refactor(store/v2): get rid of WorkingHash

[cool-develope]

Description

Closes: #20239

The final piece of store/v2 API cleanup, untouched the WorkingHash logic of commitment and iavl for the future use-case.

---

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

  • Simplified the commit process by integrating the WorkingHash functionality into the Commit method.
  • Removed redundant workingHash field and related assertions in tests.

• Bug Fixes

  • Improved error handling and assertions in various test functions to ensure accuracy and reliability.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve the removal of the WorkingHash method and its associated field from the Store struct and related tests. The functionality of WorkingHash has been integrated into the Commit method, simplifying the API and cleaning up unused methods. This refactoring aligns with the objectives of API cleanup by eliminating deprecated and redundant methods.

Changes

File	Change Summary
store/v2/root/migrate_test.go	Removed calls to WorkingHash in TestMigrateState function.
store/v2/root/store.go	Removed workingHash field, refactored WorkingHash into Commit, and simplified commitSC method.
store/v2/root/store_test.go	Removed workingHash related code in various test functions and adjusted error handling and assertions.
store/v2/store.go	Removed WorkingHash method from RootStore interface and integrated its functionality into Commit.

Assessment against linked issues

Objective	Addressed	Explanation
Remove WorkingHash method from RootStore interface (Issue #20239)	✅
Refactor Commit method to include functionality of WorkingHash (Issue #20239)	✅
Simplify and rename commitSC method (Issue #20239)	✅
Remove workingHash related code in test files and adjust error handling and assertions (Issue #20239)	✅

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

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 b4f8815 and 62d7e92.

Files selected for processing (4)

• store/v2/root/migrate_test.go (2 hunks)
• store/v2/root/store.go (7 hunks)
• store/v2/root/store_test.go (6 hunks)
• store/v2/store.go (1 hunks)

Files skipped from review due to trivial changes (1)

• store/v2/root/migrate_test.go

Additional Context Used

Path-based Instructions (3)

store/v2/store.go (1)

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

store/v2/root/store_test.go (2)

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

---

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

store/v2/root/store.go (1)

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

Additional comments not posted (7)

store/v2/store.go (1)

56-56: LGTM! The removal of the WorkingHash method from the RootStore interface aligns with the PR objectives.

store/v2/root/store_test.go (3)

144-144: LGTM! The removal of the WorkingHash method call in the TestQuery function is appropriate.

---

247-247: LGTM! The removal of the WorkingHash method call in the TestCommit function is appropriate.

---

283-286: LGTM! The removal of the WorkingHash method call in the TestStateAt function is appropriate.

store/v2/root/store.go (3)

254-257: LGTM! The Commit method now appropriately handles writing changesets to the backend and returning the resulting root hash.

---

413-423: LGTM! The writeSC method now appropriately handles writing the changeset to the SC tree and updating the last commit info.

---

413-423: LGTM! The commitSC method now appropriately handles committing the SC store and verifying the commit hash.

[tac0turtle]

this makes sense, then for ISR we can have a different tool that works directly with the underlying commitment store or have store have an extension interface

[testinginprod]

Less is more!

TY @cool-develope