Split s3Extended into per-command files under src/commands

Issue: CLDSRVCLT-10

Author: maeldonn

examples/s3ExtendedGetObjectAttributes.ts

@@ -0,0 +1,22 @@
+
+import { S3Client, S3ClientConfig } from '@aws-sdk/client-s3';
+import { GetObjectAttributesExtendedCommand } from '@scality/cloudserverclient/commands/s3Extended';
+
+const config: S3ClientConfig = {
+    endpoint: 'http://localhost:8000',
+    credentials: {
+        accessKeyId: 'accessKey1',
+        secretAccessKey: 'verySecretKey1',
+    },
+    region: 'us-east-1',
+};
+
+const client = new S3Client(config);
+
+const response = await client.send(
+    new GetObjectAttributesExtendedCommand({
+        Bucket: 'aBucketName',
+        Key: 'anObjectKey',
+        ObjectAttributes: ['ETag', 'ObjectSize', 'x-amz-meta-*'],
+    }),
+);

examples/s3extended.ts examples/s3ExtendedListObjectsV2.tsexamples/s3extended.ts renamed to examples/s3ExtendedListObjectsV2.ts

@@ -1,6 +1,6 @@
 
 import { S3Client, S3ClientConfig } from '@aws-sdk/client-s3';
-import { ListObjectsV2ExtendedCommand } from '@scality/cloudserverclient/clients/s3Extended';
+import { ListObjectsV2ExtendedCommand } from '@scality/cloudserverclient/commands/s3Extended';
 
 const config: S3ClientConfig = {
     endpoint: 'http://localhost:8000',

src/clients/s3Extended.ts

@@ -0,0 +1,43 @@
+import {
+    GetObjectAttributesCommand,
+    GetObjectAttributesCommandInput,
+    GetObjectAttributesCommandOutput,
+} from '@aws-sdk/client-s3';
+import {
+    overrideObjectAttributesHeaderMiddleware,
+    captureResponseBodyMiddleware,
+    parseUserMetadataMiddleware,
+} from './utils';
+
+export interface GetObjectAttributesExtendedInput extends Omit<GetObjectAttributesCommandInput, 'ObjectAttributes'> {
+    ObjectAttributes: string[];
+}
+
+export interface GetObjectAttributesExtendedOutput extends GetObjectAttributesCommandOutput {
+    [key: `x-amz-meta-${string}`]: string;
+}
+
+export class GetObjectAttributesExtendedCommand extends GetObjectAttributesCommand {
+    constructor(input: GetObjectAttributesExtendedInput) {
+        super(input as GetObjectAttributesCommandInput);
+
+        const captured = { xml: '' };
+
+        this.middlewareStack.add(overrideObjectAttributesHeaderMiddleware('x-amz-object-attributes', input.ObjectAttributes), {
+            step: 'build',
+            name: 'overrideObjectAttributesHeader',
+        });
+
+        this.middlewareStack.add(captureResponseBodyMiddleware(captured), {
+            step: 'deserialize',
+            name: 'captureResponseBody',
+            priority: 'low', // runs before SDK deserializer
+        });
+
+        this.middlewareStack.add(parseUserMetadataMiddleware(captured), {
+            step: 'deserialize',
+            name: 'parseUserMetadata',
+            priority: 'high', // runs after SDK deserializer
+        });
+    }
+}

src/commands/s3Extended/getObjectAttributes.ts

@@ -0,0 +1,4 @@
+export * from './listObjects';
+export * from './listObjectsV2';
+export * from './listObjectVersions';
+export * from './getObjectAttributes';

src/commands/s3Extended/index.ts

@@ -0,0 +1,17 @@
+import { ListObjectVersionsCommand, ListObjectVersionsCommandInput } from '@aws-sdk/client-s3';
+import { extendCommandWithExtraParametersMiddleware } from './utils';
+
+export interface ListObjectVersionsExtendedInput extends ListObjectVersionsCommandInput {
+    Query: string;
+}
+
+export class ListObjectVersionsExtendedCommand extends ListObjectVersionsCommand {
+    constructor(input: ListObjectVersionsExtendedInput) {
+        super(input);
+
+        this.middlewareStack.add(
+            extendCommandWithExtraParametersMiddleware(input.Query),
+            { step: 'build', name: 'extendCommandWithExtraParameters' }
+        );
+    }
+}

src/commands/s3Extended/listObjectVersions.ts

@@ -0,0 +1,17 @@
+import { ListObjectsCommand, ListObjectsCommandInput } from '@aws-sdk/client-s3';
+import { extendCommandWithExtraParametersMiddleware } from './utils';
+
+export interface ListObjectsExtendedInput extends ListObjectsCommandInput {
+    Query: string;
+}
+
+export class ListObjectsExtendedCommand extends ListObjectsCommand {
+    constructor(input: ListObjectsExtendedInput) {
+        super(input);
+
+        this.middlewareStack.add(
+            extendCommandWithExtraParametersMiddleware(input.Query),
+            { step: 'build', name: 'extendCommandWithExtraParameters' }
+        );
+    }
+}

src/commands/s3Extended/listObjects.ts

@@ -0,0 +1,57 @@
+import {
+    ListObjectsV2Command,
+    ListObjectsV2CommandInput,
+    ListObjectsV2CommandOutput,
+    _Object,
+} from '@aws-sdk/client-s3';
+import {
+    extendCommandWithExtraParametersMiddleware,
+    overrideObjectAttributesHeaderMiddleware,
+    captureResponseBodyMiddleware,
+    parseListObjectsUserMetadataMiddleware,
+} from './utils';
+
+export interface ListObjectsV2ExtendedInput extends ListObjectsV2CommandInput {
+    Query?: string;
+    ObjectAttributes?: string[];
+}
+
+export interface ListObjectsV2ExtendedContentEntry extends _Object {
+    [key: `x-amz-meta-${string}`]: string;
+}
+
+export interface ListObjectsV2ExtendedOutput extends ListObjectsV2CommandOutput {
+    Contents?: ListObjectsV2ExtendedContentEntry[];
+}
+
+export class ListObjectsV2ExtendedCommand extends ListObjectsV2Command {
+    constructor(input: ListObjectsV2ExtendedInput) {
+        super(input);
+
+        this.middlewareStack.add(
+            extendCommandWithExtraParametersMiddleware(input.Query),
+            { step: 'build', name: 'extendCommandWithExtraParameters' }
+        );
+
+        if (input.ObjectAttributes?.length) {
+            const captured = { xml: '' };
+
+            this.middlewareStack.add(overrideObjectAttributesHeaderMiddleware('x-amz-optional-object-attributes', input.ObjectAttributes), {
+                step: 'build',
+                name: 'overrideObjectAttributesHeader',
+            });
+
+            this.middlewareStack.add(captureResponseBodyMiddleware(captured), {
+                step: 'deserialize',
+                name: 'captureResponseBody',
+                priority: 'low',
+            });
+
+            this.middlewareStack.add(parseListObjectsUserMetadataMiddleware(captured), {
+                step: 'deserialize',
+                name: 'parseUserMetadata',
+                priority: 'high',
+            });
+        }
+    }
+}