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): remove appv1alpha1.Config from runtime #21042

Merged
merged 2 commits into from
Jul 25, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jul 23, 2024

Description

Since depinject v1, we actually do not supply appv1alpha.Config when we use Compose from a json: https://github.com/cosmos/cosmos-sdk/pull/20931/files#diff-27f72d7ebe452671125abb151c9e77c6b092536cfafcc734c4f10faade8d0d0dR23-R62.

That poses an issue as runtime requires it: https://github.com/cosmosregistry/chain-minimal/actions/runs/10064766032/job/27822404477 / cosmosregistry/chain-minimal#152

AppConfig actually does not need to be on runtime (as the app config service is gone), we should not require it to be available.

This should be backported to v0.52 once #21041 is merged.


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
    • Streamlined application configuration handling to enhance performance.
  • Bug Fixes
    • Removed deprecated configuration references to prevent potential errors.
  • Refactor
    • Simplified data structures related to application inputs and configuration management.

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

coderabbitai bot commented Jul 23, 2024

Walkthrough

Walkthrough

The recent changes involve the removal of the appv1alpha1.Config configuration structure from multiple files in the runtime module. This indicates a significant refactoring of the application’s configuration management, suggesting that the application will no longer depend on this configuration type. The changes streamline the application structure, potentially aligning it with a more efficient configuration management system.

Changes

Files Change Summary
runtime/app.go, Removed import of appv1alpha1 and eliminated appConfig field from App struct.
runtime/module.go Removed AppConfig from AppInputs struct and its usage in SetupAppBuilder function.
runtime/v2/app.go, Removed import of appv1alpha1 and eliminated appConfig field from App struct, retaining only essential fields.
runtime/v2/module.go Removed AppConfig from AppInputs struct and its assignment in SetupAppBuilder function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Module

    User->>App: Initialize Application
    App->>Module: Setup Application
    Module-->>App: Configuration Loaded
    App-->>User: Application Ready
Loading
sequenceDiagram
    participant User
    participant OldApp as "Old App"
    participant OldModule as "Old Module"
    participant NewApp as "New App"
    participant NewModule as "New Module"

    User->>OldApp: Initialize Old Application
    OldApp->>OldModule: Setup Old Application
    OldModule-->>OldApp: Old Configuration Loaded
    OldApp-->>User: Old Application Ready

    User->>NewApp: Initialize New Application
    NewApp->>NewModule: Setup New Application
    NewModule-->>NewApp: New Configuration Loaded
    NewApp-->>User: New Application Ready
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

@julienrbrt your pull request is missing a changelog!

Copy link
Member

@aaronc aaronc left a comment

Choose a reason for hiding this comment

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

Do we still need this for anything? We could replace with the depinject gogo version

@julienrbrt
Copy link
Member Author

Do we still need this for anything? We could replace with the depinject gogo version

Not on main no, in v0.50 we had a query for the app config, but we killed it as it wasn't being used.

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 0ca95ee and 0ea2d15.

Files selected for processing (4)
  • runtime/app.go (2 hunks)
  • runtime/module.go (3 hunks)
  • runtime/v2/app.go (2 hunks)
  • runtime/v2/module.go (2 hunks)
Files skipped from review due to trivial changes (1)
  • runtime/v2/app.go
Additional context used
Path-based instructions (3)
runtime/v2/module.go (1)

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

runtime/module.go (1)

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

runtime/app.go (1)

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

Additional comments not posted (5)
runtime/v2/module.go (2)

Line range hint 51-60:
Removal of AppConfig field approved.

The removal of the AppConfig field from the AppInputs struct is consistent with the PR objectives and helps streamline the configuration management.


Line range hint 62-73:
Removal of app.appConfig assignment approved.

The removal of the app.appConfig = inputs.AppConfig assignment in the SetupAppBuilder function is consistent with the removal of the AppConfig field from the AppInputs struct.

runtime/module.go (2)

Line range hint 55-66:
Removal of AppConfig field approved.

The removal of the AppConfig field from the AppInputs struct is consistent with the PR objectives and helps streamline the configuration management.


Line range hint 68-78:
Removal of app.appConfig assignment approved.

The removal of the app.appConfig = inputs.AppConfig assignment in the SetupAppBuilder function is consistent with the removal of the AppConfig field from the AppInputs struct.

runtime/app.go (1)

Line range hint 18-35:
Removal of appConfig field and import statement approved.

The removal of the appConfig field from the App struct and its associated import statement is consistent with the PR objectives and helps streamline the configuration management.

julienrbrt added a commit to cosmosregistry/chain-minimal that referenced this pull request Jul 23, 2024
julienrbrt added a commit to cosmosregistry/chain-minimal that referenced this pull request Jul 23, 2024
…152)

* build(deps): bump cosmossdk.io/depinject from 1.0.0-alpha.4 to 1.0.0

Bumps [cosmossdk.io/depinject](https://github.com/cosmos/cosmos-sdk) from 1.0.0-alpha.4 to 1.0.0.
- [Release notes](https://github.com/cosmos/cosmos-sdk/releases)
- [Changelog](https://github.com/cosmos/cosmos-sdk/blob/main/CHANGELOG.md)
- [Commits](cosmos/cosmos-sdk@orm/v1.0.0-alpha.4...log/v1.0.0)

---
updated-dependencies:
- dependency-name: cosmossdk.io/depinject
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* updates

* hack until cosmos/cosmos-sdk#21042

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jul 24, 2024
Copy link
Member

@kocubinski kocubinski left a comment

Choose a reason for hiding this comment

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

seems like a good evolution that config is not leaking into the app too

@julienrbrt julienrbrt added this pull request to the merge queue Jul 25, 2024
Merged via the queue into main with commit 502450c Jul 25, 2024
78 checks passed
@julienrbrt julienrbrt deleted the julien/remove-appconfig branch July 25, 2024 21:47
mergify bot pushed a commit that referenced this pull request Jul 25, 2024
mergify bot pushed a commit that referenced this pull request Jul 25, 2024
(cherry picked from commit 502450c)

# Conflicts:
#	runtime/module.go
#	runtime/v2/app.go
#	runtime/v2/module.go
tac0turtle pushed a commit that referenced this pull request Jul 26, 2024
…) (#21079)

Co-authored-by: Julien Robert <julien@rbrt.fr>
julienrbrt added a commit that referenced this pull request Jul 26, 2024
…) (#21080)

Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
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)
lionpunk pushed a commit to lionpunk/mini-chain that referenced this pull request Aug 1, 2024
…(#152)

* build(deps): bump cosmossdk.io/depinject from 1.0.0-alpha.4 to 1.0.0

Bumps [cosmossdk.io/depinject](https://github.com/cosmos/cosmos-sdk) from 1.0.0-alpha.4 to 1.0.0.
- [Release notes](https://github.com/cosmos/cosmos-sdk/releases)
- [Changelog](https://github.com/cosmos/cosmos-sdk/blob/main/CHANGELOG.md)
- [Commits](cosmos/cosmos-sdk@orm/v1.0.0-alpha.4...log/v1.0.0)

---
updated-dependencies:
- dependency-name: cosmossdk.io/depinject
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* updates

* hack until cosmos/cosmos-sdk#21042

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release 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.

3 participants