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

feat(op-service):Persist RethDB instance in the go fetcher struct. #9904

Merged

Conversation

Nickqiaoo
Copy link
Contributor

solve for #9349

@Nickqiaoo Nickqiaoo requested a review from a team as a code owner March 19, 2024 09:05
@Nickqiaoo Nickqiaoo requested a review from ajsutton March 19, 2024 09:05
Copy link
Contributor

coderabbitai bot commented Mar 19, 2024

Walkthrough

Walkthrough

The update enhances the RethDB reader service's database handling for better FFI compatibility and robustness. It introduces OpenDBResult for error management, refactors functions to work directly with database instances, and adds a function to open read-only databases. These changes aim to improve modularity, testability, and the service's architecture for database interactions.

Changes

Files Summary
op-service/rethdb-reader/*README.md* Introduced OpenDBResult struct, modified rdb_read_receipts, and added open_db_read_only function.
op-service/rethdb-reader/src/*db.rs* Added functionality for opening a read-only database instance with FFI compatibility and handling success/failure cases.
op-service/rethdb-reader/src/*lib.rs* Updated imports, modified functions to use db_instance as *const c_void, added open_db_read_only function, and adjusted internal struct usage.
op-service/rethdb-reader/src/*receipts.rs* Refactored database handling to use a generic DatabaseEnv type, adjusted function signatures for database instance passing, and updated tests accordingly.
op-service/sources/*eth_client.go* Added a check in NewEthClient to handle nil recProvider, returning an error if so.
op-service/sources/*receipts_caching.go* Added isInnerNil() method to CachingReceiptsProvider struct to check if inner field is nil.
op-service/sources/*reth_db.go* Added OpenDBReadOnly function, updated FetchRethReceipts to use unsafe.Pointer for database instance, and improved database handling in RethDBReceiptsFetcher.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@Nickqiaoo
Copy link
Contributor Author

@clabby @sebastianst Please review🙂

@ajsutton ajsutton requested review from sebastianst and clabby and removed request for ajsutton March 20, 2024 21:13
Copy link
Member

@clabby clabby left a comment

Choose a reason for hiding this comment

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

Rust changes LGTM. Deferring to @sebastianst for final approval of the Go changes. Thank you @Nickqiaoo 🥳

@Nickqiaoo
Copy link
Contributor Author

Could you please review the code when you have free time🥹 @sebastianst

op-service/sources/reth_db.go Outdated Show resolved Hide resolved
op-service/sources/reth_db.go Outdated Show resolved Hide resolved
Co-authored-by: Joshua Gutow <jbgutow@gmail.com>
@trianglesphere trianglesphere added this pull request to the merge queue Mar 28, 2024
Merged via the queue into ethereum-optimism:develop with commit 919df96 Mar 28, 2024
70 checks passed
0xfuturistic pushed a commit that referenced this pull request Apr 24, 2024
…9904)

* feat(op-service):add open_db_read_only func, return reth db instance to go

* feat(op-service):store reth db instance in go,

* fix fmt

* feat(op-service):check err when create RethFetcher

* feat(op-service):add func comments

Co-authored-by: Joshua Gutow <jbgutow@gmail.com>

---------

Co-authored-by: Joshua Gutow <jbgutow@gmail.com>
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

3 participants