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(stf/appmanager): remove the need of recurseStateChanges #20911

Merged
merged 13 commits into from
Jul 18, 2024

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Jul 9, 2024

Description

Closes: #XXXX


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

  • Bug Fixes

    • Adjusted import statements for better organization and linting compliance.
  • Refactor

    • Updated field types and method implementations for improved code structure and performance.
  • Chores

    • Removed redundant comments and simplified methods for clearer code maintenance.

Copy link
Contributor

coderabbitai bot commented Jul 9, 2024

Walkthrough

Walkthrough

The changes primarily involve minor modifications such as formatting tweaks, comment adjustments, and type updates. Significant adjustments include changing the types in appmanager.go and appmanager_builder.go, as well as streamlining the GetStateChanges method in writer_map.go. Additionally, import statements are reordered in multiple test files.

Changes

File Path Change Summary
server/grpc/gogoreflection/serverreflection.go Added an empty line at the end of the ServerReflectionInfo function.
server/v2/api/grpc/gogoreflection/serverreflection.go Removed linting comments (//nolint:staticcheck // SA1019) from multiple lines.
server/v2/appmanager/appmanager.go Changed db field type in AppManager from store.Store to Store and modified initGenesis function.
server/v2/appmanager/appmanager_builder.go Changed DB field type in Builder from store.Store to Store.
server/v2/stf/branch/writer_map.go Simplified GetStateChanges method by removing recurseStateChanges and directly iterating over branchedWriterState.
x/accounts/defaults/lockup/..._locking_account_test.go Reordered import statements for sdk "github.com/cosmos/cosmos-sdk/types".

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.

@kocubinski
Copy link
Member

Not writing the state changes on Commit() of the branches from which a sub branch was derived seems like a unintuitive DevEx to me. Consider the case below, where a is the root state, and each edge is a call to NewWriterMap, i.e. a branch.

graph LR;
a-->b
a-->c
b-->d
Loading

Before: calling d.Commit() will write all changes in d,c,a.
After: calling d.Commit() will write changes in d only.

I don't think we use branching in v2 with that expectation (this PR corrects that) but a consumer of the library might. Does anyone else have an opinion on this? @julienrbrt @tac0turtle

@testinginprod
Copy link
Contributor Author

I agree @kocubinski that your solution is more correct, but I feel that:

  • this PR makes it simpler to implement, less prone to errors on our side.
  • the usage of branching in the SDK consumers happens through the branch.Service which makes you execute in a closure, and commits the state if the closure does not error. So this is solved at DevX lvl from a module builder point of view. It might remain a problem for a server integrator, and I think it is fine for them to shoulder the responsibility of having to understand this.

@testinginprod testinginprod marked this pull request as ready for review July 11, 2024 08:59
@testinginprod testinginprod requested a review from a team as a code owner July 11, 2024 08:59
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: 1

Outside diff range, codebase verification and nitpick comments (1)
server/v2/appmanager/appmanager_builder.go (1)

11-11: Update the import path or type definition for Store.

The type of DB has been changed from store.Store to Store, but the import path for Store is not updated. Ensure that Store is correctly defined or imported.

  • server/v2/appmanager/appmanager_builder.go
Analysis chain

Update the import path or type definition for Store.

The type of DB has been changed from store.Store to Store, but the import path for Store is not updated. Ensure that Store is correctly defined or imported.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the definition or import of `Store`.

# Test: Search for `Store` definition or import. Expect: Correct import or definition.
rg --type go --pattern 'type Store' --files-with-matches

Length of output: 470


Script:

#!/bin/bash
# Verify the definition or import of `Store`.

# Test: Search for `Store` type definitions.
rg 'type Store' --type go -A 2

# Test: Search for `Store` import statements.
rg 'import.*Store' --type go -A 2

Length of output: 7871


Script:

#!/bin/bash
# Verify the import of `Store` in appmanager_builder.go.

# Test: Search for import statements in appmanager_builder.go.
rg '^import' -A 5 server/v2/appmanager/appmanager_builder.go

Length of output: 299

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ff5df35 and e9a2d3b.

Files selected for processing (9)
  • server/grpc/gogoreflection/serverreflection.go (1 hunks)
  • server/v2/api/grpc/gogoreflection/serverreflection.go (1 hunks)
  • server/v2/appmanager/appmanager.go (3 hunks)
  • server/v2/appmanager/appmanager_builder.go (1 hunks)
  • server/v2/stf/branch/writer_map.go (1 hunks)
  • x/accounts/defaults/lockup/continuous_locking_account_test.go (1 hunks)
  • x/accounts/defaults/lockup/delayed_locking_account_test.go (1 hunks)
  • x/accounts/defaults/lockup/periodic_locking_account_test.go (1 hunks)
  • x/accounts/defaults/lockup/permanent_locking_account_test.go (1 hunks)
Files skipped from review due to trivial changes (5)
  • server/v2/api/grpc/gogoreflection/serverreflection.go
  • x/accounts/defaults/lockup/continuous_locking_account_test.go
  • x/accounts/defaults/lockup/delayed_locking_account_test.go
  • x/accounts/defaults/lockup/periodic_locking_account_test.go
  • x/accounts/defaults/lockup/permanent_locking_account_test.go
Additional context used
Path-based instructions (4)
server/v2/appmanager/appmanager_builder.go (1)

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

server/v2/stf/branch/writer_map.go (1)

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

server/v2/appmanager/appmanager.go (1)

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

server/grpc/gogoreflection/serverreflection.go (1)

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

golangci-lint
server/grpc/gogoreflection/serverreflection.go

474-474: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

Additional comments not posted (3)
server/v2/stf/branch/writer_map.go (1)

56-71: Verify the correctness of GetStateChanges method after refactoring.

The method is simplified by removing the recursive recurseStateChanges method and directly iterating over branchedWriterState. Verify that this change does not alter the intended behavior of the method.

Verification successful

The GetStateChanges method after refactoring is correctly implemented.

  • The method iterates over branchedWriterState and collects state changes.
  • The logic for error handling and state change collection aligns with the intended behavior.

The refactoring maintains the method's functionality while simplifying the code by removing the recursive recurseStateChanges method.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the correctness of `GetStateChanges` method after refactoring.

# Test: Ensure that the new implementation is correct and does not alter the intended behavior.
rg --type go --pattern 'GetStateChanges' --context 10

Length of output: 465


Script:

#!/bin/bash
# Verify the correctness of `GetStateChanges` method after refactoring.

# Test: Ensure that the new implementation is correct and does not alter the intended behavior.
rg 'func (b WriterMap) GetStateChanges' -A 10

Length of output: 47


Script:

#!/bin/bash
# Verify the correctness of `GetStateChanges` method after refactoring.

# Test: Ensure that the new implementation is correct and does not alter the intended behavior.
rg 'GetStateChanges' -A 20

Length of output: 7974

server/v2/appmanager/appmanager.go (2)

30-30: Update the import path or type definition for Store.

The type of db has been changed from store.Store to Store, but the import path for Store is not updated. Ensure that Store is correctly defined or imported.


Line range hint 53-87:
Verify the correctness of InitGenesis method after refactoring.

The method's logic involves initializing the genesis state and handling state changes. Ensure that the refactoring does not introduce any errors or change the intended behavior.

@@ -471,3 +471,4 @@ func (s *serverReflectionServer) ServerReflectionInfo(stream rpb.ServerReflectio
}
}
}

Copy link
Contributor

Choose a reason for hiding this comment

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

File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order.

The file is not formatted according to the specified gci rules. Ensure that the file is correctly formatted.

+ // Add an empty line to format the file according to `gci` rules.

Committable suggestion was skipped due to low confidence.

Tools
golangci-lint

474-474: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

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.

@testinginprod SGTM, it does simplify the API. Also I don't think WriterMap.ApplyStateChanges was available when I implemented the recursive approach initially, which does indeed remove the need for it.

@tac0turtle
Copy link
Member

seems this broke something in system tests, not exactly sure how

Merged via the queue into main with commit 82646fc Jul 18, 2024
73 checks passed
@testinginprod testinginprod deleted the tip/remove_recurse_state_changes branch July 18, 2024 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants