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

fix(db): Fix pebbleDB integration #23552

Merged
merged 2 commits into from
Jan 29, 2025
Merged

fix(db): Fix pebbleDB integration #23552

merged 2 commits into from
Jan 29, 2025

Conversation

alpe
Copy link
Contributor

@alpe alpe commented Jan 29, 2025

Description

Closes: #23133

The loaded data became invalid when the closer was called. From the pebble Godocs:

// The caller should not modify the contents of the returned slice, but it is
// safe to modify the contents of the argument after Get returns. The returned
// slice will remain valid until the returned Closer is closed. On success, the
// caller MUST call closer.Close() or a memory leak will occur.

Note to reviewer:

I was not able to create an integration test to replicate the behaviour within reasonable time. Instead, I used the sims to trigger a failure. Therefore this PR also contains some minor modifications to the sims tests to replicate this.

# in `simapp/v2` run
go test -failfast -count=1 -mod=readonly -tags='sims'  . -run TestAppStateDeterminism -NumBlocks=45 -DBBackend=pebbledb

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

  • New Features

    • Enhanced simulation setup with configurable database backend
    • Added support for dynamic database backend selection
  • Bug Fixes

    • Fixed PebbleDB integration by ensuring data slice integrity
    • Improved data handling in database methods to prevent unintended modifications
  • Improvements

    • Updated default simulation database backend to memDB
    • Expanded database backend configuration options

@alpe alpe requested review from a team and julienrbrt as code owners January 29, 2025 11:22
Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to enhance the flexibility of database backend configuration in the simulation environment. Changes span multiple files, including simapp/v2/sim_runner.go, simapp/v2/sim_test.go, store/v2/db/pebbledb.go, and x/simulation/client/cli/flags.go. The primary focus is on enabling dynamic specification of database backends during test instance setup, improving the configuration options for simulation testing and addressing potential issues with database backend selection.

Changes

File Change Summary
simapp/v2/sim_runner.go, simapp/v2/sim_test.go Added dbBackend parameter to SetupTestInstance function and updated its calls to use cfg.DBBackend for dynamic database backend configuration.
store/v2/db/pebbledb.go Modified Get and Key methods to return cloned byte slices, enhancing data integrity.
x/simulation/client/cli/flags.go Changed default FlagDBBackendValue from "goleveldb" to "memdb" and updated flag description.
store/v2/CHANGELOG.md Added entry for bug fix related to pebbleDB integration.

Assessment against linked issues

Objective Addressed Explanation
Fix pebbledb configuration in app.toml [#23133]
Support dynamic database backend selection

Possibly related PRs

Suggested labels

C:x/accounts, C:x/protocolpool, C:x/epochs, C:x/params, C:x/gov, C:x/slashing, C:x/distribution, C:x/mint, C:x/authz, C:x/nft, C:x/upgrade, C:x/evidence, C:x/feegrant, C:x/group, C:x/staking, C:x/circuit, C:x/consensus

Suggested reviewers

  • tac0turtle
  • kocubinski
  • julienrbrt
  • cool-develope

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

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. (Beta)
  • @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.

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.

This comment has been minimized.

@alpe alpe changed the title fix (db): Fix pebbleDB integration fix(db): Fix pebbleDB integration Jan 29, 2025
@@ -72,7 +72,7 @@ func (db *PebbleDB) Get(key []byte) ([]byte, error) {
return nil, fmt.Errorf("failed to perform PebbleDB read: %w", err)
}

return bz, closer.Close()
return slices.Clone(bz), closer.Close()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This line is the fix. Cloning the data ensures it remains valid after the closer call

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: 0

🧹 Nitpick comments (1)
store/v2/CHANGELOG.md (1)

34-34: Consider adding more context to the changelog entry.

While the entry follows the correct format, it could be more descriptive about the specific issue that was fixed. Consider adding details about the data invalidation issue and memory leak prevention.

-* [#23552](https://github.com/cosmos/cosmos-sdk/pull/23552) Fix pebbleDB integration
+* [#23552](https://github.com/cosmos/cosmos-sdk/pull/23552) Fix pebbleDB integration to prevent data invalidation and potential memory leaks when accessing data after closing
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f8cb8b and 9a9dbeb.

📒 Files selected for processing (1)
  • store/v2/CHANGELOG.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
store/v2/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: tests (03)
  • GitHub Check: tests (02)
  • GitHub Check: tests (01)
  • GitHub Check: tests (00)
  • GitHub Check: test-store-v2
  • GitHub Check: test-store
  • GitHub Check: test-simapp-v2
  • GitHub Check: build (arm64)
  • GitHub Check: build (amd64)
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: test-integration
  • GitHub Check: Analyze
  • GitHub Check: test-system-v2
  • GitHub Check: golangci-lint
  • GitHub Check: build
  • GitHub Check: Summary
🔇 Additional comments (1)
store/v2/CHANGELOG.md (1)

32-33: LGTM! Section follows the guidelines.

The new "Bug Fixes" section is correctly formatted and placed appropriately under the "Unreleased" section.

@julienrbrt julienrbrt added this pull request to the merge queue Jan 29, 2025
Merged via the queue into main with commit 576448b Jan 29, 2025
73 of 75 checks passed
@julienrbrt julienrbrt deleted the alex/23133_pebbledb branch January 29, 2025 12:05
@robert-zaremba
Copy link
Collaborator

Looks that this should be backported to v0.50 and v0.52

@robert-zaremba
Copy link
Collaborator

I mean, the fix is in store/V2, but me maybe there is a similar bug in "V1"

alpe added a commit that referenced this pull request Jan 30, 2025
* main: (61 commits)
  build(deps): Bump cosmossdk.io/x/tx from 1.0.1 to 1.1.0 (#23547)
  feat(client/v2): add map support (#23544)
  fix(db): Fix pebbleDB integration (#23552)
  build(deps): Bump buf.build/gen/go/cometbft/cometbft/protocolbuffers/go from 1.36.3-20241120201313-68e42a58b301.1 to 1.36.4-20241120201313-68e42a58b301.1 in /api (#23520)
  build(deps): Bump github.com/golang/glog from 1.2.3 to 1.2.4 in /tools/hubl (#23541)
  fix(x/tx): add an option to encode maps using amino json (ref #23513) (#23539)
  build(deps): Bump cosmossdk.io/collections from 1.0.0 to 1.1.0 (#23534)
  build(deps): Bump github.com/bytedance/sonic from 1.12.7 to 1.12.8 in /log (#23516)
  chore: fix changelog for `v0.52.0-rc.2` (#23502)
  build(deps): Bump google.golang.org/protobuf from 1.36.3 to 1.36.4 in /x/upgrade (#23512)
  chore(collections): bring in `protocodec` in collections directly (#23515)
  feat(x/tx): add an option to encode maps using amino json (#23513)
  fix(codec): provide legacy amino og type (#23504)
  chore: remove unecessary SDKGasMeter impl (#23503)
  refactor: replace `golang.org/x/exp` with stdlib (#23501)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /tools/cosmovisor (#23496)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /store (#23494)
  build(deps): Bump github.com/hashicorp/go-plugin from 1.6.2 to 1.6.3 in /store (#23493)
  ci: Fix Ci job target (#23500)
  feat(server/v2): add swagger server component (#23486)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: pebbledb in app.toml doesn't work
3 participants