Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(network): remove DefaultConfigWithAppConfigWithQueryGasLimit #21055

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jul 24, 2024

Description

Noticed while editing network (#20887)
Follow-up of: #20945

The newly introduced API in the above PR was quite bad, this improves it and future-proof.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Bug Fixes

    • Improved integration test handling of gas limits to ensure consistent behavior during execution.
  • New Features

    • Enhanced configuration flexibility in the integration test setup, allowing for more dynamic application configurations.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jul 24, 2024
@julienrbrt julienrbrt requested a review from a team as a code owner July 24, 2024 11:18
Copy link
Contributor

coderabbitai bot commented Jul 24, 2024

Walkthrough

Walkthrough

The changes introduce a more flexible configuration system for the integration tests by modifying how the gas limit is set. The DefaultConfigWithAppConfig function has been refactored to accept additional configuration options, enhancing customization. The original function for setting a specific query gas limit has been removed, which may affect test behavior in scenarios sensitive to gas consumption.

Changes

Files Change Summary
tests/integration/server/grpc/out_of_gas_test.go, testutil/network/network.go The integration test setup was modified to use DefaultConfigWithAppConfig instead of DefaultConfigWithAppConfigWithQueryGasLimit, incorporating a new baseapp.SetQueryGasLimit(10) parameter. This enhances configurability in gas limit settings through a more flexible function signature. The old query gas limit function was removed to streamline the setup process.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite
    participant ConfigFunction
    participant BaseApp

    TestSuite->>ConfigFunction: Call DefaultConfigWithAppConfig(appConfig, baseappOpts...)
    ConfigFunction->>BaseApp: Construct BaseApp with options
    BaseApp->>TestSuite: Return configured instance
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e8222c8 and f5883d8.

Files selected for processing (2)
  • tests/integration/server/grpc/out_of_gas_test.go (2 hunks)
  • testutil/network/network.go (2 hunks)
Additional context used
Path-based instructions (2)
tests/integration/server/grpc/out_of_gas_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

testutil/network/network.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (2)
tests/integration/server/grpc/out_of_gas_test.go (1)

40-48: Verify the correctness of the new configuration setup.

The function call to network.DefaultConfigWithAppConfigWithQueryGasLimit has been replaced with network.DefaultConfigWithAppConfig, and baseapp.SetQueryGasLimit(10) has been added. Ensure that this change correctly sets the query gas limit as intended.

Verification successful

Verify the correctness of the new configuration setup.

The function call to network.DefaultConfigWithAppConfigWithQueryGasLimit has been replaced with network.DefaultConfigWithAppConfig, and baseapp.SetQueryGasLimit(10) has been added. Ensure that this change correctly sets the query gas limit as intended.


Verify the correctness of the new configuration setup.

The function call to network.DefaultConfigWithAppConfigWithQueryGasLimit has been replaced with network.DefaultConfigWithAppConfig, and baseapp.SetQueryGasLimit(10) has been added. Ensure that this change correctly sets the query gas limit as intended.


Verified the correctness of the new configuration setup.

The function call to network.DefaultConfigWithAppConfigWithQueryGasLimit has been replaced with network.DefaultConfigWithAppConfig, and baseapp.SetQueryGasLimit(10) has been added. This change correctly sets the query gas limit as intended.

  • Verified in tests/integration/server/grpc/out_of_gas_test.go
  • Verified in server/util.go
  • Verified in baseapp/baseapp_test.go
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the function usage of `network.DefaultConfigWithAppConfig` and ensure `baseapp.SetQueryGasLimit` is correctly used.

# Test: Search for the function usage. Expect: Only occurances of the new usage.
rg --type go -A 5 $'network.DefaultConfigWithAppConfig'

Length of output: 2567


Script:

#!/bin/bash
# Description: Verify the usage of `baseapp.SetQueryGasLimit` in the codebase.

# Test: Search for the function usage. Expect: Occurrences of `baseapp.SetQueryGasLimit(10)`.
rg --type go -A 5 $'baseapp.SetQueryGasLimit(10)'

Length of output: 50


Script:

#!/bin/bash
# Description: Verify the usage of `baseapp.SetQueryGasLimit` in the codebase.

# Test: Search for the function usage. Expect: Occurrences of `baseapp.SetQueryGasLimit`.
rg --type go -A 5 $'baseapp.SetQueryGasLimit'

Length of output: 1249

testutil/network/network.go (1)

Line range hint 166-225:
Verify the correctness of the new function signature and logic.

The function DefaultConfigWithAppConfig has been updated to include a variadic parameter baseappOpts ...func(*baseapp.BaseApp), allowing for additional configuration options. Ensure that this change correctly enhances the flexibility of the function and that the internal logic has been adjusted appropriately.

Copy link
Contributor

@JulianToledano JulianToledano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, this looks way cleaner! 👌

@julienrbrt julienrbrt added this pull request to the merge queue Jul 26, 2024
Merged via the queue into main with commit cc5c4d0 Jul 26, 2024
74 checks passed
@julienrbrt julienrbrt deleted the julien/network branch July 26, 2024 09:05
mergify bot pushed a commit that referenced this pull request Jul 26, 2024
alpe added a commit that referenced this pull request Jul 26, 2024
* main:
  feat(log): remove core dependency and update core interface to be dependency free (#21045)
  chore: fix some comments (#21085)
  feat: simulate nested messages (#20291)
  chore(network): remove `DefaultConfigWithAppConfigWithQueryGasLimit` (#21055)
  fix(runtime): remove `appv1alpha1.Config` from runtime (#21042)
  feat(simapp/v2): Add store server to testnet init cmd (#21076)
  chore(indexer/postgres): update to changes on main (#21077)
  feat(schema/appdata): async listener mux'ing (#20879)
  ci: Use large box for 052 branch sims on CI (#21067)
  chore(all): replace all `fmt.Errorf` without paramters with `errors.New` (#21068)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants