Default x-amz-tagging to dv-state=temp when the server omits the field

Author: ErykKul

CHANGELOG.md

@@ -16,7 +16,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 ### Changed
 
 - **BREAKING**: `DirectUploadClient` constructor signature changed from `(filesRepository, maxMultipartRetries = 5)` to `(filesRepository, config: DirectUploadClientConfig = {})`. `config` now holds `maxMultipartRetries` (default 5) and the new `fileUploadTimeoutMs` (default 60000). Existing TypeScript consumers passing the second argument as a number will need to migrate to `{ maxMultipartRetries: N }`.
-- Files: `DirectUploadClient` now reads the `tagging` field from the upload-destination response instead of hard-coding `x-amz-tagging: dv-state=temp`. This lets the server gate tagging per-driver for storage backends that don't support it (e.g. IBM Cloud Object Storage). When the server omits the field (older Dataverse releases that predate it), the client sends no `x-amz-tagging` header — lifecycle policies that previously relied on the client setting `dv-state=temp` need to move to bucket-level rules or wait for the matching server release.
+- Files: `DirectUploadClient` now reads the `tagging` field from the upload-destination response so operators on storage that doesn't accept S3 tags can opt out per-driver via `dataverse.files.<id>.disable-tagging=true`. The default behaviour is unchanged: when the server omits the field the client still sends `x-amz-tagging: dv-state=temp` (the same tag that earlier SDK versions hard-coded), so the new SDK is backwards-compatible with Dataverse releases that predate the response field. A server that explicitly returns an empty `tagging` value tells the client to skip the header entirely.
 
 ### Fixed
 

src/files/infra/clients/DirectUploadClient.ts

@@ -69,8 +69,19 @@ export class DirectUploadClient implements IDirectUploadClient {
       const headers: Record<string, string> = {
         'Content-Type': 'application/octet-stream'
       }
-      if (destination.tagging !== undefined) {
-        headers['x-amz-tagging'] = destination.tagging
+      // Default to `dv-state=temp` when the upload destination response
+      // omits the field. That tag is what every Dataverse install emits
+      // today and what every install before this change had hard-coded;
+      // making "omitted" mean "no tag" would silently break uploads
+      // against any S3 bucket whose lifecycle/access policy expects the
+      // `dv-state=temp` marker, including the default IQSS configuration.
+      // Operators with storage that doesn't accept S3 tags opt out
+      // explicitly via `dataverse.files.<id>.disable-tagging=true`,
+      // which causes the server to return an empty `tagging` field and
+      // the client below to skip the header.
+      const tag = destination.tagging ?? 'dv-state=temp'
+      if (tag !== '') {
+        headers['x-amz-tagging'] = tag
       }
       await axios.put(destination.urls[0], arrayBuffer, {
         headers,

test/unit/files/DirectUploadClient.test.ts

@@ -116,7 +116,7 @@ describe('uploadFile', () => {
       )
     })
 
-    test('should not include S3 tagging header when upload destination omits tagging', async () => {
+    test('should default to dv-state=temp tagging when upload destination omits tagging', async () => {
       const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
       const testDestination: FileUploadDestination = createSingleFileUploadDestinationModel()
       filesRepositoryStub.getFileUploadDestination = jest.fn().mockResolvedValue(testDestination)
@@ -130,6 +130,34 @@ describe('uploadFile', () => {
 
       await sut.uploadFile(1, testFile, progressMock, abortController)
 
+      expect(axiosPutSpy).toHaveBeenCalledWith(
+        testDestination.urls[0],
+        expect.anything(),
+        expect.objectContaining({
+          headers: expect.objectContaining({
+            'x-amz-tagging': 'dv-state=temp'
+          })
+        })
+      )
+    })
+
+    test('should omit the S3 tagging header when upload destination explicitly returns empty tagging', async () => {
+      const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
+      const testDestination: FileUploadDestination = {
+        ...createSingleFileUploadDestinationModel(),
+        tagging: ''
+      }
+      filesRepositoryStub.getFileUploadDestination = jest.fn().mockResolvedValue(testDestination)
+
+      const axiosPutSpy = jest.spyOn(axios, 'put').mockResolvedValue(undefined)
+
+      const sut = new DirectUploadClient(filesRepositoryStub)
+
+      const progressMock = jest.fn()
+      const abortController = new AbortController()
+
+      await sut.uploadFile(1, testFile, progressMock, abortController)
+
       expect(axiosPutSpy).toHaveBeenCalledWith(
         testDestination.urls[0],
         expect.anything(),