typescript-retry-decorator 2.2.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CODE_OF_CONDUCT.md +128 -0
- package/CONTRIBUTING.md +16 -0
- package/README.md +44 -11
- package/dist/retry.decorator.d.ts +24 -1
- package/dist/retry.decorator.d.ts.map +1 -1
- package/dist/retry.decorator.js +33 -2
- package/dist/retry.decorator.js.map +1 -1
- package/dist/retry.decorator.test.js +38 -5
- package/dist/retry.decorator.test.js.map +1 -1
- package/package.json +1 -1
- package/src/retry.decorator.test.ts +40 -10
- package/src/retry.decorator.ts +46 -3
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity
|
|
10
|
+
and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the
|
|
26
|
+
overall community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or
|
|
31
|
+
advances of any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email
|
|
35
|
+
address, without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series
|
|
86
|
+
of actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or
|
|
93
|
+
permanent ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within
|
|
113
|
+
the community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.0, available at
|
|
119
|
+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
|
122
|
+
enforcement ladder](https://github.com/mozilla/diversity).
|
|
123
|
+
|
|
124
|
+
[homepage]: https://www.contributor-covenant.org
|
|
125
|
+
|
|
126
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
127
|
+
https://www.contributor-covenant.org/faq. Translations are available at
|
|
128
|
+
https://www.contributor-covenant.org/translations.
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
When contributing to this repository, please first discuss the change you wish to make via issue,
|
|
4
|
+
email, or any other method with the owners of this repository before making a change.
|
|
5
|
+
|
|
6
|
+
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
|
7
|
+
|
|
8
|
+
## Pull Request Process
|
|
9
|
+
|
|
10
|
+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
|
|
11
|
+
build.
|
|
12
|
+
2. Update the README.md with details of changes to the interface, this includes new environment
|
|
13
|
+
variables, exposed ports, useful file locations and container parameters.
|
|
14
|
+
3. Increase the version numbers in `package.json` to the new version that this
|
|
15
|
+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
|
16
|
+
4. You may merge the Pull Request in once you have the sign-off, or the maintainer will do the merge.
|
package/README.md
CHANGED
|
@@ -8,16 +8,25 @@ Import and use it. Retry for `Promise` is supported as long as the `runtime` has
|
|
|
8
8
|
> npm install typescript-retry-decorator
|
|
9
9
|
|
|
10
10
|
### Options
|
|
11
|
-
| Option Name |
|
|
12
|
-
|
|
13
|
-
| maxAttempts |
|
|
14
|
-
| backOff |
|
|
15
|
-
| backOffPolicy |
|
|
16
|
-
| exponentialOption |
|
|
17
|
-
| doRetry |
|
|
18
|
-
| value |
|
|
19
|
-
| useConsoleLogger |
|
|
20
|
-
| useOriginalError | throw original exception|
|
|
11
|
+
| Option Name | Type | Required? | Default | Description |
|
|
12
|
+
|:-----------------:|:------------------------:|:---------:|:---------------------------------------:|:-----------------------------------------------------------------------------------------------------------------:|
|
|
13
|
+
| maxAttempts | number | Yes | - | The max attempts to try |
|
|
14
|
+
| backOff | number | No | 0 | number in `ms` to back off. If not set, then no wait |
|
|
15
|
+
| backOffPolicy | enum | No | FixedBackOffPolicy | can be fixed or exponential |
|
|
16
|
+
| exponentialOption | object | No | `{ maxInterval: 2000, multiplier: 2 }` | This is for the `ExponentialBackOffPolicy` <br/> The max interval each wait and the multiplier for the `backOff`. For `backoffStrategy`, more details below |
|
|
17
|
+
| doRetry | (e: any) => boolean | No | - | Function with error parameter to decide if repetition is necessary. |
|
|
18
|
+
| value | Error/Exception class | No | [ ] | An array of Exception types that are retryable. |
|
|
19
|
+
| useConsoleLogger | boolean | No | true | Print errors on console. |
|
|
20
|
+
| useOriginalError | throw original exception | No | false | `MaxAttemptsError` by default. if this is set to *true*, the `original` exception would be thrown instead. |
|
|
21
|
+
|
|
22
|
+
#### Exponential options
|
|
23
|
+
|
|
24
|
+
The `exponentialOption` allows you to fine-tune the exponential backoff strategy using several options:
|
|
25
|
+
- `maxInterval`: The maximum interval between two retries. The default value is 2000 ms.
|
|
26
|
+
- `multiplier`: The multiplier to use to generate the next backoff interval from the last one. The default value is 2.
|
|
27
|
+
- `backoffStrategy`: Optional. If specified, determines the strategy used to introduce "jitter" between retry intervals. For an explanation of the available strategies and why you might select one over the other, check out [this article](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/).
|
|
28
|
+
- `ExponentialBackoffStrategy.FullJitter`: The base backoff interval is multiplied by a random number between 0 and 1.
|
|
29
|
+
- `ExponentialBackoffStrategy.EqualJitter`: The backoff interval is (base interval / 2) + (random value between 0 and base interval / 2).
|
|
21
30
|
|
|
22
31
|
### Example
|
|
23
32
|
```typescript
|
|
@@ -85,6 +94,17 @@ class RetryExample {
|
|
|
85
94
|
console.info(`Calling ExponentialBackOffRetry backOff 1s, multiplier=3 for the ${count++} time at ${new Date().toLocaleTimeString()}`);
|
|
86
95
|
throw new Error('I failed!');
|
|
87
96
|
}
|
|
97
|
+
|
|
98
|
+
@Retryable({
|
|
99
|
+
maxAttempts: 3,
|
|
100
|
+
backOffPolicy: BackOffPolicy.ExponentialBackOffPolicy,
|
|
101
|
+
backOff: 1000,
|
|
102
|
+
exponentialOption: { maxInterval: 4000, multiplier: 2, backoffStrategy: ExponentialBackoffStrategy.EqualJitter }
|
|
103
|
+
})
|
|
104
|
+
static async ExponentialBackOffWithJitterRetry() {
|
|
105
|
+
console.info(`Calling ExponentialBackOffWithJitterRetry backOff 1s, multiplier=2 for the ${count++} time at ${new Date().toLocaleTimeString()}`);
|
|
106
|
+
throw new Error('I failed!');
|
|
107
|
+
}
|
|
88
108
|
}
|
|
89
109
|
|
|
90
110
|
(async () => {
|
|
@@ -122,7 +142,14 @@ class RetryExample {
|
|
|
122
142
|
} catch (e) {
|
|
123
143
|
console.info(`All retry done as expected, final message: '${e.message}'`);
|
|
124
144
|
}
|
|
125
|
-
|
|
145
|
+
|
|
146
|
+
try {
|
|
147
|
+
resetCount();
|
|
148
|
+
await RetryExample.ExponentialBackOffWithJitterRetry();
|
|
149
|
+
} catch (e) {
|
|
150
|
+
console.info(`All retry done as expected, final message: '${e.message}'`);
|
|
151
|
+
}
|
|
152
|
+
|
|
126
153
|
})();
|
|
127
154
|
|
|
128
155
|
function resetCount() {
|
|
@@ -164,4 +191,10 @@ Calling ExponentialBackOffRetry backOff 1s, multiplier=3 for the 3 time at 4:12:
|
|
|
164
191
|
Calling ExponentialBackOffRetry backOff 1s, multiplier=3 for the 4 time at 4:13:03 PM
|
|
165
192
|
I failed!
|
|
166
193
|
All retry done as expected, final message: 'Failed for 'ExponentialBackOffRetry' for 3 times.'
|
|
194
|
+
Calling ExponentialBackOffWithJitterRetry backOff 1s, multiplier=2 for the 1 time at 4:13:03 PM
|
|
195
|
+
Calling ExponentialBackOffWithJitterRetry backOff 1s, multiplier=2 for the 2 time at 4:13:03 PM
|
|
196
|
+
Calling ExponentialBackOffWithJitterRetry backOff 1s, multiplier=2 for the 3 time at 4:13:05 PM
|
|
197
|
+
Calling ExponentialBackOffWithJitterRetry backOff 1s, multiplier=2 for the 4 time at 4:13:09 PM
|
|
198
|
+
I failed!
|
|
199
|
+
All retry done as expected, final message: 'Failed for 'ExponentialBackOffWithJitterRetry' for 3 times.'
|
|
167
200
|
```
|
|
@@ -7,6 +7,9 @@ export declare function Retryable(options: RetryOptions): DecoratorFunction;
|
|
|
7
7
|
export declare class MaxAttemptsError extends Error {
|
|
8
8
|
code: string;
|
|
9
9
|
}
|
|
10
|
+
interface ConstructableError {
|
|
11
|
+
new (...args: any[]): Error;
|
|
12
|
+
}
|
|
10
13
|
export interface RetryOptions {
|
|
11
14
|
backOffPolicy?: BackOffPolicy;
|
|
12
15
|
backOff?: number;
|
|
@@ -14,9 +17,14 @@ export interface RetryOptions {
|
|
|
14
17
|
exponentialOption?: {
|
|
15
18
|
maxInterval: number;
|
|
16
19
|
multiplier: number;
|
|
20
|
+
/**
|
|
21
|
+
* Optional. If provided, the backoff time will include jitter using the desired strategy.
|
|
22
|
+
* For more information, see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
|
23
|
+
*/
|
|
24
|
+
backoffStrategy?: ExponentialBackoffStrategy;
|
|
17
25
|
};
|
|
18
26
|
maxAttempts: number;
|
|
19
|
-
value?:
|
|
27
|
+
value?: ConstructableError[];
|
|
20
28
|
useConsoleLogger?: boolean;
|
|
21
29
|
useOriginalError?: boolean;
|
|
22
30
|
}
|
|
@@ -24,5 +32,20 @@ export declare enum BackOffPolicy {
|
|
|
24
32
|
FixedBackOffPolicy = "FixedBackOffPolicy",
|
|
25
33
|
ExponentialBackOffPolicy = "ExponentialBackOffPolicy"
|
|
26
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* Represents different strategies for applying jitter to backoff times.
|
|
37
|
+
* @see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
|
38
|
+
*/
|
|
39
|
+
export declare enum ExponentialBackoffStrategy {
|
|
40
|
+
/**
|
|
41
|
+
* The backoff time will be (base backoff time) * (random number between 0 and 1).
|
|
42
|
+
*/
|
|
43
|
+
FullJitter = "FullJitter",
|
|
44
|
+
/**
|
|
45
|
+
* The backoff time will be (base backoff time / 2) + (random number between 0 and (base backoff time / 2)).
|
|
46
|
+
*/
|
|
47
|
+
EqualJitter = "EqualJitter"
|
|
48
|
+
}
|
|
27
49
|
export declare type DecoratorFunction = (target: Record<string, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) => TypedPropertyDescriptor<any>;
|
|
50
|
+
export {};
|
|
28
51
|
//# sourceMappingURL=retry.decorator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retry.decorator.d.ts","sourceRoot":"","sources":["../src/retry.decorator.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,iBAAiB,
|
|
1
|
+
{"version":3,"file":"retry.decorator.d.ts","sourceRoot":"","sources":["../src/retry.decorator.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,iBAAiB,CAyFlE;AAED,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,IAAI,SAAS;CAMd;AAED,UAAU,kBAAkB;IAC1B,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC;IAC9B,iBAAiB,CAAC,EAAE;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB;;;WAGG;QACH,eAAe,CAAC,EAAE,0BAA0B,CAAC;KAC9C,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC7B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,oBAAY,aAAa;IACvB,kBAAkB,uBAAuB;IACzC,wBAAwB,6BAA6B;CACtD;AAED;;;GAGG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,WAAW,gBAAgB;CAC5B;AAED,oBAAY,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,uBAAuB,CAAC,GAAG,CAAC,KAAK,uBAAuB,CAAC,GAAG,CAAC,CAAC"}
|
package/dist/retry.decorator.js
CHANGED
|
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.BackOffPolicy = exports.MaxAttemptsError = exports.Retryable = void 0;
|
|
12
|
+
exports.ExponentialBackoffStrategy = exports.BackOffPolicy = exports.MaxAttemptsError = exports.Retryable = void 0;
|
|
13
13
|
const utils_1 = require("./utils");
|
|
14
14
|
/**
|
|
15
15
|
* retry decorator which is nothing but a high order function wrapper
|
|
@@ -68,7 +68,7 @@ function Retryable(options) {
|
|
|
68
68
|
if (!canRetry(e)) {
|
|
69
69
|
throw e;
|
|
70
70
|
}
|
|
71
|
-
backOff && (yield (0, utils_1.sleep)(backOff));
|
|
71
|
+
backOff && (yield (0, utils_1.sleep)(applyBackoffStrategy(backOff)));
|
|
72
72
|
if (options.backOffPolicy === BackOffPolicy.ExponentialBackOffPolicy) {
|
|
73
73
|
backOff = Math.min(backOff * options.exponentialOption.multiplier, options.exponentialOption.maxInterval);
|
|
74
74
|
}
|
|
@@ -90,6 +90,22 @@ function Retryable(options) {
|
|
|
90
90
|
!options.backOff && (options.backOff = 1000);
|
|
91
91
|
options.exponentialOption = Object.assign({ maxInterval: 2000, multiplier: 2 }, options.exponentialOption);
|
|
92
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* Calculate the actual backoff using the specified backoff strategy, if any
|
|
95
|
+
* @see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
|
96
|
+
* @param baseBackoff - base backoff time in ms
|
|
97
|
+
*/
|
|
98
|
+
function applyBackoffStrategy(baseBackoff) {
|
|
99
|
+
var _a;
|
|
100
|
+
const { backoffStrategy } = (_a = options.exponentialOption) !== null && _a !== void 0 ? _a : {};
|
|
101
|
+
if (backoffStrategy === ExponentialBackoffStrategy.EqualJitter) {
|
|
102
|
+
return baseBackoff / 2 + (Math.random() * baseBackoff / 2);
|
|
103
|
+
}
|
|
104
|
+
if (backoffStrategy === ExponentialBackoffStrategy.FullJitter) {
|
|
105
|
+
return Math.random() * baseBackoff;
|
|
106
|
+
}
|
|
107
|
+
return baseBackoff;
|
|
108
|
+
}
|
|
93
109
|
}
|
|
94
110
|
exports.Retryable = Retryable;
|
|
95
111
|
class MaxAttemptsError extends Error {
|
|
@@ -109,4 +125,19 @@ var BackOffPolicy;
|
|
|
109
125
|
BackOffPolicy["FixedBackOffPolicy"] = "FixedBackOffPolicy";
|
|
110
126
|
BackOffPolicy["ExponentialBackOffPolicy"] = "ExponentialBackOffPolicy";
|
|
111
127
|
})(BackOffPolicy = exports.BackOffPolicy || (exports.BackOffPolicy = {}));
|
|
128
|
+
/**
|
|
129
|
+
* Represents different strategies for applying jitter to backoff times.
|
|
130
|
+
* @see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
|
131
|
+
*/
|
|
132
|
+
var ExponentialBackoffStrategy;
|
|
133
|
+
(function (ExponentialBackoffStrategy) {
|
|
134
|
+
/**
|
|
135
|
+
* The backoff time will be (base backoff time) * (random number between 0 and 1).
|
|
136
|
+
*/
|
|
137
|
+
ExponentialBackoffStrategy["FullJitter"] = "FullJitter";
|
|
138
|
+
/**
|
|
139
|
+
* The backoff time will be (base backoff time / 2) + (random number between 0 and (base backoff time / 2)).
|
|
140
|
+
*/
|
|
141
|
+
ExponentialBackoffStrategy["EqualJitter"] = "EqualJitter";
|
|
142
|
+
})(ExponentialBackoffStrategy = exports.ExponentialBackoffStrategy || (exports.ExponentialBackoffStrategy = {}));
|
|
112
143
|
//# sourceMappingURL=retry.decorator.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retry.decorator.js","sourceRoot":"","sources":["../src/retry.decorator.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAgC;AAEhC;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAqB;IAC7C;;;;;;;;OAQG;IACH,OAAO,UAAS,MAA2B,EAAE,WAAmB,EAAE,UAAwC;QACxG,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC;QACpC,iDAAiD;QACjD,IAAI,OAAO,CAAC,aAAa,KAAK,aAAa,CAAC,wBAAwB,EAAE;YACpE,kCAAkC,EAAE,CAAC;SACtC;QACD,UAAU,CAAC,KAAK,GAAG,UAAe,GAAG,IAAW;;gBAC9C,IAAI;oBACF,OAAO,MAAM,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;iBAC/F;gBAAC,OAAO,CAAC,EAAE;oBACV,IAAI,CAAC,YAAY,gBAAgB,EAAE;wBACjC,MAAM,SAAS,GAAG,eAAe,WAAW,SAAS,OAAO,CAAC,WAAW,SAAS,CAAC;wBAClF,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,oBAAoB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;qBACjF;oBACD,MAAM,CAAC,CAAC;iBACT;YACH,CAAC;SAAA,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;IAEF,SAAe,UAAU,CAAC,EAAa,EAAE,IAAW,EAAE,WAAmB,EAAE,OAAgB;;YACzF,IAAI;gBACF,OAAO,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;aACnC;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,EAAE,WAAW,GAAG,CAAC,EAAE;oBACrB,CAAC,OAAO,OAAO,CAAC,gBAAgB,KAAK,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC,KAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,CAAA,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBACtH,IAAG,OAAO,CAAC,gBAAgB;wBAAE,MAAM,CAAC,CAAC;oBACrC,MAAM,wBAAwB,GAAG,IAAK,gBAAgB,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,CAAC,CAAC;oBACnE,0CAA0C;oBAC1C,IAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,EAAE;wBACX,wBAAwB,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;qBAC1C;oBAED,MAAM,wBAAwB,CAAC;iBAChC;gBACD,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;oBAChB,MAAM,CAAC,CAAC;iBACT;gBACD,OAAO,IAAI,CAAC,MAAM,IAAA,aAAK,EAAC,OAAO,CAAC,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"retry.decorator.js","sourceRoot":"","sources":["../src/retry.decorator.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAgC;AAEhC;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAqB;IAC7C;;;;;;;;OAQG;IACH,OAAO,UAAS,MAA2B,EAAE,WAAmB,EAAE,UAAwC;QACxG,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC;QACpC,iDAAiD;QACjD,IAAI,OAAO,CAAC,aAAa,KAAK,aAAa,CAAC,wBAAwB,EAAE;YACpE,kCAAkC,EAAE,CAAC;SACtC;QACD,UAAU,CAAC,KAAK,GAAG,UAAe,GAAG,IAAW;;gBAC9C,IAAI;oBACF,OAAO,MAAM,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;iBAC/F;gBAAC,OAAO,CAAC,EAAE;oBACV,IAAI,CAAC,YAAY,gBAAgB,EAAE;wBACjC,MAAM,SAAS,GAAG,eAAe,WAAW,SAAS,OAAO,CAAC,WAAW,SAAS,CAAC;wBAClF,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,oBAAoB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;qBACjF;oBACD,MAAM,CAAC,CAAC;iBACT;YACH,CAAC;SAAA,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;IAEF,SAAe,UAAU,CAAC,EAAa,EAAE,IAAW,EAAE,WAAmB,EAAE,OAAgB;;YACzF,IAAI;gBACF,OAAO,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;aACnC;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,EAAE,WAAW,GAAG,CAAC,EAAE;oBACrB,CAAC,OAAO,OAAO,CAAC,gBAAgB,KAAK,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC,KAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,CAAA,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBACtH,IAAG,OAAO,CAAC,gBAAgB;wBAAE,MAAM,CAAC,CAAC;oBACrC,MAAM,wBAAwB,GAAG,IAAK,gBAAgB,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,CAAC,CAAC;oBACnE,0CAA0C;oBAC1C,IAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,EAAE;wBACX,wBAAwB,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;qBAC1C;oBAED,MAAM,wBAAwB,CAAC;iBAChC;gBACD,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;oBAChB,MAAM,CAAC,CAAC;iBACT;gBACD,OAAO,IAAI,CAAC,MAAM,IAAA,aAAK,EAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBACxD,IAAI,OAAO,CAAC,aAAa,KAAK,aAAa,CAAC,wBAAwB,EAAE;oBACpE,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;iBAC3G;gBACD,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;aACjE;QACH,CAAC;KAAA;IAED,SAAS,QAAQ,CAAC,CAAQ;;QACxB,IAAI,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC1C,OAAO,KAAK,CAAC;SACd;QACD,IAAI,CAAA,MAAA,OAAO,CAAC,KAAK,0CAAE,MAAM,KAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,YAAY,SAAS,CAAC,EAAE;YACrF,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,kCAAkC;QACzC,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;QAC7C,OAAO,CAAC,iBAAiB,iBACpB,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,EACpC,OAAO,CAAC,iBAAiB,CAC7B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,SAAS,oBAAoB,CAAC,WAAmB;;QAC/C,MAAM,EAAE,eAAe,EAAE,GAAG,MAAA,OAAO,CAAC,iBAAiB,mCAAI,EAAE,CAAC;QAC5D,IAAI,eAAe,KAAK,0BAA0B,CAAC,WAAW,EAAE;YAC9D,OAAO,WAAW,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC;SAC5D;QACD,IAAI,eAAe,KAAK,0BAA0B,CAAC,UAAU,EAAE;YAC7D,OAAO,IAAI,CAAC,MAAM,EAAE,GAAG,WAAW,CAAC;SACpC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;AACH,CAAC;AAzFD,8BAyFC;AAED,MAAa,gBAAiB,SAAQ,KAAK;IAA3C;;QACE,SAAI,GAAG,KAAK,CAAC;QACb;;;;cAIM;IACR,CAAC;CAAA;AAPD,4CAOC;AAyBD,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,0DAAyC,CAAA;IACzC,sEAAqD,CAAA;AACvD,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED;;;GAGG;AACH,IAAY,0BASX;AATD,WAAY,0BAA0B;IACpC;;OAEG;IACH,uDAAyB,CAAA;IACzB;;OAEG;IACH,yDAA2B,CAAA;AAC7B,CAAC,EATW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QASrC"}
|
|
@@ -19,6 +19,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
19
19
|
};
|
|
20
20
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
21
21
|
const retry_decorator_1 = require("./retry.decorator");
|
|
22
|
+
// CustomError for testing.
|
|
23
|
+
class CustomError extends Error {
|
|
24
|
+
constructor(message) {
|
|
25
|
+
// Call the parent class constructor with the provided message
|
|
26
|
+
super(message);
|
|
27
|
+
// Set the prototype and name properties
|
|
28
|
+
Object.setPrototypeOf(this, CustomError.prototype);
|
|
29
|
+
this.name = 'CustomError';
|
|
30
|
+
}
|
|
31
|
+
}
|
|
22
32
|
class TestClass {
|
|
23
33
|
constructor() {
|
|
24
34
|
this.count = 0;
|
|
@@ -53,6 +63,12 @@ class TestClass {
|
|
|
53
63
|
yield this.called();
|
|
54
64
|
});
|
|
55
65
|
}
|
|
66
|
+
exponentialBackOffWithJitterRetry() {
|
|
67
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
68
|
+
console.info(`Calling ExponentialBackOffRetry backOff 1s, multiplier=2 for the ${++this.count} time at ${new Date().toLocaleTimeString()}`);
|
|
69
|
+
yield this.called();
|
|
70
|
+
});
|
|
71
|
+
}
|
|
56
72
|
noLog() {
|
|
57
73
|
return __awaiter(this, void 0, void 0, function* () {
|
|
58
74
|
console.log(`test method is called for ${++this.count} time`);
|
|
@@ -77,7 +93,7 @@ __decorate([
|
|
|
77
93
|
__metadata("design:returntype", Promise)
|
|
78
94
|
], TestClass.prototype, "testMethod", null);
|
|
79
95
|
__decorate([
|
|
80
|
-
(0, retry_decorator_1.Retryable)({ maxAttempts:
|
|
96
|
+
(0, retry_decorator_1.Retryable)({ maxAttempts: 3, value: [SyntaxError, ReferenceError, CustomError] }),
|
|
81
97
|
__metadata("design:type", Function),
|
|
82
98
|
__metadata("design:paramtypes", []),
|
|
83
99
|
__metadata("design:returntype", Promise)
|
|
@@ -113,6 +129,16 @@ __decorate([
|
|
|
113
129
|
__metadata("design:paramtypes", []),
|
|
114
130
|
__metadata("design:returntype", Promise)
|
|
115
131
|
], TestClass.prototype, "exponentialBackOffRetry", null);
|
|
132
|
+
__decorate([
|
|
133
|
+
(0, retry_decorator_1.Retryable)({
|
|
134
|
+
maxAttempts: 3,
|
|
135
|
+
backOffPolicy: retry_decorator_1.BackOffPolicy.ExponentialBackOffPolicy,
|
|
136
|
+
exponentialOption: { maxInterval: 4000, multiplier: 2, backoffStrategy: retry_decorator_1.ExponentialBackoffStrategy.FullJitter },
|
|
137
|
+
}),
|
|
138
|
+
__metadata("design:type", Function),
|
|
139
|
+
__metadata("design:paramtypes", []),
|
|
140
|
+
__metadata("design:returntype", Promise)
|
|
141
|
+
], TestClass.prototype, "exponentialBackOffWithJitterRetry", null);
|
|
116
142
|
__decorate([
|
|
117
143
|
(0, retry_decorator_1.Retryable)({ maxAttempts: 2, useConsoleLogger: false }),
|
|
118
144
|
__metadata("design:type", Function),
|
|
@@ -169,7 +195,7 @@ describe('Retry Test', () => {
|
|
|
169
195
|
}));
|
|
170
196
|
test('retry with specific error', () => __awaiter(void 0, void 0, void 0, function* () {
|
|
171
197
|
const calledSpy = jest.spyOn(testClass, 'called');
|
|
172
|
-
calledSpy.mockImplementationOnce(() => { throw new
|
|
198
|
+
calledSpy.mockImplementationOnce(() => { throw new CustomError('I failed!'); });
|
|
173
199
|
yield testClass.testMethodWithException();
|
|
174
200
|
expect(calledSpy).toHaveBeenCalledTimes(2);
|
|
175
201
|
}));
|
|
@@ -216,6 +242,16 @@ describe('Retry Test', () => {
|
|
|
216
242
|
catch (e) { }
|
|
217
243
|
expect(calledSpy).toHaveBeenCalledTimes(4);
|
|
218
244
|
}));
|
|
245
|
+
test('exponential backOff policy with jitter', () => __awaiter(void 0, void 0, void 0, function* () {
|
|
246
|
+
jest.setTimeout(60000);
|
|
247
|
+
const calledSpy = jest.spyOn(testClass, 'called');
|
|
248
|
+
calledSpy.mockImplementation(() => { throw new Error(); });
|
|
249
|
+
try {
|
|
250
|
+
yield testClass.exponentialBackOffWithJitterRetry();
|
|
251
|
+
}
|
|
252
|
+
catch (e) { }
|
|
253
|
+
expect(calledSpy).toHaveBeenCalledTimes(4);
|
|
254
|
+
}));
|
|
219
255
|
test('no log', () => __awaiter(void 0, void 0, void 0, function* () {
|
|
220
256
|
const calledSpy = jest.spyOn(testClass, 'called');
|
|
221
257
|
const errorSpy = jest.spyOn(console, 'error');
|
|
@@ -225,9 +261,6 @@ describe('Retry Test', () => {
|
|
|
225
261
|
expect(calledSpy).toHaveBeenCalledTimes(2);
|
|
226
262
|
expect(errorSpy).not.toHaveBeenCalled();
|
|
227
263
|
}));
|
|
228
|
-
// CustomError for testing.
|
|
229
|
-
class CustomError extends Error {
|
|
230
|
-
}
|
|
231
264
|
test('throw original error', () => __awaiter(void 0, void 0, void 0, function* () {
|
|
232
265
|
jest.setTimeout(60000);
|
|
233
266
|
const calledSpy = jest.spyOn(testClass, 'called');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retry.decorator.test.js","sourceRoot":"","sources":["../src/retry.decorator.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"retry.decorator.test.js","sourceRoot":"","sources":["../src/retry.decorator.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,uDAA2G;AAG3G,2BAA2B;AAC3B,MAAM,WAAY,SAAQ,KAAK;IAC7B,YAAY,OAAgB;QAC1B,8DAA8D;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,wCAAwC;QACxC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,SAAS;IAEb;QACE,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;IACjB,CAAC;IAEK,UAAU;;YACd,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC;YAC9D,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAGK,uBAAuB;;YAC3B,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC;YAC9D,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAQK,WAAW;;YACf,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,CAAC,KAAK,YAAY,IAAI,IAAI,EAAE,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;YACnG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAOK,iBAAiB;;YACrB,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,KAAK,YAAY,IAAI,IAAI,EAAE,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;YAChH,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAOK,uBAAuB;;YAC3B,OAAO,CAAC,IAAI,CAAC,oEAAoE,EAAE,IAAI,CAAC,KAAK,YAAY,IAAI,IAAI,EAAE,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;YAC5I,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAOK,iCAAiC;;YACrC,OAAO,CAAC,IAAI,CAAC,oEAAoE,EAAE,IAAI,CAAC,KAAK,YAAY,IAAI,IAAI,EAAE,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;YAC5I,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAGK,KAAK;;YACT,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC;YAC9D,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAGK,gBAAgB;;YACpB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;KAAA;IAEK,MAAM;;YACV,OAAO,0BAA0B,CAAC;QACpC,CAAC;KAAA;CACF;AAlEC;IADC,IAAA,2BAAS,EAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;;;;2CAI7B;AAGD;IADC,IAAA,2BAAS,EAAC,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,CAAC;;;;wDAIhF;AAQD;IANC,IAAA,2BAAS,EAAC;QACT,WAAW,EAAE,CAAC;QACd,OAAO,EAAE,CAAC,CAAQ,EAAE,EAAE;YACpB,OAAO,CAAC,CAAC,OAAO,KAAK,YAAY,CAAC;QACpC,CAAC;KACF,CAAC;;;;4CAID;AAOD;IALC,IAAA,2BAAS,EAAC;QACT,WAAW,EAAE,CAAC;QACd,aAAa,EAAE,+BAAa,CAAC,kBAAkB;QAC/C,OAAO,EAAE,IAAI;KACd,CAAC;;;;kDAID;AAOD;IALC,IAAA,2BAAS,EAAC;QACT,WAAW,EAAE,CAAC;QACd,aAAa,EAAE,+BAAa,CAAC,wBAAwB;QACrD,iBAAiB,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE;KACxD,CAAC;;;;wDAID;AAOD;IALC,IAAA,2BAAS,EAAC;QACT,WAAW,EAAE,CAAC;QACd,aAAa,EAAE,+BAAa,CAAC,wBAAwB;QACrD,iBAAiB,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,eAAe,EAAE,4CAA0B,CAAC,UAAU,EAAE;KAChH,CAAC;;;;kEAID;AAGD;IADC,IAAA,2BAAS,EAAC,EAAE,WAAW,EAAE,CAAC,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;;;;sCAItD;AAGD;IADC,IAAA,2BAAS,EAAC,EAAE,WAAW,EAAE,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;;;;iDAGrD;AAOH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,CAAC,kBAAkB,EAAE,GAAS,EAAE;QAClC,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;QAElC,MAAM,kBAAkB,GAAG,KAAK,CAAC;QACjC,MAAM,QAAQ,GAAG,UAAU,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5C,eAAe,CAAC,KAAK,GAAG,kBAAkB,CAAC;QAE3C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAElD,SAAS,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC7C,IAAI;YACF,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;SAC9B;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;SAC7C;IACH,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAGH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAI,SAAoB,CAAC;IACzB,UAAU,CAAC,GAAG,EAAE;QACd,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,cAAc,EAAE,GAAS,EAAE;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QACvD,SAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAC7C,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;QAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,kBAAkB,EAAE,GAAS,EAAE;QAClC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,UAAU,CAAC;QAC5B,SAAS,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI;YACF,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;SAC9B;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,kCAAgB,CAAC,CAAC;YAC3C,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtC;QACD,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,2BAA2B,EAAE,GAAS,EAAE;QAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChF,MAAM,SAAS,CAAC,uBAAuB,EAAE,CAAC;QAC1C,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,qCAAqC,EAAE,GAAS,EAAE;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,IAAI;YACF,MAAM,SAAS,CAAC,uBAAuB,EAAE,CAAC;SAC3C;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAGH,IAAI,CAAC,8CAA8C,EAAE,GAAS,EAAE;QAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3E,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAC9B,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,mDAAmD,EAAE,GAAS,EAAE;QACnE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3E,IAAI;YACF,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;SAC/B;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,oBAAoB,EAAE,GAAS,EAAE;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,IAAI;YACF,MAAM,SAAS,CAAC,iBAAiB,EAAE,CAAC;SACrC;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,4BAA4B,EAAE,GAAS,EAAE;QAC5C,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3D,IAAI;YACF,MAAM,SAAS,CAAC,uBAAuB,EAAE,CAAC;SAC3C;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,GAAS,EAAE;QACxD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3D,IAAI;YACF,MAAM,SAAS,CAAC,iCAAiC,EAAE,CAAC;SACrD;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,EAAE,GAAS,EAAE;QACxB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9C,SAAS,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QACvD,SAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAC7C,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;QAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAC1C,CAAC,CAAA,CAAC,CAAC;IAGH,IAAI,CAAC,sBAAsB,EAAE,GAAS,EAAE;QACtC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACjE,IAAI;YACF,MAAM,SAAS,CAAC,gBAAgB,EAAE,CAAC;SACpC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;SACvC;IACH,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
1
|
+
import { BackOffPolicy, ExponentialBackoffStrategy, MaxAttemptsError, Retryable } from './retry.decorator';
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
// CustomError for testing.
|
|
5
|
+
class CustomError extends Error {
|
|
6
|
+
constructor(message?: string) {
|
|
7
|
+
// Call the parent class constructor with the provided message
|
|
8
|
+
super(message);
|
|
9
|
+
|
|
10
|
+
// Set the prototype and name properties
|
|
11
|
+
Object.setPrototypeOf(this, CustomError.prototype);
|
|
12
|
+
this.name = 'CustomError';
|
|
13
|
+
}
|
|
14
|
+
}
|
|
3
15
|
|
|
4
16
|
class TestClass {
|
|
5
17
|
count: number;
|
|
@@ -12,7 +24,7 @@ class TestClass {
|
|
|
12
24
|
await this.called();
|
|
13
25
|
}
|
|
14
26
|
|
|
15
|
-
@Retryable({ maxAttempts:
|
|
27
|
+
@Retryable({ maxAttempts: 3, value: [SyntaxError, ReferenceError, CustomError] })
|
|
16
28
|
async testMethodWithException(): Promise<void> {
|
|
17
29
|
console.log(`test method is called for ${++this.count} time`);
|
|
18
30
|
await this.called();
|
|
@@ -49,6 +61,16 @@ class TestClass {
|
|
|
49
61
|
await this.called();
|
|
50
62
|
}
|
|
51
63
|
|
|
64
|
+
@Retryable({
|
|
65
|
+
maxAttempts: 3,
|
|
66
|
+
backOffPolicy: BackOffPolicy.ExponentialBackOffPolicy,
|
|
67
|
+
exponentialOption: { maxInterval: 4000, multiplier: 2, backoffStrategy: ExponentialBackoffStrategy.FullJitter },
|
|
68
|
+
})
|
|
69
|
+
async exponentialBackOffWithJitterRetry(): Promise<void> {
|
|
70
|
+
console.info(`Calling ExponentialBackOffRetry backOff 1s, multiplier=2 for the ${++this.count} time at ${new Date().toLocaleTimeString()}`);
|
|
71
|
+
await this.called();
|
|
72
|
+
}
|
|
73
|
+
|
|
52
74
|
@Retryable({ maxAttempts: 2, useConsoleLogger: false })
|
|
53
75
|
async noLog(): Promise<void> {
|
|
54
76
|
console.log(`test method is called for ${++this.count} time`);
|
|
@@ -116,7 +138,7 @@ describe('Retry Test', () => {
|
|
|
116
138
|
|
|
117
139
|
test('retry with specific error', async () => {
|
|
118
140
|
const calledSpy = jest.spyOn(testClass, 'called');
|
|
119
|
-
calledSpy.mockImplementationOnce(() => { throw new
|
|
141
|
+
calledSpy.mockImplementationOnce(() => { throw new CustomError('I failed!'); });
|
|
120
142
|
await testClass.testMethodWithException();
|
|
121
143
|
expect(calledSpy).toHaveBeenCalledTimes(2);
|
|
122
144
|
});
|
|
@@ -126,7 +148,7 @@ describe('Retry Test', () => {
|
|
|
126
148
|
calledSpy.mockImplementationOnce(() => { throw new Error('I failed!'); });
|
|
127
149
|
try {
|
|
128
150
|
await testClass.testMethodWithException();
|
|
129
|
-
} catch (e) {}
|
|
151
|
+
} catch (e) { }
|
|
130
152
|
expect(calledSpy).toHaveBeenCalledTimes(1);
|
|
131
153
|
});
|
|
132
154
|
|
|
@@ -143,7 +165,7 @@ describe('Retry Test', () => {
|
|
|
143
165
|
calledSpy.mockImplementationOnce(() => { throw new Error('Error: 500'); });
|
|
144
166
|
try {
|
|
145
167
|
await testClass.testDoRetry();
|
|
146
|
-
} catch (e) {}
|
|
168
|
+
} catch (e) { }
|
|
147
169
|
expect(calledSpy).toHaveBeenCalledTimes(1);
|
|
148
170
|
});
|
|
149
171
|
|
|
@@ -152,7 +174,7 @@ describe('Retry Test', () => {
|
|
|
152
174
|
calledSpy.mockImplementation(() => { throw new Error('Error: 500'); });
|
|
153
175
|
try {
|
|
154
176
|
await testClass.fixedBackOffRetry();
|
|
155
|
-
} catch (e) {}
|
|
177
|
+
} catch (e) { }
|
|
156
178
|
expect(calledSpy).toHaveBeenCalledTimes(4);
|
|
157
179
|
});
|
|
158
180
|
|
|
@@ -162,7 +184,17 @@ describe('Retry Test', () => {
|
|
|
162
184
|
calledSpy.mockImplementation(() => { throw new Error(); });
|
|
163
185
|
try {
|
|
164
186
|
await testClass.exponentialBackOffRetry();
|
|
165
|
-
} catch (e) {}
|
|
187
|
+
} catch (e) { }
|
|
188
|
+
expect(calledSpy).toHaveBeenCalledTimes(4);
|
|
189
|
+
});
|
|
190
|
+
|
|
191
|
+
test('exponential backOff policy with jitter', async () => {
|
|
192
|
+
jest.setTimeout(60000);
|
|
193
|
+
const calledSpy = jest.spyOn(testClass, 'called');
|
|
194
|
+
calledSpy.mockImplementation(() => { throw new Error(); });
|
|
195
|
+
try {
|
|
196
|
+
await testClass.exponentialBackOffWithJitterRetry();
|
|
197
|
+
} catch (e) { }
|
|
166
198
|
expect(calledSpy).toHaveBeenCalledTimes(4);
|
|
167
199
|
});
|
|
168
200
|
|
|
@@ -176,8 +208,6 @@ describe('Retry Test', () => {
|
|
|
176
208
|
expect(errorSpy).not.toHaveBeenCalled();
|
|
177
209
|
});
|
|
178
210
|
|
|
179
|
-
// CustomError for testing.
|
|
180
|
-
class CustomError extends Error { }
|
|
181
211
|
|
|
182
212
|
test('throw original error', async () => {
|
|
183
213
|
jest.setTimeout(60000);
|
package/src/retry.decorator.ts
CHANGED
|
@@ -53,7 +53,7 @@ export function Retryable(options: RetryOptions): DecoratorFunction {
|
|
|
53
53
|
if (!canRetry(e)) {
|
|
54
54
|
throw e;
|
|
55
55
|
}
|
|
56
|
-
backOff && (await sleep(backOff));
|
|
56
|
+
backOff && (await sleep(applyBackoffStrategy(backOff)));
|
|
57
57
|
if (options.backOffPolicy === BackOffPolicy.ExponentialBackOffPolicy) {
|
|
58
58
|
backOff = Math.min(backOff * options.exponentialOption.multiplier, options.exponentialOption.maxInterval);
|
|
59
59
|
}
|
|
@@ -78,6 +78,22 @@ export function Retryable(options: RetryOptions): DecoratorFunction {
|
|
|
78
78
|
...options.exponentialOption,
|
|
79
79
|
};
|
|
80
80
|
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Calculate the actual backoff using the specified backoff strategy, if any
|
|
84
|
+
* @see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
|
85
|
+
* @param baseBackoff - base backoff time in ms
|
|
86
|
+
*/
|
|
87
|
+
function applyBackoffStrategy(baseBackoff: number): number {
|
|
88
|
+
const { backoffStrategy } = options.exponentialOption ?? {};
|
|
89
|
+
if (backoffStrategy === ExponentialBackoffStrategy.EqualJitter) {
|
|
90
|
+
return baseBackoff / 2 + (Math.random() * baseBackoff / 2);
|
|
91
|
+
}
|
|
92
|
+
if (backoffStrategy === ExponentialBackoffStrategy.FullJitter) {
|
|
93
|
+
return Math.random() * baseBackoff;
|
|
94
|
+
}
|
|
95
|
+
return baseBackoff;
|
|
96
|
+
}
|
|
81
97
|
}
|
|
82
98
|
|
|
83
99
|
export class MaxAttemptsError extends Error {
|
|
@@ -89,13 +105,25 @@ export class MaxAttemptsError extends Error {
|
|
|
89
105
|
} */
|
|
90
106
|
}
|
|
91
107
|
|
|
108
|
+
interface ConstructableError {
|
|
109
|
+
new (...args: any[]): Error;
|
|
110
|
+
}
|
|
111
|
+
|
|
92
112
|
export interface RetryOptions {
|
|
93
113
|
backOffPolicy?: BackOffPolicy;
|
|
94
114
|
backOff?: number;
|
|
95
115
|
doRetry?: (e: any) => boolean;
|
|
96
|
-
exponentialOption?: {
|
|
116
|
+
exponentialOption?: {
|
|
117
|
+
maxInterval: number;
|
|
118
|
+
multiplier: number;
|
|
119
|
+
/**
|
|
120
|
+
* Optional. If provided, the backoff time will include jitter using the desired strategy.
|
|
121
|
+
* For more information, see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
|
122
|
+
*/
|
|
123
|
+
backoffStrategy?: ExponentialBackoffStrategy;
|
|
124
|
+
};
|
|
97
125
|
maxAttempts: number;
|
|
98
|
-
value?:
|
|
126
|
+
value?: ConstructableError[];
|
|
99
127
|
useConsoleLogger?: boolean;
|
|
100
128
|
useOriginalError?: boolean;
|
|
101
129
|
}
|
|
@@ -105,5 +133,20 @@ export enum BackOffPolicy {
|
|
|
105
133
|
ExponentialBackOffPolicy = 'ExponentialBackOffPolicy'
|
|
106
134
|
}
|
|
107
135
|
|
|
136
|
+
/**
|
|
137
|
+
* Represents different strategies for applying jitter to backoff times.
|
|
138
|
+
* @see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
|
139
|
+
*/
|
|
140
|
+
export enum ExponentialBackoffStrategy {
|
|
141
|
+
/**
|
|
142
|
+
* The backoff time will be (base backoff time) * (random number between 0 and 1).
|
|
143
|
+
*/
|
|
144
|
+
FullJitter = 'FullJitter',
|
|
145
|
+
/**
|
|
146
|
+
* The backoff time will be (base backoff time / 2) + (random number between 0 and (base backoff time / 2)).
|
|
147
|
+
*/
|
|
148
|
+
EqualJitter = 'EqualJitter',
|
|
149
|
+
}
|
|
150
|
+
|
|
108
151
|
export type DecoratorFunction = (target: Record<string, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) => TypedPropertyDescriptor<any>;
|
|
109
152
|
|