fix: add application/yaml as mime type

christian-bromann commented 1 month ago

According to RFC 9512 Yaml is now an official media type and should be added to this list to support uploading yaml files through UploadThing.

Summary by CodeRabbit

New Features
- Introduced support for the YAML file format with the new MIME type application/yaml, enabling better file handling and recognition in the system.

changeset-bot[bot] commented 1 month ago

🦋 Changeset detected

Latest commit: 89d898ebfddd72cab09ec096fa5bd416e24833b7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

| Name | Type | | ----------------------- | ----- | | @uploadthing/mime-types | Patch | | @uploadthing/shared | Patch | | uploadthing | Patch | | @uploadthing/expo | Patch | | @uploadthing/react | Patch | | @uploadthing/solid | Patch | | @uploadthing/svelte | Patch | | @uploadthing/vue | Patch | | @uploadthing/nuxt | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel[bot] commented 1 month ago

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	Oct 22, 2024 2:00am

1 Skipped Deployment

coderabbitai[bot] commented 1 month ago

Walkthrough

This change introduces a new MIME type, application/yaml, to the @uploadthing/mime-types package, enabling the handling of YAML files. The modification includes adding the MIME type declaration in the application constant within the packages/mime-types/src/application.ts file. This addition expands the supported content types without altering existing entries or the overall structure of the MIME type definitions.

Changes

File Path	Change Summary
.changeset/two-olives-shop.md	Added new MIME type `application/yaml` to `@uploadthing/mime-types`.
packages/mime-types/src/application.ts	Declared new MIME type `application/yaml` with source "iana" and extensions "yaml", "yml".

Poem

In the meadow where YAML hops,
A new type joins, and never stops.
With application/yaml in sight,
Files dance in the soft moonlight.
Hooray for types, both new and bright! 🐇✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between 74c94c820948ccb349aba589bdc4528f0a1f6e1b and 89d898ebfddd72cab09ec096fa5bd416e24833b7.

📒 Files selected for processing (2)

* .changeset/two-olives-shop.md (1 hunks) * packages/mime-types/src/application.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (4)

.changeset/two-olives-shop.md (1)
`1-5`: **LGTM! Changeset looks good.** The changeset is correctly formatted and accurately describes the feature addition. The use of a patch version bump is appropriate for this type of change. Let's verify if the changeset aligns with the PR objectives and AI-generated summary:

✅ Verification successful
**Verified: Changeset aligns with PR objectives and AI-generated summary.**

🏁 Scripts executed
The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify if the changeset aligns with the PR objectives and AI-generated summary. # Test 1: Check if the package name is correct if ! grep -q '"@uploadthing/mime-types": patch' .changeset/two-olives-shop.md; then echo "Error: Package name or version bump type mismatch" exit 1 fi # Test 2: Check if the feature description mentions application/yaml if ! grep -q "add application/yaml as mime type" .changeset/two-olives-shop.md; then echo "Error: Feature description does not mention application/yaml" exit 1 fi echo "Changeset aligns with PR objectives and AI-generated summary" ``` Length of output: 281

packages/mime-types/src/application.ts (3)
`2637-2640`: **LGTM! The new MIME type is correctly added.** The addition of the "application/yaml" MIME type is correct and follows the existing structure of the `application` object. The source is set to "iana" and the extensions include both "yaml" and "yml", which are the standard file extensions for YAML files. --- Line range hint `1-2640`: **Overall, the file structure and consistency are maintained.** The addition of the "application/yaml" MIME type has been integrated seamlessly into the existing `application` object. The file maintains its structure and consistency throughout. No further changes or refactoring are necessary for this specific update. --- `2637-2640`: **Verify related changes and project alignment.** The addition of the "application/yaml" MIME type is well-integrated into the existing structure. To ensure completeness: 1. Confirm that this addition aligns with the project's objectives for supporting YAML files. 2. Check if any related changes are needed in other parts of the codebase that might use or reference MIME types. 3. Consider updating any documentation or tests that list supported MIME types. To help verify the impact of this change, you can run the following script:

✅ Verification successful
**No removed or replaced code found in the specified lines.**

🏁 Scripts executed
The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Search for potential places where MIME types are used or referenced echo "Searching for MIME type usage:" rg "application/[a-z-]+" --type ts --type js echo "\nSearching for YAML-related functionality:" rg "yaml|yml" --type ts --type js echo "\nChecking for documentation files that might need updating:" fd -e md -e txt README ``` Length of output: 55632

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

christian-bromann commented 1 month ago

@juliusmarminge it seems like even with this patch being released, I am still not able to upload yaml files, my setup looks as following:

const f = createUploadthing()

// FileRouter for your app, can contain multiple FileRoutes
export const fileRouter = {
  // Define as many FileRoutes as you like, each with a unique routeSlug
  openAPISpecUploader: f({
    'application/json': { maxFileSize: '4MB' },
    'application/yaml': { maxFileSize: '4MB' },
  })
  // ...

Any suggestions on what I am doing wrong? Yaml files remain being disabled in the file explorer and when I drop a file in the upload zone, the request fails with body: { error: 'Invalid request body', details: [ [Object] ] } 🤔

juliusmarminge commented 1 month ago

Your OS might not recognize the mime. Try setting blob type in your file route, then add a console log in onFilesChange prop and select the yaml file. See what type that logs out

pingdotgg / uploadthing