test(signature-v4-multi-region): move e2e tests out

Author: siddsriv

packages/signature-v4-multi-region/src/s3-mrap-sigv4a.e2e.spec.ts renamed to clients/client-s3/test/e2e/s3-mrap-sigv4a.e2e.spec.ts

@@ -1,3 +1,4 @@
+// requires a package.json update
 import "@smithy/signature-v4a";
 
 import { Sha256 } from "@aws-crypto/sha256-js";

packages/signature-v4-multi-region/package.json

@@ -10,8 +10,8 @@
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
     "test": "yarn g:vitest run",
-    "test:e2e": "vitest run --config vitest.config.e2e.js",
-    "test:browser": "vitest run --config vitest.config.browser.js",
+    "test:e2e": "yarn g:vitest run --config vitest.config.e2e.js",
+    "test:browser": "yarn g:vitest run --config vitest.config.browser.js",
     "test:watch": "yarn g:vitest watch"
   },
   "main": "./dist-cjs/index.js",
@@ -25,18 +25,17 @@
   "dependencies": {
     "@aws-sdk/middleware-sdk-s3": "*",
     "@aws-sdk/types": "*",
-    "@aws-sdk/signature-v4-crt": "*",
-    "@aws-sdk/client-s3": "*",
-    "@smithy/signature-v4a": "^3.0.0",
     "@smithy/protocol-http": "^5.1.0",
     "@smithy/signature-v4": "^5.0.2",
+    "@smithy/signature-v4a": "file:../../../smithy-typescript/packages/signature-v4a/package.tgz",
     "@smithy/types": "^4.2.0",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
     "@tsconfig/recommended": "1.0.1",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
+    "jsdom": "^26.0.0",
     "rimraf": "3.0.2",
     "typescript": "~5.2.2"
   },

packages/signature-v4-multi-region/src/SignatureV4MultiRegion.spec.ts

@@ -2,13 +2,12 @@ import { HttpRequest } from "@smithy/protocol-http";
 import { beforeEach, describe, expect, test as it, vi } from "vitest";
 
 vi.mock("@smithy/signature-v4");
+vi.mock("@smithy/signature-v4a");
 vi.mock("@aws-sdk/middleware-sdk-s3");
 vi.mock("@aws-sdk/signature-v4-crt");
-vi.mock("@smithy/signature-v4a");
 
 import { SignatureV4S3Express } from "@aws-sdk/middleware-sdk-s3";
 import { CrtSignerV4 } from "@aws-sdk/signature-v4-crt";
-import { SignatureV4 } from "@smithy/signature-v4";
 import { SignatureV4a } from "@smithy/signature-v4a";
 import { Checksum } from "@smithy/types";
 
@@ -48,38 +47,37 @@ describe("SignatureV4MultiRegion", () => {
 
   beforeEach(() => {
     signatureV4CrtContainer.CrtSignerV4 = CrtSignerV4 as any;
-    signatureV4aContainer.SignatureV4a = SignatureV4a as any;
     vi.clearAllMocks();
   });
 
   it("should sign with SigV4 signer", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.sign(minimalRequest);
-    expect(SignatureV4.prototype.sign).toBeCalledTimes(1);
+
+    //@ts-ignore
+    expect(SignatureV4S3Express.mock.instances[0].sign).toBeCalledTimes(1);
   });
 
   it("should presign with SigV4 signer", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.presign(minimalRequest);
-    expect(SignatureV4.prototype.presign).toBeCalledTimes(1);
+
+    //@ts-ignore
+    expect(SignatureV4S3Express.mock.instances[0].presign).toBeCalledTimes(1);
   });
 
   it("should sign with SigV4a signer if mult_region option is set", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.presign(minimalRequest, { signingRegion: "*" });
-    expect(CrtSignerV4.prototype.presign).toBeCalledTimes(1);
+    //@ts-ignore
+    expect(CrtSignerV4.mock.instances[0].presign).toBeCalledTimes(1);
   });
 
   it("should presign with SigV4 signer", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.presign(minimalRequest, { signingRegion: "*" });
-    expect(CrtSignerV4.prototype.presign).toBeCalledTimes(1);
-  });
-
-  it("should presign with SigV4a signer if signingRegion is '*'", async () => {
-    const signer = new SignatureV4MultiRegion(params);
-    await signer.presign(minimalRequest, { signingRegion: "*" });
-    expect(SignatureV4a.prototype.presign).toBeCalledTimes(1);
+    //@ts-ignore
+    expect(CrtSignerV4.mock.instances[0].presign).toBeCalledTimes(1);
   });
 
   it("should sign with SigV4a signer if signingRegion is '*'", async () => {
@@ -88,10 +86,12 @@ describe("SignatureV4MultiRegion", () => {
     expect(SignatureV4a.prototype.sign).toBeCalledTimes(1);
   });
 
-  it("should use CrtSignerV4 if available", async () => {
-    const signer = new SignatureV4MultiRegion(params);
-    await signer.sign(minimalRequest, { signingRegion: "*" });
-    expect(CrtSignerV4).toHaveBeenCalledTimes(1);
+  it("should throw if sign with SigV4a in unsupported runtime", async () => {
+    expect.assertions(1);
+    const signer = new SignatureV4MultiRegion({ ...params, runtime: "browser" });
+    await expect(async () => await signer.sign(minimalRequest, { signingRegion: "*" })).rejects.toThrow(
+      "This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js"
+    );
   });
 
   it("should use SignatureV4a if CrtSignerV4 is not available", async () => {
@@ -144,4 +144,18 @@ describe("SignatureV4MultiRegion", () => {
     await signer.sign(minimalRequest, { signingRegion: "*" });
     expect(SignatureV4a).toHaveBeenCalledTimes(1);
   });
+
+  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(
+      "\n" +
+        `Please check whether you have installed the "@aws-sdk/signature-v4-crt" package explicitly. \n` +
+        `You must also register the package by calling [require("@aws-sdk/signature-v4-crt");] ` +
+        `or an ESM equivalent such as [import "@aws-sdk/signature-v4-crt";]. \n` +
+        "For more information please go to " +
+        "https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt"
+    );
+  });
 });