fix: full image urls stored in DB #15089
Open
+828
−584
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
Contributor
📦 esbuild Bundle Analysis for payloadThis analysis was generated by esbuild-bundle-analyzer. 🤖
Largest pathsThese visualization shows top 20 largest paths in the bundle.Meta file: packages/next/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_shared.json, Out file: esbuild/exports/shared.js
Meta file: packages/richtext-lexical/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_shared.json, Out file: esbuild/exports/shared_optimized/index.js
DetailsNext to the size is how much the size has increased or decreased compared with the base branch of this PR.
|
Contributor
|
Hi @JarrodMFlesch, it seems like this PR is somewhat related to the following issue I created a while back: #14562 |
Contributor
Author
|
@jhb-dev yes this should resolve that open issue since it uses a before change hook to set the correct url. I brought up the issue regarding the /api/media/file/filename being stored earlier today as well. Personally I would like to see it just stored as undefined or null if the file is stored locally. But decided to keep it as is until 4.0 since it is technically a breaking change. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR ensures that upload URL fields store relative paths in the database for local files while maintaining absolute URLs for external resources. This change makes the database portable across different deployment environments without requiring URL updates when the serverURL changes.
Key Changes:
- Adds
beforeChangehooks to URL fields that convert full URLs to relative paths for local files before database storage - Refactors image resizing logic by splitting the monolithic
imageResizer.tsinto smaller, focused modules - Updates tests to verify relative URLs are stored in the database while absolute URLs are returned via API
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test/uploads/int.spec.ts | Adds comprehensive tests verifying relative URL storage in database for create, update, and duplicate operations |
| test/uploads/e2e.spec.ts | Updates assertions to use regex patterns instead of exact string matches for URL validation |
| test/uploads/config.ts | Sets serverURL to enable full URL testing scenarios |
| packages/payload/src/uploads/types.ts | Adds optional url field to FileSize type and exports FocalPoint type |
| packages/payload/src/uploads/getBaseFields.ts | Adds beforeChange hooks to convert URLs to relative paths before database storage |
| packages/payload/src/uploads/generateFilePathOrURL.ts | New utility to generate file paths or URLs with control over relative/absolute format |
| packages/payload/src/uploads/generateFileData.ts | Updates focal point handling and fixes focal point coordinate assignment bug |
| packages/payload/src/uploads/image-resizing/*.ts | Refactored image resizing functionality into modular components |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
DanRibbens
requested changes
Jan 8, 2026
Contributor
DanRibbens
left a comment
DanRibbens
left a comment
There was a problem hiding this comment.
Looking good other than the test config change.
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.
Issue
URL field values can be set as full URLs, but should be stored as paths if they are on the local file system. Previously this was not being handled which is not portable, you should be able to change your serverURL without needing to update the DB documents.
This PR adds a beforeChange hook to the url fields that converts the data to the correct relative url for local files. If the url is external, then that gets returned as is.
Why
serverURLis set #14945 where URLs are being fetched via fetch instead of with local filesystem reads (fixed with beforeChange hook)Flow before:
New Flow:
The new flow also ensures URLs are saved as relative URLs when stored on the local filesystem. This makes files more portable, removing the need to update the DB i.e. if you change your domain for example.
URL fields are stored in the DB as:
/:apiRoute/:collectionSlug/file/:filenamehttps://some-fake-external-website.com/images/1URL field values are returned as:
https://your-domain.com/:apiRoute/:collectionSlug/file/:filename/:apiRoute/:collectionSlug/file/:filenamehttps://some-fake-external-website.com/images/1The majority of the files added in this PR were moved from the imageResizer file.