feat(server): allow a mix of text and files with fileUploadHandler #4946

jussisaurio · 2023-10-21T13:07:37Z

🎯 Changes

…dler

Sending a FormData object with a mix of files and text fields was not possible when using experimental_createFileUploadHandler, because the handling of all fields was baked into the UploadHandler business logic, and logic for handling non-file fields was only implemented for the memory upload handler. Ergo, the file upload handler just ignored all fields that were not files.

This PR does a few things:

Moves the logic for handling non-file fields to parseMultipartFormData, and only file fields are passed to the upload handler. Now non-file fields are handled identically regardless of upload handler type.
Like with other body parsers, adds maxBodySize parameter to the function parseMultipartFormData that defaults to Infinity. Throws when combined size of all fields and files exceeds the maximum and unlinks any files that were already uploaded.
Exposes NodeOnDiskFile as experimental_NodeOnDiskFile because zfd.file() schema from zod-form-data throws when NodeOnDiskFile is returned.
Exposes MaxBodySizeExceededError

✅ Checklist

I have followed the steps listed in the Contributing guide.
If necessary, I have added documentation related to the changes made.
I have added or updated the tests related to the changes made.

…dler Sending a FormData object with a mix of files and text fields was not possible when using `experimental_createFileUploadHandler`, because the handling of all fields was baked into the `UploadHandler` business logic, and logic for handling non-file fields was only implemented for the memory upload handler. Ergo, the file upload handler just ignored all fields that were not files. This PR does a few things: 1. Moves the logic for handling non-file fields to `parseMultipartFormData`, and only file fields are passed to the upload handler. Now non-file fields are handled identically regardless of upload handler type. 2. Like with other body parsers, adds `maxBodySize` parameter to the function `parseMultipartFormData` that defaults to Infinity. Throws when combined size of all fields and files exceeds the maximum and unlinks any files that were already uploaded. 3. Exposes `NodeOnDiskFile` as `experimental_NodeOnDiskFile` because `zfd.file()` schema from `zod-form-data` throws when `NodeOnDiskFile` is returned. 4. Exposes `MaxBodySizeExceededError`

vercel · 2023-10-21T13:07:44Z

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

Name	Status	Preview	Comments	Updated (UTC)
trpc-next-app-dir	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 23, 2023 9:37pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 23, 2023 9:37pm

vercel · 2023-10-21T13:07:46Z

@jussisaurio is attempting to deploy a commit to the trpc Team on Vercel.

A member of the Team first needs to authorize it.

KATT

Thanks for this!

I don't have much time to scrutinize the code but seeing this is an experimental feature and you have been very thorough with tests and your motivation for this, I trust it

Thanks

jussisaurio requested a review from a team as a code owner October 21, 2023 13:07

github-actions bot added the @trpc/server label Oct 21, 2023

vercel bot deployed to Preview – todomvc October 21, 2023 13:09 View deployment

vercel bot deployed to Preview – trpc-next-app-dir October 21, 2023 13:10 View deployment

vercel bot deployed to Preview – www October 21, 2023 13:10 View deployment

KATT changed the title ~~Server/experimental: allow a mix of text and files with fileUploadHan…~~ feat(server): allow a mix of text and files with fileUploadHandler Oct 23, 2023

KATT approved these changes Oct 23, 2023

View reviewed changes

KATT added the ♻️ autoupdate label Oct 23, 2023

KATT enabled auto-merge (squash) October 23, 2023 21:35

Merge branch 'main' into allow-text-fields-in-fileupload-formdata

94aaec4

vercel bot deployed to Preview – www October 23, 2023 21:36 View deployment

vercel bot deployed to Preview – todomvc October 23, 2023 21:37 View deployment

vercel bot deployed to Preview – trpc-next-app-dir October 23, 2023 21:37 View deployment

KATT merged commit b745c50 into trpc:main Oct 23, 2023
35 of 37 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Nov 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(server): allow a mix of text and files with fileUploadHandler #4946

feat(server): allow a mix of text and files with fileUploadHandler #4946

jussisaurio commented Oct 21, 2023 •

edited

vercel bot commented Oct 21, 2023 •

edited

vercel bot commented Oct 21, 2023

KATT left a comment

feat(server): allow a mix of text and files with fileUploadHandler #4946

feat(server): allow a mix of text and files with fileUploadHandler #4946

Conversation

jussisaurio commented Oct 21, 2023 • edited

🎯 Changes

✅ Checklist

vercel bot commented Oct 21, 2023 • edited

vercel bot commented Oct 21, 2023

KATT left a comment

Choose a reason for hiding this comment

jussisaurio commented Oct 21, 2023 •

edited

vercel bot commented Oct 21, 2023 •

edited