chore(core): add Auth Scheme Preference config selector (#7037)

Author: trivikr

packages/core/src/submodules/httpAuthSchemes/aws_sdk/NODE_AUTH_SCHEME_PREFERENCE_OPTIONS.spec.ts

@@ -0,0 +1,45 @@
+import { afterEach, describe, expect, test as it, vi } from "vitest";
+
+import { getArrayForCommaSeparatedString } from "../utils/getArrayForCommaSeparatedString";
+import { NODE_AUTH_SCHEME_PREFERENCE_OPTIONS } from "./NODE_AUTH_SCHEME_PREFERENCE_OPTIONS";
+
+vi.mock("../utils/getArrayForCommaSeparatedString");
+
+describe("NODE_AUTH_SCHEME_PREFERENCE_OPTIONS", () => {
+  const mockInput = "a,b,c";
+  const mockOutput = ["a", "b", "c"];
+
+  vi.mocked(getArrayForCommaSeparatedString).mockReturnValue(mockOutput);
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  const test = (func: Function, key: string) => {
+    it("returns undefined if no value is provided", () => {
+      expect(func({})).toEqual(undefined);
+      expect(getArrayForCommaSeparatedString).not.toBeCalled();
+    });
+
+    it("returns list if value is defined", () => {
+      expect(func({ [key]: mockInput })).toEqual(mockOutput);
+      expect(getArrayForCommaSeparatedString).toHaveBeenCalledTimes(1);
+      expect(getArrayForCommaSeparatedString).toBeCalledWith(mockInput);
+    });
+  };
+
+  describe("environmentVariableSelector", () => {
+    const { environmentVariableSelector } = NODE_AUTH_SCHEME_PREFERENCE_OPTIONS;
+    test(environmentVariableSelector, "AWS_AUTH_SCHEME_PREFERENCE");
+  });
+
+  describe("configFileSelector", () => {
+    const { configFileSelector } = NODE_AUTH_SCHEME_PREFERENCE_OPTIONS;
+    test(configFileSelector, "auth_scheme_preference");
+  });
+
+  it("returns false for default", () => {
+    const { default: defaultValue } = NODE_AUTH_SCHEME_PREFERENCE_OPTIONS;
+    expect(defaultValue).toEqual([]);
+  });
+});

packages/core/src/submodules/httpAuthSchemes/aws_sdk/NODE_AUTH_SCHEME_PREFERENCE_OPTIONS.ts

@@ -0,0 +1,36 @@
+import { LoadedConfigSelectors } from "@smithy/node-config-provider";
+
+import { getArrayForCommaSeparatedString } from "../utils/getArrayForCommaSeparatedString";
+
+const NODE_AUTH_SCHEME_PREFERENCE_ENV_KEY = "AWS_AUTH_SCHEME_PREFERENCE";
+const NODE_AUTH_SCHEME_PREFERENCE_CONFIG_KEY = "auth_scheme_preference";
+
+/**
+ * @public
+ */
+export const NODE_AUTH_SCHEME_PREFERENCE_OPTIONS: LoadedConfigSelectors<string[]> = {
+  /**
+   * Retrieves auth scheme preference from environment variables
+   * @param env - Node process environment object
+   * @returns Array of auth scheme strings if preference is set, undefined otherwise
+   */
+  environmentVariableSelector: (env: NodeJS.ProcessEnv) => {
+    if (!(NODE_AUTH_SCHEME_PREFERENCE_ENV_KEY in env)) return undefined;
+    return getArrayForCommaSeparatedString(env[NODE_AUTH_SCHEME_PREFERENCE_ENV_KEY] as string);
+  },
+
+  /**
+   * Retrieves auth scheme preference from config file
+   * @param profile - Config profile object
+   * @returns Array of auth scheme strings if preference is set, undefined otherwise
+   */
+  configFileSelector: (profile) => {
+    if (!(NODE_AUTH_SCHEME_PREFERENCE_CONFIG_KEY in profile)) return undefined;
+    return getArrayForCommaSeparatedString(profile[NODE_AUTH_SCHEME_PREFERENCE_CONFIG_KEY] as string);
+  },
+
+  /**
+   * Default auth scheme preference if not specified in environment or config
+   */
+  default: [],
+};

packages/core/src/submodules/httpAuthSchemes/aws_sdk/index.ts

@@ -1,4 +1,5 @@
 export { AwsSdkSigV4Signer, AWSSDKSigV4Signer, validateSigningProperties } from "./AwsSdkSigV4Signer";
 export { AwsSdkSigV4ASigner } from "./AwsSdkSigV4ASigner";
+export * from "./NODE_AUTH_SCHEME_PREFERENCE_OPTIONS";
 export * from "./resolveAwsSdkSigV4AConfig";
 export * from "./resolveAwsSdkSigV4Config";

packages/core/src/submodules/httpAuthSchemes/utils/getArrayForCommaSeparatedString.spec.ts

@@ -0,0 +1,26 @@
+import { describe, expect, it } from "vitest";
+
+import { getArrayForCommaSeparatedString } from "./getArrayForCommaSeparatedString";
+
+describe(getArrayForCommaSeparatedString.name, () => {
+  it("should return empty array for empty string", () => {
+    expect(getArrayForCommaSeparatedString("")).toEqual([]);
+  });
+
+  it("should return empty array for null/undefined input", () => {
+    expect(getArrayForCommaSeparatedString(null as unknown as string)).toEqual([]);
+    expect(getArrayForCommaSeparatedString(undefined as unknown as string)).toEqual([]);
+  });
+
+  it("should split comma separated string into array", () => {
+    expect(getArrayForCommaSeparatedString("a,b,c")).toEqual(["a", "b", "c"]);
+  });
+
+  it("should trim whitespace from array items", () => {
+    expect(getArrayForCommaSeparatedString(" a , b , c ")).toEqual(["a", "b", "c"]);
+  });
+
+  it("should handle single item", () => {
+    expect(getArrayForCommaSeparatedString("a")).toEqual(["a"]);
+  });
+});

packages/core/src/submodules/httpAuthSchemes/utils/getArrayForCommaSeparatedString.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts a comma-separated string into an array of trimmed strings
+ * @param str The comma-separated input string to split
+ * @returns Array of trimmed strings split from the input
+ *
+ * @internal
+ */
+export const getArrayForCommaSeparatedString = (str: string) =>
+  typeof str === "string" && str.length > 0 ? str.split(",").map((item) => item.trim()) : [];