test: resolveAuthSchemes.spec.ts

Author: trivikr

packages/core/src/middleware-http-auth-scheme/resolveAuthSchemes.spec.ts

@@ -0,0 +1,41 @@
+import { describe, it, expect } from "vitest";
+import { HttpAuthScheme } from "@smithy/types";
+import { resolveAuthSchemes } from "./resolveAuthSchemes";
+
+describe("resolveAuthSchemes", () => {
+  const sigv4 = "sigv4";
+  const sigv4a = "sigv4a";
+
+  const mockSigV4AuthScheme = { schemeId: `aws.auth#${sigv4}` } as HttpAuthScheme;
+  const mockSigV4aAuthScheme = { schemeId: `aws.auth#${sigv4a}` } as HttpAuthScheme;
+
+  it("should return candidate auth schemes is preference list is not available", () => {
+    const candidateAuthSchemes = [mockSigV4AuthScheme, mockSigV4aAuthScheme];
+    expect(resolveAuthSchemes(candidateAuthSchemes, [])).toEqual(candidateAuthSchemes);
+
+    // @ts-expect-error case where callee incorrectly passes undefined
+    expect(resolveAuthSchemes(candidateAuthSchemes)).toEqual(candidateAuthSchemes);
+  });
+
+  it("should return auth scheme from preference if it's available", () => {
+    expect(resolveAuthSchemes([mockSigV4AuthScheme, mockSigV4aAuthScheme], [sigv4a])).toEqual([
+      mockSigV4aAuthScheme,
+      mockSigV4AuthScheme,
+    ]);
+
+    expect(resolveAuthSchemes([mockSigV4AuthScheme, mockSigV4aAuthScheme], [sigv4a, sigv4])).toEqual([
+      mockSigV4aAuthScheme,
+      mockSigV4AuthScheme,
+    ]);
+
+    expect(resolveAuthSchemes([mockSigV4AuthScheme, mockSigV4aAuthScheme], [sigv4, sigv4a])).toEqual([
+      mockSigV4AuthScheme,
+      mockSigV4aAuthScheme,
+    ]);
+  });
+
+  it("should ignore auth scheme from preference if it's not available", () => {
+    expect(resolveAuthSchemes([mockSigV4AuthScheme], [sigv4a])).toEqual([mockSigV4AuthScheme]);
+    expect(resolveAuthSchemes([mockSigV4AuthScheme], ["sigv3"])).toEqual([mockSigV4AuthScheme]);
+  });
+});

packages/core/src/middleware-http-auth-scheme/resolveAuthSchemes.ts

@@ -10,25 +10,27 @@ import { HttpAuthScheme } from "@smithy/types";
  */
 export const resolveAuthSchemes = (candidateAuthSchemes: HttpAuthScheme[], authSchemePreference: string[]) => {
   if (!authSchemePreference || authSchemePreference.length === 0) {
-    // reprioritize candidates based on user's preference
-    const preferredAuthSchemes = [];
+    return candidateAuthSchemes;
+  }
 
-    for (const preferredSchemeName of authSchemePreference) {
-      for (const candidateAuthScheme of candidateAuthSchemes) {
-        const candidateAuthSchemeName = candidateAuthScheme.schemeId.split("#")[1];
-        if (candidateAuthSchemeName === preferredSchemeName) {
-          preferredAuthSchemes.push(candidateAuthScheme);
-        }
-      }
-    }
+  // reprioritize candidates based on user's preference
+  const preferredAuthSchemes = [];
 
-    // add any remaining candidates that weren't in the preference list
+  for (const preferredSchemeName of authSchemePreference) {
     for (const candidateAuthScheme of candidateAuthSchemes) {
-      if (!preferredAuthSchemes.find(({ schemeId }) => schemeId === candidateAuthScheme.schemeId)) {
+      const candidateAuthSchemeName = candidateAuthScheme.schemeId.split("#")[1];
+      if (candidateAuthSchemeName === preferredSchemeName) {
         preferredAuthSchemes.push(candidateAuthScheme);
       }
     }
-  } else {
-    return candidateAuthSchemes;
   }
+
+  // add any remaining candidates that weren't in the preference list
+  for (const candidateAuthScheme of candidateAuthSchemes) {
+    if (!preferredAuthSchemes.find(({ schemeId }) => schemeId === candidateAuthScheme.schemeId)) {
+      preferredAuthSchemes.push(candidateAuthScheme);
+    }
+  }
+
+  return preferredAuthSchemes;
 };