refactor(distribution): spin out go.mod #18199
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Warning Rate Limit Exceeded@tac0turtle has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 0 minutes and 57 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, convert this PR to a draft and then mark it as ready for review again to re-trigger the review. Alternatively, you can push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per repository. WalkthroughThis pull request primarily involves the migration of modules to their own Changes
TipsChat with CodeRabbit Bot (
|
github-actions
bot
added
C:x/staking
C:CLI
C:x/gov
C:x/slashing
C:x/distribution
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to filter (18)
- client/v2/go.mod
- github.com/cosmos/cosmos-sdk/types/tx/amino/amino.pb.go
- github.com/cosmos/cosmos-sdk/x/auth/types/auth.pb.go
- go.mod
- simapp/go.mod
- tests/go.mod
- tests/starship/tests/go.mod
- x/circuit/go.mod
- x/distribution/go.mod
- x/distribution/types/distribution.pb.go
- x/distribution/types/genesis.pb.go
- x/distribution/types/query.pb.go
- x/distribution/types/tx.pb.go
- x/evidence/go.mod
- x/feegrant/go.mod
- x/group/go.mod
- x/nft/go.mod
- x/upgrade/go.mod
Files selected for processing (57)
- .github/workflows/test.yml (1 hunks)
- CHANGELOG.md (1 hunks)
- UPGRADING.md (1 hunks)
- go.work.example (1 hunks)
- proto/cosmos/distribution/module/v1/module.proto (1 hunks)
- proto/cosmos/distribution/v1beta1/distribution.proto (2 hunks)
- proto/cosmos/distribution/v1beta1/genesis.proto (1 hunks)
- proto/cosmos/distribution/v1beta1/query.proto (1 hunks)
- proto/cosmos/distribution/v1beta1/tx.proto (1 hunks)
- simapp/app.go (2 hunks)
- simapp/app_config.go (2 hunks)
- simapp/app_test.go (2 hunks)
- simapp/app_v2.go (2 hunks)
- simapp/simd/cmd/testnet_test.go (2 hunks)
- store/storage/rocksdb/comparator.go (2 hunks)
- tests/e2e/client/grpc/cmtservice/service_test.go (2 hunks)
- tests/e2e/distribution/grpc_query_suite.go (1 hunks)
- tests/e2e/distribution/withdraw_all_suite.go (2 hunks)
- tests/integration/bank/app_test.go (2 hunks)
- tests/integration/distribution/keeper/grpc_query_test.go (1 hunks)
- tests/integration/distribution/keeper/msg_server_test.go (2 hunks)
- tests/integration/distribution/module_test.go (1 hunks)
- tests/integration/rapidgen/rapidgen.go (2 hunks)
- tests/integration/staking/keeper/deterministic_test.go (2 hunks)
- tests/integration/staking/simulation/operations_test.go (2 hunks)
- tests/integration/tx/aminojson/aminojson_test.go (2 hunks)
- tests/integration/tx/decode_test.go (2 hunks)
- testutil/testnet/genesis.go (2 hunks)
- types/mempool/mempool_test.go (2 hunks)
- x/distribution/abci.go (1 hunks)
- x/distribution/client/cli/tx.go (1 hunks)
- x/distribution/client/cli/tx_test.go (2 hunks)
- x/distribution/client/common/common.go (1 hunks)
- x/distribution/keeper/alias_functions.go (1 hunks)
- x/distribution/keeper/allocation.go (1 hunks)
- x/distribution/keeper/allocation_test.go (1 hunks)
- x/distribution/keeper/common_test.go (1 hunks)
- x/distribution/keeper/delegation.go (1 hunks)
- x/distribution/keeper/delegation_test.go (1 hunks)
- x/distribution/keeper/genesis.go (1 hunks)
- x/distribution/keeper/grpc_query.go (1 hunks)
- x/distribution/keeper/grpc_query_test.go (1 hunks)
- x/distribution/keeper/hooks.go (1 hunks)
- x/distribution/keeper/invariants.go (1 hunks)
- x/distribution/keeper/keeper.go (1 hunks)
- x/distribution/keeper/keeper_test.go (1 hunks)
- x/distribution/keeper/migrations.go (1 hunks)
- x/distribution/keeper/msg_server.go (1 hunks)
- x/distribution/keeper/msg_server_test.go (1 hunks)
- x/distribution/keeper/store.go (1 hunks)
- x/distribution/keeper/validator.go (1 hunks)
- x/distribution/migrations/funds/migrate.go (1 hunks)
- x/distribution/migrations/funds/migrate_test.go (2 hunks)
- x/distribution/migrations/v4/migrate_test.go (1 hunks)
- x/distribution/module.go (1 hunks)
- x/distribution/simulation/decoder.go (1 hunks)
- x/distribution/simulation/decoder_test.go (1 hunks)
Files not processed due to max files limit (15)
- x/distribution/simulation/genesis.go
- x/distribution/simulation/genesis_test.go
- x/distribution/simulation/operations.go
- x/distribution/simulation/operations_test.go
- x/distribution/simulation/proposals.go
- x/distribution/simulation/proposals_test.go
- x/distribution/sonar-project.propoerties
- x/distribution/testutil/app_config.go
- x/distribution/testutil/staking_helper.go
- x/distribution/types/fee_pool_test.go
- x/distribution/types/params_test.go
- x/protocolpool/testutil/app_config.go
- x/slashing/simulation/operations_test.go
- x/slashing/testutil/app_config.go
- x/staking/testutil/app_config.go
Files skipped from review due to trivial changes (41)
- UPGRADING.md
- proto/cosmos/distribution/module/v1/module.proto
- proto/cosmos/distribution/v1beta1/distribution.proto
- proto/cosmos/distribution/v1beta1/query.proto
- simapp/app_config.go
- simapp/app_test.go
- simapp/simd/cmd/testnet_test.go
- store/storage/rocksdb/comparator.go
- tests/e2e/client/grpc/cmtservice/service_test.go
- tests/e2e/distribution/withdraw_all_suite.go
- tests/integration/distribution/keeper/msg_server_test.go
- tests/integration/distribution/module_test.go
- tests/integration/rapidgen/rapidgen.go
- tests/integration/staking/keeper/deterministic_test.go
- tests/integration/tx/aminojson/aminojson_test.go
- testutil/testnet/genesis.go
- types/mempool/mempool_test.go
- x/distribution/abci.go
- x/distribution/client/cli/tx.go
- x/distribution/client/cli/tx_test.go
- x/distribution/keeper/alias_functions.go
- x/distribution/keeper/allocation_test.go
- x/distribution/keeper/common_test.go
- x/distribution/keeper/delegation_test.go
- x/distribution/keeper/genesis.go
- x/distribution/keeper/grpc_query.go
- x/distribution/keeper/grpc_query_test.go
- x/distribution/keeper/hooks.go
- x/distribution/keeper/invariants.go
- x/distribution/keeper/keeper.go
- x/distribution/keeper/keeper_test.go
- x/distribution/keeper/migrations.go
- x/distribution/keeper/msg_server_test.go
- x/distribution/keeper/store.go
- x/distribution/keeper/validator.go
- x/distribution/migrations/funds/migrate.go
- x/distribution/migrations/funds/migrate_test.go
- x/distribution/migrations/v4/migrate_test.go
- x/distribution/module.go
- x/distribution/simulation/decoder.go
- x/distribution/simulation/decoder_test.go
Additional comments (Suppressed): 21
CHANGELOG.md (1)
- 178-178: The change log correctly reflects the changes made in the distribution module. It's important to keep the change log updated for the users to understand the changes made in each version.
go.work.example (1)
- 25-25: The new hunk adds the
./x/distributionpath to thego.work.examplefile. This change aligns with the PR summary, which mentions that the distribution module has been separated into its owngo.modfile. Ensure that the path./x/distributionis correct and that the distribution module is properly isolated with its owngo.modfile.x/distribution/client/common/common.go (1)
- 6-6: The import path for the distribution types has been updated from
"github.com/cosmos/cosmos-sdk/x/distribution/types"to"cosmossdk.io/x/distribution/types". Ensure that the new path is correct and the package at this location contains the expected types and functions. This change should not affect the functionality of the code as long as the new package provides the same API as the old one.tests/e2e/distribution/grpc_query_suite.go (1)
- 10-10: The import path for the distribution types has been updated to reflect the new location of the distribution module. Ensure that the new path
"cosmossdk.io/x/distribution/types"is correct and the package is accessible at this location.x/distribution/keeper/allocation.go (1)
- 11-11: The import path for the distribution types has been updated to reflect the new location of the distribution module. Ensure that the new path
cosmossdk.io/x/distribution/typesis correct and the package is accessible at this location.proto/cosmos/distribution/v1beta1/genesis.proto (1)
- 4-4: The
go_packageoption has been updated to reflect the new import path for the distribution module. Ensure that all references to this package in the codebase have been updated to use the new import path. This change should not affect the functionality of the code, but it is important to verify that all dependencies are correctly resolved.- option go_package = "github.com/cosmos/cosmos-sdk/x/distribution/types"; + option go_package = "cosmossdk.io/x/distribution/types";tests/integration/tx/decode_test.go (2)
14-14: The import path for the distribution module has been updated from
"github.com/cosmos/cosmos-sdk/x/distribution"to"cosmossdk.io/x/distribution". Ensure that the new path is correct and the module at the new path has the same interface as the old one. This change should not affect the functionality of the code if the new module is identical to the old one.34-39: The import path for the distribution module has been removed from this section. This change is consistent with the update in the new hunk at line 14 where the distribution module is now imported from
"cosmossdk.io/x/distribution". Ensure that all references to the distribution module in the code have been updated to use the new import path.x/distribution/keeper/msg_server.go (1)
- 9-11: The import path for the
typespackage has been updated from"github.com/cosmos/cosmos-sdk/x/distribution/types"to"cosmossdk.io/x/distribution/types". This change aligns with the PR's goal of spinning out the distribution module from the dependency tree. Ensure that all references to thetypespackage in the code have been updated to use the new import path..github/workflows/test.yml (1)
- 796-826: The new job
test-x-distributionis added to the GitHub Actions workflow. This job is designed to run tests and perform code coverage analysis for the distribution package. It uses theactions/checkout@v4andactions/setup-go@v4actions to set up the environment, and thetechnote-space/get-diff-action@v6.1.2action to get the diff of the changes. The job then runs tests on the distribution package and performs SonarCloud analysis if the pull request is not a draft and theSONAR_TOKENis not null. The job is well-structured and follows the pattern of the other jobs in the workflow. However, please ensure that theSONAR_TOKENsecret is set in the repository settings.simapp/app.go (2)
45-47: The import paths for the distribution module have been updated to reflect the new location of the module. Ensure that the new paths are correct and that the module is accessible at the new location. Also, verify that all references to the distribution module in the code have been updated to use the new import paths.
94-96: The import paths for the distribution module have been removed from this section of the imports. This change is consistent with the refactoring of the distribution module to its own
go.modfile. Ensure that this does not affect any functionality in the code that depends on the distribution module.x/distribution/keeper/delegation.go (1)
- 11-11: The import path for the distribution types has been updated to reflect the new location of the distribution module. Ensure that the new path
cosmossdk.io/x/distribution/typesis correct and the package is accessible at this location.tests/integration/bank/app_test.go (2)
- 14-15: The import paths for the distribution module have been updated to reflect the new location of the module. Ensure that the new paths are correct and that the distribution module is correctly imported in the test suite.
- _ "github.com/cosmos/cosmos-sdk/x/distribution" - distrkeeper "github.com/cosmos/cosmos-sdk/x/distribution/keeper" + _ "cosmossdk.io/x/distribution" + distrkeeper "cosmossdk.io/x/distribution/keeper"
- 32-36: The import statement for the distribution module has been removed from this section. This change is consistent with the refactoring of the distribution module. Ensure that the removal of this import statement does not affect the functionality of the test suite.
- _ "github.com/cosmos/cosmos-sdk/x/distribution" - distrkeeper "github.com/cosmos/cosmos-sdk/x/distribution/keeper"proto/cosmos/distribution/v1beta1/tx.proto (1)
- 4-4: The
go_packageoption has been updated to reflect the new import path for the distribution module. Ensure that the new pathcosmossdk.io/x/distribution/typesis correctly set up and accessible. This change should not affect the functionality of the code but it's important to verify that all dependencies are correctly resolved with the new path.simapp/app_v2.go (2)
16-16: The import path for the distribution keeper has been updated to reflect the new location of the distribution module. Ensure that the new path
cosmossdk.io/x/distribution/keeperis correct and the module is accessible at this location.42-47: The import path for the distribution keeper has been removed from this section. This change is consistent with the refactoring of the distribution module into its own
go.modfile.tests/integration/staking/simulation/operations_test.go (2)
20-21: The import paths for the distribution module and related packages have been updated to reflect the new location of the module. Ensure that the new paths are correct and that the module and packages are accessible at these locations.
33-38: The import paths for the distribution module and related packages have been removed from this section. This change is consistent with the goal of the PR to separate the distribution module from the dependency tree. Ensure that this does not affect the functionality of the code.
tests/integration/distribution/keeper/grpc_query_test.go (1)
- 11-11: The import path for the distribution types has been updated to reflect the new location of the distribution module. Ensure that the new path is correct and accessible. Also, verify that all references to the distribution types in the code have been updated to use the new import path.
| @@ -4,14 +4,14 @@ import ( | |||
| "context" | |||
| "fmt" | |||
|
|
|||
| "github.com/hashicorp/go-metrics" | |||
| metrics "github.com/hashicorp/go-metrics" | |||
There was a problem hiding this comment.
The import path for the go-metrics package has been changed from "github.com/hashicorp/go-metrics" to "metrics "github.com/hashicorp/go-metrics". This change introduces an alias for the package, which is not used elsewhere in the code. If the alias is not needed, consider reverting this change to maintain consistency with the rest of the codebase.
- metrics "github.com/hashicorp/go-metrics"
+ "github.com/hashicorp/go-metrics"
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to filter (13)
- go.mod
- simapp/go.mod
- tests/go.mod
- tests/starship/tests/go.mod
- x/distribution/go.mod
- x/distribution/go.sum
- x/evidence/go.mod
- x/feegrant/go.mod
- x/gov/go.mod
- x/group/go.mod
- x/params/go.mod
- x/protocolpool/go.mod
- x/upgrade/go.mod
Files selected for processing (1)
- contrib/images/simd-env/Dockerfile (1 hunks)
Additional comments (Suppressed): 1
contrib/images/simd-env/Dockerfile (1)
- 18-18: The new hunk adds the
go.modandgo.sumfiles of thex/distributionmodule to the Docker build context. This is in line with the PR's goal of spinning out the distribution module into its owngo.modfile. Ensure that thex/distribution/go.modandx/distribution/go.sumfiles exist and are correctly populated.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (39)
- x/distribution/abci.go (1 hunks)
- x/distribution/client/cli/tx.go (1 hunks)
- x/distribution/client/cli/tx_test.go (2 hunks)
- x/distribution/client/common/common.go (1 hunks)
- x/distribution/keeper/alias_functions.go (1 hunks)
- x/distribution/keeper/allocation.go (1 hunks)
- x/distribution/keeper/allocation_test.go (1 hunks)
- x/distribution/keeper/common_test.go (1 hunks)
- x/distribution/keeper/delegation.go (1 hunks)
- x/distribution/keeper/delegation_test.go (1 hunks)
- x/distribution/keeper/genesis.go (1 hunks)
- x/distribution/keeper/grpc_query.go (1 hunks)
- x/distribution/keeper/grpc_query_test.go (1 hunks)
- x/distribution/keeper/hooks.go (1 hunks)
- x/distribution/keeper/invariants.go (1 hunks)
- x/distribution/keeper/keeper.go (1 hunks)
- x/distribution/keeper/keeper_test.go (2 hunks)
- x/distribution/keeper/migrations.go (1 hunks)
- x/distribution/keeper/msg_server.go (1 hunks)
- x/distribution/keeper/msg_server_test.go (1 hunks)
- x/distribution/keeper/store.go (1 hunks)
- x/distribution/keeper/validator.go (1 hunks)
- x/distribution/migrations/funds/migrate.go (1 hunks)
- x/distribution/migrations/funds/migrate_test.go (2 hunks)
- x/distribution/migrations/v4/migrate_test.go (1 hunks)
- x/distribution/module.go (2 hunks)
- x/distribution/simulation/decoder.go (1 hunks)
- x/distribution/simulation/decoder_test.go (1 hunks)
- x/distribution/simulation/genesis.go (1 hunks)
- x/distribution/simulation/genesis_test.go (1 hunks)
- x/distribution/simulation/operations.go (1 hunks)
- x/distribution/simulation/operations_test.go (2 hunks)
- x/distribution/simulation/proposals.go (1 hunks)
- x/distribution/simulation/proposals_test.go (1 hunks)
- x/distribution/testutil/app_config.go (1 hunks)
- x/distribution/testutil/staking_helper.go (1 hunks)
- x/distribution/types/fee_pool_test.go (1 hunks)
- x/distribution/types/params_test.go (1 hunks)
- x/protocolpool/testutil/app_config.go (2 hunks)
Files skipped from review due to trivial changes (30)
- x/distribution/abci.go
- x/distribution/client/cli/tx.go
- x/distribution/client/cli/tx_test.go
- x/distribution/client/common/common.go
- x/distribution/keeper/allocation.go
- x/distribution/keeper/allocation_test.go
- x/distribution/keeper/common_test.go
- x/distribution/keeper/delegation.go
- x/distribution/keeper/delegation_test.go
- x/distribution/keeper/genesis.go
- x/distribution/keeper/grpc_query_test.go
- x/distribution/keeper/hooks.go
- x/distribution/keeper/keeper.go
- x/distribution/keeper/keeper_test.go
- x/distribution/keeper/migrations.go
- x/distribution/keeper/msg_server.go
- x/distribution/keeper/msg_server_test.go
- x/distribution/keeper/store.go
- x/distribution/keeper/validator.go
- x/distribution/migrations/funds/migrate_test.go
- x/distribution/module.go
- x/distribution/simulation/decoder.go
- x/distribution/simulation/decoder_test.go
- x/distribution/simulation/genesis.go
- x/distribution/simulation/genesis_test.go
- x/distribution/simulation/operations.go
- x/distribution/simulation/operations_test.go
- x/distribution/simulation/proposals.go
- x/distribution/simulation/proposals_test.go
- x/distribution/testutil/app_config.go
Additional comments: 9
x/distribution/keeper/alias_functions.go (1)
- 8-8: The import path for the
typespackage has been updated to reflect the new module structure. Ensure that the new path is correct and the package is accessible at this location.- "github.com/cosmos/cosmos-sdk/x/distribution/types" + "cosmossdk.io/x/distribution/types"x/distribution/migrations/funds/migrate.go (1)
- 6-6: The import path for the
typespackage has been changed from"github.com/cosmos/cosmos-sdk/x/distribution/types"to"cosmossdk.io/x/distribution/types". Ensure that the new path is correct and accessible, and that all references to types from this package in the codebase have been updated to reflect this change.x/distribution/types/fee_pool_test.go (1)
- 9-9: The import path for the
typespackage has been updated to reflect the new module structure. Ensure that the new path is correct and the module is properly initialized at this location.- "github.com/cosmos/cosmos-sdk/x/distribution/types" + "cosmossdk.io/x/distribution/types"x/distribution/testutil/staking_helper.go (1)
- 7-7: The import path for the
keeperpackage has been updated to reflect the new module structure. Ensure that the new path is correct and that the module at this path exports the expected functions and types.x/distribution/types/params_test.go (1)
- 9-9: The import path for the
typespackage has been updated from"github.com/cosmos/cosmos-sdk/x/distribution/types"to"cosmossdk.io/x/distribution/types". Ensure that the new import path is correct and the package is accessible at this location. Also, verify that all references to this package in the codebase have been updated to reflect this change.x/distribution/keeper/invariants.go (1)
- 7-7: The import path for the distribution types has been updated from
"github.com/cosmos/cosmos-sdk/x/distribution/types"to"cosmossdk.io/x/distribution/types". Ensure that the new path is correct and the package is accessible at this location. This change is likely due to the refactoring of the distribution module mentioned in the PR summary.x/distribution/migrations/v4/migrate_test.go (1)
- 11-12: The import paths for the
distributionmodule and itsv4migrations package have been updated to reflect the new module structure. Ensure that the new paths are correct and that the module is properly isolated from the main dependency tree.- "github.com/cosmos/cosmos-sdk/x/distribution" - v4 "github.com/cosmos/cosmos-sdk/x/distribution/migrations/v4" + "cosmossdk.io/x/distribution" + v4 "cosmossdk.io/x/distribution/migrations/v4"x/protocolpool/testutil/app_config.go (1)
- 4-4: The import path for the distribution module has been changed from
github.com/cosmos/cosmos-sdk/x/distributiontocosmossdk.io/x/distribution. Ensure that the new path is correct and accessible, and that all references to the distribution module in the codebase have been updated to use the new path.x/distribution/keeper/grpc_query.go (1)
- 11-11: The import path for the
typespackage from thedistributionmodule has been updated to reflect the new module structure. Ensure that the new path is correct and accessible.- "github.com/cosmos/cosmos-sdk/x/distribution/types" + "cosmossdk.io/x/distribution/types"
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to filter (1)
- client/v2/go.mod
Files selected for processing (2)
- UPGRADING.md (1 hunks)
- simapp/app.go (2 hunks)
Files skipped from review due to trivial changes (2)
- UPGRADING.md
- simapp/app.go
julienrbrt
approved these changes
Oct 24, 2023
| @@ -0,0 +1,14 @@ | |||
| sonar.projectKey=cosmos-sdk-distribution | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- simapp/app.go (2 hunks)
- tests/e2e/client/grpc/cmtservice/service_test.go (1 hunks)
Files skipped from review due to trivial changes (2)
- simapp/app.go
- tests/e2e/client/grpc/cmtservice/service_test.go
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
this pr spins out the distribution module from the cosmos sdk dependency tree
ref #11899
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...
!to the type prefix if API or client breaking changeCHANGELOG.mdmake lintandmake testReviewers 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...
!in the type prefix if API or client breaking changeSummary by CodeRabbit