synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 25 forks source link

RFQ Relayer: restrict state transitions #2787

Closed dwasse closed 1 week ago

dwasse commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The recent updates involve integrating a logger for the relayer-db package and modifying the UpdateQuoteRequestStatus function to verify valid state transitions within various services related to RFQs (Request for Quotes). Moreover, the core/mapmutex package has been enhanced with a Keys() method for easier key retrieval, including respective tests, across several map-related mutex interfaces.

Changes

File(s) Summary
services/rfq/relayer/reldb/base/quote.go Added logger and valid state transition checks in UpdateQuoteRequestStatus. Introduced isValidStateTransition.
services/rfq/relayer/reldb/db.go Modified UpdateQuoteRequestStatus method signature to include prevStatus.
services/rfq/relayer/service/chainindexer.go Updated UpdateQuoteRequestStatus calls to include additional prevStatus argument.
services/rfq/relayer/service/handlers.go Enhanced UpdateQuoteRequestStatus usages in various handler functions to pass additional status arguments.
services/rfq/relayer/service/relayer.go Adjusted processRequest for improved status updating logic with status reference passing.
services/rfq/relayer/service/statushandler.go Updated deadlineMiddleware to include req.Status in UpdateQuoteRequestStatus calls.
core/mapmutex/mapmutex.go Added Keys() method to untypedMapMutex and implemented in untypedMapMutexImpl for debugging purposes.
core/mapmutex/mapmutex_test.go Introduced tests for key retrieval functionalities in various map mutex types.
core/mapmutex/stringer.go Added Keys() method to StringerMapMutex, StringMapMutex, and IntMapMutex interfaces, and provided implementations.

Poem

A logger’s tale, a journey to refine,
Quote requests now traverse a secure line.
State transitions verified, errors foregone,
Keys unlocked, mutexes carry on.
Debugging’s a breeze, status held tight,
In RFQ’s realm, transitions bright. 🌟🐇


[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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 40.00000% with 45 lines in your changes missing coverage. Please review.

Project coverage is 25.64578%. Comparing base (0d573f2) to head (b140cb2).

Files Patch % Lines
services/rfq/relayer/reldb/base/quote.go 0.00000% 15 Missing :warning:
services/rfq/relayer/service/handlers.go 0.00000% 13 Missing :warning:
services/rfq/relayer/service/statushandler.go 0.00000% 8 Missing :warning:
services/rfq/relayer/service/chainindexer.go 0.00000% 7 Missing :warning:
services/rfq/relayer/service/relayer.go 0.00000% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2787 +/- ## =================================================== + Coverage 25.57487% 25.64578% +0.07090% =================================================== Files 766 766 Lines 54925 54972 +47 Branches 80 80 =================================================== + Hits 14047 14098 +51 + Misses 39428 39427 -1 + Partials 1450 1447 -3 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `31.93780% <ø> (ø)` | | | [core](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `59.29936% <100.00000%> (+0.68200%)` | :arrow_up: | | [ethergo](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `48.27025% <ø> (+0.01356%)` | :arrow_up: | | [explorer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `4.97877% <ø> (ø)` | | | [git-changes-action](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `23.69615% <ø> (ø)` | | | [omnirpc](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `33.08129% <ø> (ø)` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.21082% <ø> (ø)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `8.50242% <ø> (ø)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `27.07075% <0.00000%> (-0.05088%)` | :arrow_down: | | [screener-api](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `29.79798% <ø> (+0.50505%)` | :arrow_up: | | [scribe](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `18.17597% <ø> (+0.06437%)` | :arrow_up: | | [tools](https://app.codecov.io/gh/synapsecns/sanguine/pull/2787/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `30.55118% <ø> (ø)` | | 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: b140cb2
Status: ✅  Deploy successful!
Preview URL: https://1e17f5b9.sanguine-fe.pages.dev
Branch Preview URL: https://feat-restrict-state-tx.sanguine-fe.pages.dev

View logs