@aws-sdk/util-retry - npm Package Compare versions

Comparing version 3.327.0 to 3.329.0

dist-cjs/config.js

@@ -10,2 +10,2 @@ "use strict";
 exports.DEFAULT_MAX_ATTEMPTS = 3;
-exports.DEFAULT_RETRY_MODE = "STANDARD";
+exports.DEFAULT_RETRY_MODE = RETRY_MODES.STANDARD;

dist-cjs/index.js

@@ -5,2 +5,3 @@ "use strict";
 tslib_1.__exportStar(require("./AdaptiveRetryStrategy"), exports);
+tslib_1.__exportStar(require("./ConfiguredRetryStrategy"), exports);
 tslib_1.__exportStar(require("./DefaultRateLimiter"), exports);
@@ -7,0 +8,0 @@ tslib_1.__exportStar(require("./StandardRetryStrategy"), exports);

dist-cjs/StandardRetryStrategy.js

@@ -8,7 +8,7 @@ "use strict";
 class StandardRetryStrategy {
-    constructor(maxAttemptsProvider) {
-        this.maxAttemptsProvider = maxAttemptsProvider;
+    constructor(maxAttempts) {
+        this.maxAttempts = maxAttempts;
         this.mode = config_1.RETRY_MODES.STANDARD;
         this.retryToken = (0, defaultRetryToken_1.getDefaultRetryToken)(constants_1.INITIAL_RETRY_TOKENS, constants_1.DEFAULT_RETRY_DELAY_BASE);
-        this.maxAttemptsProvider = maxAttemptsProvider;
+        this.maxAttemptsProvider = typeof maxAttempts === "function" ? maxAttempts : async () => maxAttempts;
     }
@@ -15,0 +15,0 @@ async acquireInitialRetryToken(retryTokenScope) {

dist-es/config.js

@@ -7,2 +7,2 @@ export var RETRY_MODES;
 export const DEFAULT_MAX_ATTEMPTS = 3;
-export const DEFAULT_RETRY_MODE = "STANDARD";
+export const DEFAULT_RETRY_MODE = RETRY_MODES.STANDARD;

dist-es/index.js

 export * from "./AdaptiveRetryStrategy";
+export * from "./ConfiguredRetryStrategy";
 export * from "./DefaultRateLimiter";
@@ -3,0 +4,0 @@ export * from "./StandardRetryStrategy";

dist-es/StandardRetryStrategy.js

@@ -5,7 +5,7 @@ import { DEFAULT_MAX_ATTEMPTS, RETRY_MODES } from "./config";
 export class StandardRetryStrategy {
-    constructor(maxAttemptsProvider) {
-        this.maxAttemptsProvider = maxAttemptsProvider;
+    constructor(maxAttempts) {
+        this.maxAttempts = maxAttempts;
         this.mode = RETRY_MODES.STANDARD;
         this.retryToken = getDefaultRetryToken(INITIAL_RETRY_TOKENS, DEFAULT_RETRY_DELAY_BASE);
-        this.maxAttemptsProvider = maxAttemptsProvider;
+        this.maxAttemptsProvider = typeof maxAttempts === "function" ? maxAttempts : async () => maxAttempts;
     }
@@ -12,0 +12,0 @@ async acquireInitialRetryToken(retryTokenScope) {

dist-types/AdaptiveRetryStrategy.d.ts

 import { Provider, RetryErrorInfo, RetryStrategyV2, RetryToken, StandardRetryToken } from "@aws-sdk/types";
 import { RateLimiter } from "./types";
 /**
- * @internal
+ * @public
  *
@@ -12,3 +12,3 @@ * Strategy options to be passed to AdaptiveRetryStrategy
 /**
- * @internal
+ * @public
  *
@@ -15,0 +15,0 @@ * The AdaptiveRetryStrategy is a retry strategy for executing against a very

dist-types/config.d.ts

 /**
- * @internal
+ * @public
  */
@@ -9,3 +9,3 @@ export declare enum RETRY_MODES {
 /**
- * @internal
+ * @public
  *
@@ -17,6 +17,6 @@ * The default value for how many HTTP requests an SDK should make for a
 /**
- * @internal
+ * @public
  *
  * The default retry algorithm to use.
  */
-export declare const DEFAULT_RETRY_MODE: RETRY_MODES;
+export declare const DEFAULT_RETRY_MODE = RETRY_MODES.STANDARD;

dist-types/constants.d.ts

 /**
- * @internal
+ * @public
  *
@@ -9,3 +9,3 @@ * The base number of milliseconds to use in calculating a suitable cool-down
 /**
- * @internal
+ * @public
  *
@@ -17,3 +17,3 @@ * The maximum amount of time (in milliseconds) that will be used as a delay
 /**
- * @internal
+ * @public
  *
@@ -25,3 +25,3 @@ * The retry delay base (in milliseconds) to use when a throttling error is
 /**
- * @internal
+ * @public
  *
@@ -32,3 +32,3 @@ * Initial number of retry tokens in Retry Quota
 /**
- * @internal
+ * @public
  *
@@ -39,3 +39,3 @@ * The total amount of retry tokens to be decremented from retry token balance.
 /**
- * @internal
+ * @public
  *
@@ -47,3 +47,3 @@ * The total amount of retry tokens to be decremented from retry token balance
 /**
- * @internal
+ * @public
  *
@@ -55,3 +55,3 @@ * The total amount of retry token to be incremented from retry token balance
 /**
- * @internal
+ * @public
  *
@@ -62,3 +62,3 @@ * Header name for SDK invocation ID
 /**
- * @internal
+ * @public
  *
@@ -65,0 +65,0 @@ * Header name for request retry information.

dist-types/DefaultRateLimiter.d.ts

 import { RateLimiter } from "./types";
 /**
- * @internal
+ * @public
  */
@@ -13,3 +13,3 @@ export interface DefaultRateLimiterOptions {
 /**
- * @internal
+ * @public
  */
@@ -16,0 +16,0 @@ export declare class DefaultRateLimiter implements RateLimiter {

dist-types/defaultRetryToken.d.ts

 import { StandardRetryBackoffStrategy, StandardRetryToken } from "@aws-sdk/types";
 /**
- * @internal
+ * @public
  */
@@ -5,0 +5,0 @@ export interface DefaultRetryTokenOptions {

dist-types/index.d.ts

@@ -1,24 +0,7 @@
-/**
- * @internal
- */
 export * from "./AdaptiveRetryStrategy";
-/**
- * @internal
- */
+export * from "./ConfiguredRetryStrategy";
 export * from "./DefaultRateLimiter";
-/**
- * @internal
- */
 export * from "./StandardRetryStrategy";
-/**
- * @internal
- */
 export * from "./config";
-/**
- * @internal
- */
 export * from "./constants";
-/**
- * @internal
- */
 export * from "./types";

dist-types/StandardRetryStrategy.d.ts

 import { Provider, RetryErrorInfo, RetryStrategyV2, StandardRetryToken } from "@aws-sdk/types";
 /**
- * @internal
+ * @public
  */
 export declare class StandardRetryStrategy implements RetryStrategyV2 {
+    private readonly maxAttempts;
+    readonly mode: string;
+    private retryToken;
     private readonly maxAttemptsProvider;
-    private retryToken;
-    readonly mode: string;
+    constructor(maxAttempts: number);
     constructor(maxAttemptsProvider: Provider<number>);
@@ -10,0 +12,0 @@ acquireInitialRetryToken(retryTokenScope: string): Promise<StandardRetryToken>;

dist-types/ts3.4/config.d.ts

@@ -6,2 +6,2 @@ export declare enum RETRY_MODES {
 export declare const DEFAULT_MAX_ATTEMPTS = 3;
-export declare const DEFAULT_RETRY_MODE: RETRY_MODES;
+export declare const DEFAULT_RETRY_MODE = RETRY_MODES.STANDARD;

dist-types/ts3.4/index.d.ts

 export * from "./AdaptiveRetryStrategy";
+export * from "./ConfiguredRetryStrategy";
 export * from "./DefaultRateLimiter";
@@ -3,0 +4,0 @@ export * from "./StandardRetryStrategy";

dist-types/ts3.4/StandardRetryStrategy.d.ts

@@ -8,5 +8,7 @@ import {
 export declare class StandardRetryStrategy implements RetryStrategyV2 {
+  private readonly maxAttempts;
+  readonly mode: string;
+  private retryToken;
   private readonly maxAttemptsProvider;
-  private retryToken;
-  readonly mode: string;
+  constructor(maxAttempts: number);
   constructor(maxAttemptsProvider: Provider<number>);
@@ -13,0 +15,0 @@ acquireInitialRetryToken(

package.json

 {
   "name": "@aws-sdk/util-retry",
-  "version": "3.327.0",
+  "version": "3.329.0",
   "description": "Shared retry utilities to be used in middleware packages.",
@@ -27,7 +27,7 @@ "main": "./dist-cjs/index.js",
   "dependencies": {
-    "@aws-sdk/service-error-classification": "3.327.0",
+    "@aws-sdk/service-error-classification": "3.329.0",
     "tslib": "^2.5.0"
   },
   "devDependencies": {
-    "@aws-sdk/types": "3.310.0",
+    "@aws-sdk/types": "3.329.0",
     "@tsconfig/recommended": "1.0.1",
@@ -34,0 +34,0 @@ "@types/node": "^14.14.31",

README.md

@@ -6,4 +6,2 @@ # @aws-sdk/util-retry
 
-> An internal package
-
 This package provides shared utilities for retries.
@@ -13,2 +11,55 @@
 
-You probably shouldn't, at least directly.
+### Default
+
+By default, each client already has a default retry strategy. The default retry count is 3, and
+only retryable errors will be retried.
+
+[AWS Documentation: Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html).
+
+```js
+import { S3Client } from "@aws-sdk/client-s3";
+
+const client = new S3Client({}); // default retry strategy included.
+```
+
+### MaxAttempts
+
+If you want to change the number of attempts, you can use the `StandardRetryStrategy` from `@aws-sdk/util-retry`.
+
+```js
+import { S3Client } from "@aws-sdk/client-s3";
+import { StandardRetryStrategy } from "@aws-sdk/util-retry";
+
+const client = new S3Client({
+  // custom max number of attempts.
+  retryStrategy: new StandardRetryStrategy(4),
+});
+```
+
+This is recommended because the `StandardRetryStrategy` includes backoff calculation,
+deciding whether an error should be retried, and a retry token counter.
+
+### MaxAttempts and BackoffComputation
+
+If you want to change the number of attempts and use a custom delay
+computation, you can use the `ConfiguredRetryStrategy` from `@aws-sdk/util-retry`.
+
+```js
+import { S3Client } from "@aws-sdk/client-s3";
+import { ConfiguredRetryStrategy } from "@aws-sdk/util-retry";
+
+const client = new S3Client({
+  retryStrategy: new ConfiguredRetryStrategy(
+    4, // max attempts.
+    (attempt: number) => 100 + attempt * 1000 // backoff function.
+  ),
+});
+```
+
+This example sets the backoff at 100ms plus 1s per attempt.
+
+### Further customization
+
+You can implement the `RetryStrategyV2` interface.
+
+https://github.com/aws/aws-sdk-js-v3/blob/main/packages/types/src/retry.ts

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

54768

increased by11.9%

Number of package files

43

increased by10.26%

Lines of code

1002

increased by9.39%

Number of lines in readme file

64

increased by392.31%

Dependency changes

• + Added@aws-sdk/service-error-classification@3.329.0(transitive)

• - Removed@aws-sdk/service-error-classification@3.327.0(transitive)

• Updated@aws-sdk/service-error-classification@3.329.0