fix: prevent internal access of deprecated getters #1224
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: e8ba10f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
|
@mcculloughrt-svh is attempting to deploy a commit to the Ping Labs Team on Vercel. A member of the Team first needs to authorize it. |
## Walkthrough
This change refactors how deprecated properties `url` and `appUrl` are handled during file uploads. It introduces internal getters to avoid repeated deprecation warnings and updates the SDK to emit a warning only when these deprecated properties are accessed, advising users to use alternative properties.
## Changes
| File(s) | Change Summary |
|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| .changeset/tall-months-switch.md | Documents the patch addressing deprecation warnings for internal getter usage during uploads. |
| packages/uploadthing/src/_internal/upload-server.ts | Adds internal getter properties `_internalUrl` and `_internalAppUrl` to prevent triggering deprecation warnings internally. |
| packages/uploadthing/src/sdk/utils.ts | Implements deprecation warnings on `url` and `appUrl` getters in the upload result, advising migration to `ufsUrl`. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant SDK (uploadFile)
participant Server (uploadWithoutProgress)
User->>SDK (uploadFile): Call uploadFile()
SDK (uploadFile)->>Server (uploadWithoutProgress): Initiate upload
Server (uploadWithoutProgress)-->>SDK (uploadFile): Return response with _internalUrl, _internalAppUrl
SDK (uploadFile)-->>User: Return file object with deprecated getters (url, appUrl)
User->>SDK (uploadFile): Access file.url or file.appUrl
SDK (uploadFile)-->>User: Emit deprecation warning, return internal URLPossibly related PRs
Suggested reviewers
|
mcculloughrt-svh
changed the title
|
Same issue with my self hosted version |
Not sure, I don't think so... I looked for everywhere else the deprecation warning was used, and traced from there forward and the only other location I came up with where it might be called inadvertently is in the handleCallbackRequest of _internal/handler.ts, or something that utilizes its result. I don't think this issue exists there but I'm not familiar enough with Effect to know what's happening inside some of that to be honest. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The deprecated
urlandappUrlgetters from uploadWithoutProgress were being accessed internally by the uploadFile utility, triggering deprecation console warnings even if the end user is not accessing those getters. This keeps the deprecation warnings by shifting them onto the object returned by uploadFile, while accessing them internally through getters marked "_internal" that do not trigger the warning.See comment on issue from discord here
Summary by CodeRabbit
Bug Fixes
New Features
Style