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

fix(runtime/v2): provide default factory options if unset in app builder #21690

Merged
merged 5 commits into from
Sep 13, 2024

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented Sep 12, 2024

Description

Follow up on #21635, provides default factory options for the store/v2 if unset.


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

  • New Features
    • Enhanced flexibility in handling store configurations within the application.
  • Bug Fixes
    • Improved initialization of store options to ensure default settings are applied correctly.
  • Refactor
    • Streamlined code structure for better readability in the application command functions.
  • Style
    • Minor formatting changes to remove trailing spaces in HTTP request functions.

Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

Walkthrough

The changes involve modifications to the handling of storeOptions within the AppBuilder struct in runtime/v2/builder.go, transitioning it from a value type to a pointer type. This adjustment allows for nil values and requires default value assignments in the Build method. Additionally, the NewSimApp function in simapp/v2/app_di.go has been updated to initialize storeOptions as a pointer to a new root.Options{} struct instead of using predefined defaults. Minor formatting changes were made to the newApp function in simapp/v2/simdv2/cmd/commands.go, and some formatting adjustments were made in the testutil/rest.go file.

Changes

Files Change Summary
runtime/v2/builder.go Modified storeOptions in AppBuilder to a pointer type; updated Build method and AppBuilderWithStoreOptions function accordingly.
simapp/v2/app_di.go Changed initialization of storeOptions in NewSimApp from root.DefaultStoreOptions() to &root.Options{}; added builderOpts variable.
simapp/v2/simdv2/cmd/commands.go Streamlined formatting in newApp function by removing unnecessary line breaks without altering functionality.
testutil/rest.go Minor formatting changes by removing trailing spaces in GetRequest and PostRequest functions.

Possibly related PRs

  • ci: remove duplicate gosec & lint fixes #21685: The changes in the runtime/v2/builder.go file regarding the handling of storeOptions and the modifications in simapp/v2/app_di.go for initializing storeOptions as a pointer type indicate a direct relationship in how store options are managed, enhancing configurability in both PRs.

Suggested labels

C:orm, C:server/v2, C:indexer/postgres


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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@kocubinski kocubinski marked this pull request as ready for review September 12, 2024 15:00
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

great!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 12, 2024
@julienrbrt
Copy link
Member

Adding backport label due to simapp/v2 changes.

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

Outside diff range and nitpick comments (1)
simapp/v2/app_di.go (1)

103-103: Consider using a zero value instead of a constructor for storeOptions.

Initializing storeOptions with &root.Options{} deviates from the Uber Go Style Guide, which recommends using zero values instead of constructors for initialization.

var storeOptions root.Options

This allows for more idiomatic initialization while still providing the flexibility to customize the options later.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d8a6ed7 and c8ea058.

Files selected for processing (1)
  • simapp/v2/app_di.go (2 hunks)
Additional context used
Path-based instructions (1)
simapp/v2/app_di.go (1)

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

Additional comments not posted (3)
simapp/v2/app_di.go (3)

195-195: LGTM!

Unmarshalling the Viper sub-config directly into storeOptions is the correct approach since storeOptions is already a pointer.


199-199: LGTM!

Passing the storeOptions to runtime.AppBuilderWithStoreOptions[T] and appending the resulting option to builderOpts is a good way to enhance the flexibility of the app-building process.


201-201: LGTM!

Passing the builderOpts slice to appBuilder.Build using the variadic syntax ... is the correct way to provide multiple options to the app builder. This change is consistent with the introduction of the builderOpts variable and the appending of the store options.

@kocubinski kocubinski added this pull request to the merge queue Sep 13, 2024
Merged via the queue into main with commit 9fc6675 Sep 13, 2024
71 checks passed
@kocubinski kocubinski deleted the kocu/default-factory-opts branch September 13, 2024 10:33
mergify bot pushed a commit that referenced this pull request Sep 13, 2024
…der (#21690)

(cherry picked from commit 9fc6675)

# Conflicts:
#	runtime/v2/builder.go
julienrbrt added a commit that referenced this pull request Sep 13, 2024
…der (backport #21690) (#21710)

Co-authored-by: Matt Kocubinski <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
alpe added a commit that referenced this pull request Sep 16, 2024
* main:
  test: fix sims (#21735)
  build: bump proto-builder (#21730)
  refactor(schema)!: rename IntegerStringKind and DecimalStringKind (#21694)
  feat(types/collections): add `LegacyDec` collection value (#21693)
  refactor(server): alias AppOptions to coreserver.DynamicConfig (#21711)
  refactor(simapp): simplify simapp di (#21718)
  feat: replace the cosmos-db usecases in the tests with `core/testing` (#21525)
  feat(runtime/v2): store loader on simappv2 (#21704)
  docs(x/auth): vesting (#21715)
  build(deps): Bump google.golang.org/grpc from 1.66.1 to 1.66.2 (#21670)
  refactor(systemtest): Add cli.RunAndWait for common operations (#21689)
  fix(runtime/v2): provide default factory options if unset in app builder (#21690)
  chore: remove duplicate proto files for the same proto file (#21648)
  feat(x/genutil): add better error messages for genesis validation (#21701)
  build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.1 to 1.0.0-alpha.2 (#21698)
  test: migrate e2e/bank to system tests (#21607)
  chore: fix the gci lint issue in testutil (#21695)
  docs(x/authz): update grant docs (#21677)
@coderabbitai coderabbitai bot mentioned this pull request Sep 17, 2024
12 tasks
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