@azure/core-util - npm Package Compare versions

Comparing version 1.9.3-alpha.20240808.1 to 1.9.3-alpha.20240809.2

dist/browser/delay.d.ts

@@ -14,2 +14,14 @@ import type { AbortOptions } from "./aborterUtils.js";
 export declare function delay(timeInMs: number, options?: DelayOptions): Promise<void>;
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export declare function calculateRetryDelay(retryAttempt: number, config: {
+    retryDelayInMs: number;
+    maxRetryDelayInMs: number;
+}): {
+    retryAfterInMs: number;
+};
 //# sourceMappingURL=delay.d.ts.map

dist/browser/delay.js

 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 import { createAbortablePromise } from "./createAbortablePromise.js";
+import { getRandomIntegerInclusive } from "./random.js";
 const StandardAbortMessage = "The delay was aborted.";
@@ -22,2 +23,18 @@ /**
 }
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export function calculateRetryDelay(retryAttempt, config) {
+    // Exponentially increase the delay each time
+    const exponentialDelay = config.retryDelayInMs * Math.pow(2, retryAttempt);
+    // Don't let the delay exceed the maximum
+    const clampedDelay = Math.min(config.maxRetryDelayInMs, exponentialDelay);
+    // Allow the final value to have some "jitter" (within 50% of the delay size) so
+    // that retries across multiple clients don't occur simultaneously.
+    const retryAfterInMs = clampedDelay / 2 + getRandomIntegerInclusive(0, clampedDelay / 2);
+    return { retryAfterInMs };
+}
 //# sourceMappingURL=delay.js.map

dist/browser/index.d.ts

@@ -1,2 +0,2 @@
-export { delay, type DelayOptions } from "./delay.js";
+export { delay, type DelayOptions, calculateRetryDelay } from "./delay.js";
 export { type AbortOptions, cancelablePromiseRace, type AbortablePromiseBuilder, } from "./aborterUtils.js";
@@ -3,0 +3,0 @@ export { createAbortablePromise, type CreateAbortablePromiseOptions, } from "./createAbortablePromise.js";

dist/browser/index.js

 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-export { delay } from "./delay.js";
+export { delay, calculateRetryDelay } from "./delay.js";
 export { cancelablePromiseRace, } from "./aborterUtils.js";
@@ -5,0 +5,0 @@ export { createAbortablePromise, } from "./createAbortablePromise.js";

dist/commonjs/delay.d.ts

@@ -14,2 +14,14 @@ import type { AbortOptions } from "./aborterUtils.js";
 export declare function delay(timeInMs: number, options?: DelayOptions): Promise<void>;
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export declare function calculateRetryDelay(retryAttempt: number, config: {
+    retryDelayInMs: number;
+    maxRetryDelayInMs: number;
+}): {
+    retryAfterInMs: number;
+};
 //# sourceMappingURL=delay.d.ts.map

dist/commonjs/delay.js

@@ -6,3 +6,5 @@ "use strict";
 exports.delay = delay;
+exports.calculateRetryDelay = calculateRetryDelay;
 const createAbortablePromise_js_1 = require("./createAbortablePromise.js");
+const random_js_1 = require("./random.js");
 const StandardAbortMessage = "The delay was aborted.";
@@ -26,2 +28,18 @@ /**
 }
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+function calculateRetryDelay(retryAttempt, config) {
+    // Exponentially increase the delay each time
+    const exponentialDelay = config.retryDelayInMs * Math.pow(2, retryAttempt);
+    // Don't let the delay exceed the maximum
+    const clampedDelay = Math.min(config.maxRetryDelayInMs, exponentialDelay);
+    // Allow the final value to have some "jitter" (within 50% of the delay size) so
+    // that retries across multiple clients don't occur simultaneously.
+    const retryAfterInMs = clampedDelay / 2 + (0, random_js_1.getRandomIntegerInclusive)(0, clampedDelay / 2);
+    return { retryAfterInMs };
+}
 //# sourceMappingURL=delay.js.map

dist/commonjs/index.d.ts

@@ -1,2 +0,2 @@
-export { delay, type DelayOptions } from "./delay.js";
+export { delay, type DelayOptions, calculateRetryDelay } from "./delay.js";
 export { type AbortOptions, cancelablePromiseRace, type AbortablePromiseBuilder, } from "./aborterUtils.js";
@@ -3,0 +3,0 @@ export { createAbortablePromise, type CreateAbortablePromiseOptions, } from "./createAbortablePromise.js";

dist/commonjs/index.js

@@ -5,5 +5,6 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringToUint8Array = exports.uint8ArrayToString = exports.isWebWorker = exports.isReactNative = exports.isDeno = exports.isNodeRuntime = exports.isNodeLike = exports.isNode = exports.isBun = exports.isBrowser = exports.randomUUID = exports.objectHasProperty = exports.isObjectWithProperties = exports.isDefined = exports.computeSha256Hmac = exports.computeSha256Hash = exports.getErrorMessage = exports.isError = exports.isObject = exports.getRandomIntegerInclusive = exports.createAbortablePromise = exports.cancelablePromiseRace = exports.delay = void 0;
+exports.stringToUint8Array = exports.uint8ArrayToString = exports.isWebWorker = exports.isReactNative = exports.isDeno = exports.isNodeRuntime = exports.isNodeLike = exports.isNode = exports.isBun = exports.isBrowser = exports.randomUUID = exports.objectHasProperty = exports.isObjectWithProperties = exports.isDefined = exports.computeSha256Hmac = exports.computeSha256Hash = exports.getErrorMessage = exports.isError = exports.isObject = exports.getRandomIntegerInclusive = exports.createAbortablePromise = exports.cancelablePromiseRace = exports.calculateRetryDelay = exports.delay = void 0;
 var delay_js_1 = require("./delay.js");
 Object.defineProperty(exports, "delay", { enumerable: true, get: function () { return delay_js_1.delay; } });
+Object.defineProperty(exports, "calculateRetryDelay", { enumerable: true, get: function () { return delay_js_1.calculateRetryDelay; } });
 var aborterUtils_js_1 = require("./aborterUtils.js");
@@ -10,0 +11,0 @@ Object.defineProperty(exports, "cancelablePromiseRace", { enumerable: true, get: function () { return aborterUtils_js_1.cancelablePromiseRace; } });

dist/core-util.d.ts

@@ -25,2 +25,15 @@ import type { AbortSignalLike } from '@azure/abort-controller';
 /**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export declare function calculateRetryDelay(retryAttempt: number, config: {
+    retryDelayInMs: number;
+    maxRetryDelayInMs: number;
+}): {
+    retryAfterInMs: number;
+};
+
+/**
  * promise.race() wrapper that aborts rest of promises as soon as the first promise settles.
@@ -27,0 +40,0 @@ */

