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

Problem: slices in ReadOptions is freed by gc while referenced in rocksdb #1751

Merged
merged 5 commits into from
Feb 24, 2025

Conversation

mmsqe
Copy link
Collaborator

@mmsqe mmsqe commented Feb 19, 2025

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • Bug Fixes
    • Added a fix for resource management in the version database, ensuring proper handling of read options to enhance stability and prevent potential memory leaks. Users should notice improved reliability in data reading operations.

Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

This pull request introduces a new entry in the CHANGELOG.md under the "Bug Fixes" section, detailing a fix for the versiondb related to the management of read options. Additionally, the GetAtVersionSlice and iteratorAtVersion methods in store.go are modified to utilize a variable for read options, which is explicitly destroyed after use. These changes enhance resource management and code clarity without altering the existing logic.

Changes

File Summary
CHANGELOG.md Added a new bug fix entry for versiondb to note the missing destroy call for read options.
versiondb/tsrocksdb/store.go Updated GetAtVersionSlice and iteratorAtVersion methods to create a readOpts variable, use it for operations, and explicitly destroy it afterward.
go.mod Updated github.com/cosmos/cosmos-sdk dependency version from v0.43.0-beta1.0.20250224020346-25e0cb78f920 to v0.43.0-beta1.0.20250224030921-39d7b26bbb97.
gomod2nix.toml Updated github.com/cosmos/cosmos-sdk module version and hash to reflect the new version v0.43.0-beta1.0.20250224030921-39d7b26bbb97 and its corresponding hash.

Possibly related PRs

  • Problem: recent bug fixes are not included #1690: The changes in the main PR regarding the addition of a bug fix entry in the CHANGELOG.md for the versiondb are related to the retrieved PR, which also updates the CHANGELOG.md with a new entry for a command to fix corrupted data in the version database.

Suggested labels

backport/v1.4.x

Suggested reviewers

  • devashishdxt
  • yihuang
  • calvinaco

Poem

I'm a bunny with a coder's zest,
Hopping through code with a happy chest,
Fixed the bugs and cleared the mess,
Read options now rest, no more distress.
With a twitch of whiskers, I celebrate today—
A rabbit's code parade is on its way!
(_/)(o.o)(> <) Hop, hop, hooray!


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.

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.

Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.58%. Comparing base (a3c2f70) to head (5743116).
Report is 41 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1751       +/-   ##
===========================================
+ Coverage   16.87%   35.58%   +18.70%     
===========================================
  Files          72      126       +54     
  Lines        6163    11924     +5761     
===========================================
+ Hits         1040     4243     +3203     
- Misses       5000     7256     +2256     
- Partials      123      425      +302     
Files with missing lines Coverage Δ
versiondb/tsrocksdb/store.go 58.23% <100.00%> (ø)

... and 70 files with indirect coverage changes

@mmsqe mmsqe changed the title Problem: no deallocate read options Problem: no Destroy for read options to properly hold and release options reference Feb 20, 2025
@mmsqe mmsqe marked this pull request as ready for review February 20, 2025 13:43
@mmsqe mmsqe requested a review from a team as a code owner February 20, 2025 13:43
@mmsqe mmsqe requested review from calvinaco and thomas-nguy and removed request for a team February 20, 2025 13:43
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)
gomod2nix.toml (1)

177-178: Dependency Update for github.com/cosmos/cosmos-sdk

The module version and hash have been updated to "v0.43.0-beta1.0.20250224030921-39d7b26bbb97" and "sha256-JVGXvBx9OXnki4fjio/iG1QdclifPxL+YXvaMdVPi5s=" respectively. Ensure that this update is consistent with the changes applied in the go.mod file and that the new version is fully compatible—especially considering any resource management or API changes related to read options.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0856fbf and 5743116.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (2)
  • go.mod (1 hunks)
  • gomod2nix.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • go.mod
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: integration_tests (gas)
  • GitHub Check: integration_tests (slow)
  • GitHub Check: integration_tests (upgrade)
  • GitHub Check: integration_tests (gov)
  • GitHub Check: integration_tests (ica)
  • GitHub Check: integration_tests (ibc_update_client)
  • GitHub Check: build (macos-14)
  • GitHub Check: integration_tests (ibc_timeout)
  • GitHub Check: unittest
  • GitHub Check: integration_tests (ibc_rly_gas)
  • GitHub Check: build (macos-latest)
  • GitHub Check: integration_tests (ibc_rly_evm)
  • GitHub Check: integration_tests (ibc)
  • GitHub Check: integration_tests (unmarked)
  • GitHub Check: Run golangci-lint
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze (go)

@yihuang yihuang changed the title Problem: no Destroy for read options to properly hold and release options reference Problem: slices in ReadOptions is freed by gc while referenced in rocksdb Feb 24, 2025
@mmsqe mmsqe added this pull request to the merge queue Feb 24, 2025
Merged via the queue into crypto-org-chain:main with commit 83a6b18 Feb 24, 2025
38 checks passed
mmsqe added a commit to mmsqe/cronos that referenced this pull request Feb 24, 2025
…ksdb (crypto-org-chain#1751)

* Problem: no deallocate read options

* doc

* sync deps
mmsqe added a commit to mmsqe/cronos that referenced this pull request Feb 24, 2025
…ksdb (crypto-org-chain#1751)

* Problem: no deallocate read options

* doc

* sync deps
mmsqe added a commit that referenced this pull request Feb 27, 2025
* Problem: unable to resolve octokit action v2.0.0 (#1750)

for more info, https://github.com/crypto-org-chain/cronos/actions/runs/13386690642

* Problem: conflict of index uniqueness constrain violation on trace api (#1753)

* Problem: conflict of index uniqueness constrain violation on trace api

* test

* update deps

* bump go

* Problem: slices in ReadOptions is freed by gc while referenced in rocksdb (#1751)

* Problem: no deallocate read options

* doc

* sync deps

* add doc

* Problem: ReadOptions mutated by reference release in iterator fix is not included

* deps
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.

2 participants