fix(storage-azure): return error status 404 when file is not found instead of 500 (#11734)

### What?

The azure storage adapter returns a 500 internal server error when a
file is not found.
It's expected that it will return 404 when a file is not found.

### Why?

There is no checking if the blockBlobClient exists before it's used, so
it throws a RestError when used and the blob does not exist.

### How?

Check if exception thrown is of type RestError and have a 404 error from
the Azure API and return a 404 in that case.

An alternative way would be to call the exists() method on the
blockBlobClient, but that will be one more API call for blobs that does
exist. So I chose to check the exception instead.

Also added integration tests for azure storage in the same manner as s3,
as it was missing for azure storage.

Author: andershermansen

packages/storage-azure/src/staticHandler.ts

@@ -2,6 +2,7 @@ import type { ContainerClient } from '@azure/storage-blob'
 import type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types'
 import type { CollectionConfig } from 'payload'
 
+import { RestError } from '@azure/storage-blob'
 import { getFilePrefix } from '@payloadcms/plugin-cloud-storage/utilities'
 import path from 'path'
 
@@ -66,6 +67,9 @@ export const getHandler = ({ collection, getStorageClient }: Args): StaticHandle
         status: response.status,
       })
     } catch (err: unknown) {
+      if (err instanceof RestError && err.statusCode === 404) {
+        return new Response(null, { status: 404, statusText: 'Not Found' })
+      }
       req.payload.logger.error(err)
       return new Response('Internal Server Error', { status: 500 })
     }

pnpm-lock.yaml

@@ -23,6 +23,7 @@
   },
   "devDependencies": {
     "@aws-sdk/client-s3": "^3.614.0",
+    "@azure/storage-blob": "^12.11.0",
     "@date-fns/tz": "1.2.0",
     "@next/env": "15.3.2",
     "@payloadcms/admin-bar": "workspace:*",

test/package.json

@@ -0,0 +1,116 @@
+import type { ContainerClient } from '@azure/storage-blob'
+import type { CollectionSlug, Payload } from 'payload'
+
+import { BlobServiceClient } from '@azure/storage-blob'
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+import type { NextRESTClient } from '../helpers/NextRESTClient.js'
+
+import { initPayloadInt } from '../helpers/initPayloadInt.js'
+import { mediaSlug, mediaWithPrefixSlug, prefix } from './shared.js'
+
+const filename = fileURLToPath(import.meta.url)
+const dirname = path.dirname(filename)
+
+let restClient: NextRESTClient
+let payload: Payload
+
+describe('@payloadcms/storage-azure', () => {
+  let TEST_CONTAINER: string
+  let client: ContainerClient
+
+  beforeAll(async () => {
+    ;({ payload, restClient } = await initPayloadInt(dirname))
+    TEST_CONTAINER = process.env.AZURE_STORAGE_CONTAINER_NAME!
+
+    const blobServiceClient = BlobServiceClient.fromConnectionString(
+      process.env.AZURE_STORAGE_CONNECTION_STRING!,
+    )
+    client = blobServiceClient.getContainerClient(TEST_CONTAINER)
+
+    await client.createIfNotExists()
+    await clearContainer()
+  })
+
+  afterAll(async () => {
+    await payload.destroy()
+  })
+
+  afterEach(async () => {
+    await clearContainer()
+  })
+
+  it('can upload', async () => {
+    const upload = await payload.create({
+      collection: mediaSlug,
+      data: {},
+      filePath: path.resolve(dirname, '../uploads/image.png'),
+    })
+
+    expect(upload.id).toBeTruthy()
+    await verifyUploads({ collectionSlug: mediaSlug, uploadId: upload.id })
+    expect(upload.url).toEqual(`/api/${mediaSlug}/file/${String(upload.filename)}`)
+  })
+
+  it('can upload with prefix', async () => {
+    const upload = await payload.create({
+      collection: mediaWithPrefixSlug,
+      data: {},
+      filePath: path.resolve(dirname, '../uploads/image.png'),
+    })
+
+    expect(upload.id).toBeTruthy()
+    await verifyUploads({
+      collectionSlug: mediaWithPrefixSlug,
+      uploadId: upload.id,
+      prefix,
+    })
+    expect(upload.url).toEqual(`/api/${mediaWithPrefixSlug}/file/${String(upload.filename)}`)
+  })
+
+  it('returns 404 for non-existing file', async () => {
+    const response = await restClient.GET(`/${mediaSlug}/file/nonexistent.png`)
+    expect(response.status).toBe(404)
+  })
+
+  async function clearContainer() {
+    for await (const blob of client.listBlobsFlat()) {
+      await client.deleteBlob(blob.name)
+    }
+  }
+
+  async function verifyUploads({
+    collectionSlug,
+    uploadId,
+    prefix = '',
+  }: {
+    collectionSlug: CollectionSlug
+    prefix?: string
+    uploadId: number | string
+  }) {
+    const uploadData = (await payload.findByID({
+      collection: collectionSlug,
+      id: uploadId,
+    })) as unknown as { filename: string; sizes: Record<string, { filename: string }> }
+
+    const fileKeys = Object.keys(uploadData.sizes || {}).map((key) => {
+      const rawFilename = uploadData.sizes[key].filename
+      return prefix ? `${prefix}/${rawFilename}` : rawFilename
+    })
+
+    fileKeys.push(`${prefix ? `${prefix}/` : ''}${uploadData.filename}`)
+
+    for (const key of fileKeys) {
+      const blobClient = client.getBlobClient(key)
+      try {
+        const props = await blobClient.getProperties()
+        expect(props).toBeDefined()
+        expect(props.contentLength).toBeGreaterThan(0)
+      } catch (error) {
+        console.error('Error verifying uploads:', key, error)
+        throw error
+      }
+    }
+  }
+})

test/storage-azure/int.spec.ts

@@ -78,6 +78,7 @@
         "./packages/plugin-multi-tenant/src/translations/languages/*.ts"
       ],
       "@payloadcms/next": ["./packages/next/src/exports/*"],
+      "@payloadcms/storage-azure/client": ["./packages/storage-azure/src/exports/client.ts"],
       "@payloadcms/storage-s3/client": ["./packages/storage-s3/src/exports/client.ts"],
       "@payloadcms/storage-vercel-blob/client": [
         "./packages/storage-vercel-blob/src/exports/client.ts"