Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/middleware-retry/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"license": "Apache-2.0",
"dependencies": {
"@aws-sdk/protocol-http": "1.0.0-gamma.1",
"@aws-sdk/retry-config-provider": "1.0.0-gamma.0",
"@aws-sdk/service-error-classification": "1.0.0-gamma.1",
"@aws-sdk/types": "1.0.0-gamma.1",
"react-native-get-random-values": "^1.4.0",
Expand Down
9 changes: 4 additions & 5 deletions packages/middleware-retry/src/defaultStrategy.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { StandardRetryStrategy, RetryQuota } from "./defaultStrategy";
import { getDefaultRetryQuota } from "./defaultRetryQuota";
import { HttpRequest } from "@aws-sdk/protocol-http";
import { v4 } from "uuid";
import { DEFAULT_MAX_ATTEMPTS } from "@aws-sdk/retry-config-provider";

jest.mock("@aws-sdk/service-error-classification", () => ({
isThrottlingError: jest.fn().mockReturnValue(true)
Expand Down Expand Up @@ -616,15 +617,14 @@ describe("defaultStrategy", () => {
});
});

describe("defaults maxAttempts to 3", () => {
describe("defaults maxAttempts to DEFAULT_MAX_ATTEMPTS", () => {
it("when maxAttemptsProvider throws error", async () => {
const maxAttempts = 3;
const { isInstance } = HttpRequest;
((isInstance as unknown) as jest.Mock).mockReturnValue(true);

next = jest.fn(args => {
expect(args.request.headers["amz-sdk-request"]).toBe(
`attempt=1; max=${maxAttempts}`
`attempt=1; max=${DEFAULT_MAX_ATTEMPTS}`
);
return Promise.resolve({
response: "mockResponse",
Expand All @@ -642,13 +642,12 @@ describe("defaultStrategy", () => {
});

it("when parseInt fails on maxAttemptsProvider", async () => {
const maxAttempts = 3;
const { isInstance } = HttpRequest;
((isInstance as unknown) as jest.Mock).mockReturnValue(true);

next = jest.fn(args => {
expect(args.request.headers["amz-sdk-request"]).toBe(
`attempt=1; max=${maxAttempts}`
`attempt=1; max=${DEFAULT_MAX_ATTEMPTS}`
);
return Promise.resolve({
response: "mockResponse",
Expand Down
9 changes: 6 additions & 3 deletions packages/middleware-retry/src/defaultStrategy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
import { getDefaultRetryQuota } from "./defaultRetryQuota";
import { HttpRequest } from "@aws-sdk/protocol-http";
import { v4 } from "uuid";
import { DEFAULT_MAX_ATTEMPTS } from "@aws-sdk/retry-config-provider";

/**
* Determines whether an error is retryable based on the number of retries
Expand Down Expand Up @@ -92,14 +93,16 @@ export class StandardRetryStrategy implements RetryStrategy {
}

private async getMaxAttempts() {
let maxAttemptsStr;
let maxAttemptsStr: string;
try {
maxAttemptsStr = await this.maxAttemptsProvider();
} catch (error) {
maxAttemptsStr = "3";
maxAttemptsStr = DEFAULT_MAX_ATTEMPTS;
}
const maxAttempts = parseInt(maxAttemptsStr);
return Number.isNaN(maxAttempts) ? 3 : maxAttempts;
return Number.isNaN(maxAttempts)
? parseInt(DEFAULT_MAX_ATTEMPTS)
: maxAttempts;
}

async retry<Input extends object, Ouput extends MetadataBearer>(
Expand Down
48 changes: 29 additions & 19 deletions packages/retry-config-provider/src/defaultProvider.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,21 @@ import {
fromSharedConfigFiles,
SharedConfigInit
} from "./fromSharedConfigFiles";
import { chain, memoize } from "@aws-sdk/property-provider";
import { chain, memoize, fromStatic } from "@aws-sdk/property-provider";
import {
maxAttemptsProvider,
ENV_MAX_ATTEMPTS,
CONFIG_MAX_ATTEMPTS,
DEFAULT_MAX_ATTEMPTS,
retryModeProvider,
ENV_RETRY_MODE,
CONFIG_RETRY_MODE
CONFIG_RETRY_MODE,
DEFAULT_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()
}));
jest.mock("./fromEnv");
jest.mock("./fromSharedConfigFiles");
jest.mock("@aws-sdk/property-provider");

describe("defaultProvider", () => {
const configuration: SharedConfigInit = {
Expand All @@ -38,9 +31,10 @@ describe("defaultProvider", () => {
const testProvider = (
providerFunc: Function,
envVarName: string,
configKey: string
configKey: string,
defaultValue: string
) => {
it("passes fromEnv() and fromSharedConfigFiles() to chain", () => {
it("passes fromEnv(), fromSharedConfigFiles() and fromStatic() to chain", () => {
const mockFromEnvReturn = "mockFromEnvReturn";
(fromEnv as jest.Mock).mockReturnValueOnce(mockFromEnvReturn);

Expand All @@ -49,6 +43,9 @@ describe("defaultProvider", () => {
mockFromSharedConfigFilesReturn
);

const mockFromStatic = "mockFromStatic";
(fromStatic as jest.Mock).mockReturnValueOnce(mockFromStatic);

providerFunc(configuration);

expect(fromEnv).toHaveBeenCalledTimes(1);
Expand All @@ -58,11 +55,14 @@ describe("defaultProvider", () => {
configuration,
configKey
);
expect(fromStatic).toHaveBeenCalledTimes(1);
expect(fromStatic).toHaveBeenCalledWith(defaultValue);

expect(chain).toHaveBeenCalledTimes(1);
expect(chain).toHaveBeenCalledWith(
mockFromEnvReturn,
mockFromSharedConfigFilesReturn
mockFromSharedConfigFilesReturn,
mockFromStatic
);
});

Expand All @@ -86,10 +86,20 @@ describe("defaultProvider", () => {
};

describe("maxAttemptsProvider", () => {
testProvider(maxAttemptsProvider, ENV_MAX_ATTEMPTS, CONFIG_MAX_ATTEMPTS);
testProvider(
maxAttemptsProvider,
ENV_MAX_ATTEMPTS,
CONFIG_MAX_ATTEMPTS,
DEFAULT_MAX_ATTEMPTS
);
});

describe("retryModeProvider", () => {
testProvider(retryModeProvider, ENV_RETRY_MODE, CONFIG_RETRY_MODE);
testProvider(
retryModeProvider,
ENV_RETRY_MODE,
CONFIG_RETRY_MODE,
DEFAULT_RETRY_MODE
);
});
});
33 changes: 27 additions & 6 deletions packages/retry-config-provider/src/defaultProvider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,51 @@ import {
SharedConfigInit,
fromSharedConfigFiles
} from "./fromSharedConfigFiles";
import { chain, memoize } from "@aws-sdk/property-provider";
import { chain, memoize, fromStatic } 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 DEFAULT_MAX_ATTEMPTS = "3";

export const ENV_RETRY_MODE = "AWS_RETRY_MODE";
export const CONFIG_RETRY_MODE = "retry_mode";
export const DEFAULT_RETRY_MODE = "standard";

const defaultProvider = (
configuration: SharedConfigInit = {},
envVarName: string,
configKey: string
{
envVarName,
configKey,
defaultValue
}: {
envVarName: string;
configKey: string;
defaultValue: string;
}
): Provider<string> =>
memoize(
chain(fromEnv(envVarName), fromSharedConfigFiles(configuration, configKey))
chain(
fromEnv(envVarName),
fromSharedConfigFiles(configuration, configKey),
fromStatic(defaultValue)
)
);

export const maxAttemptsProvider = (
configuration: SharedConfigInit = {}
): Provider<string> =>
defaultProvider(configuration, ENV_MAX_ATTEMPTS, CONFIG_MAX_ATTEMPTS);
defaultProvider(configuration, {
envVarName: ENV_MAX_ATTEMPTS,
configKey: CONFIG_MAX_ATTEMPTS,
defaultValue: DEFAULT_MAX_ATTEMPTS
});

export const retryModeProvider = (
configuration: SharedConfigInit = {}
): Provider<string> =>
defaultProvider(configuration, ENV_RETRY_MODE, CONFIG_RETRY_MODE);
defaultProvider(configuration, {
envVarName: ENV_RETRY_MODE,
configKey: CONFIG_RETRY_MODE,
defaultValue: DEFAULT_RETRY_MODE
});