fix(signature-v4-multi-region): avoid require call on optional depend…

…ency
aws · Sep 13, 2023 · 5f405f0 · 5f405f0
1 parent 91e51ab
commit 5f405f0
Show file tree

Hide file tree

Showing 9 changed files with 86 additions and 16 deletions.
diff --git a/packages/signature-v4-crt/package.json b/packages/signature-v4-crt/package.json
@@ -22,6 +22,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
+    "@aws-sdk/signature-v4-multi-region": "*",
     "@smithy/querystring-parser": "^2.0.0",
     "@smithy/signature-v4": "^2.0.0",
     "@smithy/util-middleware": "^2.0.0",

diff --git a/packages/signature-v4-crt/src/index.ts b/packages/signature-v4-crt/src/index.ts
@@ -1 +1,7 @@
+import { signatureV4CrtContainer } from "@aws-sdk/signature-v4-multi-region";
+
+import { CrtSignerV4 } from "./CrtSignerV4";
+
+signatureV4CrtContainer.CrtSignerV4 = CrtSignerV4;
+
 export * from "./CrtSignerV4";
diff --git a/packages/signature-v4-multi-region/package.json b/packages/signature-v4-multi-region/package.json
@@ -15,10 +15,10 @@
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
   "browser": {
-    "@aws-sdk/signature-v4-crt": false
+    "./dist-es/load-crt.node": "./dist-es/load-crt.browser"
   },
   "react-native": {
-    "@aws-sdk/signature-v4-crt": false
+    "./dist-es/load-crt.node": "./dist-es/load-crt.browser"
   },
   "author": {
     "name": "AWS SDK for JavaScript Team",
@@ -33,22 +33,13 @@
     "tslib": "^2.5.0"
   },
   "devDependencies": {
-    "@aws-sdk/signature-v4-crt": "*",
     "@tsconfig/recommended": "1.0.1",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
     "typedoc": "0.23.23",
     "typescript": "~4.9.5"
   },
