Skip to content

fix test race condition #237

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

Merged
merged 1 commit into from
Jul 9, 2025
Merged

fix test race condition #237

merged 1 commit into from
Jul 9, 2025

Conversation

iuwqyir
Copy link
Collaborator

@iuwqyir iuwqyir commented Jul 8, 2025

TL;DR

Fix race conditions in search handler tests and improve reorg handler test cleanup.

What changed?

  • Modified the search handler test to use mockStorage.On(...).Maybe() instead of EXPECT() for calls that might not happen due to race conditions
  • Updated the reorg handler test to use a cancelable context and properly wait for the handler to stop
  • Added a timeout check to ensure the reorg handler properly responds to context cancellation

How to test?

  • Run the test suite to verify that the tests now pass consistently without flakiness
  • Verify that the reorg handler test properly cleans up resources by responding to context cancellation

Why make this change?

The search handler tests were flaky due to race conditions where some mocked calls might not be made depending on timing. By using .Maybe(), we allow these calls to be optional, making the tests more reliable.

The reorg handler test was improved to properly clean up resources by using a cancelable context and waiting for the handler to stop, preventing potential resource leaks and making the test more deterministic.

Summary by CodeRabbit

  • Tests
    • Improved test reliability by making certain mock calls optional to accommodate non-deterministic behavior.
    • Enhanced test control and verification for handler shutdown, ensuring proper cleanup and timeout handling.

Copy link

coderabbitai bot commented Jul 8, 2025

Walkthrough

The changes update tests to handle non-determinism and improve goroutine management. In the search handler test, some mocked storage calls are relaxed to allow for optional invocation. In the reorg handler test, explicit context cancellation and shutdown verification are added to ensure proper goroutine termination.

Changes

File(s) Change Summary
internal/handlers/search_handlers_test.go Relaxed mocks for certain storage calls in TestSearch_TransactionHash to allow optional calls; added clarifying comments.
internal/orchestrator/reorg_handler_test.go Added explicit context cancellation and goroutine shutdown verification in TestStartReorgHandler.

Sequence Diagram(s)

sequenceDiagram
    participant Test
    participant ReorgHandler

    Test->>ReorgHandler: Start with cancelable context (in goroutine)
    Note right of ReorgHandler: Handler runs
    Test->>ReorgHandler: Sleep briefly, then cancel context
    ReorgHandler-->>Test: Signals completion via channel
    Test->>Test: Waits for handler to exit (with timeout)
Loading

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 04f775a and b479d94.

📒 Files selected for processing (2)
  • internal/handlers/search_handlers_test.go (2 hunks)
  • internal/orchestrator/reorg_handler_test.go (1 hunks)
🔇 Additional comments (2)
internal/orchestrator/reorg_handler_test.go (1)

539-562: Excellent improvement to goroutine lifecycle management.

The addition of a cancelable context and synchronization channel significantly improves test reliability by:

  • Providing explicit control over the handler's lifecycle
  • Ensuring the test waits for proper handler shutdown
  • Adding timeout verification to confirm cancellation responsiveness

This addresses the race condition issues mentioned in the PR objectives.

internal/handlers/search_handlers_test.go (1)

74-117: Well-targeted approach to handling test race conditions.

The strategic use of .Maybe() for potentially non-deterministic calls while keeping the first transaction search strict is excellent. This ensures:

  • Core functionality is still validated (first call must succeed)
  • Race conditions don't cause test flakiness for subsequent calls
  • Clear documentation via comments explains the timing behavior

This directly addresses the test flakiness mentioned in the PR objectives.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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
Collaborator Author

iuwqyir commented Jul 8, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@iuwqyir iuwqyir marked this pull request as ready for review July 8, 2025 22:11
@iuwqyir iuwqyir merged commit 59e8864 into main Jul 9, 2025
6 checks passed
@iuwqyir iuwqyir deleted the 07-09-fix_test_race_condition branch July 9, 2025 09:43
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.

1 participant