chore: use booleanSelector

Author: trivikr

packages/middleware-bucket-endpoint/package.json

@@ -19,13 +19,13 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@aws-sdk/protocol-http": "3.38.0",
+    "@aws-sdk/node-config-provider": "3.38.0",
     "@aws-sdk/types": "3.38.0",
     "@aws-sdk/util-arn-parser": "3.37.0",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
     "@aws-sdk/middleware-stack": "3.38.0",
-    "@aws-sdk/node-config-provider": "3.38.0",
     "@types/jest": "^26.0.4",
     "jest": "^26.1.0",
     "typescript": "~4.3.5"

packages/middleware-bucket-endpoint/src/NodeUseArnRegionConfigOptions.spec.ts

@@ -1,69 +1,50 @@
+import { booleanSelector, SelectorType } from "@aws-sdk/node-config-provider";
+
 import {
-  NODE_USE_ARN_REGION_CONFIG_OPTIONS as loadOptions,
+  NODE_USE_ARN_REGION_CONFIG_OPTIONS,
   NODE_USE_ARN_REGION_ENV_NAME,
   NODE_USE_ARN_REGION_INI_NAME,
 } from "./NodeUseArnRegionConfigOptions";
 
-describe("Node useArnRegion config loader", () => {
-  describe("environment variable selector", () => {
-    const env: { [NODE_USE_ARN_REGION_ENV_NAME]: any } = {} as any;
+jest.mock("@aws-sdk/node-config-provider");
 
-    beforeEach(() => {
-      delete env[NODE_USE_ARN_REGION_ENV_NAME];
-    });
+describe("NODE_USE_ARN_REGION_CONFIG_OPTIONS", () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
 
-    it(`should return undefined if the environment variable doesn't have ${NODE_USE_ARN_REGION_ENV_NAME}`, () => {
-      expect(loadOptions.environmentVariableSelector(env)).toBeUndefined();
+  const test = (func: Function, obj: { [key: string]: string }, key: string, type: SelectorType) => {
+    it.each([true, false, undefined])("returns %s", (output) => {
+      (booleanSelector as jest.Mock).mockReturnValueOnce(output);
+      expect(func(obj)).toEqual(output);
+      expect(booleanSelector).toBeCalledWith(obj, key, type);
     });
 
-    [
-      { envValue: "true", parsed: true },
-      { envValue: "false", parsed: false },
-    ].forEach(({ envValue, parsed }) => {
-      it(`should return boolean if the environment variable ${NODE_USE_ARN_REGION_ENV_NAME} is ${envValue}`, () => {
-        env[NODE_USE_ARN_REGION_ENV_NAME] = envValue;
-        expect(loadOptions.environmentVariableSelector(env)).toBe(parsed);
+    it("throws error", () => {
+      const mockError = new Error("error");
+      (booleanSelector as jest.Mock).mockImplementationOnce(() => {
+        throw mockError;
       });
+      expect(() => {
+        func(obj);
+      }).toThrow(mockError);
     });
+  };
 
-    ["0", "1", "yes", "no", undefined, null, void 0, ""].forEach((envValue) => {
-      it(`should throw if the environment variable ${NODE_USE_ARN_REGION_ENV_NAME} is ${envValue}`, () => {
-        env[NODE_USE_ARN_REGION_ENV_NAME] = envValue as any;
-        expect(() => loadOptions.environmentVariableSelector(env)).toThrow(
-          `Cannot load env ${NODE_USE_ARN_REGION_ENV_NAME}. Expected "true" or "false", got ${envValue}.`
-        );
-      });
-    });
+  describe("calls booleanSelector for environmentVariableSelector", () => {
+    const env: { [NODE_USE_ARN_REGION_ENV_NAME]: any } = {} as any;
+    const { environmentVariableSelector } = NODE_USE_ARN_REGION_CONFIG_OPTIONS;
+    test(environmentVariableSelector, env, NODE_USE_ARN_REGION_ENV_NAME, SelectorType.ENV);
   });
 
-  describe("shared INI files selector", () => {
+  describe("calls booleanSelector for configFileSelector", () => {
     const profileContent: { [NODE_USE_ARN_REGION_INI_NAME]: any } = {} as any;
+    const { configFileSelector } = NODE_USE_ARN_REGION_CONFIG_OPTIONS;
+    test(configFileSelector, profileContent, NODE_USE_ARN_REGION_INI_NAME, SelectorType.CONFIG);
+  });
 
-    beforeEach(() => {
-      delete profileContent[NODE_USE_ARN_REGION_INI_NAME];
-    });
-
-    it(`should return undefined if shared config profile doesn't have ${NODE_USE_ARN_REGION_INI_NAME}`, () => {
-      expect(loadOptions.configFileSelector(profileContent)).toBeUndefined();
-    });
-
-    [
-      { value: "true", parsed: true },
-      { value: "false", parsed: false },
-    ].forEach(({ value, parsed }) => {
-      it(`should return boolean if the shared config profile ${NODE_USE_ARN_REGION_INI_NAME} is ${value}`, () => {
-        profileContent[NODE_USE_ARN_REGION_INI_NAME] = value;
-        expect(loadOptions.configFileSelector(profileContent)).toBe(parsed);
-      });
-    });
-
-    ["0", "1", "yes", "no", undefined, null, void 0, ""].forEach((value) => {
-      it(`should throw if the shared config profile ${NODE_USE_ARN_REGION_INI_NAME} is ${value}`, () => {
-        profileContent[NODE_USE_ARN_REGION_INI_NAME] = value as any;
-        expect(() => loadOptions.configFileSelector(profileContent)).toThrow(
-          `Cannot load shared config entry ${NODE_USE_ARN_REGION_INI_NAME}. Expected "true" or "false", got ${value}.`
-        );
-      });
-    });
+  it("returns false for default", () => {
+    const { default: defaultValue } = NODE_USE_ARN_REGION_CONFIG_OPTIONS;
+    expect(defaultValue).toEqual(false);
   });
 });

packages/middleware-bucket-endpoint/src/NodeUseArnRegionConfigOptions.ts

@@ -1,4 +1,5 @@
 import { LoadedConfigSelectors } from "@aws-sdk/node-config-provider";
+import { booleanSelector, SelectorType } from "@aws-sdk/node-config-provider";
 
 export const NODE_USE_ARN_REGION_ENV_NAME = "AWS_S3_USE_ARN_REGION";
 export const NODE_USE_ARN_REGION_INI_NAME = "s3_use_arn_region";
@@ -9,21 +10,8 @@ export const NODE_USE_ARN_REGION_INI_NAME = "s3_use_arn_region";
  * @api private
  */
 export const NODE_USE_ARN_REGION_CONFIG_OPTIONS: LoadedConfigSelectors<boolean> = {
-  environmentVariableSelector: (env: NodeJS.ProcessEnv) => {
-    if (!Object.prototype.hasOwnProperty.call(env, NODE_USE_ARN_REGION_ENV_NAME)) return undefined;
-    if (env[NODE_USE_ARN_REGION_ENV_NAME] === "true") return true;
-    if (env[NODE_USE_ARN_REGION_ENV_NAME] === "false") return false;
-    throw new Error(
-      `Cannot load env ${NODE_USE_ARN_REGION_ENV_NAME}. Expected "true" or "false", got ${env[NODE_USE_ARN_REGION_ENV_NAME]}.`
-    );
-  },
-  configFileSelector: (profile) => {
-    if (!Object.prototype.hasOwnProperty.call(profile, NODE_USE_ARN_REGION_INI_NAME)) return undefined;
-    if (profile[NODE_USE_ARN_REGION_INI_NAME] === "true") return true;
-    if (profile[NODE_USE_ARN_REGION_INI_NAME] === "false") return false;
-    throw new Error(
-      `Cannot load shared config entry ${NODE_USE_ARN_REGION_INI_NAME}. Expected "true" or "false", got ${profile[NODE_USE_ARN_REGION_INI_NAME]}.`
-    );
-  },
+  environmentVariableSelector: (env: NodeJS.ProcessEnv) =>
+    booleanSelector(env, NODE_USE_ARN_REGION_ENV_NAME, SelectorType.ENV),
+  configFileSelector: (profile) => booleanSelector(profile, NODE_USE_ARN_REGION_INI_NAME, SelectorType.CONFIG),
   default: false,
 };