fix(rest-api): `/destinationTokens` returns empty list when bridgeable token doesnt exist in bridge map

abtestingalpha commented 1 month ago

Description Not all bridgeable tokens exist in bridgemap, so this handles the case by returning an empty list.

Summary by CodeRabbit

New Features
- Enhanced error handling and response logic in the destination tokens functionality.
- Added a new test case to verify behavior when no destination tokens are available.
Bug Fixes
- Improved response consistency with explicit return statements in the error handling.
Tests
- Introduced a new test scenario for empty responses while maintaining existing test checks.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve modifications to the destinationTokensController in destinationTokensController.ts, enhancing its logic and error handling. A new variable payload is introduced to manage response data, with conditions to set its value based on the presence of fromTokenInfo. The response handling is updated to ensure consistent return statements. Additionally, the test suite in destinationTokensRoute.test.ts is expanded with a new test case to verify behavior when no destination tokens are available, while existing tests remain intact.

Changes

File Path	Change Summary
packages/rest-api/src/controllers/destinationTokensController.ts	Modified logic to introduce `payload`, updated response handling to ensure consistent return statements.
packages/rest-api/src/tests/destinationTokensRoute.test.ts	Added new import `ONEETH` and a test case for scenarios with no destination tokens, preserving existing tests.

Possibly related PRs

#3151: Introduces the /destinationTokens route, related to handling token information in destinationTokensController.ts.
#3180: Adds the validateRouteExists function, enhancing route validation relevant to the modified /destinationTokens route.
#3307: Focuses on the /destinationTx endpoint with similar improvements in controller logic and response handling as seen in the main PR.

Suggested labels

size/s, Sol, Typescript

Suggested reviewers

Defi-Moses
trajan0x

Poem

In the code where tokens play,
A rabbit hops to light the way.
With payloads bright and tests anew,
We check for chains, both old and true.
So let us code, and let us cheer,
For every change brings us near! 🐇✨

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.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`5084e97`
Status:	✅ Deploy successful!
Preview URL:	https://1b86e0bb.sanguine-fe.pages.dev
Branch Preview URL:	https://rest-api-handle-tokens-not-i.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 26.98386%. Comparing base (6415acd) to head (5084e97). Report is 12 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3314 +/- ## =================================================== - Coverage 31.92469% 26.98386% -4.94083% =================================================== Files 238 178 -60 Lines 14553 11833 -2720 Branches 356 82 -274 =================================================== - Hits 4646 3193 -1453 + Misses 9614 8357 -1257 + Partials 293 283 -10 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3314/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/3314/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/3314/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3314/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.

synapsecns / sanguine