feat: add use() to smithy client to inject middleware

Author: AllanZhengYP

clients/node/client-rds-data-node/RDSDataClient.ts

@@ -1,16 +1,16 @@
-import * as __aws_sdk_middleware_content_length from "@aws-sdk/middleware-content-length";
+import { contentLengthPlugin } from "@aws-sdk/middleware-content-length";
 import * as __aws_sdk_middleware_header_default from "@aws-sdk/middleware-header-default";
 import * as __aws_sdk_retry_middleware from "@aws-sdk/retry-middleware";
-import * as __aws_sdk_signing_middleware from "@aws-sdk/signing-middleware";
+import { signingPlugin } from "@aws-sdk/signing-middleware";
 import * as __aws_sdk_util_user_agent_node from "@aws-sdk/util-user-agent-node";
 import {
   RDSDataConfiguration,
   RDSDataResolvedConfiguration,
   RDSRuntimeConfiguration
 } from "./RDSDataConfiguration";
-import { AwsAuthConfiguration, RegionConfiguration, RetryConfig, EndpointsConfig, ProtocolConfig } from './Configurations';
-import {version as clientVersion} from './package.json';
-import {HttpOptions, MetadataBearer} from '@aws-sdk/types';
+import { AwsAuthConfiguration, RegionConfiguration, RetryConfig, EndpointsConfig, ProtocolConfig } from '@aws-sdk/config-resolver';
+import { version as clientVersion } from './package.json';
+import { HttpOptions, MetadataBearer } from '@aws-sdk/types';
 import { SmithyClient } from "@aws-sdk/smithy-client";
 
 /**
@@ -38,16 +38,7 @@ export class RDSDataClient extends SmithyClient<HttpOptions, InputTypesUnion, Ou
     let intermediaConfig_3 = EndpointsConfig.resolve(intermediaConfig_2);
     let intermediaConfig_4 = RetryConfig.resolve(intermediaConfig_3);
     this.config = intermediaConfig_4;
-    this.middlewareStack.add(
-      __aws_sdk_middleware_content_length.contentLengthMiddleware(
-        this.config.bodyLengthChecker
-      ),
-      {
-        step: "build",
-        priority: -80,
-        tags: { SET_CONTENT_LENGTH: true }
-      }
-    );
+    super.use(contentLengthPlugin(this.config.bodyLengthChecker));
     if (this.config.maxRetries > 0) {
       this.middlewareStack.add(
         __aws_sdk_retry_middleware.retryMiddleware(
@@ -62,17 +53,7 @@ export class RDSDataClient extends SmithyClient<HttpOptions, InputTypesUnion, Ou
         }
       );
     }
-    this.middlewareStack.add(
-      __aws_sdk_signing_middleware.signingMiddleware<
-        InputTypesUnion,
-        OutputTypesUnion
-      >(this.config.signer),
-      {
-        step: "finalize",
-        priority: 0,
-        tags: { SIGNATURE: true }
-      }
-    );
+    super.use(signingPlugin(this.config.signer));
     this.middlewareStack.add(
       __aws_sdk_middleware_header_default.headerDefault({
         "User-Agent": __aws_sdk_util_user_agent_node.defaultUserAgent(

packages/middleware-content-length/src/index.ts

@@ -4,7 +4,8 @@ import {
   BuildMiddleware,
   BodyLengthCalculator,
   MetadataBearer,
-  BuildHandlerOutput
+  BuildHandlerOutput,
+  InjectableMiddleware
 } from "@aws-sdk/types";
 import { HttpRequest } from "@aws-sdk/protocol-http";
 
@@ -42,3 +43,13 @@ export function contentLengthMiddleware(
     });
   };
 }
+
+export function contentLengthPlugin(
+  bodyLengthCalculator: BodyLengthCalculator
+): InjectableMiddleware {
+  return {
+    middleware: contentLengthMiddleware(bodyLengthCalculator),
+    step: "build",
+    tags: { SET_CONTENT_LENGTH: true }
+  };
+}

packages/signing-middleware/src/index.ts

@@ -1,15 +1,16 @@
 import {
   FinalizeHandler,
   FinalizeHandlerArguments,
-  FinalizeMiddleware,
+  FinalizeRequestMiddleware,
   RequestSigner,
   FinalizeHandlerOutput,
-  HttpRequest
+  HttpRequest,
+  InjectableMiddleware
 } from "@aws-sdk/types";
 
 export function signingMiddleware<Input extends object, Output extends object>(
   signer: RequestSigner
-): FinalizeMiddleware<Input, Output> {
+): FinalizeRequestMiddleware<Input, Output> {
   return (
     next: FinalizeHandler<Input, Output>
   ): FinalizeHandler<Input, Output> => async (
@@ -21,3 +22,13 @@ export function signingMiddleware<Input extends object, Output extends object>(
       request: await signer.sign(args.request as HttpRequest)
     });
 }
+
+export function signingPlugin<Input extends object, Output extends object>(
+  signer: RequestSigner
+): InjectableMiddleware<Input, Output> {
+  return {
+    middleware: signingMiddleware<Input, Output>(signer),
+    step: "finalizeRequest",
+    tags: { SIGNATURE: true }
+  };
+}

packages/smithy-client/src/index.ts

@@ -1,5 +1,11 @@
 import { MiddlewareStack } from "@aws-sdk/middleware-stack";
-import { Protocol, Command, MetadataBearer } from "@aws-sdk/types";
+import {
+  Protocol,
+  Command,
+  MetadataBearer,
+  InjectableMiddleware,
+  HandlerOptions as InjectOptions
+} from "@aws-sdk/types";
 
 export interface SmithyConfiguration<HandlerOptions> {
   protocol: Protocol<any, any, HandlerOptions>;
@@ -19,6 +25,20 @@ export class SmithyClient<
   constructor(config: SmithyConfiguration<HandlerOptions>) {
     this.config = config;
   }
+  use(
+    injectable: InjectableMiddleware<ClientInput, ClientOutput>,
+    options: InjectOptions = {}
+  ) {
+    const { middleware, step, priority, tags } = injectable;
+    this.middlewareStack.add(
+      middleware as any,
+      {
+        step: options.step || step,
+        priority: options.priority || priority,
+        tags: { ...tags, ...options.tags }
+      } as any
+    );
+  }
   send<InputType extends ClientInput, OutputType extends ClientOutput>(
     command: Command<
       ClientInput,

packages/types/src/middleware.ts

@@ -365,3 +365,46 @@ export interface HandlerExecutionContext {
    */
   logger: Logger;
 }
