From ce7fd355e18c75befbd1b4cdaf654d247e0cf563 Mon Sep 17 00:00:00 2001 From: AndrewFossAWS Date: Wed, 30 Aug 2023 13:32:35 -0700 Subject: [PATCH] feat(region-config-provider): add region-config-provider package --- packages/region-config-resolver/CHANGELOG.md | 0 packages/region-config-resolver/LICENSE | 201 ++++++++++++++++++ packages/region-config-resolver/README.md | 12 ++ .../region-config-resolver/jest.config.js | 5 + packages/region-config-resolver/package.json | 62 ++++++ .../src/extensions/index.ts | 37 ++++ packages/region-config-resolver/src/index.ts | 9 + .../src/regionConfig/config.spec.ts | 38 ++++ .../src/regionConfig/config.ts | 28 +++ .../src/regionConfig/getRealRegion.spec.ts | 36 ++++ .../src/regionConfig/getRealRegion.ts | 11 + .../src/regionConfig/index.ts | 8 + .../src/regionConfig/isFipsRegion.spec.ts | 15 ++ .../src/regionConfig/isFipsRegion.ts | 5 + .../regionConfig/resolveRegionConfig.spec.ts | 93 ++++++++ .../src/regionConfig/resolveRegionConfig.ts | 68 ++++++ .../region-config-resolver/tsconfig.cjs.json | 9 + .../region-config-resolver/tsconfig.es.json | 10 + .../tsconfig.types.json | 9 + packages/types/src/extensions/index.ts | 9 + packages/types/src/index.ts | 1 + 21 files changed, 666 insertions(+) create mode 100644 packages/region-config-resolver/CHANGELOG.md create mode 100644 packages/region-config-resolver/LICENSE create mode 100644 packages/region-config-resolver/README.md create mode 100644 packages/region-config-resolver/jest.config.js create mode 100644 packages/region-config-resolver/package.json create mode 100644 packages/region-config-resolver/src/extensions/index.ts create mode 100644 packages/region-config-resolver/src/index.ts create mode 100644 packages/region-config-resolver/src/regionConfig/config.spec.ts create mode 100644 packages/region-config-resolver/src/regionConfig/config.ts create mode 100644 packages/region-config-resolver/src/regionConfig/getRealRegion.spec.ts create mode 100644 packages/region-config-resolver/src/regionConfig/getRealRegion.ts create mode 100644 packages/region-config-resolver/src/regionConfig/index.ts create mode 100644 packages/region-config-resolver/src/regionConfig/isFipsRegion.spec.ts create mode 100644 packages/region-config-resolver/src/regionConfig/isFipsRegion.ts create mode 100644 packages/region-config-resolver/src/regionConfig/resolveRegionConfig.spec.ts create mode 100644 packages/region-config-resolver/src/regionConfig/resolveRegionConfig.ts create mode 100644 packages/region-config-resolver/tsconfig.cjs.json create mode 100644 packages/region-config-resolver/tsconfig.es.json create mode 100644 packages/region-config-resolver/tsconfig.types.json create mode 100644 packages/types/src/extensions/index.ts diff --git a/packages/region-config-resolver/CHANGELOG.md b/packages/region-config-resolver/CHANGELOG.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/packages/region-config-resolver/LICENSE b/packages/region-config-resolver/LICENSE new file mode 100644 index 0000000000000..7b6491ba78762 --- /dev/null +++ b/packages/region-config-resolver/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/packages/region-config-resolver/README.md b/packages/region-config-resolver/README.md new file mode 100644 index 0000000000000..389b765532247 --- /dev/null +++ b/packages/region-config-resolver/README.md @@ -0,0 +1,12 @@ +# @aws-sdk/region-config-resolver + +[![NPM version](https://img.shields.io/npm/v/@aws-sdk/region-config-resolver/latest.svg)](https://www.npmjs.com/package/@aws-sdk/region-config-resolver) +[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/region-config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/region-config-resolver) + +> An internal package + +This package provides utilities for AWS region config resolvers. + +## Usage + +You probably shouldn't, at least directly. diff --git a/packages/region-config-resolver/jest.config.js b/packages/region-config-resolver/jest.config.js new file mode 100644 index 0000000000000..a8d1c2e499123 --- /dev/null +++ b/packages/region-config-resolver/jest.config.js @@ -0,0 +1,5 @@ +const base = require("../../jest.config.base.js"); + +module.exports = { + ...base, +}; diff --git a/packages/region-config-resolver/package.json b/packages/region-config-resolver/package.json new file mode 100644 index 0000000000000..bac5acd164a06 --- /dev/null +++ b/packages/region-config-resolver/package.json @@ -0,0 +1,62 @@ +{ + "name": "@aws-sdk/region-config-resolver", + "version": "2.0.5", + "scripts": { + "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", + "build:cjs": "tsc -p tsconfig.cjs.json", + "build:es": "tsc -p tsconfig.es.json", + "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build", + "build:types": "tsc -p tsconfig.types.json", + "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", + "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", + "test": "jest", + "test:e2e": "jest -c jest.config.e2e.js" + }, + "main": "./dist-cjs/index.js", + "module": "./dist-es/index.js", + "types": "./dist-types/index.d.ts", + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "dependencies": { + "@smithy/types": "^2.2.2", + "@smithy/util-config-provider": "^2.0.0", + "@smithy/util-middleware": "^2.0.0", + "tslib": "^2.5.0" + }, + "devDependencies": { + "@smithy/node-config-provider": "^2.0.5", + "@tsconfig/recommended": "1.0.1", + "concurrently": "7.0.0", + "downlevel-dts": "0.10.1", + "jest": "28.1.1", + "rimraf": "3.0.2", + "typedoc": "0.23.23", + "typescript": "~4.9.5" + }, + "engines": { + "node": ">=14.0.0" + }, + "typesVersions": { + "<4.0": { + "dist-types/*": [ + "dist-types/ts3.4/*" + ] + } + }, + "files": [ + "dist-*/**" + ], + "homepage": "https://github.com/awslabs/smithy-typescript/tree/main/packages/region-config-resolver", + "repository": { + "type": "git", + "url": "https://github.com/aws/aws-sdk-js-v3.git", + "directory": "packages/region-config-resolver" + }, + "typedoc": { + "entryPoint": "src/index.ts" + } +} diff --git a/packages/region-config-resolver/src/extensions/index.ts b/packages/region-config-resolver/src/extensions/index.ts new file mode 100644 index 0000000000000..0a4268a6e3558 --- /dev/null +++ b/packages/region-config-resolver/src/extensions/index.ts @@ -0,0 +1,37 @@ +import { AwsRegionExtensionConfiguration } from "@aws-sdk/types"; +import { Provider } from "@smithy/types"; + +import { getRealRegion } from "../regionConfig/getRealRegion"; + +/** + * @internal + */ +export const getAwsRegionExtensionConfiguration = (runtimeConfig: Partial<{ region: string | Provider }>) => { + let runtimeConfigRegion: Provider = async () => { + const region = runtimeConfig.region!; + if (typeof region === "string") { + return region; + } + return await region(); + }; + + return { + setRegion(region: Provider): void { + runtimeConfigRegion = region; + }, + region(): Provider { + return runtimeConfigRegion; + }, + }; +}; + +/** + * @internal + */ +export const resolveAwsRegionExtensionConfiguration = ( + awsRegionExtensionConfiguration: AwsRegionExtensionConfiguration +) => { + const runtimeConfig: Partial<{ region: Provider }> = {}; + runtimeConfig.region = awsRegionExtensionConfiguration.region(); + return runtimeConfig; +}; diff --git a/packages/region-config-resolver/src/index.ts b/packages/region-config-resolver/src/index.ts new file mode 100644 index 0000000000000..5aaa1c0df061a --- /dev/null +++ b/packages/region-config-resolver/src/index.ts @@ -0,0 +1,9 @@ +/** + * @internal + */ +export * from "./extensions"; + +/** + * @internal + */ +export * from "./regionConfig"; diff --git a/packages/region-config-resolver/src/regionConfig/config.spec.ts b/packages/region-config-resolver/src/regionConfig/config.spec.ts new file mode 100644 index 0000000000000..580f3e85280d9 --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/config.spec.ts @@ -0,0 +1,38 @@ +import { + NODE_REGION_CONFIG_FILE_OPTIONS, + NODE_REGION_CONFIG_OPTIONS, + REGION_ENV_NAME, + REGION_INI_NAME, +} from "./config"; + +describe("config", () => { + describe("NODE_REGION_CONFIG_OPTIONS", () => { + describe("environmentVariableSelector", () => { + const { environmentVariableSelector } = NODE_REGION_CONFIG_OPTIONS; + it.each([undefined, "mockRegion"])(`when env[${REGION_ENV_NAME}]: %s`, (mockEndpoint) => { + expect(environmentVariableSelector({ [REGION_ENV_NAME]: mockEndpoint })).toBe(mockEndpoint); + }); + }); + + describe("configFileSelector", () => { + const { configFileSelector } = NODE_REGION_CONFIG_OPTIONS; + it.each([undefined, "mockRegion"])(`when env[${REGION_INI_NAME}]: %s`, (mockEndpoint) => { + expect(configFileSelector({ [REGION_INI_NAME]: mockEndpoint })).toBe(mockEndpoint); + }); + }); + + it("default throws error", () => { + const { default: defaultKey } = NODE_REGION_CONFIG_OPTIONS; + expect(() => { + (defaultKey as any)(); + }).toThrowError(new Error("Region is missing")); + }); + }); + + describe("NODE_REGION_CONFIG_FILE_OPTIONS", () => { + it("preferredFile contains credentials", () => { + const { preferredFile } = NODE_REGION_CONFIG_FILE_OPTIONS; + expect(preferredFile).toBe("credentials"); + }); + }); +}); diff --git a/packages/region-config-resolver/src/regionConfig/config.ts b/packages/region-config-resolver/src/regionConfig/config.ts new file mode 100644 index 0000000000000..95428045597b8 --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/config.ts @@ -0,0 +1,28 @@ +import { LoadedConfigSelectors, LocalConfigOptions } from "@smithy/node-config-provider"; + +/** + * @internal + */ +export const REGION_ENV_NAME = "AWS_REGION"; +/** + * @internal + */ +export const REGION_INI_NAME = "region"; + +/** + * @internal + */ +export const NODE_REGION_CONFIG_OPTIONS: LoadedConfigSelectors = { + environmentVariableSelector: (env) => env[REGION_ENV_NAME], + configFileSelector: (profile) => profile[REGION_INI_NAME], + default: () => { + throw new Error("Region is missing"); + }, +}; + +/** + * @internal + */ +export const NODE_REGION_CONFIG_FILE_OPTIONS: LocalConfigOptions = { + preferredFile: "credentials", +}; diff --git a/packages/region-config-resolver/src/regionConfig/getRealRegion.spec.ts b/packages/region-config-resolver/src/regionConfig/getRealRegion.spec.ts new file mode 100644 index 0000000000000..5a27f4aa8303b --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/getRealRegion.spec.ts @@ -0,0 +1,36 @@ +import { getRealRegion } from "./getRealRegion"; +import { isFipsRegion } from "./isFipsRegion"; + +jest.mock("./isFipsRegion"); + +describe(getRealRegion.name, () => { + beforeEach(() => { + (isFipsRegion as jest.Mock).mockReturnValue(true); + }); + + afterEach(() => { + expect(isFipsRegion).toHaveBeenCalledTimes(1); + jest.clearAllMocks(); + }); + + it("returns provided region if it's not FIPS", () => { + const mockRegion = "mockRegion"; + (isFipsRegion as jest.Mock).mockReturnValue(false); + expect(getRealRegion(mockRegion)).toStrictEqual(mockRegion); + }); + + describe("FIPS regions", () => { + it.each(["fips-aws-global", "aws-fips"])(`returns "us-east-1" for "%s"`, (input) => { + expect(getRealRegion(input)).toStrictEqual("us-east-1"); + }); + + it.each([ + ["us-west-1", "us-west-1-fips"], + ["us-west-1", "fips-us-west-1"], + ["us-west-1", "fips-dkr-us-west-1"], + ["us-west-1", "fips-prod-us-west-1"], + ])(`returns "%s" for "%s"`, (output, input) => { + expect(getRealRegion(input)).toStrictEqual(output); + }); + }); +}); diff --git a/packages/region-config-resolver/src/regionConfig/getRealRegion.ts b/packages/region-config-resolver/src/regionConfig/getRealRegion.ts new file mode 100644 index 0000000000000..5a9eb9ce10a9a --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/getRealRegion.ts @@ -0,0 +1,11 @@ +import { isFipsRegion } from "./isFipsRegion"; + +/** + * @internal + */ +export const getRealRegion = (region: string) => + isFipsRegion(region) + ? ["fips-aws-global", "aws-fips"].includes(region) + ? "us-east-1" + : region.replace(/fips-(dkr-|prod-)?|-fips/, "") + : region; diff --git a/packages/region-config-resolver/src/regionConfig/index.ts b/packages/region-config-resolver/src/regionConfig/index.ts new file mode 100644 index 0000000000000..6dcf5e55f976a --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/index.ts @@ -0,0 +1,8 @@ +/** + * @internal + */ +export * from "./config"; +/** + * @internal + */ +export * from "./resolveRegionConfig"; diff --git a/packages/region-config-resolver/src/regionConfig/isFipsRegion.spec.ts b/packages/region-config-resolver/src/regionConfig/isFipsRegion.spec.ts new file mode 100644 index 0000000000000..a497e75f26607 --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/isFipsRegion.spec.ts @@ -0,0 +1,15 @@ +import { isFipsRegion } from "./isFipsRegion"; + +describe(isFipsRegion.name, () => { + it.each([ + [true, "fips-us-east-1"], + [true, "us-east-1-fips"], + [false, "us-east-1"], + ])(`returns %s for region "%s"`, (output, input) => { + expect(isFipsRegion(input)).toEqual(output); + }); + + it.each([undefined, null])("returns false for %s", (input) => { + expect(isFipsRegion(input)).toEqual(false); + }); +}); diff --git a/packages/region-config-resolver/src/regionConfig/isFipsRegion.ts b/packages/region-config-resolver/src/regionConfig/isFipsRegion.ts new file mode 100644 index 0000000000000..5a7d60f7f05d4 --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/isFipsRegion.ts @@ -0,0 +1,5 @@ +/** + * @internal + */ +export const isFipsRegion = (region: string) => + typeof region === "string" && (region.startsWith("fips-") || region.endsWith("-fips")); diff --git a/packages/region-config-resolver/src/regionConfig/resolveRegionConfig.spec.ts b/packages/region-config-resolver/src/regionConfig/resolveRegionConfig.spec.ts new file mode 100644 index 0000000000000..cd01e2077790f --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/resolveRegionConfig.spec.ts @@ -0,0 +1,93 @@ +import { getRealRegion } from "./getRealRegion"; +import { isFipsRegion } from "./isFipsRegion"; +import { resolveRegionConfig } from "./resolveRegionConfig"; + +jest.mock("./getRealRegion"); +jest.mock("./isFipsRegion"); + +describe("RegionConfig", () => { + const mockRegion = "mockRegion"; + const mockRealRegion = "mockRealRegion"; + const mockUseFipsEndpoint = () => Promise.resolve(false); + + beforeEach(() => { + (getRealRegion as jest.Mock).mockReturnValue(mockRealRegion); + (isFipsRegion as jest.Mock).mockReturnValue(false); + }); + + afterEach(() => { + jest.clearAllMocks(); + }); + + describe("region", () => { + it("return normalized value with real region if passed as a string", async () => { + const resolvedRegionConfig = resolveRegionConfig({ region: mockRegion, useFipsEndpoint: mockUseFipsEndpoint }); + const resolvedRegion = await resolvedRegionConfig.region(); + expect(resolvedRegion).toBe(mockRealRegion); + expect(getRealRegion).toHaveBeenCalledTimes(1); + expect(getRealRegion).toHaveBeenCalledWith(mockRegion); + }); + + it("return provider with real region if passed as a Provider", async () => { + const resolvedRegionConfig = resolveRegionConfig({ + region: () => Promise.resolve(mockRegion), + useFipsEndpoint: mockUseFipsEndpoint, + }); + const resolvedRegion = await resolvedRegionConfig.region(); + expect(resolvedRegion).toBe(mockRealRegion); + expect(getRealRegion).toHaveBeenCalledTimes(1); + expect(getRealRegion).toHaveBeenCalledWith(mockRegion); + }); + + it("throw if region is not supplied", () => { + expect(() => resolveRegionConfig({ useFipsEndpoint: mockUseFipsEndpoint })).toThrow(); + }); + }); + + describe("useFipsEndpoint", () => { + let mockRegionProvider; + let mockUseFipsEndpoint; + + beforeEach(() => { + mockRegionProvider = jest.fn().mockResolvedValueOnce(Promise.resolve(mockRegion)); + mockUseFipsEndpoint = jest.fn().mockResolvedValueOnce(Promise.resolve(false)); + }); + + afterEach(() => { + expect(isFipsRegion).toHaveBeenCalledTimes(1); + expect(isFipsRegion).toHaveBeenCalledWith(mockRegion); + expect(mockRegionProvider).toHaveBeenCalledTimes(1); + }); + + it("can be undefined", async () => { + const resolvedRegionConfig = resolveRegionConfig({ + region: mockRegionProvider, + }); + + expect(await resolvedRegionConfig.useFipsEndpoint()).toBe(false); + }); + + it("returns Provider which returns true for FIPS endpoints", async () => { + (isFipsRegion as jest.Mock).mockReturnValue(true); + const resolvedRegionConfig = resolveRegionConfig({ + region: mockRegionProvider, + useFipsEndpoint: mockUseFipsEndpoint, + }); + + const useFipsEndpoint = await resolvedRegionConfig.useFipsEndpoint(); + expect(useFipsEndpoint).toStrictEqual(true); + expect(mockUseFipsEndpoint).not.toHaveBeenCalled(); + }); + + it("returns passed Provider if endpoint is not FIPS", async () => { + const resolvedRegionConfig = resolveRegionConfig({ + region: mockRegionProvider, + useFipsEndpoint: mockUseFipsEndpoint, + }); + + const useFipsEndpoint = await resolvedRegionConfig.useFipsEndpoint(); + expect(useFipsEndpoint).toStrictEqual(false); + expect(mockUseFipsEndpoint).toHaveBeenCalledTimes(1); + }); + }); +}); diff --git a/packages/region-config-resolver/src/regionConfig/resolveRegionConfig.ts b/packages/region-config-resolver/src/regionConfig/resolveRegionConfig.ts new file mode 100644 index 0000000000000..d1ee3c8561b14 --- /dev/null +++ b/packages/region-config-resolver/src/regionConfig/resolveRegionConfig.ts @@ -0,0 +1,68 @@ +import { Provider } from "@smithy/types"; + +import { getRealRegion } from "./getRealRegion"; +import { isFipsRegion } from "./isFipsRegion"; + +/** + * @public + */ +export interface RegionInputConfig { + /** + * The AWS region to which this client will send requests + */ + region?: string | Provider; + + /** + * Enables FIPS compatible endpoints. + */ + useFipsEndpoint?: boolean | Provider; +} + +/** + * @internal + */ +interface PreviouslyResolved {} + +/** + * @internal + */ +export interface RegionResolvedConfig { + /** + * Resolved value for input config {@link RegionInputConfig.region} + */ + region: Provider; + + /** + * Resolved value for input {@link RegionInputConfig.useFipsEndpoint} + */ + useFipsEndpoint: Provider; +} + +/** + * @internal + */ +export const resolveRegionConfig = (input: T & RegionInputConfig & PreviouslyResolved): T & RegionResolvedConfig => { + const { region, useFipsEndpoint } = input; + + if (!region) { + throw new Error("Region is missing"); + } + + return { + ...input, + region: async () => { + if (typeof region === "string") { + return getRealRegion(region); + } + const providedRegion = await region(); + return getRealRegion(providedRegion); + }, + useFipsEndpoint: async () => { + const providedRegion = typeof region === "string" ? region : await region(); + if (isFipsRegion(providedRegion)) { + return true; + } + return typeof useFipsEndpoint !== "function" ? Promise.resolve(!!useFipsEndpoint) : useFipsEndpoint(); + }, + }; +}; diff --git a/packages/region-config-resolver/tsconfig.cjs.json b/packages/region-config-resolver/tsconfig.cjs.json new file mode 100644 index 0000000000000..96198be81644a --- /dev/null +++ b/packages/region-config-resolver/tsconfig.cjs.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "outDir": "dist-cjs", + "rootDir": "src" + }, + "extends": "../../tsconfig.cjs.json", + "include": ["src/"] +} diff --git a/packages/region-config-resolver/tsconfig.es.json b/packages/region-config-resolver/tsconfig.es.json new file mode 100644 index 0000000000000..7f162b266e26c --- /dev/null +++ b/packages/region-config-resolver/tsconfig.es.json @@ -0,0 +1,10 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "lib": [], + "outDir": "dist-es", + "rootDir": "src" + }, + "extends": "../../tsconfig.es.json", + "include": ["src/"] +} diff --git a/packages/region-config-resolver/tsconfig.types.json b/packages/region-config-resolver/tsconfig.types.json new file mode 100644 index 0000000000000..6cdf9f52ea065 --- /dev/null +++ b/packages/region-config-resolver/tsconfig.types.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "declarationDir": "dist-types", + "rootDir": "src" + }, + "extends": "../../tsconfig.types.json", + "include": ["src/"] +} diff --git a/packages/types/src/extensions/index.ts b/packages/types/src/extensions/index.ts new file mode 100644 index 0000000000000..45984b832475c --- /dev/null +++ b/packages/types/src/extensions/index.ts @@ -0,0 +1,9 @@ +import { Provider } from "@smithy/types"; + +/** + * @internal + */ +export interface AwsRegionExtensionConfiguration { + setRegion(region: Provider): void; + region(): Provider; +} diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts index e41e7c339f595..ab64cd947b8ce 100644 --- a/packages/types/src/index.ts +++ b/packages/types/src/index.ts @@ -11,6 +11,7 @@ export * from "./dns"; export * from "./encode"; export * from "./endpoint"; export * from "./eventStream"; +export * from "./extensions"; export * from "./http"; export * from "./identity"; export * from "./logger";