@fluidframework/odsp-driver 2.0.0-dev-rc.1.0.0.232845 → 2.0.0-dev-rc.2.0.0.246488

package/lib/test/epochTests.spec.js

@@ -0,0 +1,340 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { OdspErrorTypes, maximumCacheDurationMs, } from "@fluidframework/odsp-driver-definitions";
+import { ThrottlingError } from "@fluidframework/driver-utils";
+import { createChildLogger } from "@fluidframework/telemetry-utils";
+import { stub } from "sinon";
+import { persistedCacheValueVersion } from "../contracts.js";
+import { EpochTracker } from "../epochTracker.js";
+import { LocalPersistentCache } from "../odspCache.js";
+import { getHashedDocumentId } from "../odspPublicUtils.js";
+import * as odspUtilsModule from "../odspUtils.js";
+import { mockFetchOk, mockFetchSingle, createResponse } from "./mockFetch.js";
+const createUtLocalCache = () => new LocalPersistentCache();
+describe("Tests for Epoch Tracker", () => {
+    const siteUrl = "https://microsoft.sharepoint-df.com/siteUrl";
+    const driveId = "driveId";
+    const itemId = "itemId";
+    let epochTracker;
+    let localCache;
+    let hashedDocumentId;
+    const resolvedUrl = {
+        siteUrl,
+        driveId,
+        itemId,
+        odspResolvedUrl: true,
+    };
+    before(async () => {
+        hashedDocumentId = await getHashedDocumentId(driveId, itemId);
+    });
+    beforeEach(() => {
+        localCache = createUtLocalCache();
+        // use null logger here as we expect errors
+        epochTracker = new EpochTracker(localCache, {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        }, createChildLogger());
+    });
+    afterEach(async () => {
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    it("defaultCacheExpiryTimeoutMs <= maximumCacheDurationMs policy", () => {
+        // This is the maximum allowed value per the policy - 5 days
+        const expected = 432000000;
+        assert(maximumCacheDurationMs <= expected, "Actual cache expiry used must meet the policy");
+    });
+    it("Cache, old versions", async () => {
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+            file: { docId: hashedDocumentId, resolvedUrl },
+        };
+        const cacheEntry2 = { ...cacheEntry1, key: "key2" };
+        const cacheValue1 = { val: "val1", cacheEntryTime: Date.now() };
+        const cacheValue2 = { val: "val2", cacheEntryTime: Date.now() };
+        const value1 = {
+            value: cacheValue1,
+            fluidEpoch: "epoch1",
+            version: persistedCacheValueVersion,
+        };
+        const value2 = {
+            value: cacheValue2,
+            fluidEpoch: "epoch1",
+            version: "non-existing version",
+        };
+        await localCache.put(cacheEntry1, value1);
+        await localCache.put(cacheEntry2, value2);
+        // This will set the initial epoch value in epoch tracker.
+        assert((await epochTracker.get(cacheEntry1)) === cacheValue1, "Entry 1 should continue to exist");
+        // This should not fail, just return nothing!
+        await epochTracker.get(cacheEntry2);
+        // Make sure nothing changed as result of reading data.
+        assert((await epochTracker.get(cacheEntry1)) === cacheValue1, "Entry 1 should continue to exist");
+        assert((await epochTracker.get(cacheEntry2)) === undefined, "Entry 2 should not exist");
+    });
+    it("Epoch error when fetch error from cache should throw epoch error and clear cache", async () => {
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+            file: { docId: hashedDocumentId, resolvedUrl },
+        };
+        const cacheEntry2 = { ...cacheEntry1, key: "key2" };
+        const cacheValue1 = { val: "val1", cacheEntryTime: Date.now() };
+        const cacheValue2 = { val: "val2", cacheEntryTime: Date.now() };
+        const value1 = {
+            value: cacheValue1,
+            fluidEpoch: "epoch1",
+            version: persistedCacheValueVersion,
+        };
+        const value2 = {
+            value: cacheValue2,
+            fluidEpoch: "epoch2",
+            version: persistedCacheValueVersion,
+        };
+        await localCache.put(cacheEntry1, value1);
+        await localCache.put(cacheEntry2, value2);
+        // This will set the initial epoch value in epoch tracker.
+        assert((await epochTracker.get(cacheEntry1)) === cacheValue1, "Entry 1 should continue to exist");
+        // This should not fail, just return nothing!
+        await epochTracker.get(cacheEntry2);
+        // Make sure nothing changed as result of reading data.
+        assert((await epochTracker.get(cacheEntry1)) === cacheValue1, "Entry 1 should continue to exist");
+        assert((await epochTracker.get(cacheEntry2)) === undefined, "Entry 2 should not exist");
+    });
+    it("Epoch error when fetch response and should clear cache", async () => {
+        let success = true;
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        try {
+            await mockFetchOk(async () => epochTracker.fetchArray("fetchUrl", {}, "test"), {}, { "x-fluid-epoch": "epoch2" });
+        }
+        catch (error) {
+            success = false;
+            assert.strictEqual(error.errorType, OdspErrorTypes.fileOverwrittenInStorage, "Error should be epoch error");
+        }
+        assert((await epochTracker.get(cacheEntry1)) === undefined, "Entry in cache should be cleared");
+        assert.strictEqual(success, false, "Fetching should fail!!");
+    });
+    it("Epoch error when fetch response as json and should clear cache", async () => {
+        let success = true;
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        try {
+            await mockFetchOk(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "test"), {}, { "x-fluid-epoch": "epoch2" });
+        }
+        catch (error) {
+            success = false;
+            assert.strictEqual(error.errorType, OdspErrorTypes.fileOverwrittenInStorage, "Error should be epoch error");
+        }
+        assert((await epochTracker.get(cacheEntry1)) === undefined, "Entry in cache should be cleared");
+        assert.strictEqual(success, false, "Fetching should fail!!");
+    });
+    it("Check client correlationID on error in unsuccessful fetch case", async () => {
+        let success = true;
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        try {
+            await mockFetchOk(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "test"), {}, { "x-fluid-epoch": "epoch2" });
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        }
+        catch (error) {
+            success = false;
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            assert(error.XRequestStatsHeader !== undefined, "CorrelationId should be present");
+        }
+        assert.strictEqual(success, false, "Fetching should fail!!");
+    });
+    it("Check client correlationID on spoCommonHeaders in successful fetch case", async () => {
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        const response = await mockFetchOk(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "test"), {}, { "x-fluid-epoch": "epoch1" });
+        assert(response.propsToLog.XRequestStatsHeader !== undefined, "CorrelationId should be present");
+    });
+    it("Epoch error should not occur if response does not contain epoch", async () => {
+        let success = true;
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        try {
+            await mockFetchOk(async () => epochTracker.fetchArray("fetchUrl", {}, "test"));
+        }
+        catch {
+            success = false;
+        }
+        assert.strictEqual(success, true, "Fetching should succeed!!");
+        assert.strictEqual(
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, unicorn/no-await-expression-member
+        (await epochTracker.get(cacheEntry1)).val, "val1", "Entry in cache should be present");
+    });
+    it("Epoch error should not occur if response contains same epoch", async () => {
+        let success = true;
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        try {
+            await mockFetchOk(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "test"), {}, { "x-fluid-epoch": "epoch1" });
+        }
+        catch {
+            success = false;
+        }
+        assert.strictEqual(success, true, "Fetching should succeed!!");
+        assert.strictEqual(
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, unicorn/no-await-expression-member
+        (await epochTracker.get(cacheEntry1)).val, "val1", "Entry in cache should be present");
+    });
+    it("Should differentiate between epoch and coherency 409 errors when coherency 409", async () => {
+        let success = true;
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        try {
+            await mockFetchSingle(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "test"), async () => createResponse({ "x-fluid-epoch": "epoch1" }, undefined, 409));
+        }
+        catch (error) {
+            success = false;
+            assert.strictEqual(error.errorType, OdspErrorTypes.throttlingError, "Error should be throttling error");
+        }
+        assert.strictEqual(success, false, "Fetching should not succeed!!");
+        assert.strictEqual(
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, unicorn/no-await-expression-member
+        (await epochTracker.get(cacheEntry1)).val, "val1", "Entry in cache should be present because it was not epoch 409");
+    });
+    it("Should differentiate between epoch and coherency 409 errors when epoch 409", async () => {
+        let success = true;
+        const cacheEntry1 = {
+            key: "key1",
+            type: "snapshot",
+        };
+        epochTracker.setEpoch("epoch1", true, "test");
+        await epochTracker.put(cacheEntry1, { val: "val1" });
+        // This will set the initial epoch value in epoch tracker.
+        await epochTracker.get(cacheEntry1);
+        try {
+            await mockFetchSingle(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "test"), async () => createResponse({ "x-fluid-epoch": "epoch2" }, undefined, 409));
+        }
+        catch (error) {
+            success = false;
+            assert.strictEqual(error.errorType, OdspErrorTypes.fileOverwrittenInStorage, "Error should be epoch error");
+        }
+        assert.strictEqual(success, false, "Fetching should not succeed!!");
+        assert((await epochTracker.get(cacheEntry1)) === undefined, "Entry in cache should be absent because it was epoch 409");
+    });
+    it("Check for resolved url on LocationRedirection error", async () => {
+        let success = true;
+        const newSiteUrl = "https://microsoft.sharepoint.com/siteUrl";
+        try {
+            await mockFetchSingle(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "test"), async () => createResponse({ "x-fluid-epoch": "epoch1" }, {
+                error: {
+                    "message": "locationMoved",
+                    "@error.redirectLocation": newSiteUrl,
+                },
+            }, 404));
+        }
+        catch (error) {
+            success = false;
+            assert.strictEqual(error.errorType, OdspErrorTypes.locationRedirection, "Error should be locationRedirection error");
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
+            const newResolvedUrl = error.redirectUrl;
+            assert.strictEqual(newResolvedUrl.siteUrl, newSiteUrl, "New site url should match");
+            assert.strictEqual(newResolvedUrl.driveId, driveId, "driveId should remain same");
+        }
+        assert.strictEqual(success, false, "Fetching should not succeed!!");
+    });
+    it("Checks throttling errors are non-retriable when disableRetriesOnStorageThrottlingError=true", async () => {
+        const retryAfterSeconds = 1;
+        let fetchStub;
+        const epochTrackerWithHostPolicy = new EpochTracker(localCache, {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        }, createChildLogger(), undefined, { disableRetriesOnStorageThrottlingError: true } /* hostPolicy */);
+        try {
+            // fetchHelper is used by epochTracker's fetch method, which we stub here to emulate throttling error
+            fetchStub = stub(odspUtilsModule, "fetchHelper");
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+            fetchStub.callsFake(async () => {
+                throw new ThrottlingError("Server is throttled", retryAfterSeconds, {
+                    testProp: "testProp",
+                    driverVersion: "1",
+                });
+            });
+            await epochTrackerWithHostPolicy.fetch("fetchUrl", {}, "test");
+        }
+        catch (error) {
+            // retoring the fetchHelper function to avoid causing errors in other tests
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+            fetchStub.restore();
+            assert(error.canRetry === false, "Error should be marked as non-retriable");
+            assert(
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access
+            error.retryAfterSeconds === retryAfterSeconds, "retryAfterSeconds should exist");
+        }
+    });
+    it("Checks throttling errors retriable when disableRetriesOnStorageThrottlingError=false", async () => {
+        let fetchStub;
+        const epochTrackerWithHostPolicy = new EpochTracker(localCache, {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        }, createChildLogger(), undefined, { disableRetriesOnStorageThrottlingError: false } /* hostPolicy */);
+        try {
+            // fetchHelper is used by epochTracker's fetch method, which we stub here to emulate throttling error
+            fetchStub = stub(odspUtilsModule, "fetchHelper");
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+            fetchStub.callsFake(async () => {
+                throw new ThrottlingError("Server is throttled", 1000, {
+                    testProp: "testProp",
+                    driverVersion: "1",
+                });
+            });
+            await epochTrackerWithHostPolicy.fetch("fetchUrl", {}, "test");
+        }
+        catch (error) {
+            // retoring the fetchHelper function to avoid causing errors in other tests
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+            fetchStub.restore();
+            assert(error.canRetry === true, "Error should be retriable");
+        }
+    });
+});
+//# sourceMappingURL=epochTests.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"epochTests.spec.js","sourceRoot":"","sources":["../../src/test/epochTests.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EACN,cAAc,EAId,sBAAsB,GACtB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,eAAe,EAA0B,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAwB,MAAM,iCAAiC,CAAC;AAC1F,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAA4B,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,eAAe,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE9E,MAAM,kBAAkB,GAAG,GAAyB,EAAE,CAAC,IAAI,oBAAoB,EAAE,CAAC;AAElF,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACxC,MAAM,OAAO,GAAG,6CAA6C,CAAC;IAC9D,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC;IACxB,IAAI,YAA0B,CAAC;IAC/B,IAAI,UAAgC,CAAC;IACrC,IAAI,gBAAwB,CAAC;IAC7B,MAAM,WAAW,GAAG;QACnB,OAAO;QACP,OAAO;QACP,MAAM;QACN,eAAe,EAAE,IAAI;KACU,CAAC;IAEjC,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACf,UAAU,GAAG,kBAAkB,EAAE,CAAC;QAClC,2CAA2C;QAC3C,YAAY,GAAG,IAAI,YAAY,CAC9B,UAAU,EACV;YACC,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,EACD,iBAAiB,EAAE,CACnB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACvE,4DAA4D;QAC5D,MAAM,QAAQ,GAGV,SAAS,CAAC;QAEd,MAAM,CAAC,sBAAsB,IAAI,QAAQ,EAAE,+CAA+C,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,WAAW,GAAgB;YAChC,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;SAC9C,CAAC;QACF,MAAM,WAAW,GAAgB,EAAE,GAAG,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QACjE,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAChE,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAChE,MAAM,MAAM,GAA6B;YACxC,KAAK,EAAE,WAAW;YAClB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,0BAA0B;SACnC,CAAC;QACF,MAAM,MAAM,GAAG;YACd,KAAK,EAAE,WAAW;YAClB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,sBAAsB;SAC/B,CAAC;QACF,MAAM,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1C,0DAA0D;QAC1D,MAAM,CACL,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,WAAW,EACrD,kCAAkC,CAClC,CAAC;QACF,6CAA6C;QAC7C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,uDAAuD;QACvD,MAAM,CACL,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,WAAW,EACrD,kCAAkC,CAClC,CAAC;QACF,MAAM,CAAC,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,SAAS,EAAE,0BAA0B,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QACjG,MAAM,WAAW,GAAgB;YAChC,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;SAC9C,CAAC;QACF,MAAM,WAAW,GAAgB,EAAE,GAAG,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QACjE,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAChE,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAChE,MAAM,MAAM,GAA6B;YACxC,KAAK,EAAE,WAAW;YAClB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,0BAA0B;SACnC,CAAC;QACF,MAAM,MAAM,GAA6B;YACxC,KAAK,EAAE,WAAW;YAClB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,0BAA0B;SACnC,CAAC;QACF,MAAM,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1C,0DAA0D;QAC1D,MAAM,CACL,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,WAAW,EACrD,kCAAkC,CAClC,CAAC;QACF,6CAA6C;QAC7C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,uDAAuD;QACvD,MAAM,CACL,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,WAAW,EACrD,kCAAkC,CAClC,CAAC;QACF,MAAM,CAAC,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,SAAS,EAAE,0BAA0B,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACvE,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI;YACH,MAAM,WAAW,CAChB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EAC3D,EAAE,EACF,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;SACF;QAAC,OAAO,KAAc,EAAE;YACxB,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,wBAAwB,EACvC,6BAA6B,CAC7B,CAAC;SACF;QACD,MAAM,CACL,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,SAAS,EACnD,kCAAkC,CAClC,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,wBAAwB,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC/E,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI;YACH,MAAM,WAAW,CAChB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EACpE,EAAE,EACF,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;SACF;QAAC,OAAO,KAAc,EAAE;YACxB,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,wBAAwB,EACvC,6BAA6B,CAC7B,CAAC;SACF;QACD,MAAM,CACL,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,SAAS,EACnD,kCAAkC,CAClC,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,wBAAwB,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC/E,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI;YACH,MAAM,WAAW,CAChB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EACpE,EAAE,EACF,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;YACF,8DAA8D;SAC9D;QAAC,OAAO,KAAU,EAAE;YACpB,OAAO,GAAG,KAAK,CAAC;YAChB,sEAAsE;YACtE,MAAM,CAAC,KAAK,CAAC,mBAAmB,KAAK,SAAS,EAAE,iCAAiC,CAAC,CAAC;SACnF;QACD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,wBAAwB,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,MAAM,WAAW,CACjC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EACpE,EAAE,EACF,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,MAAM,CACL,QAAQ,CAAC,UAAU,CAAC,mBAAmB,KAAK,SAAS,EACrD,iCAAiC,CACjC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAChF,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI;YACH,MAAM,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;SAC/E;QAAC,MAAM;YACP,OAAO,GAAG,KAAK,CAAC;SAChB;QACD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW;QACjB,0GAA0G;QAC1G,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,EACzC,MAAM,EACN,kCAAkC,CAClC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC7E,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI;YACH,MAAM,WAAW,CAChB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EACpE,EAAE,EACF,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;SACF;QAAC,MAAM;YACP,OAAO,GAAG,KAAK,CAAC;SAChB;QACD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW;QACjB,0GAA0G;QAC1G,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,EACzC,MAAM,EACN,kCAAkC,CAClC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,KAAK,IAAI,EAAE;QAC/F,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI;YACH,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EACpE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC,CACzE,CAAC;SACF;QAAC,OAAO,KAAc,EAAE;YACxB,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,eAAe,EAC9B,kCAAkC,CAClC,CAAC;SACF;QACD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,+BAA+B,CAAC,CAAC;QACpE,MAAM,CAAC,WAAW;QACjB,0GAA0G;QAC1G,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,EACzC,MAAM,EACN,+DAA+D,CAC/D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;QAC3F,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAW;YAC3B,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,UAAU;SAChB,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,0DAA0D;QAC1D,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI;YACH,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EACpE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC,CACzE,CAAC;SACF;QAAC,OAAO,KAAc,EAAE;YACxB,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,wBAAwB,EACvC,6BAA6B,CAC7B,CAAC;SACF;QACD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,+BAA+B,CAAC,CAAC;QACpE,MAAM,CACL,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,SAAS,EACnD,0DAA0D,CAC1D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACpE,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,MAAM,UAAU,GAAG,0CAA0C,CAAC;QAC9D,IAAI;YACH,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,EACpE,KAAK,IAAI,EAAE,CACV,cAAc,CACb,EAAE,eAAe,EAAE,QAAQ,EAAE,EAC7B;gBACC,KAAK,EAAE;oBACN,SAAS,EAAE,eAAe;oBAC1B,yBAAyB,EAAE,UAAU;iBACrC;aACD,EACD,GAAG,CACH,CACF,CAAC;SACF;QAAC,OAAO,KAAc,EAAE;YACxB,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,mBAAmB,EAClC,2CAA2C,CAC3C,CAAC;YACF,mJAAmJ;YACnJ,MAAM,cAAc,GAAsB,KAAa,CAAC,WAAW,CAAC;YACpE,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,2BAA2B,CAAC,CAAC;YACpF,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC;SAClF;QACD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,+BAA+B,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6FAA6F,EAAE,KAAK,IAAI,EAAE;QAC5G,MAAM,iBAAiB,GAAG,CAAC,CAAC;QAC5B,IAAI,SAAS,CAAC;QACd,MAAM,0BAA0B,GAAG,IAAI,YAAY,CAClD,UAAU,EACV;YACC,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,EACD,iBAAiB,EAAE,EACnB,SAAS,EACT,EAAE,sCAAsC,EAAE,IAAI,EAAE,CAAC,gBAAgB,CACjE,CAAC;QACF,IAAI;YACH,qGAAqG;YACrG,SAAS,GAAG,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;YACjD,yGAAyG;YACzG,SAAS,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;gBAC9B,MAAM,IAAI,eAAe,CAAC,qBAAqB,EAAE,iBAAiB,EAAE;oBACnE,QAAQ,EAAE,UAAU;oBACpB,aAAa,EAAE,GAAG;iBAClB,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,MAAM,0BAA0B,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SAC/D;QAAC,OAAO,KAAK,EAAE;YACf,2EAA2E;YAC3E,yGAAyG;YACzG,SAAS,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CACJ,KAAmC,CAAC,QAAQ,KAAK,KAAK,EACvD,yCAAyC,CACzC,CAAC;YACF,MAAM;YACL,0GAA0G;YACzG,KAAa,CAAC,iBAAiB,KAAK,iBAAiB,EACtD,gCAAgC,CAChC,CAAC;SACF;IACF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QACrG,IAAI,SAAS,CAAC;QACd,MAAM,0BAA0B,GAAG,IAAI,YAAY,CAClD,UAAU,EACV;YACC,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,EACD,iBAAiB,EAAE,EACnB,SAAS,EACT,EAAE,sCAAsC,EAAE,KAAK,EAAE,CAAC,gBAAgB,CAClE,CAAC;QACF,IAAI;YACH,qGAAqG;YACrG,SAAS,GAAG,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;YACjD,yGAAyG;YACzG,SAAS,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;gBAC9B,MAAM,IAAI,eAAe,CAAC,qBAAqB,EAAE,IAAI,EAAE;oBACtD,QAAQ,EAAE,UAAU;oBACpB,aAAa,EAAE,GAAG;iBAClB,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,MAAM,0BAA0B,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SAC/D;QAAC,OAAO,KAAK,EAAE;YACf,2EAA2E;YAC3E,yGAAyG;YACzG,SAAS,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAE,KAAyB,CAAC,QAAQ,KAAK,IAAI,EAAE,2BAA2B,CAAC,CAAC;SAClF;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 \"node:assert\";\nimport { IDocumentStorageServicePolicies } from \"@fluidframework/driver-definitions\";\nimport {\n\tOdspErrorTypes,\n\tIOdspResolvedUrl,\n\tICacheEntry,\n\tIEntry,\n\tmaximumCacheDurationMs,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { ThrottlingError, type NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { createChildLogger, type IFluidErrorBase } from \"@fluidframework/telemetry-utils\";\nimport { stub } from \"sinon\";\nimport { IVersionedValueWithEpoch, persistedCacheValueVersion } from \"../contracts.js\";\nimport { EpochTracker } from \"../epochTracker.js\";\nimport { LocalPersistentCache } from \"../odspCache.js\";\nimport { getHashedDocumentId } from \"../odspPublicUtils.js\";\nimport * as odspUtilsModule from \"../odspUtils.js\";\nimport { mockFetchOk, mockFetchSingle, createResponse } from \"./mockFetch.js\";\n\nconst createUtLocalCache = (): LocalPersistentCache => new LocalPersistentCache();\n\ndescribe(\"Tests for Epoch Tracker\", () => {\n\tconst siteUrl = \"https://microsoft.sharepoint-df.com/siteUrl\";\n\tconst driveId = \"driveId\";\n\tconst itemId = \"itemId\";\n\tlet epochTracker: EpochTracker;\n\tlet localCache: LocalPersistentCache;\n\tlet hashedDocumentId: string;\n\tconst resolvedUrl = {\n\t\tsiteUrl,\n\t\tdriveId,\n\t\titemId,\n\t\todspResolvedUrl: true,\n\t} as unknown as IOdspResolvedUrl;\n\n\tbefore(async () => {\n\t\thashedDocumentId = await getHashedDocumentId(driveId, itemId);\n\t});\n\n\tbeforeEach(() => {\n\t\tlocalCache = createUtLocalCache();\n\t\t// use null logger here as we expect errors\n\t\tepochTracker = new EpochTracker(\n\t\t\tlocalCache,\n\t\t\t{\n\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\tresolvedUrl,\n\t\t\t},\n\t\t\tcreateChildLogger(),\n\t\t);\n\t});\n\n\tafterEach(async () => {\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tit(\"defaultCacheExpiryTimeoutMs <= maximumCacheDurationMs policy\", () => {\n\t\t// This is the maximum allowed value per the policy - 5 days\n\t\tconst expected: Exclude<\n\t\t\tIDocumentStorageServicePolicies[\"maximumCacheDurationMs\"],\n\t\t\tundefined\n\t\t> = 432000000;\n\n\t\tassert(maximumCacheDurationMs <= expected, \"Actual cache expiry used must meet the policy\");\n\t});\n\n\tit(\"Cache, old versions\", async () => {\n\t\tconst cacheEntry1: ICacheEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t};\n\t\tconst cacheEntry2: ICacheEntry = { ...cacheEntry1, key: \"key2\" };\n\t\tconst cacheValue1 = { val: \"val1\", cacheEntryTime: Date.now() };\n\t\tconst cacheValue2 = { val: \"val2\", cacheEntryTime: Date.now() };\n\t\tconst value1: IVersionedValueWithEpoch = {\n\t\t\tvalue: cacheValue1,\n\t\t\tfluidEpoch: \"epoch1\",\n\t\t\tversion: persistedCacheValueVersion,\n\t\t};\n\t\tconst value2 = {\n\t\t\tvalue: cacheValue2,\n\t\t\tfluidEpoch: \"epoch1\",\n\t\t\tversion: \"non-existing version\",\n\t\t};\n\t\tawait localCache.put(cacheEntry1, value1);\n\t\tawait localCache.put(cacheEntry2, value2);\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tassert(\n\t\t\t(await epochTracker.get(cacheEntry1)) === cacheValue1,\n\t\t\t\"Entry 1 should continue to exist\",\n\t\t);\n\t\t// This should not fail, just return nothing!\n\t\tawait epochTracker.get(cacheEntry2);\n\t\t// Make sure nothing changed as result of reading data.\n\t\tassert(\n\t\t\t(await epochTracker.get(cacheEntry1)) === cacheValue1,\n\t\t\t\"Entry 1 should continue to exist\",\n\t\t);\n\t\tassert((await epochTracker.get(cacheEntry2)) === undefined, \"Entry 2 should not exist\");\n\t});\n\n\tit(\"Epoch error when fetch error from cache should throw epoch error and clear cache\", async () => {\n\t\tconst cacheEntry1: ICacheEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t};\n\t\tconst cacheEntry2: ICacheEntry = { ...cacheEntry1, key: \"key2\" };\n\t\tconst cacheValue1 = { val: \"val1\", cacheEntryTime: Date.now() };\n\t\tconst cacheValue2 = { val: \"val2\", cacheEntryTime: Date.now() };\n\t\tconst value1: IVersionedValueWithEpoch = {\n\t\t\tvalue: cacheValue1,\n\t\t\tfluidEpoch: \"epoch1\",\n\t\t\tversion: persistedCacheValueVersion,\n\t\t};\n\t\tconst value2: IVersionedValueWithEpoch = {\n\t\t\tvalue: cacheValue2,\n\t\t\tfluidEpoch: \"epoch2\",\n\t\t\tversion: persistedCacheValueVersion,\n\t\t};\n\t\tawait localCache.put(cacheEntry1, value1);\n\t\tawait localCache.put(cacheEntry2, value2);\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tassert(\n\t\t\t(await epochTracker.get(cacheEntry1)) === cacheValue1,\n\t\t\t\"Entry 1 should continue to exist\",\n\t\t);\n\t\t// This should not fail, just return nothing!\n\t\tawait epochTracker.get(cacheEntry2);\n\t\t// Make sure nothing changed as result of reading data.\n\t\tassert(\n\t\t\t(await epochTracker.get(cacheEntry1)) === cacheValue1,\n\t\t\t\"Entry 1 should continue to exist\",\n\t\t);\n\t\tassert((await epochTracker.get(cacheEntry2)) === undefined, \"Entry 2 should not exist\");\n\t});\n\n\tit(\"Epoch error when fetch response and should clear cache\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\ttry {\n\t\t\tawait mockFetchOk(\n\t\t\t\tasync () => epochTracker.fetchArray(\"fetchUrl\", {}, \"test\"),\n\t\t\t\t{},\n\t\t\t\t{ \"x-fluid-epoch\": \"epoch2\" },\n\t\t\t);\n\t\t} catch (error: unknown) {\n\t\t\tsuccess = false;\n\t\t\tassert.strictEqual(\n\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\tOdspErrorTypes.fileOverwrittenInStorage,\n\t\t\t\t\"Error should be epoch error\",\n\t\t\t);\n\t\t}\n\t\tassert(\n\t\t\t(await epochTracker.get(cacheEntry1)) === undefined,\n\t\t\t\"Entry in cache should be cleared\",\n\t\t);\n\t\tassert.strictEqual(success, false, \"Fetching should fail!!\");\n\t});\n\n\tit(\"Epoch error when fetch response as json and should clear cache\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\ttry {\n\t\t\tawait mockFetchOk(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"test\"),\n\t\t\t\t{},\n\t\t\t\t{ \"x-fluid-epoch\": \"epoch2\" },\n\t\t\t);\n\t\t} catch (error: unknown) {\n\t\t\tsuccess = false;\n\t\t\tassert.strictEqual(\n\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\tOdspErrorTypes.fileOverwrittenInStorage,\n\t\t\t\t\"Error should be epoch error\",\n\t\t\t);\n\t\t}\n\t\tassert(\n\t\t\t(await epochTracker.get(cacheEntry1)) === undefined,\n\t\t\t\"Entry in cache should be cleared\",\n\t\t);\n\t\tassert.strictEqual(success, false, \"Fetching should fail!!\");\n\t});\n\n\tit(\"Check client correlationID on error in unsuccessful fetch case\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\ttry {\n\t\t\tawait mockFetchOk(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"test\"),\n\t\t\t\t{},\n\t\t\t\t{ \"x-fluid-epoch\": \"epoch2\" },\n\t\t\t);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t} catch (error: any) {\n\t\t\tsuccess = false;\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\tassert(error.XRequestStatsHeader !== undefined, \"CorrelationId should be present\");\n\t\t}\n\t\tassert.strictEqual(success, false, \"Fetching should fail!!\");\n\t});\n\n\tit(\"Check client correlationID on spoCommonHeaders in successful fetch case\", async () => {\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\tconst response = await mockFetchOk(\n\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"test\"),\n\t\t\t{},\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\tassert(\n\t\t\tresponse.propsToLog.XRequestStatsHeader !== undefined,\n\t\t\t\"CorrelationId should be present\",\n\t\t);\n\t});\n\n\tit(\"Epoch error should not occur if response does not contain epoch\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\ttry {\n\t\t\tawait mockFetchOk(async () => epochTracker.fetchArray(\"fetchUrl\", {}, \"test\"));\n\t\t} catch {\n\t\t\tsuccess = false;\n\t\t}\n\t\tassert.strictEqual(success, true, \"Fetching should succeed!!\");\n\t\tassert.strictEqual(\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, unicorn/no-await-expression-member\n\t\t\t(await epochTracker.get(cacheEntry1)).val,\n\t\t\t\"val1\",\n\t\t\t\"Entry in cache should be present\",\n\t\t);\n\t});\n\n\tit(\"Epoch error should not occur if response contains same epoch\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\ttry {\n\t\t\tawait mockFetchOk(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"test\"),\n\t\t\t\t{},\n\t\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t\t);\n\t\t} catch {\n\t\t\tsuccess = false;\n\t\t}\n\t\tassert.strictEqual(success, true, \"Fetching should succeed!!\");\n\t\tassert.strictEqual(\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, unicorn/no-await-expression-member\n\t\t\t(await epochTracker.get(cacheEntry1)).val,\n\t\t\t\"val1\",\n\t\t\t\"Entry in cache should be present\",\n\t\t);\n\t});\n\n\tit(\"Should differentiate between epoch and coherency 409 errors when coherency 409\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\ttry {\n\t\t\tawait mockFetchSingle(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"test\"),\n\t\t\t\tasync () => createResponse({ \"x-fluid-epoch\": \"epoch1\" }, undefined, 409),\n\t\t\t);\n\t\t} catch (error: unknown) {\n\t\t\tsuccess = false;\n\t\t\tassert.strictEqual(\n\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\tOdspErrorTypes.throttlingError,\n\t\t\t\t\"Error should be throttling error\",\n\t\t\t);\n\t\t}\n\t\tassert.strictEqual(success, false, \"Fetching should not succeed!!\");\n\t\tassert.strictEqual(\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, unicorn/no-await-expression-member\n\t\t\t(await epochTracker.get(cacheEntry1)).val,\n\t\t\t\"val1\",\n\t\t\t\"Entry in cache should be present because it was not epoch 409\",\n\t\t);\n\t});\n\n\tit(\"Should differentiate between epoch and coherency 409 errors when epoch 409\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst cacheEntry1: IEntry = {\n\t\t\tkey: \"key1\",\n\t\t\ttype: \"snapshot\",\n\t\t};\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\t\t// This will set the initial epoch value in epoch tracker.\n\t\tawait epochTracker.get(cacheEntry1);\n\t\ttry {\n\t\t\tawait mockFetchSingle(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"test\"),\n\t\t\t\tasync () => createResponse({ \"x-fluid-epoch\": \"epoch2\" }, undefined, 409),\n\t\t\t);\n\t\t} catch (error: unknown) {\n\t\t\tsuccess = false;\n\t\t\tassert.strictEqual(\n\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\tOdspErrorTypes.fileOverwrittenInStorage,\n\t\t\t\t\"Error should be epoch error\",\n\t\t\t);\n\t\t}\n\t\tassert.strictEqual(success, false, \"Fetching should not succeed!!\");\n\t\tassert(\n\t\t\t(await epochTracker.get(cacheEntry1)) === undefined,\n\t\t\t\"Entry in cache should be absent because it was epoch 409\",\n\t\t);\n\t});\n\n\tit(\"Check for resolved url on LocationRedirection error\", async () => {\n\t\tlet success: boolean = true;\n\t\tconst newSiteUrl = \"https://microsoft.sharepoint.com/siteUrl\";\n\t\ttry {\n\t\t\tawait mockFetchSingle(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"test\"),\n\t\t\t\tasync () =>\n\t\t\t\t\tcreateResponse(\n\t\t\t\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\terror: {\n\t\t\t\t\t\t\t\t\"message\": \"locationMoved\",\n\t\t\t\t\t\t\t\t\"@error.redirectLocation\": newSiteUrl,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t404,\n\t\t\t\t\t),\n\t\t\t);\n\t\t} catch (error: unknown) {\n\t\t\tsuccess = false;\n\t\t\tassert.strictEqual(\n\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\tOdspErrorTypes.locationRedirection,\n\t\t\t\t\"Error should be locationRedirection error\",\n\t\t\t);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any\n\t\t\tconst newResolvedUrl: IOdspResolvedUrl = (error as any).redirectUrl;\n\t\t\tassert.strictEqual(newResolvedUrl.siteUrl, newSiteUrl, \"New site url should match\");\n\t\t\tassert.strictEqual(newResolvedUrl.driveId, driveId, \"driveId should remain same\");\n\t\t}\n\t\tassert.strictEqual(success, false, \"Fetching should not succeed!!\");\n\t});\n\n\tit(\"Checks throttling errors are non-retriable when disableRetriesOnStorageThrottlingError=true\", async () => {\n\t\tconst retryAfterSeconds = 1;\n\t\tlet fetchStub;\n\t\tconst epochTrackerWithHostPolicy = new EpochTracker(\n\t\t\tlocalCache,\n\t\t\t{\n\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\tresolvedUrl,\n\t\t\t},\n\t\t\tcreateChildLogger(),\n\t\t\tundefined,\n\t\t\t{ disableRetriesOnStorageThrottlingError: true } /* hostPolicy */,\n\t\t);\n\t\ttry {\n\t\t\t// fetchHelper is used by epochTracker's fetch method, which we stub here to emulate throttling error\n\t\t\tfetchStub = stub(odspUtilsModule, \"fetchHelper\");\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access\n\t\t\tfetchStub.callsFake(async () => {\n\t\t\t\tthrow new ThrottlingError(\"Server is throttled\", retryAfterSeconds, {\n\t\t\t\t\ttestProp: \"testProp\",\n\t\t\t\t\tdriverVersion: \"1\",\n\t\t\t\t});\n\t\t\t});\n\t\t\tawait epochTrackerWithHostPolicy.fetch(\"fetchUrl\", {}, \"test\");\n\t\t} catch (error) {\n\t\t\t// retoring the fetchHelper function to avoid causing errors in other tests\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access\n\t\t\tfetchStub.restore();\n\t\t\tassert(\n\t\t\t\t(error as NonRetryableError<string>).canRetry === false,\n\t\t\t\t\"Error should be marked as non-retriable\",\n\t\t\t);\n\t\t\tassert(\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access\n\t\t\t\t(error as any).retryAfterSeconds === retryAfterSeconds,\n\t\t\t\t\"retryAfterSeconds should exist\",\n\t\t\t);\n\t\t}\n\t});\n\n\tit(\"Checks throttling errors retriable when disableRetriesOnStorageThrottlingError=false\", async () => {\n\t\tlet fetchStub;\n\t\tconst epochTrackerWithHostPolicy = new EpochTracker(\n\t\t\tlocalCache,\n\t\t\t{\n\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\tresolvedUrl,\n\t\t\t},\n\t\t\tcreateChildLogger(),\n\t\t\tundefined,\n\t\t\t{ disableRetriesOnStorageThrottlingError: false } /* hostPolicy */,\n\t\t);\n\t\ttry {\n\t\t\t// fetchHelper is used by epochTracker's fetch method, which we stub here to emulate throttling error\n\t\t\tfetchStub = stub(odspUtilsModule, \"fetchHelper\");\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access\n\t\t\tfetchStub.callsFake(async () => {\n\t\t\t\tthrow new ThrottlingError(\"Server is throttled\", 1000, {\n\t\t\t\t\ttestProp: \"testProp\",\n\t\t\t\t\tdriverVersion: \"1\",\n\t\t\t\t});\n\t\t\t});\n\t\t\tawait epochTrackerWithHostPolicy.fetch(\"fetchUrl\", {}, \"test\");\n\t\t} catch (error) {\n\t\t\t// retoring the fetchHelper function to avoid causing errors in other tests\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access\n\t\t\tfetchStub.restore();\n\t\t\tassert((error as ThrottlingError).canRetry === true, \"Error should be retriable\");\n\t\t}\n\t});\n});\n"]}

