chore(config-resolver): add region validation cache (#1750)

* chore(config-resolver): add region validation cache

* formatting

Author: kuhe

.changeset/cold-dolls-applaud.md

@@ -0,0 +1,5 @@
+---
+"@smithy/config-resolver": minor
+---
+
+validate region is hostname component

packages/config-resolver/package.json

@@ -28,6 +28,7 @@
     "@smithy/node-config-provider": "workspace:^",
     "@smithy/types": "workspace:^",
     "@smithy/util-config-provider": "workspace:^",
+    "@smithy/util-endpoints": "workspace:^",
     "@smithy/util-middleware": "workspace:^",
     "tslib": "^2.6.2"
   },

packages/config-resolver/src/regionConfig/checkRegion.spec.ts

@@ -0,0 +1,77 @@
+import { isValidHostLabel } from "@smithy/util-endpoints";
+import { describe, expect, test as it, vi } from "vitest";
+
+import { checkRegion } from "./checkRegion";
+
+describe("checkRegion", () => {
+  const acceptedRegionExamples = [
+    "us-east-1",
+    "ap-east-1",
+    "ap-southeast-4",
+    "ap-northeast-3",
+    "ap-northeast-1",
+    "eu-west-2",
+    "il-central-1",
+    "mx-central-1",
+    "eu-isoe-santaclaus-125",
+    "us-iso-reindeer-3000",
+    "eusc-de-gingerbread-8000",
+    "abcd",
+    "12345",
+  ];
+
+  it("does not throw when the region is a valid host label", () => {
+    for (const region of acceptedRegionExamples) {
+      expect(() => checkRegion(region)).not.toThrow();
+    }
+  });
+
+  it("throws when the region is not a valid host label", () => {
+    for (const region of [
+      "us-east-1-",
+      "a".repeat(64),
+      "-us-east-1",
+      "",
+      "!",
+      "@",
+      "#",
+      "$",
+      "%",
+      "^",
+      "&",
+      "*",
+      "(",
+      ")",
+      ".",
+      "[",
+      "]",
+      ";",
+      `'`,
+      "?",
+      "/",
+      "\\",
+      "|",
+      "+-*/",
+    ]) {
+      expect(() => checkRegion(region)).toThrow(
+        `Region not accepted: region="${region}" is not a valid hostname component.`
+      );
+    }
+  });
+
+  it("caches accepted regions", () => {
+    const di = {
+      isValidHostLabel,
+    };
+    for (const region of acceptedRegionExamples) {
+      expect(() => checkRegion(region, di.isValidHostLabel)).not.toThrow();
+    }
+    vi.spyOn(di, "isValidHostLabel").mockImplementation(isValidHostLabel);
+    for (const region of acceptedRegionExamples) {
+      expect(() => checkRegion(region, di.isValidHostLabel)).not.toThrow();
+    }
+    expect(di.isValidHostLabel).toHaveBeenCalledTimes(0);
+    expect(() => checkRegion("oh-canada", di.isValidHostLabel)).not.toThrow();
+    expect(di.isValidHostLabel).toHaveBeenCalledTimes(1);
+  });
+});

packages/config-resolver/src/regionConfig/checkRegion.ts

@@ -0,0 +1,22 @@
+import { isValidHostLabel } from "@smithy/util-endpoints";
+
+/**
+ * @internal
+ */
+const validRegions = new Set<string>();
+
+/**
+ * Checks whether region can be a host component.
+ *
+ * @param region - to check.
+ * @param check - checking function.
+ *
+ * @internal
+ */
+export const checkRegion = (region: string, check = isValidHostLabel) => {
+  if (!validRegions.has(region) && !check(region)) {
+    throw new Error(`Region not accepted: region="${region}" is not a valid hostname component.`);
+  } else {
+    validRegions.add(region);
+  }
+};

packages/config-resolver/src/regionConfig/resolveRegionConfig.ts

@@ -1,5 +1,6 @@
 import type { Provider } from "@smithy/types";
 
+import { checkRegion } from "./checkRegion";
 import { getRealRegion } from "./getRealRegion";
 import { isFipsRegion } from "./isFipsRegion";
 
@@ -47,11 +48,10 @@ export const resolveRegionConfig = <T>(input: T & RegionInputConfig & Previously
 
   return Object.assign(input, {
     region: async () => {
-      if (typeof region === "string") {
-        return getRealRegion(region);
-      }
-      const providedRegion = await region();
-      return getRealRegion(providedRegion);
+      const providedRegion = typeof region === "function" ? await region() : region;
+      const realRegion = getRealRegion(providedRegion);
+      checkRegion(realRegion);
+      return realRegion;
     },
     useFipsEndpoint: async () => {
       const providedRegion = typeof region === "string" ? region : await region();

packages/util-endpoints/src/lib/isValidHostLabel.spec.ts

@@ -32,7 +32,7 @@ describe(isValidHostLabel.name, () => {
       expect(isValidHostLabel(hostLabelToTest, true)).toBe(output);
     });
 
-    describe("returns false is any subdomain is invalid", () => {
+    describe("returns false if any subdomain is invalid", () => {
       const validHostLabel = testCases
         .filter(([outputEntry]) => outputEntry === true)
         .map(([, value]) => value)

yarn.lock

@@ -2514,6 +2514,7 @@ __metadata:
     "@smithy/node-config-provider": "workspace:^"
     "@smithy/types": "workspace:^"
     "@smithy/util-config-provider": "workspace:^"
+    "@smithy/util-endpoints": "workspace:^"
     "@smithy/util-middleware": "workspace:^"
     concurrently: "npm:7.0.0"
     downlevel-dts: "npm:0.10.1"