-  "peerDependencies": {
-    "@aws-sdk/signature-v4-crt": "^3.118.0"
-  },
-  "peerDependenciesMeta": {
-    "@aws-sdk/signature-v4-crt": {
-      "optional": true
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/packages/signature-v4-multi-region/src/SignatureV4MultiRegion.spec.ts b/packages/signature-v4-multi-region/src/SignatureV4MultiRegion.spec.ts
@@ -7,6 +7,7 @@ jest.mock("@aws-sdk/signature-v4-crt");
 import { CrtSignerV4 } from "@aws-sdk/signature-v4-crt";
 import { SignatureV4 } from "@smithy/signature-v4";
 
+import { signatureV4CrtContainer } from "./signature-v4-crt-container";
 import { SignatureV4MultiRegion, SignatureV4MultiRegionInit } from "./SignatureV4MultiRegion";
 
 describe("SignatureV4MultiRegion", () => {
@@ -26,6 +27,7 @@ describe("SignatureV4MultiRegion", () => {
   });
 
   beforeEach(() => {
+    signatureV4CrtContainer.CrtSignerV4 = CrtSignerV4 as any;
     jest.clearAllMocks();
   });
 
@@ -72,4 +74,15 @@ describe("SignatureV4MultiRegion", () => {
       "This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js"
     );
   });
+
+  it("should throw if sign with SigV4a and signature-v4-crt is not installed", async () => {
+    signatureV4CrtContainer.CrtSignerV4 = null;
+    expect.assertions(1);
+    const signer = new SignatureV4MultiRegion({ ...params });
+    await expect(async () => await signer.sign(minimalRequest, { signingRegion: "*" })).rejects.toThrow(
+      `\nPlease check if you have installed "@aws-sdk/signature-v4-crt" package explicitly. \n` +
+        "For more information please go to " +
+        "https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt"
+    );
+  });
 });
diff --git a/packages/signature-v4-multi-region/src/SignatureV4MultiRegion.ts b/packages/signature-v4-multi-region/src/SignatureV4MultiRegion.ts
@@ -1,4 +1,3 @@
-import type { CrtSignerV4, CrtSignerV4Init } from "@aws-sdk/signature-v4-crt";
 import { SignatureV4, SignatureV4CryptoInit, SignatureV4Init } from "@smithy/signature-v4";
 import {
   HttpRequest,
@@ -8,6 +7,9 @@ import {
   RequestSigningArguments,
 } from "@smithy/types";
 
+import { loadCrt } from "./load-crt.node";
+import { OptionalCrtSignerV4, signatureV4CrtContainer } from "./signature-v4-crt-container";
+
 /**
  * @internal
  */
@@ -26,7 +28,7 @@ export type SignatureV4MultiRegionInit = SignatureV4Init &
  */
 export class SignatureV4MultiRegion implements RequestPresigner, RequestSigner {
   private readonly sigv4Signer: SignatureV4;
-  private sigv4aSigner?: CrtSignerV4;
+  private sigv4aSigner?: InstanceType<OptionalCrtSignerV4>;
   private readonly signerOptions: SignatureV4MultiRegionInit;
 
   constructor(options: SignatureV4MultiRegionInit) {
@@ -52,11 +54,13 @@ export class SignatureV4MultiRegion implements RequestPresigner, RequestSigner {
     return this.sigv4Signer.presign(originalRequest, options);
   }
 
-  private getSigv4aSigner(): CrtSignerV4 {
+  private getSigv4aSigner(): InstanceType<OptionalCrtSignerV4> {
     if (!this.sigv4aSigner) {
-      let CrtSignerV4: new (options: CrtSignerV4Init & SignatureV4CryptoInit) => CrtSignerV4;
+      let CrtSignerV4: OptionalCrtSignerV4 | null = null;
+
       try {
-        CrtSignerV4 = typeof require === "function" && require("@aws-sdk/signature-v4-crt").CrtSignerV4;
+        loadCrt();
+        CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
         if (typeof CrtSignerV4 !== "function") throw new Error();
       } catch (e) {
         e.message =
@@ -65,6 +69,7 @@ export class SignatureV4MultiRegion implements RequestPresigner, RequestSigner {
           "https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt";
         throw e;
       }
+
       this.sigv4aSigner = new CrtSignerV4({
         ...this.signerOptions,
         signingAlgorithm: 1,

diff --git a/packages/signature-v4-multi-region/src/index.ts b/packages/signature-v4-multi-region/src/index.ts
@@ -2,3 +2,4 @@
  * @internal
  */
 export * from "./SignatureV4MultiRegion";
+export * from "./signature-v4-crt-container";
diff --git a/packages/signature-v4-multi-region/src/load-crt.browser.ts b/packages/signature-v4-multi-region/src/load-crt.browser.ts
@@ -0,0 +1,4 @@
+/**
+ * @internal
+ */
+export function loadCrt(): void {}
diff --git a/packages/signature-v4-multi-region/src/load-crt.node.ts b/packages/signature-v4-multi-region/src/load-crt.node.ts
@@ -0,0 +1,20 @@
+import { signatureV4CrtContainer } from "./signature-v4-crt-container";
+
+/**
+ * @internal
+ */
+export function loadCrt(): void {
+  if (signatureV4CrtContainer.CrtSignerV4) {
+    return;
+  }
+  try {
+    if (typeof require === "function") {
+      // add some indirection to avoid static analysis.
+      const __require = require;
+      const moduleName = "@aws-sdk/signature-v4-crt";
+      __require.call(null, moduleName);
+    }
+  } catch (e) {
+    // ignored.
+  }
+}
diff --git a/packages/signature-v4-multi-region/src/signature-v4-crt-container.ts b/packages/signature-v4-multi-region/src/signature-v4-crt-container.ts
@@ -0,0 +1,29 @@
+import type { RequestPresigner, RequestSigner } from "@smithy/types";
+
+/**
+ * @public
+ */
+export type OptionalCrtSignerV4 = {
+  /**
+   * This constructor is not typed so as not to require a type import
+   * from the signature-v4-crt package.
+   *
+   * The true type is CrtSignerV4 from \@aws-sdk/signature-v4-crt.
+   */
+  new (options: any): RequestPresigner & RequestSigner;
+};
+
+/**
+ * @public
+ *
+ * \@aws-sdk/signature-v4-crt will install the constructor in this
+ * container if it is installed.
+ *
+ * This avoids a runtime-require being interpreted statically by bundlers.
+ *
+ */
+export const signatureV4CrtContainer: {
+  CrtSignerV4: null | OptionalCrtSignerV4;
+} = {
+  CrtSignerV4: null,
+};