fix: skip content type for non-body methods #954

juliusmarminge · 2024-09-16T17:06:17Z

Summary by CodeRabbit

New Features
- Enhanced request body handling by allowing only specific HTTP methods (POST, PUT, PATCH) to include request bodies.
- Added comprehensive tests for router configuration across multiple adapter modules to ensure consistent response for GET requests.
Bug Fixes
- Improved robustness of the request body processing by bypassing parsing for unsupported methods.

vercel · 2024-09-16T17:06:21Z

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	Sep 16, 2024 6:25pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
legacy-docs-uploadthing	⬜️ Ignored (Inspect)	Visit Preview		Sep 16, 2024 6:25pm

changeset-bot · 2024-09-16T17:06:21Z

⚠️ No Changeset found

Latest commit: 1a8cb26

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

coderabbitai · 2024-09-16T17:06:36Z

Walkthrough

The changes introduce a new helper function, isBodyAllowed, to determine which HTTP methods ("POST", "PUT", and "PATCH") can have a request body. The getPostBody function is updated to utilize this helper, allowing it to return undefined for disallowed methods, with an adjusted return type. Additionally, tests are added to verify that the router configuration is correctly returned for GET requests across various adapter modules, enhancing test coverage.

Changes

File Path	Change Summary
packages/uploadthing/src/internal/to-web-request.ts	Added `isBodyAllowed` function; modified `getPostBody` to return `undefined` for disallowed methods; updated return type to allow `undefined`.
packages/uploadthing/test/adapters.test.ts	Added tests for GET requests across multiple adapters to verify router configuration and response structure.

Poem

In the meadow where bunnies play,
A new rule has brightened the day.
With methods now checked,
No body to wreck,
Our code hops along, come what may! 🐇✨

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 149ff63 and 1a8cb26.

Files selected for processing (1)

packages/uploadthing/src/internal/to-web-request.ts (2 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/uploadthing/src/internal/to-web-request.ts

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 generate interesting stats about this repository and render them as a table.
-- @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.

pkg-pr-new · 2024-09-16T17:08:56Z

Open in Stackblitz

More templates

pnpm add https://pkg.pr.new/pingdotgg/uploadthing@954

commit: 1a8cb26

github-actions · 2024-09-16T17:09:04Z

📦 Bundle size comparison

Bundle	Size (gzip)	Visualization
Main	26.03KB	See Treemap 📊
PR (`5eae957`)	26.03KB	See Treemap 📊
Diff	No change

markflorkowski

TIL body on GET is not actually spec-forbidden, but it just has no semantic meaning in the spec, and is generally "not recommended"

juliusmarminge · 2024-09-16T17:24:39Z

TIL body on GET is not actually spec-forbidden, but it just has no semantic meaning in the spec, and is generally "not recommended"

markflorkowski · 2024-09-16T17:26:29Z

TIL body on GET is not actually spec-forbidden, but it just has no semantic meaning in the spec, and is generally "not recommended"

juliusmarminge · 2024-09-16T17:29:04Z

Interesting... then Node aint spec compliant, nor is Chrome

markflorkowski · 2024-09-16T17:41:45Z

Interesting... then Node aint spec compliant, nor is Chrome

I think since the spec doesn't specify behaviour, they can implement it how they want, and everyone has just agreed that GET doesn't have a body, even if the spec is wishy-washy on it hahah

skip content type for non-body methods

1d47e95

vercel bot deployed to Preview – docs-uploadthing September 16, 2024 17:09 View deployment

add tests for GEt endpoint

149ff63

markflorkowski approved these changes Sep 16, 2024

View reviewed changes

vercel bot deployed to Preview – docs-uploadthing September 16, 2024 17:25 View deployment

undefined is probably better here

1a8cb26

vercel bot deployed to Preview – docs-uploadthing September 16, 2024 18:25 View deployment

juliusmarminge merged commit 21677bb into main Sep 16, 2024

juliusmarminge added a commit that referenced this pull request Sep 16, 2024

chore: missing changeset for #954

a948109

coderabbitai bot mentioned this pull request Sep 30, 2024

fix: prefer browser recognized mime type over file extension lookup #991

Merged

fix: skip content type for non-body methods #954

fix: skip content type for non-body methods #954

Uh oh!

Conversation

juliusmarminge commented Sep 16, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Bundle size comparison

Uh oh!

markflorkowski left a comment

Choose a reason for hiding this comment

Uh oh!

juliusmarminge commented Sep 16, 2024

Uh oh!

markflorkowski commented Sep 16, 2024

Uh oh!

juliusmarminge commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markflorkowski commented Sep 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

juliusmarminge commented Sep 16, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Sep 16, 2024 •

edited

Loading

changeset-bot bot commented Sep 16, 2024 •

edited

Loading

coderabbitai bot commented Sep 16, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Sep 16, 2024 •

edited

Loading

github-actions bot commented Sep 16, 2024 •

edited

Loading

juliusmarminge commented Sep 16, 2024 •

edited

Loading