chore: use plain app id in key gen #960

juliusmarminge · 2024-09-18T16:45:53Z

We decided it was too hard to port the encoding to other languages
so we now do a prefix check on appId in plain text instead of the
encoded value.

ref: https://github.com/pingdotgg/uploadthing-infra/pull/550

Summary by CodeRabbit

New Features
- Simplified file key generation process for uploads, enhancing clarity and efficiency.
- Introduced requirements for user-defined file seeds to be unique, URL-safe, and a minimum of 36 characters.
Bug Fixes
- Removed unnecessary complexity in key generation, improving overall functionality and reducing dependencies.
- Eliminated the verifyKey function, streamlining key management and enhancing security.

vercel · 2024-09-18T16:45:55Z

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	Nov 6, 2024 9:34am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
legacy-docs-uploadthing	⬜️ Ignored (Inspect)	Visit Preview		Nov 6, 2024 9:34am

changeset-bot · 2024-09-18T16:45:57Z

⚠️ No Changeset found

Latest commit: badab68

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-18T16:46:16Z

Warning

Rate limit exceeded

@juliusmarminge has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 38 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b281a5c and badab68.

Walkthrough

The changes primarily involve the simplification of the file key generation process. The previous implementation utilized the Sqids library for encoding and randomization, while the new approach directly concatenates the appId with a user-defined file seed. The updated requirements for the file seed ensure it is unique, URL-safe, and at least 36 characters long, streamlining the overall key generation without the need for additional complexity.

Changes

File Path	Change Summary
docs/src/app/(docs)/uploading-files/page.mdx, packages/shared/src/crypto.ts	The `generateKey` function was modified to simplify the key generation process by removing the encoding of `appId` and directly concatenating it with the `encodedFileSeed`. The new implementation eliminates the use of the Sqids library and focuses on ensuring the file seed is URL-safe. The `verifyKey` function was also removed, affecting key verification.

Poem

In the meadow where the keys align,
A rabbit hops, feeling just fine.
With seeds so safe and bright,
The keys now shine, a pure delight!
No more shuffle, just a simple way,
To share our files and play all day! 🐇✨

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 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-18T16:48:34Z

Open in Stackblitz

More templates

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

commit: badab68

github-actions · 2024-09-18T16:49:39Z

📦 Bundle size comparison

Bundle	Size (gzip)	Visualization
Main	27.51KB	No treemap on forks
PR (`1fa9529`)	27.51KB	No treemap on forks
Diff	No change

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 95319f2 and 75c1da4.

Files selected for processing (2)

docs/src/app/(docs)/uploading-files/page.mdx (1 hunks)
packages/shared/src/crypto.ts (1 hunks)

Additional comments not posted (2)

docs/src/app/(docs)/uploading-files/page.mdx (2)

99-103: LGTM!

The requirements for generating a file key are clear and reasonable. Using base64 encoding to ensure the file seed is URL-safe is a good approach.

106-111: LGTM!

The generateKey function correctly implements the requirements for generating a file key. The use of base64 encoding ensures the fileSeed is URL-safe, and the concatenation with appId generates a unique file key.

packages/shared/src/crypto.ts

use plain app id in key gen

75c1da4

github-actions bot added the 📚 documentation label Sep 18, 2024

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

coderabbitai bot reviewed Sep 18, 2024

View reviewed changes

packages/shared/src/crypto.ts Show resolved Hide resolved

rm verifykey helper

b281a5c

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

Merge branch 'main' into plain-app-id

37a73ff

vercel bot deployed to Preview – docs-uploadthing October 8, 2024 22:31 View deployment

juliusmarminge added the ❗ infra changes required Infra changes required for this change to work label Nov 6, 2024

juliusmarminge added 3 commits November 6, 2024 10:24

Merge branch 'main' into plain-app-id

764ed1b

rm

6376d33

rm unused test

badab68

vercel bot deployed to Preview – docs-uploadthing November 6, 2024 09:34 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: use plain app id in key gen #960

chore: use plain app id in key gen #960

juliusmarminge commented Sep 18, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Sep 18, 2024 •

edited

Loading

changeset-bot bot commented Sep 18, 2024 •

edited

Loading

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

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

edited

Loading

github-actions bot commented Sep 18, 2024 •

edited

Loading

coderabbitai bot left a comment

chore: use plain app id in key gen #960

Are you sure you want to change the base?

chore: use plain app id in key gen #960

Conversation

juliusmarminge commented Sep 18, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

vercel bot commented Sep 18, 2024 • edited Loading

changeset-bot bot commented Sep 18, 2024 • edited Loading

⚠️ No Changeset found

coderabbitai bot commented Sep 18, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

pkg-pr-new bot commented Sep 18, 2024 • edited Loading

github-actions bot commented Sep 18, 2024 • edited Loading

📦 Bundle size comparison

coderabbitai bot left a comment

Choose a reason for hiding this comment

juliusmarminge commented Sep 18, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Sep 18, 2024 •

edited

Loading

changeset-bot bot commented Sep 18, 2024 •

edited

Loading

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

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

edited

Loading

github-actions bot commented Sep 18, 2024 •

edited

Loading