@fluidframework/routerlicious-driver 2.0.0-dev-rc.2.0.0.245554 → 2.0.0-dev-rc.3.0.0.250606

package/lib/test/cache.spec.js

@@ -0,0 +1,43 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { useFakeTimers } from "sinon";
+import { InMemoryCache } from "../cache.js";
+describe("InMemoryCache", () => {
+    let clock;
+    let cache;
+    before(() => {
+        clock = useFakeTimers();
+    });
+    afterEach(() => {
+        clock.reset();
+    });
+    after(() => {
+        clock.restore();
+    });
+    it("No expiry", async () => {
+        cache = new InMemoryCache();
+        await cache.put("one", 1);
+        clock.tick(Number.MAX_SAFE_INTEGER);
+        assert.equal(await cache.get("one"), 1, "Entry shouldn't expire");
+    });
+    it("With expiry", async () => {
+        const expiryMs = 10;
+        cache = new InMemoryCache(expiryMs);
+        await cache.put("one", 1);
+        await cache.put("two", 2);
+        clock.tick(5);
+        assert.equal(await cache.get("one"), 1, "'one' shouldn't be expired after 5ms");
+        assert.equal(await cache.get("two"), 2, "'two' shouldn't be expired after 5ms");
+        assert.equal(await cache.get("one"), 1); // Should NOT reset the expiry, only put does
+        await cache.put("two", 2.1);
+        await cache.put("three", 3);
+        clock.tick(5);
+        assert.equal(await cache.get("one"), undefined, "'one' should be expired after 10ms");
+        assert.equal(await cache.get("two"), 2.1, "'two' shouldn't be expired after 5ms");
+        assert.equal(await cache.get("three"), 3, "'three' shouldn't be expired after 5ms");
+    });
+});
+//# sourceMappingURL=cache.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cache.spec.js","sourceRoot":"","sources":["../../src/test/cache.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAmB,aAAa,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,EAAU,aAAa,EAAE,MAAM,aAAa,CAAC;AAEpD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC9B,IAAI,KAAsB,CAAC;IAC3B,IAAI,KAAqB,CAAC;IAE1B,MAAM,CAAC,GAAG,EAAE;QACX,KAAK,GAAG,aAAa,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACd,KAAK,CAAC,KAAK,EAAE,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE;QACV,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;QAC1B,KAAK,GAAG,IAAI,aAAa,EAAE,CAAC;QAC5B,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAE1B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAEpC,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,wBAAwB,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;QAC5B,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,GAAG,IAAI,aAAa,CAAS,QAAQ,CAAC,CAAC;QAE5C,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1B,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAE1B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,sCAAsC,CAAC,CAAC;QAChF,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,sCAAsC,CAAC,CAAC;QAEhF,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,6CAA6C;QACtF,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC5B,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAE5B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,oCAAoC,CAAC,CAAC;QACtF,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,sCAAsC,CAAC,CAAC;QAClF,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,wCAAwC,CAAC,CAAC;IACrF,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 { SinonFakeTimers, useFakeTimers } from \"sinon\";\nimport { ICache, InMemoryCache } from \"../cache.js\";\n\ndescribe(\"InMemoryCache\", () => {\n\tlet clock: SinonFakeTimers;\n\tlet cache: ICache<number>;\n\n\tbefore(() => {\n\t\tclock = useFakeTimers();\n\t});\n\n\tafterEach(() => {\n\t\tclock.reset();\n\t});\n\n\tafter(() => {\n\t\tclock.restore();\n\t});\n\n\tit(\"No expiry\", async () => {\n\t\tcache = new InMemoryCache();\n\t\tawait cache.put(\"one\", 1);\n\n\t\tclock.tick(Number.MAX_SAFE_INTEGER);\n\n\t\tassert.equal(await cache.get(\"one\"), 1, \"Entry shouldn't expire\");\n\t});\n\n\tit(\"With expiry\", async () => {\n\t\tconst expiryMs = 10;\n\t\tcache = new InMemoryCache<number>(expiryMs);\n\n\t\tawait cache.put(\"one\", 1);\n\t\tawait cache.put(\"two\", 2);\n\n\t\tclock.tick(5);\n\t\tassert.equal(await cache.get(\"one\"), 1, \"'one' shouldn't be expired after 5ms\");\n\t\tassert.equal(await cache.get(\"two\"), 2, \"'two' shouldn't be expired after 5ms\");\n\n\t\tassert.equal(await cache.get(\"one\"), 1); // Should NOT reset the expiry, only put does\n\t\tawait cache.put(\"two\", 2.1);\n\t\tawait cache.put(\"three\", 3);\n\n\t\tclock.tick(5);\n\t\tassert.equal(await cache.get(\"one\"), undefined, \"'one' should be expired after 10ms\");\n\t\tassert.equal(await cache.get(\"two\"), 2.1, \"'two' shouldn't be expired after 5ms\");\n\t\tassert.equal(await cache.get(\"three\"), 3, \"'three' shouldn't be expired after 5ms\");\n\t});\n});\n"]}

package/lib/test/errorUtils.spec.js

