Merge pull request #44 from jeskew/fix/v4-signer-tweaks

Widen region option in SignatureV4 ctor to accept a region provider and move credentials to be a ctor argument

Author: jeskew

packages/signature-v4/__tests__/SignatureV4.ts

@@ -25,7 +25,11 @@ const MockDate = () => new Date("2000-01-01T00:00:00.000Z");
 const signer = new SignatureV4({
   service: "foo",
   region: "us-bar-1",
-  sha256: Sha256
+  sha256: Sha256,
+  credentials: {
+    accessKeyId: "foo",
+    secretAccessKey: "bar"
+  }
 });
 
 const minimalRequest: HttpRequest<any> = {
@@ -52,7 +56,6 @@ describe("SignatureV4", () => {
     it("should sign requests without bodies", async () => {
       const { query } = await signer.presignRequest({
         request: minimalRequest,
-        credentials,
         expiration,
         currentDateConstructor: MockDate as any
       });
@@ -73,7 +76,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           body: "It was the best of times, it was the worst of times"
         },
-        credentials,
         expiration,
         currentDateConstructor: MockDate as any
       });
@@ -94,7 +96,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           body: new Uint8Array([0xde, 0xad, 0xbe, 0xef])
         },
-        credentials,
         expiration,
         currentDateConstructor: MockDate as any
       });
@@ -115,7 +116,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           body: new PassThrough()
         },
-        credentials,
         expiration,
         currentDateConstructor: MockDate as any
       });
@@ -131,12 +131,17 @@ describe("SignatureV4", () => {
     });
 
     it(`should set and sign the ${TOKEN_QUERY_PARAM} query parameter if the credentials have a session token`, async () => {
-      const { query } = await signer.presignRequest({
-        request: minimalRequest,
+      const signer = new SignatureV4({
+        service: "foo",
+        region: "us-bar-1",
+        sha256: Sha256,
         credentials: {
           ...credentials,
           sessionToken: "baz"
-        },
+        }
+      });
+      const { query } = await signer.presignRequest({
+        request: minimalRequest,
         expiration,
         currentDateConstructor: MockDate as any
       });
@@ -158,15 +163,15 @@ describe("SignatureV4", () => {
         service: "foo",
         region: "us-bar-1",
         sha256: Sha256,
-        unsignedPayload: true
+        unsignedPayload: true,
+        credentials
       });
 
       const { query } = await signer.presignRequest({
         request: {
           ...minimalRequest,
           body: new Uint8Array([0xde, 0xad, 0xbe, 0xef])
         },
-        credentials,
         expiration,
         currentDateConstructor: MockDate as any
       });
@@ -196,7 +201,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           headers
         },
-        credentials,
         expiration,
         hoistHeaders: false,
         currentDateConstructor: MockDate as any
@@ -225,7 +229,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           headers
         },
-        credentials,
         expiration,
         hoistHeaders: false,
         currentDateConstructor: MockDate as any,
@@ -245,7 +248,6 @@ describe("SignatureV4", () => {
             [EXPIRES_QUERY_PARAM]: "1 week"
           }
         },
-        credentials,
         expiration,
         hoistHeaders: false,
         currentDateConstructor: MockDate as any
@@ -257,7 +259,6 @@ describe("SignatureV4", () => {
       return expect(
         signer.presignRequest({
           request: minimalRequest,
-          credentials,
           expiration: new Date(),
           currentDateConstructor: MockDate as any
         })
@@ -267,7 +268,6 @@ describe("SignatureV4", () => {
     it("should use the current date if no constructor supplied", async () => {
       const { query } = await signer.presignRequest({
         request: minimalRequest,
-        credentials,
         expiration: Math.floor((Date.now() + 60 * 60 * 1000) / 1000)
       });
       expect((query as any)[AMZ_DATE_QUERY_PARAM]).toBe(
@@ -280,7 +280,6 @@ describe("SignatureV4", () => {
     it("should sign requests without bodies", async () => {
       const { headers } = await signer.signRequest({
         request: minimalRequest,
-        credentials,
         currentDateConstructor: MockDate as any
       });
       expect(headers[AUTH_HEADER]).toBe(
@@ -294,7 +293,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           body: "It was the best of times, it was the worst of times"
         },
-        credentials,
         currentDateConstructor: MockDate as any
       });
       expect(headers[AUTH_HEADER]).toBe(
@@ -308,7 +306,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           body: new Uint8Array([0xde, 0xad, 0xbe, 0xef])
         },
-        credentials,
         currentDateConstructor: MockDate as any
       });
       expect(headers[AUTH_HEADER]).toBe(
@@ -322,7 +319,6 @@ describe("SignatureV4", () => {
           ...minimalRequest,
           body: new PassThrough()
         },
-        credentials,
         currentDateConstructor: MockDate as any
       });
 
@@ -335,19 +331,23 @@ describe("SignatureV4", () => {
     it(`should set the ${AMZ_DATE_HEADER}`, async () => {
       const { headers } = await signer.signRequest({
         request: minimalRequest,
-        credentials,
         currentDateConstructor: MockDate as any
       });
       expect(headers[AMZ_DATE_HEADER]).toBe("20000101T000000Z");
     });
 
     it(`should set and sign the ${TOKEN_HEADER} header if the credentials have a session token`, async () => {
-      const { headers } = await signer.signRequest({
-        request: minimalRequest,
+      const signer = new SignatureV4({
+        service: "foo",
+        region: "us-bar-1",
+        sha256: Sha256,
         credentials: {
           ...credentials,
           sessionToken: "baz"
-        },
+        }
+      });
+      const { headers } = await signer.signRequest({
+        request: minimalRequest,
         currentDateConstructor: MockDate as any
       });
       expect(headers[AUTH_HEADER]).toBe(
@@ -360,15 +360,15 @@ describe("SignatureV4", () => {
         service: "foo",
         region: "us-bar-1",
         sha256: Sha256,
-        unsignedPayload: true
+        unsignedPayload: true,
+        credentials
       });
 
       const { headers } = await signer.signRequest({
         request: {
           ...minimalRequest,
           body: new Uint8Array([0xde, 0xad, 0xbe, 0xef])
         },
-        credentials,
         currentDateConstructor: MockDate as any
       });
       expect(headers[AUTH_HEADER]).toBe(
@@ -379,8 +379,7 @@ describe("SignatureV4", () => {
 
     it("should use the current date if no constructor supplied", async () => {
       const { headers } = await signer.signRequest({
-        request: minimalRequest,
-        credentials
+        request: minimalRequest
       });
       expect(headers[AMZ_DATE_HEADER]).toBe(
         iso8601(new Date()).replace(/[\-:]/g, "")
@@ -397,7 +396,6 @@ describe("SignatureV4", () => {
             "user-agent": "baz"
           }
         },
-        credentials,
         currentDateConstructor: MockDate as any,
         unsignableHeaders: { foo: true }
       });