@fluidframework/driver-utils 2.0.0-rc.1.0.4 → 2.0.0-rc.2.0.0

package/lib/test/parallelRequests.spec.js

@@ -0,0 +1,186 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { unreachableCase } from "@fluidframework/core-utils";
+import { ParallelRequests } from "../parallelRequests.js";
+var HowMany;
+(function (HowMany) {
+    HowMany[HowMany["Exact"] = 0] = "Exact";
+    HowMany[HowMany["Partial"] = 1] = "Partial";
+    HowMany[HowMany["TooMany"] = 2] = "TooMany";
+})(HowMany || (HowMany = {}));
+describe("Parallel Requests", () => {
+    async function test(concurrency, payloadSize, from, to, expectedRequests, knownTo, howMany = HowMany.Exact) {
+        let nextElement = from;
+        let requests = 0;
+        let dispatches = 0;
+        const logger = new MockLogger();
+        const manager = new ParallelRequests(from, knownTo ? to : undefined, payloadSize, logger.toTelemetryLogger(), async (request, _from, _to) => {
+            let length = _to - _from;
+            requests++;
+            assert(_from >= from);
+            assert(length <= payloadSize);
+            assert(requests <= request);
+            assert(!knownTo || _to <= to);
+            switch (howMany) {
+                case HowMany.Partial:
+                    length = Math.min(length, payloadSize / 2 + 1);
+                    break;
+                case HowMany.TooMany:
+                    length = 2 * length + 2;
+                    break;
+                case HowMany.Exact:
+                    break;
+                default:
+                    unreachableCase(howMany);
+            }
+            // covering knownTo === false case
+            const actualTo = Math.min(_from + length, to);
+            const payload = [];
+            for (let i = _from; i < actualTo; i++) {
+                payload.push(i);
+            }
+            return {
+                partial: _from !== to && howMany === HowMany.Partial,
+                cancel: false,
+                payload,
+            };
+        }, (deltas) => {
+            dispatches++;
+            // Big chunks are broken into smaller ones
+            assert(dispatches <= requests || howMany === HowMany.TooMany);
+            for (const el of deltas) {
+                assert(el === nextElement);
+                nextElement++;
+            }
+        });
+        await manager.run(concurrency);
+        assert(nextElement === to);
+        assert(!knownTo || dispatches === requests);
+        assert.equal(requests, expectedRequests, "expected requests");
+        logger.assertMatchNone([{ category: "error" }]);
+    }
+    async function testCancel(from, to, cancelAt, payloadSize, expectedRequests) {
+        let nextElement = from;
+        let requests = 0;
+        let dispatches = 0;
+        const logger = new MockLogger();
+        const manager = new ParallelRequests(from, to, payloadSize, logger.toTelemetryLogger(), async (request, _from, _to) => {
+            const length = _to - _from;
+            requests++;
+            assert(_from >= from);
+            assert(length <= payloadSize);
+            assert(requests <= request);
+            assert(to === undefined || _to <= to);
+            if (_to > cancelAt) {
+                return { partial: false, cancel: true, payload: [] };
+            }
+            const payload = [];
+            for (let i = _from; i < _to; i++) {
+                payload.push(i);
+            }
+            return { partial: false, cancel: false, payload };
+        }, (deltas) => {
+            dispatches++;
+            assert(dispatches <= requests);
+            for (const el of deltas) {
+                assert(el === nextElement);
+                nextElement++;
+            }
+        });
+        await manager.run(10);
+        assert(dispatches <= requests);
+        assert(requests === expectedRequests);
+        logger.assertMatchNone([{ category: "error" }]);
+    }
+    it("no concurrency, single request, over", async () => {
+        await test(1, 100, 123, 156, 1, true);
+        await test(1, 100, 123, 156, 1, false);
+        await test(1, 100, 123, 156, 1, true, HowMany.TooMany);
+        await test(1, 100, 123, 156, 1, true, HowMany.Partial);
+    });
+    it("no concurrency, single request, exact", async () => {
+        await test(1, 156 - 123, 123, 156, 1, true);
+        await test(1, 156 - 123, 123, 156, 2, false);
+        await test(1, 156 - 123, 123, 156, 1, true, HowMany.TooMany);
+        await test(1, 156 - 123, 123, 156, 2, true, HowMany.Partial);
+        await test(1, 156 - 123, 123, 156, 2, false, HowMany.TooMany);
+        await test(1, 156 - 123, 123, 156, 3, false, HowMany.Partial);
+    });
+    it("concurrency, single request, exact", async () => {
+        await test(2, 156 - 123, 123, 156, 1, true);
+        await test(2, 156 - 123, 123, 156, 1, true, HowMany.TooMany);
+        await test(2, 156 - 123, 123, 156, 2, true, HowMany.Partial);
+        // here, the number of actual requests is Ok to be 2..3
+        await test(2, 156 - 123, 123, 156, 3, false);
+        await test(2, 156 - 123, 123, 156, 3, false, HowMany.TooMany);
+        await test(2, 156 - 123, 123, 156, 3, false, HowMany.Partial);
+    });
+    it("no concurrency, multiple requests", async () => {
+        await test(1, 10, 123, 156, 4, true);
+        await test(1, 10, 123, 156, 4, false);
+        await test(1, 10, 123, 156, 3, false, HowMany.TooMany);
+    });
+    it("two concurrent requests exact", async () => {
+        await test(2, 10, 123, 153, 3, true);
+        await test(2, 10, 123, 153, 3, true, HowMany.TooMany);
+        await test(2, 10, 123, 153, 6, true, HowMany.Partial);
+        await test(2, 10, 123, 153, 5, false);
+        await test(2, 10, 123, 153, 5, false, HowMany.TooMany);
+        await test(2, 10, 123, 153, 8, false, HowMany.Partial);
+    });
+    it("two concurrent requests one over", async () => {
+        await test(2, 10, 123, 154, 4, true);
+        // here, the number of actual requests is Ok to be 4..5
+        await test(2, 10, 123, 154, 5, false);
+    });
+    it("four concurrent requests", async () => {
+        await test(4, 10, 123, 156, 4, true);
+        // here, the number of actual requests is Ok to be 4..7
+        await test(4, 10, 123, 156, 7, false);
+    });
+    it("cancellation", async () => {
+        await testCancel(1, 1000, 502, 10, 60);
+        await testCancel(1, undefined, 502, 10, 60);
+    });
+    it("exception in request", async () => {
+        const logger = new MockLogger();
+        const manager = new ParallelRequests(1, 100, 10, logger.toTelemetryLogger(), async (request, _from, _to) => {
+            throw new Error("request");
+        }, (deltas) => {
+            throw new Error("response");
+        });
+        let success = true;
+        try {
+            await manager.run(10);
+        }
+        catch (error) {
+            success = false;
+            assert(error.message === "request");
+        }
+        assert(!success);
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+    it("exception in response", async () => {
+        const logger = new MockLogger();
+        const manager = new ParallelRequests(1, 100, 10, logger.toTelemetryLogger(), async (request, _from, _to) => {
+            return { cancel: false, partial: false, payload: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] };
+        }, (deltas) => {
+            throw new Error("response");
+        });
+        let success = true;
+        try {
+            await manager.run(10);
+        }
+        catch (error) {
+            success = false;
+            assert(error.message === "response");
+        }
+        assert(!success);
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+});
+//# sourceMappingURL=parallelRequests.spec.js.map

package/lib/test/parallelRequests.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parallelRequests.spec.js","sourceRoot":"","sources":["../../src/test/parallelRequests.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,IAAK,OAIJ;AAJD,WAAK,OAAO;IACX,uCAAK,CAAA;IACL,2CAAO,CAAA;IACP,2CAAO,CAAA;AACR,CAAC,EAJI,OAAO,KAAP,OAAO,QAIX;AAED,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAClC,KAAK,UAAU,IAAI,CAClB,WAAmB,EACnB,WAAmB,EACnB,IAAY,EACZ,EAAU,EACV,gBAAwB,EACxB,OAAgB,EAChB,UAAmB,OAAO,CAAC,KAAK;QAEhC,IAAI,WAAW,GAAG,IAAI,CAAC;QACvB,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAEhC,MAAM,OAAO,GAAG,IAAI,gBAAgB,CACnC,IAAI,EACJ,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EACxB,WAAW,EACX,MAAM,CAAC,iBAAiB,EAAE,EAC1B,KAAK,EAAE,OAAe,EAAE,KAAa,EAAE,GAAW,EAAE,EAAE;YACrD,IAAI,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC;YACzB,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;YACtB,MAAM,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC;YAC9B,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC,CAAC;YAC5B,MAAM,CAAC,CAAC,OAAO,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;YAE9B,QAAQ,OAAO,EAAE;gBAChB,KAAK,OAAO,CAAC,OAAO;oBACnB,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC/C,MAAM;gBACP,KAAK,OAAO,CAAC,OAAO;oBACnB,MAAM,GAAG,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;oBACxB,MAAM;gBACP,KAAK,OAAO,CAAC,KAAK;oBACjB,MAAM;gBACP;oBACC,eAAe,CAAC,OAAO,CAAC,CAAC;aAC1B;YACD,kCAAkC;YAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAa,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aAChB;YAED,OAAO;gBACN,OAAO,EAAE,KAAK,KAAK,EAAE,IAAI,OAAO,KAAK,OAAO,CAAC,OAAO;gBACpD,MAAM,EAAE,KAAK;gBACb,OAAO;aACP,CAAC;QACH,CAAC,EACD,CAAC,MAAgB,EAAE,EAAE;YACpB,UAAU,EAAE,CAAC;YACb,0CAA0C;YAC1C,MAAM,CAAC,UAAU,IAAI,QAAQ,IAAI,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YAC9D,KAAK,MAAM,EAAE,IAAI,MAAM,EAAE;gBACxB,MAAM,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;gBAC3B,WAAW,EAAE,CAAC;aACd;QACF,CAAC,CACD,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE/B,MAAM,CAAC,WAAW,KAAK,EAAE,CAAC,CAAC;QAC3B,MAAM,CAAC,CAAC,OAAO,IAAI,UAAU,KAAK,QAAQ,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QAC9D,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,UAAU,UAAU,CACxB,IAAY,EACZ,EAAsB,EACtB,QAAgB,EAChB,WAAW,EACX,gBAAwB;QAExB,IAAI,WAAW,GAAG,IAAI,CAAC;QACvB,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAEhC,MAAM,OAAO,GAAG,IAAI,gBAAgB,CACnC,IAAI,EACJ,EAAE,EACF,WAAW,EACX,MAAM,CAAC,iBAAiB,EAAE,EAC1B,KAAK,EAAE,OAAe,EAAE,KAAa,EAAE,GAAW,EAAE,EAAE;YACrD,MAAM,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC;YAC3B,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;YACtB,MAAM,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC;YAC9B,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC,CAAC;YAC5B,MAAM,CAAC,EAAE,KAAK,SAAS,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;YAEtC,IAAI,GAAG,GAAG,QAAQ,EAAE;gBACnB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;aACrD;YAED,MAAM,OAAO,GAAa,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;gBACjC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aAChB;YAED,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QACnD,CAAC,EACD,CAAC,MAAgB,EAAE,EAAE;YACpB,UAAU,EAAE,CAAC;YACb,MAAM,CAAC,UAAU,IAAI,QAAQ,CAAC,CAAC;YAC/B,KAAK,MAAM,EAAE,IAAI,MAAM,EAAE;gBACxB,MAAM,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;gBAC3B,WAAW,EAAE,CAAC;aACd;QACF,CAAC,CACD,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEtB,MAAM,CAAC,UAAU,IAAI,QAAQ,CAAC,CAAC;QAC/B,MAAM,CAAC,QAAQ,KAAK,gBAAgB,CAAC,CAAC;QACtC,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7D,uDAAuD;QACvD,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACrC,uDAAuD;QACvD,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACrC,uDAAuD;QACvD,MAAM,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;QAC7B,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACvC,MAAM,UAAU,CAAC,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAEhC,MAAM,OAAO,GAAG,IAAI,gBAAgB,CACnC,CAAC,EACD,GAAG,EACH,EAAE,EACF,MAAM,CAAC,iBAAiB,EAAE,EAC1B,KAAK,EAAE,OAAe,EAAE,KAAa,EAAE,GAAW,EAAE,EAAE;YACrD,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC,EACD,CAAC,MAAgB,EAAE,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7B,CAAC,CACD,CAAC;QAEF,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI;YACH,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACtB;QAAC,OAAO,KAAU,EAAE;YACpB,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;SACpC;QACD,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;QACjB,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAEhC,MAAM,OAAO,GAAG,IAAI,gBAAgB,CACnC,CAAC,EACD,GAAG,EACH,EAAE,EACF,MAAM,CAAC,iBAAiB,EAAE,EAC1B,KAAK,EAAE,OAAe,EAAE,KAAa,EAAE,GAAW,EAAE,EAAE;YACrD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;QACpF,CAAC,EACD,CAAC,MAAgB,EAAE,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7B,CAAC,CACD,CAAC;QAEF,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI;YACH,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACtB;QAAC,OAAO,KAAU,EAAE;YACpB,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,CAAC,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC;SACrC;QACD,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;QACjB,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { unreachableCase } from \"@fluidframework/core-utils\";\nimport { ParallelRequests } from \"../parallelRequests.js\";\n\nenum HowMany {\n\tExact,\n\tPartial,\n\tTooMany,\n}\n\ndescribe(\"Parallel Requests\", () => {\n\tasync function test(\n\t\tconcurrency: number,\n\t\tpayloadSize: number,\n\t\tfrom: number,\n\t\tto: number,\n\t\texpectedRequests: number,\n\t\tknownTo: boolean,\n\t\thowMany: HowMany = HowMany.Exact,\n\t) {\n\t\tlet nextElement = from;\n\t\tlet requests = 0;\n\t\tlet dispatches = 0;\n\n\t\tconst logger = new MockLogger();\n\n\t\tconst manager = new ParallelRequests<number>(\n\t\t\tfrom,\n\t\t\tknownTo ? to : undefined,\n\t\t\tpayloadSize,\n\t\t\tlogger.toTelemetryLogger(),\n\t\t\tasync (request: number, _from: number, _to: number) => {\n\t\t\t\tlet length = _to - _from;\n\t\t\t\trequests++;\n\n\t\t\t\tassert(_from >= from);\n\t\t\t\tassert(length <= payloadSize);\n\t\t\t\tassert(requests <= request);\n\t\t\t\tassert(!knownTo || _to <= to);\n\n\t\t\t\tswitch (howMany) {\n\t\t\t\t\tcase HowMany.Partial:\n\t\t\t\t\t\tlength = Math.min(length, payloadSize / 2 + 1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase HowMany.TooMany:\n\t\t\t\t\t\tlength = 2 * length + 2;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase HowMany.Exact:\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tunreachableCase(howMany);\n\t\t\t\t}\n\t\t\t\t// covering knownTo === false case\n\t\t\t\tconst actualTo = Math.min(_from + length, to);\n\n\t\t\t\tconst payload: number[] = [];\n\t\t\t\tfor (let i = _from; i < actualTo; i++) {\n\t\t\t\t\tpayload.push(i);\n\t\t\t\t}\n\n\t\t\t\treturn {\n\t\t\t\t\tpartial: _from !== to && howMany === HowMany.Partial,\n\t\t\t\t\tcancel: false,\n\t\t\t\t\tpayload,\n\t\t\t\t};\n\t\t\t},\n\t\t\t(deltas: number[]) => {\n\t\t\t\tdispatches++;\n\t\t\t\t// Big chunks are broken into smaller ones\n\t\t\t\tassert(dispatches <= requests || howMany === HowMany.TooMany);\n\t\t\t\tfor (const el of deltas) {\n\t\t\t\t\tassert(el === nextElement);\n\t\t\t\t\tnextElement++;\n\t\t\t\t}\n\t\t\t},\n\t\t);\n\n\t\tawait manager.run(concurrency);\n\n\t\tassert(nextElement === to);\n\t\tassert(!knownTo || dispatches === requests);\n\t\tassert.equal(requests, expectedRequests, \"expected requests\");\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t}\n\n\tasync function testCancel(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tcancelAt: number,\n\t\tpayloadSize,\n\t\texpectedRequests: number,\n\t) {\n\t\tlet nextElement = from;\n\t\tlet requests = 0;\n\t\tlet dispatches = 0;\n\t\tconst logger = new MockLogger();\n\n\t\tconst manager = new ParallelRequests<number>(\n\t\t\tfrom,\n\t\t\tto,\n\t\t\tpayloadSize,\n\t\t\tlogger.toTelemetryLogger(),\n\t\t\tasync (request: number, _from: number, _to: number) => {\n\t\t\t\tconst length = _to - _from;\n\t\t\t\trequests++;\n\n\t\t\t\tassert(_from >= from);\n\t\t\t\tassert(length <= payloadSize);\n\t\t\t\tassert(requests <= request);\n\t\t\t\tassert(to === undefined || _to <= to);\n\n\t\t\t\tif (_to > cancelAt) {\n\t\t\t\t\treturn { partial: false, cancel: true, payload: [] };\n\t\t\t\t}\n\n\t\t\t\tconst payload: number[] = [];\n\t\t\t\tfor (let i = _from; i < _to; i++) {\n\t\t\t\t\tpayload.push(i);\n\t\t\t\t}\n\n\t\t\t\treturn { partial: false, cancel: false, payload };\n\t\t\t},\n\t\t\t(deltas: number[]) => {\n\t\t\t\tdispatches++;\n\t\t\t\tassert(dispatches <= requests);\n\t\t\t\tfor (const el of deltas) {\n\t\t\t\t\tassert(el === nextElement);\n\t\t\t\t\tnextElement++;\n\t\t\t\t}\n\t\t\t},\n\t\t);\n\n\t\tawait manager.run(10);\n\n\t\tassert(dispatches <= requests);\n\t\tassert(requests === expectedRequests);\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t}\n\n\tit(\"no concurrency, single request, over\", async () => {\n\t\tawait test(1, 100, 123, 156, 1, true);\n\t\tawait test(1, 100, 123, 156, 1, false);\n\t\tawait test(1, 100, 123, 156, 1, true, HowMany.TooMany);\n\t\tawait test(1, 100, 123, 156, 1, true, HowMany.Partial);\n\t});\n\n\tit(\"no concurrency, single request, exact\", async () => {\n\t\tawait test(1, 156 - 123, 123, 156, 1, true);\n\t\tawait test(1, 156 - 123, 123, 156, 2, false);\n\t\tawait test(1, 156 - 123, 123, 156, 1, true, HowMany.TooMany);\n\t\tawait test(1, 156 - 123, 123, 156, 2, true, HowMany.Partial);\n\t\tawait test(1, 156 - 123, 123, 156, 2, false, HowMany.TooMany);\n\t\tawait test(1, 156 - 123, 123, 156, 3, false, HowMany.Partial);\n\t});\n\n\tit(\"concurrency, single request, exact\", async () => {\n\t\tawait test(2, 156 - 123, 123, 156, 1, true);\n\t\tawait test(2, 156 - 123, 123, 156, 1, true, HowMany.TooMany);\n\t\tawait test(2, 156 - 123, 123, 156, 2, true, HowMany.Partial);\n\t\t// here, the number of actual requests is Ok to be 2..3\n\t\tawait test(2, 156 - 123, 123, 156, 3, false);\n\t\tawait test(2, 156 - 123, 123, 156, 3, false, HowMany.TooMany);\n\t\tawait test(2, 156 - 123, 123, 156, 3, false, HowMany.Partial);\n\t});\n\n\tit(\"no concurrency, multiple requests\", async () => {\n\t\tawait test(1, 10, 123, 156, 4, true);\n\t\tawait test(1, 10, 123, 156, 4, false);\n\t\tawait test(1, 10, 123, 156, 3, false, HowMany.TooMany);\n\t});\n\n\tit(\"two concurrent requests exact\", async () => {\n\t\tawait test(2, 10, 123, 153, 3, true);\n\t\tawait test(2, 10, 123, 153, 3, true, HowMany.TooMany);\n\t\tawait test(2, 10, 123, 153, 6, true, HowMany.Partial);\n\t\tawait test(2, 10, 123, 153, 5, false);\n\t\tawait test(2, 10, 123, 153, 5, false, HowMany.TooMany);\n\t\tawait test(2, 10, 123, 153, 8, false, HowMany.Partial);\n\t});\n\n\tit(\"two concurrent requests one over\", async () => {\n\t\tawait test(2, 10, 123, 154, 4, true);\n\t\t// here, the number of actual requests is Ok to be 4..5\n\t\tawait test(2, 10, 123, 154, 5, false);\n\t});\n\n\tit(\"four concurrent requests\", async () => {\n\t\tawait test(4, 10, 123, 156, 4, true);\n\t\t// here, the number of actual requests is Ok to be 4..7\n\t\tawait test(4, 10, 123, 156, 7, false);\n\t});\n\n\tit(\"cancellation\", async () => {\n\t\tawait testCancel(1, 1000, 502, 10, 60);\n\t\tawait testCancel(1, undefined, 502, 10, 60);\n\t});\n\n\tit(\"exception in request\", async () => {\n\t\tconst logger = new MockLogger();\n\n\t\tconst manager = new ParallelRequests<number>(\n\t\t\t1,\n\t\t\t100,\n\t\t\t10,\n\t\t\tlogger.toTelemetryLogger(),\n\t\t\tasync (request: number, _from: number, _to: number) => {\n\t\t\t\tthrow new Error(\"request\");\n\t\t\t},\n\t\t\t(deltas: number[]) => {\n\t\t\t\tthrow new Error(\"response\");\n\t\t\t},\n\t\t);\n\n\t\tlet success = true;\n\t\ttry {\n\t\t\tawait manager.run(10);\n\t\t} catch (error: any) {\n\t\t\tsuccess = false;\n\t\t\tassert(error.message === \"request\");\n\t\t}\n\t\tassert(!success);\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t});\n\n\tit(\"exception in response\", async () => {\n\t\tconst logger = new MockLogger();\n\n\t\tconst manager = new ParallelRequests<number>(\n\t\t\t1,\n\t\t\t100,\n\t\t\t10,\n\t\t\tlogger.toTelemetryLogger(),\n\t\t\tasync (request: number, _from: number, _to: number) => {\n\t\t\t\treturn { cancel: false, partial: false, payload: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] };\n\t\t\t},\n\t\t\t(deltas: number[]) => {\n\t\t\t\tthrow new Error(\"response\");\n\t\t\t},\n\t\t);\n\n\t\tlet success = true;\n\t\ttry {\n\t\t\tawait manager.run(10);\n\t\t} catch (error: any) {\n\t\t\tsuccess = false;\n\t\t\tassert(error.message === \"response\");\n\t\t}\n\t\tassert(!success);\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t});\n});\n"]}

package/lib/test/rateLimiter.spec.js

@@ -0,0 +1,85 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { RateLimiter } from "../rateLimiter.js";
+describe("Rate Limiter", () => {
+    let limiter;
+    beforeEach(() => {
+        limiter = new RateLimiter(3);
+    });
+    it("can run task", async () => {
+        let done = false;
+        assert(limiter.waitQueueLength === 0);
+        await limiter.schedule(async () => {
+            assert(limiter.waitQueueLength === 0);
+            done = true;
+        });
+        assert(done);
+    });
+    it("can run 3 tasks", async () => {
+        let done = false;
+        await limiter.schedule(async () => {
+            await limiter.schedule(async () => {
+                await limiter.schedule(async () => {
+                    assert(limiter.waitQueueLength === 0);
+                    done = true;
+                });
+            });
+        });
+        assert(done);
+    });
+    it("can run 4 tasks", async () => {
+        let done = false;
+        let promise;
+        await limiter.schedule(async () => {
+            await limiter.schedule(async () => {
+                await limiter.schedule(async () => {
+                    promise = limiter.schedule(async () => {
+                        done = true;
+                    });
+                    assert(limiter.waitQueueLength === 1);
+                });
+                assert(limiter.waitQueueLength === 0);
+            });
+        });
+        assert(promise !== undefined);
+        await promise;
+        assert(done);
+        assert(limiter.waitQueueLength === 0);
+    });
+    it("can run a lot of tasks", async () => {
+        let counter = 0;
+        const tasks = 100;
+        const promises = [];
+        for (let i = 0; i < tasks; i++) {
+            promises.push(limiter.schedule(async () => {
+                counter++;
+            }));
+        }
+        // This is implementation detail and may not be true in the future.
+        // I.e. RateLimiter may asynchronously pick up first 3 tasks.
+        assert(limiter.waitQueueLength === tasks - 3);
+        await Promise.all(promises);
+        assert(counter === tasks);
+        assert(limiter.waitQueueLength === 0);
+    });
+    it("can run many tasks sequentially", async () => {
+        let counter = 0;
+        const promises = [];
+        for (let i = 0; i < 3; i++) {
+            promises.push(limiter.schedule(async () => {
+                counter++;
+            }));
+        }
+        await Promise.all(promises);
+        // Now check that we can schedule another task.
+        await limiter.schedule(async () => {
+            counter++;
+        });
+        assert(counter === 4);
+        assert(limiter.waitQueueLength === 0);
+    });
+});
+//# sourceMappingURL=rateLimiter.spec.js.map

package/lib/test/rateLimiter.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateLimiter.spec.js","sourceRoot":"","sources":["../../src/test/rateLimiter.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC7B,IAAI,OAAoB,CAAC;IAEzB,UAAU,CAAC,GAAG,EAAE;QACf,OAAO,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;QAC7B,IAAI,IAAI,GAAG,KAAK,CAAC;QACjB,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;QACtC,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YACjC,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;YACtC,IAAI,GAAG,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAChC,IAAI,IAAI,GAAG,KAAK,CAAC;QACjB,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YACjC,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;gBACjC,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;oBACjC,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;oBACtC,IAAI,GAAG,IAAI,CAAC;gBACb,CAAC,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAChC,IAAI,IAAI,GAAG,KAAK,CAAC;QACjB,IAAI,OAAkC,CAAC;QACvC,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YACjC,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;gBACjC,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;oBACjC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;wBACrC,IAAI,GAAG,IAAI,CAAC;oBACb,CAAC,CAAC,CAAC;oBACH,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;QAC9B,MAAM,OAAO,CAAC;QACd,MAAM,CAAC,IAAI,CAAC,CAAC;QACb,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACvC,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,MAAM,KAAK,GAAG,GAAG,CAAC;QAClB,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC/B,QAAQ,CAAC,IAAI,CACZ,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;gBAC3B,OAAO,EAAE,CAAC;YACX,CAAC,CAAC,CACF,CAAC;SACF;QAED,mEAAmE;QACnE,6DAA6D;QAC7D,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC;QAE9C,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5B,MAAM,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAChD,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC3B,QAAQ,CAAC,IAAI,CACZ,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;gBAC3B,OAAO,EAAE,CAAC;YACX,CAAC,CAAC,CACF,CAAC;SACF;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5B,+CAA+C;QAC/C,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YACjC,OAAO,EAAE,CAAC;QACX,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC;QACtB,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { RateLimiter } from \"../rateLimiter.js\";\n\ndescribe(\"Rate Limiter\", () => {\n\tlet limiter: RateLimiter;\n\n\tbeforeEach(() => {\n\t\tlimiter = new RateLimiter(3);\n\t});\n\n\tit(\"can run task\", async () => {\n\t\tlet done = false;\n\t\tassert(limiter.waitQueueLength === 0);\n\t\tawait limiter.schedule(async () => {\n\t\t\tassert(limiter.waitQueueLength === 0);\n\t\t\tdone = true;\n\t\t});\n\t\tassert(done);\n\t});\n\n\tit(\"can run 3 tasks\", async () => {\n\t\tlet done = false;\n\t\tawait limiter.schedule(async () => {\n\t\t\tawait limiter.schedule(async () => {\n\t\t\t\tawait limiter.schedule(async () => {\n\t\t\t\t\tassert(limiter.waitQueueLength === 0);\n\t\t\t\t\tdone = true;\n\t\t\t\t});\n\t\t\t});\n\t\t});\n\t\tassert(done);\n\t});\n\n\tit(\"can run 4 tasks\", async () => {\n\t\tlet done = false;\n\t\tlet promise: Promise<void> | undefined;\n\t\tawait limiter.schedule(async () => {\n\t\t\tawait limiter.schedule(async () => {\n\t\t\t\tawait limiter.schedule(async () => {\n\t\t\t\t\tpromise = limiter.schedule(async () => {\n\t\t\t\t\t\tdone = true;\n\t\t\t\t\t});\n\t\t\t\t\tassert(limiter.waitQueueLength === 1);\n\t\t\t\t});\n\t\t\t\tassert(limiter.waitQueueLength === 0);\n\t\t\t});\n\t\t});\n\t\tassert(promise !== undefined);\n\t\tawait promise;\n\t\tassert(done);\n\t\tassert(limiter.waitQueueLength === 0);\n\t});\n\n\tit(\"can run a lot of tasks\", async () => {\n\t\tlet counter = 0;\n\t\tconst tasks = 100;\n\t\tconst promises: Promise<void>[] = [];\n\t\tfor (let i = 0; i < tasks; i++) {\n\t\t\tpromises.push(\n\t\t\t\tlimiter.schedule(async () => {\n\t\t\t\t\tcounter++;\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\n\t\t// This is implementation detail and may not be true in the future.\n\t\t// I.e. RateLimiter may asynchronously pick up first 3 tasks.\n\t\tassert(limiter.waitQueueLength === tasks - 3);\n\n\t\tawait Promise.all(promises);\n\t\tassert(counter === tasks);\n\t\tassert(limiter.waitQueueLength === 0);\n\t});\n\n\tit(\"can run many tasks sequentially\", async () => {\n\t\tlet counter = 0;\n\t\tconst promises: Promise<void>[] = [];\n\t\tfor (let i = 0; i < 3; i++) {\n\t\t\tpromises.push(\n\t\t\t\tlimiter.schedule(async () => {\n\t\t\t\t\tcounter++;\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\t\tawait Promise.all(promises);\n\t\t// Now check that we can schedule another task.\n\t\tawait limiter.schedule(async () => {\n\t\t\tcounter++;\n\t\t});\n\t\tassert(counter === 4);\n\t\tassert(limiter.waitQueueLength === 0);\n\t});\n});\n"]}

