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

package/lib/test/fetchSnapshot.spec.js

@@ -0,0 +1,412 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/* eslint-disable @typescript-eslint/dot-notation */
+import { strict as assert } from "node:assert";
+import { stub } from "sinon";
+import { OdspErrorTypes } from "@fluidframework/odsp-driver-definitions";
+import { createChildLogger, MockLogger, } from "@fluidframework/telemetry-utils";
+import { stringToBuffer } from "@fluid-internal/client-utils";
+import { EpochTracker } from "../epochTracker.js";
+import * as fetchSnapshotImport from "../fetchSnapshot.js";
+import { LocalPersistentCache, NonPersistentCache } from "../odspCache.js";
+import { createCacheSnapshotKey } from "../odspUtils.js";
+import { createOdspUrl } from "../createOdspUrl.js";
+import { getHashedDocumentId } from "../odspPublicUtils.js";
+import { OdspDriverUrlResolver } from "../odspDriverUrlResolver.js";
+import { OdspDocumentStorageService } from "../odspDocumentStorageManager.js";
+import { convertToCompactSnapshot } from "../compactSnapshotWriter.js";
+import { createResponse } from "./mockFetch.js";
+const createUtLocalCache = () => new LocalPersistentCache();
+describe("Tests1 for snapshot fetch", () => {
+    const siteUrl = "https://microsoft.sharepoint-df.com/siteUrl";
+    const driveId = "driveId";
+    const itemId = "itemId";
+    const filePath = "path";
+    let epochTracker;
+    let localCache;
+    let hashedDocumentId;
+    let service;
+    const resolvedUrl = {
+        siteUrl,
+        driveId,
+        itemId,
+        odspResolvedUrl: true,
+    };
+    const newFileParams = {
+        type: "New",
+        driveId,
+        siteUrl: "https://www.localhost.xxx",
+        filePath,
+        filename: "filename",
+    };
+    const hostPolicy = {
+        snapshotOptions: { timeout: 2000, mds: 1000 },
+        summarizerClient: true,
+        fetchBinarySnapshotFormat: false,
+        concurrentSnapshotFetch: true,
+    };
+    const resolver = new OdspDriverUrlResolver();
+    const nonPersistentCache = new NonPersistentCache();
+    let logger;
+    let mockLogger;
+    const odspUrl = createOdspUrl({ ...newFileParams, itemId, dataStorePath: "/" });
+    const content = {
+        snapshotTree: {
+            id: "id",
+            blobs: {},
+            trees: {},
+        },
+        blobContents: new Map(),
+        ops: [],
+        sequenceNumber: 0,
+        latestSequenceNumber: 0,
+        snapshotFormatV: 1,
+    };
+    let resolved;
+    before(async () => {
+        hashedDocumentId = await getHashedDocumentId(driveId, itemId);
+    });
+    beforeEach(async () => {
+        localCache = createUtLocalCache();
+        mockLogger = new MockLogger();
+        logger = createChildLogger({ logger: mockLogger });
+        // use null logger here as we expect errors
+        epochTracker = new EpochTracker(localCache, {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        }, logger);
+        epochTracker.setEpoch("epoch1", true, "test");
+        resolved = await resolver.resolve({ url: odspUrl });
+        service = new OdspDocumentStorageService(resolved, async (_options) => "token", logger, true, { ...nonPersistentCache, persistedCache: epochTracker }, hostPolicy, epochTracker, async () => {
+            return {};
+        }, () => "tenantid/id");
+    });
+    afterEach(async () => {
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    it("Mds limit check in fetch snapshot", async () => {
+        let success = false;
+        async function mockDownloadSnapshot(_response, callback) {
+            const getDownloadSnapshotStub = stub(fetchSnapshotImport, "downloadSnapshot");
+            getDownloadSnapshotStub.returns(_response);
+            try {
+                return await callback();
+            }
+            finally {
+                assert(getDownloadSnapshotStub.args[0][3]?.mds === undefined, "mds should be undefined");
+                success = true;
+                getDownloadSnapshotStub.restore();
+            }
+        }
+        const odspResponse = {
+            content: (await createResponse({}, content, 200)),
+            duration: 10,
+            headers: new Map([
+                ["x-fluid-epoch", "epoch1"],
+                ["content-type", "application/json"],
+            ]),
+            propsToLog: {},
+        };
+        const response = {
+            odspResponse,
+            requestHeaders: {},
+            requestUrl: siteUrl,
+        };
+        try {
+            await mockDownloadSnapshot(Promise.resolve(response), async () => service.getVersions(null, 1));
+        }
+        catch {
+            // Drop error
+        }
+        assert(success, "mds limit should not be set!!");
+    });
+    it("Check error in snapshot content type", async () => {
+        async function mockDownloadSnapshot(_response, callback) {
+            const getDownloadSnapshotStub = stub(fetchSnapshotImport, "downloadSnapshot");
+            getDownloadSnapshotStub.returns(_response);
+            try {
+                return await callback();
+            }
+            finally {
+                getDownloadSnapshotStub.restore();
+            }
+        }
+        const odspResponse = {
+            content: (await createResponse({}, content, 200)),
+            duration: 10,
+            headers: new Map([
+                ["x-fluid-epoch", "epoch1"],
+                ["content-type", "unknown"],
+            ]),
+            propsToLog: {},
+        };
+        const response = {
+            odspResponse,
+            requestHeaders: {},
+            requestUrl: siteUrl,
+        };
+        try {
+            await mockDownloadSnapshot(Promise.resolve(response), async () => service.getVersions(null, 1));
+            assert.fail("should throw incorrectServerResponse error");
+        }
+        catch (error) {
+            assert.strictEqual(error.errorType, OdspErrorTypes.incorrectServerResponse, "incorrectServerResponse should be received");
+            assert.strictEqual(
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
+            error.contentType, "unknown", "content type should be unknown");
+        }
+    });
+    it("GetSnapshot() should work in normal flow", async () => {
+        let ungroupedData = false;
+        async function mockDownloadSnapshot(_response, callback) {
+            const getDownloadSnapshotStub = stub(fetchSnapshotImport, "downloadSnapshot");
+            getDownloadSnapshotStub.returns(_response);
+            try {
+                return await callback();
+            }
+            finally {
+                getDownloadSnapshotStub.restore();
+                assert(getDownloadSnapshotStub.args[0][2]?.length === 0, "should ask for ungroupedData");
+                ungroupedData = true;
+            }
+        }
+        const snapshot = {
+            blobContents,
+            snapshotTree: snapshotTreeWithGroupId,
+            ops: [],
+            latestSequenceNumber: 0,
+            sequenceNumber: 0,
+            snapshotFormatV: 1,
+        };
+        const odspResponse = {
+            content: (await createResponse({}, convertToCompactSnapshot(snapshot), 200)),
+            duration: 10,
+            headers: new Map([
+                ["x-fluid-epoch", "epoch1"],
+                ["content-type", "application/ms-fluid"],
+            ]),
+            propsToLog: {},
+        };
+        const response = {
+            odspResponse,
+            requestHeaders: {},
+            requestUrl: siteUrl,
+        };
+        try {
+            await mockDownloadSnapshot(Promise.resolve(response), async () => service.getSnapshot({ loadingGroupIds: [] }));
+        }
+        catch {
+            assert.fail("the getSnapshot request should succeed");
+        }
+        assert(ungroupedData, "should have asked for ungroupedData");
+        const cachedValue = (await epochTracker.get(createCacheSnapshotKey(resolved)));
+        assert(cachedValue.snapshotTree.id === "SnapshotId", "snapshot should have been cached");
+        assert(service["blobCache"].value.size > 0, "blobs should be cached locally");
+        assert(service["commitCache"].size > 0, "no trees should be cached");
+    });
+    it("GetSnapshot() should work but snapshot should not be cached locally if asked for custom groupId", async () => {
+        let success = false;
+        service["firstSnapshotFetchCall"] = false;
+        async function mockDownloadSnapshot(_response, callback) {
+            const getDownloadSnapshotStub = stub(fetchSnapshotImport, "downloadSnapshot");
+            getDownloadSnapshotStub.returns(_response);
+            try {
+                return await callback();
+            }
+            finally {
+                getDownloadSnapshotStub.restore();
+                assert(getDownloadSnapshotStub.args[0][2]?.[0] === "g1", "should ask for g1 groupId");
+                success = true;
+            }
+        }
+        const snapshot = {
+            blobContents,
+            snapshotTree: snapshotTreeWithGroupId,
+            ops: [],
+            latestSequenceNumber: 0,
+            sequenceNumber: 0,
+            snapshotFormatV: 1,
+        };
+        const odspResponse = {
+            content: (await createResponse({}, convertToCompactSnapshot(snapshot), 200)),
+            duration: 10,
+            headers: new Map([
+                ["x-fluid-epoch", "epoch1"],
+                ["content-type", "application/ms-fluid"],
+            ]),
+            propsToLog: {},
+        };
+        const response = {
+            odspResponse,
+            requestHeaders: {},
+            requestUrl: siteUrl,
+        };
+        try {
+            await mockDownloadSnapshot(Promise.resolve(response), async () => service.getSnapshot({ loadingGroupIds: ["g1"] }));
+        }
+        catch (error) {
+            console.log("error", error);
+            assert.fail("the getSnapshot request should succeed");
+        }
+        assert(success, "should have asked for g1 group id");
+        assert(service["blobCache"].value.size > 0, "blobs should still be cached locally");
+        assert(service["commitCache"].size === 0, "no trees should be cached");
+        assert(mockLogger.matchEvents([
+            {
+                eventName: "ObtainSnapshotForGroup_end",
+                method: "networkOnly",
+                fetchSource: "noCache",
+                useLegacyFlowWithoutGroups: false,
+            },
+        ]), "unexpected events");
+    });
+    it("GetSnapshot() should not cache locally when specified in options", async () => {
+        async function mockDownloadSnapshot(_response, callback) {
+            const getDownloadSnapshotStub = stub(fetchSnapshotImport, "downloadSnapshot");
+            getDownloadSnapshotStub.returns(_response);
+            try {
+                return await callback();
+            }
+            finally {
+                getDownloadSnapshotStub.restore();
+            }
+        }
+        const snapshot = {
+            blobContents,
+            snapshotTree: snapshotTreeWithGroupId,
+            ops: [],
+            latestSequenceNumber: 0,
+            sequenceNumber: 0,
+            snapshotFormatV: 1,
+        };
+        const odspResponse = {
+            content: (await createResponse({}, convertToCompactSnapshot(snapshot), 200)),
+            duration: 10,
+            headers: new Map([
+                ["x-fluid-epoch", "epoch1"],
+                ["content-type", "application/ms-fluid"],
+            ]),
+            propsToLog: {},
+        };
+        const response = {
+            odspResponse,
+            requestHeaders: {},
+            requestUrl: siteUrl,
+        };
+        try {
+            await mockDownloadSnapshot(Promise.resolve(response), async () => service.getSnapshot({ loadingGroupIds: [], cacheSnapshot: false }));
+        }
+        catch {
+            assert.fail("the getSnapshot request should succeed");
+        }
+        const cachedValue = (await epochTracker.get(createCacheSnapshotKey(resolved)));
+        assert(cachedValue.snapshotTree.id === "SnapshotId", "snapshot should have been cached");
+        assert(service["blobCache"].value.size > 0, "blobs should still be cached locally");
+        assert(service["commitCache"].size === 0, "no trees should be cached");
+    });
+    it("GetSnapshot() should not consult cache when request is for a loading group", async () => {
+        async function mockDownloadSnapshot(_response, callback) {
+            const getDownloadSnapshotStub = stub(fetchSnapshotImport, "downloadSnapshot");
+            getDownloadSnapshotStub.returns(_response);
+            try {
+                return await callback();
+            }
+            finally {
+                getDownloadSnapshotStub.restore();
+            }
+        }
+        const snapshot = {
+            blobContents,
+            snapshotTree: snapshotTreeWithGroupId,
+            ops: [],
+            latestSequenceNumber: 0,
+            sequenceNumber: 0,
+            snapshotFormatV: 1,
+        };
+        const odspResponse = {
+            content: (await createResponse({}, convertToCompactSnapshot(snapshot), 200)),
+            duration: 10,
+            headers: new Map([
+                ["x-fluid-epoch", "epoch1"],
+                ["content-type", "application/ms-fluid"],
+            ]),
+            propsToLog: {},
+        };
+        const response = {
+            odspResponse,
+            requestHeaders: {},
+            requestUrl: siteUrl,
+        };
+        try {
+            await mockDownloadSnapshot(Promise.resolve(response), async () => service.getSnapshot({ loadingGroupIds: [], cacheSnapshot: false }));
+        }
+        catch {
+            assert.fail("the getSnapshot request should succeed");
+        }
+        // Fetch again for a groupId
+        try {
+            await mockDownloadSnapshot(Promise.resolve(response), async () => service.getSnapshot({ loadingGroupIds: ["g1"], cacheSnapshot: false }));
+        }
+        catch {
+            assert.fail("the getSnapshot request should succeed");
+        }
+        // Cache should not be consulted.
+        assert(mockLogger.matchEvents([
+            {
+                eventName: "ObtainSnapshot_end",
+                method: "network",
+                useLegacyFlowWithoutGroups: false,
+            },
+            {
+                eventName: "ObtainSnapshotForGroup_end",
+                method: "networkOnly",
+                fetchSource: "noCache",
+                useLegacyFlowWithoutGroups: false,
+            },
+        ]), "unexpected events");
+    });
+});
+const snapshotTreeWithGroupId = {
+    id: "SnapshotId",
+    blobs: {},
+    trees: {
+        ".protocol": {
+            blobs: {},
+            trees: {},
+        },
+        ".app": {
+            blobs: { ".metadata": "bARD4RKvW4LL1KmaUKp6hUMSp" },
+            trees: {
+                ".channels": {
+                    blobs: {},
+                    trees: {
+                        default: {
+                            blobs: {},
+                            trees: {
+                                dds: {
+                                    blobs: {},
+                                    trees: {},
+                                },
+                            },
+                            groupId: "G3",
+                        },
+                    },
+                    unreferenced: true,
+                    groupId: "G2",
+                },
+                ".blobs": { blobs: {}, trees: {} },
+            },
+            unreferenced: true,
+            groupId: "G4",
+        },
+    },
+};
+const blobContents = new Map([
+    [
+        "bARD4RKvW4LL1KmaUKp6hUMSp",
+        stringToBuffer(JSON.stringify({ summaryFormatVersion: 1, gcFeature: 0 }), "utf8"),
+    ],
+]);
+//# sourceMappingURL=fetchSnapshot.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetchSnapshot.spec.js","sourceRoot":"","sources":["../../src/test/fetchSnapshot.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,oDAAoD;AAEpD,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAE7B,OAAO,EAAE,cAAc,EAAoB,MAAM,yCAAyC,CAAC;AAC3F,OAAO,EACN,iBAAiB,EACjB,UAAU,GAGV,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,KAAK,mBAAmB,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,EAA+B,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,kBAAkB,GAAG,GAAyB,EAAE,CAAC,IAAI,oBAAoB,EAAE,CAAC;AAElF,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IAC1C,MAAM,OAAO,GAAG,6CAA6C,CAAC;IAC9D,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC;IACxB,MAAM,QAAQ,GAAG,MAAM,CAAC;IACxB,IAAI,YAA0B,CAAC;IAC/B,IAAI,UAAgC,CAAC;IACrC,IAAI,gBAAwB,CAAC;IAC7B,IAAI,OAAmC,CAAC;IAExC,MAAM,WAAW,GAAG;QACnB,OAAO;QACP,OAAO;QACP,MAAM;QACN,eAAe,EAAE,IAAI;KACU,CAAC;IAEjC,MAAM,aAAa,GAAiB;QACnC,IAAI,EAAE,KAAK;QACX,OAAO;QACP,OAAO,EAAE,2BAA2B;QACpC,QAAQ;QACR,QAAQ,EAAE,UAAU;KACpB,CAAC;IAEF,MAAM,UAAU,GAA8B;QAC7C,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE;QAC7C,gBAAgB,EAAE,IAAI;QACtB,yBAAyB,EAAE,KAAK;QAChC,uBAAuB,EAAE,IAAI;KAC7B,CAAC;IAEF,MAAM,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACpD,IAAI,MAA2B,CAAC;IAChC,IAAI,UAAsB,CAAC;IAC3B,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,GAAG,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;IAEhF,MAAM,OAAO,GAAc;QAC1B,YAAY,EAAE;YACb,EAAE,EAAE,IAAI;YACR,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,EAAE;SACT;QACD,YAAY,EAAE,IAAI,GAAG,EAAE;QACvB,GAAG,EAAE,EAAE;QACP,cAAc,EAAE,CAAC;QACjB,oBAAoB,EAAE,CAAC;QACvB,eAAe,EAAE,CAAC;KAClB,CAAC;IAEF,IAAI,QAA0B,CAAC;IAC/B,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACrB,UAAU,GAAG,kBAAkB,EAAE,CAAC;QAClC,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,GAAG,iBAAiB,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;QACnD,2CAA2C;QAC3C,YAAY,GAAG,IAAI,YAAY,CAC9B,UAAU,EACV;YACC,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,EACD,MAAM,CACN,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QACpD,OAAO,GAAG,IAAI,0BAA0B,CACvC,QAAQ,EACR,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,MAAM,EACN,IAAI,EACJ,EAAE,GAAG,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,EACvD,UAAU,EACV,YAAY,EACZ,KAAK,IAAI,EAAE;YACV,OAAO,EAAE,CAAC;QACX,CAAC,EACD,GAAG,EAAE,CAAC,aAAa,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,mCAAmC,EAAE,KAAK,IAAI,EAAE;QAClD,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,KAAK,UAAU,oBAAoB,CAClC,SAAsD,EACtD,QAA0B;YAE1B,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;YAC9E,uBAAuB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI;gBACH,OAAO,MAAM,QAAQ,EAAE,CAAC;aACxB;oBAAS;gBACT,MAAM,CACL,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,SAAS,EACrD,yBAAyB,CACzB,CAAC;gBACF,OAAO,GAAG,IAAI,CAAC;gBACf,uBAAuB,CAAC,OAAO,EAAE,CAAC;aAClC;QACF,CAAC;QACD,MAAM,YAAY,GAA4B;YAC7C,OAAO,EAAE,CAAC,MAAM,cAAc,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAwB;YACxE,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,IAAI,GAAG,CAAC;gBAChB,CAAC,eAAe,EAAE,QAAQ,CAAC;gBAC3B,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACpC,CAAC;YACF,UAAU,EAAE,EAAE;SACd,CAAC;QACF,MAAM,QAAQ,GAAuC;YACpD,YAAY;YACZ,cAAc,EAAE,EAAE;YAClB,UAAU,EAAE,OAAO;SACnB,CAAC;QACF,IAAI;YACH,MAAM,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAChE,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAC5B,CAAC;SACF;QAAC,MAAM;YACP,aAAa;SACb;QACD,MAAM,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACrD,KAAK,UAAU,oBAAoB,CAClC,SAAsD,EACtD,QAA0B;YAE1B,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;YAC9E,uBAAuB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI;gBACH,OAAO,MAAM,QAAQ,EAAE,CAAC;aACxB;oBAAS;gBACT,uBAAuB,CAAC,OAAO,EAAE,CAAC;aAClC;QACF,CAAC;QACD,MAAM,YAAY,GAA4B;YAC7C,OAAO,EAAE,CAAC,MAAM,cAAc,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAwB;YACxE,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,IAAI,GAAG,CAAC;gBAChB,CAAC,eAAe,EAAE,QAAQ,CAAC;gBAC3B,CAAC,cAAc,EAAE,SAAS,CAAC;aAC3B,CAAC;YACF,UAAU,EAAE,EAAE;SACd,CAAC;QACF,MAAM,QAAQ,GAAuC;YACpD,YAAY;YACZ,cAAc,EAAE,EAAE;YAClB,UAAU,EAAE,OAAO;SACnB,CAAC;QACF,IAAI;YACH,MAAM,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAChE,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAC5B,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;SAC1D;QAAC,OAAO,KAAc,EAAE;YACxB,MAAM,CAAC,WAAW,CAChB,KAAkC,CAAC,SAAS,EAC7C,cAAc,CAAC,uBAAuB,EACtC,4CAA4C,CAC5C,CAAC;YACF,MAAM,CAAC,WAAW;YACjB,0GAA0G;YACzG,KAAa,CAAC,WAAW,EAC1B,SAAS,EACT,gCAAgC,CAChC,CAAC;SACF;IACF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACzD,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,KAAK,UAAU,oBAAoB,CAClC,SAAsD,EACtD,QAA0B;YAE1B,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;YAC9E,uBAAuB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI;gBACH,OAAO,MAAM,QAAQ,EAAE,CAAC;aACxB;oBAAS;gBACT,uBAAuB,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,CACL,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,EAChD,8BAA8B,CAC9B,CAAC;gBACF,aAAa,GAAG,IAAI,CAAC;aACrB;QACF,CAAC;QACD,MAAM,QAAQ,GAAc;YAC3B,YAAY;YACZ,YAAY,EAAE,uBAAuB;YACrC,GAAG,EAAE,EAAE;YACP,oBAAoB,EAAE,CAAC;YACvB,cAAc,EAAE,CAAC;YACjB,eAAe,EAAE,CAAC;SAClB,CAAC;QACF,MAAM,YAAY,GAA4B;YAC7C,OAAO,EAAE,CAAC,MAAM,cAAc,CAC7B,EAAE,EACF,wBAAwB,CAAC,QAAQ,CAAC,EAClC,GAAG,CACH,CAAwB;YACzB,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,IAAI,GAAG,CAAC;gBAChB,CAAC,eAAe,EAAE,QAAQ,CAAC;gBAC3B,CAAC,cAAc,EAAE,sBAAsB,CAAC;aACxC,CAAC;YACF,UAAU,EAAE,EAAE;SACd,CAAC;QACF,MAAM,QAAQ,GAAuC;YACpD,YAAY;YACZ,cAAc,EAAE,EAAE;YAClB,UAAU,EAAE,OAAO;SACnB,CAAC;QACF,IAAI;YACH,MAAM,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAChE,OAAO,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAC5C,CAAC;SACF;QAAC,MAAM;YACP,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;SACtD;QACD,MAAM,CAAC,aAAa,EAAE,qCAAqC,CAAC,CAAC;QAC7D,MAAM,WAAW,GAAG,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAc,CAAC;QAC5F,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,KAAK,YAAY,EAAE,kCAAkC,CAAC,CAAC;QACzF,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,gCAAgC,CAAC,CAAC;QAC9E,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,2BAA2B,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iGAAiG,EAAE,KAAK,IAAI,EAAE;QAChH,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,OAAO,CAAC,wBAAwB,CAAC,GAAG,KAAK,CAAC;QAC1C,KAAK,UAAU,oBAAoB,CAClC,SAAsD,EACtD,QAA0B;YAE1B,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;YAC9E,uBAAuB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI;gBACH,OAAO,MAAM,QAAQ,EAAE,CAAC;aACxB;oBAAS;gBACT,uBAAuB,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,CACL,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,EAChD,2BAA2B,CAC3B,CAAC;gBACF,OAAO,GAAG,IAAI,CAAC;aACf;QACF,CAAC;QACD,MAAM,QAAQ,GAAc;YAC3B,YAAY;YACZ,YAAY,EAAE,uBAAuB;YACrC,GAAG,EAAE,EAAE;YACP,oBAAoB,EAAE,CAAC;YACvB,cAAc,EAAE,CAAC;YACjB,eAAe,EAAE,CAAC;SAClB,CAAC;QACF,MAAM,YAAY,GAA4B;YAC7C,OAAO,EAAE,CAAC,MAAM,cAAc,CAC7B,EAAE,EACF,wBAAwB,CAAC,QAAQ,CAAC,EAClC,GAAG,CACH,CAAwB;YACzB,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,IAAI,GAAG,CAAC;gBAChB,CAAC,eAAe,EAAE,QAAQ,CAAC;gBAC3B,CAAC,cAAc,EAAE,sBAAsB,CAAC;aACxC,CAAC;YACF,UAAU,EAAE,EAAE;SACd,CAAC;QACF,MAAM,QAAQ,GAAuC;YACpD,YAAY;YACZ,cAAc,EAAE,EAAE;YAClB,UAAU,EAAE,OAAO;SACnB,CAAC;QACF,IAAI;YACH,MAAM,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAChE,OAAO,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAChD,CAAC;SACF;QAAC,OAAO,KAAc,EAAE;YACxB,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;SACtD;QACD,MAAM,CAAC,OAAO,EAAE,mCAAmC,CAAC,CAAC;QACrD,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,sCAAsC,CAAC,CAAC;QACpF,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACvE,MAAM,CACL,UAAU,CAAC,WAAW,CAAC;YACtB;gBACC,SAAS,EAAE,4BAA4B;gBACvC,MAAM,EAAE,aAAa;gBACrB,WAAW,EAAE,SAAS;gBACtB,0BAA0B,EAAE,KAAK;aACjC;SACD,CAAC,EACF,mBAAmB,CACnB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QACjF,KAAK,UAAU,oBAAoB,CAClC,SAAsD,EACtD,QAA0B;YAE1B,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;YAC9E,uBAAuB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI;gBACH,OAAO,MAAM,QAAQ,EAAE,CAAC;aACxB;oBAAS;gBACT,uBAAuB,CAAC,OAAO,EAAE,CAAC;aAClC;QACF,CAAC;QACD,MAAM,QAAQ,GAAc;YAC3B,YAAY;YACZ,YAAY,EAAE,uBAAuB;YACrC,GAAG,EAAE,EAAE;YACP,oBAAoB,EAAE,CAAC;YACvB,cAAc,EAAE,CAAC;YACjB,eAAe,EAAE,CAAC;SAClB,CAAC;QACF,MAAM,YAAY,GAA4B;YAC7C,OAAO,EAAE,CAAC,MAAM,cAAc,CAC7B,EAAE,EACF,wBAAwB,CAAC,QAAQ,CAAC,EAClC,GAAG,CACH,CAAwB;YACzB,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,IAAI,GAAG,CAAC;gBAChB,CAAC,eAAe,EAAE,QAAQ,CAAC;gBAC3B,CAAC,cAAc,EAAE,sBAAsB,CAAC;aACxC,CAAC;YACF,UAAU,EAAE,EAAE;SACd,CAAC;QACF,MAAM,QAAQ,GAAuC;YACpD,YAAY;YACZ,cAAc,EAAE,EAAE;YAClB,UAAU,EAAE,OAAO;SACnB,CAAC;QACF,IAAI;YACH,MAAM,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAChE,OAAO,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAClE,CAAC;SACF;QAAC,MAAM;YACP,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;SACtD;QACD,MAAM,WAAW,GAAG,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAc,CAAC;QAC5F,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,KAAK,YAAY,EAAE,kCAAkC,CAAC,CAAC;QACzF,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,sCAAsC,CAAC,CAAC;QACpF,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;QAC3F,KAAK,UAAU,oBAAoB,CAClC,SAAsD,EACtD,QAA0B;YAE1B,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;YAC9E,uBAAuB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI;gBACH,OAAO,MAAM,QAAQ,EAAE,CAAC;aACxB;oBAAS;gBACT,uBAAuB,CAAC,OAAO,EAAE,CAAC;aAClC;QACF,CAAC;QACD,MAAM,QAAQ,GAAc;YAC3B,YAAY;YACZ,YAAY,EAAE,uBAAuB;YACrC,GAAG,EAAE,EAAE;YACP,oBAAoB,EAAE,CAAC;YACvB,cAAc,EAAE,CAAC;YACjB,eAAe,EAAE,CAAC;SAClB,CAAC;QACF,MAAM,YAAY,GAA4B;YAC7C,OAAO,EAAE,CAAC,MAAM,cAAc,CAC7B,EAAE,EACF,wBAAwB,CAAC,QAAQ,CAAC,EAClC,GAAG,CACH,CAAwB;YACzB,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,IAAI,GAAG,CAAC;gBAChB,CAAC,eAAe,EAAE,QAAQ,CAAC;gBAC3B,CAAC,cAAc,EAAE,sBAAsB,CAAC;aACxC,CAAC;YACF,UAAU,EAAE,EAAE;SACd,CAAC;QACF,MAAM,QAAQ,GAAuC;YACpD,YAAY;YACZ,cAAc,EAAE,EAAE;YAClB,UAAU,EAAE,OAAO;SACnB,CAAC;QACF,IAAI;YACH,MAAM,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAChE,OAAO,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAClE,CAAC;SACF;QAAC,MAAM;YACP,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;SACtD;QAED,4BAA4B;QAC5B,IAAI;YACH,MAAM,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAChE,OAAO,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CACtE,CAAC;SACF;QAAC,MAAM;YACP,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;SACtD;QACD,iCAAiC;QACjC,MAAM,CACL,UAAU,CAAC,WAAW,CAAC;YACtB;gBACC,SAAS,EAAE,oBAAoB;gBAC/B,MAAM,EAAE,SAAS;gBACjB,0BAA0B,EAAE,KAAK;aACjC;YACD;gBACC,SAAS,EAAE,4BAA4B;gBACvC,MAAM,EAAE,aAAa;gBACrB,WAAW,EAAE,SAAS;gBACtB,0BAA0B,EAAE,KAAK;aACjC;SACD,CAAC,EACF,mBAAmB,CACnB,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAkB;IAC9C,EAAE,EAAE,YAAY;IAChB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE;QACN,WAAW,EAAE;YACZ,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,EAAE;SACT;QACD,MAAM,EAAE;YACP,KAAK,EAAE,EAAE,WAAW,EAAE,2BAA2B,EAAE;YACnD,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,KAAK,EAAE,EAAE;oBACT,KAAK,EAAE;wBACN,OAAO,EAAE;4BACR,KAAK,EAAE,EAAE;4BACT,KAAK,EAAE;gCACN,GAAG,EAAE;oCACJ,KAAK,EAAE,EAAE;oCACT,KAAK,EAAE,EAAE;iCACT;6BACD;4BACD,OAAO,EAAE,IAAI;yBACb;qBACD;oBACD,YAAY,EAAE,IAAI;oBAClB,OAAO,EAAE,IAAI;iBACb;gBACD,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;aAClC;YACD,YAAY,EAAE,IAAI;YAClB,OAAO,EAAE,IAAI;SACb;KACD;CACD,CAAC;AAEF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAsB;IACjD;QACC,2BAA2B;QAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;KACjF;CACD,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable @typescript-eslint/dot-notation */\n\nimport { strict as assert } from \"node:assert\";\nimport { stub } from \"sinon\";\nimport { ISnapshot } from \"@fluidframework/driver-definitions\";\nimport { OdspErrorTypes, IOdspResolvedUrl } from \"@fluidframework/odsp-driver-definitions\";\nimport {\n\tcreateChildLogger,\n\tMockLogger,\n\ttype ITelemetryLoggerExt,\n\ttype IFluidErrorBase,\n} from \"@fluidframework/telemetry-utils\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { stringToBuffer } from \"@fluid-internal/client-utils\";\nimport { EpochTracker } from \"../epochTracker.js\";\nimport { HostStoragePolicyInternal } from \"../contracts.js\";\nimport * as fetchSnapshotImport from \"../fetchSnapshot.js\";\nimport { LocalPersistentCache, NonPersistentCache } from \"../odspCache.js\";\nimport { INewFileInfo, IOdspResponse, createCacheSnapshotKey } from \"../odspUtils.js\";\nimport { createOdspUrl } from \"../createOdspUrl.js\";\nimport { getHashedDocumentId } from \"../odspPublicUtils.js\";\nimport { OdspDriverUrlResolver } from \"../odspDriverUrlResolver.js\";\nimport { ISnapshotRequestAndResponseOptions } from \"../fetchSnapshot.js\";\nimport { OdspDocumentStorageService } from \"../odspDocumentStorageManager.js\";\nimport { convertToCompactSnapshot } from \"../compactSnapshotWriter.js\";\nimport { createResponse } from \"./mockFetch.js\";\n\nconst createUtLocalCache = (): LocalPersistentCache => new LocalPersistentCache();\n\ndescribe(\"Tests1 for snapshot fetch\", () => {\n\tconst siteUrl = \"https://microsoft.sharepoint-df.com/siteUrl\";\n\tconst driveId = \"driveId\";\n\tconst itemId = \"itemId\";\n\tconst filePath = \"path\";\n\tlet epochTracker: EpochTracker;\n\tlet localCache: LocalPersistentCache;\n\tlet hashedDocumentId: string;\n\tlet service: OdspDocumentStorageService;\n\n\tconst resolvedUrl = {\n\t\tsiteUrl,\n\t\tdriveId,\n\t\titemId,\n\t\todspResolvedUrl: true,\n\t} as unknown as IOdspResolvedUrl;\n\n\tconst newFileParams: INewFileInfo = {\n\t\ttype: \"New\",\n\t\tdriveId,\n\t\tsiteUrl: \"https://www.localhost.xxx\",\n\t\tfilePath,\n\t\tfilename: \"filename\",\n\t};\n\n\tconst hostPolicy: HostStoragePolicyInternal = {\n\t\tsnapshotOptions: { timeout: 2000, mds: 1000 },\n\t\tsummarizerClient: true,\n\t\tfetchBinarySnapshotFormat: false,\n\t\tconcurrentSnapshotFetch: true,\n\t};\n\n\tconst resolver = new OdspDriverUrlResolver();\n\tconst nonPersistentCache = new NonPersistentCache();\n\tlet logger: ITelemetryLoggerExt;\n\tlet mockLogger: MockLogger;\n\tconst odspUrl = createOdspUrl({ ...newFileParams, itemId, dataStorePath: \"/\" });\n\n\tconst content: ISnapshot = {\n\t\tsnapshotTree: {\n\t\t\tid: \"id\",\n\t\t\tblobs: {},\n\t\t\ttrees: {},\n\t\t},\n\t\tblobContents: new Map(),\n\t\tops: [],\n\t\tsequenceNumber: 0,\n\t\tlatestSequenceNumber: 0,\n\t\tsnapshotFormatV: 1,\n\t};\n\n\tlet resolved: IOdspResolvedUrl;\n\tbefore(async () => {\n\t\thashedDocumentId = await getHashedDocumentId(driveId, itemId);\n\t});\n\n\tbeforeEach(async () => {\n\t\tlocalCache = createUtLocalCache();\n\t\tmockLogger = new MockLogger();\n\t\tlogger = createChildLogger({ logger: mockLogger });\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\tlogger,\n\t\t);\n\t\tepochTracker.setEpoch(\"epoch1\", true, \"test\");\n\t\tresolved = await resolver.resolve({ url: odspUrl });\n\t\tservice = new OdspDocumentStorageService(\n\t\t\tresolved,\n\t\t\tasync (_options) => \"token\",\n\t\t\tlogger,\n\t\t\ttrue,\n\t\t\t{ ...nonPersistentCache, persistedCache: epochTracker },\n\t\t\thostPolicy,\n\t\t\tepochTracker,\n\t\t\tasync () => {\n\t\t\t\treturn {};\n\t\t\t},\n\t\t\t() => \"tenantid/id\",\n\t\t);\n\t});\n\n\tafterEach(async () => {\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tit(\"Mds limit check in fetch snapshot\", async () => {\n\t\tlet success = false;\n\t\tasync function mockDownloadSnapshot<T>(\n\t\t\t_response: Promise<ISnapshotRequestAndResponseOptions>,\n\t\t\tcallback: () => Promise<T>,\n\t\t): Promise<T> {\n\t\t\tconst getDownloadSnapshotStub = stub(fetchSnapshotImport, \"downloadSnapshot\");\n\t\t\tgetDownloadSnapshotStub.returns(_response);\n\t\t\ttry {\n\t\t\t\treturn await callback();\n\t\t\t} finally {\n\t\t\t\tassert(\n\t\t\t\t\tgetDownloadSnapshotStub.args[0][3]?.mds === undefined,\n\t\t\t\t\t\"mds should be undefined\",\n\t\t\t\t);\n\t\t\t\tsuccess = true;\n\t\t\t\tgetDownloadSnapshotStub.restore();\n\t\t\t}\n\t\t}\n\t\tconst odspResponse: IOdspResponse<Response> = {\n\t\t\tcontent: (await createResponse({}, content, 200)) as unknown as Response,\n\t\t\tduration: 10,\n\t\t\theaders: new Map([\n\t\t\t\t[\"x-fluid-epoch\", \"epoch1\"],\n\t\t\t\t[\"content-type\", \"application/json\"],\n\t\t\t]),\n\t\t\tpropsToLog: {},\n\t\t};\n\t\tconst response: ISnapshotRequestAndResponseOptions = {\n\t\t\todspResponse,\n\t\t\trequestHeaders: {},\n\t\t\trequestUrl: siteUrl,\n\t\t};\n\t\ttry {\n\t\t\tawait mockDownloadSnapshot(Promise.resolve(response), async () =>\n\t\t\t\tservice.getVersions(null, 1),\n\t\t\t);\n\t\t} catch {\n\t\t\t// Drop error\n\t\t}\n\t\tassert(success, \"mds limit should not be set!!\");\n\t});\n\n\tit(\"Check error in snapshot content type\", async () => {\n\t\tasync function mockDownloadSnapshot<T>(\n\t\t\t_response: Promise<ISnapshotRequestAndResponseOptions>,\n\t\t\tcallback: () => Promise<T>,\n\t\t): Promise<T> {\n\t\t\tconst getDownloadSnapshotStub = stub(fetchSnapshotImport, \"downloadSnapshot\");\n\t\t\tgetDownloadSnapshotStub.returns(_response);\n\t\t\ttry {\n\t\t\t\treturn await callback();\n\t\t\t} finally {\n\t\t\t\tgetDownloadSnapshotStub.restore();\n\t\t\t}\n\t\t}\n\t\tconst odspResponse: IOdspResponse<Response> = {\n\t\t\tcontent: (await createResponse({}, content, 200)) as unknown as Response,\n\t\t\tduration: 10,\n\t\t\theaders: new Map([\n\t\t\t\t[\"x-fluid-epoch\", \"epoch1\"],\n\t\t\t\t[\"content-type\", \"unknown\"],\n\t\t\t]),\n\t\t\tpropsToLog: {},\n\t\t};\n\t\tconst response: ISnapshotRequestAndResponseOptions = {\n\t\t\todspResponse,\n\t\t\trequestHeaders: {},\n\t\t\trequestUrl: siteUrl,\n\t\t};\n\t\ttry {\n\t\t\tawait mockDownloadSnapshot(Promise.resolve(response), async () =>\n\t\t\t\tservice.getVersions(null, 1),\n\t\t\t);\n\t\t\tassert.fail(\"should throw incorrectServerResponse error\");\n\t\t} catch (error: unknown) {\n\t\t\tassert.strictEqual(\n\t\t\t\t(error as Partial<IFluidErrorBase>).errorType,\n\t\t\t\tOdspErrorTypes.incorrectServerResponse,\n\t\t\t\t\"incorrectServerResponse should be received\",\n\t\t\t);\n\t\t\tassert.strictEqual(\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any\n\t\t\t\t(error as any).contentType,\n\t\t\t\t\"unknown\",\n\t\t\t\t\"content type should be unknown\",\n\t\t\t);\n\t\t}\n\t});\n\n\tit(\"GetSnapshot() should work in normal flow\", async () => {\n\t\tlet ungroupedData = false;\n\t\tasync function mockDownloadSnapshot<T>(\n\t\t\t_response: Promise<ISnapshotRequestAndResponseOptions>,\n\t\t\tcallback: () => Promise<T>,\n\t\t): Promise<T> {\n\t\t\tconst getDownloadSnapshotStub = stub(fetchSnapshotImport, \"downloadSnapshot\");\n\t\t\tgetDownloadSnapshotStub.returns(_response);\n\t\t\ttry {\n\t\t\t\treturn await callback();\n\t\t\t} finally {\n\t\t\t\tgetDownloadSnapshotStub.restore();\n\t\t\t\tassert(\n\t\t\t\t\tgetDownloadSnapshotStub.args[0][2]?.length === 0,\n\t\t\t\t\t\"should ask for ungroupedData\",\n\t\t\t\t);\n\t\t\t\tungroupedData = true;\n\t\t\t}\n\t\t}\n\t\tconst snapshot: ISnapshot = {\n\t\t\tblobContents,\n\t\t\tsnapshotTree: snapshotTreeWithGroupId,\n\t\t\tops: [],\n\t\t\tlatestSequenceNumber: 0,\n\t\t\tsequenceNumber: 0,\n\t\t\tsnapshotFormatV: 1,\n\t\t};\n\t\tconst odspResponse: IOdspResponse<Response> = {\n\t\t\tcontent: (await createResponse(\n\t\t\t\t{},\n\t\t\t\tconvertToCompactSnapshot(snapshot),\n\t\t\t\t200,\n\t\t\t)) as unknown as Response,\n\t\t\tduration: 10,\n\t\t\theaders: new Map([\n\t\t\t\t[\"x-fluid-epoch\", \"epoch1\"],\n\t\t\t\t[\"content-type\", \"application/ms-fluid\"],\n\t\t\t]),\n\t\t\tpropsToLog: {},\n\t\t};\n\t\tconst response: ISnapshotRequestAndResponseOptions = {\n\t\t\todspResponse,\n\t\t\trequestHeaders: {},\n\t\t\trequestUrl: siteUrl,\n\t\t};\n\t\ttry {\n\t\t\tawait mockDownloadSnapshot(Promise.resolve(response), async () =>\n\t\t\t\tservice.getSnapshot({ loadingGroupIds: [] }),\n\t\t\t);\n\t\t} catch {\n\t\t\tassert.fail(\"the getSnapshot request should succeed\");\n\t\t}\n\t\tassert(ungroupedData, \"should have asked for ungroupedData\");\n\t\tconst cachedValue = (await epochTracker.get(createCacheSnapshotKey(resolved))) as ISnapshot;\n\t\tassert(cachedValue.snapshotTree.id === \"SnapshotId\", \"snapshot should have been cached\");\n\t\tassert(service[\"blobCache\"].value.size > 0, \"blobs should be cached locally\");\n\t\tassert(service[\"commitCache\"].size > 0, \"no trees should be cached\");\n\t});\n\n\tit(\"GetSnapshot() should work but snapshot should not be cached locally if asked for custom groupId\", async () => {\n\t\tlet success = false;\n\t\tservice[\"firstSnapshotFetchCall\"] = false;\n\t\tasync function mockDownloadSnapshot<T>(\n\t\t\t_response: Promise<ISnapshotRequestAndResponseOptions>,\n\t\t\tcallback: () => Promise<T>,\n\t\t): Promise<T> {\n\t\t\tconst getDownloadSnapshotStub = stub(fetchSnapshotImport, \"downloadSnapshot\");\n\t\t\tgetDownloadSnapshotStub.returns(_response);\n\t\t\ttry {\n\t\t\t\treturn await callback();\n\t\t\t} finally {\n\t\t\t\tgetDownloadSnapshotStub.restore();\n\t\t\t\tassert(\n\t\t\t\t\tgetDownloadSnapshotStub.args[0][2]?.[0] === \"g1\",\n\t\t\t\t\t\"should ask for g1 groupId\",\n\t\t\t\t);\n\t\t\t\tsuccess = true;\n\t\t\t}\n\t\t}\n\t\tconst snapshot: ISnapshot = {\n\t\t\tblobContents,\n\t\t\tsnapshotTree: snapshotTreeWithGroupId,\n\t\t\tops: [],\n\t\t\tlatestSequenceNumber: 0,\n\t\t\tsequenceNumber: 0,\n\t\t\tsnapshotFormatV: 1,\n\t\t};\n\t\tconst odspResponse: IOdspResponse<Response> = {\n\t\t\tcontent: (await createResponse(\n\t\t\t\t{},\n\t\t\t\tconvertToCompactSnapshot(snapshot),\n\t\t\t\t200,\n\t\t\t)) as unknown as Response,\n\t\t\tduration: 10,\n\t\t\theaders: new Map([\n\t\t\t\t[\"x-fluid-epoch\", \"epoch1\"],\n\t\t\t\t[\"content-type\", \"application/ms-fluid\"],\n\t\t\t]),\n\t\t\tpropsToLog: {},\n\t\t};\n\t\tconst response: ISnapshotRequestAndResponseOptions = {\n\t\t\todspResponse,\n\t\t\trequestHeaders: {},\n\t\t\trequestUrl: siteUrl,\n\t\t};\n\t\ttry {\n\t\t\tawait mockDownloadSnapshot(Promise.resolve(response), async () =>\n\t\t\t\tservice.getSnapshot({ loadingGroupIds: [\"g1\"] }),\n\t\t\t);\n\t\t} catch (error: unknown) {\n\t\t\tconsole.log(\"error\", error);\n\t\t\tassert.fail(\"the getSnapshot request should succeed\");\n\t\t}\n\t\tassert(success, \"should have asked for g1 group id\");\n\t\tassert(service[\"blobCache\"].value.size > 0, \"blobs should still be cached locally\");\n\t\tassert(service[\"commitCache\"].size === 0, \"no trees should be cached\");\n\t\tassert(\n\t\t\tmockLogger.matchEvents([\n\t\t\t\t{\n\t\t\t\t\teventName: \"ObtainSnapshotForGroup_end\",\n\t\t\t\t\tmethod: \"networkOnly\",\n\t\t\t\t\tfetchSource: \"noCache\",\n\t\t\t\t\tuseLegacyFlowWithoutGroups: false,\n\t\t\t\t},\n\t\t\t]),\n\t\t\t\"unexpected events\",\n\t\t);\n\t});\n\n\tit(\"GetSnapshot() should not cache locally when specified in options\", async () => {\n\t\tasync function mockDownloadSnapshot<T>(\n\t\t\t_response: Promise<ISnapshotRequestAndResponseOptions>,\n\t\t\tcallback: () => Promise<T>,\n\t\t): Promise<T> {\n\t\t\tconst getDownloadSnapshotStub = stub(fetchSnapshotImport, \"downloadSnapshot\");\n\t\t\tgetDownloadSnapshotStub.returns(_response);\n\t\t\ttry {\n\t\t\t\treturn await callback();\n\t\t\t} finally {\n\t\t\t\tgetDownloadSnapshotStub.restore();\n\t\t\t}\n\t\t}\n\t\tconst snapshot: ISnapshot = {\n\t\t\tblobContents,\n\t\t\tsnapshotTree: snapshotTreeWithGroupId,\n\t\t\tops: [],\n\t\t\tlatestSequenceNumber: 0,\n\t\t\tsequenceNumber: 0,\n\t\t\tsnapshotFormatV: 1,\n\t\t};\n\t\tconst odspResponse: IOdspResponse<Response> = {\n\t\t\tcontent: (await createResponse(\n\t\t\t\t{},\n\t\t\t\tconvertToCompactSnapshot(snapshot),\n\t\t\t\t200,\n\t\t\t)) as unknown as Response,\n\t\t\tduration: 10,\n\t\t\theaders: new Map([\n\t\t\t\t[\"x-fluid-epoch\", \"epoch1\"],\n\t\t\t\t[\"content-type\", \"application/ms-fluid\"],\n\t\t\t]),\n\t\t\tpropsToLog: {},\n\t\t};\n\t\tconst response: ISnapshotRequestAndResponseOptions = {\n\t\t\todspResponse,\n\t\t\trequestHeaders: {},\n\t\t\trequestUrl: siteUrl,\n\t\t};\n\t\ttry {\n\t\t\tawait mockDownloadSnapshot(Promise.resolve(response), async () =>\n\t\t\t\tservice.getSnapshot({ loadingGroupIds: [], cacheSnapshot: false }),\n\t\t\t);\n\t\t} catch {\n\t\t\tassert.fail(\"the getSnapshot request should succeed\");\n\t\t}\n\t\tconst cachedValue = (await epochTracker.get(createCacheSnapshotKey(resolved))) as ISnapshot;\n\t\tassert(cachedValue.snapshotTree.id === \"SnapshotId\", \"snapshot should have been cached\");\n\t\tassert(service[\"blobCache\"].value.size > 0, \"blobs should still be cached locally\");\n\t\tassert(service[\"commitCache\"].size === 0, \"no trees should be cached\");\n\t});\n\n\tit(\"GetSnapshot() should not consult cache when request is for a loading group\", async () => {\n\t\tasync function mockDownloadSnapshot<T>(\n\t\t\t_response: Promise<ISnapshotRequestAndResponseOptions>,\n\t\t\tcallback: () => Promise<T>,\n\t\t): Promise<T> {\n\t\t\tconst getDownloadSnapshotStub = stub(fetchSnapshotImport, \"downloadSnapshot\");\n\t\t\tgetDownloadSnapshotStub.returns(_response);\n\t\t\ttry {\n\t\t\t\treturn await callback();\n\t\t\t} finally {\n\t\t\t\tgetDownloadSnapshotStub.restore();\n\t\t\t}\n\t\t}\n\t\tconst snapshot: ISnapshot = {\n\t\t\tblobContents,\n\t\t\tsnapshotTree: snapshotTreeWithGroupId,\n\t\t\tops: [],\n\t\t\tlatestSequenceNumber: 0,\n\t\t\tsequenceNumber: 0,\n\t\t\tsnapshotFormatV: 1,\n\t\t};\n\t\tconst odspResponse: IOdspResponse<Response> = {\n\t\t\tcontent: (await createResponse(\n\t\t\t\t{},\n\t\t\t\tconvertToCompactSnapshot(snapshot),\n\t\t\t\t200,\n\t\t\t)) as unknown as Response,\n\t\t\tduration: 10,\n\t\t\theaders: new Map([\n\t\t\t\t[\"x-fluid-epoch\", \"epoch1\"],\n\t\t\t\t[\"content-type\", \"application/ms-fluid\"],\n\t\t\t]),\n\t\t\tpropsToLog: {},\n\t\t};\n\t\tconst response: ISnapshotRequestAndResponseOptions = {\n\t\t\todspResponse,\n\t\t\trequestHeaders: {},\n\t\t\trequestUrl: siteUrl,\n\t\t};\n\t\ttry {\n\t\t\tawait mockDownloadSnapshot(Promise.resolve(response), async () =>\n\t\t\t\tservice.getSnapshot({ loadingGroupIds: [], cacheSnapshot: false }),\n\t\t\t);\n\t\t} catch {\n\t\t\tassert.fail(\"the getSnapshot request should succeed\");\n\t\t}\n\n\t\t// Fetch again for a groupId\n\t\ttry {\n\t\t\tawait mockDownloadSnapshot(Promise.resolve(response), async () =>\n\t\t\t\tservice.getSnapshot({ loadingGroupIds: [\"g1\"], cacheSnapshot: false }),\n\t\t\t);\n\t\t} catch {\n\t\t\tassert.fail(\"the getSnapshot request should succeed\");\n\t\t}\n\t\t// Cache should not be consulted.\n\t\tassert(\n\t\t\tmockLogger.matchEvents([\n\t\t\t\t{\n\t\t\t\t\teventName: \"ObtainSnapshot_end\",\n\t\t\t\t\tmethod: \"network\",\n\t\t\t\t\tuseLegacyFlowWithoutGroups: false,\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\teventName: \"ObtainSnapshotForGroup_end\",\n\t\t\t\t\tmethod: \"networkOnly\",\n\t\t\t\t\tfetchSource: \"noCache\",\n\t\t\t\t\tuseLegacyFlowWithoutGroups: false,\n\t\t\t\t},\n\t\t\t]),\n\t\t\t\"unexpected events\",\n\t\t);\n\t});\n});\n\nconst snapshotTreeWithGroupId: ISnapshotTree = {\n\tid: \"SnapshotId\",\n\tblobs: {},\n\ttrees: {\n\t\t\".protocol\": {\n\t\t\tblobs: {},\n\t\t\ttrees: {},\n\t\t},\n\t\t\".app\": {\n\t\t\tblobs: { \".metadata\": \"bARD4RKvW4LL1KmaUKp6hUMSp\" },\n\t\t\ttrees: {\n\t\t\t\t\".channels\": {\n\t\t\t\t\tblobs: {},\n\t\t\t\t\ttrees: {\n\t\t\t\t\t\tdefault: {\n\t\t\t\t\t\t\tblobs: {},\n\t\t\t\t\t\t\ttrees: {\n\t\t\t\t\t\t\t\tdds: {\n\t\t\t\t\t\t\t\t\tblobs: {},\n\t\t\t\t\t\t\t\t\ttrees: {},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tgroupId: \"G3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tunreferenced: true,\n\t\t\t\t\tgroupId: \"G2\",\n\t\t\t\t},\n\t\t\t\t\".blobs\": { blobs: {}, trees: {} },\n\t\t\t},\n\t\t\tunreferenced: true,\n\t\t\tgroupId: \"G4\",\n\t\t},\n\t},\n};\n\nconst blobContents = new Map<string, ArrayBuffer>([\n\t[\n\t\t\"bARD4RKvW4LL1KmaUKp6hUMSp\",\n\t\tstringToBuffer(JSON.stringify({ summaryFormatVersion: 1, gcFeature: 0 }), \"utf8\"),\n\t],\n]);\n"]}

package/lib/test/getFileLink.spec.js

@@ -0,0 +1,62 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { getFileLink } from "../getFileLink.js";
+import { mockFetchSingle, mockFetchMultiple, okResponse, notFound, createResponse, } from "./mockFetch.js";
+describe("getFileLink", () => {
+    const siteUrl = "https://microsoft.sharepoint-df.com/siteUrl";
+    const driveId = "driveId";
+    const logger = new MockLogger();
+    const storageTokenFetcher = async () => "StorageToken";
+    const fileItemResponse = {
+        webDavUrl: "fetchDavUrl",
+        webUrl: "fetchWebUrl",
+        sharepointIds: { listItemUniqueId: "fetchFileId" },
+    };
+    afterEach(() => {
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+    it("should return share link with existing access", async () => {
+        const result = await mockFetchMultiple(async () => getFileLink(storageTokenFetcher, { siteUrl, driveId, itemId: "itemId4" }, logger.toTelemetryLogger()), [
+            async () => okResponse({}, fileItemResponse),
+            async () => okResponse({}, { d: { directUrl: "sharelink" } }),
+        ]);
+        assert.strictEqual(result, "sharelink", "File link should match url returned from sharing information");
+    });
+    it("should reject if file web dav url is missing", async () => {
+        await assert.rejects(mockFetchMultiple(async () => getFileLink(storageTokenFetcher, { siteUrl, driveId, itemId: "itemId5" }, logger.toTelemetryLogger()), [
+            async () => okResponse({}, {}),
+            // We retry once on malformed response from server, so need a second response mocked.
+            async () => okResponse({}, {}),
+        ]), "File link should reject for malformed url");
+    });
+    it("should reject if file item is not found", async () => {
+        await assert.rejects(mockFetchSingle(async () => {
+            return getFileLink(storageTokenFetcher, { siteUrl, driveId, itemId: "itemId6" }, logger.toTelemetryLogger());
+        }, notFound), "File link should reject when not found");
+    });
+    it("should successfully retry", async () => {
+        const result = await mockFetchMultiple(async () => getFileLink(storageTokenFetcher, { siteUrl, driveId, itemId: "itemId7" }, logger.toTelemetryLogger()), [
+            async () => createResponse({ "retry-after": "0.001" }, undefined, 900),
+            async () => okResponse({}, fileItemResponse),
+            async () => okResponse({}, { d: { directUrl: "sharelink" } }),
+        ]);
+        assert.strictEqual(result, "sharelink", "File link should match url returned from sharing information");
+        // Should be present in cache now and subsequent calls should fetch from cache.
+        const sharelink2 = await getFileLink(storageTokenFetcher, { siteUrl, driveId, itemId: "itemId7" }, logger.toTelemetryLogger());
+        assert.strictEqual(sharelink2, "sharelink", "File link should match url returned from sharing information from cache");
+    });
+    it("should successfully give up after 5 tries", async () => {
+        await assert.rejects(mockFetchMultiple(async () => getFileLink(storageTokenFetcher, { siteUrl, driveId, itemId: "itemId7" }, logger.toTelemetryLogger()), [
+            async () => createResponse({ "retry-after": "0.001" }, undefined, 900),
+            async () => createResponse({ "retry-after": "0.001" }, undefined, 900),
+            async () => createResponse({ "retry-after": "0.001" }, undefined, 900),
+            async () => createResponse({ "retry-after": "0.001" }, undefined, 900),
+            async () => createResponse({ "retry-after": "0.001" }, undefined, 900),
+        ]), "did not retries 5 times");
+    });
+});
+//# sourceMappingURL=getFileLink.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getFileLink.spec.js","sourceRoot":"","sources":["../../src/test/getFileLink.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EACN,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,QAAQ,EACR,cAAc,GAEd,MAAM,gBAAgB,CAAC;AAExB,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC5B,MAAM,OAAO,GAAG,6CAA6C,CAAC;IAC9D,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;IAChC,MAAM,mBAAmB,GAAG,KAAK,IAAqB,EAAE,CAAC,cAAc,CAAC;IACxE,MAAM,gBAAgB,GAAG;QACxB,SAAS,EAAE,aAAa;QACxB,MAAM,EAAE,aAAa;QACrB,aAAa,EAAE,EAAE,gBAAgB,EAAE,aAAa,EAAE;KAClD,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACd,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,MAAM,GAAG,MAAM,iBAAiB,CACrC,KAAK,IAAI,EAAE,CACV,WAAW,CACV,mBAAmB,EACnB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,EACvC,MAAM,CAAC,iBAAiB,EAAE,CAC1B,EACF;YACC,KAAK,IAA2B,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,gBAAgB,CAAC;YACnE,KAAK,IAA2B,EAAE,CACjC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,CAAC;SAClD,CACD,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,MAAM,EACN,WAAW,EACX,8DAA8D,CAC9D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,MAAM,CAAC,OAAO,CACnB,iBAAiB,CAChB,KAAK,IAAI,EAAE,CACV,WAAW,CACV,mBAAmB,EACnB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,EACvC,MAAM,CAAC,iBAAiB,EAAE,CAC1B,EACF;YACC,KAAK,IAA2B,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC;YACrD,qFAAqF;YACrF,KAAK,IAA2B,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC;SACrD,CACD,EACD,2CAA2C,CAC3C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,CAAC,OAAO,CACnB,eAAe,CAAC,KAAK,IAAI,EAAE;YAC1B,OAAO,WAAW,CACjB,mBAAmB,EACnB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,EACvC,MAAM,CAAC,iBAAiB,EAAE,CAC1B,CAAC;QACH,CAAC,EAAE,QAAQ,CAAC,EACZ,wCAAwC,CACxC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,MAAM,iBAAiB,CACrC,KAAK,IAAI,EAAE,CACV,WAAW,CACV,mBAAmB,EACnB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,EACvC,MAAM,CAAC,iBAAiB,EAAE,CAC1B,EACF;YACC,KAAK,IAA2B,EAAE,CACjC,cAAc,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC;YAC3D,KAAK,IAA2B,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,gBAAgB,CAAC;YACnE,KAAK,IAA2B,EAAE,CACjC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,CAAC;SAClD,CACD,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,MAAM,EACN,WAAW,EACX,8DAA8D,CAC9D,CAAC;QACF,+EAA+E;QAC/E,MAAM,UAAU,GAAG,MAAM,WAAW,CACnC,mBAAmB,EACnB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,EACvC,MAAM,CAAC,iBAAiB,EAAE,CAC1B,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,UAAU,EACV,WAAW,EACX,yEAAyE,CACzE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,MAAM,CAAC,OAAO,CACnB,iBAAiB,CAChB,KAAK,IAAI,EAAE,CACV,WAAW,CACV,mBAAmB,EACnB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,EACvC,MAAM,CAAC,iBAAiB,EAAE,CAC1B,EACF;YACC,KAAK,IAA2B,EAAE,CACjC,cAAc,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC;YAC3D,KAAK,IAA2B,EAAE,CACjC,cAAc,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC;YAC3D,KAAK,IAA2B,EAAE,CACjC,cAAc,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC;YAC3D,KAAK,IAA2B,EAAE,CACjC,cAAc,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC;YAC3D,KAAK,IAA2B,EAAE,CACjC,cAAc,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC;SAC3D,CACD,EACD,yBAAyB,CACzB,CAAC;IACH,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 { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { getFileLink } from \"../getFileLink.js\";\nimport {\n\tmockFetchSingle,\n\tmockFetchMultiple,\n\tokResponse,\n\tnotFound,\n\tcreateResponse,\n\tMockResponse,\n} from \"./mockFetch.js\";\n\ndescribe(\"getFileLink\", () => {\n\tconst siteUrl = \"https://microsoft.sharepoint-df.com/siteUrl\";\n\tconst driveId = \"driveId\";\n\tconst logger = new MockLogger();\n\tconst storageTokenFetcher = async (): Promise<string> => \"StorageToken\";\n\tconst fileItemResponse = {\n\t\twebDavUrl: \"fetchDavUrl\",\n\t\twebUrl: \"fetchWebUrl\",\n\t\tsharepointIds: { listItemUniqueId: \"fetchFileId\" },\n\t};\n\n\tafterEach(() => {\n\t\tlogger.assertMatchNone([{ category: \"error\" }]);\n\t});\n\n\tit(\"should return share link with existing access\", async () => {\n\t\tconst result = await mockFetchMultiple(\n\t\t\tasync () =>\n\t\t\t\tgetFileLink(\n\t\t\t\t\tstorageTokenFetcher,\n\t\t\t\t\t{ siteUrl, driveId, itemId: \"itemId4\" },\n\t\t\t\t\tlogger.toTelemetryLogger(),\n\t\t\t\t),\n\t\t\t[\n\t\t\t\tasync (): Promise<MockResponse> => okResponse({}, fileItemResponse),\n\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\tokResponse({}, { d: { directUrl: \"sharelink\" } }),\n\t\t\t],\n\t\t);\n\t\tassert.strictEqual(\n\t\t\tresult,\n\t\t\t\"sharelink\",\n\t\t\t\"File link should match url returned from sharing information\",\n\t\t);\n\t});\n\n\tit(\"should reject if file web dav url is missing\", async () => {\n\t\tawait assert.rejects(\n\t\t\tmockFetchMultiple(\n\t\t\t\tasync () =>\n\t\t\t\t\tgetFileLink(\n\t\t\t\t\t\tstorageTokenFetcher,\n\t\t\t\t\t\t{ siteUrl, driveId, itemId: \"itemId5\" },\n\t\t\t\t\t\tlogger.toTelemetryLogger(),\n\t\t\t\t\t),\n\t\t\t\t[\n\t\t\t\t\tasync (): Promise<MockResponse> => okResponse({}, {}),\n\t\t\t\t\t// We retry once on malformed response from server, so need a second response mocked.\n\t\t\t\t\tasync (): Promise<MockResponse> => okResponse({}, {}),\n\t\t\t\t],\n\t\t\t),\n\t\t\t\"File link should reject for malformed url\",\n\t\t);\n\t});\n\n\tit(\"should reject if file item is not found\", async () => {\n\t\tawait assert.rejects(\n\t\t\tmockFetchSingle(async () => {\n\t\t\t\treturn getFileLink(\n\t\t\t\t\tstorageTokenFetcher,\n\t\t\t\t\t{ siteUrl, driveId, itemId: \"itemId6\" },\n\t\t\t\t\tlogger.toTelemetryLogger(),\n\t\t\t\t);\n\t\t\t}, notFound),\n\t\t\t\"File link should reject when not found\",\n\t\t);\n\t});\n\n\tit(\"should successfully retry\", async () => {\n\t\tconst result = await mockFetchMultiple(\n\t\t\tasync () =>\n\t\t\t\tgetFileLink(\n\t\t\t\t\tstorageTokenFetcher,\n\t\t\t\t\t{ siteUrl, driveId, itemId: \"itemId7\" },\n\t\t\t\t\tlogger.toTelemetryLogger(),\n\t\t\t\t),\n\t\t\t[\n\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\tcreateResponse({ \"retry-after\": \"0.001\" }, undefined, 900),\n\t\t\t\tasync (): Promise<MockResponse> => okResponse({}, fileItemResponse),\n\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\tokResponse({}, { d: { directUrl: \"sharelink\" } }),\n\t\t\t],\n\t\t);\n\t\tassert.strictEqual(\n\t\t\tresult,\n\t\t\t\"sharelink\",\n\t\t\t\"File link should match url returned from sharing information\",\n\t\t);\n\t\t// Should be present in cache now and subsequent calls should fetch from cache.\n\t\tconst sharelink2 = await getFileLink(\n\t\t\tstorageTokenFetcher,\n\t\t\t{ siteUrl, driveId, itemId: \"itemId7\" },\n\t\t\tlogger.toTelemetryLogger(),\n\t\t);\n\t\tassert.strictEqual(\n\t\t\tsharelink2,\n\t\t\t\"sharelink\",\n\t\t\t\"File link should match url returned from sharing information from cache\",\n\t\t);\n\t});\n\n\tit(\"should successfully give up after 5 tries\", async () => {\n\t\tawait assert.rejects(\n\t\t\tmockFetchMultiple(\n\t\t\t\tasync () =>\n\t\t\t\t\tgetFileLink(\n\t\t\t\t\t\tstorageTokenFetcher,\n\t\t\t\t\t\t{ siteUrl, driveId, itemId: \"itemId7\" },\n\t\t\t\t\t\tlogger.toTelemetryLogger(),\n\t\t\t\t\t),\n\t\t\t\t[\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tcreateResponse({ \"retry-after\": \"0.001\" }, undefined, 900),\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tcreateResponse({ \"retry-after\": \"0.001\" }, undefined, 900),\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tcreateResponse({ \"retry-after\": \"0.001\" }, undefined, 900),\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tcreateResponse({ \"retry-after\": \"0.001\" }, undefined, 900),\n\t\t\t\t\tasync (): Promise<MockResponse> =>\n\t\t\t\t\t\tcreateResponse({ \"retry-after\": \"0.001\" }, undefined, 900),\n\t\t\t\t],\n\t\t\t),\n\t\t\t\"did not retries 5 times\",\n\t\t);\n\t});\n});\n"]}

package/lib/test/getUrlAndHeadersWithAuth.spec.js

@@ -0,0 +1,66 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { getUrlAndHeadersWithAuth } from "../getUrlAndHeadersWithAuth.js";
+describe("getUrlAndHeadersWithAuth", () => {
+    const baseUrl = "https://contoso.sharepoint.com/_api/v2.1/drives/driveId/items/itemId/opstream";
+    const urlWithoutParams = new URL(baseUrl);
+    const urlWithSingleParam = new URL(`${baseUrl}?someParam=someValue`);
+    const urlWithMultipleParams = new URL(`${baseUrl}?param1=value1&param2=value2`);
+    // decrement by 1 to account for '?' character included in query string
+    const maxTokenLength = 2048 - "access_token=".length - 1;
+    const shortToken = generateToken(10);
+    function generateToken(length) {
+        return "a".repeat(length);
+    }
+    it("returns original url if token is null", async () => {
+        const { url, headers } = getUrlAndHeadersWithAuth(baseUrl, null, false);
+        assert.strictEqual(url, baseUrl, "Original and returned urls must match");
+        assert.deepStrictEqual(headers, {}, "Returned header must be empty");
+    });
+    it("returns original url if token is empty", async () => {
+        const { url, headers } = getUrlAndHeadersWithAuth(baseUrl, "", false);
+        assert.strictEqual(url, baseUrl, "Original and returned urls must match");
+        assert.deepStrictEqual(headers, {}, "Returned header must be empty");
+    });
+    const validateTokenEmbeddedIntoQueryString = (originalUrl, token, result) => {
+        const returnedUrl = new URL(result.url);
+        assert.strictEqual(returnedUrl.searchParams.get("access_token"), token, "Url must contain token in query string");
+        assert.deepStrictEqual(result.headers, {}, "Returned header must be empty");
+        returnedUrl.searchParams.delete("access_token");
+        assert.strictEqual(returnedUrl.href, originalUrl.href, "Returned url must match original url");
+    };
+    const validateTokenEmbeddedIntoHeaders = (originalUrl, token, result) => {
+        const returnedUrl = new URL(result.url);
+        assert.strictEqual(returnedUrl.searchParams.get("access_token"), null, "Url must not contain token in query string");
+        assert.strictEqual(result.headers.Authorization.endsWith(token), true, "Returned header must contain token");
+        assert.strictEqual(returnedUrl.href, originalUrl.href, "Returned url must match original url");
+    };
+    it("returns url with token embedded as part of query string when overall query string does not exceed 2048 characters", async () => {
+        validateTokenEmbeddedIntoQueryString(urlWithoutParams, shortToken, getUrlAndHeadersWithAuth(urlWithoutParams.href, shortToken, false));
+        validateTokenEmbeddedIntoQueryString(urlWithSingleParam, shortToken, getUrlAndHeadersWithAuth(urlWithSingleParam.href, shortToken, false));
+        validateTokenEmbeddedIntoQueryString(urlWithMultipleParams, shortToken, getUrlAndHeadersWithAuth(urlWithMultipleParams.href, shortToken, false));
+        const longTokenForUrlWithoutParams = generateToken(maxTokenLength);
+        validateTokenEmbeddedIntoQueryString(urlWithoutParams, longTokenForUrlWithoutParams, getUrlAndHeadersWithAuth(urlWithoutParams.href, longTokenForUrlWithoutParams, false));
+        const longTokenForUrlWithSingleParam = generateToken(maxTokenLength - urlWithSingleParam.search.length);
+        validateTokenEmbeddedIntoQueryString(urlWithSingleParam, longTokenForUrlWithSingleParam, getUrlAndHeadersWithAuth(urlWithSingleParam.href, longTokenForUrlWithSingleParam, false));
+        const longTokenForUrlMultipleParams = generateToken(maxTokenLength - urlWithMultipleParams.search.length);
+        validateTokenEmbeddedIntoQueryString(urlWithMultipleParams, longTokenForUrlMultipleParams, getUrlAndHeadersWithAuth(urlWithMultipleParams.href, longTokenForUrlMultipleParams, false));
+    });
+    it("returns headers with token embedded in Authorization header when overall query string exceeds 2048 characters", async () => {
+        const longTokenForUrlWithoutParams = generateToken(maxTokenLength + 1);
+        validateTokenEmbeddedIntoHeaders(urlWithoutParams, longTokenForUrlWithoutParams, getUrlAndHeadersWithAuth(urlWithoutParams.href, longTokenForUrlWithoutParams, false));
+        const longTokenForUrlWithSingleParam = generateToken(maxTokenLength - urlWithSingleParam.search.length + 1);
+        validateTokenEmbeddedIntoHeaders(urlWithSingleParam, longTokenForUrlWithSingleParam, getUrlAndHeadersWithAuth(urlWithSingleParam.href, longTokenForUrlWithSingleParam, false));
+        const longTokenForUrlMultipleParams = generateToken(maxTokenLength - urlWithMultipleParams.search.length + 1);
+        validateTokenEmbeddedIntoHeaders(urlWithMultipleParams, longTokenForUrlMultipleParams, getUrlAndHeadersWithAuth(urlWithMultipleParams.href, longTokenForUrlMultipleParams, false));
+    });
+    it("returns headers with token embedded in Authorization header when forced", async () => {
+        validateTokenEmbeddedIntoHeaders(urlWithoutParams, shortToken, getUrlAndHeadersWithAuth(urlWithoutParams.href, shortToken, true));
+        validateTokenEmbeddedIntoHeaders(urlWithSingleParam, shortToken, getUrlAndHeadersWithAuth(urlWithSingleParam.href, shortToken, true));
+        validateTokenEmbeddedIntoHeaders(urlWithMultipleParams, shortToken, getUrlAndHeadersWithAuth(urlWithMultipleParams.href, shortToken, true));
+    });
+});
+//# sourceMappingURL=getUrlAndHeadersWithAuth.spec.js.map