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

refactor(types): loosen module.AppModule interface #19951

Merged
merged 1 commit into from
Apr 4, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Apr 4, 2024

Description

Follow-up of this comment: #19697 (review)


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

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

  • Refactor
    • Improved interface registration logic across the application to enhance module compatibility and performance.
  • Chores
    • Simplified module interfaces by removing redundant methods, streamlining the application's architecture.

@julienrbrt julienrbrt requested a review from a team as a code owner April 4, 2024 09:59
Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Walkthrough

Walkthrough

The overarching modification involves refining the interface registration mechanism across various modules and mock types within the application. Specifically, it streamlines the process by conditionally invoking the RegisterInterfaces method only for modules that implement the HasRegisterInterfaces interface, and simultaneously removes redundant implementations of this method across multiple modules and mock types. This change aims to enhance modularity and reduce clutter by eliminating unnecessary interface registrations.

Changes

Files Change Summary
runtime/app.go Added conditional type assertion in RegisterModules to invoke RegisterInterfaces for compliant modules.
testutil/mock/.../types_mock_appmodule.go Removed RegisterInterfaces method and related mock implementations in MockAppModuleWithAllExtensions types.
testutil/mock/.../types_module_module.go Eliminated RegisterInterfaces method from MockAppModuleBasic and MockAppModule, including related calls.
types/module/module.go Removed appmodulev2.HasRegisterInterfaces from AppModuleBasic and AppModule interfaces.
x/epochs/module.go, x/genutil/module.go Removed RegisterInterfaces method implementation, affecting interface registration logic within modules.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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/coderabbit-overrides.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.

@julienrbrt julienrbrt changed the title refactor(types): losen module.AppModule interface refactor(types): loosen module.AppModule interface Apr 4, 2024
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 Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 1028e27 and b878fc5.
Files ignored due to path filters (1)
  • tests/starship/tests/go.mod is excluded by !**/*.mod
Files selected for processing (6)
  • runtime/app.go (1 hunks)
  • testutil/mock/types_mock_appmodule.go (3 hunks)
  • testutil/mock/types_module_module.go (4 hunks)
  • types/module/module.go (2 hunks)
  • x/epochs/module.go (2 hunks)
  • x/genutil/module.go (2 hunks)
Additional Context Used
Path-based Instructions (6)
x/genutil/module.go (1)

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

x/epochs/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.

testutil/mock/types_module_module.go (1)

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

testutil/mock/types_mock_appmodule.go (1)

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

types/module/module.go (1)

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

Additional comments not posted (5)
x/genutil/module.go (1)

7-12: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-93]

The removal of the RegisterInterfaces method aligns with the PR's objectives and simplifies the interface registration logic within the Cosmos SDK.

x/epochs/module.go (1)

9-14: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-95]

The removal of the RegisterInterfaces function aligns with the PR's objectives to simplify the interface registration logic. Note: The summary mentions the removal of an import related to registry, which is not visible in the provided code snippet. This discrepancy does not affect the approval of the changes made.

runtime/app.go (1)

71-73: The addition of a conditional type assertion in the RegisterModules function enhances the flexibility of interface registration within the Cosmos SDK, aligning with the PR's objectives.

testutil/mock/types_module_module.go (1)

9-14: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-261]

The removal of the RegisterInterfaces method from mock implementations aligns with the PR's objectives to simplify the interface registration logic and ensures that the mocks remain consistent with the updated interfaces.

testutil/mock/types_mock_appmodule.go (1)

10-15: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-255]

The removal of RegisterInterfaces from the mock implementations aligns with the PR's objectives and is correctly reflected in the changes. Ensure that any tests or other code relying on these mocks are updated accordingly to accommodate the absence of RegisterInterfaces.

@github-actions github-actions bot added C:x/genutil genutil module issues C:x/epochs labels Apr 4, 2024
Copy link

sonarqubecloud bot commented Apr 4, 2024

Quality Gate Passed Quality Gate passed for 'Cosmos SDK - Epochs'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@julienrbrt julienrbrt enabled auto-merge April 4, 2024 11:00
@julienrbrt julienrbrt added this pull request to the merge queue Apr 4, 2024
@julienrbrt julienrbrt removed this pull request from the merge queue due to a manual request Apr 4, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Apr 4, 2024
Merged via the queue into main with commit 649dfaa Apr 4, 2024
64 of 66 checks passed
@julienrbrt julienrbrt deleted the julien/module branch April 4, 2024 15:20
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 8, 2024
* main: (45 commits)
  build(deps): Bump github.com/decred/dcrd/dcrec/secp256k1/v4 from 4.2.0 to 4.3.0 (cosmos#19913)
  build(deps): Bump google.golang.org/grpc from 1.62.1 to 1.63.0 (cosmos#19929)
  test(types/address): add additional unit tests for address.LengthPrefix and a… (cosmos#19964)
  refactor(x/bank)!: remove Address.String() (cosmos#19954)
  build(deps): Bump github.com/prometheus/common from 0.51.1 to 0.52.2 (cosmos#19930)
  fix(x/epochs): Fix init genesis (cosmos#19958)
  feat(core,runtime): transaction service (exec mode) (cosmos#19953)
  fix(x/authz): non utf-8 characters in logs (cosmos#19923)
  build(deps): Bump golang.org/x/crypto from 0.21.0 to 0.22.0 (cosmos#19960)
  chore: fix spelling errors (cosmos#19957)
  fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955)
  refactor(types): loosen module.AppModule interface (cosmos#19951)
  feat(core): add `TxValidator` interface (cosmos#19950)
  build(deps): Bump cosmossdk.io/store from 1.0.2 to 1.1.0 in /x/epochs (cosmos#19947)
  feat(x/epochs): upstream osmosis epoch module (cosmos#19697)
  build(deps): Bump bufbuild/buf-setup-action from 1.30.0 to 1.30.1 (cosmos#19928)
  refactor(x/genutil)!: remove Address.String() (cosmos#19926)
  docs(x/mint): Fix inconsistency in mint docs  (cosmos#19915)
  build(deps): Bump github.com/regen-network/gocuke from 1.1.0 to 1.1.1 in /orm (cosmos#19920)
  feat: Integrate grpc configuration into client.toml (cosmos#19905)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:x/epochs C:x/genutil genutil module issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants