fix: Do not share prefix store by alpe · Pull Request #83 · evstack/ev-abci

alpe · 2025-05-07T10:54:17Z

Resolves #76

Overview

Summary by CodeRabbit

Bug Fixes
- Improved internal datastore handling to ensure correct state persistence and retrieval.
Tests
- Added comprehensive tests to verify state saving and loading functionality, ensuring data integrity.
Refactor
- Updated internal struct and constant visibility for better encapsulation and maintainability.

coderabbitai · 2025-05-07T10:54:25Z

Walkthrough

This change refactors the Store struct to use a named datastore field instead of an embedded interface, restricts the prefix constant's visibility, and updates the initialization of rollkitStore in the adapter. It also introduces new tests for state persistence and updates the dependency declaration in go.mod.

Changes

File(s)	Change Summary
pkg/adapter/store.go	Refactored `Store` to use a named `prefixedStore` field (was embedded), made prefix constant unexported.
pkg/adapter/adapter.go	Updated `NewABCIExecutor` to initialize `rollkitStore` directly from the raw store, not the ABCI-prefixed store.
pkg/adapter/store_test.go	Added new tests for state save/load and fixture helpers for state and validator creation.
go.mod	Removed `// indirect` from `github.com/stretchr/testify` dependency.

Sequence Diagram(s)

sequenceDiagram
    participant Test as TestStateIO
    participant DS as InMemoryDatastore
    participant Store as Store
    participant State as State

    Test->>DS: Initialize map datastore
    Test->>Store: Create Store(DS)
    Test->>State: Create stateFixture()
    Test->>Store: Save(State)
    Store->>DS: Put(state key, serialized state)
    Test->>Store: Load()
    Store->>DS: Get(state key)
    Store-->>Test: Return loaded State
    Test->>Test: Assert loaded State equals original

Assessment against linked issues

Objective	Addressed	Explanation
Fix panic on startup caused by incorrect store wrapping and initialization (#76)	✅

Possibly related PRs

feat: use datastore directly for state store #66: Refactored the Store struct and initialization logic, which is further refined in this PR.

Suggested reviewers

tac0turtle

Poem

In the warren, code hops anew,
Prefixes hidden, fields in view.
A store refactored, tests now run,
Bugs chased off, the fix is done!
🐇 With every hop, the state persists—
Startup panics off the lists!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b33e97 and 14a0729.

📒 Files selected for processing (4)

go.mod (1 hunks)
pkg/adapter/adapter.go (1 hunks)
pkg/adapter/store.go (2 hunks)
pkg/adapter/store_test.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: test / Run Unit Tests
GitHub Check: lint / golangci-lint

🔇 Additional comments (9)

go.mod (1)

236-236: Dependency update looks good.

The removal of the // indirect comment for github.com/stretchr/testify correctly marks it as a direct dependency, which aligns with its usage in the new test file.

pkg/adapter/adapter.go (1)

77-77: Great fix: Use independent store instances

This change correctly initializes the rollkitStore with the raw datastore instead of potentially sharing a prefixed datastore with abciStore. This prevents key collisions and ensures proper data isolation between ABCI and Rollkit components.

pkg/adapter/store.go (4)

15-16: Correct encapsulation: Make prefix unexported

Making the prefix constant unexported prevents external code from accidentally using the same prefix, which helps avoid potential key conflicts.

22-24: Proper encapsulation: Use named field instead of embedding

Replacing the embedded interface with a named field improves encapsulation and makes the code's intention clearer. This change prevents accidental direct access to the store methods and forces all access through the intended API.

27-33: Constructor updated correctly

The constructor has been properly updated to initialize the named prefixedStore field instead of embedding the interface.

37-37: Methods correctly updated to use prefixedStore

The LoadState and SaveState methods have been properly updated to use the prefixedStore field instead of relying on embedded methods.

Also applies to: 65-65

pkg/adapter/store_test.go (3)

15-26: Good test for state persistence

This test correctly verifies the functionality of saving and loading state through the store abstraction. It checks both the ability to save/load state and confirms that the data is stored with the expected prefix in the underlying datastore.

28-52: Comprehensive state fixture

The state fixture provides a complete state object with realistic values, which is excellent for thorough testing. This ensures that all state fields are properly serialized and deserialized.

54-62: Good validator helper function

The validator helper function correctly creates a validator with a generated key and reasonable defaults for testing purposes.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

alpe · 2025-05-07T10:56:04Z

 	github.com/spf13/pflag v1.0.6 // indirect
 	github.com/spf13/viper v1.19.0 // indirect
-	github.com/stretchr/testify v1.10.0 // indirect
+	github.com/stretchr/testify v1.10.0


go mod tidy only

alpe · 2025-05-07T10:56:35Z

 	// Create a new Store with ABCI prefix
 	abciStore := NewStore(store)
-	rollkitStore := rstore.New(abciStore)
+	rollkitStore := rstore.New(store)


This line was the key problem. instead of the original store, the prefix store was used.

alpe · 2025-05-07T10:57:22Z

 // Store wraps a datastore with ABCI-specific functionality
 type Store struct {
-	ds.Batching
+	prefixedStore ds.Batching


no need to have the abci store public at this stage when only load/save state is used

Do not share prefix store

14a0729

github-actions Bot assigned alpe May 7, 2025

alpe mentioned this pull request May 7, 2025

Fix state store #82

Closed

alpe commented May 7, 2025

View reviewed changes

alpe requested a review from randygrok May 7, 2025 10:57

julienrbrt approved these changes May 7, 2025

View reviewed changes

tac0turtle approved these changes May 7, 2025

View reviewed changes

julienrbrt merged commit 4abb42a into main May 7, 2025
13 checks passed

julienrbrt deleted the alex/76_store2 branch May 7, 2025 11:41

coderabbitai Bot mentioned this pull request May 7, 2025

chore: fix rollkit store creation #86

Merged

chatton pushed a commit that referenced this pull request Oct 7, 2025

fix: do not share prefix store (#83)

c0eb939

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Do not share prefix store#83

fix: Do not share prefix store#83
julienrbrt merged 1 commit intomainfrom
alex/76_store2

alpe commented May 7, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented May 7, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

alpe May 7, 2025

Uh oh!

alpe May 7, 2025

Uh oh!

alpe May 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

alpe commented May 7, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

alpe May 7, 2025

Choose a reason for hiding this comment

Uh oh!

alpe May 7, 2025

Choose a reason for hiding this comment

Uh oh!

alpe May 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alpe commented May 7, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)