feat: refactor middleware stack (#1398)

* feat(middleware-stack): refactor middleware stack implementation and interface * feat: update dedendents with updated middleware interface * feat(middleware-stack): make middleware stack a pluggable, address feedbacks BREAKING CHANGE: addRelativeTo() now doesn't require step in options. The middleware will be injected to the same step as the toMiddleware
aws · Jul 28, 2020 · 9fedaa9 · 9fedaa9
1 parent 88e96e6
commit 9fedaa9
Show file tree

Hide file tree

Showing 18 changed files with 574 additions and 733 deletions.
diff --git a/packages/credential-provider-cognito-identity/src/fromCognitoIdentity.spec.ts b/packages/credential-provider-cognito-identity/src/fromCognitoIdentity.spec.ts
@@ -35,12 +35,12 @@ describe("fromCognitoIdentity", () => {
       expiration,
     });
 
-    expect(send.mock.calls[0][0]).toEqual(
-      new GetCredentialsForIdentityCommand({
-        IdentityId: identityId,
-        CustomRoleArn: "myArn",
-      })
-    );
+    const sendParam = send.mock.calls[0][0];
+    expect(sendParam).toEqual(expect.any(GetCredentialsForIdentityCommand));
+    expect(sendParam.input).toEqual({
+      IdentityId: identityId,
+      CustomRoleArn: "myArn",
+    });
   });
 
   it("should resolve logins to string tokens and pass them to the service", async () => {
@@ -54,16 +54,16 @@ describe("fromCognitoIdentity", () => {
       },
     })();
 
-    expect(send.mock.calls[0][0]).toEqual(
-      new GetCredentialsForIdentityCommand({
-        IdentityId: identityId,
-        CustomRoleArn: "myArn",
-        Logins: {
-          myDomain: "token",
-          "www.amazon.com": "expiring nonce",
-        },
-      })
-    );
+    const sendParam = send.mock.calls[0][0];
+    expect(sendParam).toEqual(expect.any(GetCredentialsForIdentityCommand));
+    expect(sendParam.input).toMatchObject({
+      IdentityId: identityId,
+      CustomRoleArn: "myArn",
+      Logins: {
+        myDomain: "token",
+        "www.amazon.com": "expiring nonce",
+      },
+    });
   });
 
   it("should convert a GetCredentialsForIdentity response without credentials to a provider error", async () => {

diff --git a/packages/credential-provider-cognito-identity/src/fromCognitoIdentityPool.spec.ts b/packages/credential-provider-cognito-identity/src/fromCognitoIdentityPool.spec.ts
@@ -56,7 +56,10 @@ describe("fromCognitoIdentityPool", () => {
     });
 
     expect(send.mock.calls.length).toBe(1);
-    expect(send.mock.calls[0][0]).toEqual(new GetIdCommand({ IdentityPoolId: identityPoolId }));
+    expect(send.mock.calls[0][0]).toEqual(expect.any(GetIdCommand));
+    expect(send.mock.calls[0][0].input).toEqual({
+      IdentityPoolId: identityPoolId,
+    });
 
     expect((fromCognitoIdentity as any).mock.calls.length).toBe(1);
     expect((fromCognitoIdentity as any).mock.calls[0][0]).toEqual({
@@ -76,15 +79,14 @@ describe("fromCognitoIdentityPool", () => {
       },
     })();
 
-    expect(send.mock.calls[0][0]).toEqual(
-      new GetIdCommand({
-        IdentityPoolId: identityPoolId,
-        Logins: {
-          myDomain: "token",
-          "www.amazon.com": "expiring nonce",
-        },
-      })
-    );
+    expect(send.mock.calls[0][0]).toEqual(expect.any(GetIdCommand));
+    expect(send.mock.calls[0][0].input).toEqual({
+      IdentityPoolId: identityPoolId,
+      Logins: {
+        myDomain: "token",
+        "www.amazon.com": "expiring nonce",
+      },
+    });
   });
 
   it("should not invoke GetId a second time once an identityID has been fetched", async () => {

diff --git a/packages/eventstream-handler-node/package.json b/packages/eventstream-handler-node/package.json
@@ -25,7 +25,7 @@
     "@aws-sdk/util-utf8-node": "1.0.0-gamma.4",
     "@types/jest": "^26.0.4",
     "jest": "^26.1.0",
-    "typescript": "~3.4.0"
+    "typescript": "~3.9.3"
   },
   "engines": {
     "node": ">= 10.0.0"

diff --git a/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.spec.ts b/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.spec.ts
@@ -1,4 +1,4 @@
-import { MiddlewareStack } from "@aws-sdk/middleware-stack";
+import { constructStack } from "@aws-sdk/middleware-stack";
 import { HttpRequest } from "@aws-sdk/protocol-http";
 
 import { bucketEndpointMiddleware, bucketEndpointMiddlewareOptions } from "./bucketEndpointMiddleware";
@@ -130,7 +130,7 @@ describe("bucketEndpointMiddleware", () => {
   });
 
   it("should be inserted before 'hostheaderMiddleware' if exists", async () => {
-    const stack = new MiddlewareStack();
+    const stack = constructStack();
     const mockHostheaderMiddleware = (next: any) => (args: any) => {
       args.request.arr.push("two");
       return next(args);

diff --git a/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.ts b/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.ts
@@ -2,12 +2,11 @@ import { HttpRequest } from "@aws-sdk/protocol-http";
 import {
   BuildHandler,
   BuildHandlerArguments,
-  BuildHandlerOptions,
   BuildHandlerOutput,
   BuildMiddleware,
   MetadataBearer,
   Pluggable,
-  RelativeLocation,
+  RelativeMiddlewareOptions,
 } from "@aws-sdk/types";
 
 import { bucketHostname } from "./bucketHostname";
@@ -49,8 +48,7 @@ export function bucketEndpointMiddleware(options: BucketEndpointResolvedConfig):
   };
 }
 
-export const bucketEndpointMiddlewareOptions: BuildHandlerOptions & RelativeLocation<any, any> = {
-  step: "build",
+export const bucketEndpointMiddlewareOptions: RelativeMiddlewareOptions = {
   tags: ["BUCKET_ENDPOINT"],
   name: "bucketEndpointMiddleware",
   relation: "before",

diff --git a/packages/middleware-eventstream/src/handling-middleware.ts b/packages/middleware-eventstream/src/handling-middleware.ts
@@ -1,5 +1,5 @@
 import { HttpRequest } from "@aws-sdk/protocol-http";
-import { FinalizeRequestHandlerOptions, FinalizeRequestMiddleware, RelativeLocation } from "@aws-sdk/types";
+import { FinalizeRequestMiddleware, RelativeMiddlewareOptions } from "@aws-sdk/types";
 
 import { EventStreamResolvedConfig } from "./configuration";
 
@@ -11,8 +11,7 @@ export const eventStreamHandlingMiddleware = (
   return options.eventStreamPayloadHandler.handle(next, args, context);
 };
 
-export const eventStreamHandlingMiddlewareOptions: FinalizeRequestHandlerOptions & RelativeLocation<any, any> = {
-  step: "finalizeRequest",
+export const eventStreamHandlingMiddlewareOptions: RelativeMiddlewareOptions = {
   tags: ["EVENT_STREAM", "SIGNATURE", "HANDLE"],
   name: "eventStreamHandlingMiddleware",
   relation: "after",

diff --git a/packages/middleware-sdk-s3-control/src/prepend-account-id.ts b/packages/middleware-sdk-s3-control/src/prepend-account-id.ts
@@ -2,12 +2,11 @@ import { HttpRequest } from "@aws-sdk/protocol-http";
 import {
   BuildHandler,
   BuildHandlerArguments,
-  BuildHandlerOptions,
   BuildHandlerOutput,
   BuildMiddleware,
   MetadataBearer,
   Pluggable,
-  RelativeLocation,
+  RelativeMiddlewareOptions,
 } from "@aws-sdk/types";
 
 export function prependAccountIdMiddleware(): BuildMiddleware<any, any> {
@@ -40,8 +39,7 @@ export function prependAccountIdMiddleware(): BuildMiddleware<any, any> {
   };
 }
 
-export const prependAccountIdMiddlewareOptions: BuildHandlerOptions & RelativeLocation<any, any> = {
-  step: "build",
+export const prependAccountIdMiddlewareOptions: RelativeMiddlewareOptions = {
   tags: ["PREPEND_ACCOUNT_ID_MIDDLEWARE"],
   name: "prependAccountIdMiddleware",
   relation: "before",

diff --git a/packages/middleware-sdk-transcribe-streaming/src/middleware-endpoint.ts b/packages/middleware-sdk-transcribe-streaming/src/middleware-endpoint.ts
@@ -2,9 +2,8 @@ import { HttpRequest } from "@aws-sdk/protocol-http";
 import {
   BuildHandler,
   BuildHandlerArguments,
-  BuildHandlerOptions,
   BuildMiddleware,
-  RelativeLocation,
+  RelativeMiddlewareOptions,
   RequestHandler,
 } from "@aws-sdk/types";
 
@@ -54,8 +53,7 @@ export const websocketURLMiddleware = (options: {
   return next(args);
 };
 
-export const websocketURLMiddlewareOptions: BuildHandlerOptions & RelativeLocation<any, any> = {
-  step: "build",
+export const websocketURLMiddlewareOptions: RelativeMiddlewareOptions = {
   name: "websocketURLMiddleware",
   tags: ["WEBSOCKET", "EVENT_STREAM"],
   relation: "after",

diff --git a/packages/middleware-signing/src/middleware.ts b/packages/middleware-signing/src/middleware.ts
@@ -3,10 +3,9 @@ import {
   FinalizeHandler,
   FinalizeHandlerArguments,
   FinalizeHandlerOutput,
-  FinalizeRequestHandlerOptions,
   FinalizeRequestMiddleware,
   Pluggable,
-  RelativeLocation,
+  RelativeMiddlewareOptions,
 } from "@aws-sdk/types";
 
 import { AwsAuthResolvedConfig } from "./configurations";
@@ -43,9 +42,8 @@ export function awsAuthMiddleware<Input extends object, Output extends object>(
     };
 }
 
-export const awsAuthMiddlewareOptions: FinalizeRequestHandlerOptions & RelativeLocation<any, any> = {
+export const awsAuthMiddlewareOptions: RelativeMiddlewareOptions = {
   name: "awsAuthMiddleware",
-  step: "finalizeRequest",
   tags: ["SIGNATURE", "AWSAUTH"],
   relation: "after",
   toMiddleware: "retryMiddleware",