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..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/fromEnv.spec.ts b/packages/retry-config-provider/src/fromEnv.spec.ts new file mode 100644 index 000000000000..363e5380c5e1 --- /dev/null +++ b/packages/retry-config-provider/src/fromEnv.spec.ts @@ -0,0 +1,32 @@ +import { fromEnv } from "./fromEnv"; +import { ProviderError } from "@aws-sdk/property-provider"; + +describe("fromEnv", () => { + const envVarName = "ENV_VAR_NAME"; + const envVarValue = process.env[envVarName]; + const mockEnvVarValue = "mockEnvVarValue"; + + const getProviderError = (envVarName: string) => + new ProviderError( + `No value defined for the ${envVarName} environment variable` + ); + + beforeEach(() => { + delete process.env[envVarName]; + }); + + afterAll(() => { + process.env[envVarName] = envVarValue; + }); + + it(`returns value in '${envVarName}' env var when set`, () => { + process.env[envVarName] = mockEnvVarValue; + return expect(fromEnv(envVarName)()).resolves.toBe(mockEnvVarValue); + }); + + 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 new file mode 100644 index 000000000000..7bdb8d8afa66 --- /dev/null +++ b/packages/retry-config-provider/src/fromEnv.ts @@ -0,0 +1,13 @@ +import { ProviderError } from "@aws-sdk/property-provider"; +import { Provider } from "@aws-sdk/types"; + +export const fromEnv = (envVarName: string): Provider => async () => { + const envVar = process.env[envVarName]; + if (envVar) { + return envVar; + } + + throw new ProviderError( + `No value defined for the ${envVarName} 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..5ff19b1c9a91 --- /dev/null +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.spec.ts @@ -0,0 +1,167 @@ +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]; + const configKey = "config_key"; + + beforeEach(() => { + delete process.env[ENV_PROFILE]; + }); + + afterAll(() => { + process.env[ENV_PROFILE] = envProfile; + }); + + const getProviderError = (profile: string) => + new ProviderError( + `No ${configKey} found for profile ${profile} in SDK configuration files` + ); + + describe("loadedConfig", () => { + const mockConfigAnswer = "mockConfigAnswer"; + const mockConfigNotAnswer = "mockConfigNotAnswer"; + + type loadedConfigTestData = { + message: string; + iniDataToReturn: ParsedIniData; + profile?: string; + }; + + const loadedConfigResolves: (loadedConfigTestData & { + configValueToVerify: string; + })[] = [ + { + message: "returns configValue from default profile", + iniDataToReturn: { + default: { [configKey]: mockConfigAnswer } + }, + configValueToVerify: mockConfigAnswer + }, + { + message: "returns configValue from designated profile", + iniDataToReturn: { + default: { [configKey]: mockConfigNotAnswer }, + foo: { [configKey]: mockConfigAnswer } + }, + configValueToVerify: mockConfigAnswer, + profile: "foo" + } + ]; + + const loadedConfigRejects: loadedConfigTestData[] = [ + { + message: + "rejects if default profile is not present and profile value is not passed", + iniDataToReturn: { + foo: { [configKey]: mockConfigNotAnswer } + } + }, + { + message: "rejects if designated profile is not present", + iniDataToReturn: { + default: { [configKey]: mockConfigNotAnswer } + }, + profile: "foo" + } + ]; + + describe("uses the shared ini file loader if pre-loaded config is not supplied", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, configValueToVerify, profile }) => { + it(`${message} from config file`, () => { + (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ + configFile: iniDataToReturn, + credentialsFile: {} + }); + return expect( + fromSharedConfigFiles({ profile }, configKey)() + ).resolves.toBe(configValueToVerify); + }); + } + ); + + loadedConfigRejects.forEach(({ message, iniDataToReturn, profile }) => { + it(message, () => { + (loadSharedConfigFiles as jest.Mock).mockResolvedValueOnce({ + configFile: iniDataToReturn, + credentialsFile: {} + }); + return expect( + fromSharedConfigFiles({ profile }, configKey)() + ).rejects.toMatchObject(getProviderError(profile ?? "default")); + }); + }); + }); + + describe("uses pre-loaded config if supplied", () => { + loadedConfigResolves.forEach( + ({ message, iniDataToReturn, configValueToVerify, profile }) => { + it(`${message} from config file`, () => { + const loadedConfig = Promise.resolve({ + configFile: iniDataToReturn, + credentialsFile: {} + }); + return expect( + fromSharedConfigFiles({ loadedConfig, profile }, configKey)() + ).resolves.toBe(configValueToVerify); + }); + } + ); + + loadedConfigRejects.forEach(({ message, iniDataToReturn, profile }) => { + it(message, () => { + const loadedConfig = Promise.resolve({ + configFile: {}, + credentialsFile: iniDataToReturn + }); + return expect( + fromSharedConfigFiles({ loadedConfig, profile }, configKey)() + ).rejects.toMatchObject(getProviderError(profile ?? "default")); + }); + }); + }); + }); + + describe("profile", () => { + const loadedConfigData = { + configFile: { + default: { [configKey]: "credentialsFileDefault" }, + foo: { [configKey]: "credentialsFileDefault" } + }, + credentialsFile: {} + }; + const loadedConfig = Promise.resolve(loadedConfigData); + + it("returns configValue from designated profile when profile is defined", () => { + const profile = "foo"; + return expect( + fromSharedConfigFiles({ loadedConfig, profile }, configKey)() + ).resolves.toBe(loadedConfigData.configFile[profile][configKey]); + }); + + describe("when profile is not defined", () => { + 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 }, configKey)() + ).resolves.toBe(loadedConfigData.configFile[profile][configKey]); + }); + + 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 new file mode 100644 index 000000000000..c124d16b4fa7 --- /dev/null +++ b/packages/retry-config-provider/src/fromSharedConfigFiles.ts @@ -0,0 +1,43 @@ +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 = {}, + configKey: string +): Provider => async () => { + const { + loadedConfig = loadSharedConfigFiles(init), + profile = process.env[ENV_PROFILE] || DEFAULT_PROFILE + } = init; + + const { configFile } = await loadedConfig; + const { [configKey]: configValue } = configFile[profile] || {}; + if (typeof configValue === "string") { + return configValue; + } + + throw new ProviderError( + `No ${configKey} 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..c82818e53423 --- /dev/null +++ b/packages/retry-config-provider/src/index.ts @@ -0,0 +1 @@ +export * from "./defaultProvider"; 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 + } +}