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

Start event ingestion on proper block height when connecting to local Emulator #753

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

m-Peter
Copy link
Collaborator

@m-Peter m-Peter commented Feb 10, 2025

Description

The Emulator always starts at block height 0, so if we try to subscribe at block height 1, we'll get an error, as it doesn't exist.


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced error handling for event ingestion, improving stability in local testing environments by preventing potential subscription issues.

Copy link
Contributor

coderabbitai bot commented Feb 10, 2025

Walkthrough

This change adds a conditional check in the StartEventIngestion method of the Bootstrap struct. When the latestCadenceHeight equals config.EmulatorInitCadenceHeight, the logic decrements the nextCadenceHeight by one, preventing an attempt to subscribe to a non-existent block height (block height 1) when using a local Emulator. No modifications were made to the public interfaces.

Changes

File Summary
bootstrap/bootstrap.go Added a conditional check in StartEventIngestion to decrement nextCadenceHeight when latestCadenceHeight matches the emulator init height, preventing subscription at an invalid block height.

Sequence Diagram(s)

sequenceDiagram
    participant B as Bootstrap
    participant A as Access Node
    participant E as Emulator

    B->>B: StartEventIngestion()
    alt latestCadenceHeight equals config.EmulatorInitCadenceHeight
        B->>B: Decrement nextCadenceHeight by 1
    else
        B->>B: Use latestCadenceHeight as-is
    end
    B->>A: Subscribe to events at nextCadenceHeight
Loading

Possibly related PRs

Suggested labels

Improvement, EVM

Suggested reviewers

  • janezpodhostnik
  • zhangchiqing
  • peterargue

Poem

Hopping along with careful care,
I fixed a bug with a snare.
A tiny check, a subtle twist,
Block heights now can't be missed!
Leaping forward with joy and flair 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
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)
bootstrap/bootstrap.go (1)

148-153: LGTM! Consider adding a debug log.

The special case handling for the Emulator is well-implemented and properly documented. The solution effectively prevents the subscription error when the Emulator starts at block height 0.

Consider adding a debug log when this special case is triggered to aid in troubleshooting:

 	if latestCadenceHeight == config.EmulatorInitCadenceHeight {
+		l.Debug().
+			Uint64("next_cadence_height", nextCadenceHeight).
+			Msg("adjusting next cadence height for Emulator")
 		nextCadenceHeight -= 1
 	}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4d3dfcd and 36fe0b8.

📒 Files selected for processing (1)
  • bootstrap/bootstrap.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test

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)
bootstrap/bootstrap.go (1)

148-153: Add test coverage for Emulator special case.

Consider adding a test case to verify the behavior when connecting to a local Emulator, ensuring that the block height adjustment works as expected.

Would you like me to help generate the test case for this special case handling?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4d3dfcd and 36fe0b8.

📒 Files selected for processing (1)
  • bootstrap/bootstrap.go (1 hunks)
🔇 Additional comments (2)
bootstrap/bootstrap.go (2)

148-153: LGTM! Well-documented special case handling for local Emulator.

The implementation correctly handles the edge case where the local Emulator starts at block height 0, preventing the subscription attempt to non-existent block height 1.


128-135: Verify block height validation for Emulator case.

The block height validation might fail when using the Emulator and latestCadenceHeight is 0, as it attempts to load the block before applying the special case adjustment.

Consider moving the Emulator special case handling before the block height validation or adding a specific validation bypass for the Emulator case.

@nvdtf
Copy link
Member

nvdtf commented Feb 10, 2025

I had an issue where the dockerized version of the emulator and gateway don't work together unless a transaction is executed on emulator and gateway is restarted (thus, starting from height 1 instead of 0). Seems like this fixes my issue! Thanks!

@m-Peter m-Peter merged commit 6067e1c into main Feb 11, 2025
2 checks passed
@m-Peter m-Peter deleted the mpeter/fix-local-dev-with-emulator branch February 11, 2025 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants