feat(storage): support tagging directive in copy (#14527)

Author: soberm

packages/storage/__tests__/providers/s3/apis/internal/copy.test.ts

@@ -196,6 +196,7 @@ describe('copy API', () => {
 								...copyObjectClientBaseParams,
 								CopySource: expectedSourceKey,
 								Key: expectedDestinationKey,
+								TaggingDirective: 'COPY',
 							},
 						);
 					});
@@ -226,6 +227,7 @@ describe('copy API', () => {
 						MetadataDirective: 'COPY',
 						CopySource: `${bucket}/public/sourceKey`,
 						Key: 'public/destinationKey',
+						TaggingDirective: 'COPY',
 					},
 				);
 			});
@@ -340,6 +342,7 @@ describe('copy API', () => {
 							...copyObjectClientBaseParams,
 							CopySource: `${bucket}/${expectedSourcePath}`,
 							Key: expectedDestinationPath,
+							TaggingDirective: 'COPY',
 						},
 					);
 				},
@@ -368,6 +371,7 @@ describe('copy API', () => {
 						MetadataDirective: 'COPY',
 						CopySource: `${bucket}/sourcePath`,
 						Key: 'destinationPath',
+						TaggingDirective: 'COPY',
 					},
 				);
 			});
@@ -431,6 +435,49 @@ describe('copy API', () => {
 					);
 				});
 			});
+
+			describe('TagConfig passed in input', () => {
+				it('should use COPY TaggingDirective when tagConfig is not provided (default)', async () => {
+					await copyWrapper({
+						source: { path: 'sourcePath' },
+						destination: { path: 'destinationPath' },
+					});
+
+					expect(copyObject).toHaveBeenCalledWith(
+						expect.any(Object),
+						expect.objectContaining({
+							TaggingDirective: 'COPY',
+						}),
+					);
+				});
+
+				it('should use COPY TaggingDirective when tagConfig mode is copy', async () => {
+					await copyWrapper({
+						source: { path: 'sourcePath' },
+						destination: { path: 'destinationPath' },
+						tagConfig: { mode: 'copy' },
+					});
+
+					expect(copyObject).toHaveBeenCalledWith(
+						expect.any(Object),
+						expect.objectContaining({
+							TaggingDirective: 'COPY',
+						}),
+					);
+				});
+
+				it('should use REPLACE TaggingDirective with empty tagging when tagConfig mode is remove', async () => {
+					await copyWrapper({
+						source: { path: 'sourcePath' },
+						destination: { path: 'destinationPath' },
+						tagConfig: { mode: 'remove' },
+					});
+
+					const callArgs = mockCopyObject.mock.calls[0][1];
+					expect(callArgs.TaggingDirective).toBe('REPLACE');
+					expect(callArgs.Tagging).toBeUndefined();
+				});
+			});
 		});
 	});
 
@@ -460,6 +507,7 @@ describe('copy API', () => {
 						...copyObjectClientBaseParams,
 						CopySource: `${bucket}/public/${missingSourceKey}`,
 						Key: `public/${destinationKey}`,
+						TaggingDirective: 'COPY',
 					},
 				);
 				expect(error.$metadata.httpStatusCode).toBe(404);

packages/storage/__tests__/providers/s3/utils/client/s3Data/copyObject.test.ts