package/lib/test/epochTestsWithRedemption.spec.js

@@ -0,0 +1,119 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { Deferred } from "@fluidframework/core-utils";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { OdspErrorTypes, snapshotKey, } from "@fluidframework/odsp-driver-definitions";
+import { EpochTrackerWithRedemption } from "../epochTracker.js";
+import { LocalPersistentCache } from "../odspCache.js";
+import { getHashedDocumentId } from "../odspPublicUtils.js";
+import { mockFetchSingle, mockFetchMultiple, okResponse, notFound, } from "./mockFetch.js";
+class DeferralWithCallback extends Deferred {
+    constructor() {
+        super();
+        this.epochCallback = async () => { };
+    }
+    setCallback(epochCallback) {
+        this.epochCallback = epochCallback;
+    }
+    get promise() {
+        // eslint-disable-next-line @typescript-eslint/promise-function-async
+        return this.epochCallback().then(() => super.promise);
+    }
+}
+describe("Tests for Epoch Tracker With Redemption", () => {
+    const siteUrl = "https://microsoft.sharepoint-df.com/siteUrl";
+    const driveId = "driveId";
+    const itemId = "itemId";
+    const logger = new MockLogger();
+    let epochTracker;
+    let hashedDocumentId;
+    let epochCallback;
+    before(async () => {
+        hashedDocumentId = await getHashedDocumentId(driveId, itemId);
+    });
+    beforeEach(() => {
+        const resolvedUrl = {
+            siteUrl,
+            driveId,
+            itemId,
+            odspResolvedUrl: true,
+        };
+        epochTracker = new EpochTrackerWithRedemption(new LocalPersistentCache(), {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        }, logger.toTelemetryLogger());
+    });
+    afterEach(async () => {
+        await epochTracker.removeEntries().catch(() => { });
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+    describe("Test Suite 1", () => {
+        beforeEach(() => {
+            epochCallback = new DeferralWithCallback();
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
+            epochTracker.treesLatestDeferral = epochCallback;
+        });
+        it("joinSession call should succeed on retrying after snapshot cached read succeeds", async () => {
+            epochTracker.setEpoch("epoch1", true, "test");
+            const cacheEntry1 = {
+                type: snapshotKey,
+                key: "key1",
+            };
+            await epochTracker.put(cacheEntry1, { val: "val1" });
+            // We will trigger a successful call to return the value set in the cache after the failed joinSession call
+            epochCallback.setCallback(async () => epochTracker.get(cacheEntry1));
+            // Initial joinSession call will return 404 but after the timeout, the call will be retried and succeed
+            await mockFetchMultiple(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "joinSession"), [
+                notFound,
+                async () => okResponse({ "x-fluid-epoch": "epoch1" }, {}),
+            ]);
+        });
+        it("joinSession call should succeed on retrying after any network call to the file succeeds", async () => {
+            epochTracker.setEpoch("epoch1", true, "test");
+            const cacheEntry1 = {
+                type: snapshotKey,
+                key: "key1",
+            };
+            await epochTracker.put(cacheEntry1, { val: "val1" });
+            // We will trigger a successful call to return the value set in the cache after the failed joinSession call
+            epochCallback.setCallback(async () => {
+                return epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "treesLatest");
+            });
+            // Initial joinSession call will return 404 but after the timeout, the call will be retried and succeed
+            await mockFetchMultiple(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "joinSession"), [
+                notFound,
+                async () => okResponse({ "x-fluid-epoch": "epoch1" }, {}),
+                async () => okResponse({ "x-fluid-epoch": "epoch1" }, {}), // "joinSession"
+            ]);
+        });
+        it("Requests should fail if joinSession call fails and the getLatest call also fails", async () => {
+            let success = true;
+            try {
+                epochCallback.setCallback(async () => {
+                    try {
+                        await mockFetchSingle(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "treesLatest"), notFound, "internal");
+                    }
+                    catch (error) {
+                        assert.strictEqual(error.errorType, OdspErrorTypes.fileNotFoundOrAccessDeniedError, "Error should be file not found or access denied error");
+                    }
+                });
+                await mockFetchSingle(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "joinSession"), async () => notFound({ "x-fluid-epoch": "epoch1" }), "external");
+            }
+            catch (error) {
+                success = false;
+                assert.strictEqual(error.errorType, OdspErrorTypes.fileNotFoundOrAccessDeniedError, "Error should be file not found or access denied error");
+            }
+            assert.strictEqual(success, false, "Join session should fail if treesLatest call has failed");
+        });
+    });
+    describe("Tests Suite 2", () => {
+        it("Failed treesLatest call should not trigger unhandled rejection event", async () => {
+            const treesLatestP = mockFetchSingle(async () => epochTracker.fetchAndParseAsJSON("fetchUrl", {}, "treesLatest"), notFound);
+            await assert.rejects(treesLatestP, "should fail without causing an unhandledRejection event.");
+        });
+    });
+});
+//# sourceMappingURL=epochTestsWithRedemption.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"epochTestsWithRedemption.spec.js","sourceRoot":"","sources":["../../src/test/epochTestsWithRedemption.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAwB,MAAM,iCAAiC,CAAC;AACnF,OAAO,EACN,cAAc,EAGd,WAAW,GACX,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EACN,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,QAAQ,GAER,MAAM,gBAAgB,CAAC;AAExB,MAAM,oBAAqB,SAAQ,QAAc;IAGhD;QACC,KAAK,EAAE,CAAC;QAHD,kBAAa,GAA2B,KAAK,IAAI,EAAE,GAAE,CAAC,CAAC;IAI/D,CAAC;IAEM,WAAW,CAAC,aAAqC;QACvD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACpC,CAAC;IAED,IAAW,OAAO;QACjB,qEAAqE;QACrE,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;CACD;AAED,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;IACxD,MAAM,OAAO,GAAG,6CAA6C,CAAC;IAC9D,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC;IACxB,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;IAChC,IAAI,YAAwC,CAAC;IAC7C,IAAI,gBAAwB,CAAC;IAC7B,IAAI,aAAmC,CAAC;IAExC,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACf,MAAM,WAAW,GAAG;YACnB,OAAO;YACP,OAAO;YACP,MAAM;YACN,eAAe,EAAE,IAAI;SACU,CAAC;QACjC,YAAY,GAAG,IAAI,0BAA0B,CAC5C,IAAI,oBAAoB,EAAE,EAC1B;YACC,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,EACD,MAAM,CAAC,iBAAiB,EAAE,CAC1B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,GAAG,EAAE;YACf,aAAa,GAAG,IAAI,oBAAoB,EAAE,CAAC;YAC3C,0GAA0G;YACzG,YAAoB,CAAC,mBAAmB,GAAG,aAAa,CAAC;QAC3D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;YAChG,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,MAAM,WAAW,GAAW;gBAC3B,IAAI,EAAE,WAAW;gBACjB,GAAG,EAAE,MAAM;aACX,CAAC;YACF,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;YAErD,2GAA2G;YAC3G,aAAa,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;YAErE,uGAAuG;YACvG,MAAM,iBAAiB,CACtB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,CAAC,EAC3E;gBACC,QAAQ;gBACR,KAAK,IAA2B,EAAE,CACjC,UAAU,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;aAC9C,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yFAAyF,EAAE,KAAK,IAAI,EAAE;YACxG,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,MAAM,WAAW,GAAW;gBAC3B,IAAI,EAAE,WAAW;gBACjB,GAAG,EAAE,MAAM;aACX,CAAC;YACF,MAAM,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;YAErD,2GAA2G;YAC3G,aAAa,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;gBACpC,OAAO,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;YACxE,CAAC,CAAC,CAAC;YAEH,uGAAuG;YACvG,MAAM,iBAAiB,CACtB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,CAAC,EAC3E;gBACC,QAAQ;gBACR,KAAK,IAA2B,EAAE,CACjC,UAAU,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;gBAC9C,KAAK,IAA2B,EAAE,CACjC,UAAU,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,EAAE,gBAAgB;aAChE,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;YACjG,IAAI,OAAO,GAAY,IAAI,CAAC;YAE5B,IAAI;gBACH,aAAa,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;oBACpC,IAAI;wBACH,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CACV,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,CAAC,EAChE,QAAQ,EACR,UAAU,CACV,CAAC;qBACF;oBAAC,OAAO,KAAc,EAAE;wBACxB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,+BAA+B,EAC9C,uDAAuD,CACvD,CAAC;qBACF;gBACF,CAAC,CAAC,CAAC;gBACH,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,CAAC,EAC3E,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,EACnD,UAAU,CACV,CAAC;aACF;YAAC,OAAO,KAAc,EAAE;gBACxB,OAAO,GAAG,KAAK,CAAC;gBAChB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,+BAA+B,EAC9C,uDAAuD,CACvD,CAAC;aACF;YACD,MAAM,CAAC,WAAW,CACjB,OAAO,EACP,KAAK,EACL,yDAAyD,CACzD,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,YAAY,GAAG,eAAe,CACnC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,CAAC,EAC3E,QAAQ,CACR,CAAC;YACF,MAAM,MAAM,CAAC,OAAO,CACnB,YAAY,EACZ,0DAA0D,CAC1D,CAAC;QACH,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 { strict as assert } from \"node:assert\";\nimport { Deferred } from \"@fluidframework/core-utils\";\nimport { MockLogger, type IFluidErrorBase } from \"@fluidframework/telemetry-utils\";\nimport {\n\tOdspErrorTypes,\n\tIOdspResolvedUrl,\n\tIEntry,\n\tsnapshotKey,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { EpochTrackerWithRedemption } from \"../epochTracker.js\";\nimport { LocalPersistentCache } from \"../odspCache.js\";\nimport { getHashedDocumentId } from \"../odspPublicUtils.js\";\nimport {\n\tmockFetchSingle,\n\tmockFetchMultiple,\n\tokResponse,\n\tnotFound,\n\tMockResponse,\n} from \"./mockFetch.js\";\n\nclass DeferralWithCallback extends Deferred<void> {\n\tprivate epochCallback: () => Promise<unknown> = async () => {};\n\n\tconstructor() {\n\t\tsuper();\n\t}\n\n\tpublic setCallback(epochCallback: () => Promise<unknown>): void {\n\t\tthis.epochCallback = epochCallback;\n\t}\n\n\tpublic get promise(): Promise<void> {\n\t\t// eslint-disable-next-line @typescript-eslint/promise-function-async\n\t\treturn this.epochCallback().then(() => super.promise);\n\t}\n}\n\ndescribe(\"Tests for Epoch Tracker With Redemption\", () => {\n\tconst siteUrl = \"https://microsoft.sharepoint-df.com/siteUrl\";\n\tconst driveId = \"driveId\";\n\tconst itemId = \"itemId\";\n\tconst logger = new MockLogger();\n\tlet epochTracker: EpochTrackerWithRedemption;\n\tlet hashedDocumentId: string;\n\tlet epochCallback: DeferralWithCallback;\n\n\tbefore(async () => {\n\t\thashedDocumentId = await getHashedDocumentId(driveId, itemId);\n\t});\n\n\tbeforeEach(() => {\n\t\tconst resolvedUrl = {\n\t\t\tsiteUrl,\n\t\t\tdriveId,\n\t\t\titemId,\n\t\t\todspResolvedUrl: true,\n\t\t} as unknown as IOdspResolvedUrl;\n\t\tepochTracker = new EpochTrackerWithRedemption(\n\t\t\tnew LocalPersistentCache(),\n\t\t\t{\n\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\tresolvedUrl,\n\t\t\t},\n\t\t\tlogger.toTelemetryLogger(),\n\t\t);\n\t});\n\n\tafterEach(async () => {\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t});\n\n\tdescribe(\"Test Suite 1\", () => {\n\t\tbeforeEach(() => {\n\t\t\tepochCallback = new DeferralWithCallback();\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any\n\t\t\t(epochTracker as any).treesLatestDeferral = epochCallback;\n\t\t});\n\t\tit(\"joinSession call should succeed on retrying after snapshot cached read succeeds\", async () => {\n\t\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\t\tconst cacheEntry1: IEntry = {\n\t\t\t\ttype: snapshotKey,\n\t\t\t\tkey: \"key1\",\n\t\t\t};\n\t\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\n\t\t\t// We will trigger a successful call to return the value set in the cache after the failed joinSession call\n\t\t\tepochCallback.setCallback(async () => epochTracker.get(cacheEntry1));\n\n\t\t\t// Initial joinSession call will return 404 but after the timeout, the call will be retried and succeed\n\t\t\tawait mockFetchMultiple(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"joinSession\"),\n\t\t\t\t[\n\t\t\t\t\tnotFound,\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tokResponse({ \"x-fluid-epoch\": \"epoch1\" }, {}),\n\t\t\t\t],\n\t\t\t);\n\t\t});\n\n\t\tit(\"joinSession call should succeed on retrying after any network call to the file succeeds\", async () => {\n\t\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\t\tconst cacheEntry1: IEntry = {\n\t\t\t\ttype: snapshotKey,\n\t\t\t\tkey: \"key1\",\n\t\t\t};\n\t\t\tawait epochTracker.put(cacheEntry1, { val: \"val1\" });\n\n\t\t\t// We will trigger a successful call to return the value set in the cache after the failed joinSession call\n\t\t\tepochCallback.setCallback(async () => {\n\t\t\t\treturn epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"treesLatest\");\n\t\t\t});\n\n\t\t\t// Initial joinSession call will return 404 but after the timeout, the call will be retried and succeed\n\t\t\tawait mockFetchMultiple(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"joinSession\"),\n\t\t\t\t[\n\t\t\t\t\tnotFound, // joinSession\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tokResponse({ \"x-fluid-epoch\": \"epoch1\" }, {}), // \"treesLatest\"\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tokResponse({ \"x-fluid-epoch\": \"epoch1\" }, {}), // \"joinSession\"\n\t\t\t\t],\n\t\t\t);\n\t\t});\n\n\t\tit(\"Requests should fail if joinSession call fails and the getLatest call also fails\", async () => {\n\t\t\tlet success: boolean = true;\n\n\t\t\ttry {\n\t\t\t\tepochCallback.setCallback(async () => {\n\t\t\t\t\ttry {\n\t\t\t\t\t\tawait mockFetchSingle(\n\t\t\t\t\t\t\tasync () =>\n\t\t\t\t\t\t\t\tepochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"treesLatest\"),\n\t\t\t\t\t\t\tnotFound,\n\t\t\t\t\t\t\t\"internal\",\n\t\t\t\t\t\t);\n\t\t\t\t\t} catch (error: unknown) {\n\t\t\t\t\t\tassert.strictEqual(\n\t\t\t\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\t\t\t\tOdspErrorTypes.fileNotFoundOrAccessDeniedError,\n\t\t\t\t\t\t\t\"Error should be file not found or access denied error\",\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\tawait mockFetchSingle(\n\t\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"joinSession\"),\n\t\t\t\t\tasync () => notFound({ \"x-fluid-epoch\": \"epoch1\" }),\n\t\t\t\t\t\"external\",\n\t\t\t\t);\n\t\t\t} catch (error: unknown) {\n\t\t\t\tsuccess = false;\n\t\t\t\tassert.strictEqual(\n\t\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\t\tOdspErrorTypes.fileNotFoundOrAccessDeniedError,\n\t\t\t\t\t\"Error should be file not found or access denied error\",\n\t\t\t\t);\n\t\t\t}\n\t\t\tassert.strictEqual(\n\t\t\t\tsuccess,\n\t\t\t\tfalse,\n\t\t\t\t\"Join session should fail if treesLatest call has failed\",\n\t\t\t);\n\t\t});\n\t});\n\n\tdescribe(\"Tests Suite 2\", () => {\n\t\tit(\"Failed treesLatest call should not trigger unhandled rejection event\", async () => {\n\t\t\tconst treesLatestP = mockFetchSingle(\n\t\t\t\tasync () => epochTracker.fetchAndParseAsJSON(\"fetchUrl\", {}, \"treesLatest\"),\n\t\t\t\tnotFound,\n\t\t\t);\n\t\t\tawait assert.rejects(\n\t\t\t\ttreesLatestP,\n\t\t\t\t\"should fail without causing an unhandledRejection event.\",\n\t\t\t);\n\t\t});\n\t});\n});\n"]}