search

onflow / flow-evm-gateway

FlowEVM Gateway implements an Ethereum-equivalent JSON-RPC API for EVM clients to use
https://developers.flow.com/evm/about
Apache License 2.0
11 stars 9 forks source link

Make indexing of receipts idempotent #429

Closed m-Peter closed 1 month ago

m-Peter commented 1 month ago

Closes: https://github.com/onflow/flow-evm-gateway/issues/400

Description

We do this by indexing all receipts for a block height at once, instead of individually, as was done before.

For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The recent changes significantly enhance the Engine class and associated components by introducing a method for indexing multiple receipts linked to a block. This update includes improved error handling and batch processing capabilities, which promote efficiency and robustness in event processing. Modifications ensure better alignment across tests and interfaces, ultimately enhancing data integrity and streamlining storage operations.

Changes

Files Change Summary
services/ingestion/engine.go, Added indexReceipts method for handling multiple receipts with safety checks; modified processEvents to incorporate receipt indexing.
services/ingestion/engine_test.go Updated TestBlockAndTransactionIngestion to handle batch processing of receipts, enhancing assertions for multiple receipts.
storage/index.go, Revised ReceiptIndexer.Store method to accept multiple receipts and an evmHeight parameter, improving batch storage efficiency.
storage/index_testsuite.go Adjusted test cases to match the updated Store method signature, supporting multiple receipts and the new block height parameter.
storage/mocks/ReceiptIndexer.go, Altered mocked Store method to accept slices of receipts and additional parameters, improving test fidelity for batch operations.
storage/pebble/receipts.go Updated Store method to process multiple receipts with validation against evmHeight, enhancing integrity and efficiency in storage operations.

Sequence Diagram(s)

sequenceDiagram
    participant E as Engine
    participant R as ReceiptIndexer
    participant S as Storage
    participant B as Block

    E->>B: Process block and receipts
    E->>R: Call indexReceipts(receipts, block)
    R->>S: Store(receipts, evmHeight)
    S->>S: Validate each receipt against evmHeight
    S-->>R: Return result
    R-->>E: Return indexing result

Assessment against linked issues

Objective Addressed Explanation
Ensure indexing is idempotent (#400) ❓ Changes improve batch processing but do not confirm idempotence.
Allow for manual reindexing with a special mode (#400) ❌ No implementation for manual reindexing was observed.

Poem

🐰 In the garden where data flows,
With receipts that gather, and blooms that glow.
We index with joy, in batches we play,
Ensuring our blocks are stored without stray.
A hop, a skip, through code we bound,
Efficiency blooms in the changes we've found! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.