From 25c58c61b150a99ac2c7ccf104e66305a7f235dd Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Wed, 17 Jun 2020 16:28:40 +0000 Subject: [PATCH 01/13] chore: retry-config-provider as copy of region-provider --- packages/retry-config-provider/.gitignore | 8 + packages/retry-config-provider/.npmignore | 16 ++ packages/retry-config-provider/LICENSE | 201 +++++++++++++++ packages/retry-config-provider/README.md | 10 + packages/retry-config-provider/jest.config.js | 5 + packages/retry-config-provider/package.json | 33 +++ .../src/defaultProvider.spec.ts | 72 ++++++ .../src/defaultProvider.ts | 14 + .../retry-config-provider/src/fromEnv.spec.ts | 84 ++++++ packages/retry-config-provider/src/fromEnv.ts | 21 ++ .../src/fromSharedConfigFiles.spec.ts | 242 ++++++++++++++++++ .../src/fromSharedConfigFiles.ts | 44 ++++ packages/retry-config-provider/src/index.ts | 3 + packages/retry-config-provider/tsconfig.json | 22 ++ .../retry-config-provider/tsconfig.test.json | 11 + 15 files changed, 786 insertions(+) create mode 100644 packages/retry-config-provider/.gitignore create mode 100644 packages/retry-config-provider/.npmignore create mode 100644 packages/retry-config-provider/LICENSE create mode 100644 packages/retry-config-provider/README.md create mode 100644 packages/retry-config-provider/jest.config.js create mode 100644 packages/retry-config-provider/package.json create mode 100644 packages/retry-config-provider/src/defaultProvider.spec.ts create mode 100644 packages/retry-config-provider/src/defaultProvider.ts create mode 100644 packages/retry-config-provider/src/fromEnv.spec.ts create mode 100644 packages/retry-config-provider/src/fromEnv.ts create mode 100644 packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts create mode 100644 packages/retry-config-provider/src/fromSharedConfigFiles.ts create mode 100644 packages/retry-config-provider/src/index.ts create mode 100644 packages/retry-config-provider/tsconfig.json create mode 100644 packages/retry-config-provider/tsconfig.test.json diff --git a/packages/retry-config-provider/.gitignore b/packages/retry-config-provider/.gitignore new file mode 100644 index 000000000000..3d1714c9806e --- /dev/null +++ b/packages/retry-config-provider/.gitignore @@ -0,0 +1,8 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/packages/retry-config-provider/.npmignore b/packages/retry-config-provider/.npmignore new file mode 100644 index 000000000000..9fc09eec2b85 --- /dev/null +++ b/packages/retry-config-provider/.npmignore @@ -0,0 +1,16 @@ +/src/ +/coverage/ +tsconfig.test.json +*.tsbuildinfo + +*.spec.js +*.spec.d.ts +*.spec.js.map + +*.mock.js +*.mock.d.ts +*.mock.js.map + +*.fixture.js +*.fixture.d.ts +*.fixture.js.map diff --git a/packages/retry-config-provider/LICENSE b/packages/retry-config-provider/LICENSE new file mode 100644 index 000000000000..a23adae1f987 --- /dev/null +++ b/packages/retry-config-provider/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 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/retry-config-provider/README.md b/packages/retry-config-provider/README.md new file mode 100644 index 000000000000..55be2315f872 --- /dev/null +++ b/packages/retry-config-provider/README.md @@ -0,0 +1,10 @@ +# @aws-sdk/retry-config-provider + +[![NPM version](https://img.shields.io/npm/v/@aws-sdk/retry-config-provider/beta.svg)](https://www.npmjs.com/package/@aws-sdk/retry-config-provider) +[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/retry-config-provider.svg)](https://www.npmjs.com/package/@aws-sdk/retry-config-provider) + +> An internal package + +## Usage + +You probably shouldn't, at least directly. diff --git a/packages/retry-config-provider/jest.config.js b/packages/retry-config-provider/jest.config.js new file mode 100644 index 000000000000..498ea8304467 --- /dev/null +++ b/packages/retry-config-provider/jest.config.js @@ -0,0 +1,5 @@ +const base = require("../../jest.config.base.js"); + +module.exports = { + ...base +}; diff --git a/packages/retry-config-provider/package.json b/packages/retry-config-provider/package.json new file mode 100644 index 000000000000..954d3301a83e --- /dev/null +++ b/packages/retry-config-provider/package.json @@ -0,0 +1,33 @@ +{ + "name": "@aws-sdk/retry-config-provider", + "version": "1.0.0-gamma.0", + "description": "AWS retry configuration provider for Node.JS. Will determine the default retry configuration to use for AWS clients by checking known environment variables and shared configuration files", + "main": "./build/index.js", + "typings": "./build/index.d.ts", + "scripts": { + "prepublishOnly": "tsc", + "pretest": "tsc -p tsconfig.test.json", + "test": "jest" + }, + "keywords": [ + "aws", + "credentials" + ], + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/property-provider": "1.0.0-gamma.1", + "@aws-sdk/shared-ini-file-loader": "1.0.0-gamma.1", + "@aws-sdk/types": "1.0.0-gamma.1", + "tslib": "^1.8.0" + }, + "devDependencies": { + "@types/jest": "^25.1.4", + "@types/node": "^10.0.0", + "jest": "^25.1.0", + "typescript": "~3.8.3" + } +} diff --git a/packages/retry-config-provider/src/defaultProvider.spec.ts b/packages/retry-config-provider/src/defaultProvider.spec.ts new file mode 100644 index 000000000000..ea25ff280b62 --- /dev/null +++ b/packages/retry-config-provider/src/defaultProvider.spec.ts @@ -0,0 +1,72 @@ +import { fromEnv } from "./fromEnv"; +import { fromSharedConfigFiles } from "./fromSharedConfigFiles"; +import { chain, memoize } from "@aws-sdk/property-provider"; +import { + defaultProvider, + RegionProviderConfiguration +} from "./defaultProvider"; + +jest.mock("./fromEnv", () => ({ + fromEnv: jest.fn() +})); + +jest.mock("./fromSharedConfigFiles", () => ({ + fromSharedConfigFiles: jest.fn() +})); + +jest.mock("@aws-sdk/property-provider", () => ({ + chain: jest.fn(), + memoize: jest.fn() +})); + +describe("defaultProvider", () => { + const configuration: RegionProviderConfiguration = { + profile: "profile", + environmentVariableName: "environmentVariableName" + }; + + afterEach(() => { + jest.clearAllMocks(); + }); + + it("passes fromEnv() and fromSharedConfigFiles() to chain", () => { + const mockFromEnvReturn = "mockFromEnvReturn"; + (fromEnv as jest.Mock).mockReturnValueOnce(mockFromEnvReturn); + + const mockFromSharedConfigFilesReturn = "mockFromSharedConfigFilesReturn"; + (fromSharedConfigFiles as jest.Mock).mockReturnValueOnce( + mockFromSharedConfigFilesReturn + ); + + defaultProvider(configuration); + + expect(fromEnv).toHaveBeenCalledTimes(1); + expect(fromEnv).toHaveBeenCalledWith(configuration); + expect(fromSharedConfigFiles).toHaveBeenCalledTimes(1); + expect(fromSharedConfigFiles).toHaveBeenCalledWith(configuration); + + expect(chain).toHaveBeenCalledTimes(1); + expect(chain).toHaveBeenCalledWith( + mockFromEnvReturn, + mockFromSharedConfigFilesReturn + ); + }); + + it("passes output of chain to memoize", () => { + const mockChainReturn = "mockChainReturn"; + (chain as jest.Mock).mockReturnValueOnce(mockChainReturn); + + defaultProvider(configuration); + + expect(chain).toHaveBeenCalledTimes(1); + expect(memoize).toHaveBeenCalledTimes(1); + expect(memoize).toHaveBeenCalledWith(mockChainReturn); + }); + + it("returns output memoize", () => { + const mockMemoizeReturn = "mockMemoizeReturn"; + (memoize as jest.Mock).mockReturnValueOnce(mockMemoizeReturn); + + expect(defaultProvider(configuration)).toEqual(mockMemoizeReturn); + }); +}); diff --git a/packages/retry-config-provider/src/defaultProvider.ts b/packages/retry-config-provider/src/defaultProvider.ts new file mode 100644 index 000000000000..f072368c4087 --- /dev/null +++ b/packages/retry-config-provider/src/defaultProvider.ts @@ -0,0 +1,14 @@ +import { EnvConfiguration, fromEnv } from "./fromEnv"; +import { + SharedConfigInit, + fromSharedConfigFiles +} from "./fromSharedConfigFiles"; +import { chain, memoize } from "@aws-sdk/property-provider"; +import { Provider } from "@aws-sdk/types"; + +export type RegionProviderConfiguration = EnvConfiguration & SharedConfigInit; + +export const defaultProvider = ( + configuration: RegionProviderConfiguration = {} +): Provider => + memoize(chain(fromEnv(configuration), fromSharedConfigFiles(configuration))); diff --git a/packages/retry-config-provider/src/fromEnv.spec.ts b/packages/retry-config-provider/src/fromEnv.spec.ts new file mode 100644 index 000000000000..d70e28e2ff08 --- /dev/null +++ b/packages/retry-config-provider/src/fromEnv.spec.ts @@ -0,0 +1,84 @@ +import { fromEnv, ENV_REGION } from "./fromEnv"; +import { ProviderError } from "@aws-sdk/property-provider"; + +describe("fromEnv", () => { + const ENV_CUSTOM = "AWS_DEFAULT_REGION"; + const envRegion = process.env[ENV_REGION]; + const envCustom = process.env[ENV_CUSTOM]; + const mockEnvRegion = "mockEnvRegion"; + const mockEnvCustom = "mockEnvCustom"; + + const getProviderError = (envVarName: string) => + new ProviderError( + `No value defined for the ${envVarName} environment variable` + ); + + beforeEach(() => { + delete process.env[ENV_REGION]; + delete process.env[ENV_CUSTOM]; + }); + + afterAll(() => { + process.env[ENV_CUSTOM] = envCustom; + process.env[ENV_REGION] = envRegion; + }); + + describe("when no value is passed", () => { + it(`returns value in '${ENV_REGION}' env var when set`, () => { + process.env[ENV_REGION] = mockEnvRegion; + return expect(fromEnv()()).resolves.toBe(mockEnvRegion); + }); + + it(`throws when '${ENV_REGION}' env var is not set`, () => { + return expect(fromEnv()()).rejects.toMatchObject( + getProviderError(ENV_REGION) + ); + }); + }); + + describe(`when custom env var '${ENV_CUSTOM}' is passed`, () => { + describe(`returns value in '${ENV_CUSTOM}' env var when set`, () => { + const environmentVariableName = ENV_CUSTOM; + + beforeEach(() => { + process.env[environmentVariableName] = mockEnvCustom; + expect(process.env[ENV_REGION]).toBeUndefined(); + }); + + it(`when '${ENV_REGION}' is set`, () => { + process.env[ENV_REGION] = mockEnvRegion; + return expect(fromEnv({ environmentVariableName })()).resolves.toBe( + mockEnvCustom + ); + }); + + it(`when '${ENV_REGION}' is not set`, () => { + return expect(fromEnv({ environmentVariableName })()).resolves.toBe( + mockEnvCustom + ); + }); + }); + + describe(`throws when '${ENV_CUSTOM}' env var is not set`, () => { + const environmentVariableName = ENV_CUSTOM; + + beforeEach(() => { + delete process.env[environmentVariableName]; + expect(process.env[ENV_REGION]).toBeUndefined(); + }); + + it(`when '${ENV_REGION}' is set`, () => { + process.env[ENV_REGION] = mockEnvRegion; + return expect( + fromEnv({ environmentVariableName })() + ).rejects.toMatchObject(getProviderError(environmentVariableName)); + }); + + it(`when '${ENV_REGION}' is not set`, () => { + return expect( + fromEnv({ environmentVariableName })() + ).rejects.toMatchObject(getProviderError(environmentVariableName)); + }); + }); + }); +}); diff --git a/packages/retry-config-provider/src/fromEnv.ts b/packages/retry-config-provider/src/fromEnv.ts new file mode 100644 index 000000000000..9e72f6e0fd93 --- /dev/null +++ b/packages/retry-config-provider/src/fromEnv.ts @@ -0,0 +1,21 @@ +import { ProviderError } from "@aws-sdk/property-provider"; +import { Provider } from "@aws-sdk/types"; + +export const ENV_REGION = "AWS_REGION"; + +export interface EnvConfiguration { + environmentVariableName?: string; +} + +export const fromEnv = ({ + environmentVariableName = ENV_REGION +}: EnvConfiguration = {}): Provider => async () => { + const envRegion = process.env[environmentVariableName]; + if (envRegion) { + return envRegion; + } + + throw new ProviderError( + `No value defined for the ${environmentVariableName} environment variable` + ); +}; diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts new file mode 100644 index 000000000000..8eb9b8684e7c --- /dev/null +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts @@ -0,0 +1,242 @@ +import { fromSharedConfigFiles, ENV_PROFILE } from "./fromSharedConfigFiles"; +import { + loadSharedConfigFiles, + ParsedIniData +} from "@aws-sdk/shared-ini-file-loader"; +import { ProviderError } from "@aws-sdk/property-provider"; + +jest.mock("@aws-sdk/shared-ini-file-loader", () => ({ + loadSharedConfigFiles: jest.fn() +})); + +describe("fromSharedConfigFiles", () => { + const envProfile = process.env[ENV_PROFILE]; + + beforeEach(() => { + delete process.env[ENV_PROFILE]; + }); + + afterAll(() => { + process.env[ENV_PROFILE] = envProfile; + }); + + const getProviderError = (profile: string) => + new ProviderError( + `No region found for profile ${profile} in SDK configuration files` + ); + + describe("loadedConfig", () => { + const mockRegionAnswer = "mockRegionAnswer"; + const mockRegionNotAnswer = "mockRegionNotAnswer"; + const getIniDataWithAnswersRemoved = (iniData: ParsedIniData) => + Object.keys(iniData).reduce( + (acc, key) => ({ + [key]: { region: mockRegionNotAnswer }, + ...acc + }), + {} + ); + + type loadedConfigTestData = { + message: string; + iniDataToReturn: ParsedIniData; + profile?: string; + }; + + const loadedConfigResolves: (loadedConfigTestData & { + regionToVerify: string; + })[] = [ + { + message: "returns region from default profile", + iniDataToReturn: { + default: { region: mockRegionAnswer } + }, + regionToVerify: mockRegionAnswer + }, + { + message: "returns region from designated profile", + iniDataToReturn: { + default: { region: mockRegionNotAnswer }, + foo: { region: mockRegionAnswer } + }, + regionToVerify: mockRegionAnswer, + profile: "foo" + } + ]; + + const loadedConfigRejects: loadedConfigTestData[] = [ + { + message: + "rejects if default profile is not present and profile value is not passed", + iniDataToReturn: { + foo: { region: mockRegionNotAnswer } + } + }, + { + message: "rejects if designated profile is not present", + iniDataToReturn: { + default: { region: mockRegionNotAnswer } + }, + profile: "foo" + } + ]; + + describe("uses the shared ini file loader if pre-loaded config is not supplied", () => { + describe("when config file is empty", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, regionToVerify, profile }) => { + it(`${message} from credentials file`, () => { + (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ + configFile: {}, + credentialsFile: iniDataToReturn + }); + return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( + regionToVerify + ); + }); + } + ); + }); + + describe("when credentials file is empty", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, regionToVerify, profile }) => { + it(`${message} from config file`, () => { + (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ + configFile: iniDataToReturn, + credentialsFile: {} + }); + return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( + regionToVerify + ); + }); + } + ); + }); + + describe("prefer credentials file if both not empty", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, regionToVerify, profile }) => { + it(`${message} from credentials file`, () => { + (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ + configFile: getIniDataWithAnswersRemoved(iniDataToReturn), + credentialsFile: iniDataToReturn + }); + return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( + regionToVerify + ); + }); + } + ); + }); + + loadedConfigRejects.forEach(({ message, iniDataToReturn, profile }) => { + it(message, () => { + (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ + configFile: {}, + credentialsFile: iniDataToReturn + }); + return expect( + fromSharedConfigFiles({ profile })() + ).rejects.toMatchObject(getProviderError(profile ?? "default")); + }); + }); + }); + + describe("uses pre-loaded config if supplied", () => { + describe("when config file is empty", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, regionToVerify, profile }) => { + it(`${message} from credentials file`, () => { + const loadedConfig = Promise.resolve({ + configFile: {}, + credentialsFile: iniDataToReturn + }); + return expect( + fromSharedConfigFiles({ loadedConfig, profile })() + ).resolves.toBe(regionToVerify); + }); + } + ); + }); + + describe("when credentials file is empty", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, regionToVerify, profile }) => { + it(`${message} from config file`, () => { + const loadedConfig = Promise.resolve({ + configFile: iniDataToReturn, + credentialsFile: {} + }); + return expect( + fromSharedConfigFiles({ loadedConfig, profile })() + ).resolves.toBe(regionToVerify); + }); + } + ); + }); + + describe("prefer credentials file if both not empty", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, regionToVerify, profile }) => { + it(`${message} from config file`, () => { + const loadedConfig = Promise.resolve({ + configFile: getIniDataWithAnswersRemoved(iniDataToReturn), + credentialsFile: iniDataToReturn + }); + return expect( + fromSharedConfigFiles({ loadedConfig, profile })() + ).resolves.toBe(regionToVerify); + }); + } + ); + }); + + loadedConfigRejects.forEach(({ message, iniDataToReturn, profile }) => { + it(message, () => { + const loadedConfig = Promise.resolve({ + configFile: {}, + credentialsFile: iniDataToReturn + }); + return expect( + fromSharedConfigFiles({ loadedConfig, profile })() + ).rejects.toMatchObject(getProviderError(profile ?? "default")); + }); + }); + }); + }); + + describe("profile", () => { + const loadedConfigData = { + configFile: {}, + credentialsFile: { + default: { region: "credentialsFileDefault" }, + foo: { region: "credentialsFileDefault" } + } + }; + const loadedConfig = Promise.resolve(loadedConfigData); + + it("returns region from designated profile when profile is defined", () => { + const profile = "foo"; + return expect( + fromSharedConfigFiles({ loadedConfig, profile })() + ).resolves.toBe(loadedConfigData.credentialsFile[profile].region); + }); + + describe("when profile is not defined", () => { + it(`returns region from value in '${ENV_PROFILE}' env var if it is set`, () => { + const profile = "foo"; + process.env[ENV_PROFILE] = profile; + return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( + loadedConfigData.credentialsFile[profile].region + ); + }); + + it(`returns region from default profile if '${ENV_PROFILE}' env var is not set`, () => { + return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( + loadedConfigData.credentialsFile.default.region + ); + }); + }); + }); +}); diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.ts new file mode 100644 index 000000000000..0742b81d6cd2 --- /dev/null +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.ts @@ -0,0 +1,44 @@ +import { ProviderError } from "@aws-sdk/property-provider"; +import { + loadSharedConfigFiles, + SharedConfigFiles, + SharedConfigInit as BaseSharedConfigInit +} from "@aws-sdk/shared-ini-file-loader"; +import { Provider } from "@aws-sdk/types"; + +const DEFAULT_PROFILE = "default"; +export const ENV_PROFILE = "AWS_PROFILE"; + +export interface SharedConfigInit extends BaseSharedConfigInit { + /** + * The configuration profile to use. + */ + profile?: string; + + /** + * A promise that will be resolved with loaded and parsed credentials files. + * Used to avoid loading shared config files multiple times. + */ + loadedConfig?: Promise; +} + +export const fromSharedConfigFiles = ( + init: SharedConfigInit = {} +): Provider => async () => { + const { + loadedConfig = loadSharedConfigFiles(init), + profile = process.env[ENV_PROFILE] || DEFAULT_PROFILE + } = init; + + const { configFile, credentialsFile } = await loadedConfig; + for (let file of [credentialsFile, configFile]) { + const { region } = file[profile] || {}; + if (typeof region === "string") { + return region; + } + } + + throw new ProviderError( + `No region found for profile ${profile} in SDK configuration files` + ); +}; diff --git a/packages/retry-config-provider/src/index.ts b/packages/retry-config-provider/src/index.ts new file mode 100644 index 000000000000..6c7eb3151a90 --- /dev/null +++ b/packages/retry-config-provider/src/index.ts @@ -0,0 +1,3 @@ +export * from "./defaultProvider"; +export * from "./fromEnv"; +export * from "./fromSharedConfigFiles"; diff --git a/packages/retry-config-provider/tsconfig.json b/packages/retry-config-provider/tsconfig.json new file mode 100644 index 000000000000..ea8af8858555 --- /dev/null +++ b/packages/retry-config-provider/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "target": "es5", + "module": "commonjs", + "declaration": true, + "strict": true, + "sourceMap": true, + "downlevelIteration": true, + "lib": [ + "es5", + "es2015.promise", + "es2015.collection", + "es2015.iterable", + "es2015.symbol.wellknown" + ], + "rootDir": "./src", + "outDir": "./build", + "importHelpers": true, + "noEmitHelpers": true, + "incremental": true + } +} diff --git a/packages/retry-config-provider/tsconfig.test.json b/packages/retry-config-provider/tsconfig.test.json new file mode 100644 index 000000000000..17d0f1b7321f --- /dev/null +++ b/packages/retry-config-provider/tsconfig.test.json @@ -0,0 +1,11 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "sourceMap": false, + "inlineSourceMap": true, + "inlineSources": true, + "rootDir": "./src", + "outDir": "./build", + "incremental": true + } +} From 873c6b666d4c3c3561ce3471bea2a8d106b36081 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Wed, 17 Jun 2020 19:51:34 +0000 Subject: [PATCH 02/13] chore: rename configuration --- packages/retry-config-provider/src/defaultProvider.spec.ts | 4 ++-- packages/retry-config-provider/src/defaultProvider.ts | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/retry-config-provider/src/defaultProvider.spec.ts b/packages/retry-config-provider/src/defaultProvider.spec.ts index ea25ff280b62..a0e91f815670 100644 --- a/packages/retry-config-provider/src/defaultProvider.spec.ts +++ b/packages/retry-config-provider/src/defaultProvider.spec.ts @@ -3,7 +3,7 @@ import { fromSharedConfigFiles } from "./fromSharedConfigFiles"; import { chain, memoize } from "@aws-sdk/property-provider"; import { defaultProvider, - RegionProviderConfiguration + RetryConfigProviderConfiguration } from "./defaultProvider"; jest.mock("./fromEnv", () => ({ @@ -20,7 +20,7 @@ jest.mock("@aws-sdk/property-provider", () => ({ })); describe("defaultProvider", () => { - const configuration: RegionProviderConfiguration = { + const configuration: RetryConfigProviderConfiguration = { profile: "profile", environmentVariableName: "environmentVariableName" }; diff --git a/packages/retry-config-provider/src/defaultProvider.ts b/packages/retry-config-provider/src/defaultProvider.ts index f072368c4087..6ffb8920c685 100644 --- a/packages/retry-config-provider/src/defaultProvider.ts +++ b/packages/retry-config-provider/src/defaultProvider.ts @@ -6,9 +6,10 @@ import { import { chain, memoize } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; -export type RegionProviderConfiguration = EnvConfiguration & SharedConfigInit; +export type RetryConfigProviderConfiguration = EnvConfiguration & + SharedConfigInit; export const defaultProvider = ( - configuration: RegionProviderConfiguration = {} + configuration: RetryConfigProviderConfiguration = {} ): Provider => memoize(chain(fromEnv(configuration), fromSharedConfigFiles(configuration))); From 05f86ff587ba015153cff9ed2841b65e043a1d9b Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 02:47:06 +0000 Subject: [PATCH 03/13] chore: do not pass configuration in fromEnv --- .../src/defaultProvider.spec.ts | 1 - .../src/defaultProvider.ts | 2 +- .../retry-config-provider/src/fromEnv.spec.ts | 67 ++----------------- packages/retry-config-provider/src/fromEnv.ts | 8 +-- 4 files changed, 11 insertions(+), 67 deletions(-) diff --git a/packages/retry-config-provider/src/defaultProvider.spec.ts b/packages/retry-config-provider/src/defaultProvider.spec.ts index a0e91f815670..7615060e7dc6 100644 --- a/packages/retry-config-provider/src/defaultProvider.spec.ts +++ b/packages/retry-config-provider/src/defaultProvider.spec.ts @@ -41,7 +41,6 @@ describe("defaultProvider", () => { defaultProvider(configuration); expect(fromEnv).toHaveBeenCalledTimes(1); - expect(fromEnv).toHaveBeenCalledWith(configuration); expect(fromSharedConfigFiles).toHaveBeenCalledTimes(1); expect(fromSharedConfigFiles).toHaveBeenCalledWith(configuration); diff --git a/packages/retry-config-provider/src/defaultProvider.ts b/packages/retry-config-provider/src/defaultProvider.ts index 6ffb8920c685..b5a5e6e7a5bf 100644 --- a/packages/retry-config-provider/src/defaultProvider.ts +++ b/packages/retry-config-provider/src/defaultProvider.ts @@ -12,4 +12,4 @@ export type RetryConfigProviderConfiguration = EnvConfiguration & export const defaultProvider = ( configuration: RetryConfigProviderConfiguration = {} ): Provider => - memoize(chain(fromEnv(configuration), fromSharedConfigFiles(configuration))); + memoize(chain(fromEnv(), fromSharedConfigFiles(configuration))); diff --git a/packages/retry-config-provider/src/fromEnv.spec.ts b/packages/retry-config-provider/src/fromEnv.spec.ts index d70e28e2ff08..faf5bc737274 100644 --- a/packages/retry-config-provider/src/fromEnv.spec.ts +++ b/packages/retry-config-provider/src/fromEnv.spec.ts @@ -2,11 +2,8 @@ import { fromEnv, ENV_REGION } from "./fromEnv"; import { ProviderError } from "@aws-sdk/property-provider"; describe("fromEnv", () => { - const ENV_CUSTOM = "AWS_DEFAULT_REGION"; const envRegion = process.env[ENV_REGION]; - const envCustom = process.env[ENV_CUSTOM]; const mockEnvRegion = "mockEnvRegion"; - const mockEnvCustom = "mockEnvCustom"; const getProviderError = (envVarName: string) => new ProviderError( @@ -15,70 +12,20 @@ describe("fromEnv", () => { beforeEach(() => { delete process.env[ENV_REGION]; - delete process.env[ENV_CUSTOM]; }); afterAll(() => { - process.env[ENV_CUSTOM] = envCustom; process.env[ENV_REGION] = envRegion; }); - describe("when no value is passed", () => { - it(`returns value in '${ENV_REGION}' env var when set`, () => { - process.env[ENV_REGION] = mockEnvRegion; - return expect(fromEnv()()).resolves.toBe(mockEnvRegion); - }); - - it(`throws when '${ENV_REGION}' env var is not set`, () => { - return expect(fromEnv()()).rejects.toMatchObject( - getProviderError(ENV_REGION) - ); - }); + it(`returns value in '${ENV_REGION}' env var when set`, () => { + process.env[ENV_REGION] = mockEnvRegion; + return expect(fromEnv()()).resolves.toBe(mockEnvRegion); }); - describe(`when custom env var '${ENV_CUSTOM}' is passed`, () => { - describe(`returns value in '${ENV_CUSTOM}' env var when set`, () => { - const environmentVariableName = ENV_CUSTOM; - - beforeEach(() => { - process.env[environmentVariableName] = mockEnvCustom; - expect(process.env[ENV_REGION]).toBeUndefined(); - }); - - it(`when '${ENV_REGION}' is set`, () => { - process.env[ENV_REGION] = mockEnvRegion; - return expect(fromEnv({ environmentVariableName })()).resolves.toBe( - mockEnvCustom - ); - }); - - it(`when '${ENV_REGION}' is not set`, () => { - return expect(fromEnv({ environmentVariableName })()).resolves.toBe( - mockEnvCustom - ); - }); - }); - - describe(`throws when '${ENV_CUSTOM}' env var is not set`, () => { - const environmentVariableName = ENV_CUSTOM; - - beforeEach(() => { - delete process.env[environmentVariableName]; - expect(process.env[ENV_REGION]).toBeUndefined(); - }); - - it(`when '${ENV_REGION}' is set`, () => { - process.env[ENV_REGION] = mockEnvRegion; - return expect( - fromEnv({ environmentVariableName })() - ).rejects.toMatchObject(getProviderError(environmentVariableName)); - }); - - it(`when '${ENV_REGION}' is not set`, () => { - return expect( - fromEnv({ environmentVariableName })() - ).rejects.toMatchObject(getProviderError(environmentVariableName)); - }); - }); + it(`throws when '${ENV_REGION}' env var is not set`, () => { + return expect(fromEnv()()).rejects.toMatchObject( + getProviderError(ENV_REGION) + ); }); }); diff --git a/packages/retry-config-provider/src/fromEnv.ts b/packages/retry-config-provider/src/fromEnv.ts index 9e72f6e0fd93..eb074ea15e2c 100644 --- a/packages/retry-config-provider/src/fromEnv.ts +++ b/packages/retry-config-provider/src/fromEnv.ts @@ -7,15 +7,13 @@ export interface EnvConfiguration { environmentVariableName?: string; } -export const fromEnv = ({ - environmentVariableName = ENV_REGION -}: EnvConfiguration = {}): Provider => async () => { - const envRegion = process.env[environmentVariableName]; +export const fromEnv = (): Provider => async () => { + const envRegion = process.env[ENV_REGION]; if (envRegion) { return envRegion; } throw new ProviderError( - `No value defined for the ${environmentVariableName} environment variable` + `No value defined for the ${ENV_REGION} environment variable` ); }; From 7b6edc5e387edab600b5e84cd0e11085910e431c Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 02:48:25 +0000 Subject: [PATCH 04/13] chore: remove unused EnvConfiguration --- packages/retry-config-provider/src/defaultProvider.spec.ts | 3 +-- packages/retry-config-provider/src/defaultProvider.ts | 5 ++--- packages/retry-config-provider/src/fromEnv.ts | 4 ---- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/packages/retry-config-provider/src/defaultProvider.spec.ts b/packages/retry-config-provider/src/defaultProvider.spec.ts index 7615060e7dc6..b696fe4d8a15 100644 --- a/packages/retry-config-provider/src/defaultProvider.spec.ts +++ b/packages/retry-config-provider/src/defaultProvider.spec.ts @@ -21,8 +21,7 @@ jest.mock("@aws-sdk/property-provider", () => ({ describe("defaultProvider", () => { const configuration: RetryConfigProviderConfiguration = { - profile: "profile", - environmentVariableName: "environmentVariableName" + profile: "profile" }; afterEach(() => { diff --git a/packages/retry-config-provider/src/defaultProvider.ts b/packages/retry-config-provider/src/defaultProvider.ts index b5a5e6e7a5bf..ba3bf57282c7 100644 --- a/packages/retry-config-provider/src/defaultProvider.ts +++ b/packages/retry-config-provider/src/defaultProvider.ts @@ -1,4 +1,4 @@ -import { EnvConfiguration, fromEnv } from "./fromEnv"; +import { fromEnv } from "./fromEnv"; import { SharedConfigInit, fromSharedConfigFiles @@ -6,8 +6,7 @@ import { import { chain, memoize } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; -export type RetryConfigProviderConfiguration = EnvConfiguration & - SharedConfigInit; +export type RetryConfigProviderConfiguration = SharedConfigInit; export const defaultProvider = ( configuration: RetryConfigProviderConfiguration = {} diff --git a/packages/retry-config-provider/src/fromEnv.ts b/packages/retry-config-provider/src/fromEnv.ts index eb074ea15e2c..c6200f2616fc 100644 --- a/packages/retry-config-provider/src/fromEnv.ts +++ b/packages/retry-config-provider/src/fromEnv.ts @@ -3,10 +3,6 @@ import { Provider } from "@aws-sdk/types"; export const ENV_REGION = "AWS_REGION"; -export interface EnvConfiguration { - environmentVariableName?: string; -} - export const fromEnv = (): Provider => async () => { const envRegion = process.env[ENV_REGION]; if (envRegion) { From 3fb96925da3766a2def710c05794afeba0752292 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 03:01:00 +0000 Subject: [PATCH 05/13] chore: remove RetryConfigProviderConfiguration --- .../src/defaultProvider.spec.ts | 12 ++++++------ .../retry-config-provider/src/defaultProvider.ts | 4 +--- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/packages/retry-config-provider/src/defaultProvider.spec.ts b/packages/retry-config-provider/src/defaultProvider.spec.ts index b696fe4d8a15..ba7781cd8c19 100644 --- a/packages/retry-config-provider/src/defaultProvider.spec.ts +++ b/packages/retry-config-provider/src/defaultProvider.spec.ts @@ -1,10 +1,10 @@ import { fromEnv } from "./fromEnv"; -import { fromSharedConfigFiles } from "./fromSharedConfigFiles"; -import { chain, memoize } from "@aws-sdk/property-provider"; import { - defaultProvider, - RetryConfigProviderConfiguration -} from "./defaultProvider"; + fromSharedConfigFiles, + SharedConfigInit +} from "./fromSharedConfigFiles"; +import { chain, memoize } from "@aws-sdk/property-provider"; +import { defaultProvider } from "./defaultProvider"; jest.mock("./fromEnv", () => ({ fromEnv: jest.fn() @@ -20,7 +20,7 @@ jest.mock("@aws-sdk/property-provider", () => ({ })); describe("defaultProvider", () => { - const configuration: RetryConfigProviderConfiguration = { + const configuration: SharedConfigInit = { profile: "profile" }; diff --git a/packages/retry-config-provider/src/defaultProvider.ts b/packages/retry-config-provider/src/defaultProvider.ts index ba3bf57282c7..f06feb01db14 100644 --- a/packages/retry-config-provider/src/defaultProvider.ts +++ b/packages/retry-config-provider/src/defaultProvider.ts @@ -6,9 +6,7 @@ import { import { chain, memoize } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; -export type RetryConfigProviderConfiguration = SharedConfigInit; - export const defaultProvider = ( - configuration: RetryConfigProviderConfiguration = {} + configuration: SharedConfigInit = {} ): Provider => memoize(chain(fromEnv(), fromSharedConfigFiles(configuration))); From 033fdf53dbf01f903fcd81afc578dc17c95425a7 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 03:07:41 +0000 Subject: [PATCH 06/13] chore: update env variable name and value --- .../retry-config-provider/src/fromEnv.spec.ts | 20 +++++++++---------- packages/retry-config-provider/src/fromEnv.ts | 6 +++--- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/retry-config-provider/src/fromEnv.spec.ts b/packages/retry-config-provider/src/fromEnv.spec.ts index faf5bc737274..5364597f7ba4 100644 --- a/packages/retry-config-provider/src/fromEnv.spec.ts +++ b/packages/retry-config-provider/src/fromEnv.spec.ts @@ -1,9 +1,9 @@ -import { fromEnv, ENV_REGION } from "./fromEnv"; +import { fromEnv, ENV_MAX_ATTEMPTS } from "./fromEnv"; import { ProviderError } from "@aws-sdk/property-provider"; describe("fromEnv", () => { - const envRegion = process.env[ENV_REGION]; - const mockEnvRegion = "mockEnvRegion"; + const envRegion = process.env[ENV_MAX_ATTEMPTS]; + const mockEnvMaxAttempts = "mockEnvMaxAttempts"; const getProviderError = (envVarName: string) => new ProviderError( @@ -11,21 +11,21 @@ describe("fromEnv", () => { ); beforeEach(() => { - delete process.env[ENV_REGION]; + delete process.env[ENV_MAX_ATTEMPTS]; }); afterAll(() => { - process.env[ENV_REGION] = envRegion; + process.env[ENV_MAX_ATTEMPTS] = envRegion; }); - it(`returns value in '${ENV_REGION}' env var when set`, () => { - process.env[ENV_REGION] = mockEnvRegion; - return expect(fromEnv()()).resolves.toBe(mockEnvRegion); + it(`returns value in '${ENV_MAX_ATTEMPTS}' env var when set`, () => { + process.env[ENV_MAX_ATTEMPTS] = mockEnvMaxAttempts; + return expect(fromEnv()()).resolves.toBe(mockEnvMaxAttempts); }); - it(`throws when '${ENV_REGION}' env var is not set`, () => { + it(`throws when '${ENV_MAX_ATTEMPTS}' env var is not set`, () => { return expect(fromEnv()()).rejects.toMatchObject( - getProviderError(ENV_REGION) + getProviderError(ENV_MAX_ATTEMPTS) ); }); }); diff --git a/packages/retry-config-provider/src/fromEnv.ts b/packages/retry-config-provider/src/fromEnv.ts index c6200f2616fc..47d18dd944f1 100644 --- a/packages/retry-config-provider/src/fromEnv.ts +++ b/packages/retry-config-provider/src/fromEnv.ts @@ -1,15 +1,15 @@ import { ProviderError } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; -export const ENV_REGION = "AWS_REGION"; +export const ENV_MAX_ATTEMPTS = "AWS_MAX_ATTEMPTS"; export const fromEnv = (): Provider => async () => { - const envRegion = process.env[ENV_REGION]; + const envRegion = process.env[ENV_MAX_ATTEMPTS]; if (envRegion) { return envRegion; } throw new ProviderError( - `No value defined for the ${ENV_REGION} environment variable` + `No value defined for the ${ENV_MAX_ATTEMPTS} environment variable` ); }; From 690992cbdeeb476d13cd58edf8524e040d79173d Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 03:13:18 +0000 Subject: [PATCH 07/13] chore: update region->max_attempts in fromSharedConfigFiles --- .../src/fromSharedConfigFiles.spec.ts | 68 +++++++++---------- .../src/fromSharedConfigFiles.ts | 8 +-- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts index 8eb9b8684e7c..f20b1ddbb044 100644 --- a/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts @@ -22,16 +22,16 @@ describe("fromSharedConfigFiles", () => { const getProviderError = (profile: string) => new ProviderError( - `No region found for profile ${profile} in SDK configuration files` + `No max_attempts value found for profile ${profile} in SDK configuration files` ); describe("loadedConfig", () => { - const mockRegionAnswer = "mockRegionAnswer"; - const mockRegionNotAnswer = "mockRegionNotAnswer"; + const mockMaxAttemptsAnswer = "mockMaxAttemptsAnswer"; + const mockMaxAttmeptsNotAnswer = "mockMaxAttmeptsNotAnswer"; const getIniDataWithAnswersRemoved = (iniData: ParsedIniData) => Object.keys(iniData).reduce( (acc, key) => ({ - [key]: { region: mockRegionNotAnswer }, + [key]: { max_attempts: mockMaxAttmeptsNotAnswer }, ...acc }), {} @@ -44,22 +44,22 @@ describe("fromSharedConfigFiles", () => { }; const loadedConfigResolves: (loadedConfigTestData & { - regionToVerify: string; + maxAttemptsToVerify: string; })[] = [ { - message: "returns region from default profile", + message: "returns maxAttempts from default profile", iniDataToReturn: { - default: { region: mockRegionAnswer } + default: { max_attempts: mockMaxAttemptsAnswer } }, - regionToVerify: mockRegionAnswer + maxAttemptsToVerify: mockMaxAttemptsAnswer }, { - message: "returns region from designated profile", + message: "returns maxAttempts from designated profile", iniDataToReturn: { - default: { region: mockRegionNotAnswer }, - foo: { region: mockRegionAnswer } + default: { max_attempts: mockMaxAttmeptsNotAnswer }, + foo: { max_attempts: mockMaxAttemptsAnswer } }, - regionToVerify: mockRegionAnswer, + maxAttemptsToVerify: mockMaxAttemptsAnswer, profile: "foo" } ]; @@ -69,13 +69,13 @@ describe("fromSharedConfigFiles", () => { message: "rejects if default profile is not present and profile value is not passed", iniDataToReturn: { - foo: { region: mockRegionNotAnswer } + foo: { max_attempts: mockMaxAttmeptsNotAnswer } } }, { message: "rejects if designated profile is not present", iniDataToReturn: { - default: { region: mockRegionNotAnswer } + default: { max_attempts: mockMaxAttmeptsNotAnswer } }, profile: "foo" } @@ -84,14 +84,14 @@ describe("fromSharedConfigFiles", () => { describe("uses the shared ini file loader if pre-loaded config is not supplied", () => { describe("when config file is empty", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, regionToVerify, profile }) => { + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { it(`${message} from credentials file`, () => { (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ configFile: {}, credentialsFile: iniDataToReturn }); return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( - regionToVerify + maxAttemptsToVerify ); }); } @@ -100,14 +100,14 @@ describe("fromSharedConfigFiles", () => { describe("when credentials file is empty", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, regionToVerify, profile }) => { + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { it(`${message} from config file`, () => { (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ configFile: iniDataToReturn, credentialsFile: {} }); return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( - regionToVerify + maxAttemptsToVerify ); }); } @@ -116,14 +116,14 @@ describe("fromSharedConfigFiles", () => { describe("prefer credentials file if both not empty", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, regionToVerify, profile }) => { + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { it(`${message} from credentials file`, () => { (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ configFile: getIniDataWithAnswersRemoved(iniDataToReturn), credentialsFile: iniDataToReturn }); return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( - regionToVerify + maxAttemptsToVerify ); }); } @@ -146,7 +146,7 @@ describe("fromSharedConfigFiles", () => { describe("uses pre-loaded config if supplied", () => { describe("when config file is empty", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, regionToVerify, profile }) => { + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { it(`${message} from credentials file`, () => { const loadedConfig = Promise.resolve({ configFile: {}, @@ -154,7 +154,7 @@ describe("fromSharedConfigFiles", () => { }); return expect( fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(regionToVerify); + ).resolves.toBe(maxAttemptsToVerify); }); } ); @@ -162,7 +162,7 @@ describe("fromSharedConfigFiles", () => { describe("when credentials file is empty", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, regionToVerify, profile }) => { + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { it(`${message} from config file`, () => { const loadedConfig = Promise.resolve({ configFile: iniDataToReturn, @@ -170,7 +170,7 @@ describe("fromSharedConfigFiles", () => { }); return expect( fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(regionToVerify); + ).resolves.toBe(maxAttemptsToVerify); }); } ); @@ -178,7 +178,7 @@ describe("fromSharedConfigFiles", () => { describe("prefer credentials file if both not empty", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, regionToVerify, profile }) => { + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { it(`${message} from config file`, () => { const loadedConfig = Promise.resolve({ configFile: getIniDataWithAnswersRemoved(iniDataToReturn), @@ -186,7 +186,7 @@ describe("fromSharedConfigFiles", () => { }); return expect( fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(regionToVerify); + ).resolves.toBe(maxAttemptsToVerify); }); } ); @@ -210,31 +210,31 @@ describe("fromSharedConfigFiles", () => { const loadedConfigData = { configFile: {}, credentialsFile: { - default: { region: "credentialsFileDefault" }, - foo: { region: "credentialsFileDefault" } + default: { max_attempts: "credentialsFileDefault" }, + foo: { max_attempts: "credentialsFileDefault" } } }; const loadedConfig = Promise.resolve(loadedConfigData); - it("returns region from designated profile when profile is defined", () => { + it("returns maxAttempts from designated profile when profile is defined", () => { const profile = "foo"; return expect( fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(loadedConfigData.credentialsFile[profile].region); + ).resolves.toBe(loadedConfigData.credentialsFile[profile].max_attempts); }); describe("when profile is not defined", () => { - it(`returns region from value in '${ENV_PROFILE}' env var if it is set`, () => { + it(`returns maxAttempts from value in '${ENV_PROFILE}' env var if it is set`, () => { const profile = "foo"; process.env[ENV_PROFILE] = profile; return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( - loadedConfigData.credentialsFile[profile].region + loadedConfigData.credentialsFile[profile].max_attempts ); }); - it(`returns region from default profile if '${ENV_PROFILE}' env var is not set`, () => { + it(`returns maxAttempts from default profile if '${ENV_PROFILE}' env var is not set`, () => { return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( - loadedConfigData.credentialsFile.default.region + loadedConfigData.credentialsFile.default.max_attempts ); }); }); diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.ts index 0742b81d6cd2..d6093af4095a 100644 --- a/packages/retry-config-provider/src/fromSharedConfigFiles.ts +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.ts @@ -32,13 +32,13 @@ export const fromSharedConfigFiles = ( const { configFile, credentialsFile } = await loadedConfig; for (let file of [credentialsFile, configFile]) { - const { region } = file[profile] || {}; - if (typeof region === "string") { - return region; + const { max_attempts } = file[profile] || {}; + if (typeof max_attempts === "string") { + return max_attempts; } } throw new ProviderError( - `No region found for profile ${profile} in SDK configuration files` + `No max_attempts value found for profile ${profile} in SDK configuration files` ); }; From 482e3413170cded9756b30fabe43194caccbf318 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 03:21:50 +0000 Subject: [PATCH 08/13] chore: search for config only in config file --- .../src/fromSharedConfigFiles.spec.ts | 132 +++++------------- .../src/fromSharedConfigFiles.ts | 10 +- 2 files changed, 36 insertions(+), 106 deletions(-) diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts index f20b1ddbb044..b9230291e657 100644 --- a/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts @@ -82,59 +82,25 @@ describe("fromSharedConfigFiles", () => { ]; describe("uses the shared ini file loader if pre-loaded config is not supplied", () => { - describe("when config file is empty", () => { - loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { - it(`${message} from credentials file`, () => { - (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ - configFile: {}, - credentialsFile: iniDataToReturn - }); - return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( - maxAttemptsToVerify - ); + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { + it(`${message} from config file`, () => { + (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ + configFile: iniDataToReturn, + credentialsFile: {} }); - } - ); - }); - - describe("when credentials file is empty", () => { - loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { - it(`${message} from config file`, () => { - (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ - configFile: iniDataToReturn, - credentialsFile: {} - }); - return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( - maxAttemptsToVerify - ); - }); - } - ); - }); - - describe("prefer credentials file if both not empty", () => { - loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { - it(`${message} from credentials file`, () => { - (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ - configFile: getIniDataWithAnswersRemoved(iniDataToReturn), - credentialsFile: iniDataToReturn - }); - return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( - maxAttemptsToVerify - ); - }); - } - ); - }); + return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( + maxAttemptsToVerify + ); + }); + } + ); loadedConfigRejects.forEach(({ message, iniDataToReturn, profile }) => { it(message, () => { (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ - configFile: {}, - credentialsFile: iniDataToReturn + configFile: iniDataToReturn, + credentialsFile: {} }); return expect( fromSharedConfigFiles({ profile })() @@ -144,53 +110,19 @@ describe("fromSharedConfigFiles", () => { }); describe("uses pre-loaded config if supplied", () => { - describe("when config file is empty", () => { - loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { - it(`${message} from credentials file`, () => { - const loadedConfig = Promise.resolve({ - configFile: {}, - credentialsFile: iniDataToReturn - }); - return expect( - fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(maxAttemptsToVerify); + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { + it(`${message} from config file`, () => { + const loadedConfig = Promise.resolve({ + configFile: iniDataToReturn, + credentialsFile: {} }); - } - ); - }); - - describe("when credentials file is empty", () => { - loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { - it(`${message} from config file`, () => { - const loadedConfig = Promise.resolve({ - configFile: iniDataToReturn, - credentialsFile: {} - }); - return expect( - fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(maxAttemptsToVerify); - }); - } - ); - }); - - describe("prefer credentials file if both not empty", () => { - loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { - it(`${message} from config file`, () => { - const loadedConfig = Promise.resolve({ - configFile: getIniDataWithAnswersRemoved(iniDataToReturn), - credentialsFile: iniDataToReturn - }); - return expect( - fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(maxAttemptsToVerify); - }); - } - ); - }); + return expect( + fromSharedConfigFiles({ loadedConfig, profile })() + ).resolves.toBe(maxAttemptsToVerify); + }); + } + ); loadedConfigRejects.forEach(({ message, iniDataToReturn, profile }) => { it(message, () => { @@ -208,11 +140,11 @@ describe("fromSharedConfigFiles", () => { describe("profile", () => { const loadedConfigData = { - configFile: {}, - credentialsFile: { + configFile: { default: { max_attempts: "credentialsFileDefault" }, foo: { max_attempts: "credentialsFileDefault" } - } + }, + credentialsFile: {} }; const loadedConfig = Promise.resolve(loadedConfigData); @@ -220,7 +152,7 @@ describe("fromSharedConfigFiles", () => { const profile = "foo"; return expect( fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(loadedConfigData.credentialsFile[profile].max_attempts); + ).resolves.toBe(loadedConfigData.configFile[profile].max_attempts); }); describe("when profile is not defined", () => { @@ -228,13 +160,13 @@ describe("fromSharedConfigFiles", () => { const profile = "foo"; process.env[ENV_PROFILE] = profile; return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( - loadedConfigData.credentialsFile[profile].max_attempts + loadedConfigData.configFile[profile].max_attempts ); }); it(`returns maxAttempts from default profile if '${ENV_PROFILE}' env var is not set`, () => { return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( - loadedConfigData.credentialsFile.default.max_attempts + loadedConfigData.configFile.default.max_attempts ); }); }); diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.ts index d6093af4095a..832e1d7668ef 100644 --- a/packages/retry-config-provider/src/fromSharedConfigFiles.ts +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.ts @@ -30,12 +30,10 @@ export const fromSharedConfigFiles = ( profile = process.env[ENV_PROFILE] || DEFAULT_PROFILE } = init; - const { configFile, credentialsFile } = await loadedConfig; - for (let file of [credentialsFile, configFile]) { - const { max_attempts } = file[profile] || {}; - if (typeof max_attempts === "string") { - return max_attempts; - } + const { configFile } = await loadedConfig; + const { max_attempts } = configFile[profile] || {}; + if (typeof max_attempts === "string") { + return max_attempts; } throw new ProviderError( From 92a987ef1b501b506ef4c6667bb6728159a03e70 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 03:30:59 +0000 Subject: [PATCH 09/13] chore: rename defaultProvider to maxAttemptsProvider --- packages/retry-config-provider/src/index.ts | 4 +--- ...ultProvider.spec.ts => maxAttemptsProvider.spec.ts} | 10 +++++----- .../src/{defaultProvider.ts => maxAttemptsProvider.ts} | 2 +- 3 files changed, 7 insertions(+), 9 deletions(-) rename packages/retry-config-provider/src/{defaultProvider.spec.ts => maxAttemptsProvider.spec.ts} (87%) rename packages/retry-config-provider/src/{defaultProvider.ts => maxAttemptsProvider.ts} (90%) diff --git a/packages/retry-config-provider/src/index.ts b/packages/retry-config-provider/src/index.ts index 6c7eb3151a90..5fe9c7f5111a 100644 --- a/packages/retry-config-provider/src/index.ts +++ b/packages/retry-config-provider/src/index.ts @@ -1,3 +1 @@ -export * from "./defaultProvider"; -export * from "./fromEnv"; -export * from "./fromSharedConfigFiles"; +export * from "./maxAttemptsProvider"; diff --git a/packages/retry-config-provider/src/defaultProvider.spec.ts b/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts similarity index 87% rename from packages/retry-config-provider/src/defaultProvider.spec.ts rename to packages/retry-config-provider/src/maxAttemptsProvider.spec.ts index ba7781cd8c19..147b7e9f9dbf 100644 --- a/packages/retry-config-provider/src/defaultProvider.spec.ts +++ b/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts @@ -4,7 +4,7 @@ import { SharedConfigInit } from "./fromSharedConfigFiles"; import { chain, memoize } from "@aws-sdk/property-provider"; -import { defaultProvider } from "./defaultProvider"; +import { maxAttemptsProvider } from "./maxAttemptsProvider"; jest.mock("./fromEnv", () => ({ fromEnv: jest.fn() @@ -19,7 +19,7 @@ jest.mock("@aws-sdk/property-provider", () => ({ memoize: jest.fn() })); -describe("defaultProvider", () => { +describe("maxAttemptsProvider", () => { const configuration: SharedConfigInit = { profile: "profile" }; @@ -37,7 +37,7 @@ describe("defaultProvider", () => { mockFromSharedConfigFilesReturn ); - defaultProvider(configuration); + maxAttemptsProvider(configuration); expect(fromEnv).toHaveBeenCalledTimes(1); expect(fromSharedConfigFiles).toHaveBeenCalledTimes(1); @@ -54,7 +54,7 @@ describe("defaultProvider", () => { const mockChainReturn = "mockChainReturn"; (chain as jest.Mock).mockReturnValueOnce(mockChainReturn); - defaultProvider(configuration); + maxAttemptsProvider(configuration); expect(chain).toHaveBeenCalledTimes(1); expect(memoize).toHaveBeenCalledTimes(1); @@ -65,6 +65,6 @@ describe("defaultProvider", () => { const mockMemoizeReturn = "mockMemoizeReturn"; (memoize as jest.Mock).mockReturnValueOnce(mockMemoizeReturn); - expect(defaultProvider(configuration)).toEqual(mockMemoizeReturn); + expect(maxAttemptsProvider(configuration)).toEqual(mockMemoizeReturn); }); }); diff --git a/packages/retry-config-provider/src/defaultProvider.ts b/packages/retry-config-provider/src/maxAttemptsProvider.ts similarity index 90% rename from packages/retry-config-provider/src/defaultProvider.ts rename to packages/retry-config-provider/src/maxAttemptsProvider.ts index f06feb01db14..231406bf6e8e 100644 --- a/packages/retry-config-provider/src/defaultProvider.ts +++ b/packages/retry-config-provider/src/maxAttemptsProvider.ts @@ -6,7 +6,7 @@ import { import { chain, memoize } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; -export const defaultProvider = ( +export const maxAttemptsProvider = ( configuration: SharedConfigInit = {} ): Provider => memoize(chain(fromEnv(), fromSharedConfigFiles(configuration))); From 3e4f7c0c2e30e74340d3fc8e4e5e9486950bcd9d Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 03:46:29 +0000 Subject: [PATCH 10/13] chore: pass environment variable name to fromEnv --- .../retry-config-provider/src/fromEnv.spec.ts | 23 ++++++++++--------- packages/retry-config-provider/src/fromEnv.ts | 12 ++++------ .../src/maxAttemptsProvider.spec.ts | 3 ++- .../src/maxAttemptsProvider.ts | 6 ++++- 4 files changed, 24 insertions(+), 20 deletions(-) diff --git a/packages/retry-config-provider/src/fromEnv.spec.ts b/packages/retry-config-provider/src/fromEnv.spec.ts index 5364597f7ba4..363e5380c5e1 100644 --- a/packages/retry-config-provider/src/fromEnv.spec.ts +++ b/packages/retry-config-provider/src/fromEnv.spec.ts @@ -1,9 +1,10 @@ -import { fromEnv, ENV_MAX_ATTEMPTS } from "./fromEnv"; +import { fromEnv } from "./fromEnv"; import { ProviderError } from "@aws-sdk/property-provider"; describe("fromEnv", () => { - const envRegion = process.env[ENV_MAX_ATTEMPTS]; - const mockEnvMaxAttempts = "mockEnvMaxAttempts"; + const envVarName = "ENV_VAR_NAME"; + const envVarValue = process.env[envVarName]; + const mockEnvVarValue = "mockEnvVarValue"; const getProviderError = (envVarName: string) => new ProviderError( @@ -11,21 +12,21 @@ describe("fromEnv", () => { ); beforeEach(() => { - delete process.env[ENV_MAX_ATTEMPTS]; + delete process.env[envVarName]; }); afterAll(() => { - process.env[ENV_MAX_ATTEMPTS] = envRegion; + process.env[envVarName] = envVarValue; }); - it(`returns value in '${ENV_MAX_ATTEMPTS}' env var when set`, () => { - process.env[ENV_MAX_ATTEMPTS] = mockEnvMaxAttempts; - return expect(fromEnv()()).resolves.toBe(mockEnvMaxAttempts); + it(`returns value in '${envVarName}' env var when set`, () => { + process.env[envVarName] = mockEnvVarValue; + return expect(fromEnv(envVarName)()).resolves.toBe(mockEnvVarValue); }); - it(`throws when '${ENV_MAX_ATTEMPTS}' env var is not set`, () => { - return expect(fromEnv()()).rejects.toMatchObject( - getProviderError(ENV_MAX_ATTEMPTS) + it(`throws when '${envVarName}' env var is not set`, () => { + return expect(fromEnv(envVarName)()).rejects.toMatchObject( + getProviderError(envVarName) ); }); }); diff --git a/packages/retry-config-provider/src/fromEnv.ts b/packages/retry-config-provider/src/fromEnv.ts index 47d18dd944f1..7bdb8d8afa66 100644 --- a/packages/retry-config-provider/src/fromEnv.ts +++ b/packages/retry-config-provider/src/fromEnv.ts @@ -1,15 +1,13 @@ import { ProviderError } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; -export const ENV_MAX_ATTEMPTS = "AWS_MAX_ATTEMPTS"; - -export const fromEnv = (): Provider => async () => { - const envRegion = process.env[ENV_MAX_ATTEMPTS]; - if (envRegion) { - return envRegion; +export const fromEnv = (envVarName: string): Provider => async () => { + const envVar = process.env[envVarName]; + if (envVar) { + return envVar; } throw new ProviderError( - `No value defined for the ${ENV_MAX_ATTEMPTS} environment variable` + `No value defined for the ${envVarName} environment variable` ); }; diff --git a/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts b/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts index 147b7e9f9dbf..5d30d32780fc 100644 --- a/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts +++ b/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts @@ -4,7 +4,7 @@ import { SharedConfigInit } from "./fromSharedConfigFiles"; import { chain, memoize } from "@aws-sdk/property-provider"; -import { maxAttemptsProvider } from "./maxAttemptsProvider"; +import { maxAttemptsProvider, ENV_MAX_ATTEMPTS } from "./maxAttemptsProvider"; jest.mock("./fromEnv", () => ({ fromEnv: jest.fn() @@ -40,6 +40,7 @@ describe("maxAttemptsProvider", () => { maxAttemptsProvider(configuration); expect(fromEnv).toHaveBeenCalledTimes(1); + expect(fromEnv).toHaveBeenCalledWith(ENV_MAX_ATTEMPTS); expect(fromSharedConfigFiles).toHaveBeenCalledTimes(1); expect(fromSharedConfigFiles).toHaveBeenCalledWith(configuration); diff --git a/packages/retry-config-provider/src/maxAttemptsProvider.ts b/packages/retry-config-provider/src/maxAttemptsProvider.ts index 231406bf6e8e..99160d035650 100644 --- a/packages/retry-config-provider/src/maxAttemptsProvider.ts +++ b/packages/retry-config-provider/src/maxAttemptsProvider.ts @@ -6,7 +6,11 @@ import { import { chain, memoize } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; +export const ENV_MAX_ATTEMPTS = "AWS_MAX_ATTEMPTS"; + export const maxAttemptsProvider = ( configuration: SharedConfigInit = {} ): Provider => - memoize(chain(fromEnv(), fromSharedConfigFiles(configuration))); + memoize( + chain(fromEnv(ENV_MAX_ATTEMPTS), fromSharedConfigFiles(configuration)) + ); From 1eae0e143d5b43052ffcb0e983f5838c55b04bf4 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 04:02:00 +0000 Subject: [PATCH 11/13] chore: pass config key to fromSharedConfigFiles --- .../src/fromSharedConfigFiles.spec.ts | 79 +++++++++---------- .../src/fromSharedConfigFiles.ts | 11 +-- .../src/maxAttemptsProvider.spec.ts | 11 ++- .../src/maxAttemptsProvider.ts | 6 +- 4 files changed, 56 insertions(+), 51 deletions(-) diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts index b9230291e657..5ff19b1c9a91 100644 --- a/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts @@ -11,6 +11,7 @@ jest.mock("@aws-sdk/shared-ini-file-loader", () => ({ describe("fromSharedConfigFiles", () => { const envProfile = process.env[ENV_PROFILE]; + const configKey = "config_key"; beforeEach(() => { delete process.env[ENV_PROFILE]; @@ -22,20 +23,12 @@ describe("fromSharedConfigFiles", () => { const getProviderError = (profile: string) => new ProviderError( - `No max_attempts value found for profile ${profile} in SDK configuration files` + `No ${configKey} found for profile ${profile} in SDK configuration files` ); describe("loadedConfig", () => { - const mockMaxAttemptsAnswer = "mockMaxAttemptsAnswer"; - const mockMaxAttmeptsNotAnswer = "mockMaxAttmeptsNotAnswer"; - const getIniDataWithAnswersRemoved = (iniData: ParsedIniData) => - Object.keys(iniData).reduce( - (acc, key) => ({ - [key]: { max_attempts: mockMaxAttmeptsNotAnswer }, - ...acc - }), - {} - ); + const mockConfigAnswer = "mockConfigAnswer"; + const mockConfigNotAnswer = "mockConfigNotAnswer"; type loadedConfigTestData = { message: string; @@ -44,22 +37,22 @@ describe("fromSharedConfigFiles", () => { }; const loadedConfigResolves: (loadedConfigTestData & { - maxAttemptsToVerify: string; + configValueToVerify: string; })[] = [ { - message: "returns maxAttempts from default profile", + message: "returns configValue from default profile", iniDataToReturn: { - default: { max_attempts: mockMaxAttemptsAnswer } + default: { [configKey]: mockConfigAnswer } }, - maxAttemptsToVerify: mockMaxAttemptsAnswer + configValueToVerify: mockConfigAnswer }, { - message: "returns maxAttempts from designated profile", + message: "returns configValue from designated profile", iniDataToReturn: { - default: { max_attempts: mockMaxAttmeptsNotAnswer }, - foo: { max_attempts: mockMaxAttemptsAnswer } + default: { [configKey]: mockConfigNotAnswer }, + foo: { [configKey]: mockConfigAnswer } }, - maxAttemptsToVerify: mockMaxAttemptsAnswer, + configValueToVerify: mockConfigAnswer, profile: "foo" } ]; @@ -69,13 +62,13 @@ describe("fromSharedConfigFiles", () => { message: "rejects if default profile is not present and profile value is not passed", iniDataToReturn: { - foo: { max_attempts: mockMaxAttmeptsNotAnswer } + foo: { [configKey]: mockConfigNotAnswer } } }, { message: "rejects if designated profile is not present", iniDataToReturn: { - default: { max_attempts: mockMaxAttmeptsNotAnswer } + default: { [configKey]: mockConfigNotAnswer } }, profile: "foo" } @@ -83,15 +76,15 @@ describe("fromSharedConfigFiles", () => { describe("uses the shared ini file loader if pre-loaded config is not supplied", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { + ({ message, iniDataToReturn, configValueToVerify, profile }) => { it(`${message} from config file`, () => { (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ configFile: iniDataToReturn, credentialsFile: {} }); - return expect(fromSharedConfigFiles({ profile })()).resolves.toBe( - maxAttemptsToVerify - ); + return expect( + fromSharedConfigFiles({ profile }, configKey)() + ).resolves.toBe(configValueToVerify); }); } ); @@ -103,7 +96,7 @@ describe("fromSharedConfigFiles", () => { credentialsFile: {} }); return expect( - fromSharedConfigFiles({ profile })() + fromSharedConfigFiles({ profile }, configKey)() ).rejects.toMatchObject(getProviderError(profile ?? "default")); }); }); @@ -111,15 +104,15 @@ describe("fromSharedConfigFiles", () => { describe("uses pre-loaded config if supplied", () => { loadedConfigResolves.forEach( - ({ message, iniDataToReturn, maxAttemptsToVerify, profile }) => { + ({ message, iniDataToReturn, configValueToVerify, profile }) => { it(`${message} from config file`, () => { const loadedConfig = Promise.resolve({ configFile: iniDataToReturn, credentialsFile: {} }); return expect( - fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(maxAttemptsToVerify); + fromSharedConfigFiles({ loadedConfig, profile }, configKey)() + ).resolves.toBe(configValueToVerify); }); } ); @@ -131,7 +124,7 @@ describe("fromSharedConfigFiles", () => { credentialsFile: iniDataToReturn }); return expect( - fromSharedConfigFiles({ loadedConfig, profile })() + fromSharedConfigFiles({ loadedConfig, profile }, configKey)() ).rejects.toMatchObject(getProviderError(profile ?? "default")); }); }); @@ -141,33 +134,33 @@ describe("fromSharedConfigFiles", () => { describe("profile", () => { const loadedConfigData = { configFile: { - default: { max_attempts: "credentialsFileDefault" }, - foo: { max_attempts: "credentialsFileDefault" } + default: { [configKey]: "credentialsFileDefault" }, + foo: { [configKey]: "credentialsFileDefault" } }, credentialsFile: {} }; const loadedConfig = Promise.resolve(loadedConfigData); - it("returns maxAttempts from designated profile when profile is defined", () => { + it("returns configValue from designated profile when profile is defined", () => { const profile = "foo"; return expect( - fromSharedConfigFiles({ loadedConfig, profile })() - ).resolves.toBe(loadedConfigData.configFile[profile].max_attempts); + fromSharedConfigFiles({ loadedConfig, profile }, configKey)() + ).resolves.toBe(loadedConfigData.configFile[profile][configKey]); }); describe("when profile is not defined", () => { - it(`returns maxAttempts from value in '${ENV_PROFILE}' env var if it is set`, () => { + it(`returns configValue from value in '${ENV_PROFILE}' env var if it is set`, () => { const profile = "foo"; process.env[ENV_PROFILE] = profile; - return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( - loadedConfigData.configFile[profile].max_attempts - ); + return expect( + fromSharedConfigFiles({ loadedConfig }, configKey)() + ).resolves.toBe(loadedConfigData.configFile[profile][configKey]); }); - it(`returns maxAttempts from default profile if '${ENV_PROFILE}' env var is not set`, () => { - return expect(fromSharedConfigFiles({ loadedConfig })()).resolves.toBe( - loadedConfigData.configFile.default.max_attempts - ); + it(`returns configValue from default profile if '${ENV_PROFILE}' env var is not set`, () => { + return expect( + fromSharedConfigFiles({ loadedConfig }, configKey)() + ).resolves.toBe(loadedConfigData.configFile.default[configKey]); }); }); }); diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.ts index 832e1d7668ef..f2f0f00fd8c0 100644 --- a/packages/retry-config-provider/src/fromSharedConfigFiles.ts +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.ts @@ -23,7 +23,8 @@ export interface SharedConfigInit extends BaseSharedConfigInit { } export const fromSharedConfigFiles = ( - init: SharedConfigInit = {} + init: SharedConfigInit = {}, + configKey: string ): Provider => async () => { const { loadedConfig = loadSharedConfigFiles(init), @@ -31,12 +32,12 @@ export const fromSharedConfigFiles = ( } = init; const { configFile } = await loadedConfig; - const { max_attempts } = configFile[profile] || {}; - if (typeof max_attempts === "string") { - return max_attempts; + const { [configKey]: configValue } = configFile[profile] || {}; + if (typeof configValue === "string") { + return configValue; } throw new ProviderError( - `No max_attempts value found for profile ${profile} in SDK configuration files` + `No ${configKey} found for profile ${profile} in SDK configuration files` ); }; diff --git a/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts b/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts index 5d30d32780fc..6db39aa96bc7 100644 --- a/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts +++ b/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts @@ -4,7 +4,11 @@ import { SharedConfigInit } from "./fromSharedConfigFiles"; import { chain, memoize } from "@aws-sdk/property-provider"; -import { maxAttemptsProvider, ENV_MAX_ATTEMPTS } from "./maxAttemptsProvider"; +import { + maxAttemptsProvider, + ENV_MAX_ATTEMPTS, + CONFIG_MAX_ATTEMPTS +} from "./maxAttemptsProvider"; jest.mock("./fromEnv", () => ({ fromEnv: jest.fn() @@ -42,7 +46,10 @@ describe("maxAttemptsProvider", () => { expect(fromEnv).toHaveBeenCalledTimes(1); expect(fromEnv).toHaveBeenCalledWith(ENV_MAX_ATTEMPTS); expect(fromSharedConfigFiles).toHaveBeenCalledTimes(1); - expect(fromSharedConfigFiles).toHaveBeenCalledWith(configuration); + expect(fromSharedConfigFiles).toHaveBeenCalledWith( + configuration, + CONFIG_MAX_ATTEMPTS + ); expect(chain).toHaveBeenCalledTimes(1); expect(chain).toHaveBeenCalledWith( diff --git a/packages/retry-config-provider/src/maxAttemptsProvider.ts b/packages/retry-config-provider/src/maxAttemptsProvider.ts index 99160d035650..eba2bb27eadc 100644 --- a/packages/retry-config-provider/src/maxAttemptsProvider.ts +++ b/packages/retry-config-provider/src/maxAttemptsProvider.ts @@ -7,10 +7,14 @@ import { chain, memoize } from "@aws-sdk/property-provider"; import { Provider } from "@aws-sdk/types"; export const ENV_MAX_ATTEMPTS = "AWS_MAX_ATTEMPTS"; +export const CONFIG_MAX_ATTEMPTS = "max_attempts"; export const maxAttemptsProvider = ( configuration: SharedConfigInit = {} ): Provider => memoize( - chain(fromEnv(ENV_MAX_ATTEMPTS), fromSharedConfigFiles(configuration)) + chain( + fromEnv(ENV_MAX_ATTEMPTS), + fromSharedConfigFiles(configuration, CONFIG_MAX_ATTEMPTS) + ) ); From 69aac6f1d7e692667200627be97d8d5100cdd068 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 04:13:50 +0000 Subject: [PATCH 12/13] chore: add retryModeProvider --- .../src/defaultProvider.spec.ts | 95 +++++++++++++++++++ .../src/defaultProvider.ts | 32 +++++++ packages/retry-config-provider/src/index.ts | 2 +- .../src/maxAttemptsProvider.spec.ts | 78 --------------- .../src/maxAttemptsProvider.ts | 20 ---- 5 files changed, 128 insertions(+), 99 deletions(-) create mode 100644 packages/retry-config-provider/src/defaultProvider.spec.ts create mode 100644 packages/retry-config-provider/src/defaultProvider.ts delete mode 100644 packages/retry-config-provider/src/maxAttemptsProvider.spec.ts delete mode 100644 packages/retry-config-provider/src/maxAttemptsProvider.ts diff --git a/packages/retry-config-provider/src/defaultProvider.spec.ts b/packages/retry-config-provider/src/defaultProvider.spec.ts new file mode 100644 index 000000000000..e882ed462fa9 --- /dev/null +++ b/packages/retry-config-provider/src/defaultProvider.spec.ts @@ -0,0 +1,95 @@ +import { fromEnv } from "./fromEnv"; +import { + fromSharedConfigFiles, + SharedConfigInit +} from "./fromSharedConfigFiles"; +import { chain, memoize } from "@aws-sdk/property-provider"; +import { + maxAttemptsProvider, + ENV_MAX_ATTEMPTS, + CONFIG_MAX_ATTEMPTS, + retryModeProvider, + ENV_RETRY_MODE, + CONFIG_RETRY_MODE +} from "./defaultProvider"; + +jest.mock("./fromEnv", () => ({ + fromEnv: jest.fn() +})); + +jest.mock("./fromSharedConfigFiles", () => ({ + fromSharedConfigFiles: jest.fn() +})); + +jest.mock("@aws-sdk/property-provider", () => ({ + chain: jest.fn(), + memoize: jest.fn() +})); + +describe("defaultProvider", () => { + const configuration: SharedConfigInit = { + profile: "profile" + }; + + afterEach(() => { + jest.clearAllMocks(); + }); + + const testProvider = ( + providerFunc: Function, + envVarName: string, + configKey: string + ) => { + it("passes fromEnv() and fromSharedConfigFiles() to chain", () => { + const mockFromEnvReturn = "mockFromEnvReturn"; + (fromEnv as jest.Mock).mockReturnValueOnce(mockFromEnvReturn); + + const mockFromSharedConfigFilesReturn = "mockFromSharedConfigFilesReturn"; + (fromSharedConfigFiles as jest.Mock).mockReturnValueOnce( + mockFromSharedConfigFilesReturn + ); + + providerFunc(configuration); + + expect(fromEnv).toHaveBeenCalledTimes(1); + expect(fromEnv).toHaveBeenCalledWith(envVarName); + expect(fromSharedConfigFiles).toHaveBeenCalledTimes(1); + expect(fromSharedConfigFiles).toHaveBeenCalledWith( + configuration, + configKey + ); + + expect(chain).toHaveBeenCalledTimes(1); + expect(chain).toHaveBeenCalledWith( + mockFromEnvReturn, + mockFromSharedConfigFilesReturn + ); + }); + + it("passes output of chain to memoize", () => { + const mockChainReturn = "mockChainReturn"; + (chain as jest.Mock).mockReturnValueOnce(mockChainReturn); + + providerFunc(configuration); + + expect(chain).toHaveBeenCalledTimes(1); + expect(memoize).toHaveBeenCalledTimes(1); + expect(memoize).toHaveBeenCalledWith(mockChainReturn); + }); + + it("returns output memoize", () => { + const mockMemoizeReturn = "mockMemoizeReturn"; + (memoize as jest.Mock).mockReturnValueOnce(mockMemoizeReturn); + + expect(providerFunc(configuration)).toEqual(mockMemoizeReturn); + }); + }; + + describe("maxAttemptsProvider", () => { + testProvider(maxAttemptsProvider, ENV_MAX_ATTEMPTS, CONFIG_MAX_ATTEMPTS); + }); + + describe("retryModeProvider", () => { + testProvider(retryModeProvider, ENV_RETRY_MODE, CONFIG_RETRY_MODE); + }); +}); diff --git a/packages/retry-config-provider/src/defaultProvider.ts b/packages/retry-config-provider/src/defaultProvider.ts new file mode 100644 index 000000000000..8bb6370374fd --- /dev/null +++ b/packages/retry-config-provider/src/defaultProvider.ts @@ -0,0 +1,32 @@ +import { fromEnv } from "./fromEnv"; +import { + SharedConfigInit, + fromSharedConfigFiles +} from "./fromSharedConfigFiles"; +import { chain, memoize } from "@aws-sdk/property-provider"; +import { Provider } from "@aws-sdk/types"; + +export const ENV_MAX_ATTEMPTS = "AWS_MAX_ATTEMPTS"; +export const CONFIG_MAX_ATTEMPTS = "max_attempts"; + +export const ENV_RETRY_MODE = "AWS_RETRY_MODE"; +export const CONFIG_RETRY_MODE = "retry_mode"; + +const defaultProvider = ( + configuration: SharedConfigInit = {}, + envVarName: string, + configKey: string +): Provider => + memoize( + chain(fromEnv(envVarName), fromSharedConfigFiles(configuration, configKey)) + ); + +export const maxAttemptsProvider = ( + configuration: SharedConfigInit = {} +): Provider => + defaultProvider(configuration, ENV_MAX_ATTEMPTS, CONFIG_MAX_ATTEMPTS); + +export const retryModeProvider = ( + configuration: SharedConfigInit = {} +): Provider => + defaultProvider(configuration, ENV_RETRY_MODE, CONFIG_RETRY_MODE); diff --git a/packages/retry-config-provider/src/index.ts b/packages/retry-config-provider/src/index.ts index 5fe9c7f5111a..c82818e53423 100644 --- a/packages/retry-config-provider/src/index.ts +++ b/packages/retry-config-provider/src/index.ts @@ -1 +1 @@ -export * from "./maxAttemptsProvider"; +export * from "./defaultProvider"; diff --git a/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts b/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts deleted file mode 100644 index 6db39aa96bc7..000000000000 --- a/packages/retry-config-provider/src/maxAttemptsProvider.spec.ts +++ /dev/null @@ -1,78 +0,0 @@ -import { fromEnv } from "./fromEnv"; -import { - fromSharedConfigFiles, - SharedConfigInit -} from "./fromSharedConfigFiles"; -import { chain, memoize } from "@aws-sdk/property-provider"; -import { - maxAttemptsProvider, - ENV_MAX_ATTEMPTS, - CONFIG_MAX_ATTEMPTS -} from "./maxAttemptsProvider"; - -jest.mock("./fromEnv", () => ({ - fromEnv: jest.fn() -})); - -jest.mock("./fromSharedConfigFiles", () => ({ - fromSharedConfigFiles: jest.fn() -})); - -jest.mock("@aws-sdk/property-provider", () => ({ - chain: jest.fn(), - memoize: jest.fn() -})); - -describe("maxAttemptsProvider", () => { - const configuration: SharedConfigInit = { - profile: "profile" - }; - - afterEach(() => { - jest.clearAllMocks(); - }); - - it("passes fromEnv() and fromSharedConfigFiles() to chain", () => { - const mockFromEnvReturn = "mockFromEnvReturn"; - (fromEnv as jest.Mock).mockReturnValueOnce(mockFromEnvReturn); - - const mockFromSharedConfigFilesReturn = "mockFromSharedConfigFilesReturn"; - (fromSharedConfigFiles as jest.Mock).mockReturnValueOnce( - mockFromSharedConfigFilesReturn - ); - - maxAttemptsProvider(configuration); - - expect(fromEnv).toHaveBeenCalledTimes(1); - expect(fromEnv).toHaveBeenCalledWith(ENV_MAX_ATTEMPTS); - expect(fromSharedConfigFiles).toHaveBeenCalledTimes(1); - expect(fromSharedConfigFiles).toHaveBeenCalledWith( - configuration, - CONFIG_MAX_ATTEMPTS - ); - - expect(chain).toHaveBeenCalledTimes(1); - expect(chain).toHaveBeenCalledWith( - mockFromEnvReturn, - mockFromSharedConfigFilesReturn - ); - }); - - it("passes output of chain to memoize", () => { - const mockChainReturn = "mockChainReturn"; - (chain as jest.Mock).mockReturnValueOnce(mockChainReturn); - - maxAttemptsProvider(configuration); - - expect(chain).toHaveBeenCalledTimes(1); - expect(memoize).toHaveBeenCalledTimes(1); - expect(memoize).toHaveBeenCalledWith(mockChainReturn); - }); - - it("returns output memoize", () => { - const mockMemoizeReturn = "mockMemoizeReturn"; - (memoize as jest.Mock).mockReturnValueOnce(mockMemoizeReturn); - - expect(maxAttemptsProvider(configuration)).toEqual(mockMemoizeReturn); - }); -}); diff --git a/packages/retry-config-provider/src/maxAttemptsProvider.ts b/packages/retry-config-provider/src/maxAttemptsProvider.ts deleted file mode 100644 index eba2bb27eadc..000000000000 --- a/packages/retry-config-provider/src/maxAttemptsProvider.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { fromEnv } from "./fromEnv"; -import { - SharedConfigInit, - fromSharedConfigFiles -} from "./fromSharedConfigFiles"; -import { chain, memoize } from "@aws-sdk/property-provider"; -import { Provider } from "@aws-sdk/types"; - -export const ENV_MAX_ATTEMPTS = "AWS_MAX_ATTEMPTS"; -export const CONFIG_MAX_ATTEMPTS = "max_attempts"; - -export const maxAttemptsProvider = ( - configuration: SharedConfigInit = {} -): Provider => - memoize( - chain( - fromEnv(ENV_MAX_ATTEMPTS), - fromSharedConfigFiles(configuration, CONFIG_MAX_ATTEMPTS) - ) - ); From d6eecea853365279fff337e8b796f033ec252272 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 18 Jun 2020 09:53:17 -0700 Subject: [PATCH 13/13] chore: remove unnecessary Co-authored-by: Alexander Forsyth --- packages/retry-config-provider/src/fromSharedConfigFiles.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/retry-config-provider/src/fromSharedConfigFiles.ts b/packages/retry-config-provider/src/fromSharedConfigFiles.ts index f2f0f00fd8c0..c124d16b4fa7 100644 --- a/packages/retry-config-provider/src/fromSharedConfigFiles.ts +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.ts @@ -32,7 +32,7 @@ export const fromSharedConfigFiles = ( } = init; const { configFile } = await loadedConfig; - const { [configKey]: configValue } = configFile[profile] || {}; + const { [configKey]: configValue } = configFile[profile] || {}; if (typeof configValue === "string") { return configValue; }