@fluidframework/driver-utils 0.50.3 → 0.51.2

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/driver-utils";
-export declare const pkgVersion = "0.50.3";
+export declare const pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/driver-utils";
-exports.pkgVersion = "0.50.3";
+exports.pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"0.50.3\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"0.51.2\";\n"]}

package/dist/runWithRetry.d.ts

@@ -3,5 +3,31 @@
  * Licensed under the MIT License.
  */
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-export declare function runWithRetry<T>(api: () => Promise<T>, fetchCallName: string, refreshDelayInfo: (id: string) => void, emitDelayInfo: (id: string, retryInMs: number, err: any) => void, logger: ITelemetryLogger, checkRetry?: () => void): Promise<T>;
+/**
+ * Interface describing an object passed to various network APIs.
+ * It allows caller to control cancellation, as well as learn about any delays.
+ */
+export interface IProgress {
+    /**
+     * Abort signal used to cancel operation
+     * Note that most of the layers do not use this signal yet. We need to change that over time.
+     * Please consult with API documentation / implementation.
+     * Note that  number of layers may not check this signal while holding this request in a queue,
+     * so it may take a while it takes effect. This can be improved in the future.
+     * Layers in question are:
+     *    - driver (RateLimiter)
+     *    - runWithRetry
+     */
+    cancel?: AbortSignal;
+    /**
+     * Called whenever api returns cancellable error and the call is going to be retried.
+     * Any exception thrown from this call back result in cancellation of operation
+     * and propagation of thrown exception.
+     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,
+     * as well as information provided by service (like 429 error asking to wait for some time before retry)
+     * @param error - error object returned from the call.
+     */
+    retry?(delayInMs: number, error: any): void;
+}
+export declare function runWithRetry<T>(api: (cancel?: AbortSignal) => Promise<T>, fetchCallName: string, logger: ITelemetryLogger, progress: IProgress): Promise<T>;
 //# sourceMappingURL=runWithRetry.d.ts.map

