Skip to content

Fix: UnhandledPromiseRejection crashing server when returning a 401 #1494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Nov 22, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced asynchronous handling for API responses, improving overall performance.
  • Bug Fixes
    • Improved error handling to ensure better logging and response consistency during failures.

Copy link

changeset-bot bot commented Nov 22, 2024

⚠️ No Changeset found

Latest commit: 9f2c16a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

Walkthrough

The changes made in this pull request focus on enhancing the asynchronous handling of API responses within the route builder functions. The wrapResponse function has been modified to be asynchronous, necessitating the use of await in its calls across various API route functions. Additionally, error handling has been improved by wrapping error logic in try-catch blocks to ensure proper logging of errors during response processing. The overall flow of API response wrapping is now more robust, maintaining consistency in error responses while supporting asynchronous operations.

Changes

File Path Change Summary
apps/webapp/app/services/routeBuilders/apiBuilder.server.ts Updated wrapResponse function to be asynchronous. Modified calls to wrapResponse to include await. Enhanced error handling with try-catch for logging errors.

Poem

In the web's bright warren, changes hop,
Asynchronous whispers, never stop!
Errors caught in a gentle embrace,
Logging the troubles, keeping the pace.
With await we frolic, through code we bound,
In the garden of functions, new joy is found! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint (1.23.1)

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/webapp/app/services/routeBuilders/apiBuilder.server.ts

(node:7971) ESLintIgnoreWarning: The ".eslintignore" file is no longer supported. Switch to using the "ignores" property in "eslint.config.js": https://eslint.org/docs/latest/use/configure/migration-guide#ignoring-files
(Use node --trace-warnings ... to show where the warning was created)

Oops! Something went wrong! :(

ESLint: 9.15.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.


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
🪧 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.

CodeRabbit Configuration 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 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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
apps/webapp/app/services/routeBuilders/apiBuilder.server.ts (1)

182-194: Robust error handling, but consider reducing duplication

The error handling is now properly handling async operations and providing good error logging. However, there's significant duplication of this logic across the three route builders.

Consider extracting the common error handling logic into a shared function:

async function handleRouteError(
  error: unknown,
  request: Request,
  corsStrategy: "all" | "none"
): Promise<Response> {
  try {
    if (error instanceof Response) {
      return await wrapResponse(request, error, corsStrategy !== "none");
    }
    return await wrapResponse(
      request,
      json({ error: "Internal Server Error" }, { status: 500 }),
      corsStrategy !== "none"
    );
  } catch (innerError) {
    logger.error("[apiBuilder] Failed to handle error", { error, innerError });
    return json({ error: "Internal Server Error" }, { status: 500 });
  }
}

Also applies to: 315-327, 529-541

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4305a23 and 9f2c16a.

📒 Files selected for processing (1)
  • apps/webapp/app/services/routeBuilders/apiBuilder.server.ts (20 hunks)
🔇 Additional comments (2)
apps/webapp/app/services/routeBuilders/apiBuilder.server.ts (2)

549-558: LGTM: Proper async/await handling for wrapResponse

The function is now correctly marked as async and properly awaits the apiCors call, which should resolve the UnhandledPromiseRejection issues.


81-84: LGTM: Consistent async/await usage across all response wrapping

All calls to wrapResponse are now properly awaited, ensuring consistent handling of responses and preventing promise rejection issues.

Also applies to: 249-253, 402-406, 92-98, 260-266, 421-427, 109-115, 277-283, 438-444, 126-132, 294-300, 455-461, 471-474, 481-484, 490-493, 157-168, 511-514, 180-180, 313-313, 527-527

@ericallam ericallam merged commit 3792394 into main Nov 22, 2024
7 checks passed
@ericallam ericallam deleted the fix-unhandled-promise-rejection-retrieve-runs branch November 22, 2024 22:16
Copy link

pkg-pr-new bot commented Nov 22, 2024

@trigger.dev/build

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1494

@trigger.dev/react-hooks

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1494

@trigger.dev/rsc

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1494

@trigger.dev/sdk

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1494

trigger.dev

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev@1494

@trigger.dev/core

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1494

commit: 9f2c16a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant