fix(synapse-interface): Reorders validation to check existence first

[abtestingalpha]

Description
Reorders validation to check existence first

Summary by CodeRabbit

• New Features

  • Enhanced validation for API parameters to ensure clearer error messages and improved user experience.
  • Streamlined validation logic across various routes for required parameters, ensuring existence checks precede type validations.

• Bug Fixes

  • Addressed misleading error messages related to missing parameters by restructuring validation order.

• Documentation

  • Improved clarity in the validation process to enhance understanding for developers and users interacting with the API.

[coderabbitai]

Warning

Rate limit exceeded

@abtestingalpha has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 59 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 4200b0f and 1b5398d.

Walkthrough

The changes across multiple route files in the API focus on improving the validation logic for incoming request parameters. The modifications ensure that existence checks for parameters such as fromChain, toChain, amount, and others are performed before type validations. This restructuring enhances the clarity and flow of the validation process, leading to more informative error messages when required parameters are missing.

Changes

File(s)	Change Summary
packages/rest-api/src/routes/bridgeRoute.ts, packages/rest-api/src/routes/bridgeTxInfoRoute.ts, packages/rest-api/src/routes/getBridgeTxStatusRoute.ts, packages/rest-api/src/routes/getDestinationTxRoute.ts, packages/rest-api/src/routes/getSynapseTxIdRoute.ts, packages/rest-api/src/routes/swapRoute.ts	Enhanced validation logic for parameters by restructuring the order of checks to prioritize existence before type validation, improving clarity and error messaging.

Possibly related PRs

• API method updates #3122: The changes in bridgeTxInfoRoute.ts enhance the validation logic for fromChain and toChain, which aligns with the main PR's focus on improving validation for similar parameters in bridgeRoute.ts.
• [SLT-157] feat(rest-api): Refactor for RESTful architectural standardization #3126: The modifications in bridgeRoute.ts and bridgeTxInfoRoute.ts both emphasize the importance of validating token addresses and ensuring they are supported on the specified chain, which is a key aspect of the main PR.
• REST API Improvements [SLT-179] #3133: The updates to bridgeTxInfoController and swapTxInfoController in this PR involve similar validation enhancements for token addresses, which directly relates to the validation improvements made in the main PR.
• Adds /destinationTokens route [SLT-204] #3151: The introduction of the /destinationTokens route involves validation for fromChain and fromToken, which is consistent with the main PR's focus on enhancing validation logic for API parameters.

Suggested labels

javascript

Poem

🐰 In the code where bunnies hop,
Validation checks now never stop.
From chains to amounts, all must be there,
Clearer messages show we care!
With each request, we’ll swiftly glide,
Ensuring smoothness on this ride! 🌟

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages]

Deploying sanguine-fe with    Cloudflare Pages

Latest commit:	1b5398d
Status:	✅  Deploy successful!
Preview URL:	https://d0c637a2.sanguine-fe.pages.dev
Branch Preview URL:	https://rest-api-validation-order.sanguine-fe.pages.dev

View logs

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.95009%. Comparing base (a03677e) to head (1b5398d).
Report is 4 commits behind head on master.

Additional details and impacted files

@@              Coverage Diff              @@
##              master       #3156   +/-   ##
=============================================
  Coverage   37.95009%   37.95009%           
=============================================
  Files            418         418           
  Lines          24245       24245           
  Branches          82          82           
=============================================
  Hits            9201        9201           
  Misses         14306       14306           
  Partials         738         738           

Flag	Coverage Δ
packages	90.96267% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[codecov]

Bundle Report

Changes will decrease total bundle size by 157.86kB (-0.44%) ⬇️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
synapse-interface-server-cjs	1.47MB	147.2kB (-9.12%) ⬇️
widget-cjs-esm	271.27kB	10.65kB (-3.78%) ⬇️