fix: remove race condition in bouncer observe event by nmammeri · Pull Request #6023 · chainflip-io/chainflip-backend

nmammeri · 2025-07-28T15:06:29Z

Pull Request

Closes: PRO-xxx

Checklist

Please conduct a thorough self-review before opening the PR.

I am confident that the code works.
I have written sufficient tests.
I have written and tested required migrations.
I have updated documentation where appropriate.

Summary

Fixes a race condition in bouncer's observeEvent function between checking for the event in historic blocks and in the new block from a subscription

…lock subscription

coderabbitai · 2025-07-28T15:06:36Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/bouncer-observe-event-history-fix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- 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 generate unit tests to generate unit tests for 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.

codecov · 2025-07-28T15:37:53Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

MxmUrw

Looks good to me, the change moves the check for historical blocks into the loop that checks new blocks coming in from the subscription. This way we won't accidentally miss a block height. (Which could have happened previously)

j4m1ef0rd

This will conflict with a lot with #5997 which i'm still reviewing.
Find to merge this now and replicate the change on the other PR later.

MxmUrw · 2025-08-04T14:26:07Z

Let's merge this to increase the probability of followup PRs to be merged.

…reward * origin/main: feat: delegated staking auction integration (#6022) ci: improve secret passing 🥷 (#6042) feat: generate backspin chain spec (#6041) refactor: return `Ok(None)` instead of error if sol egress witnessing cannot find a tx (#6036) feat: add operator to validator info (#6040) feat: Support for DCA 1 block interval (#6025) feat: added account balance of operator (#6035) fix: remove race condition in bouncer observe event (#6023) fix: use `any::Asset` instead of `ChainlinkAssetpair` in internal price API (#6034) feat: price oracle elections (#5971) feat: don't error if tx is Confirmed (#6019) chore: process all events in a block in parallel (#6013)

This reverts commit ecb2caa.

* fix: remove race condition between historic blocks checking and new block subscription * fix: properly convert header.number to number

* Revert "fix: remove race condition in bouncer observe event (#6023)" This reverts commit ecb2caa. * WIP * chore: lint bouncer * fix: pass header hash as argument * fix: Pass block hash via subscription * fix: stringify block hashes * fix: increase default historical block margin * feat: move bouncer header subs into background thread - allow us to share a single sub instead of opening/closing new ones. - allow more reliable update of eg. finalized block height. * chore: restore `historicalCheckBlocks` to 2 * fix: graceful abort handling. * fix: fix event cache garbage collection (use Array). * fix: correct ordering of historical events * chore: simplify governance test * fix: wait for all order deletion events * fix: more explicit stopping in observeEvent * fix: longer timeout for evm deposit test. * fix: lint * fix: take all matching events in a block * fix: check 2 historical blocks * fix: start historical query at parent block hash * fix: stopping logic operator precendence & tidy up * fix: evm deposits test * feat: further improvements: - Add utility for handling dispatch error - Add utility for waiting for extrinsic inclusion - Use EventRecord type where possible, rather than any - Fix event check in multiple members governance test - Don't rely on observeEvents to detect extrinsic success. * fix: remove asset hub zero balance warning * feat: Use new utils for btc vault swap & open channel checks * feat: increase vitest maxConcurrency value * chore: update timeout values * fix: private btc channel * chore: extra logging * feat: observe current block immediately - add AsyncQueue class for more robust `observableToIterable` impl - store current finalised block hash - prepend current best events to event subscription - set default historical blocks to zero * feat: bouncer: better swap progress diagnostics * chore: reduce number of historical blocks for observerSwapRequested * feat: better logging * feat: more `stopAfter` options. * fix: ensure correct event ordering * chore: reduce vitest concurrency setting * fix: eslint * chore: prettier * refactor: missing changes from Jamie's PR * fix: lint * fix: reduce maxConcurrency * fix: remove waitForPrivateBtcChannel * fix: hold broker mutex while opening private btc channel * fix: make all concurrent tests run at the same time * chore: reduce logger noise * fix: mutex per broker/lp uri instead of global mutexes * fix: use describe correctly * fix: make swaps run concurrently * fix: reduce logger spam * fix: CCM gasLimit tests * fix: prefer isFinalized over isInBlock for AssetHub/Polkadot bouncer submissions * fix: make forceRecoverSolNonce parallel. --------- Co-authored-by: Jamie Ford <Jamie@chainflip.io> Co-authored-by: Maxim Urschumzew <MxmUrw@users.noreply.github.com>

* fix: remove race condition between historic blocks checking and new block subscription * fix: properly convert header.number to number

* Revert "fix: remove race condition in bouncer observe event (#6023)" This reverts commit ecb2caa. * WIP * chore: lint bouncer * fix: pass header hash as argument * fix: Pass block hash via subscription * fix: stringify block hashes * fix: increase default historical block margin * feat: move bouncer header subs into background thread - allow us to share a single sub instead of opening/closing new ones. - allow more reliable update of eg. finalized block height. * chore: restore `historicalCheckBlocks` to 2 * fix: graceful abort handling. * fix: fix event cache garbage collection (use Array). * fix: correct ordering of historical events * chore: simplify governance test * fix: wait for all order deletion events * fix: more explicit stopping in observeEvent * fix: longer timeout for evm deposit test. * fix: lint * fix: take all matching events in a block * fix: check 2 historical blocks * fix: start historical query at parent block hash * fix: stopping logic operator precendence & tidy up * fix: evm deposits test * feat: further improvements: - Add utility for handling dispatch error - Add utility for waiting for extrinsic inclusion - Use EventRecord type where possible, rather than any - Fix event check in multiple members governance test - Don't rely on observeEvents to detect extrinsic success. * fix: remove asset hub zero balance warning * feat: Use new utils for btc vault swap & open channel checks * feat: increase vitest maxConcurrency value * chore: update timeout values * fix: private btc channel * chore: extra logging * feat: observe current block immediately - add AsyncQueue class for more robust `observableToIterable` impl - store current finalised block hash - prepend current best events to event subscription - set default historical blocks to zero * feat: bouncer: better swap progress diagnostics * chore: reduce number of historical blocks for observerSwapRequested * feat: better logging * feat: more `stopAfter` options. * fix: ensure correct event ordering * chore: reduce vitest concurrency setting * fix: eslint * chore: prettier * refactor: missing changes from Jamie's PR * fix: lint * fix: reduce maxConcurrency * fix: remove waitForPrivateBtcChannel * fix: hold broker mutex while opening private btc channel * fix: make all concurrent tests run at the same time * chore: reduce logger noise * fix: mutex per broker/lp uri instead of global mutexes * fix: use describe correctly * fix: make swaps run concurrently * fix: reduce logger spam * fix: CCM gasLimit tests * fix: prefer isFinalized over isInBlock for AssetHub/Polkadot bouncer submissions * fix: make forceRecoverSolNonce parallel. --------- Co-authored-by: Jamie Ford <Jamie@chainflip.io> Co-authored-by: Maxim Urschumzew <MxmUrw@users.noreply.github.com>

fix: remove race condition between historic blocks checking and new b…

55a37be

…lock subscription

nmammeri requested a review from martin-chainflip as a code owner July 28, 2025 15:06

nmammeri requested a review from j4m1ef0rd July 28, 2025 15:06

fix: properly convert header.number to number

4f2a2d4

MxmUrw reviewed Aug 1, 2025

View reviewed changes

j4m1ef0rd approved these changes Aug 4, 2025

View reviewed changes

MxmUrw added this pull request to the merge queue Aug 4, 2025

Merged via the queue into main with commit ecb2caa Aug 4, 2025
54 checks passed

MxmUrw deleted the fix/bouncer-observe-event-history-fix branch August 4, 2025 16:39

j4m1ef0rd mentioned this pull request Aug 14, 2025

fix: bouncer flakiness in observe-event #5997

Merged

dandanlen added a commit that referenced this pull request Aug 20, 2025

Revert "fix: remove race condition in bouncer observe event (#6023)"

5012bba

This reverts commit ecb2caa.

dandanlen pushed a commit that referenced this pull request Aug 26, 2025

fix: remove race condition in bouncer observe event (#6023)

8df48a0

* fix: remove race condition between historic blocks checking and new block subscription * fix: properly convert header.number to number

dandanlen pushed a commit that referenced this pull request Aug 26, 2025

fix: remove race condition in bouncer observe event (#6023)

832631f

* fix: remove race condition between historic blocks checking and new block subscription * fix: properly convert header.number to number

dandanlen pushed a commit that referenced this pull request Aug 26, 2025

fix: remove race condition in bouncer observe event (#6023)

10c25a9

* fix: remove race condition between historic blocks checking and new block subscription * fix: properly convert header.number to number

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: remove race condition in bouncer observe event#6023

fix: remove race condition in bouncer observe event#6023
MxmUrw merged 2 commits intomainfrom
fix/bouncer-observe-event-history-fix

nmammeri commented Jul 28, 2025

Uh oh!

coderabbitai bot commented Jul 28, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jul 28, 2025

Uh oh!

MxmUrw left a comment

Uh oh!

j4m1ef0rd left a comment

Uh oh!

MxmUrw commented Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

nmammeri commented Jul 28, 2025

Pull Request

Checklist

Summary

Uh oh!

coderabbitai bot commented Jul 28, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jul 28, 2025

Codecov Report

Uh oh!

MxmUrw left a comment

Choose a reason for hiding this comment

Uh oh!

j4m1ef0rd left a comment

Choose a reason for hiding this comment

Uh oh!

MxmUrw commented Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CodeRabbit Configuration File (`.coderabbit.yaml`)