fix(rfq-relayer): skip cache when fetching committable balances [SLT-386]

dwasse commented 1 month ago

Summary by CodeRabbit

New Features
- Enhanced gas balance retrieval process for improved performance and data accuracy.
- Updated methods for handling inventory checks to ensure better management of balance and inventory status.
Bug Fixes
- Maintained consistent error handling for unsupported chains and insufficient inventory scenarios.

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request modifies the HasSufficientGas method in the inventoryManagerImpl struct and updates the commitPendingBalance and handleNotEnoughInventory methods in the QuoteRequestHandler class. The key change is the addition of the SkipDBCache() argument to the GetCommittableBalance method calls, which alters how gas and committable balances are retrieved, bypassing the database cache. The overall control flow and error handling remain unchanged, and various comments and TODOs have been added for future improvements.

Changes

File Path	Change Summary
`services/rfq/relayer/inventory/manager.go`	Updated `HasSufficientGas` method to include `SkipDBCache()` in `GetCommittableBalance` call.
`services/rfq/relayer/service/handlers.go`	Modified `commitPendingBalance` and `handleNotEnoughInventory` methods to include `SkipDBCache()` in `GetCommittableBalance` calls.

Possibly related PRs

2963: The changes in this PR involve modifications to the inventoryManagerImpl struct in manager.go, specifically the introduction of the inFlightQuoteManager, which is relevant to the changes made to the HasSufficientGas method that also involve balance retrieval logic.

Suggested labels

go, needs-go-generate-services/rfq, size/m

Suggested reviewers

trajan0x
aureliusbtc

🐇 In the fields where bunnies roam,
We skip the cache, we call it home.
With gas and balance, all in line,
Our code now dances, oh so fine!
So hop along, let changes flow,
In the land of code, we make it glow! 🌼

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 , please review it.` - `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 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 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 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 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 33.22599%. Comparing base (42c0079) to head (857d137). Report is 13 commits behind head on master.

Files with missing lines	Patch %	Lines
services/rfq/relayer/service/handlers.go	0.00000%	2 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3328 +/- ## =================================================== - Coverage 33.25951% 33.22599% -0.03352% =================================================== Files 543 543 Lines 34769 34780 +11 Branches 82 82 =================================================== - Hits 11564 11556 -8 - Misses 22182 22201 +19 Partials 1023 1023 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3328/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/3328/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.48870% <ø> (ø)` | | | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/3328/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.44834% <ø> (ø)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/3328/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `6.81642% <ø> (ø)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/3328/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `24.54476% <33.33333%> (-0.11682%)` | :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-workers-and-pages[bot] commented 1 month ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`857d137`
Status:	✅ Deploy successful!
Preview URL:	https://4b1f7807.sanguine-fe.pages.dev
Branch Preview URL:	https://fix-skip-cache.sanguine-fe.pages.dev

View logs

synapsecns / sanguine