Skip to content

Commit a2579b7

Browse files
srchasesrchase
authored
feat(utl-retry): add util-retry package and its types (#4224)
Author: Chase Coalwell <[email protected]>
1 parent 89598b6 commit a2579b7

24 files changed

+1661
-0
lines changed

‎packages/types/src/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export * from "./middleware";
1414
export * from "./pagination";
1515
export * from "./profile";
1616
export * from "./response";
17+
export * from "./retry";
1718
export * from "./serde";
1819
export * from "./shapes";
1920
export * from "./signature";

‎packages/types/src/retry.ts

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
export type RetryErrorType =
2+
/**
3+
* This is a connection level error such as a socket timeout, socket connect
4+
* error, tls negotiation timeout etc...
5+
* Typically these should never be applied for non-idempotent request types
6+
* since in this scenario, it's impossible to know whether the operation had
7+
* a side effect on the server.
8+
*/
9+
| "TRANSIENT"
10+
11+
/**
12+
* This is an error where the server explicitly told the client to back off,
13+
* such as a 429 or 503 Http error.
14+
*/
15+
| "THROTTLING"
16+
17+
/**
18+
* This is a server error that isn't explicitly throttling but is considered
19+
* by the client to be something that should be retried.
20+
*/
21+
| "SERVER_ERROR"
22+
23+
/**
24+
* Doesn't count against any budgets. This could be something like a 401
25+
* challenge in Http.
26+
*/
27+
| "CLIENT_ERROR";
28+
29+
export interface RetryErrorInfo {
30+
errorType: RetryErrorType;
31+
32+
/**
33+
* Protocol hint. This could come from Http's 'retry-after' header or
34+
* something from MQTT or any other protocol that has the ability to convey
35+
* retry info from a peer.
36+
*
37+
* @returns the Date after which a retry should be attempted.
38+
*/
39+
retryAfterHint?: Date;
40+
}
41+
42+
export interface RetryBackoffStrategy {
43+
/**
44+
* @returns the number of milliseconds to wait before retrying an action.
45+
*/
46+
computeNextBackoffDelay(retryAttempt: number): number;
47+
}
48+
49+
export interface StandardRetryBackoffStrategy extends RetryBackoffStrategy {
50+
/**
51+
* Sets the delayBase used to compute backoff delays.
52+
* @param delayBase
53+
*/
54+
setDelayBase(delayBase: number): void;
55+
}
56+
57+
export interface RetryStrategyOptions {
58+
backoffStrategy: RetryBackoffStrategy;
59+
60+
maxRetriesBase: number;
61+
}
62+
63+
export interface RetryToken {
64+
/**
65+
* @returns the current count of retry.
66+
*/
67+
getRetryCount(): number;
68+
69+
/**
70+
* @returns the number of milliseconds to wait before retrying an action.
71+
*/
72+
getRetryDelay(): number;
73+
}
74+
75+
export interface StandardRetryToken extends RetryToken {
76+
/**
77+
* @returns wheather token has remaining tokens.
78+
*/
79+
hasRetryTokens(errorType: RetryErrorType): boolean;
80+
81+
/**
82+
* @returns the number of available tokens.
83+
*/
84+
getRetryTokenCount(errorInfo: RetryErrorInfo): number;
85+
86+
/**
87+
* @returns the cost of the last retry attemp.
88+
*/
89+
getLastRetryCost(): number | undefined;
90+
91+
/**
92+
* Releases a number of tokens.
93+
*
94+
* @param amount of tokens to release.
95+
*/
96+
releaseRetryTokens(amount?: number): void;
97+
}
98+
99+
export interface RetryStrategyV2 {
100+
/**
101+
* Called before any retries (for the first call to the operation). It either
102+
* returns a retry token or an error upon the failure to acquire a token prior.
103+
*
104+
* tokenScope is arbitrary and out of scope for this component. However,
105+
* adding it here offers us a lot of future flexibility for outage detection.
106+
* For example, it could be "us-east-1" on a shared retry strategy, or
107+
* "us-west-2-c:dynamodb".
108+
*/
109+
acquireInitialRetryToken(retryTokenScope: string): Promise<RetryToken>;
110+
111+
/**
112+
* After a failed operation call, this function is invoked to refresh the
113+
* retryToken returned by acquireInitialRetryToken(). This function can
114+
* either choose to allow another retry and send a new or updated token,
115+
* or reject the retry attempt and report the error either in an exception
116+
* or returning an error.
117+
*/
118+
refreshRetryTokenForRetry(tokenToRenew: RetryToken, errorInfo: RetryErrorInfo): Promise<RetryToken>;
119+
120+
/**
121+
* Upon successful completion of the operation, a user calls this function
122+
* to record that the operation was successful.
123+
*/
124+
recordSuccess(token: RetryToken): void;
125+
}
126+
127+
export type ExponentialBackoffJitterType = "DEFAULT" | "NONE" | "FULL" | "DECORRELATED";
128+
129+
export interface ExponentialBackoffStrategyOptions {
130+
jitterType: ExponentialBackoffJitterType;
131+
132+
/* Scaling factor to add for the backoff in milliseconds. Default is 25ms */
133+
backoffScaleValue?: number;
134+
}

‎packages/util-retry/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

‎packages/util-retry/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/util-retry/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# @aws-sdk/util-retry
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-retry/latest.svg)](https://www.npmjs.com/package/@aws-sdk/util-retry)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-retry.svg)](https://www.npmjs.com/package/@aws-sdk/util-retry)
5+
6+
> An internal package
7+
8+
This package provides shared utilities for retries.
9+
10+
## Usage
11+
12+
You probably shouldn't, at least directly.

‎packages/util-retry/jest.config.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
const base = require("../../jest.config.base.js");
2+
3+
module.exports = {
4+
...base,
5+
};

0 commit comments

Comments
 (0)