synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 25 forks source link

RFQ Relayer: use mutex on listener-triggered handlers #2767

Closed dwasse closed 2 weeks ago

dwasse commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The recent modifications implement enhanced concurrency control to prevent race conditions during state transitions in the chainindexer.go and statushandler.go files. The changes involve introducing mutex locks for transaction IDs to ensure thread-safe handling of events and state transitions. This update aims to improve the robustness and reliability of the system when processing simultaneous operations.

Changes

Files Change Summary
services/rfq/relayer/service/chainindexer.go Added an import for hexutil from the github.com/ethereum/go-ethereum/common package and implemented a blocking lock on the transaction ID mutex in the runChainIndexer function.
services/rfq/relayer/service/statushandler.go Added an import for mapmutex from github.com/synapsecns/sanguine/core/mapmutex, introduced a relayMtx field in QuoteRequestHandler, and added lock-checking logic in the Forward method.

Sequence Diagram

sequenceDiagram
    participant Client
    participant QuoteRequestHandler
    participant ChainIndexer
    Client->>QuoteRequestHandler: Send Transaction Request
    QuoteRequestHandler->>QuoteRequestHandler: Check if lock acquired
    alt Lock acquired
        QuoteRequestHandler->>Client: Reject request
    else No Lock
        QuoteRequestHandler->>ChainIndexer: Forward request
        ChainIndexer->>ChainIndexer: Acquire Mutex Lock
        ChainIndexer->>ChainIndexer: Process transaction events
        ChainIndexer->>ChainIndexer: Release Mutex Lock
        ChainIndexer->>QuoteRequestHandler: Acknowledge receipt
        QuoteRequestHandler->>Client: Confirm transaction
    end

Poem

In the code where bytes align,
Mutexes guard, transactions refine.
Locks acquired, no state to clash,
Concurrency tamed in a hash.
Chainindexer's new stride,
Safe states now abide. 🌟
Hippity hop, no race ignored,
In Rabbit's realm, errors floored!


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 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](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.
codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 0% with 16 lines in your changes missing coverage. Please review.

Project coverage is 25.70202%. Comparing base (99ec69f) to head (777f4c8).

Files Patch % Lines
services/rfq/relayer/service/chainindexer.go 0.00000% 10 Missing :warning:
services/rfq/relayer/service/statushandler.go 0.00000% 6 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2767 +/- ## =================================================== - Coverage 25.70563% 25.70202% -0.00361% =================================================== Files 699 699 Lines 51479 51494 +15 Branches 80 80 =================================================== + Hits 13233 13235 +2 - Misses 36899 36912 +13 Partials 1347 1347 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2767/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/2767/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.00000% <ø> (ø)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/2767/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `27.13163% <0.00000%> (-0.04078%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

cloudflare-pages[bot] commented 2 weeks ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 777f4c8
Status: âœ…  Deploy successful!
Preview URL: https://c70538c6.sanguine-fe.pages.dev
Branch Preview URL: https://feat-rfq-listener-mux.sanguine-fe.pages.dev

View logs