dist/esm/delay.d.ts

@@ -14,2 +14,14 @@ import type { AbortOptions } from "./aborterUtils.js";
 export declare function delay(timeInMs: number, options?: DelayOptions): Promise<void>;
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export declare function calculateRetryDelay(retryAttempt: number, config: {
+    retryDelayInMs: number;
+    maxRetryDelayInMs: number;
+}): {
+    retryAfterInMs: number;
+};
 //# sourceMappingURL=delay.d.ts.map

dist/esm/delay.js

 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 import { createAbortablePromise } from "./createAbortablePromise.js";
+import { getRandomIntegerInclusive } from "./random.js";
 const StandardAbortMessage = "The delay was aborted.";
@@ -22,2 +23,18 @@ /**
 }
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export function calculateRetryDelay(retryAttempt, config) {
+    // Exponentially increase the delay each time
+    const exponentialDelay = config.retryDelayInMs * Math.pow(2, retryAttempt);
+    // Don't let the delay exceed the maximum
+    const clampedDelay = Math.min(config.maxRetryDelayInMs, exponentialDelay);
+    // Allow the final value to have some "jitter" (within 50% of the delay size) so
+    // that retries across multiple clients don't occur simultaneously.
+    const retryAfterInMs = clampedDelay / 2 + getRandomIntegerInclusive(0, clampedDelay / 2);
+    return { retryAfterInMs };
+}
 //# sourceMappingURL=delay.js.map

dist/esm/index.d.ts

@@ -1,2 +0,2 @@
-export { delay, type DelayOptions } from "./delay.js";
+export { delay, type DelayOptions, calculateRetryDelay } from "./delay.js";
 export { type AbortOptions, cancelablePromiseRace, type AbortablePromiseBuilder, } from "./aborterUtils.js";
@@ -3,0 +3,0 @@ export { createAbortablePromise, type CreateAbortablePromiseOptions, } from "./createAbortablePromise.js";

dist/esm/index.js

 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-export { delay } from "./delay.js";
+export { delay, calculateRetryDelay } from "./delay.js";
 export { cancelablePromiseRace, } from "./aborterUtils.js";
@@ -5,0 +5,0 @@ export { createAbortablePromise, } from "./createAbortablePromise.js";

dist/react-native/delay.d.ts

@@ -14,2 +14,14 @@ import type { AbortOptions } from "./aborterUtils.js";
 export declare function delay(timeInMs: number, options?: DelayOptions): Promise<void>;
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export declare function calculateRetryDelay(retryAttempt: number, config: {
+    retryDelayInMs: number;
+    maxRetryDelayInMs: number;
+}): {
+    retryAfterInMs: number;
+};
 //# sourceMappingURL=delay.d.ts.map

dist/react-native/delay.js

 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 import { createAbortablePromise } from "./createAbortablePromise.js";
+import { getRandomIntegerInclusive } from "./random.js";
 const StandardAbortMessage = "The delay was aborted.";
@@ -22,2 +23,18 @@ /**
 }
+/**
+ * Calculates the delay interval for retry attempts using exponential delay with jitter.
+ * @param retryAttempt - The current retry attempt number.
+ * @param config - The exponential retry configuration.
+ * @returns An object containing the calculated retry delay.
+ */
+export function calculateRetryDelay(retryAttempt, config) {
+    // Exponentially increase the delay each time
+    const exponentialDelay = config.retryDelayInMs * Math.pow(2, retryAttempt);
+    // Don't let the delay exceed the maximum
+    const clampedDelay = Math.min(config.maxRetryDelayInMs, exponentialDelay);
+    // Allow the final value to have some "jitter" (within 50% of the delay size) so
+    // that retries across multiple clients don't occur simultaneously.
+    const retryAfterInMs = clampedDelay / 2 + getRandomIntegerInclusive(0, clampedDelay / 2);
+    return { retryAfterInMs };
+}
 //# sourceMappingURL=delay.js.map

dist/react-native/index.d.ts

@@ -1,2 +0,2 @@
-export { delay, type DelayOptions } from "./delay.js";
+export { delay, type DelayOptions, calculateRetryDelay } from "./delay.js";
 export { type AbortOptions, cancelablePromiseRace, type AbortablePromiseBuilder, } from "./aborterUtils.js";
@@ -3,0 +3,0 @@ export { createAbortablePromise, type CreateAbortablePromiseOptions, } from "./createAbortablePromise.js";

dist/react-native/index.js

 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-export { delay } from "./delay.js";
+export { delay, calculateRetryDelay } from "./delay.js";
 export { cancelablePromiseRace, } from "./aborterUtils.js";
@@ -5,0 +5,0 @@ export { createAbortablePromise, } from "./createAbortablePromise.js";

package.json

 {
   "name": "@azure/core-util",
-  "version": "1.9.3-alpha.20240808.1",
+  "version": "1.9.3-alpha.20240809.2",
   "description": "Core library for shared utility methods",
@@ -5,0 +5,0 @@ "sdk-type": "client",

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

320033

increased by4.3%

Lines of code

3327

increased by4.07%

No dependency changes