+
+export type InjectableMiddleware<
+  Input extends object = any,
+  Output extends object = any
+> =
+  | {
+      middleware: Middleware<Input, Output>;
+      step: "initialize";
+      priority?: number;
+      tags?: { [tag: string]: any };
+    }
+  | {
+      middleware: SerializeMiddleware<Input, Output>;
+      step: "serialization";
+      priority?: number;
+      tags?: { [tag: string]: any };
+    }
+  | {
+      middleware: FinalizeRequestMiddleware<Input, Output>;
+      step: "build";
+      priority?: number;
+      tags?: { [tag: string]: any };
+    }
+  | {
+      middleware: FinalizeRequestMiddleware<Input, Output>;
+      step: "finalizeRequest";
+      priority?: number;
+      tags?: { [tag: string]: any };
+    }
+  | {
+      middleware: DeserializeMiddleware<Input, Output>;
+      step: "deserialize";
+      priority?: number;
+      tags?: { [tag: string]: any };
+    };
+
+// export type InjectableMiddleware<
+//   Input extends object = any,
+//   Output extends object = any
+//   > = {
+//     middleware: Middleware<Input, Output> | SerializeMiddleware<Input, Output> | FinalizeRequestMiddleware<Input, Output> | DeserializeMiddleware<Input, Output>
+//     options: HandlerOptions & { step?: "initialize" } | SerializeHandlerOptions | BuildHandlerOptions | FinalizeRequestHandlerOptions | DeserializeHandlerOptions
+//   }