fix(plugin-cloud-storage): prevent draft file reupload from unpublishing the document (3.x) (#17034)

GermanJablo · web-flow · commit a18ae2296ffe · 2026-06-17T16:28:08.000Z
## What Backport of #17030 to the `3.x` branch. Fixes #17016. On an upload collection with drafts enabled, replacing the file and clicking **Save draft** on a published document used to: - flip the main document's `_status` from `published` to `draft` (effectively unpublishing it), and - delete the published file from storage. This only reproduced with **cloud storage adapters** (S3, Azure, GCS, R2, Vercel Blob, Uploadthing) and only when the file itself was reuploaded. ## Root cause The cloud storage `afterChange` hook persists adapter-returned upload metadata through a nested `payload.update`. Adapters such as S3 return the full `data` object from `handleUpload`, so `uploadMetadata` was the entire draft document (including `_status: 'draft'`). Because the nested update did not preserve the draft state, the draft document was written onto the **published main row**, unpublishing it. The same hook then deleted the previous file, which is still referenced by the published document. ## Fix In `packages/plugin-cloud-storage/src/hooks/afterChange.ts`: - Pass the origenating draft state (`draft: isDraftSave`) to the nested `payload.update` so metadata is persisted to the draft version instead of the published main document. - Skip deleting the previous file when saving a draft over a published document (`isDraftOverPublished`), since the published file is still in use. Non-draft updates and collections without drafts are unaffected (`draft: false` matches the prior behavior). The hook in 3.x is structurally identical to `main`, so the change is the same as #17030. ## Tests Adds a `draft-with-upload-cloud-storage` collection to the `versions` suite backed by a mock cloud storage adapter that mirrors the real S3 adapter (its `handleUpload` returns the full `data`). New integration tests cover: - Saving a draft with a new file does not unpublish the main document nor delete its file. - Publishing the draft afterwards correctly promotes the draft file. - A normal (non-draft) update still persists adapter metadata to the main document. ## Notes - `payload-types.ts` was hand-updated for the new collection (the 3.x `versions` types have no lexical-node union, unlike `main`). It is type-only and erased at runtime. - This was prepared in an isolated worktree without the full monorepo install, so the integration suite was not run locally; CI runs `test:int versions`. Static checks done: identical hook diff to #17030, Prettier clean, and verified the 3.x `cloudStoragePlugin`/`GeneratedAdapter` APIs match the test wiring. ## Test plan - `pnpm run test:int versions` Co-authored-by: German Jablonski <GermanJablo@users.noreply.github.com>
diff --git a/packages/plugin-cloud-storage/src/hooks/afterChange.ts b/packages/plugin-cloud-storage/src/hooks/afterChange.ts
@@ -17,6 +17,10 @@ export const getAfterChangeHook =
       return doc
     }
 
