feat(storage-*): include modified headers into the response headers of files when using adapters (#12096)
This PR makes it so that `modifyResponseHeaders` is supported in our
adapters when set on the collection config. Previously it would be
ignored.
This means that users can now modify or append new headers to what's
returned by each service.
```ts
import type { CollectionConfig } from 'payload'
export const Media: CollectionConfig = {
slug: 'media',
upload: {
modifyResponseHeaders: ({ headers }) => {
const newHeaders = new Headers(headers) // Copy existing headers
newHeaders.set('X-Frame-Options', 'DENY') // Set new header
return newHeaders
},
},
}
```
Also adds support for `void` return on the `modifyResponseHeaders`
function in the case where the user just wants to use existing headers
and doesn't need more control.
eg:
```ts
import type { CollectionConfig } from 'payload'
export const Media: CollectionConfig = {
slug: 'media',
upload: {
modifyResponseHeaders: ({ headers }) => {
headers.set('X-Frame-Options', 'DENY') // You can directly set headers without returning
},
},
}
```
Manual testing checklist (no CI e2es setup for these envs yet):
- [x] GCS
- [x] S3
- [x] Azure
- [x] UploadThing
- [x] Vercel Blob
---------
Co-authored-by: James <james@trbl.design>
This commit is contained in:
@@ -14,7 +14,7 @@ interface Args {
|
||||
}
|
||||
|
||||
export const getHandler = ({ collection, getStorageClient }: Args): StaticHandler => {
|
||||
return async (req, { params: { clientUploadContext, filename } }) => {
|
||||
return async (req, { headers: incomingHeaders, params: { clientUploadContext, filename } }) => {
|
||||
try {
|
||||
const prefix = await getFilePrefix({ clientUploadContext, collection, filename, req })
|
||||
const blockBlobClient = getStorageClient().getBlockBlobClient(
|
||||
@@ -30,14 +30,34 @@ export const getHandler = ({ collection, getStorageClient }: Args): StaticHandle
|
||||
|
||||
const response = blob._response
|
||||
|
||||
let initHeaders: Headers = {
|
||||
...(response.headers.rawHeaders() as unknown as Headers),
|
||||
}
|
||||
|
||||
// Typescript is difficult here with merging these types from Azure
|
||||
if (incomingHeaders) {
|
||||
initHeaders = {
|
||||
...initHeaders,
|
||||
...incomingHeaders,
|
||||
}
|
||||
}
|
||||
|
||||
let headers = new Headers(initHeaders)
|
||||
|
||||
const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')
|
||||
const objectEtag = response.headers.get('etag')
|
||||
|
||||
if (
|
||||
collection.upload &&
|
||||
typeof collection.upload === 'object' &&
|
||||
typeof collection.upload.modifyResponseHeaders === 'function'
|
||||
) {
|
||||
headers = collection.upload.modifyResponseHeaders({ headers }) || headers
|
||||
}
|
||||
|
||||
if (etagFromHeaders && etagFromHeaders === objectEtag) {
|
||||
return new Response(null, {
|
||||
headers: new Headers({
|
||||
...response.headers.rawHeaders(),
|
||||
}),
|
||||
headers,
|
||||
status: 304,
|
||||
})
|
||||
}
|
||||
@@ -63,7 +83,7 @@ export const getHandler = ({ collection, getStorageClient }: Args): StaticHandle
|
||||
})
|
||||
|
||||
return new Response(readableStream, {
|
||||
headers: response.headers.rawHeaders(),
|
||||
headers,
|
||||
status: response.status,
|
||||
})
|
||||
} catch (err: unknown) {
|
||||
|
||||
Reference in New Issue
Block a user