package/lib/test/runWithRetry.spec.js

@@ -0,0 +1,180 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { DriverErrorTypes } from "@fluidframework/driver-definitions";
+import { createChildLogger } from "@fluidframework/telemetry-utils";
+import { runWithRetry } from "../runWithRetry.js";
+const _setTimeout = global.setTimeout;
+const fastSetTimeout = (callback, ms, ...args) => _setTimeout(callback, ms / 1000.0, ...args);
+async function runWithFastSetTimeout(callback) {
+    global.setTimeout = fastSetTimeout;
+    return callback().finally(() => {
+        global.setTimeout = _setTimeout;
+    });
+}
+describe("runWithRetry Tests", () => {
+    const logger = createChildLogger();
+    it("Should succeed at first time", async () => {
+        let retryTimes = 1;
+        let success = false;
+        const api = async () => {
+            retryTimes -= 1;
+            return true;
+        };
+        let emitDelayInfoTimes = 0;
+        success = await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {
+            onRetry: () => {
+                emitDelayInfoTimes += 1;
+            },
+        }));
+        assert.strictEqual(retryTimes, 0, "Should succeed at first time");
+        assert.strictEqual(success, true, "Retry should succeed ultimately");
+        assert.strictEqual(emitDelayInfoTimes, 0, "Should not emit delay at first time");
+    });
+    it("Check that it retries infinitely", async () => {
+        const maxTries = 5;
+        let retryTimes = maxTries;
+        let success = false;
+        const api = async () => {
+            if (retryTimes > 0) {
+                retryTimes -= 1;
+                const error = new Error("Throw error");
+                error.retryAfterSeconds = 10;
+                error.canRetry = true;
+                throw error;
+            }
+            return true;
+        };
+        let emitDelayInfoTimes = 0;
+        success = await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {
+            onRetry: () => {
+                emitDelayInfoTimes += 1;
+            },
+        }));
+        assert.strictEqual(retryTimes, 0, "Should keep retrying until success");
+        assert.strictEqual(success, true, "Retry should succeed ultimately");
+        assert.strictEqual(emitDelayInfoTimes, maxTries, "Should emit delay at each try");
+    });
+    it("Check that it retries after retry seconds", async () => {
+        let retryTimes = 1;
+        let success = false;
+        const api = async () => {
+            if (retryTimes > 0) {
+                retryTimes -= 1;
+                const error = new Error("Throttle Error");
+                error.errorType = DriverErrorTypes.throttlingError;
+                error.retryAfterSeconds = 400;
+                error.canRetry = true;
+                throw error;
+            }
+            return true;
+        };
+        success = await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {}));
+        assert.strictEqual(retryTimes, 0, "Should retry once");
+        assert.strictEqual(success, true, "Retry should succeed ultimately");
+    });
+    it("If error is just a string, should retry as canRetry is not false", async () => {
+        let retryTimes = 1;
+        let success = false;
+        const api = async () => {
+            if (retryTimes > 0) {
+                retryTimes -= 1;
+                const err = new Error("error");
+                err.canRetry = true;
+                throw err;
+            }
+            return true;
+        };
+        try {
+            success = await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {}));
+        }
+        catch (error) { }
+        assert.strictEqual(retryTimes, 0, "Should retry");
+        assert.strictEqual(success, true, "Should succeed as retry should be successful");
+    });
+    it("Should not retry if canRetry is set as false", async () => {
+        let retryTimes = 1;
+        let success = false;
+        const api = async () => {
+            if (retryTimes > 0) {
+                retryTimes -= 1;
+                const error = new Error("error");
+                error.canRetry = false;
+                throw error;
+            }
+            return true;
+        };
+        try {
+            success = await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {}));
+            assert.fail("Should not succeed");
+        }
+        catch (error) { }
+        assert.strictEqual(retryTimes, 0, "Should not retry");
+        assert.strictEqual(success, false, "Should not succeed as canRetry was not set");
+    });
+    it("Should not retry if canRetry is not set", async () => {
+        let retryTimes = 1;
+        let success = false;
+        const api = async () => {
+            if (retryTimes > 0) {
+                retryTimes -= 1;
+                const error = new Error("error");
+                throw error;
+            }
+            return true;
+        };
+        try {
+            success = await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {}));
+            assert.fail("Should not succeed");
+        }
+        catch (error) { }
+        assert.strictEqual(retryTimes, 0, "Should not retry");
+        assert.strictEqual(success, false, "Should not succeed as canRetry was not set");
+    });
+    it("Should not retry if it is disabled", async () => {
+        let retryTimes = 1;
+        let success = false;
+        const api = async () => {
+            if (retryTimes > 0) {
+                retryTimes -= 1;
+                const error = new Error("error");
+                error.canRetry = true;
+                throw error;
+            }
+            return true;
+        };
+        try {
+            success = await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {
+                onRetry: () => {
+                    throw new Error("disposed");
+                },
+            }));
+            assert.fail("Should not succeed");
+        }
+        catch (error) { }
+        assert.strictEqual(retryTimes, 0, "Should not retry");
+        assert.strictEqual(success, false, "Should not succeed as retrying was disabled");
+    });
+    it("Abort reason is included in thrown exception", async () => {
+        const abortController = new AbortController();
+        const api = () => {
+            abortController.abort("Sample abort reason");
+            const error = new Error("aborted");
+            error.canRetry = true;
+            throw error;
+        };
+        try {
+            await runWithFastSetTimeout(async () => runWithRetry(api, "test", logger, {
+                cancel: abortController.signal,
+            }));
+            assert.fail("Should not succeed");
+        }
+        catch (error) {
+            assert.strictEqual(error.message, "runWithRetry was Aborted");
+            assert.strictEqual(error.reason, "Sample abort reason");
+        }
+    });
+});
+//# sourceMappingURL=runWithRetry.spec.js.map