@@ -107,12 +107,14 @@ describe('validateCopyObjectHeaders', () => {
 			request: {
 				...baseRequest,
 				MetadataDirective: 'mock-metadata',
+				TaggingDirective: 'COPY',
 				CopySourceIfMatch: 'mock-etag',
 				CopySourceIfUnmodifiedSince: new Date(0),
 			},
 			headers: {
 				...baseHeaders,
 				'x-amz-metadata-directive': 'mock-metadata',
+				'x-amz-tagging-directive': 'COPY',
 				'x-amz-copy-source-if-match': 'mock-etag',
 				'x-amz-copy-source-if-unmodified-since':
 					'Thu, 01 Jan 1970 00:00:00 GMT',

packages/storage/src/internals/types/inputs.ts

@@ -137,6 +137,7 @@ type ExtendCopyInputWithAdvancedOptions<InputType, ExtendedOptionsType> =
 		? {
 				source: InputType['source'];
 				destination: InputType['destination'];
+				tagConfig?: InputType['tagConfig'];
 				options?: ExtendedOptionsType;
 			}
 		: never;

packages/storage/src/providers/s3/apis/internal/copy.ts

@@ -10,6 +10,7 @@ import {
 	CopyWithPathInput,
 	CopyWithPathOutput,
 } from '../../types';
+import { TagConfig } from '../../../../types/inputs';
 import { ResolvedS3Config, StorageBucket } from '../../types/options';
 import {
 	isInputWithPath,
@@ -114,6 +115,7 @@ const copyWithPath = async (
 		eTag: input.source.eTag,
 		expectedSourceBucketOwner: input.source?.expectedBucketOwner,
 		expectedBucketOwner: input.destination?.expectedBucketOwner,
+		tagConfig: input.tagConfig,
 	});
 
 	return { path: finalCopyDestination };
@@ -193,6 +195,7 @@ const serviceCopy = async ({
 	eTag,
 	expectedSourceBucketOwner,
 	expectedBucketOwner,
+	tagConfig,
 }: {
 	source: string;
 	destination: string;
@@ -202,6 +205,7 @@ const serviceCopy = async ({
 	eTag?: string;
 	expectedSourceBucketOwner?: string;
 	expectedBucketOwner?: string;
+	tagConfig?: TagConfig;
 }) => {
 	await copyObject(
 		{
@@ -213,6 +217,7 @@ const serviceCopy = async ({
 			CopySource: source,
 			Key: destination,
 			MetadataDirective: 'COPY', // Copies over metadata like contentType as well
+			TaggingDirective: tagConfig?.mode === 'remove' ? 'REPLACE' : 'COPY',
 			CopySourceIfMatch: eTag,
 			CopySourceIfUnmodifiedSince: notModifiedSince,
 			ExpectedSourceBucketOwner: expectedSourceBucketOwner,

packages/storage/src/providers/s3/utils/client/s3data/copyObject.ts

@@ -35,6 +35,7 @@ export type CopyObjectInput = Pick<
 	| 'CopySource'
 	| 'Key'
 	| 'MetadataDirective'
+	| 'TaggingDirective'
 	| 'CacheControl'
 	| 'ContentType'
 	| 'ContentDisposition'
@@ -60,6 +61,7 @@ const copyObjectSerializer = async (
 		...assignStringVariables({
 			'x-amz-copy-source': input.CopySource,
 			'x-amz-metadata-directive': input.MetadataDirective,
+			'x-amz-tagging-directive': input.TaggingDirective,
 			'x-amz-copy-source-if-match': input.CopySourceIfMatch,
 			'x-amz-copy-source-if-unmodified-since':
 				input.CopySourceIfUnmodifiedSince?.toUTCString(),
@@ -97,6 +99,7 @@ export const validateCopyObjectHeaders = (
 			input.MetadataDirective,
 			headers['x-amz-metadata-directive'],
 		),
+		bothNilOrEqual(input.TaggingDirective, headers['x-amz-tagging-directive']),
 		bothNilOrEqual(
 			input.CopySourceIfMatch,
 			headers['x-amz-copy-source-if-match'],

packages/storage/src/types/inputs.ts

@@ -95,9 +95,30 @@ export interface StorageCopyInputWithKey<
 	destination: DestinationOptions;
 }
 
+export interface CopyTagConfig {
+	mode: 'copy';
+}
+
+export interface RemoveTagConfig {
+	mode: 'remove';
+}
+
+export interface ReplaceTagConfig {
+	mode: 'replace';
+	tags: Record<string, string>;
+}
+
+export type TagConfigInternal =
+	| CopyTagConfig
+	| RemoveTagConfig
+	| ReplaceTagConfig;
+
+export type TagConfig = Exclude<TagConfigInternal, ReplaceTagConfig>;
+
 export interface StorageCopyInputWithPath {
 	source: StorageOperationInputWithPath & CopyWithPathSourceOptions;
 	destination: StorageOperationInputWithPath & CopyWithPathDestinationOptions;
+	tagConfig?: TagConfig;
 }
 
 /**