package/dist/runWithRetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,EACtC,aAAa,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,IAAI,EAChE,MAAM,EAAE,gBAAgB,EACxB,UAAU,CAAC,EAAE,MAAM,IAAI,GACxB,OAAO,CAAC,CAAC,CAAC,CAkDZ"}
+{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;;OAOG;IACH,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CAC/C;AAED,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,SAAS,GACpB,OAAO,CAAC,CAAC,CAAC,CA0CZ"}

package/dist/runWithRetry.js

@@ -5,10 +5,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runWithRetry = void 0;
-const uuid_1 = require("uuid");
 const common_utils_1 = require("@fluidframework/common-utils");
 const network_1 = require("./network");
-async function runWithRetry(api, fetchCallName, refreshDelayInfo, emitDelayInfo, logger, checkRetry) {
+async function runWithRetry(api, fetchCallName, logger, progress) {
     var _a;
     let result;
     let success = false;
@@ -16,22 +15,15 @@ async function runWithRetry(api, fetchCallName, refreshDelayInfo, emitDelayInfo,
     let numRetries = 0;
     const startTime = common_utils_1.performance.now();
     let lastError;
-    let id;
     do {
         try {
-            result = await api();
-            if (id !== undefined) {
-                refreshDelayInfo(id);
-            }
+            result = await api(progress.cancel);
             success = true;
         }
         catch (err) {
-            if (checkRetry !== undefined) {
-                checkRetry();
-            }
             // If it is not retriable, then just throw the error.
             if (!network_1.canRetryOnError(err)) {
-                logger.sendErrorEvent({
+                logger.sendTelemetryEvent({
                     eventName: `${fetchCallName}_cancel`,
                     retry: numRetries,
                     duration: common_utils_1.performance.now() - startTime,
@@ -43,10 +35,9 @@ async function runWithRetry(api, fetchCallName, refreshDelayInfo, emitDelayInfo,
             // If the error is throttling error, then wait for the specified time before retrying.
             // If the waitTime is not specified, then we start with retrying immediately to max of 8s.
             retryAfterMs = (_a = network_1.getRetryDelayFromError(err)) !== null && _a !== void 0 ? _a : Math.min(retryAfterMs * 2, 8000);
-            if (id === undefined) {
-                id = uuid_1.v4();
+            if (progress.retry) {
+                progress.retry(retryAfterMs, err);
             }
-            emitDelayInfo(id, retryAfterMs, err);
             await common_utils_1.delay(retryAfterMs);
         }
     } while (!success);

package/dist/runWithRetry.js.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAElC,+DAAkE;AAClE,uCAAoE;AAE7D,KAAK,UAAU,YAAY,CAC9B,GAAqB,EACrB,aAAqB,EACrB,gBAAsC,EACtC,aAAgE,EAChE,MAAwB,EACxB,UAAuB;;IAEvB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,IAAI,EAAsB,CAAC;IAC3B,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;YACrB,IAAI,EAAE,KAAK,SAAS,EAAE;gBAClB,gBAAgB,CAAC,EAAE,CAAC,CAAC;aACxB;YACD,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,UAAU,EAAE,CAAC;aAChB;YACD,qDAAqD;YACrD,IAAI,CAAC,yBAAe,CAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,cAAc,CAAC;oBAClB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;iBAC1C,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YACD,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,SAAG,gCAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,EAAE,KAAK,SAAS,EAAE;gBAClB,EAAE,GAAG,SAAI,EAAE,CAAC;aACf;YACD,aAAa,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;YACrC,MAAM,oBAAK,CAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SAC1C,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC;AAzDD,oCAyDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\n\nexport async function runWithRetry<T>(\n    api: () => Promise<T>,\n    fetchCallName: string,\n    refreshDelayInfo: (id: string) => void,\n    emitDelayInfo: (id: string, retryInMs: number, err: any) => void,\n    logger: ITelemetryLogger,\n    checkRetry?: () => void,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    let id: string | undefined;\n    do {\n        try {\n            result = await api();\n            if (id !== undefined) {\n                refreshDelayInfo(id);\n            }\n            success = true;\n        } catch (err) {\n            if (checkRetry !== undefined) {\n                checkRetry();\n            }\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendErrorEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                }, err);\n                throw err;\n            }\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (id === undefined) {\n                id = uuid();\n            }\n            emitDelayInfo(id, retryAfterMs, err);\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}
+{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAkE;AAClE,uCAAoE;AA8B7D,KAAK,UAAU,YAAY,CAC9B,GAAyC,EACzC,aAAqB,EACrB,MAAwB,EACxB,QAAmB;;IAEnB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,qDAAqD;YACrD,IAAI,CAAC,yBAAe,CAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;iBAC1C,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YACD,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,SAAG,gCAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;aACrC;YACD,MAAM,oBAAK,CAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SAC1C,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC;AA/CD,oCA+CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\n\n/**\n * Interface describing an object passed to various network APIs.\n * It allows caller to control cancellation, as well as learn about any delays.\n */\nexport interface IProgress {\n    /**\n     * Abort signal used to cancel operation\n     * Note that most of the layers do not use this signal yet. We need to change that over time.\n     * Please consult with API documentation / implementation.\n     * Note that  number of layers may not check this signal while holding this request in a queue,\n     * so it may take a while it takes effect. This can be improved in the future.\n     * Layers in question are:\n     *    - driver (RateLimiter)\n     *    - runWithRetry\n     */\n    cancel?: AbortSignal;\n\n    /**\n     * Called whenever api returns cancellable error and the call is going to be retried.\n     * Any exception thrown from this call back result in cancellation of operation\n     * and propagation of thrown exception.\n     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,\n     * as well as information provided by service (like 429 error asking to wait for some time before retry)\n     * @param error - error object returned from the call.\n     */\n    retry?(delayInMs: number, error: any): void;\n}\n\nexport async function runWithRetry<T>(\n    api: (cancel?: AbortSignal) => Promise<T>,\n    fetchCallName: string,\n    logger: ITelemetryLogger,\n    progress: IProgress,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    do {\n        try {\n            result = await api(progress.cancel);\n            success = true;\n        } catch (err) {\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                }, err);\n                throw err;\n            }\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (progress.retry) {\n                progress.retry(retryAfterMs, err);\n            }\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/driver-utils";
-export declare const pkgVersion = "0.50.3";
+export declare const pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "0.50.3";
+export const pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,8BAA8B,CAAC;AACtD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"0.50.3\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,8BAA8B,CAAC;AACtD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"0.51.2\";\n"]}

package/lib/runWithRetry.d.ts

@@ -3,5 +3,31 @@
  * Licensed under the MIT License.
  */
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-export declare function runWithRetry<T>(api: () => Promise<T>, fetchCallName: string, refreshDelayInfo: (id: string) => void, emitDelayInfo: (id: string, retryInMs: number, err: any) => void, logger: ITelemetryLogger, checkRetry?: () => void): Promise<T>;
+/**
+ * Interface describing an object passed to various network APIs.
+ * It allows caller to control cancellation, as well as learn about any delays.
+ */
+export interface IProgress {
+    /**
+     * Abort signal used to cancel operation
+     * Note that most of the layers do not use this signal yet. We need to change that over time.
+     * Please consult with API documentation / implementation.
+     * Note that  number of layers may not check this signal while holding this request in a queue,
+     * so it may take a while it takes effect. This can be improved in the future.
+     * Layers in question are:
+     *    - driver (RateLimiter)
+     *    - runWithRetry
+     */
+    cancel?: AbortSignal;
+    /**
+     * Called whenever api returns cancellable error and the call is going to be retried.
+     * Any exception thrown from this call back result in cancellation of operation
+     * and propagation of thrown exception.
+     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,
+     * as well as information provided by service (like 429 error asking to wait for some time before retry)
+     * @param error - error object returned from the call.
+     */
+    retry?(delayInMs: number, error: any): void;
+}
+export declare function runWithRetry<T>(api: (cancel?: AbortSignal) => Promise<T>, fetchCallName: string, logger: ITelemetryLogger, progress: IProgress): Promise<T>;
 //# sourceMappingURL=runWithRetry.d.ts.map

package/lib/runWithRetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,EACtC,aAAa,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,IAAI,EAChE,MAAM,EAAE,gBAAgB,EACxB,UAAU,CAAC,EAAE,MAAM,IAAI,GACxB,OAAO,CAAC,CAAC,CAAC,CAkDZ"}
+{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;;OAOG;IACH,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CAC/C;AAED,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,SAAS,GACpB,OAAO,CAAC,CAAC,CAAC,CA0CZ"}

package/lib/runWithRetry.js

@@ -2,10 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { v4 as uuid } from "uuid";
 import { delay, performance } from "@fluidframework/common-utils";
 import { canRetryOnError, getRetryDelayFromError } from "./network";
-export async function runWithRetry(api, fetchCallName, refreshDelayInfo, emitDelayInfo, logger, checkRetry) {
+export async function runWithRetry(api, fetchCallName, logger, progress) {
     var _a;
     let result;
     let success = false;
@@ -13,22 +12,15 @@ export async function runWithRetry(api, fetchCallName, refreshDelayInfo, emitDel
     let numRetries = 0;
     const startTime = performance.now();
     let lastError;
-    let id;
     do {
         try {
-            result = await api();
-            if (id !== undefined) {
-                refreshDelayInfo(id);
-            }
+            result = await api(progress.cancel);
             success = true;
         }
         catch (err) {
-            if (checkRetry !== undefined) {
-                checkRetry();
-            }
             // If it is not retriable, then just throw the error.
             if (!canRetryOnError(err)) {
-                logger.sendErrorEvent({
+                logger.sendTelemetryEvent({
                     eventName: `${fetchCallName}_cancel`,
                     retry: numRetries,
                     duration: performance.now() - startTime,
@@ -40,10 +32,9 @@ export async function runWithRetry(api, fetchCallName, refreshDelayInfo, emitDel
             // If the error is throttling error, then wait for the specified time before retrying.
             // If the waitTime is not specified, then we start with retrying immediately to max of 8s.
             retryAfterMs = (_a = getRetryDelayFromError(err)) !== null && _a !== void 0 ? _a : Math.min(retryAfterMs * 2, 8000);
-            if (id === undefined) {
-                id = uuid();
+            if (progress.retry) {
+                progress.retry(retryAfterMs, err);
             }
-            emitDelayInfo(id, retryAfterMs, err);
             await delay(retryAfterMs);
         }
     } while (!success);

package/lib/runWithRetry.js.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAEpE,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,GAAqB,EACrB,aAAqB,EACrB,gBAAsC,EACtC,aAAgE,EAChE,MAAwB,EACxB,UAAuB;;IAEvB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,IAAI,EAAsB,CAAC;IAC3B,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;YACrB,IAAI,EAAE,KAAK,SAAS,EAAE;gBAClB,gBAAgB,CAAC,EAAE,CAAC,CAAC;aACxB;YACD,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,UAAU,EAAE,CAAC;aAChB;YACD,qDAAqD;YACrD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,cAAc,CAAC;oBAClB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;iBAC1C,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YACD,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,SAAG,sBAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,EAAE,KAAK,SAAS,EAAE;gBAClB,EAAE,GAAG,IAAI,EAAE,CAAC;aACf;YACD,aAAa,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;YACrC,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SAC1C,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\n\nexport async function runWithRetry<T>(\n    api: () => Promise<T>,\n    fetchCallName: string,\n    refreshDelayInfo: (id: string) => void,\n    emitDelayInfo: (id: string, retryInMs: number, err: any) => void,\n    logger: ITelemetryLogger,\n    checkRetry?: () => void,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    let id: string | undefined;\n    do {\n        try {\n            result = await api();\n            if (id !== undefined) {\n                refreshDelayInfo(id);\n            }\n            success = true;\n        } catch (err) {\n            if (checkRetry !== undefined) {\n                checkRetry();\n            }\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendErrorEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                }, err);\n                throw err;\n            }\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (id === undefined) {\n                id = uuid();\n            }\n            emitDelayInfo(id, retryAfterMs, err);\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}
+{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AA8BpE,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,GAAyC,EACzC,aAAqB,EACrB,MAAwB,EACxB,QAAmB;;IAEnB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,qDAAqD;YACrD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;iBAC1C,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YACD,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,SAAG,sBAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;aACrC;YACD,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SAC1C,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\n\n/**\n * Interface describing an object passed to various network APIs.\n * It allows caller to control cancellation, as well as learn about any delays.\n */\nexport interface IProgress {\n    /**\n     * Abort signal used to cancel operation\n     * Note that most of the layers do not use this signal yet. We need to change that over time.\n     * Please consult with API documentation / implementation.\n     * Note that  number of layers may not check this signal while holding this request in a queue,\n     * so it may take a while it takes effect. This can be improved in the future.\n     * Layers in question are:\n     *    - driver (RateLimiter)\n     *    - runWithRetry\n     */\n    cancel?: AbortSignal;\n\n    /**\n     * Called whenever api returns cancellable error and the call is going to be retried.\n     * Any exception thrown from this call back result in cancellation of operation\n     * and propagation of thrown exception.\n     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,\n     * as well as information provided by service (like 429 error asking to wait for some time before retry)\n     * @param error - error object returned from the call.\n     */\n    retry?(delayInMs: number, error: any): void;\n}\n\nexport async function runWithRetry<T>(\n    api: (cancel?: AbortSignal) => Promise<T>,\n    fetchCallName: string,\n    logger: ITelemetryLogger,\n    progress: IProgress,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    do {\n        try {\n            result = await api(progress.cancel);\n            success = true;\n        } catch (err) {\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                }, err);\n                throw err;\n            }\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (progress.retry) {\n                progress.retry(retryAfterMs, err);\n            }\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "0.50.3",
+  "version": "0.51.2",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -62,21 +62,21 @@
     "@fluidframework/gitresources": "^0.1033.0",
     "@fluidframework/protocol-base": "^0.1033.0",
     "@fluidframework/protocol-definitions": "^0.1025.0",
-    "@fluidframework/telemetry-utils": "^0.50.3",
+    "@fluidframework/telemetry-utils": "^0.51.2",
     "axios": "^0.21.1",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@fluidframework/mocha-test-setup": "^0.50.3",
-    "@fluidframework/runtime-utils": "^0.50.3",
+    "@fluidframework/eslint-config-fluid": "^0.24.0",
+    "@fluidframework/mocha-test-setup": "^0.51.2",
+    "@fluidframework/runtime-utils": "^0.51.2",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/mocha": "^8.2.2",
     "@types/node": "^12.19.0",
     "@typescript-eslint/eslint-plugin": "~4.14.0",
     "@typescript-eslint/parser": "~4.14.0",
-    "concurrently": "^5.2.0",
+    "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "cross-env": "^7.0.2",
     "eslint": "~7.18.0",

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "0.50.3";
+export const pkgVersion = "0.51.2";

package/src/runWithRetry.ts

@@ -3,18 +3,43 @@
  * Licensed under the MIT License.
  */
 
-import { v4 as uuid } from "uuid";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { delay, performance } from "@fluidframework/common-utils";
 import { canRetryOnError, getRetryDelayFromError } from "./network";
 
+/**
+ * Interface describing an object passed to various network APIs.
+ * It allows caller to control cancellation, as well as learn about any delays.
+ */
+export interface IProgress {
+    /**
+     * Abort signal used to cancel operation
+     * Note that most of the layers do not use this signal yet. We need to change that over time.
+     * Please consult with API documentation / implementation.
+     * Note that  number of layers may not check this signal while holding this request in a queue,
+     * so it may take a while it takes effect. This can be improved in the future.
+     * Layers in question are:
+     *    - driver (RateLimiter)
+     *    - runWithRetry
+     */
+    cancel?: AbortSignal;
+
+    /**
+     * Called whenever api returns cancellable error and the call is going to be retried.
+     * Any exception thrown from this call back result in cancellation of operation
+     * and propagation of thrown exception.
+     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,
+     * as well as information provided by service (like 429 error asking to wait for some time before retry)
+     * @param error - error object returned from the call.
+     */
+    retry?(delayInMs: number, error: any): void;
+}
+
 export async function runWithRetry<T>(
-    api: () => Promise<T>,
+    api: (cancel?: AbortSignal) => Promise<T>,
     fetchCallName: string,
-    refreshDelayInfo: (id: string) => void,
-    emitDelayInfo: (id: string, retryInMs: number, err: any) => void,
     logger: ITelemetryLogger,
-    checkRetry?: () => void,
+    progress: IProgress,
 ): Promise<T> {
     let result: T | undefined;
     let success = false;
@@ -22,21 +47,14 @@ export async function runWithRetry<T>(
     let numRetries = 0;
     const startTime = performance.now();
     let lastError: any;
-    let id: string | undefined;
     do {
         try {
-            result = await api();
-            if (id !== undefined) {
-                refreshDelayInfo(id);
-            }
+            result = await api(progress.cancel);
             success = true;
         } catch (err) {
-            if (checkRetry !== undefined) {
-                checkRetry();
-            }
             // If it is not retriable, then just throw the error.
             if (!canRetryOnError(err)) {
-                logger.sendErrorEvent({
+                logger.sendTelemetryEvent({
                     eventName: `${fetchCallName}_cancel`,
                     retry: numRetries,
                     duration: performance.now() - startTime,
@@ -48,10 +66,9 @@ export async function runWithRetry<T>(
             // If the error is throttling error, then wait for the specified time before retrying.
             // If the waitTime is not specified, then we start with retrying immediately to max of 8s.
             retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);
-            if (id === undefined) {
-                id = uuid();
+            if (progress.retry) {
+                progress.retry(retryAfterMs, err);
             }
-            emitDelayInfo(id, retryAfterMs, err);
             await delay(retryAfterMs);
         }
     } while (!success);