@@ -0,0 +1,227 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import assert from "assert";
+import { FluidErrorTypes } from "@fluidframework/core-interfaces";
+import { RouterliciousErrorTypes, createR11sNetworkError, errorObjectFromSocketError, throwR11sNetworkError, } from "../errorUtils.js";
+describe("ErrorUtils", () => {
+    /**
+     * Checks if the input is an {@link IThrottlingWarning}.
+     */
+    function isIThrottlingWarning(input) {
+        return (input !== undefined &&
+            input.errorType === FluidErrorTypes.throttlingError &&
+            input.retryAfterSeconds !== undefined);
+    }
+    describe("createR11sNetworkError()", () => {
+        it("creates non-retriable authorization error on 401", () => {
+            const message = "test error";
+            const error = createR11sNetworkError(message, 401);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);
+            assert.strictEqual(error.canRetry, false);
+        });
+        it("creates non-retriable authorization error on 403", () => {
+            const message = "test error";
+            const error = createR11sNetworkError(message, 403);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);
+            assert.strictEqual(error.canRetry, false);
+        });
+        it("creates non-retriable not-found error on 404", () => {
+            const message = "test error";
+            const error = createR11sNetworkError(message, 404);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.fileNotFoundOrAccessDeniedError);
+            assert.strictEqual(error.canRetry, false);
+        });
+        it("creates retriable error on 429 with retry-after", () => {
+            const message = "test error";
+            const error = createR11sNetworkError(message, 429, 5000);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.throttlingError);
+            assert.strictEqual(error.canRetry, true);
+            assert.strictEqual(error.retryAfterSeconds, 5);
+        });
+        it("creates retriable error on 429 without retry-after", () => {
+            const message = "test error";
+            const error = createR11sNetworkError(message, 429);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);
+            assert.strictEqual(error.canRetry, true);
+        });
+        it("creates retriable error on 500", () => {
+            const message = "test error";
+            const error = createR11sNetworkError(message, 500);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);
+            assert.strictEqual(error.canRetry, true);
+        });
+        it("creates retriable error on anything else with retryAfter", () => {
+            const message = "test error";
+            const error = createR11sNetworkError(message, 400, 100000);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.throttlingError);
+            assert.strictEqual(error.canRetry, true);
+            assert.strictEqual(error.retryAfterSeconds, 100);
+        });
+        it("creates non-retriable error on anything else", () => {
+            const message = "test error";
+            const error2 = createR11sNetworkError(message, 400);
+            assert.strictEqual(error2.errorType, RouterliciousErrorTypes.genericNetworkError);
+            assert.strictEqual(error2.canRetry, false);
+        });
+    });
+    describe("throwR11sNetworkError()", () => {
+        it("throws non-retriable authorization error on 401", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 401);
+            }, {
+                errorType: RouterliciousErrorTypes.authorizationError,
+                canRetry: false,
+            });
+        });
+        it("throws non-retriable authorization error on 403", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 403);
+            }, {
+                errorType: RouterliciousErrorTypes.authorizationError,
+                canRetry: false,
+            });
+        });
+        it("throws non-retriable not-found error on 404", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 404);
+            }, {
+                errorType: RouterliciousErrorTypes.fileNotFoundOrAccessDeniedError,
+                canRetry: false,
+            });
+        });
+        it("throws retriable error on 429 with retry-after", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 429, 5000);
+            }, {
+                errorType: RouterliciousErrorTypes.throttlingError,
+                canRetry: true,
+                retryAfterSeconds: 5,
+            });
+        });
+        it("throws retriable error on 429 without retry-after", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 429);
+            }, {
+                errorType: RouterliciousErrorTypes.genericNetworkError,
+                canRetry: true,
+            });
+        });
+        it("throws retriable error on 500", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 500);
+            }, {
+                errorType: RouterliciousErrorTypes.genericNetworkError,
+                canRetry: true,
+            });
+        });
+        it("throws retriable error on anything else with retryAfter", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 400, 200000);
+            }, {
+                errorType: RouterliciousErrorTypes.throttlingError,
+                canRetry: true,
+                retryAfterSeconds: 200,
+            });
+        });
+        it("throws non-retriable error on anything else", () => {
+            const message = "test error";
+            assert.throws(() => {
+                throwR11sNetworkError(message, 400);
+            }, {
+                errorType: RouterliciousErrorTypes.genericNetworkError,
+                canRetry: false,
+            });
+        });
+    });
+    describe("errorObjectFromSocketError()", () => {
+        const handler = "test_handler";
+        const message = "test error";
+        const assertExpectedMessage = (actualMessage) => {
+            assert(actualMessage.includes(message), "R11s error should include socket error message");
+            assert(actualMessage.includes(handler), "R11s error should include handler name");
+        };
+        it("creates non-retriable authorization error on 401", () => {
+            const error = errorObjectFromSocketError({
+                code: 401,
+                message,
+            }, handler);
+            assertExpectedMessage(error.message);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);
+            assert.strictEqual(error.canRetry, false);
+            assert.strictEqual(error.statusCode, 401);
+        });
+        it("creates non-retriable authorization error on 403", () => {
+            const error = errorObjectFromSocketError({
+                code: 403,
+                message,
+            }, handler);
+            assertExpectedMessage(error.message);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);
+            assert.strictEqual(error.canRetry, false);
+            assert.strictEqual(error.statusCode, 403);
+        });
+        it("creates non-retriable not-found error on 404", () => {
+            const error = errorObjectFromSocketError({
+                code: 404,
+                message,
+            }, handler);
+            assertExpectedMessage(error.message);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.fileNotFoundOrAccessDeniedError);
+            assert.strictEqual(error.canRetry, false);
+            assert.strictEqual(error.statusCode, 404);
+        });
+        it("creates retriable error on 429 with retry-after", () => {
+            const error = errorObjectFromSocketError({
+                code: 429,
+                message,
+                retryAfterMs: 5000,
+            }, handler);
+            assert(isIThrottlingWarning(error));
+            assertExpectedMessage(error.message);
+            assert.strictEqual(error.canRetry, true);
+            assert.strictEqual(error.retryAfterSeconds, 5);
+            assert.strictEqual(error.statusCode, 429);
+        });
+        it("creates retriable error on 429 without retry-after", () => {
+            const error = errorObjectFromSocketError({
+                code: 429,
+                message,
+            }, handler);
+            assertExpectedMessage(error.message);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);
+            assert.strictEqual(error.canRetry, true);
+        });
+        it("creates retriable error on 500", () => {
+            const error = errorObjectFromSocketError({
+                code: 500,
+                message,
+            }, handler);
+            assertExpectedMessage(error.message);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);
+            assert.strictEqual(error.canRetry, true);
+            assert.strictEqual(error.statusCode, 500);
+        });
+        it("creates retriable error on 400 with retryAfter", () => {
+            const error = errorObjectFromSocketError({
+                code: 400,
+                message,
+                retryAfterMs: 300000,
+            }, handler);
+            assertExpectedMessage(error.message);
+            assert.strictEqual(error.errorType, RouterliciousErrorTypes.throttlingError);
+            assert.strictEqual(error.canRetry, true);
+            assert.strictEqual(error.retryAfterSeconds, 300);
+            assert.strictEqual(error.statusCode, 400);
+        });
+    });
+});
+//# sourceMappingURL=errorUtils.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errorUtils.spec.js","sourceRoot":"","sources":["../../src/test/errorUtils.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EACN,uBAAuB,EACvB,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,GACrB,MAAM,kBAAkB,CAAC;AAE1B,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC3B;;OAEG;IACH,SAAS,oBAAoB,CAAC,KAAc;QAC3C,OAAO,CACN,KAAK,KAAK,SAAS;YAClB,KAAqC,CAAC,SAAS,KAAK,eAAe,CAAC,eAAe;YACnF,KAAqC,CAAC,iBAAiB,KAAK,SAAS,CACtE,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACzC,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC3D,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;YAChF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC3D,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;YAChF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,CAAC,WAAW,CACjB,KAAK,CAAC,SAAS,EACf,uBAAuB,CAAC,+BAA+B,CACvD,CAAC;YACF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC1D,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACzD,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,eAAe,CAAC,CAAC;YAC7E,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,WAAW,CAAE,KAA4B,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC7D,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;YACjF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACzC,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;YACjF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YACnE,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;YAC3D,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,eAAe,CAAC,CAAC;YAC7E,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,MAAM,GAAG,sBAAsB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACpD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;YAClF,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACxC,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC1D,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,kBAAkB;gBACrD,QAAQ,EAAE,KAAK;aACf,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC1D,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,kBAAkB;gBACrD,QAAQ,EAAE,KAAK;aACf,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACtD,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,+BAA+B;gBAClE,QAAQ,EAAE,KAAK;aACf,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACzD,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,eAAe;gBAClD,QAAQ,EAAE,IAAI;gBACd,iBAAiB,EAAE,CAAC;aACpB,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC5D,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB;gBACtD,QAAQ,EAAE,IAAI;aACd,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACxC,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB;gBACtD,QAAQ,EAAE,IAAI;aACd,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YAClE,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;YAC7C,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,eAAe;gBAClD,QAAQ,EAAE,IAAI;gBACd,iBAAiB,EAAE,GAAG;aACtB,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACtD,MAAM,OAAO,GAAG,YAAY,CAAC;YAC7B,MAAM,CAAC,MAAM,CACZ,GAAG,EAAE;gBACJ,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,EACD;gBACC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB;gBACtD,QAAQ,EAAE,KAAK;aACf,CACD,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;QAC7C,MAAM,OAAO,GAAG,cAAc,CAAC;QAC/B,MAAM,OAAO,GAAG,YAAY,CAAC;QAC7B,MAAM,qBAAqB,GAAG,CAAC,aAAqB,EAAE,EAAE;YACvD,MAAM,CACL,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,EAC/B,gDAAgD,CAChD,CAAC;YACF,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,wCAAwC,CAAC,CAAC;QACnF,CAAC,CAAC;QACF,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC3D,MAAM,KAAK,GAAG,0BAA0B,CACvC;gBACC,IAAI,EAAE,GAAG;gBACT,OAAO;aACP,EACD,OAAO,CACP,CAAC;YACF,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;YAChF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC3D,MAAM,KAAK,GAAG,0BAA0B,CACvC;gBACC,IAAI,EAAE,GAAG;gBACT,OAAO;aACP,EACD,OAAO,CACP,CAAC;YACF,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;YAChF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,KAAK,GAAG,0BAA0B,CACvC;gBACC,IAAI,EAAE,GAAG;gBACT,OAAO;aACP,EACD,OAAO,CACP,CAAC;YACF,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,WAAW,CACjB,KAAK,CAAC,SAAS,EACf,uBAAuB,CAAC,+BAA+B,CACvD,CAAC;YACF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC1D,MAAM,KAAK,GAAG,0BAA0B,CACvC;gBACC,IAAI,EAAE,GAAG;gBACT,OAAO;gBACP,YAAY,EAAE,IAAI;aAClB,EACD,OAAO,CACP,CAAC;YAEF,MAAM,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpC,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC;YAC/C,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC7D,MAAM,KAAK,GAAG,0BAA0B,CACvC;gBACC,IAAI,EAAE,GAAG;gBACT,OAAO;aACP,EACD,OAAO,CACP,CAAC;YACF,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;YACjF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACzC,MAAM,KAAK,GAAG,0BAA0B,CACvC;gBACC,IAAI,EAAE,GAAG;gBACT,OAAO;aACP,EACD,OAAO,CACP,CAAC;YACF,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;YACjF,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACzD,MAAM,KAAK,GAAG,0BAA0B,CACvC;gBACC,IAAI,EAAE,GAAG;gBACT,OAAO;gBACP,YAAY,EAAE,MAAM;aACpB,EACD,OAAO,CACP,CAAC;YACF,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,uBAAuB,CAAC,eAAe,CAAC,CAAC;YAC7E,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;YAC1D,MAAM,CAAC,WAAW,CAAE,KAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACJ,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 assert from \"assert\";\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces\";\nimport { IThrottlingWarning } from \"@fluidframework/driver-definitions\";\nimport {\n\tRouterliciousErrorTypes,\n\tcreateR11sNetworkError,\n\terrorObjectFromSocketError,\n\tthrowR11sNetworkError,\n} from \"../errorUtils.js\";\n\ndescribe(\"ErrorUtils\", () => {\n\t/**\n\t * Checks if the input is an {@link IThrottlingWarning}.\n\t */\n\tfunction isIThrottlingWarning(input: unknown): input is IThrottlingWarning {\n\t\treturn (\n\t\t\tinput !== undefined &&\n\t\t\t(input as Partial<IThrottlingWarning>).errorType === FluidErrorTypes.throttlingError &&\n\t\t\t(input as Partial<IThrottlingWarning>).retryAfterSeconds !== undefined\n\t\t);\n\t}\n\n\tdescribe(\"createR11sNetworkError()\", () => {\n\t\tit(\"creates non-retriable authorization error on 401\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error = createR11sNetworkError(message, 401);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);\n\t\t\tassert.strictEqual(error.canRetry, false);\n\t\t});\n\t\tit(\"creates non-retriable authorization error on 403\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error = createR11sNetworkError(message, 403);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);\n\t\t\tassert.strictEqual(error.canRetry, false);\n\t\t});\n\t\tit(\"creates non-retriable not-found error on 404\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error = createR11sNetworkError(message, 404);\n\t\t\tassert.strictEqual(\n\t\t\t\terror.errorType,\n\t\t\t\tRouterliciousErrorTypes.fileNotFoundOrAccessDeniedError,\n\t\t\t);\n\t\t\tassert.strictEqual(error.canRetry, false);\n\t\t});\n\t\tit(\"creates retriable error on 429 with retry-after\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error = createR11sNetworkError(message, 429, 5000);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.throttlingError);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t\tassert.strictEqual((error as IThrottlingWarning).retryAfterSeconds, 5);\n\t\t});\n\t\tit(\"creates retriable error on 429 without retry-after\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error = createR11sNetworkError(message, 429);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t});\n\t\tit(\"creates retriable error on 500\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error = createR11sNetworkError(message, 500);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t});\n\t\tit(\"creates retriable error on anything else with retryAfter\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error = createR11sNetworkError(message, 400, 100000);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.throttlingError);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t\tassert.strictEqual((error as any).retryAfterSeconds, 100);\n\t\t});\n\t\tit(\"creates non-retriable error on anything else\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tconst error2 = createR11sNetworkError(message, 400);\n\t\t\tassert.strictEqual(error2.errorType, RouterliciousErrorTypes.genericNetworkError);\n\t\t\tassert.strictEqual(error2.canRetry, false);\n\t\t});\n\t});\n\tdescribe(\"throwR11sNetworkError()\", () => {\n\t\tit(\"throws non-retriable authorization error on 401\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 401);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.authorizationError,\n\t\t\t\t\tcanRetry: false,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t\tit(\"throws non-retriable authorization error on 403\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 403);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.authorizationError,\n\t\t\t\t\tcanRetry: false,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t\tit(\"throws non-retriable not-found error on 404\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 404);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.fileNotFoundOrAccessDeniedError,\n\t\t\t\t\tcanRetry: false,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t\tit(\"throws retriable error on 429 with retry-after\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 429, 5000);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.throttlingError,\n\t\t\t\t\tcanRetry: true,\n\t\t\t\t\tretryAfterSeconds: 5,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t\tit(\"throws retriable error on 429 without retry-after\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 429);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.genericNetworkError,\n\t\t\t\t\tcanRetry: true,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t\tit(\"throws retriable error on 500\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 500);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.genericNetworkError,\n\t\t\t\t\tcanRetry: true,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t\tit(\"throws retriable error on anything else with retryAfter\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 400, 200000);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.throttlingError,\n\t\t\t\t\tcanRetry: true,\n\t\t\t\t\tretryAfterSeconds: 200,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t\tit(\"throws non-retriable error on anything else\", () => {\n\t\t\tconst message = \"test error\";\n\t\t\tassert.throws(\n\t\t\t\t() => {\n\t\t\t\t\tthrowR11sNetworkError(message, 400);\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\terrorType: RouterliciousErrorTypes.genericNetworkError,\n\t\t\t\t\tcanRetry: false,\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t});\n\tdescribe(\"errorObjectFromSocketError()\", () => {\n\t\tconst handler = \"test_handler\";\n\t\tconst message = \"test error\";\n\t\tconst assertExpectedMessage = (actualMessage: string) => {\n\t\t\tassert(\n\t\t\t\tactualMessage.includes(message),\n\t\t\t\t\"R11s error should include socket error message\",\n\t\t\t);\n\t\t\tassert(actualMessage.includes(handler), \"R11s error should include handler name\");\n\t\t};\n\t\tit(\"creates non-retriable authorization error on 401\", () => {\n\t\t\tconst error = errorObjectFromSocketError(\n\t\t\t\t{\n\t\t\t\t\tcode: 401,\n\t\t\t\t\tmessage,\n\t\t\t\t},\n\t\t\t\thandler,\n\t\t\t);\n\t\t\tassertExpectedMessage(error.message);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);\n\t\t\tassert.strictEqual(error.canRetry, false);\n\t\t\tassert.strictEqual((error as any).statusCode, 401);\n\t\t});\n\t\tit(\"creates non-retriable authorization error on 403\", () => {\n\t\t\tconst error = errorObjectFromSocketError(\n\t\t\t\t{\n\t\t\t\t\tcode: 403,\n\t\t\t\t\tmessage,\n\t\t\t\t},\n\t\t\t\thandler,\n\t\t\t);\n\t\t\tassertExpectedMessage(error.message);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.authorizationError);\n\t\t\tassert.strictEqual(error.canRetry, false);\n\t\t\tassert.strictEqual((error as any).statusCode, 403);\n\t\t});\n\t\tit(\"creates non-retriable not-found error on 404\", () => {\n\t\t\tconst error = errorObjectFromSocketError(\n\t\t\t\t{\n\t\t\t\t\tcode: 404,\n\t\t\t\t\tmessage,\n\t\t\t\t},\n\t\t\t\thandler,\n\t\t\t);\n\t\t\tassertExpectedMessage(error.message);\n\t\t\tassert.strictEqual(\n\t\t\t\terror.errorType,\n\t\t\t\tRouterliciousErrorTypes.fileNotFoundOrAccessDeniedError,\n\t\t\t);\n\t\t\tassert.strictEqual(error.canRetry, false);\n\t\t\tassert.strictEqual((error as any).statusCode, 404);\n\t\t});\n\t\tit(\"creates retriable error on 429 with retry-after\", () => {\n\t\t\tconst error = errorObjectFromSocketError(\n\t\t\t\t{\n\t\t\t\t\tcode: 429,\n\t\t\t\t\tmessage,\n\t\t\t\t\tretryAfterMs: 5000,\n\t\t\t\t},\n\t\t\t\thandler,\n\t\t\t);\n\n\t\t\tassert(isIThrottlingWarning(error));\n\t\t\tassertExpectedMessage(error.message);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t\tassert.strictEqual(error.retryAfterSeconds, 5);\n\t\t\tassert.strictEqual((error as any).statusCode, 429);\n\t\t});\n\t\tit(\"creates retriable error on 429 without retry-after\", () => {\n\t\t\tconst error = errorObjectFromSocketError(\n\t\t\t\t{\n\t\t\t\t\tcode: 429,\n\t\t\t\t\tmessage,\n\t\t\t\t},\n\t\t\t\thandler,\n\t\t\t);\n\t\t\tassertExpectedMessage(error.message);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t});\n\t\tit(\"creates retriable error on 500\", () => {\n\t\t\tconst error = errorObjectFromSocketError(\n\t\t\t\t{\n\t\t\t\t\tcode: 500,\n\t\t\t\t\tmessage,\n\t\t\t\t},\n\t\t\t\thandler,\n\t\t\t);\n\t\t\tassertExpectedMessage(error.message);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.genericNetworkError);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t\tassert.strictEqual((error as any).statusCode, 500);\n\t\t});\n\t\tit(\"creates retriable error on 400 with retryAfter\", () => {\n\t\t\tconst error = errorObjectFromSocketError(\n\t\t\t\t{\n\t\t\t\t\tcode: 400,\n\t\t\t\t\tmessage,\n\t\t\t\t\tretryAfterMs: 300000,\n\t\t\t\t},\n\t\t\t\thandler,\n\t\t\t);\n\t\t\tassertExpectedMessage(error.message);\n\t\t\tassert.strictEqual(error.errorType, RouterliciousErrorTypes.throttlingError);\n\t\t\tassert.strictEqual(error.canRetry, true);\n\t\t\tassert.strictEqual((error as any).retryAfterSeconds, 300);\n\t\t\tassert.strictEqual((error as any).statusCode, 400);\n\t\t});\n\t});\n});\n"]}

