feat(signature-v4): update EventSigner signature API to sign (#1016)

Author: trivikr

Diff for: packages/signature-v4/src/SignatureV4.spec.ts

@@ -608,7 +608,7 @@ describe("SignatureV4", () => {
     });
   });
 
-  describe("#signEvent", () => {
+  describe("#sign (event)", () => {
     //adopt to Ruby SDK: https://github.com/aws/aws-sdk-ruby/blob/3c47c05aa77bdbb7b803a3ff932b3a89c32276ac/gems/aws-sigv4/spec/signer_spec.rb#L274
     it("support event signing", async () => {
       const signer = new SignatureV4({
@@ -620,7 +620,7 @@ describe("SignatureV4", () => {
         },
         sha256: Sha256
       });
-      const eventSignature = await signer.signEvent(
+      const eventSignature = await signer.sign(
         {
           headers: Uint8Array.from([
             5,

Diff for: packages/signature-v4/src/SignatureV4.ts

@@ -189,59 +189,36 @@ export class SignatureV4
     return request;
   }
 
-  public sign(
+  public async sign(
     stringToSign: string,
     options?: SigningArguments
   ): Promise<string>;
-  public sign(
+  public async sign(
+    event: FormattedEvent,
+    options: EventSigningArguments
+  ): Promise<string>;
+  public async sign(
     requestToSign: HttpRequest,
     options?: RequestSigningArguments
   ): Promise<HttpRequest>;
-  public async sign<T extends string | HttpRequest>(
-    toSign: T,
-    {
-      signingDate = new Date(),
-      ...options
-    }: RequestSigningArguments | SigningArguments = {}
-  ): Promise<T> {
-    const [region, credentials] = await Promise.all([
-      this.regionProvider(),
-      this.credentialProvider()
-    ]);
-
+  public async sign(toSign: any, options: any): Promise<any> {
     if (typeof toSign === "string") {
-      return this.signString(
-        toSign,
-        signingDate,
-        region,
-        credentials
-      ) as Promise<T>;
+      return this.signString(toSign, options);
+    } else if (toSign.headers && toSign.payload) {
+      return this.signEvent(toSign, options);
     } else {
-      const {
-        unsignableHeaders,
-        signableHeaders
-      } = options as RequestSigningArguments;
-
-      return this.signRequest(
-        toSign as HttpRequest,
-        signingDate,
-        region,
-        credentials,
-        unsignableHeaders,
-        signableHeaders
-      ) as Promise<T>;
+      return this.signRequest(toSign, options);
     }
   }
 
-  public async signEvent(
+  private async signEvent(
     { headers, payload }: FormattedEvent,
-    options: EventSigningArguments
+    { signingDate = new Date(), priorSignature }: EventSigningArguments
   ): Promise<string> {
-    const [region, credentials] = await Promise.all([
+    const [region] = await Promise.all([
       this.regionProvider(),
       this.credentialProvider()
     ]);
-    const { signingDate = new Date(), priorSignature } = options;
     const { shortDate, longDate } = formatDate(signingDate);
     const scope = createScope(shortDate, region, this.service);
     const hashedPayload = await getPayloadHash(
@@ -259,15 +236,17 @@ export class SignatureV4
       hashedHeaders,
       hashedPayload
     ].join("\n");
-    return this.signString(stringToSign, signingDate, region, credentials);
+    return this.signString(stringToSign, { signingDate });
   }
 
   private async signString(
     stringToSign: string,
-    signingDate: DateInput,
-    region: string,
-    credentials: Credentials
+    { signingDate = new Date() }: SigningArguments = {}
   ): Promise<string> {
+    const [region, credentials] = await Promise.all([
+      this.regionProvider(),
+      this.credentialProvider()
+    ]);
     const { shortDate } = formatDate(signingDate);
 
     const hash = new this.sha256(
@@ -278,14 +257,18 @@ export class SignatureV4
   }
 
   private async signRequest(
-    originalRequest: HttpRequest,
-    signingDate: DateInput,
-    region: string,
-    credentials: Credentials,
-    unsignableHeaders?: Set<string>,
-    signableHeaders?: Set<string>
+    requestToSign: HttpRequest,
+    {
+      signingDate = new Date(),
+      signableHeaders,
+      unsignableHeaders
+    }: RequestSigningArguments = {}
   ): Promise<HttpRequest> {
-    const request = prepareRequest(originalRequest);
+    const [region, credentials] = await Promise.all([
+      this.regionProvider(),
+      this.credentialProvider()
+    ]);
+    const request = prepareRequest(requestToSign);
     const { longDate, shortDate } = formatDate(signingDate);
     const scope = createScope(shortDate, region, this.service);
 

Diff for: packages/types/src/signature.ts

@@ -35,7 +35,7 @@ export interface RequestSigningArguments extends SigningArguments {
   signableHeaders?: Set<string>;
 }
 
-export interface EventSigningArguments extends RequestSigningArguments {
+export interface EventSigningArguments extends SigningArguments {
   priorSignature: string;
 }
 
@@ -88,8 +88,5 @@ export interface EventSigner {
   /**
    * Sign the individual event of the event stream.
    */
-  signEvent(
-    event: FormattedEvent,
-    options: EventSigningArguments
-  ): Promise<string>;
+  sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
 }