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

fix: formData bug in react native #1114

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

Conversation

shashkovdanil
Copy link

@shashkovdanil shashkovdanil commented Jan 3, 2025

Fix iOS FormData crash in React Native environment

Issue

React Native iOS app crashes when uploading files with error:
attempt to insert nil object from objects[0] in NSPlaceholderDictionary initWithObjects:forKeys:count

Root Cause

iOS attempts to create NSDictionary from File object when appending to FormData, but fails because it expects specific structure {uri, type, name}.

Solution

Add environment detection and handle FormData differently for React Native:

  • Check for uri property to detect RN environment
  • RN: Pass object with {uri, type, name} structure
  • Web: Keep existing File handling

Breaking Changes

None. Maintains backward compatibility with web environments.

Summary by CodeRabbit

  • Bug Fixes
    • Resolved file upload compatibility issue for iOS and React Native environments
    • Improved file handling to prevent crashes when uploading files on mobile platforms

Copy link

changeset-bot bot commented Jan 3, 2025

⚠️ No Changeset found

Latest commit: d209425

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

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Walkthrough

The pull request modifies the uploadWithProgress function in the upload-browser.ts file to improve file handling for iOS and React Native environments. The primary change introduces a conditional check that handles file objects with a uri property differently when appending to FormData. This addresses a specific iOS crash issue by constructing a plain object with uri, type, name, and optional range properties instead of directly appending the File object.

Changes

File Change Summary
packages/uploadthing/src/_internal/upload-browser.ts Modified uploadWithProgress function to handle file objects with uri property for iOS/React Native compatibility

Possibly related PRs

Suggested labels

📚 documentation, examples

Suggested reviewers

  • markflorkowski

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

@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)

71-79: Introduce a dedicated type interface for the React Native file object
Casting the file object to any is workable but can weaken type safety. Consider defining a TypeScript interface (e.g. ReactNativeFileObject) that includes uri, type, name, and range to remove the as any cast, improving clarity and maintainability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d1f66f3 and d209425.

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

60-70: Excellent documentation for iOS/React Native edge case
These explanatory comments clarify the underlying crash scenario and the solution approach. Good job documenting the rationale behind the special handling of File metadata for iOS platforms.


80-81: Fallback logic for standard file upload is intact
Continuing to append a web-based File or sliced File preserves legacy behavior and does not introduce any regressions.

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 (2)
packages/uploadthing/src/_internal/upload-browser.ts (2)

75-85: Clarify the rationale in code comments.
The documentation is helpful for explaining the React Native iOS crash. However, consider providing a succinct reference link (if available) or a simpler explanation for future maintainers who may not be familiar with iOS’s differences in handling File objects.


86-88: Add more robust environment checks or type checks.
Currently you rely on the presence of "uri" to detect React Native. Consider verifying that file.type and file.name are also present before building the object, as missing values could lead to unexpected behavior. Likewise, an explicit runtime check for typeof file.uri === "string" might improve safety.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d209425 and 7c85147.

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

89-92: Validate optional properties before appending them.
When adding the range property conditionally, ensure it is recognized by the server or that the receiving environment properly ignores unknown fields. If not, consider removing or renaming it to avoid potential conflicts in other platforms.


94-96: Confirm file slicing behavior across environments.
When rangeStart > 0, the code calls file.slice(...). This may not behave consistently in certain non-browser or polyfilled environments. Consider verifying that file.slice(...) is supported wherever this code runs, or provide a fallback if not.

@shashkovdanil
Copy link
Author

@juliusmarminge hi, kindly reminder

Comment on lines +86 to +96
if ("uri" in file) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
formData.append("file", {
uri: file.uri as string,
type: file.type,
name: file.name,
...(rangeStart > 0 && { range: rangeStart }),
} as any);
} else {
formData.append("file", rangeStart > 0 ? file.slice(rangeStart) : file);
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

can you update the type of the file input to this function so that this is more generally acceptable rather than a big hidden hack?

so like a FormDataFileEsque type or something on L20 and in cascading places where necessary?

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.

2 participants