feat: update according to new client interface

Author: AllanZhengYP

packages/s3-request-presigner/jest.config.js

@@ -0,0 +1,5 @@
+const base = require("../../jest.config.base.js");
+
+module.exports = {
+  ...base
+};

packages/s3-request-presigner/package.json

@@ -21,7 +21,8 @@
     "tslib": "^1.8.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3-node": "^0.1.0-preview.7",
+    "@aws-sdk/protocol-http": "^0.1.0-preview.1",
+    "@aws-sdk/hash-node": "^0.1.0-preview.8",
     "@types/jest": "^24.0.12",
     "@types/node": "^12.0.2",
     "jest": "^24.7.1",

packages/s3-request-presigner/src/index.spec.ts

@@ -1,6 +1,6 @@
-import { S3RequestPresigner } from "./index";
-import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3-node";
-import { HttpRequest } from "@aws-sdk/types";
+import { S3RequestPresigner, S3RequestPresignerOptions } from "./index";
+import { HttpRequest } from "@aws-sdk/protocol-http";
+import { Hash } from "@aws-sdk/hash-node";
 import {
   ALGORITHM_IDENTIFIER,
   SHA256_HEADER,
@@ -14,33 +14,33 @@ import {
 } from "./constants";
 
 describe("s3 presigner", () => {
-  const s3 = new S3Client({
+  const s3ResolvedConfig: S3RequestPresignerOptions = {
     credentials: {
       accessKeyId: "akid",
       secretAccessKey: "skey"
     },
-    region: "us-bar-1"
-  });
+    region: "us-bar-1",
+    sha256: Hash.bind(null, "sha256"),
+    signingName: "s3"
+  };
   const expiration = Math.floor(
     (new Date("2000-01-01T00:00:00.000Z").valueOf() + 60 * 60 * 1000) / 1000
   );
   const presigningOptions = {
     signingDate: new Date("2000-01-01T00:00:00.000Z")
   };
-  const minimalRequest: HttpRequest<any> = {
+  const minimalRequest = new HttpRequest({
     method: "GET",
     protocol: "https:",
     path: "/foo/bar/baz",
     headers: {
       host: "foo.s3.us-bar-1.amazonaws.com"
     },
     hostname: "foo.s3.us-bar-1.amazonaws.com"
-  };
+  });
 
   it("should not double uri encode the path", async () => {
-    const signer = new S3RequestPresigner({
-      ...s3.config
-    });
+    const signer = new S3RequestPresigner(s3ResolvedConfig);
     const signed = await signer.presignRequest(
       minimalRequest,
       expiration,
@@ -50,9 +50,7 @@ describe("s3 presigner", () => {
   });
 
   it("should set the body digest to 'UNSIGNED_PAYLOAD'", async () => {
-    const signer = new S3RequestPresigner({
-      ...s3.config
-    });
+    const signer = new S3RequestPresigner(s3ResolvedConfig);
     const signed = await signer.presignRequest(
       minimalRequest,
       expiration,
@@ -62,9 +60,7 @@ describe("s3 presigner", () => {
   });
 
   it("should not change original request", async () => {
-    const signer = new S3RequestPresigner({
-      ...s3.config
-    });
+    const signer = new S3RequestPresigner(s3ResolvedConfig);
     const originalRequest = { ...minimalRequest };
     const signed = await signer.presignRequest(
       minimalRequest,

packages/s3-request-presigner/src/index.ts

@@ -8,7 +8,7 @@ import {
   SignatureV4Init,
   SignatureV4CryptoInit
 } from "@aws-sdk/signature-v4";
-import { HttpRequest } from "@aws-sdk/types";
+import { HttpRequest as IHttpRequest } from "@aws-sdk/types";
 import { UNSIGNED_PAYLOAD, SHA256_HEADER } from "./constants";
 
 /**
@@ -18,28 +18,29 @@ import { UNSIGNED_PAYLOAD, SHA256_HEADER } from "./constants";
 type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
+export type S3RequestPresignerOptions = PartialBy<
+  SignatureV4Init & SignatureV4CryptoInit,
+  "service" | "uriEscapePath"
+> & { signingName?: string };
+
 export class S3RequestPresigner implements RequestPresigner {
   private readonly signer: SignatureV4;
-  constructor({
-    service = "s3",
-    uriEscapePath = false,
-    ...rest
-  }: PartialBy<
-    SignatureV4Init & SignatureV4CryptoInit,
-    "service" | "uriEscapePath"
-  >) {
-    this.signer = new SignatureV4({
-      uriEscapePath,
-      service,
-      ...rest
-    });
+  constructor(options: S3RequestPresignerOptions) {
+    const resolvedOptions = {
+      // Allow `signingName` because we want to support usecase of supply client's resolved config
+      // directly. Where service equals signingName.
+      service: options.signingName || options.service || "s3",
+      uriEscapePath: options.uriEscapePath || false,
+      ...options
+    };
+    this.signer = new SignatureV4(resolvedOptions);
   }
 
-  public async presignRequest<StreamType>(
-    requestToSign: HttpRequest<StreamType>,
+  public async presignRequest(
+    requestToSign: IHttpRequest,
     expiration: DateInput,
     options?: RequestSigningArguments
-  ): Promise<HttpRequest<StreamType>> {
+  ): Promise<IHttpRequest> {
     requestToSign.headers[SHA256_HEADER] = UNSIGNED_PAYLOAD;
     return this.signer.presignRequest(requestToSign, expiration, options);
   }