package/lib/test/mapWithExpiration.spec.js

@@ -0,0 +1,205 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { useFakeTimers } from "sinon";
+import { MapWithExpiration } from "../mapWithExpiration.js";
+describe("MapWithExpiration", () => {
+    let clock;
+    before(() => {
+        clock = useFakeTimers();
+    });
+    afterEach(() => {
+        clock.reset();
+    });
+    after(() => {
+        clock.restore();
+    });
+    function assertSize(actual, expected, message) {
+        assert.equal(actual.size, expected.size, `'size' mismatch (${message})`);
+    }
+    function assertForEach(actual, expected, message) {
+        const actualValues = [];
+        const expectedValues = [];
+        actual.forEach((value, key) => {
+            actualValues[key] = value;
+        });
+        expected.forEach((value, key) => {
+            expectedValues[key] = value;
+        });
+        assert.equal(actualValues.join(","), expectedValues.join(","), `'forEach' mismatch (${message})`);
+    }
+    /** Asserts that actual has each key in expected (and elsewhere we assert that .keys matches) */
+    function assertHas(actual, expected) {
+        for (const k of expected.keys()) {
+            assert(actual.has(k), "'has' mismatch");
+        }
+    }
+    /** Asserts that actual.get returns the same value as expected for all keys (and elsewhere we assert that .keys matches) */
+    function assertGet(actual, expected, message) {
+        for (const k of expected.keys()) {
+            assert.equal(actual.get(k), expected.get(k), `'get' mismatch (${message})`);
+        }
+    }
+    /**
+     * Helper that takes the name of a function returning an Iterable,
+     * and returns a function that ensures actual and expected yield the same result when iterated over.
+     * If fnName is undefined, iterate over actual and expected directly
+     */
+    const assertIterable = (fnName) => function (actual, expected, message) {
+        const actuals = [];
+        for (const a of fnName === undefined ? actual : actual[fnName]()) {
+            actuals.push(a);
+        }
+        const expecteds = [];
+        for (const e of fnName === undefined ? expected : expected[fnName]()) {
+            expecteds.push(e);
+        }
+        assert.deepEqual(actuals.sort(), expecteds.sort(), `Iterator mismatch (${message})`);
+    };
+    const assertEntries = assertIterable("entries");
+    const assertKeys = assertIterable("keys");
+    const assertValues = assertIterable("values");
+    const assertSymbolIterator = assertIterable(Symbol.iterator);
+    const assertIterator = assertIterable();
+    /**
+     * This generates a test case per function to validate.
+     * They need to be tested independently since these all have side effects
+     */
+    function test(testName, testCallback) {
+        [
+            [assertSize, "check size"],
+            [assertForEach, "check forEach"],
+            [assertEntries, "check entries"],
+            [assertKeys, "check keys"],
+            [assertValues, "check values"],
+            [assertSymbolIterator, "check Symbol.iterator"],
+            [assertIterator, "check Iterator"],
+            [assertHas, "check has"],
+            [assertGet, "check get"],
+        ].forEach(([assertFn, caseName]) => {
+            it(`${testName} (${caseName})`, () => {
+                testCallback(assertFn);
+            });
+        });
+    }
+    test("Basic expiry", (assertMatches) => {
+        const expiryMs = 10;
+        const map = new MapWithExpiration(expiryMs);
+        const expected = new Map();
+        map.set(1, "one");
+        map.set(9, "nine");
+        expected.set(1, "one");
+        expected.set(9, "nine");
+        clock.tick(5);
+        assertMatches(map, expected, "Shouldn't be expired after 5ms");
+        map.get(1); // Should NOT reset the expiry, only set
+        map.set(9, "niner");
+        map.set(2, "two");
+        expected.set(9, "niner");
+        expected.set(2, "two");
+        assertMatches(map, expected, "Still shouldn't be expired");
+        clock.tick(5);
+        expected.delete(1);
+        assertMatches(map, expected, "Should be expired after 10ms unless set in the interim");
+    });
+    test("delete", (assertMatches) => {
+        const expiryMs = 10;
+        const map = new MapWithExpiration(expiryMs);
+        const expected = new Map();
+        map.set(1, "one");
+        map.set(9, "nine");
+        expected.set(1, "one");
+        expected.set(9, "nine");
+        assertMatches(map, expected, "Should have set some keys");
+        map.delete(9);
+        expected.delete(9);
+        assertMatches(map, expected, "Should be updated by delete");
+    });
+    test("clear", (assertMatches) => {
+        const expiryMs = 10;
+        const map = new MapWithExpiration(expiryMs);
+        const expected = new Map();
+        map.set(1, "one");
+        map.set(9, "nine");
+        expected.set(1, "one");
+        expected.set(9, "nine");
+        assertMatches(map, expected, "Should have set some keys");
+        map.clear();
+        expected.clear();
+        assertMatches(map, expected, "Should be empty after clear");
+    });
+    describe("forEach thisArg", () => {
+        function testForEachCases(testName, testFn) {
+            it(testName, () => {
+                testFn([new Map(), new MapWithExpiration(10)], // We run plain Map and MapWithExpiration through to ensure matching behavior
+                ["THIS", undefined]);
+            });
+        }
+        testForEachCases("Inline function callback should use thisArg for 'this'", (maps, thisArgs) => {
+            for (const thisArg of thisArgs) {
+                for (const map of maps) {
+                    map.set(1, "one");
+                    map.forEach(function (value, key, m) {
+                        assert.equal(this, thisArg, "Incorrect value for 'this'");
+                    }, thisArg);
+                }
+            }
+        });
+        testForEachCases(".bind on an inline function callback should supersede thisArg", (maps, thisArgs) => {
+            for (const thisArg of thisArgs) {
+                for (const map of maps) {
+                    map.set(1, "one");
+                    map.forEach(function (value, key, m) {
+                        assert.equal(this, "BOUND", "Incorrect value for 'this'");
+                    }.bind("BOUND"), thisArg);
+                }
+            }
+        });
+        class Foo {
+            cb(valueWhichIsExpectedThis, k, m) {
+                assert(!(this instanceof Foo), "'this' should not be a Foo, it should have been overridden");
+                assert.equal(this, valueWhichIsExpectedThis, "Incorrect value for 'this'");
+            }
+        }
+        testForEachCases("Class function callback should use thisArg not the class instance", (maps, thisArgs) => {
+            const foo = new Foo();
+            for (const thisArg of thisArgs) {
+                for (const map of maps) {
+                    map.set(1, thisArg); // We will sneak in thisArg as the value to let us assert about it in cb
+                    map.forEach(foo.cb, thisArg);
+                }
+            }
+        });
+        testForEachCases(".bind on a class function callback should supersede thisArg", (maps, thisArgs) => {
+            const foo = new Foo();
+            for (const thisArg of thisArgs) {
+                for (const map of maps) {
+                    map.set(1, "BOUND"); // We will sneak in thisArg as the value to let us assert about it in cb
+                    map.forEach(foo.cb.bind("BOUND"), thisArg);
+                }
+            }
+        });
+        // In ESM the the 'this' value is 'undefined', but in CJS it is '{__esModule: true}'.
+        // Therefore, we exempt the test value 'undefined' from the below assertion.
+        if (this !== undefined) {
+            testForEachCases("Arrow functions don't pick up thisArg", (maps, thisArgs) => {
+                for (const thisArg of thisArgs) {
+                    for (const map of maps) {
+                        map.set(1, "one");
+                        map.forEach(() => {
+                            assert.notEqual(this, thisArg, "Expected 'this' to be unchanged for arrow fn");
+                        }, thisArg);
+                    }
+                }
+            });
+        }
+    });
+    it("toString", () => {
+        const map = new MapWithExpiration(0);
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
+        assert.equal(map.toString(), "[object Map]");
+    });
+});
+//# sourceMappingURL=mapWithExpiration.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapWithExpiration.spec.js","sourceRoot":"","sources":["../../src/test/mapWithExpiration.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAmB,aAAa,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAClC,IAAI,KAAsB,CAAC;IAE3B,MAAM,CAAC,GAAG,EAAE;QACX,KAAK,GAAG,aAAa,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACd,KAAK,CAAC,KAAK,EAAE,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE;QACV,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,SAAS,UAAU,CAClB,MAAyC,EACzC,QAA6B,EAC7B,OAAe;QAEf,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,oBAAoB,OAAO,GAAG,CAAC,CAAC;IAC1E,CAAC;IAED,SAAS,aAAa,CACrB,MAAyC,EACzC,QAA6B,EAC7B,OAAe;QAEf,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC7B,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC/B,cAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EACtB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EACxB,uBAAuB,OAAO,GAAG,CACjC,CAAC;IACH,CAAC;IAED,gGAAgG;IAChG,SAAS,SAAS,CAAC,MAAyC,EAAE,QAA6B;QAC1F,KAAK,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;SACxC;IACF,CAAC;IAED,2HAA2H;IAC3H,SAAS,SAAS,CACjB,MAAyC,EACzC,QAA6B,EAC7B,OAAe;QAEf,KAAK,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,mBAAmB,OAAO,GAAG,CAAC,CAAC;SAC5E;IACF,CAAC;IAED;;;;OAIG;IACH,MAAM,cAAc,GAAG,CAAC,MAAwC,EAAE,EAAE,CACnE,UACC,MAAyC,EACzC,QAA6B,EAC7B,OAAe;QAEf,MAAM,OAAO,GAAU,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,IAAI,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE;YACjE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAChB;QACD,MAAM,SAAS,GAAU,EAAE,CAAC;QAC5B,KAAK,MAAM,CAAC,IAAI,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE;YACrE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAClB;QACD,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC,IAAI,EAAE,EAAE,sBAAsB,OAAO,GAAG,CAAC,CAAC;IACtF,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,YAAY,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC9C,MAAM,oBAAoB,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,cAAc,GAAG,cAAc,EAAE,CAAC;IAExC;;;OAGG;IACH,SAAS,IAAI,CAAC,QAAgB,EAAE,YAAgC;QAC/D;YACC,CAAC,UAAU,EAAE,YAAY,CAAU;YACnC,CAAC,aAAa,EAAE,eAAe,CAAU;YACzC,CAAC,aAAa,EAAE,eAAe,CAAU;YACzC,CAAC,UAAU,EAAE,YAAY,CAAU;YACnC,CAAC,YAAY,EAAE,cAAc,CAAU;YACvC,CAAC,oBAAoB,EAAE,uBAAuB,CAAU;YACxD,CAAC,cAAc,EAAE,gBAAgB,CAAU;YAC3C,CAAC,SAAS,EAAE,WAAW,CAAU;YACjC,CAAC,SAAS,EAAE,WAAW,CAAU;SACjC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE;YAClC,EAAE,CAAC,GAAG,QAAQ,KAAK,QAAQ,GAAG,EAAE,GAAG,EAAE;gBACpC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,cAAc,EAAE,CAAC,aAIb,EAAE,EAAE;QACZ,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAAiB,QAAQ,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE3C,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAClB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACvB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAExB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,gCAAgC,CAAC,CAAC;QAE/D,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,wCAAwC;QACpD,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACpB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAClB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACzB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACvB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,4BAA4B,CAAC,CAAC;QAE3D,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACnB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,wDAAwD,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,EAAE,CAAC,aAIP,EAAE,EAAE;QACZ,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAAiB,QAAQ,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE3C,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAClB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACvB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAExB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QAE1D,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACd,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAEnB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE,CAAC,aAIN,EAAE,EAAE;QACZ,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAAiB,QAAQ,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE3C,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAClB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACvB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAExB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QAE1D,GAAG,CAAC,KAAK,EAAE,CAAC;QACZ,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEjB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAChC,SAAS,gBAAgB,CACxB,QAAgB,EAChB,MAAwD;YAExD,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACjB,MAAM,CACL,CAAC,IAAI,GAAG,EAAE,EAAE,IAAI,iBAAiB,CAAC,EAAE,CAAC,CAAC,EAAE,6EAA6E;gBACrH,CAAC,MAAM,EAAE,SAAS,CAAC,CACnB,CAAC;YACH,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,gBAAgB,CACf,wDAAwD,EACxD,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YAClB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;oBACvB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;oBAClB,GAAG,CAAC,OAAO,CAAC,UAEX,KAAa,EACb,GAAW,EACX,CAAsB;wBAEtB,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC;oBAC3D,CAAC,EAAE,OAAO,CAAC,CAAC;iBACZ;aACD;QACF,CAAC,CACD,CAAC;QAEF,gBAAgB,CACf,+DAA+D,EAC/D,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YAClB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;oBACvB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;oBAClB,GAAG,CAAC,OAAO,CACV,UAEC,KAAa,EACb,GAAW,EACX,CAAsB;wBAEtB,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC;oBAC3D,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EACf,OAAO,CACP,CAAC;iBACF;aACD;QACF,CAAC,CACD,CAAC;QAEF,MAAM,GAAG;YACR,EAAE,CAAY,wBAAwB,EAAE,CAAC,EAAE,CAAC;gBAC3C,MAAM,CACL,CAAC,CAAC,IAAI,YAAY,GAAG,CAAC,EACtB,4DAA4D,CAC5D,CAAC;gBACF,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,wBAAwB,EAAE,4BAA4B,CAAC,CAAC;YAC5E,CAAC;SACD;QAED,gBAAgB,CACf,mEAAmE,EACnE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YAClB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;YACtB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;oBACvB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,wEAAwE;oBAC7F,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;iBAC7B;aACD;QACF,CAAC,CACD,CAAC;QAEF,gBAAgB,CACf,6DAA6D,EAC7D,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YAClB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;YACtB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;oBACvB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,wEAAwE;oBAC7F,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;iBAC3C;aACD;QACF,CAAC,CACD,CAAC;QAEF,qFAAqF;QACrF,4EAA4E;QAC5E,IAAI,IAAI,KAAK,SAAS,EAAE;YACvB,gBAAgB,CAAC,uCAAuC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;gBAC5E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;oBAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;wBACvB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;wBAClB,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE;4BAChB,MAAM,CAAC,QAAQ,CACd,IAAI,EACJ,OAAO,EACP,8CAA8C,CAC9C,CAAC;wBACH,CAAC,EAAE,OAAO,CAAC,CAAC;qBACZ;iBACD;YACF,CAAC,CAAC,CAAC;SACH;IACF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;QACnB,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAAiB,CAAC,CAAC,CAAC;QACrD,gEAAgE;QAChE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;IAC9C,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 { SinonFakeTimers, useFakeTimers } from \"sinon\";\nimport { MapWithExpiration } from \"../mapWithExpiration.js\";\n\ndescribe(\"MapWithExpiration\", () => {\n\tlet clock: SinonFakeTimers;\n\n\tbefore(() => {\n\t\tclock = useFakeTimers();\n\t});\n\n\tafterEach(() => {\n\t\tclock.reset();\n\t});\n\n\tafter(() => {\n\t\tclock.restore();\n\t});\n\n\tfunction assertSize(\n\t\tactual: MapWithExpiration<number, string>,\n\t\texpected: Map<number, string>,\n\t\tmessage: string,\n\t) {\n\t\tassert.equal(actual.size, expected.size, `'size' mismatch (${message})`);\n\t}\n\n\tfunction assertForEach(\n\t\tactual: MapWithExpiration<number, string>,\n\t\texpected: Map<number, string>,\n\t\tmessage: string,\n\t) {\n\t\tconst actualValues: string[] = [];\n\t\tconst expectedValues: string[] = [];\n\t\tactual.forEach((value, key) => {\n\t\t\tactualValues[key] = value;\n\t\t});\n\t\texpected.forEach((value, key) => {\n\t\t\texpectedValues[key] = value;\n\t\t});\n\t\tassert.equal(\n\t\t\tactualValues.join(\",\"),\n\t\t\texpectedValues.join(\",\"),\n\t\t\t`'forEach' mismatch (${message})`,\n\t\t);\n\t}\n\n\t/** Asserts that actual has each key in expected (and elsewhere we assert that .keys matches) */\n\tfunction assertHas(actual: MapWithExpiration<number, string>, expected: Map<number, string>) {\n\t\tfor (const k of expected.keys()) {\n\t\t\tassert(actual.has(k), \"'has' mismatch\");\n\t\t}\n\t}\n\n\t/** Asserts that actual.get returns the same value as expected for all keys (and elsewhere we assert that .keys matches) */\n\tfunction assertGet(\n\t\tactual: MapWithExpiration<number, string>,\n\t\texpected: Map<number, string>,\n\t\tmessage: string,\n\t) {\n\t\tfor (const k of expected.keys()) {\n\t\t\tassert.equal(actual.get(k), expected.get(k), `'get' mismatch (${message})`);\n\t\t}\n\t}\n\n\t/**\n\t * Helper that takes the name of a function returning an Iterable,\n\t * and returns a function that ensures actual and expected yield the same result when iterated over.\n\t * If fnName is undefined, iterate over actual and expected directly\n\t */\n\tconst assertIterable = (fnName?: string | typeof Symbol.iterator) =>\n\t\tfunction (\n\t\t\tactual: MapWithExpiration<number, string>,\n\t\t\texpected: Map<number, string>,\n\t\t\tmessage: string,\n\t\t) {\n\t\t\tconst actuals: any[] = [];\n\t\t\tfor (const a of fnName === undefined ? actual : actual[fnName]()) {\n\t\t\t\tactuals.push(a);\n\t\t\t}\n\t\t\tconst expecteds: any[] = [];\n\t\t\tfor (const e of fnName === undefined ? expected : expected[fnName]()) {\n\t\t\t\texpecteds.push(e);\n\t\t\t}\n\t\t\tassert.deepEqual(actuals.sort(), expecteds.sort(), `Iterator mismatch (${message})`);\n\t\t};\n\n\tconst assertEntries = assertIterable(\"entries\");\n\tconst assertKeys = assertIterable(\"keys\");\n\tconst assertValues = assertIterable(\"values\");\n\tconst assertSymbolIterator = assertIterable(Symbol.iterator);\n\tconst assertIterator = assertIterable();\n\n\t/**\n\t * This generates a test case per function to validate.\n\t * They need to be tested independently since these all have side effects\n\t */\n\tfunction test(testName: string, testCallback: (assertFn) => void) {\n\t\t[\n\t\t\t[assertSize, \"check size\"] as const,\n\t\t\t[assertForEach, \"check forEach\"] as const,\n\t\t\t[assertEntries, \"check entries\"] as const,\n\t\t\t[assertKeys, \"check keys\"] as const,\n\t\t\t[assertValues, \"check values\"] as const,\n\t\t\t[assertSymbolIterator, \"check Symbol.iterator\"] as const,\n\t\t\t[assertIterator, \"check Iterator\"] as const,\n\t\t\t[assertHas, \"check has\"] as const,\n\t\t\t[assertGet, \"check get\"] as const,\n\t\t].forEach(([assertFn, caseName]) => {\n\t\t\tit(`${testName} (${caseName})`, () => {\n\t\t\t\ttestCallback(assertFn);\n\t\t\t});\n\t\t});\n\t}\n\n\ttest(\"Basic expiry\", (assertMatches: (\n\t\tactual: MapWithExpiration<number, string>,\n\t\texpected: Map<number, string>,\n\t\tmessage: string,\n\t) => void) => {\n\t\tconst expiryMs = 10;\n\t\tconst map = new MapWithExpiration<number, string>(expiryMs);\n\t\tconst expected = new Map<number, string>();\n\n\t\tmap.set(1, \"one\");\n\t\tmap.set(9, \"nine\");\n\t\texpected.set(1, \"one\");\n\t\texpected.set(9, \"nine\");\n\n\t\tclock.tick(5);\n\t\tassertMatches(map, expected, \"Shouldn't be expired after 5ms\");\n\n\t\tmap.get(1); // Should NOT reset the expiry, only set\n\t\tmap.set(9, \"niner\");\n\t\tmap.set(2, \"two\");\n\t\texpected.set(9, \"niner\");\n\t\texpected.set(2, \"two\");\n\t\tassertMatches(map, expected, \"Still shouldn't be expired\");\n\n\t\tclock.tick(5);\n\t\texpected.delete(1);\n\t\tassertMatches(map, expected, \"Should be expired after 10ms unless set in the interim\");\n\t});\n\n\ttest(\"delete\", (assertMatches: (\n\t\tactual: MapWithExpiration<number, string>,\n\t\texpected: Map<number, string>,\n\t\tmessage: string,\n\t) => void) => {\n\t\tconst expiryMs = 10;\n\t\tconst map = new MapWithExpiration<number, string>(expiryMs);\n\t\tconst expected = new Map<number, string>();\n\n\t\tmap.set(1, \"one\");\n\t\tmap.set(9, \"nine\");\n\t\texpected.set(1, \"one\");\n\t\texpected.set(9, \"nine\");\n\n\t\tassertMatches(map, expected, \"Should have set some keys\");\n\n\t\tmap.delete(9);\n\t\texpected.delete(9);\n\n\t\tassertMatches(map, expected, \"Should be updated by delete\");\n\t});\n\n\ttest(\"clear\", (assertMatches: (\n\t\tactual: MapWithExpiration<number, string>,\n\t\texpected: Map<number, string>,\n\t\tmessage: string,\n\t) => void) => {\n\t\tconst expiryMs = 10;\n\t\tconst map = new MapWithExpiration<number, string>(expiryMs);\n\t\tconst expected = new Map<number, string>();\n\n\t\tmap.set(1, \"one\");\n\t\tmap.set(9, \"nine\");\n\t\texpected.set(1, \"one\");\n\t\texpected.set(9, \"nine\");\n\n\t\tassertMatches(map, expected, \"Should have set some keys\");\n\n\t\tmap.clear();\n\t\texpected.clear();\n\n\t\tassertMatches(map, expected, \"Should be empty after clear\");\n\t});\n\n\tdescribe(\"forEach thisArg\", () => {\n\t\tfunction testForEachCases(\n\t\t\ttestName: string,\n\t\t\ttestFn: (maps: Map<any, any>[], thisArgs: any[]) => void,\n\t\t) {\n\t\t\tit(testName, () => {\n\t\t\t\ttestFn(\n\t\t\t\t\t[new Map(), new MapWithExpiration(10)], // We run plain Map and MapWithExpiration through to ensure matching behavior\n\t\t\t\t\t[\"THIS\", undefined],\n\t\t\t\t);\n\t\t\t});\n\t\t}\n\n\t\ttestForEachCases(\n\t\t\t\"Inline function callback should use thisArg for 'this'\",\n\t\t\t(maps, thisArgs) => {\n\t\t\t\tfor (const thisArg of thisArgs) {\n\t\t\t\t\tfor (const map of maps) {\n\t\t\t\t\t\tmap.set(1, \"one\");\n\t\t\t\t\t\tmap.forEach(function (\n\t\t\t\t\t\t\tthis: any,\n\t\t\t\t\t\t\tvalue: string,\n\t\t\t\t\t\t\tkey: number,\n\t\t\t\t\t\t\tm: Map<number, string>,\n\t\t\t\t\t\t) {\n\t\t\t\t\t\t\tassert.equal(this, thisArg, \"Incorrect value for 'this'\");\n\t\t\t\t\t\t}, thisArg);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t);\n\n\t\ttestForEachCases(\n\t\t\t\".bind on an inline function callback should supersede thisArg\",\n\t\t\t(maps, thisArgs) => {\n\t\t\t\tfor (const thisArg of thisArgs) {\n\t\t\t\t\tfor (const map of maps) {\n\t\t\t\t\t\tmap.set(1, \"one\");\n\t\t\t\t\t\tmap.forEach(\n\t\t\t\t\t\t\tfunction (\n\t\t\t\t\t\t\t\tthis: any,\n\t\t\t\t\t\t\t\tvalue: string,\n\t\t\t\t\t\t\t\tkey: number,\n\t\t\t\t\t\t\t\tm: Map<number, string>,\n\t\t\t\t\t\t\t) {\n\t\t\t\t\t\t\t\tassert.equal(this, \"BOUND\", \"Incorrect value for 'this'\");\n\t\t\t\t\t\t\t}.bind(\"BOUND\"),\n\t\t\t\t\t\t\tthisArg,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t);\n\n\t\tclass Foo {\n\t\t\tcb(this: any, valueWhichIsExpectedThis, k, m) {\n\t\t\t\tassert(\n\t\t\t\t\t!(this instanceof Foo),\n\t\t\t\t\t\"'this' should not be a Foo, it should have been overridden\",\n\t\t\t\t);\n\t\t\t\tassert.equal(this, valueWhichIsExpectedThis, \"Incorrect value for 'this'\");\n\t\t\t}\n\t\t}\n\n\t\ttestForEachCases(\n\t\t\t\"Class function callback should use thisArg not the class instance\",\n\t\t\t(maps, thisArgs) => {\n\t\t\t\tconst foo = new Foo();\n\t\t\t\tfor (const thisArg of thisArgs) {\n\t\t\t\t\tfor (const map of maps) {\n\t\t\t\t\t\tmap.set(1, thisArg); // We will sneak in thisArg as the value to let us assert about it in cb\n\t\t\t\t\t\tmap.forEach(foo.cb, thisArg);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t);\n\n\t\ttestForEachCases(\n\t\t\t\".bind on a class function callback should supersede thisArg\",\n\t\t\t(maps, thisArgs) => {\n\t\t\t\tconst foo = new Foo();\n\t\t\t\tfor (const thisArg of thisArgs) {\n\t\t\t\t\tfor (const map of maps) {\n\t\t\t\t\t\tmap.set(1, \"BOUND\"); // We will sneak in thisArg as the value to let us assert about it in cb\n\t\t\t\t\t\tmap.forEach(foo.cb.bind(\"BOUND\"), thisArg);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t);\n\n\t\t// In ESM the the 'this' value is 'undefined', but in CJS it is '{__esModule: true}'.\n\t\t// Therefore, we exempt the test value 'undefined' from the below assertion.\n\t\tif (this !== undefined) {\n\t\t\ttestForEachCases(\"Arrow functions don't pick up thisArg\", (maps, thisArgs) => {\n\t\t\t\tfor (const thisArg of thisArgs) {\n\t\t\t\t\tfor (const map of maps) {\n\t\t\t\t\t\tmap.set(1, \"one\");\n\t\t\t\t\t\tmap.forEach(() => {\n\t\t\t\t\t\t\tassert.notEqual(\n\t\t\t\t\t\t\t\tthis,\n\t\t\t\t\t\t\t\tthisArg,\n\t\t\t\t\t\t\t\t\"Expected 'this' to be unchanged for arrow fn\",\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t}, thisArg);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\t});\n\n\tit(\"toString\", () => {\n\t\tconst map = new MapWithExpiration<number, string>(0);\n\t\t// eslint-disable-next-line @typescript-eslint/no-base-to-string\n\t\tassert.equal(map.toString(), \"[object Map]\");\n\t});\n});\n"]}