package/lib/test/runWithRetry.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runWithRetry.spec.js","sourceRoot":"","sources":["../../src/test/runWithRetry.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;AACtC,MAAM,cAAc,GAAQ,CAAC,QAAoC,EAAE,EAAU,EAAE,GAAG,IAAW,EAAE,EAAE,CAChG,WAAW,CAAC,QAAQ,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;AAC7C,KAAK,UAAU,qBAAqB,CAAI,QAA0B;IACjE,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC;IACnC,OAAO,QAAQ,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;QAC9B,MAAM,CAAC,UAAU,GAAG,WAAW,CAAC;IACjC,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IACnC,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;IAEnC,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC7C,IAAI,UAAU,GAAW,CAAC,CAAC;QAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACtB,UAAU,IAAI,CAAC,CAAC;YAChB,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QAEF,IAAI,kBAAkB,GAAW,CAAC,CAAC;QACnC,OAAO,GAAG,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAChD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE;YACjC,OAAO,EAAE,GAAG,EAAE;gBACb,kBAAkB,IAAI,CAAC,CAAC;YACzB,CAAC;SACD,CAAC,CACF,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,iCAAiC,CAAC,CAAC;QACrE,MAAM,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC,EAAE,qCAAqC,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,QAAQ,GAAW,CAAC,CAAC;QAC3B,IAAI,UAAU,GAAW,QAAQ,CAAC;QAClC,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACtB,IAAI,UAAU,GAAG,CAAC,EAAE;gBACnB,UAAU,IAAI,CAAC,CAAC;gBAChB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;gBACtC,KAAa,CAAC,iBAAiB,GAAG,EAAE,CAAC;gBACrC,KAAa,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAC/B,MAAM,KAAK,CAAC;aACZ;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QAEF,IAAI,kBAAkB,GAAW,CAAC,CAAC;QACnC,OAAO,GAAG,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAChD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE;YACjC,OAAO,EAAE,GAAG,EAAE;gBACb,kBAAkB,IAAI,CAAC,CAAC;YACzB,CAAC;SACD,CAAC,CACF,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,oCAAoC,CAAC,CAAC;QACxE,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,iCAAiC,CAAC,CAAC;QACrE,MAAM,CAAC,WAAW,CAAC,kBAAkB,EAAE,QAAQ,EAAE,+BAA+B,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QAC1D,IAAI,UAAU,GAAW,CAAC,CAAC;QAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACtB,IAAI,UAAU,GAAG,CAAC,EAAE;gBACnB,UAAU,IAAI,CAAC,CAAC;gBAChB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;gBACzC,KAAa,CAAC,SAAS,GAAG,gBAAgB,CAAC,eAAe,CAAC;gBAC3D,KAAa,CAAC,iBAAiB,GAAG,GAAG,CAAC;gBACtC,KAAa,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAC/B,MAAM,KAAK,CAAC;aACZ;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QACF,OAAO,GAAG,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACzF,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,mBAAmB,CAAC,CAAC;QACvD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,iCAAiC,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QACjF,IAAI,UAAU,GAAW,CAAC,CAAC;QAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACtB,IAAI,UAAU,GAAG,CAAC,EAAE;gBACnB,UAAU,IAAI,CAAC,CAAC;gBAChB,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC9B,GAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAC7B,MAAM,GAAG,CAAC;aACV;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QACF,IAAI;YACH,OAAO,GAAG,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAChD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CACrC,CAAC;SACF;QAAC,OAAO,KAAK,EAAE,GAAE;QAClB,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,8CAA8C,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC7D,IAAI,UAAU,GAAW,CAAC,CAAC;QAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACtB,IAAI,UAAU,GAAG,CAAC,EAAE;gBACnB,UAAU,IAAI,CAAC,CAAC;gBAChB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;gBAChC,KAAa,CAAC,QAAQ,GAAG,KAAK,CAAC;gBAChC,MAAM,KAAK,CAAC;aACZ;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QACF,IAAI;YACH,OAAO,GAAG,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAChD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CACrC,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;SAClC;QAAC,OAAO,KAAK,EAAE,GAAE;QAClB,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,4CAA4C,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACxD,IAAI,UAAU,GAAW,CAAC,CAAC;QAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACtB,IAAI,UAAU,GAAG,CAAC,EAAE;gBACnB,UAAU,IAAI,CAAC,CAAC;gBAChB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;gBACjC,MAAM,KAAK,CAAC;aACZ;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QACF,IAAI;YACH,OAAO,GAAG,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAChD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CACrC,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;SAClC;QAAC,OAAO,KAAK,EAAE,GAAE;QAClB,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,4CAA4C,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QACnD,IAAI,UAAU,GAAW,CAAC,CAAC;QAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACtB,IAAI,UAAU,GAAG,CAAC,EAAE;gBACnB,UAAU,IAAI,CAAC,CAAC;gBAChB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;gBAChC,KAAa,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAC/B,MAAM,KAAK,CAAC;aACZ;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QACF,IAAI;YACH,OAAO,GAAG,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAChD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE;gBACjC,OAAO,EAAE,GAAG,EAAE;oBACb,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC7B,CAAC;aACD,CAAC,CACF,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;SAClC;QAAC,OAAO,KAAK,EAAE,GAAE;QAClB,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,6CAA6C,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;QAE9C,MAAM,GAAG,GAAG,GAAG,EAAE;YAChB,eAAe,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;YAClC,KAAa,CAAC,QAAQ,GAAG,IAAI,CAAC;YAC/B,MAAM,KAAK,CAAC;QACb,CAAC,CAAC;QACF,IAAI;YACH,MAAM,qBAAqB,CAAC,KAAK,IAAI,EAAE,CACtC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE;gBACjC,MAAM,EAAE,eAAe,CAAC,MAAM;aAC9B,CAAC,CACF,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;SAClC;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YACvE,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;SACjE;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { DriverErrorTypes } from \"@fluidframework/driver-definitions\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { runWithRetry } from \"../runWithRetry.js\";\n\nconst _setTimeout = global.setTimeout;\nconst fastSetTimeout: any = (callback: (...cbArgs: any[]) => void, ms: number, ...args: any[]) =>\n\t_setTimeout(callback, ms / 1000.0, ...args);\nasync function runWithFastSetTimeout<T>(callback: () => Promise<T>): Promise<T> {\n\tglobal.setTimeout = fastSetTimeout;\n\treturn callback().finally(() => {\n\t\tglobal.setTimeout = _setTimeout;\n\t});\n}\n\ndescribe(\"runWithRetry Tests\", () => {\n\tconst logger = createChildLogger();\n\n\tit(\"Should succeed at first time\", async () => {\n\t\tlet retryTimes: number = 1;\n\t\tlet success = false;\n\t\tconst api = async () => {\n\t\t\tretryTimes -= 1;\n\t\t\treturn true;\n\t\t};\n\n\t\tlet emitDelayInfoTimes: number = 0;\n\t\tsuccess = await runWithFastSetTimeout(async () =>\n\t\t\trunWithRetry(api, \"test\", logger, {\n\t\t\t\tonRetry: () => {\n\t\t\t\t\temitDelayInfoTimes += 1;\n\t\t\t\t},\n\t\t\t}),\n\t\t);\n\t\tassert.strictEqual(retryTimes, 0, \"Should succeed at first time\");\n\t\tassert.strictEqual(success, true, \"Retry should succeed ultimately\");\n\t\tassert.strictEqual(emitDelayInfoTimes, 0, \"Should not emit delay at first time\");\n\t});\n\n\tit(\"Check that it retries infinitely\", async () => {\n\t\tconst maxTries: number = 5;\n\t\tlet retryTimes: number = maxTries;\n\t\tlet success = false;\n\t\tconst api = async () => {\n\t\t\tif (retryTimes > 0) {\n\t\t\t\tretryTimes -= 1;\n\t\t\t\tconst error = new Error(\"Throw error\");\n\t\t\t\t(error as any).retryAfterSeconds = 10;\n\t\t\t\t(error as any).canRetry = true;\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\treturn true;\n\t\t};\n\n\t\tlet emitDelayInfoTimes: number = 0;\n\t\tsuccess = await runWithFastSetTimeout(async () =>\n\t\t\trunWithRetry(api, \"test\", logger, {\n\t\t\t\tonRetry: () => {\n\t\t\t\t\temitDelayInfoTimes += 1;\n\t\t\t\t},\n\t\t\t}),\n\t\t);\n\t\tassert.strictEqual(retryTimes, 0, \"Should keep retrying until success\");\n\t\tassert.strictEqual(success, true, \"Retry should succeed ultimately\");\n\t\tassert.strictEqual(emitDelayInfoTimes, maxTries, \"Should emit delay at each try\");\n\t});\n\n\tit(\"Check that it retries after retry seconds\", async () => {\n\t\tlet retryTimes: number = 1;\n\t\tlet success = false;\n\t\tconst api = async () => {\n\t\t\tif (retryTimes > 0) {\n\t\t\t\tretryTimes -= 1;\n\t\t\t\tconst error = new Error(\"Throttle Error\");\n\t\t\t\t(error as any).errorType = DriverErrorTypes.throttlingError;\n\t\t\t\t(error as any).retryAfterSeconds = 400;\n\t\t\t\t(error as any).canRetry = true;\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\treturn true;\n\t\t};\n\t\tsuccess = await runWithFastSetTimeout(async () => runWithRetry(api, \"test\", logger, {}));\n\t\tassert.strictEqual(retryTimes, 0, \"Should retry once\");\n\t\tassert.strictEqual(success, true, \"Retry should succeed ultimately\");\n\t});\n\n\tit(\"If error is just a string, should retry as canRetry is not false\", async () => {\n\t\tlet retryTimes: number = 1;\n\t\tlet success = false;\n\t\tconst api = async () => {\n\t\t\tif (retryTimes > 0) {\n\t\t\t\tretryTimes -= 1;\n\t\t\t\tconst err = new Error(\"error\");\n\t\t\t\t(err as any).canRetry = true;\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t\treturn true;\n\t\t};\n\t\ttry {\n\t\t\tsuccess = await runWithFastSetTimeout(async () =>\n\t\t\t\trunWithRetry(api, \"test\", logger, {}),\n\t\t\t);\n\t\t} catch (error) {}\n\t\tassert.strictEqual(retryTimes, 0, \"Should retry\");\n\t\tassert.strictEqual(success, true, \"Should succeed as retry should be successful\");\n\t});\n\n\tit(\"Should not retry if canRetry is set as false\", async () => {\n\t\tlet retryTimes: number = 1;\n\t\tlet success = false;\n\t\tconst api = async () => {\n\t\t\tif (retryTimes > 0) {\n\t\t\t\tretryTimes -= 1;\n\t\t\t\tconst error = new Error(\"error\");\n\t\t\t\t(error as any).canRetry = false;\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\treturn true;\n\t\t};\n\t\ttry {\n\t\t\tsuccess = await runWithFastSetTimeout(async () =>\n\t\t\t\trunWithRetry(api, \"test\", logger, {}),\n\t\t\t);\n\t\t\tassert.fail(\"Should not succeed\");\n\t\t} catch (error) {}\n\t\tassert.strictEqual(retryTimes, 0, \"Should not retry\");\n\t\tassert.strictEqual(success, false, \"Should not succeed as canRetry was not set\");\n\t});\n\n\tit(\"Should not retry if canRetry is not set\", async () => {\n\t\tlet retryTimes: number = 1;\n\t\tlet success = false;\n\t\tconst api = async () => {\n\t\t\tif (retryTimes > 0) {\n\t\t\t\tretryTimes -= 1;\n\t\t\t\tconst error = new Error(\"error\");\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\treturn true;\n\t\t};\n\t\ttry {\n\t\t\tsuccess = await runWithFastSetTimeout(async () =>\n\t\t\t\trunWithRetry(api, \"test\", logger, {}),\n\t\t\t);\n\t\t\tassert.fail(\"Should not succeed\");\n\t\t} catch (error) {}\n\t\tassert.strictEqual(retryTimes, 0, \"Should not retry\");\n\t\tassert.strictEqual(success, false, \"Should not succeed as canRetry was not set\");\n\t});\n\n\tit(\"Should not retry if it is disabled\", async () => {\n\t\tlet retryTimes: number = 1;\n\t\tlet success = false;\n\t\tconst api = async () => {\n\t\t\tif (retryTimes > 0) {\n\t\t\t\tretryTimes -= 1;\n\t\t\t\tconst error = new Error(\"error\");\n\t\t\t\t(error as any).canRetry = true;\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\treturn true;\n\t\t};\n\t\ttry {\n\t\t\tsuccess = await runWithFastSetTimeout(async () =>\n\t\t\t\trunWithRetry(api, \"test\", logger, {\n\t\t\t\t\tonRetry: () => {\n\t\t\t\t\t\tthrow new Error(\"disposed\");\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t);\n\t\t\tassert.fail(\"Should not succeed\");\n\t\t} catch (error) {}\n\t\tassert.strictEqual(retryTimes, 0, \"Should not retry\");\n\t\tassert.strictEqual(success, false, \"Should not succeed as retrying was disabled\");\n\t});\n\n\tit(\"Abort reason is included in thrown exception\", async () => {\n\t\tconst abortController = new AbortController();\n\n\t\tconst api = () => {\n\t\t\tabortController.abort(\"Sample abort reason\");\n\t\t\tconst error = new Error(\"aborted\");\n\t\t\t(error as any).canRetry = true;\n\t\t\tthrow error;\n\t\t};\n\t\ttry {\n\t\t\tawait runWithFastSetTimeout(async () =>\n\t\t\t\trunWithRetry(api, \"test\", logger, {\n\t\t\t\t\tcancel: abortController.signal,\n\t\t\t\t}),\n\t\t\t);\n\t\t\tassert.fail(\"Should not succeed\");\n\t\t} catch (error) {\n\t\t\tassert.strictEqual((error as any).message, \"runWithRetry was Aborted\");\n\t\t\tassert.strictEqual((error as any).reason, \"Sample abort reason\");\n\t\t}\n\t});\n});\n"]}