feat(api): cache bridge limits

bigboydiamonds commented 2 months ago

Description Caching responses based on query params for /bridgeLimits endpoint.

Using node-fetch package to cache responses for 1hr.

Summary by CodeRabbit

New Features
- Introduced caching functionality in the bridge limits controller to improve response times for repeated requests.
- Implemented a standard time-to-live (TTL) of 3600 seconds for cached responses.
Bug Fixes
- Enhanced response structure to ensure consistent data caching and handling of null values for maximum and minimum amounts.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce a new caching mechanism to the bridgeLimitsController within the packages/rest-api module. A dependency on node-cache has been added, allowing the controller to store and retrieve responses based on query parameters. This optimization reduces processing time for repeated requests by checking for cached responses before executing further logic, ultimately enhancing the efficiency of the API.

Changes

File	Change Summary
packages/rest-api/package.json	Added new dependency `node-cache` version `^5.1.2`.
packages/rest-api/src/controllers/bridgeLimitsController.ts	Implemented caching functionality using `NodeCache`, checking for cached responses before processing requests.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller
    participant Cache
    participant TokenService

    Client->>Controller: Request bridge limits
    Controller->>Cache: Check for cached response
    alt Cache hit
        Cache-->>Controller: Return cached response
        Controller-->>Client: Send response
    else Cache miss
        Controller->>TokenService: Retrieve token information
        TokenService-->>Controller: Return token data
        Controller->>Cache: Cache the response
        Controller-->>Client: Send response
    end

Poem

In the garden of code, a rabbit hops free,
Caching the limits, as swift as can be.
With node-cache added, oh what a delight,
Reducing the waits, making queries so bright!
Hooray for the changes, let’s dance and rejoice,
For faster responses, we all have a voice! 🐇✨

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?

:heart: 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)

:placard: 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](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 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 37.95792%. Comparing base (9418b40) to head (32d0b4b). Report is 29 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3191 +/- ## =================================================== - Coverage 41.54443% 37.95792% -3.58651% =================================================== Files 460 418 -42 Lines 25770 24240 -1530 Branches 357 82 -275 =================================================== - Hits 10706 9201 -1505 + Misses 14326 14301 -25 Partials 738 738 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3191/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/3191/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.96267% <ø> (ø)` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3191/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | 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 2 months ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`32d0b4b`
Status:	✅ Deploy successful!
Preview URL:	https://9453c99d.sanguine-fe.pages.dev
Branch Preview URL:	https://api-cache-bridge-limits.sanguine-fe.pages.dev

View logs

synapsecns / sanguine