feat(x/group): Add env bundler to group module #19489
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
WalkthroughWalkthroughThe overarching change integrates a new Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -451,7 +450,7 @@ | |||
| return errorsmod.Wrap(err, "doTallyAndUpdate") | |||
| } | |||
|
|
|||
| if err := k.proposalTable.Update(k.storeService.OpenKVStore(ctx), proposal.Id, &proposal); err != nil { | |||
| if err := k.proposalTable.Update(k.environment.KVStoreService.OpenKVStore(ctx), proposal.Id, &proposal); err != nil { | |||
Check failure
Code scanning / gosec
Implicit memory aliasing in for loop.
| @@ -349,7 +348,7 @@ | |||
|
|
|||
| //nolint:gosec // "implicit memory aliasing in the for loop (because of the pointer on &v)" | |||
| for _, v := range votes { | |||
| err = k.voteTable.Delete(k.storeService.OpenKVStore(ctx), &v) | |||
| err = k.voteTable.Delete(k.environment.KVStoreService.OpenKVStore(ctx), &v) | |||
Check failure
Code scanning / gosec
Implicit memory aliasing in for loop.
| @@ -308,7 +307,7 @@ | |||
| if proposalInfo.Status == group.PROPOSAL_STATUS_SUBMITTED { | |||
| proposalInfo.Status = group.PROPOSAL_STATUS_ABORTED | |||
|
|
|||
| if err := k.proposalTable.Update(k.storeService.OpenKVStore(ctx), proposalInfo.Id, &proposalInfo); err != nil { | |||
| if err := k.proposalTable.Update(k.environment.KVStoreService.OpenKVStore(ctx), proposalInfo.Id, &proposalInfo); err != nil { | |||
Check failure
Code scanning / gosec
Implicit memory aliasing in for loop.
![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: 2
Configuration used: .coderabbit.yml
Files selected for processing (18)
- simapp/app.go (1 hunks)
- x/group/CHANGELOG.md (1 hunks)
- x/group/keeper/abci.go (1 hunks)
- x/group/keeper/abci_test.go (23 hunks)
- x/group/keeper/genesis.go (2 hunks)
- x/group/keeper/genesis_test.go (2 hunks)
- x/group/keeper/grpc_query.go (14 hunks)
- x/group/keeper/grpc_query_test.go (1 hunks)
- x/group/keeper/invariants.go (1 hunks)
- x/group/keeper/keeper.go (13 hunks)
- x/group/keeper/keeper_test.go (9 hunks)
- x/group/keeper/migrations.go (1 hunks)
- x/group/keeper/msg_server.go (44 hunks)
- x/group/keeper/msg_server_test.go (2 hunks)
- x/group/keeper/proposal_executor.go (1 hunks)
- x/group/keeper/tally.go (2 hunks)
- x/group/module/depinject.go (3 hunks)
- x/group/module/module.go (1 hunks)
Additional comments: 73
x/group/keeper/abci.go (1)
- 7-15: The implementation of the
EndBlockerfunction correctly integrates the new environment bundler setup and follows best practices for error handling and context usage. Good job on ensuring that the function is concise and maintainable.x/group/keeper/migrations.go (1)
- 23-23: The update to use
m.keeper.environment.KVStoreServicein theMigrate1to2function aligns with the migration to an environment bundler, ensuring that the migration utilizes the new setup correctly.x/group/CHANGELOG.md (1)
- 35-35: The changelog entry is well-documented, clearly stating the new feature related to the integration of
appmodule.Environmentwith the Keeper. It follows the established changelog format and principles.x/group/module/depinject.go (1)
- 32-32: The updates in
depinject.go, specifically the replacement ofStoreServicewithEnvironmentin theProvideModulefunction, correctly align with the migration to an environment bundler. This ensures proper interaction with external dependencies through the new setup.Also applies to: 48-48
x/group/keeper/tally.go (1)
- 16-16: The updates in the
Tallyfunction, specifically the replacement ofsdk.Contextwithcontext.Contextand the use ofk.environment.KVStoreServiceforkvStoreinitialization, correctly reflect the migration to an environment bundler and the new context management approach.Also applies to: 26-26
x/group/keeper/genesis.go (1)
- 20-20: The updates in the
InitGenesisandExportGenesisfunctions to usek.environment.KVStoreServicealign with the migration to an environment bundler, ensuring that the genesis processes utilize the new setup correctly.Also applies to: 55-55
x/group/keeper/proposal_executor.go (1)
- 19-19: The addition of the comment regarding the future use of
context.Contextandenv bundler serviceis clear and provides valuable insight into future development plans. It's a good practice to document such intentions for future reference.x/group/keeper/invariants.go (1)
- 29-29: The update in the
GroupTotalWeightInvariantfunction to usekeeper.environment.KVStoreServicealigns with the migration to an environment bundler, ensuring that the invariant check utilizes the new setup correctly.x/group/module/module.go (1)
- 151-151: The simplification of the
EndBlockmethod to directly callkeeper.EndBlockeris a positive change, enhancing the clarity and maintainability of the code.x/group/keeper/genesis_test.go (2)
- 56-56: The introduction of the
runtime.NewEnvironmentcall to create anenvvariable is aligned with the PR's objective to integrate theappmodule.Environmentinto theKeeperstructure. This change enhances the module's interaction with different application services by providing streamlined access.- 77-77: The modification to include the
envparameter in thekeeper.NewKeeperfunction call is correctly implemented. This change is crucial for utilizing the new environment bundler, enabling more efficient access to application services within thex/groupmodule.x/group/keeper/grpc_query_test.go (1)
- 72-74: The update to initialize the
groupKeeperwith a newruntime.Environmentinstance is correctly implemented and aligns with the PR's objective to enhance the module's architecture by integrating theappmodule.Environment. This change facilitates improved access to application services.x/group/keeper/grpc_query.go (25)
- 22-22: The change from
sdk.Contexttocontext.Contextin theGroupInfofunction aligns with the PR's objective to utilize the environment bundler. Ensure that all downstream calls within this function and related functions are compatible withcontext.Context.- 33-35: The
getGroupInfofunction correctly usescontext.Context. It's important to verify thatk.environment.KVStoreService.OpenKVStore(ctx)properly handles the standard Gocontext.Contextand that any context cancellation or deadlines are respected.- 40-40: The
GroupPolicyInfofunction's switch tocontext.Contextis consistent with the overall migration strategy. Similar to other functions, ensure compatibility and proper handling of the context throughout the call chain.- 55-57: In
getGroupPolicyInfo, the use ofcontext.Contextand interaction withk.environment.KVStoreService.OpenKVStore(ctx)should be checked for correct context handling, especially regarding cancellation and deadlines.- 61-61: The
GroupMembersfunction's adaptation tocontext.Contextis part of the module's migration to use an environment bundler. Ensure that the context is correctly propagated through all underlying calls.- 81-82: For
getGroupMembers, it's crucial to confirm thatk.environment.KVStoreService.OpenKVStore(ctx)respects thecontext.Contextpassed, especially for long-running operations that might be subject to cancellation.- 86-86: The
GroupsByAdminfunction's update to usecontext.Contextis in line with the migration goals. Ensure that all related operations properly handle the context, including any potential error handling or cancellation scenarios.- 109-110: In
getGroupsByAdmin, verify that the context passed tok.environment.KVStoreService.OpenKVStore(ctx)is correctly utilized, particularly in terms of handling cancellations or timeouts.- 114-114: The
GroupPoliciesByGroupfunction's switch tocontext.Contextis consistent with the migration to an environment bundler. Ensure that the context is properly propagated and handled in all underlying calls.- 134-135: For
getGroupPoliciesByGroup, it's important to ensure thatk.environment.KVStoreService.OpenKVStore(ctx)correctly handles thecontext.Context, especially for operations that might be affected by context cancellation or deadlines.- 140-140: The
GroupPoliciesByAdminfunction's adaptation tocontext.Contextaligns with the module's migration strategy. As with other functions, ensure that the context is correctly handled throughout the call chain.- 163-164: In
getGroupPoliciesByAdmin, confirm thatk.environment.KVStoreService.OpenKVStore(ctx)properly utilizes thecontext.Context, particularly in terms of respecting cancellations and deadlines.- 168-168: The
Proposalfunction's update to usecontext.Contextis part of the broader migration to an environment bundler. Ensure that all related operations and downstream calls correctly handle the context.- 179-179: The
ProposalsByGroupPolicyfunction's switch tocontext.Contextis consistent with the module's migration goals. Verify that the context is properly propagated and handled in all underlying operations.- 202-203: For
getProposalsByGroupPolicy, it's crucial to ensure thatk.environment.KVStoreService.OpenKVStore(ctx)respects thecontext.Contextpassed, especially for operations that might be subject to cancellation.- 207-209: The
getProposalfunction correctly usescontext.Context. Verify thatk.environment.KVStoreService.OpenKVStore(ctx)properly handles the standard Gocontext.Context, including any context cancellation or deadlines.- 216-216: The
VoteByProposalVoterfunction's adaptation tocontext.Contextaligns with the module's migration strategy. Ensure that the context is correctly handled throughout the call chain, especially in error handling or cancellation scenarios.- 232-232: The
VotesByProposalfunction's update to usecontext.Contextis part of the broader migration to an environment bundler. Verify that all related operations and downstream calls correctly handle the context.- 252-252: The
VotesByVoterfunction's switch tocontext.Contextis consistent with the module's migration goals. Ensure that the context is properly propagated and handled in all underlying operations.- 275-275: The
GroupsByMemberfunction's adaptation tocontext.Contextaligns with the module's migration strategy. As with other functions, ensure that the context is correctly handled throughout the call chain.- 312-314: In
getVote, confirm thatk.environment.KVStoreService.OpenKVStore(ctx)properly utilizes thecontext.Context, particularly in terms of respecting cancellations and deadlines.- 318-319: For
getVotesByProposal, it's important to ensure thatk.environment.KVStoreService.OpenKVStore(ctx)correctly handles thecontext.Context, especially for operations that might be affected by context cancellation or deadlines.- 323-324: In
getVotesByVoter, verify that the context passed tok.environment.KVStoreService.OpenKVStore(ctx)is correctly utilized, particularly in terms of handling cancellations or timeouts.- 328-328: The
TallyResultfunction's update to usecontext.Contextis part of the broader migration to an environment bundler. Ensure that all related operations and downstream calls correctly handle the context, including any potential error handling or cancellation scenarios.- 356-356: The
Groupsfunction's switch tocontext.Contextis consistent with the module's migration goals. Verify that the context is properly propagated and handled in all underlying operations, especially in terms of respecting cancellations and deadlines.x/group/keeper/keeper_test.go (9)
- 12-12: The addition of the
"cosmossdk.io/core/appmodule"import is necessary for utilizing theappmodule.Environmenttype within the test suite. This change aligns with the PR's objective to integrate the environment bundler into thex/groupmodule.- 49-49: Adding the
environmentfield of typeappmodule.Environmentto theTestSuitestruct is a crucial step in enabling the test suite to utilize the new environment bundler. This change is consistent with the PR's goal of enhancing the module's interaction with application services.- 61-62: Initializing the
envvariable withruntime.NewEnvironment(storeService, log.NewNopLogger())and subsequently assigning it tos.environmentis a correct implementation for setting up the environment bundler within the test suite. This setup is essential for the subsequent use of theenvironmentin keeper and other module functions.- 83-83: The modification to the
keeper.NewKeepercall to include theenvparameter is in line with the changes made to the keeper's constructor to accept anappmodule.Environmentparameter. This adjustment ensures that the keeper instance within the test suite is correctly initialized with the environment bundler.- 87-88: Assigning the initialized
envtos.environmentcorrectly stores the environment instance for use in subsequent tests. This assignment is necessary for tests that require access to the environment bundler.- 280-280: The modification to the
EndBlockercall to include thespec.newCtxparameter is consistent with the updated function signature. However, it's important to note that theEndBlockerfunction does not require theenvironmentparameter directly in its arguments. The context provided should already be enriched with necessary environmental data, ensuring that the function operates within the correct context.- 342-342: The modification to the
PruneProposalscall to include thes.environmentparameter is necessary following the changes to the function signature. This ensures that the function has access to the environment bundler, allowing it to perform its operations with the correct context and access to application services.- 465-465: The call to
TallyProposalsAtVPEndwith thectxands.environmentparameters correctly reflects the updated function signature. This change is part of the broader effort to integrate the environment bundler into the module's operations, ensuring that the tallying process has access to the necessary application services.- 532-532: Similar to the previous comment, the call to
TallyProposalsAtVPEndin the context of testing group member leaving scenarios is correctly updated to include theenvironmentparameter. This ensures that the function operates with the correct context and access to application services, even in more complex test scenarios.x/group/keeper/abci_test.go (4)
- 1-1: Renaming the package from
module_testtokeeper_testaligns with Go conventions for naming test packages. This change improves clarity by explicitly indicating that these tests are for thekeeperpackage within thex/groupmodule.- 166-166: The replacement of
submitProposalAndVotewithsubmitProposalAndVoteHelperacross multiple test cases ensures consistency in how proposals are submitted and voted on within these tests. This change likely reflects an effort to standardize test utilities and improve the readability and maintainability of the test code.Also applies to: 181-181, 196-196, 211-211, 225-225, 245-245, 257-257, 272-272, 288-288, 310-310
- 336-336: Directly calling the
EndBlockerfunction ons.groupKeeperin the test cases for proposal pruning and tallying, instead of through themodulepackage, is a significant change. This approach is more direct and likely reflects the architectural changes introduced by the PR, where thex/groupmodule's interaction with application services is streamlined through theappmodule.Environment. It's important to ensure that this direct invocation accurately simulates the conditions under whichEndBlockerwould be called in a live environment.Also applies to: 539-539
- 558-558: The introduction of
submitProposalHelperandsubmitProposalAndVoteHelperfunctions at the end of the file is a good practice, as it abstracts the proposal submission and voting logic into reusable components. This not only DRYs up the test code but also makes it easier to understand and maintain. However, it's crucial to ensure that these helper functions accurately represent the proposal submission and voting process as it would occur in the actual application.Also applies to: 576-576
simapp/app.go (1)
- 368-368: The initialization of
app.GroupKeeperhas been updated to include aruntime.NewEnvironmentcall, passingloggeras an argument. This change aligns with the PR's objective to integrate theappmodule.Environmentinto theKeeperstructure for thex/groupmodule, facilitating enhanced access to application services. The modification appears to be correctly implemented, adhering to the described objectives and best practices for maintainability and modularity.However, it's important to ensure that all downstream usages of
app.GroupKeeperand related components are updated to accommodate this change, especially if they rely on the previous initialization pattern. Additionally, thorough testing should be conducted to verify that the integration of the environment bundler does not introduce any unintended side effects or regressions in the module's functionality.x/group/keeper/msg_server.go (22)
- 29-29: The function
CreateGroupnow correctly usescontext.Contextas its context parameter, aligning with the migration to the new environment bundler. This change is consistent and correctly implemented.- 64-64: The use of
k.environment.KVStoreService.OpenKVStore(ctx)to obtain the KV store is a significant change that aligns with the new environment bundler approach. This ensures that theKeepercan interact with the KV store in a context-aware manner, improving modularity and maintainability.- 71-71: The retrieval of the current block time using
k.environment.HeaderService.GetHeaderInfo(ctx).Timeis a good practice, ensuring that the timestamp used inCreateGroupand other operations is consistent and accurate.- 94-94: The use of
k.environment.EventService.EventManager(ctx).Emitfor emitting events is correctly implemented, leveraging the new environment bundler. This change enhances the modularity and flexibility of event management within the module.- 101-101: The migration of
UpdateGroupMembersto usecontext.Contextand the new environment bundler is correctly implemented. This change is consistent across the module and improves the maintainability and modularity of the code.- 114-114: The logic for updating group members, including handling member weight updates and deletions, is well-structured and maintains the integrity of group weights. The use of the new environment bundler for accessing the KV store and other services is correctly applied.
- 192-192: The addition of the member's
AddedAttimestamp usingk.environment.HeaderService.GetHeaderInfo(ctx).Timeduring member creation is a good practice, ensuring consistency in the handling of timestamps across the module.- 221-221: The
UpdateGroupAdminfunction's migration to usecontext.Contextand the new environment bundler is correctly implemented, aligning with the module's overall migration strategy. This enhances the maintainability and modularity of the code.- 253-253: The changes in
UpdateGroupMetadatato usecontext.Contextand leverage the new environment bundler are correctly implemented. This consistency in the migration approach across the module is commendable.- 328-328: The
CreateGroupPolicyfunction's adaptation to usecontext.Contextand the new environment bundler, especially for decision policy validation and group policy account creation, is well-executed. This change enhances the module's architecture and maintainability.- 370-370: The loop for handling potential address collisions during group policy account creation is a prudent measure. It ensures the uniqueness of the account address, which is crucial for the integrity of group policies.
- 421-421: The use of
k.environment.EventService.EventManager(ctx).Emitfor emitting theEventCreateGroupPolicyevent is correctly implemented, leveraging the new environment bundler for event management.- 428-428: The migration of
UpdateGroupPolicyAdminto usecontext.Contextand the new environment bundler is correctly implemented. This change is consistent with the module's overall migration strategy and improves the code's maintainability.- 451-451: The
UpdateGroupPolicyDecisionPolicyfunction's adaptation to usecontext.Contextand the new environment bundler, especially for decision policy validation and update, is well-executed. This enhances the module's architecture and maintainability.- 489-489: The changes in
UpdateGroupPolicyMetadatato usecontext.Contextand leverage the new environment bundler are correctly implemented. This consistency in the migration approach across the module is commendable.- 511-511: The
SubmitProposalfunction's comprehensive update to usecontext.Contextand the new environment bundler, especially for proposal validation and submission, is well-executed. This change significantly enhances the module's functionality and maintainability.- 563-563: The logic for ensuring that only group members can submit proposals and for executing proposal messages is well-structured and correctly leverages the new environment bundler. This maintains the integrity and functionality of the proposal submission process.
- 621-621: The use of
k.environment.EventService.EventManager(ctx).Emitfor emitting theEventSubmitProposalevent is correctly implemented, leveraging the new environment bundler for event management. This enhances the modularity and flexibility of event handling within the module.- 655-655: The migration of
WithdrawProposalto usecontext.Contextand the new environment bundler is correctly implemented. This change is consistent with the module's overall migration strategy and improves the code's maintainability.- 697-697: The
Votefunction's adaptation to usecontext.Contextand the new environment bundler, especially for vote validation and storage, is well-executed. This enhances the module's architecture and maintainability.- 781-781: The
doTallyAndUpdatefunction's logic for performing a tally and updating the proposal status based on the tally result is well-structured and correctly leverages the new environment bundler. This maintains the integrity of the voting and proposal finalization process.- 914-914: The
LeaveGroupfunction's comprehensive update to usecontext.Contextand the new environment bundler, especially for group member removal and group weight update, is well-executed. This change significantly enhances the module's functionality and maintainability.
Comment on lines
+2030
to
+2035
| key := storetypes.NewKVStoreKey(group.StoreKey) | ||
| env := runtime.NewEnvironment(runtime.NewKVStoreService(key), log.NewNopLogger()) | ||
| vpe := resp.Proposal.VotingPeriodEnd | ||
| timeDiff := vpe.Sub(s.sdkCtx.HeaderInfo().Time) | ||
| ctxVPE := sdkCtx.WithHeaderInfo(header.Info{Time: s.sdkCtx.HeaderInfo().Time.Add(timeDiff).Add(time.Second * 1)}) | ||
| s.Require().NoError(s.groupKeeper.TallyProposalsAtVPEnd(ctxVPE)) | ||
| s.Require().NoError(s.groupKeeper.TallyProposalsAtVPEnd(ctxVPE, env)) |
There was a problem hiding this comment.
The use of runtime.NewEnvironment and runtime.NewKVStoreService within a test case seems unusual and might not reflect a typical usage pattern in Cosmos SDK modules. It's important to ensure that this setup accurately represents the intended environment and store interactions for the functionality being tested. If this pattern is specific to the test environment and does not mirror the actual application's runtime environment, consider adding a comment to clarify its purpose and usage in this context.
// Ensure the use of runtime.NewEnvironment and runtime.NewKVStoreService accurately represents the intended environment for the functionality being tested.
tac0turtle
approved these changes
Feb 20, 2024
julienrbrt
approved these changes
Feb 20, 2024
This was referenced Apr 18, 2024
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
ref: #19290
Migrate x/group module to use environment bundler
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
EndBlockerfunction that updates proposal tallies and prunes expired proposals.appmodule.Environment.runtime.Environment.context.Contextfor consistency.environmentparameter.