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: log xhr error #1121

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: log xhr error #1121

wants to merge 2 commits into from

Conversation

juliusmarminge
Copy link
Collaborator

@juliusmarminge juliusmarminge commented Jan 4, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling during file uploads to provide more detailed error logging.

Copy link

vercel bot commented Jan 4, 2025

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 10:40pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
legacy-docs-uploadthing ⬜️ Ignored (Inspect) Visit Preview Jan 4, 2025 10:40pm

Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

Walkthrough

The pull request introduces modifications to the error handling logic in the uploadWithProgress function within the upload-browser.ts file. The changes focus on improving error logging during file uploads by capturing and logging the error event object when an upload fails. This enhancement provides more detailed error information for debugging purposes, while maintaining the existing upload process functionality.

Changes

File Change Summary
packages/uploadthing/src/_internal/upload-browser.ts Updated error event listener in uploadWithProgress function to capture and log the full error event object

Sequence Diagram

sequenceDiagram
    participant Client
    participant UploadFunction
    participant XMLHttpRequest
    participant ErrorHandler

    Client->>UploadFunction: Initiate file upload
    UploadFunction->>XMLHttpRequest: Send upload request
    alt Upload Successful
        XMLHttpRequest-->>UploadFunction: Upload progress/complete
    else Upload Fails
        XMLHttpRequest->>ErrorHandler: Trigger error event
        ErrorHandler->>ErrorHandler: Log error details
        ErrorHandler-->>UploadFunction: Return error information
    end
Loading

This sequence diagram illustrates the updated error handling flow, showing how the error event is now captured and logged when an upload fails, providing more visibility into potential issues during the file upload process.


🪧 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

changeset-bot bot commented Jan 4, 2025

⚠️ No Changeset found

Latest commit: 41b9159

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

pkg-pr-new bot commented Jan 4, 2025

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

🧹 Nitpick comments (1)
packages/uploadthing/src/_internal/upload-browser.ts (1)

66-68: Include more details in the thrown error and switch to console.error for clarity.

Currently, the error event is logged, but the UploadThingError does not include any details from err. Providing at least the err.message in the thrown error can drastically improve debugging. Also, using console.error is more expressive and consistent for reporting errors.

Here’s a suggested diff for lines 66-68:

 xhr.addEventListener("error", (err) => {
-  // eslint-disable-next-line no-console
-  console.log("XHR error", err, xhr);
+  // eslint-disable-next-line no-console
+  console.error("XHR error", err, xhr);
   resume(
     new UploadThingError({
       code: "UPLOAD_FAILED",
+      message: err?.message || "Unknown XHR error",
     }),
   );
 });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 68c261f and 41b9159.

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

Copy link
Contributor

github-actions bot commented Jan 4, 2025

📦 Bundle size comparison

Bundle Size (gzip) Visualization
Main 30.07KB See Treemap 📊
PR (1e5b88d) 30.12KB See Treemap 📊
Diff ↑49.00B

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