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

op-e2e: harden WaitForTransaction against tx indexing in progress errors #10600

Merged
merged 1 commit into from
May 21, 2024

Conversation

sebastianst
Copy link
Member

@sebastianst sebastianst commented May 21, 2024

Description

This is a new error by geth that hasn't an exported error type yet, but it indicates that geth is still indexing and so one more try should be done.

Tests

This is used in all e2e tests. If they still pass, and we see a reduction in flakes, then it works.

Additional context

Creates random flakyness in tests. Tried to fix this as part of #10589 but it then made lots of tests fail, so split it out into its own PR. Edit: it's actually that other PR that makes tests fail, not this one.

this is a new error by geth that hasn't an exported error type yet, but
it indicates that geth is still indexing and so one more try is worth
it.
@sebastianst sebastianst requested a review from a team as a code owner May 21, 2024 17:47
@sebastianst sebastianst requested a review from protolambda May 21, 2024 17:47
Copy link
Contributor

coderabbitai bot commented May 21, 2024

Walkthrough

Walkthrough

The recent changes in the wait.go file within the op-e2e/e2eutils/geth directory include the addition of the strings package import, modification of the error constant declaration, and refactoring of the error handling logic in the WaitForTransaction function. These updates aim to enhance the error processing mechanism, likely improving the robustness and clarity of the code.

Changes

File Path Change Summary
op-e2e/e2eutils/geth/wait.go - Added strings package import
- Modified error constant declaration
- Refactored error handling logic in WaitForTransaction function

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between f706f06 and 3167886.
Files selected for processing (1)
  • op-e2e/e2eutils/geth/wait.go (3 hunks)
Additional comments not posted (2)
op-e2e/e2eutils/geth/wait.go (2)

8-8: The import of the strings package is justified as it is used in the error handling logic within WaitForTransaction.


20-20: The addition of the errStrTxIdxingInProgress constant is a good practice as it centralizes the error message, enhancing maintainability and readability.


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

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.
  • 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: 1

op-e2e/e2eutils/geth/wait.go Show resolved Hide resolved
@sebastianst sebastianst requested a review from axelKingsley May 21, 2024 19:15
@sebastianst sebastianst enabled auto-merge May 21, 2024 19:15
Copy link
Contributor

@axelKingsley axelKingsley left a comment

Choose a reason for hiding this comment

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

slam dunk, nice improvement and TY for the context in the description.

op-e2e/e2eutils/geth/wait.go Show resolved Hide resolved
@sebastianst sebastianst added this pull request to the merge queue May 21, 2024
Merged via the queue into develop with commit 8b5e3c2 May 21, 2024
69 checks passed
@sebastianst sebastianst deleted the seb/e2e-fix-wait-tx-indexing branch May 21, 2024 19:41
rdovgan pushed a commit to rdovgan/optimism that referenced this pull request Jun 24, 2024
…ors (ethereum-optimism#10600)

this is a new error by geth that hasn't an exported error type yet, but
it indicates that geth is still indexing and so one more try is worth
it.
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