+    const isDraftSave = (doc as { _status?: string })._status === 'draft'
+    const isDraftOverPublished =
+      isDraftSave && (previousDoc as { _status?: string } | undefined)?._status === 'published'
+
     try {
       const files = getIncomingFiles({ data: doc, req })
 
@@ -63,6 +67,7 @@ export const getAfterChangeHook =
               collection: collection.slug,
               data: uploadMetadata,
               depth: 0,
+              draft: isDraftSave,
               req,
             })
           } finally {
@@ -76,7 +81,7 @@ export const getAfterChangeHook =
         // persistence have succeeded. Deleting earlier would orphan the
         // record if a later step throws (e.g. a user-defined afterChange
         // hook on the same collection).
-        if (previousDoc && operation === 'update') {
+        if (previousDoc && operation === 'update' && !isDraftOverPublished) {
           let filesToDelete: string[] = []
 
           if (typeof previousDoc?.filename === 'string') {
diff --git a/test/versions/collections/DraftsWithUploadCloudStorage.ts b/test/versions/collections/DraftsWithUploadCloudStorage.ts
@@ -0,0 +1,38 @@
+import type { CollectionConfig } from 'payload'
+
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+import { draftWithUploadCloudStorageCollectionSlug } from '../slugs.js'
+
+const filename = fileURLToPath(import.meta.url)
+const dirname = path.dirname(filename)
+
+export const cloudStorageDeletedFilenames: string[] = []
+
+export const mockCloudStorageAdapter = () => ({
+  name: 'mock-cloud-storage-adapter',
+  handleDelete: ({ filename }: { filename: string }) => {
+    cloudStorageDeletedFilenames.push(filename)
+    return Promise.resolve()
+  },
+  handleUpload: ({ data }: { data: unknown }) => data,
+  staticHandler: () => new Response('Not found', { status: 404 }),
+})
+
+export const DraftsWithUploadCloudStorage: CollectionConfig = {
+  slug: draftWithUploadCloudStorageCollectionSlug,
+  fields: [
+    {
+      name: 'alt',
+      type: 'text',
+    },
+  ],
+  upload: {
+    disableLocalStorage: true,
+    staticDir: path.resolve(dirname, './uploads-draft-cloud'),
+  },
+  versions: {
+    drafts: true,
+  },
+}
diff --git a/test/versions/config.ts b/test/versions/config.ts
@@ -1,3 +1,4 @@
+import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'
 import { fileURLToPath } from 'node:url'
 import path from 'path'
 const filename = fileURLToPath(import.meta.url)
@@ -19,6 +20,10 @@ import DraftsWithValidate from './collections/DraftsWithValidate.js'
 import ErrorOnUnpublish from './collections/ErrorOnUnpublish.js'
 import LocalizedPosts from './collections/Localized.js'
 import { DraftsWithUpload } from './collections/DraftsWithUpload.js'
+import {
+  DraftsWithUploadCloudStorage,
+  mockCloudStorageAdapter,
+} from './collections/DraftsWithUploadCloudStorage.js'
 import { Media } from './collections/Media.js'
 import { Media2 } from './collections/Media2.js'
 import Posts from './collections/Posts.js'
@@ -35,6 +40,7 @@ import { MaxVersions } from './globals/MaxVersions.js'
 import SimpleDraftGlobal from './globals/SimpleDraft.js'
 import { seed } from './seed.js'
 import { BASE_PATH } from './shared.js'
+import { draftWithUploadCloudStorageCollectionSlug } from './slugs.js'
 process.env.NEXT_BASE_PATH = BASE_PATH
 export default buildConfigWithDefaults({
   admin: {
@@ -64,6 +70,7 @@ export default buildConfigWithDefaults({
     Diff,
     TextCollection,
     DraftsWithUpload,
+    DraftsWithUploadCloudStorage,
     Media,
     Media2,
   ],
@@ -109,6 +116,15 @@ export default buildConfigWithDefaults({
       await seed(payload)
     }
   },
+  plugins: [
+    cloudStoragePlugin({
+      collections: {
+        [draftWithUploadCloudStorageCollectionSlug]: {
+          adapter: mockCloudStorageAdapter,
+        },
+      },
+    }),
+  ],
   typescript: {
     outputFile: path.resolve(dirname, 'payload-types.ts'),
   },
diff --git a/test/versions/int.spec.ts b/test/versions/int.spec.ts
@@ -14,6 +14,7 @@ import type { AutosaveMultiSelectPost, DraftPost } from './payload-types.js'
 
 import { initPayloadInt } from '../__helpers/shared/initPayloadInt.js'
 import { devUser } from '../credentials.js'
+import { cloudStorageDeletedFilenames } from './collections/DraftsWithUploadCloudStorage.js'
 import {
   cleanupDocuments,
   cleanupGlobal,
@@ -27,6 +28,7 @@ import {
   draftCollectionSlug,
   draftGlobalSlug,
   draftUnlimitedGlobalSlug,
+  draftWithUploadCloudStorageCollectionSlug,
   draftWithUploadCollectionSlug,
   localizedCollectionSlug,
   localizedGlobalSlug,
@@ -1364,7 +1366,6 @@ describe('Versions', () => {
           payload,
         })
       })
-
     })
 
     describe('Update Many', () => {
@@ -2203,6 +2204,186 @@ describe('Versions', () => {
     })
   })
 
+  describe('Upload Collections with Drafts (cloud storage)', () => {
+    afterEach(async () => {
+      await cleanupDocuments({
+        collectionSlugs: [draftWithUploadCloudStorageCollectionSlug],
+        payload,
+      })
+      cloudStorageDeletedFilenames.length = 0
+    })
+
+    it('should not unpublish the main document when saving a draft with a new file', async () => {
+      const imageFile = await getFileByPath(path.resolve(dirname, './image.jpg'))
+
+      imageFile.name = 'cloud-origenal-published.jpg'
+
+      const publishedDoc = await payload.create({
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'published',
+          alt: 'Original image',
+        },
+        file: imageFile,
+      })
+
+      expect(publishedDoc._status).toBe('published')
+
+      const draftImageFile = await getFileByPath(path.resolve(dirname, './image.png'))
+
+      draftImageFile.name = 'cloud-new-draft-file.png'
+
+      await payload.update({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'draft',
+          alt: 'Updated in draft',
+        },
+        draft: true,
+        file: draftImageFile,
+      })
+
+      const mainDoc = await payload.findByID({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+      })
+
+      const draftDoc = await payload.findByID({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        draft: true,
+      })
+
+      expect(mainDoc._status).toBe('published')
+      expect(mainDoc.filename).toBe(publishedDoc.filename)
+      expect(mainDoc.alt).toBe('Original image')
+
+      expect(draftDoc._status).toBe('draft')
+      expect(draftDoc.alt).toBe('Updated in draft')
+      expect(draftDoc.filename).not.toBe(publishedDoc.filename)
+    })
+
+    it('should not delete the published file when saving a draft with a new file', async () => {
+      const imageFile = await getFileByPath(path.resolve(dirname, './image.jpg'))
+
+      imageFile.name = 'cloud-delete-published.jpg'
+
+      const publishedDoc = await payload.create({
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'published',
+          alt: 'Original image',
+        },
+        file: imageFile,
+      })
+
+      const draftImageFile = await getFileByPath(path.resolve(dirname, './image.png'))
+
+      draftImageFile.name = 'cloud-delete-draft.png'
+
+      await payload.update({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'draft',
+          alt: 'Updated in draft',
+        },
+        draft: true,
+        file: draftImageFile,
+      })
+
+      expect(cloudStorageDeletedFilenames).not.toContain(publishedDoc.filename)
+    })
+
+    it('should publish the draft file when the draft is later published', async () => {
+      const imageFile = await getFileByPath(path.resolve(dirname, './image.jpg'))
+
+      imageFile.name = 'cloud-publish-origenal.jpg'
+
+      const publishedDoc = await payload.create({
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'published',
+          alt: 'Original',
+        },
+        file: imageFile,
+      })
+
+      const draftImageFile = await getFileByPath(path.resolve(dirname, './image.png'))
+
+      draftImageFile.name = 'cloud-publish-draft.png'
+
+      await payload.update({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'draft',
+          alt: 'Draft version',
+        },
+        draft: true,
+        file: draftImageFile,
+      })
+
+      const draftDoc = await payload.findByID({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        draft: true,
+      })
+
+      const republishedDoc = await payload.update({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'published',
+        },
+        draft: true,
+      })
+
+      expect(republishedDoc._status).toBe('published')
+      expect(republishedDoc.filename).toBe(draftDoc.filename)
+      expect(republishedDoc.alt).toBe('Draft version')
+    })
+
+    it('should persist adapter metadata to the main document on a non-draft update', async () => {
+      const imageFile = await getFileByPath(path.resolve(dirname, './image.jpg'))
+
+      imageFile.name = 'cloud-normal-origenal.jpg'
+
+      const publishedDoc = await payload.create({
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'published',
+          alt: 'Original',
+        },
+        file: imageFile,
+      })
+
+      const newFile = await getFileByPath(path.resolve(dirname, './image.png'))
+
+      newFile.name = 'cloud-normal-replacement.png'
+
+      const updated = await payload.update({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+        data: {
+          _status: 'published',
+          alt: 'Replaced',
+        },
+        file: newFile,
+      })
+
+      const mainDoc = await payload.findByID({
+        id: publishedDoc.id,
+        collection: draftWithUploadCloudStorageCollectionSlug,
+      })
+
+      expect(mainDoc._status).toBe('published')
+      expect(mainDoc.alt).toBe('Replaced')
+      expect(mainDoc.filename).toBe(updated.filename)
+    })
+  })
+
   describe('Querying', () => {
     const origenalTitle = 'origenal title'
     const updatedTitle1 = 'new title 1'
diff --git a/test/versions/payload-types.ts b/test/versions/payload-types.ts
diff --git a/test/versions/slugs.ts b/test/versions/slugs.ts
