Skip to content
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

chore: gracefully handle dev callback failed #1081

Merged
merged 7 commits into from
Jan 4, 2025

Conversation

juliusmarminge
Copy link
Collaborator

@juliusmarminge juliusmarminge commented Dec 3, 2024

Requires https://github.com/pingdotgg/uploadthing-infra/pull/615

Closes #1078

instead of silently throwing and holding the client upload, a failed dev hook now reports back to UT if the callback failed for any reason

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for upload processes, providing more informative feedback during uploads.
    • Introduced middleware for session management in a Next.js application, improving request handling and security.
  • Bug Fixes

    • Improved response validation in upload handling to ensure accurate error reporting.
  • Documentation

    • Added detailed logging for better insights into upload success and failure.

Copy link

changeset-bot bot commented Dec 3, 2024

⚠️ No Changeset found

Latest commit: 32f3f6a

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

vercel bot commented Dec 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-uploadthing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 4, 2025 2:32am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
legacy-docs-uploadthing ⬜️ Ignored (Inspect) Visit Preview Jan 4, 2025 2:32am

@juliusmarminge juliusmarminge added the ❗ infra changes required Infra changes required for this change to work label Dec 3, 2024
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Warning

Rate limit exceeded

@juliusmarminge has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 42 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

Reviewing files that changed from the base of the PR and between dd7eba0 and 32f3f6a.

📒 Files selected for processing (2)
  • packages/uploadthing/src/_internal/handler.ts (3 hunks)
  • packages/uploadthing/src/_internal/upload-browser.ts (2 hunks)

Walkthrough

The pull request introduces enhancements to error handling and logging mechanisms across multiple files in the UploadThing SDK. The changes focus on improving error reporting, particularly in development environments, by adding more detailed error tracking in the upload handling process. Modifications include the addition of a new middleware for session validation, improvements to the uploadWithProgress function for better response checking, and enhancements to the handleUploadAction function for refined error handling.

Changes

File Change Summary
packages/uploadthing/src/internal/handler.ts Added handleDevStreamError function for logging development stream errors, updated handleUploadAction with improved error handling and development mode logic.
packages/uploadthing/src/internal/upload.browser.ts Enhanced uploadWithProgress error handling with more robust response checking using hasProperty and isRecord predicates.
playground/middleware.ts Introduced new middleware for session validation and request path filtering.

Assessment against linked issues

Objective Addressed Explanation
Improve callback failure debugging [#1078]
Surface clearer error messages

Possibly related PRs

Suggested labels

sdk, uploadthing/client, 📚 documentation

Suggested reviewers

  • markflorkowski
  • t3dotgg

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

github-actions bot commented Dec 3, 2024

📦 Bundle size comparison

Bundle Size (gzip) Visualization
Main 30.00KB See Treemap 📊
PR (63d6741) 30.07KB See Treemap 📊
Diff ↑73.00B

Copy link

pkg-pr-new bot commented Dec 3, 2024

@juliusmarminge juliusmarminge marked this pull request as ready for review December 14, 2024 17:45
@juliusmarminge juliusmarminge added the ✅ infra changes implemented The necessary infra changes have been shipped label Dec 14, 2024
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: 2

🧹 Outside diff range and nitpick comments (1)
playground/middleware.ts (1)

9-18: Handle potential errors from getSession to prevent middleware failure

If getSession() throws an error, it could cause the middleware to fail unexpectedly. Wrap the call to getSession() in a try-catch block to handle potential errors and respond appropriately.

Apply this diff to handle errors from getSession:

export default (async (req) => {
  if (req.nextUrl.pathname !== "/") {
+   let sesh;
+   try {
      const sesh = await getSession();
+   } catch (error) {
+     console.error("Failed to get session:", error);
+     return NextResponse.json({ error: "Internal Server Error" }, { status: 500 });
+   }
    if (!sesh) {
      return NextResponse.json({ error: "Forbidden" }, { status: 403 });
    }
  }

  return NextResponse.next();
}) satisfies NextMiddleware;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a43ad7 and 2ee0d0c.

📒 Files selected for processing (3)
  • packages/uploadthing/src/internal/handler.ts (3 hunks)
  • packages/uploadthing/src/internal/upload.browser.ts (2 hunks)
  • playground/middleware.ts (1 hunks)
🔇 Additional comments (4)
packages/uploadthing/src/internal/upload.browser.ts (2)

3-3: Import statement approved

The addition of hasProperty and isRecord from "effect/Predicate" is appropriate for the enhanced error handling logic.


41-61: Handle non-JSON responses gracefully

Since xhr.responseType is set to "json", if the server returns a non-JSON response, xhr.response might be null. Ensure that the code handles scenarios where the response is not valid JSON to prevent unexpected errors.

Please verify how the code behaves when the server returns a non-JSON response and handle it appropriately.

packages/uploadthing/src/internal/handler.ts (1)

662-669: Confirm proper error propagation in handleDevStreamError usage

When forwarding callback requests, handleDevStreamError is invoked upon a ResponseError. Ensure that any errors thrown within handleDevStreamError are properly caught to prevent unhandled promise rejections.

Please confirm that handleDevStreamError handles its internal errors gracefully and that they are appropriately logged without causing unhandled exceptions.

playground/middleware.ts (1)

20-22: Verify the matcher patterns to ensure correct route matching

The matcher patterns in the middleware configuration may unintentionally include or exclude certain routes. Double-check the regular expressions to confirm they match the intended routes and exclude static assets or Next.js internals.

Please ensure that:

  • Static files and assets (e.g., images, CSS, JS files) are excluded.
  • Next.js internal routes (e.g., /_next) are excluded.
  • Desired API routes and pages are correctly matched.

packages/uploadthing/src/internal/upload.browser.ts Outdated Show resolved Hide resolved
packages/uploadthing/src/internal/handler.ts Outdated Show resolved Hide resolved
@juliusmarminge juliusmarminge merged commit 95388b5 into main Jan 4, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✅ infra changes implemented The necessary infra changes have been shipped ❗ infra changes required Infra changes required for this change to work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[misc]: how do we make it clearer why callbacks might fail
2 participants