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

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

@@ -0,0 +1 @@
+{"version":3,"file":"getUrlAndHeadersWithAuth.spec.js","sourceRoot":"","sources":["../../src/test/getUrlAndHeadersWithAuth.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAE1E,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACzC,MAAM,OAAO,GAAG,+EAA+E,CAAC;IAChG,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,GAAG,OAAO,sBAAsB,CAAC,CAAC;IACrE,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,GAAG,OAAO,8BAA8B,CAAC,CAAC;IAChF,uEAAuE;IACvE,MAAM,cAAc,GAAG,IAAI,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;IACzD,MAAM,UAAU,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC;IAErC,SAAS,aAAa,CAAC,MAAc;QACpC,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACxE,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,uCAAuC,CAAC,CAAC;QAC1E,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,EAAE,+BAA+B,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACtE,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,uCAAuC,CAAC,CAAC;QAC1E,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,EAAE,+BAA+B,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,MAAM,oCAAoC,GAAG,CAC5C,WAAgB,EAChB,KAAa,EACb,MAA6D,EACtD,EAAE;QACT,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,EAC5C,KAAK,EACL,wCAAwC,CACxC,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,+BAA+B,CAAC,CAAC;QAC5E,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAChB,WAAW,CAAC,IAAI,EAChB,sCAAsC,CACtC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,gCAAgC,GAAG,CACxC,WAAgB,EAChB,KAAa,EACb,MAA6D,EACtD,EAAE;QACT,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,EAC5C,IAAI,EACJ,4CAA4C,CAC5C,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC5C,IAAI,EACJ,oCAAoC,CACpC,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAChB,WAAW,CAAC,IAAI,EAChB,sCAAsC,CACtC,CAAC;IACH,CAAC,CAAC;IAEF,EAAE,CAAC,mHAAmH,EAAE,KAAK,IAAI,EAAE;QAClI,oCAAoC,CACnC,gBAAgB,EAChB,UAAU,EACV,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAClE,CAAC;QAEF,oCAAoC,CACnC,kBAAkB,EAClB,UAAU,EACV,wBAAwB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CACpE,CAAC;QAEF,oCAAoC,CACnC,qBAAqB,EACrB,UAAU,EACV,wBAAwB,CAAC,qBAAqB,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CACvE,CAAC;QAEF,MAAM,4BAA4B,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;QACnE,oCAAoC,CACnC,gBAAgB,EAChB,4BAA4B,EAC5B,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,EAAE,4BAA4B,EAAE,KAAK,CAAC,CACpF,CAAC;QAEF,MAAM,8BAA8B,GAAG,aAAa,CACnD,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC,MAAM,CACjD,CAAC;QACF,oCAAoC,CACnC,kBAAkB,EAClB,8BAA8B,EAC9B,wBAAwB,CACvB,kBAAkB,CAAC,IAAI,EACvB,8BAA8B,EAC9B,KAAK,CACL,CACD,CAAC;QAEF,MAAM,6BAA6B,GAAG,aAAa,CAClD,cAAc,GAAG,qBAAqB,CAAC,MAAM,CAAC,MAAM,CACpD,CAAC;QACF,oCAAoC,CACnC,qBAAqB,EACrB,6BAA6B,EAC7B,wBAAwB,CACvB,qBAAqB,CAAC,IAAI,EAC1B,6BAA6B,EAC7B,KAAK,CACL,CACD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+GAA+G,EAAE,KAAK,IAAI,EAAE;QAC9H,MAAM,4BAA4B,GAAG,aAAa,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACvE,gCAAgC,CAC/B,gBAAgB,EAChB,4BAA4B,EAC5B,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,EAAE,4BAA4B,EAAE,KAAK,CAAC,CACpF,CAAC;QAEF,MAAM,8BAA8B,GAAG,aAAa,CACnD,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CACrD,CAAC;QACF,gCAAgC,CAC/B,kBAAkB,EAClB,8BAA8B,EAC9B,wBAAwB,CACvB,kBAAkB,CAAC,IAAI,EACvB,8BAA8B,EAC9B,KAAK,CACL,CACD,CAAC;QAEF,MAAM,6BAA6B,GAAG,aAAa,CAClD,cAAc,GAAG,qBAAqB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CACxD,CAAC;QACF,gCAAgC,CAC/B,qBAAqB,EACrB,6BAA6B,EAC7B,wBAAwB,CACvB,qBAAqB,CAAC,IAAI,EAC1B,6BAA6B,EAC7B,KAAK,CACL,CACD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACxF,gCAAgC,CAC/B,gBAAgB,EAChB,UAAU,EACV,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,CACjE,CAAC;QAEF,gCAAgC,CAC/B,kBAAkB,EAClB,UAAU,EACV,wBAAwB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,CACnE,CAAC;QAEF,gCAAgC,CAC/B,qBAAqB,EACrB,UAAU,EACV,wBAAwB,CAAC,qBAAqB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,CACtE,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 { getUrlAndHeadersWithAuth } from \"../getUrlAndHeadersWithAuth.js\";\n\ndescribe(\"getUrlAndHeadersWithAuth\", () => {\n\tconst baseUrl = \"https://contoso.sharepoint.com/_api/v2.1/drives/driveId/items/itemId/opstream\";\n\tconst urlWithoutParams = new URL(baseUrl);\n\tconst urlWithSingleParam = new URL(`${baseUrl}?someParam=someValue`);\n\tconst urlWithMultipleParams = new URL(`${baseUrl}?param1=value1&param2=value2`);\n\t// decrement by 1 to account for '?' character included in query string\n\tconst maxTokenLength = 2048 - \"access_token=\".length - 1;\n\tconst shortToken = generateToken(10);\n\n\tfunction generateToken(length: number): string {\n\t\treturn \"a\".repeat(length);\n\t}\n\n\tit(\"returns original url if token is null\", async () => {\n\t\tconst { url, headers } = getUrlAndHeadersWithAuth(baseUrl, null, false);\n\t\tassert.strictEqual(url, baseUrl, \"Original and returned urls must match\");\n\t\tassert.deepStrictEqual(headers, {}, \"Returned header must be empty\");\n\t});\n\n\tit(\"returns original url if token is empty\", async () => {\n\t\tconst { url, headers } = getUrlAndHeadersWithAuth(baseUrl, \"\", false);\n\t\tassert.strictEqual(url, baseUrl, \"Original and returned urls must match\");\n\t\tassert.deepStrictEqual(headers, {}, \"Returned header must be empty\");\n\t});\n\n\tconst validateTokenEmbeddedIntoQueryString = (\n\t\toriginalUrl: URL,\n\t\ttoken: string,\n\t\tresult: { url: string; headers: { [index: string]: string } },\n\t): void => {\n\t\tconst returnedUrl = new URL(result.url);\n\t\tassert.strictEqual(\n\t\t\treturnedUrl.searchParams.get(\"access_token\"),\n\t\t\ttoken,\n\t\t\t\"Url must contain token in query string\",\n\t\t);\n\t\tassert.deepStrictEqual(result.headers, {}, \"Returned header must be empty\");\n\t\treturnedUrl.searchParams.delete(\"access_token\");\n\t\tassert.strictEqual(\n\t\t\treturnedUrl.href,\n\t\t\toriginalUrl.href,\n\t\t\t\"Returned url must match original url\",\n\t\t);\n\t};\n\n\tconst validateTokenEmbeddedIntoHeaders = (\n\t\toriginalUrl: URL,\n\t\ttoken: string,\n\t\tresult: { url: string; headers: { [index: string]: string } },\n\t): void => {\n\t\tconst returnedUrl = new URL(result.url);\n\t\tassert.strictEqual(\n\t\t\treturnedUrl.searchParams.get(\"access_token\"),\n\t\t\tnull,\n\t\t\t\"Url must not contain token in query string\",\n\t\t);\n\t\tassert.strictEqual(\n\t\t\tresult.headers.Authorization.endsWith(token),\n\t\t\ttrue,\n\t\t\t\"Returned header must contain token\",\n\t\t);\n\t\tassert.strictEqual(\n\t\t\treturnedUrl.href,\n\t\t\toriginalUrl.href,\n\t\t\t\"Returned url must match original url\",\n\t\t);\n\t};\n\n\tit(\"returns url with token embedded as part of query string when overall query string does not exceed 2048 characters\", async () => {\n\t\tvalidateTokenEmbeddedIntoQueryString(\n\t\t\turlWithoutParams,\n\t\t\tshortToken,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithoutParams.href, shortToken, false),\n\t\t);\n\n\t\tvalidateTokenEmbeddedIntoQueryString(\n\t\t\turlWithSingleParam,\n\t\t\tshortToken,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithSingleParam.href, shortToken, false),\n\t\t);\n\n\t\tvalidateTokenEmbeddedIntoQueryString(\n\t\t\turlWithMultipleParams,\n\t\t\tshortToken,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithMultipleParams.href, shortToken, false),\n\t\t);\n\n\t\tconst longTokenForUrlWithoutParams = generateToken(maxTokenLength);\n\t\tvalidateTokenEmbeddedIntoQueryString(\n\t\t\turlWithoutParams,\n\t\t\tlongTokenForUrlWithoutParams,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithoutParams.href, longTokenForUrlWithoutParams, false),\n\t\t);\n\n\t\tconst longTokenForUrlWithSingleParam = generateToken(\n\t\t\tmaxTokenLength - urlWithSingleParam.search.length,\n\t\t);\n\t\tvalidateTokenEmbeddedIntoQueryString(\n\t\t\turlWithSingleParam,\n\t\t\tlongTokenForUrlWithSingleParam,\n\t\t\tgetUrlAndHeadersWithAuth(\n\t\t\t\turlWithSingleParam.href,\n\t\t\t\tlongTokenForUrlWithSingleParam,\n\t\t\t\tfalse,\n\t\t\t),\n\t\t);\n\n\t\tconst longTokenForUrlMultipleParams = generateToken(\n\t\t\tmaxTokenLength - urlWithMultipleParams.search.length,\n\t\t);\n\t\tvalidateTokenEmbeddedIntoQueryString(\n\t\t\turlWithMultipleParams,\n\t\t\tlongTokenForUrlMultipleParams,\n\t\t\tgetUrlAndHeadersWithAuth(\n\t\t\t\turlWithMultipleParams.href,\n\t\t\t\tlongTokenForUrlMultipleParams,\n\t\t\t\tfalse,\n\t\t\t),\n\t\t);\n\t});\n\n\tit(\"returns headers with token embedded in Authorization header when overall query string exceeds 2048 characters\", async () => {\n\t\tconst longTokenForUrlWithoutParams = generateToken(maxTokenLength + 1);\n\t\tvalidateTokenEmbeddedIntoHeaders(\n\t\t\turlWithoutParams,\n\t\t\tlongTokenForUrlWithoutParams,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithoutParams.href, longTokenForUrlWithoutParams, false),\n\t\t);\n\n\t\tconst longTokenForUrlWithSingleParam = generateToken(\n\t\t\tmaxTokenLength - urlWithSingleParam.search.length + 1,\n\t\t);\n\t\tvalidateTokenEmbeddedIntoHeaders(\n\t\t\turlWithSingleParam,\n\t\t\tlongTokenForUrlWithSingleParam,\n\t\t\tgetUrlAndHeadersWithAuth(\n\t\t\t\turlWithSingleParam.href,\n\t\t\t\tlongTokenForUrlWithSingleParam,\n\t\t\t\tfalse,\n\t\t\t),\n\t\t);\n\n\t\tconst longTokenForUrlMultipleParams = generateToken(\n\t\t\tmaxTokenLength - urlWithMultipleParams.search.length + 1,\n\t\t);\n\t\tvalidateTokenEmbeddedIntoHeaders(\n\t\t\turlWithMultipleParams,\n\t\t\tlongTokenForUrlMultipleParams,\n\t\t\tgetUrlAndHeadersWithAuth(\n\t\t\t\turlWithMultipleParams.href,\n\t\t\t\tlongTokenForUrlMultipleParams,\n\t\t\t\tfalse,\n\t\t\t),\n\t\t);\n\t});\n\n\tit(\"returns headers with token embedded in Authorization header when forced\", async () => {\n\t\tvalidateTokenEmbeddedIntoHeaders(\n\t\t\turlWithoutParams,\n\t\t\tshortToken,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithoutParams.href, shortToken, true),\n\t\t);\n\n\t\tvalidateTokenEmbeddedIntoHeaders(\n\t\t\turlWithSingleParam,\n\t\t\tshortToken,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithSingleParam.href, shortToken, true),\n\t\t);\n\n\t\tvalidateTokenEmbeddedIntoHeaders(\n\t\t\turlWithMultipleParams,\n\t\t\tshortToken,\n\t\t\tgetUrlAndHeadersWithAuth(urlWithMultipleParams.href, shortToken, true),\n\t\t);\n\t});\n});\n"]}

package/lib/test/getVersions.spec.js

@@ -0,0 +1,284 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { maximumCacheDurationMs, } from "@fluidframework/odsp-driver-definitions";
+import { createChildLogger } from "@fluidframework/telemetry-utils";
+import { delay } from "@fluidframework/core-utils";
+import { EpochTracker } from "../epochTracker.js";
+import { persistedCacheValueVersion, } from "../contracts.js";
+import { LocalPersistentCache, NonPersistentCache } from "../odspCache.js";
+import { createOdspUrl } from "../createOdspUrl.js";
+import { getHashedDocumentId } from "../odspPublicUtils.js";
+import { OdspDriverUrlResolver } from "../odspDriverUrlResolver.js";
+import { OdspDocumentStorageService, defaultSummarizerCacheExpiryTimeout, } from "../odspDocumentStorageManager.js";
+import { mockFetchSingle, notFound, createResponse } from "./mockFetch.js";
+const createUtLocalCache = () => new LocalPersistentCache();
+describe("Tests 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",
+    };
+    function GetHostStoragePolicyInternal(isSummarizer = false) {
+        return {
+            snapshotOptions: { timeout: 2000 },
+            summarizerClient: isSummarizer,
+            fetchBinarySnapshotFormat: false,
+            // for testing both network and cache fetch
+            concurrentSnapshotFetch: true,
+        };
+    }
+    const resolver = new OdspDriverUrlResolver();
+    const nonPersistentCache = new NonPersistentCache();
+    const logger = createChildLogger();
+    const odspUrl = createOdspUrl({ ...newFileParams, itemId, dataStorePath: "/" });
+    const odspSnapshot = {
+        id: "id",
+        trees: [
+            {
+                entries: [{ path: "path", type: "tree" }],
+                id: "id",
+                sequenceNumber: 1,
+            },
+        ],
+        blobs: [],
+    };
+    const content = {
+        snapshotTree: {
+            id: "id",
+            blobs: {},
+            trees: {},
+        },
+        blobContents: new Map(),
+        ops: [],
+        sequenceNumber: 0,
+        latestSequenceNumber: 0,
+        snapshotFormatV: 1,
+    };
+    const value = {
+        value: { ...content, cacheEntryTime: Date.now() },
+        fluidEpoch: "epoch1",
+        version: persistedCacheValueVersion,
+    };
+    // Set the cacheEntryTime to anything greater than the current maxCacheAge
+    function valueWithExpiredCache(cacheExpiryTimeoutMs) {
+        const versionedValue = {
+            value: { ...content, cacheEntryTime: Date.now() - cacheExpiryTimeoutMs - 1000 },
+            fluidEpoch: "epoch1",
+            version: persistedCacheValueVersion,
+        };
+        return versionedValue;
+    }
+    const expectedVersion = [{ id: "id", treeId: undefined }];
+    before(async () => {
+        hashedDocumentId = await getHashedDocumentId(driveId, itemId);
+    });
+    describe("Tests for caching of different file versions", () => {
+        beforeEach(async () => {
+            localCache = createUtLocalCache();
+            const resolvedUrlWithFileVersion = {
+                siteUrl,
+                driveId,
+                itemId,
+                odspResolvedUrl: true,
+                fileVersion: "2",
+                type: "fluid",
+                url: "",
+                hashedDocumentId,
+                endpoints: {
+                    snapshotStorageUrl: "fake",
+                    attachmentPOSTStorageUrl: "",
+                    attachmentGETStorageUrl: "",
+                    deltaStorageUrl: "",
+                },
+                tokens: {},
+                fileName: "",
+                summarizer: false,
+                id: "id",
+            };
+            epochTracker = new EpochTracker(localCache, {
+                docId: hashedDocumentId,
+                resolvedUrl,
+            }, createChildLogger());
+            service = new OdspDocumentStorageService(resolvedUrlWithFileVersion, async (_options) => "token", logger, true, { ...nonPersistentCache, persistedCache: epochTracker }, GetHostStoragePolicyInternal(), epochTracker, async () => {
+                return {};
+            }, () => "tenantid/id", undefined);
+        });
+        afterEach(async () => {
+            await epochTracker.removeEntries().catch(() => { });
+        });
+        it("should not fetch from cache with the same snapshot", async () => {
+            const latestContent = {
+                snapshotTree: {
+                    id: "WrongId",
+                    blobs: {},
+                    trees: {},
+                },
+                blobContents: new Map(),
+                ops: [],
+                sequenceNumber: 0,
+                latestSequenceNumber: 0,
+                snapshotFormatV: 1,
+            };
+            const latestValue = {
+                value: { ...latestContent, cacheEntryTime: Date.now() },
+                fluidEpoch: "epoch1",
+                version: persistedCacheValueVersion,
+            };
+            const cacheEntry = {
+                key: "",
+                type: "snapshot",
+                file: { docId: hashedDocumentId, resolvedUrl },
+            };
+            await localCache.put(cacheEntry, latestValue);
+            const version = await mockFetchSingle(async () => service.getVersions(null, 1), async () => {
+                await delay(50); // insure cache response is faster
+                return createResponse({ "x-fluid-epoch": "epoch1", "content-type": "application/json" }, odspSnapshot, 200);
+            });
+            assert.deepStrictEqual(version, expectedVersion, "incorrect version");
+        });
+    });
+    describe("Tests for regular snapshot fetch", () => {
+        beforeEach(async () => {
+            localCache = createUtLocalCache();
+            // use null logger here as we expect errors
+            epochTracker = new EpochTracker(localCache, {
+                docId: hashedDocumentId,
+                resolvedUrl,
+            }, createChildLogger());
+            const resolved = await resolver.resolve({ url: odspUrl });
+            service = new OdspDocumentStorageService(resolved, async (_options) => "token", logger, true, { ...nonPersistentCache, persistedCache: epochTracker }, GetHostStoragePolicyInternal(), epochTracker, async () => {
+                return {};
+            }, () => "tenantid/id", undefined);
+        });
+        afterEach(async () => {
+            await epochTracker.removeEntries().catch(() => { });
+        });
+        it("cache fetch throws and network fetch succeeds", async () => {
+            // overwriting get() to make cache fetch throw
+            localCache.get = async () => {
+                throw new Error("testing");
+            };
+            const version = await mockFetchSingle(async () => service.getVersions(null, 1), async () => createResponse({ "x-fluid-epoch": "epoch1", "content-type": "application/json" }, odspSnapshot, 200));
+            assert.deepStrictEqual(version, expectedVersion, "incorrect version");
+        });
+        it("cache fetch succeeds and network fetch succeeds", async () => {
+            const cacheEntry = {
+                key: "",
+                type: "snapshot",
+                file: { docId: hashedDocumentId, resolvedUrl },
+            };
+            await localCache.put(cacheEntry, value);
+            const version = await mockFetchSingle(async () => service.getVersions(null, 1), async () => createResponse({ "x-fluid-epoch": "epoch1" }, odspSnapshot, 200));
+            assert.deepStrictEqual(version, expectedVersion, "incorrect version");
+        });
+        it("cache fetch throws and network fetch throws", async () => {
+            // overwriting get() to make cache fetch throw
+            localCache.get = async () => {
+                throw new Error("testing");
+            };
+            await assert.rejects(async () => {
+                await mockFetchSingle(async () => service.getVersions(null, 1), 
+                // 404 response expected so network fetch throws
+                notFound);
+            }, /404/, "Expected 404 error to be thrown");
+        });
+        it("cache fetch succeeds and network fetch throws", async () => {
+            const cacheEntry = {
+                key: "",
+                type: "snapshot",
+                file: { docId: hashedDocumentId, resolvedUrl },
+            };
+            await localCache.put(cacheEntry, value);
+            const version = await mockFetchSingle(async () => service.getVersions(null, 1), 
+            // 404 response expected so network fetch throws
+            notFound);
+            assert.deepStrictEqual(version, expectedVersion, "incorrect version");
+        });
+        it("empty cache and network fetch throws", async () => {
+            await assert.rejects(async () => {
+                await mockFetchSingle(async () => service.getVersions(null, 1), 
+                // 404 response expected so network fetch throws
+                notFound);
+            }, /404/, "Expected 404 error to be thrown");
+        });
+        it("cache expires and network fetch succeeds", async () => {
+            const cacheEntry = {
+                key: "",
+                type: "snapshot",
+                file: { docId: hashedDocumentId, resolvedUrl },
+            };
+            await localCache.put(cacheEntry, valueWithExpiredCache(maximumCacheDurationMs));
+            const version = await mockFetchSingle(async () => service.getVersions(null, 1), async () => createResponse({ "x-fluid-epoch": "epoch1", "content-type": "application/json" }, odspSnapshot, 200));
+            assert.deepStrictEqual(version, expectedVersion, "incorrect version");
+        });
+        it("cache expires and network fetch throws", async () => {
+            const cacheEntry = {
+                key: "",
+                type: "snapshot",
+                file: { docId: hashedDocumentId, resolvedUrl },
+            };
+            await localCache.put(cacheEntry, valueWithExpiredCache(maximumCacheDurationMs));
+            await assert.rejects(async () => {
+                await mockFetchSingle(async () => service.getVersions(null, 1), 
+                // 404 response expected so network fetch throws
+                notFound);
+            }, /404/, "Expected 404 error to be thrown");
+        });
+    });
+    describe("Tests for snapshot fetch as Summarizer", () => {
+        beforeEach(async () => {
+            localCache = createUtLocalCache();
+            // use null logger here as we expect errors
+            epochTracker = new EpochTracker(localCache, {
+                docId: hashedDocumentId,
+                resolvedUrl,
+            }, createChildLogger());
+            const resolved = await resolver.resolve({ url: odspUrl });
+            service = new OdspDocumentStorageService(resolved, async (_options) => "token", logger, true, { ...nonPersistentCache, persistedCache: epochTracker }, GetHostStoragePolicyInternal(true /* isSummarizer */), epochTracker, async () => {
+                return {};
+            }, () => "tenantid/id");
+        });
+        afterEach(async () => {
+            await epochTracker.removeEntries().catch(() => { });
+        });
+        it("cache expires and network fetch succeeds", async () => {
+            const cacheEntry = {
+                key: "",
+                type: "snapshot",
+                file: { docId: hashedDocumentId, resolvedUrl },
+            };
+            await localCache.put(cacheEntry, valueWithExpiredCache(defaultSummarizerCacheExpiryTimeout));
+            const version = await mockFetchSingle(async () => service.getVersions(null, 1), async () => createResponse({ "x-fluid-epoch": "epoch1", "content-type": "application/json" }, odspSnapshot, 200));
+            assert.deepStrictEqual(version, expectedVersion, "incorrect version");
+        });
+        it("cache fetch succeeds", async () => {
+            const cacheEntry = {
+                key: "",
+                type: "snapshot",
+                file: { docId: hashedDocumentId, resolvedUrl },
+            };
+            await localCache.put(cacheEntry, valueWithExpiredCache(defaultSummarizerCacheExpiryTimeout - 5000));
+            assert.notEqual(cacheEntry, undefined, "Cache should have been restored");
+        });
+    });
+});
+//# sourceMappingURL=getVersions.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getVersions.spec.js","sourceRoot":"","sources":["../../src/test/getVersions.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAGN,sBAAsB,GACtB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAIN,0BAA0B,GAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE3E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EACN,0BAA0B,EAC1B,mCAAmC,GACnC,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE3E,MAAM,kBAAkB,GAAG,GAAyB,EAAE,CAAC,IAAI,oBAAoB,EAAE,CAAC;AAElF,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACzC,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,SAAS,4BAA4B,CACpC,eAAwB,KAAK;QAE7B,OAAO;YACN,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YAClC,gBAAgB,EAAE,YAAY;YAC9B,yBAAyB,EAAE,KAAK;YAChC,2CAA2C;YAC3C,uBAAuB,EAAE,IAAI;SAC7B,CAAC;IACH,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACpD,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;IACnC,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,GAAG,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;IAEhF,MAAM,YAAY,GAAkB;QACnC,EAAE,EAAE,IAAI;QACR,KAAK,EAAE;YACN;gBACC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;gBACzC,EAAE,EAAE,IAAI;gBACR,cAAc,EAAE,CAAC;aACjB;SACD;QACD,KAAK,EAAE,EAAE;KACT,CAAC;IAEF,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,MAAM,KAAK,GAA6B;QACvC,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE;QACjD,UAAU,EAAE,QAAQ;QACpB,OAAO,EAAE,0BAA0B;KACnC,CAAC;IAEF,0EAA0E;IAC1E,SAAS,qBAAqB,CAAC,oBAA4B;QAC1D,MAAM,cAAc,GAA6B;YAChD,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,oBAAoB,GAAG,IAAI,EAAE;YAC/E,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,0BAA0B;SACnC,CAAC;QACF,OAAO,cAAc,CAAC;IACvB,CAAC;IACD,MAAM,eAAe,GAAG,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,SAAU,EAAE,CAAC,CAAC;IAE3D,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8CAA8C,EAAE,GAAG,EAAE;QAC7D,UAAU,CAAC,KAAK,IAAI,EAAE;YACrB,UAAU,GAAG,kBAAkB,EAAE,CAAC;YAClC,MAAM,0BAA0B,GAAqB;gBACpD,OAAO;gBACP,OAAO;gBACP,MAAM;gBACN,eAAe,EAAE,IAAI;gBACrB,WAAW,EAAE,GAAG;gBAChB,IAAI,EAAE,OAAO;gBACb,GAAG,EAAE,EAAE;gBACP,gBAAgB;gBAChB,SAAS,EAAE;oBACV,kBAAkB,EAAE,MAAM;oBAC1B,wBAAwB,EAAE,EAAE;oBAC5B,uBAAuB,EAAE,EAAE;oBAC3B,eAAe,EAAE,EAAE;iBACnB;gBACD,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,EAAE;gBACZ,UAAU,EAAE,KAAK;gBACjB,EAAE,EAAE,IAAI;aACR,CAAC;YAEF,YAAY,GAAG,IAAI,YAAY,CAC9B,UAAU,EACV;gBACC,KAAK,EAAE,gBAAgB;gBACvB,WAAW;aACX,EACD,iBAAiB,EAAE,CACnB,CAAC;YAEF,OAAO,GAAG,IAAI,0BAA0B,CACvC,0BAA0B,EAC1B,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,MAAM,EACN,IAAI,EACJ,EAAE,GAAG,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,EACvD,4BAA4B,EAAE,EAC9B,YAAY,EACZ,KAAK,IAAI,EAAE;gBACV,OAAO,EAAE,CAAC;YACX,CAAC,EACD,GAAG,EAAE,CAAC,aAAa,EACnB,SAAS,CACT,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,aAAa,GAAc;gBAChC,YAAY,EAAE;oBACb,EAAE,EAAE,SAAS;oBACb,KAAK,EAAE,EAAE;oBACT,KAAK,EAAE,EAAE;iBACT;gBACD,YAAY,EAAE,IAAI,GAAG,EAAE;gBACvB,GAAG,EAAE,EAAE;gBACP,cAAc,EAAE,CAAC;gBACjB,oBAAoB,EAAE,CAAC;gBACvB,eAAe,EAAE,CAAC;aAClB,CAAC;YAEF,MAAM,WAAW,GAA6B;gBAC7C,KAAK,EAAE,EAAE,GAAG,aAAa,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE;gBACvD,UAAU,EAAE,QAAQ;gBACpB,OAAO,EAAE,0BAA0B;aACnC,CAAC;YAEF,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;aAC9C,CAAC;YAEF,MAAM,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAG,MAAM,eAAe,CACpC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EACxC,KAAK,IAAI,EAAE;gBACV,MAAM,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,kCAAkC;gBACnD,OAAO,cAAc,CACpB,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,kBAAkB,EAAE,EACjE,YAAY,EACZ,GAAG,CACH,CAAC;YACH,CAAC,CACD,CAAC;YAEF,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;QACjD,UAAU,CAAC,KAAK,IAAI,EAAE;YACrB,UAAU,GAAG,kBAAkB,EAAE,CAAC;YAClC,2CAA2C;YAC3C,YAAY,GAAG,IAAI,YAAY,CAC9B,UAAU,EACV;gBACC,KAAK,EAAE,gBAAgB;gBACvB,WAAW;aACX,EACD,iBAAiB,EAAE,CACnB,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1D,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,4BAA4B,EAAE,EAC9B,YAAY,EACZ,KAAK,IAAI,EAAE;gBACV,OAAO,EAAE,CAAC;YACX,CAAC,EACD,GAAG,EAAE,CAAC,aAAa,EACnB,SAAS,CACT,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC9D,8CAA8C;YAC9C,UAAU,CAAC,GAAG,GAAG,KAAK,IAAmB,EAAE;gBAC1C,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC,CAAC;YAEF,MAAM,OAAO,GAAG,MAAM,eAAe,CACpC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EACxC,KAAK,IAAI,EAAE,CACV,cAAc,CACb,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,kBAAkB,EAAE,EACjE,YAAY,EACZ,GAAG,CACH,CACF,CAAC;YAEF,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;aAC9C,CAAC;YACF,MAAM,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAExC,MAAM,OAAO,GAAG,MAAM,eAAe,CACpC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EACxC,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,CAC5E,CAAC;YACF,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC5D,8CAA8C;YAC9C,UAAU,CAAC,GAAG,GAAG,KAAK,IAAmB,EAAE;gBAC1C,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC,CAAC;YAEF,MAAM,MAAM,CAAC,OAAO,CACnB,KAAK,IAAI,EAAE;gBACV,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxC,gDAAgD;gBAChD,QAAQ,CACR,CAAC;YACH,CAAC,EACD,KAAK,EACL,iCAAiC,CACjC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC9D,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;aAC9C,CAAC;YACF,MAAM,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAExC,MAAM,OAAO,GAAG,MAAM,eAAe,CACpC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;YACxC,gDAAgD;YAChD,QAAQ,CACR,CAAC;YACF,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,MAAM,CAAC,OAAO,CACnB,KAAK,IAAI,EAAE;gBACV,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxC,gDAAgD;gBAChD,QAAQ,CACR,CAAC;YACH,CAAC,EACD,KAAK,EACL,iCAAiC,CACjC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;aAC9C,CAAC;YACF,MAAM,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,CAAC,CAAC;YAEhF,MAAM,OAAO,GAAG,MAAM,eAAe,CACpC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EACxC,KAAK,IAAI,EAAE,CACV,cAAc,CACb,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,kBAAkB,EAAE,EACjE,YAAY,EACZ,GAAG,CACH,CACF,CAAC;YACF,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;aAC9C,CAAC;YACF,MAAM,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,CAAC,CAAC;YAEhF,MAAM,MAAM,CAAC,OAAO,CACnB,KAAK,IAAI,EAAE;gBACV,MAAM,eAAe,CACpB,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxC,gDAAgD;gBAChD,QAAQ,CACR,CAAC;YACH,CAAC,EACD,KAAK,EACL,iCAAiC,CACjC,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;QACvD,UAAU,CAAC,KAAK,IAAI,EAAE;YACrB,UAAU,GAAG,kBAAkB,EAAE,CAAC;YAClC,2CAA2C;YAC3C,YAAY,GAAG,IAAI,YAAY,CAC9B,UAAU,EACV;gBACC,KAAK,EAAE,gBAAgB;gBACvB,WAAW;aACX,EACD,iBAAiB,EAAE,CACnB,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1D,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,4BAA4B,CAAC,IAAI,CAAC,kBAAkB,CAAC,EACrD,YAAY,EACZ,KAAK,IAAI,EAAE;gBACV,OAAO,EAAE,CAAC;YACX,CAAC,EACD,GAAG,EAAE,CAAC,aAAa,CACnB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;aAC9C,CAAC;YACF,MAAM,UAAU,CAAC,GAAG,CACnB,UAAU,EACV,qBAAqB,CAAC,mCAAmC,CAAC,CAC1D,CAAC;YAEF,MAAM,OAAO,GAAG,MAAM,eAAe,CACpC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EACxC,KAAK,IAAI,EAAE,CACV,cAAc,CACb,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,kBAAkB,EAAE,EACjE,YAAY,EACZ,GAAG,CACH,CACF,CAAC;YACF,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACrC,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE;aAC9C,CAAC;YACF,MAAM,UAAU,CAAC,GAAG,CACnB,UAAU,EACV,qBAAqB,CAAC,mCAAmC,GAAG,IAAI,CAAC,CACjE,CAAC;YAEF,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,iCAAiC,CAAC,CAAC;QAC3E,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 { ISnapshot } from \"@fluidframework/driver-definitions\";\nimport {\n\tIOdspResolvedUrl,\n\tICacheEntry,\n\tmaximumCacheDurationMs,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { delay } from \"@fluidframework/core-utils\";\nimport { EpochTracker } from \"../epochTracker.js\";\nimport {\n\tIOdspSnapshot,\n\tHostStoragePolicyInternal,\n\tIVersionedValueWithEpoch,\n\tpersistedCacheValueVersion,\n} from \"../contracts.js\";\nimport { LocalPersistentCache, NonPersistentCache } from \"../odspCache.js\";\nimport { INewFileInfo } from \"../odspUtils.js\";\nimport { createOdspUrl } from \"../createOdspUrl.js\";\nimport { getHashedDocumentId } from \"../odspPublicUtils.js\";\nimport { OdspDriverUrlResolver } from \"../odspDriverUrlResolver.js\";\nimport {\n\tOdspDocumentStorageService,\n\tdefaultSummarizerCacheExpiryTimeout,\n} from \"../odspDocumentStorageManager.js\";\nimport { mockFetchSingle, notFound, createResponse } from \"./mockFetch.js\";\n\nconst createUtLocalCache = (): LocalPersistentCache => new LocalPersistentCache();\n\ndescribe(\"Tests 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\tfunction GetHostStoragePolicyInternal(\n\t\tisSummarizer: boolean = false,\n\t): HostStoragePolicyInternal {\n\t\treturn {\n\t\t\tsnapshotOptions: { timeout: 2000 },\n\t\t\tsummarizerClient: isSummarizer,\n\t\t\tfetchBinarySnapshotFormat: false,\n\t\t\t// for testing both network and cache fetch\n\t\t\tconcurrentSnapshotFetch: true,\n\t\t};\n\t}\n\tconst resolver = new OdspDriverUrlResolver();\n\tconst nonPersistentCache = new NonPersistentCache();\n\tconst logger = createChildLogger();\n\tconst odspUrl = createOdspUrl({ ...newFileParams, itemId, dataStorePath: \"/\" });\n\n\tconst odspSnapshot: IOdspSnapshot = {\n\t\tid: \"id\",\n\t\ttrees: [\n\t\t\t{\n\t\t\t\tentries: [{ path: \"path\", type: \"tree\" }],\n\t\t\t\tid: \"id\",\n\t\t\t\tsequenceNumber: 1,\n\t\t\t},\n\t\t],\n\t\tblobs: [],\n\t};\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\tconst value: IVersionedValueWithEpoch = {\n\t\tvalue: { ...content, cacheEntryTime: Date.now() },\n\t\tfluidEpoch: \"epoch1\",\n\t\tversion: persistedCacheValueVersion,\n\t};\n\n\t// Set the cacheEntryTime to anything greater than the current maxCacheAge\n\tfunction valueWithExpiredCache(cacheExpiryTimeoutMs: number): IVersionedValueWithEpoch {\n\t\tconst versionedValue: IVersionedValueWithEpoch = {\n\t\t\tvalue: { ...content, cacheEntryTime: Date.now() - cacheExpiryTimeoutMs - 1000 },\n\t\t\tfluidEpoch: \"epoch1\",\n\t\t\tversion: persistedCacheValueVersion,\n\t\t};\n\t\treturn versionedValue;\n\t}\n\tconst expectedVersion = [{ id: \"id\", treeId: undefined! }];\n\n\tbefore(async () => {\n\t\thashedDocumentId = await getHashedDocumentId(driveId, itemId);\n\t});\n\n\tdescribe(\"Tests for caching of different file versions\", () => {\n\t\tbeforeEach(async () => {\n\t\t\tlocalCache = createUtLocalCache();\n\t\t\tconst resolvedUrlWithFileVersion: IOdspResolvedUrl = {\n\t\t\t\tsiteUrl,\n\t\t\t\tdriveId,\n\t\t\t\titemId,\n\t\t\t\todspResolvedUrl: true,\n\t\t\t\tfileVersion: \"2\",\n\t\t\t\ttype: \"fluid\",\n\t\t\t\turl: \"\",\n\t\t\t\thashedDocumentId,\n\t\t\t\tendpoints: {\n\t\t\t\t\tsnapshotStorageUrl: \"fake\",\n\t\t\t\t\tattachmentPOSTStorageUrl: \"\",\n\t\t\t\t\tattachmentGETStorageUrl: \"\",\n\t\t\t\t\tdeltaStorageUrl: \"\",\n\t\t\t\t},\n\t\t\t\ttokens: {},\n\t\t\t\tfileName: \"\",\n\t\t\t\tsummarizer: false,\n\t\t\t\tid: \"id\",\n\t\t\t};\n\n\t\t\tepochTracker = new EpochTracker(\n\t\t\t\tlocalCache,\n\t\t\t\t{\n\t\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\t\tresolvedUrl,\n\t\t\t\t},\n\t\t\t\tcreateChildLogger(),\n\t\t\t);\n\n\t\t\tservice = new OdspDocumentStorageService(\n\t\t\t\tresolvedUrlWithFileVersion,\n\t\t\t\tasync (_options) => \"token\",\n\t\t\t\tlogger,\n\t\t\t\ttrue,\n\t\t\t\t{ ...nonPersistentCache, persistedCache: epochTracker },\n\t\t\t\tGetHostStoragePolicyInternal(),\n\t\t\t\tepochTracker,\n\t\t\t\tasync () => {\n\t\t\t\t\treturn {};\n\t\t\t\t},\n\t\t\t\t() => \"tenantid/id\",\n\t\t\t\tundefined,\n\t\t\t);\n\t\t});\n\n\t\tafterEach(async () => {\n\t\t\tawait epochTracker.removeEntries().catch(() => {});\n\t\t});\n\n\t\tit(\"should not fetch from cache with the same snapshot\", async () => {\n\t\t\tconst latestContent: ISnapshot = {\n\t\t\t\tsnapshotTree: {\n\t\t\t\t\tid: \"WrongId\",\n\t\t\t\t\tblobs: {},\n\t\t\t\t\ttrees: {},\n\t\t\t\t},\n\t\t\t\tblobContents: new Map(),\n\t\t\t\tops: [],\n\t\t\t\tsequenceNumber: 0,\n\t\t\t\tlatestSequenceNumber: 0,\n\t\t\t\tsnapshotFormatV: 1,\n\t\t\t};\n\n\t\t\tconst latestValue: IVersionedValueWithEpoch = {\n\t\t\t\tvalue: { ...latestContent, cacheEntryTime: Date.now() },\n\t\t\t\tfluidEpoch: \"epoch1\",\n\t\t\t\tversion: persistedCacheValueVersion,\n\t\t\t};\n\n\t\t\tconst cacheEntry: ICacheEntry = {\n\t\t\t\tkey: \"\",\n\t\t\t\ttype: \"snapshot\",\n\t\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t\t};\n\n\t\t\tawait localCache.put(cacheEntry, latestValue);\n\n\t\t\tconst version = await mockFetchSingle(\n\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\tasync () => {\n\t\t\t\t\tawait delay(50); // insure cache response is faster\n\t\t\t\t\treturn createResponse(\n\t\t\t\t\t\t{ \"x-fluid-epoch\": \"epoch1\", \"content-type\": \"application/json\" },\n\t\t\t\t\t\todspSnapshot,\n\t\t\t\t\t\t200,\n\t\t\t\t\t);\n\t\t\t\t},\n\t\t\t);\n\n\t\t\tassert.deepStrictEqual(version, expectedVersion, \"incorrect version\");\n\t\t});\n\t});\n\n\tdescribe(\"Tests for regular snapshot fetch\", () => {\n\t\tbeforeEach(async () => {\n\t\t\tlocalCache = createUtLocalCache();\n\t\t\t// use null logger here as we expect errors\n\t\t\tepochTracker = new EpochTracker(\n\t\t\t\tlocalCache,\n\t\t\t\t{\n\t\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\t\tresolvedUrl,\n\t\t\t\t},\n\t\t\t\tcreateChildLogger(),\n\t\t\t);\n\n\t\t\tconst resolved = await resolver.resolve({ url: odspUrl });\n\t\t\tservice = new OdspDocumentStorageService(\n\t\t\t\tresolved,\n\t\t\t\tasync (_options) => \"token\",\n\t\t\t\tlogger,\n\t\t\t\ttrue,\n\t\t\t\t{ ...nonPersistentCache, persistedCache: epochTracker },\n\t\t\t\tGetHostStoragePolicyInternal(),\n\t\t\t\tepochTracker,\n\t\t\t\tasync () => {\n\t\t\t\t\treturn {};\n\t\t\t\t},\n\t\t\t\t() => \"tenantid/id\",\n\t\t\t\tundefined,\n\t\t\t);\n\t\t});\n\n\t\tafterEach(async () => {\n\t\t\tawait epochTracker.removeEntries().catch(() => {});\n\t\t});\n\n\t\tit(\"cache fetch throws and network fetch succeeds\", async () => {\n\t\t\t// overwriting get() to make cache fetch throw\n\t\t\tlocalCache.get = async (): Promise<void> => {\n\t\t\t\tthrow new Error(\"testing\");\n\t\t\t};\n\n\t\t\tconst version = await mockFetchSingle(\n\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\tasync () =>\n\t\t\t\t\tcreateResponse(\n\t\t\t\t\t\t{ \"x-fluid-epoch\": \"epoch1\", \"content-type\": \"application/json\" },\n\t\t\t\t\t\todspSnapshot,\n\t\t\t\t\t\t200,\n\t\t\t\t\t),\n\t\t\t);\n\n\t\t\tassert.deepStrictEqual(version, expectedVersion, \"incorrect version\");\n\t\t});\n\n\t\tit(\"cache fetch succeeds and network fetch succeeds\", async () => {\n\t\t\tconst cacheEntry: ICacheEntry = {\n\t\t\t\tkey: \"\",\n\t\t\t\ttype: \"snapshot\",\n\t\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t\t};\n\t\t\tawait localCache.put(cacheEntry, value);\n\n\t\t\tconst version = await mockFetchSingle(\n\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\tasync () => createResponse({ \"x-fluid-epoch\": \"epoch1\" }, odspSnapshot, 200),\n\t\t\t);\n\t\t\tassert.deepStrictEqual(version, expectedVersion, \"incorrect version\");\n\t\t});\n\n\t\tit(\"cache fetch throws and network fetch throws\", async () => {\n\t\t\t// overwriting get() to make cache fetch throw\n\t\t\tlocalCache.get = async (): Promise<void> => {\n\t\t\t\tthrow new Error(\"testing\");\n\t\t\t};\n\n\t\t\tawait assert.rejects(\n\t\t\t\tasync () => {\n\t\t\t\t\tawait mockFetchSingle(\n\t\t\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\t\t\t// 404 response expected so network fetch throws\n\t\t\t\t\t\tnotFound,\n\t\t\t\t\t);\n\t\t\t\t},\n\t\t\t\t/404/,\n\t\t\t\t\"Expected 404 error to be thrown\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"cache fetch succeeds and network fetch throws\", async () => {\n\t\t\tconst cacheEntry: ICacheEntry = {\n\t\t\t\tkey: \"\",\n\t\t\t\ttype: \"snapshot\",\n\t\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t\t};\n\t\t\tawait localCache.put(cacheEntry, value);\n\n\t\t\tconst version = await mockFetchSingle(\n\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\t// 404 response expected so network fetch throws\n\t\t\t\tnotFound,\n\t\t\t);\n\t\t\tassert.deepStrictEqual(version, expectedVersion, \"incorrect version\");\n\t\t});\n\n\t\tit(\"empty cache and network fetch throws\", async () => {\n\t\t\tawait assert.rejects(\n\t\t\t\tasync () => {\n\t\t\t\t\tawait mockFetchSingle(\n\t\t\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\t\t\t// 404 response expected so network fetch throws\n\t\t\t\t\t\tnotFound,\n\t\t\t\t\t);\n\t\t\t\t},\n\t\t\t\t/404/,\n\t\t\t\t\"Expected 404 error to be thrown\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"cache expires and network fetch succeeds\", async () => {\n\t\t\tconst cacheEntry: ICacheEntry = {\n\t\t\t\tkey: \"\",\n\t\t\t\ttype: \"snapshot\",\n\t\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t\t};\n\t\t\tawait localCache.put(cacheEntry, valueWithExpiredCache(maximumCacheDurationMs));\n\n\t\t\tconst version = await mockFetchSingle(\n\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\tasync () =>\n\t\t\t\t\tcreateResponse(\n\t\t\t\t\t\t{ \"x-fluid-epoch\": \"epoch1\", \"content-type\": \"application/json\" },\n\t\t\t\t\t\todspSnapshot,\n\t\t\t\t\t\t200,\n\t\t\t\t\t),\n\t\t\t);\n\t\t\tassert.deepStrictEqual(version, expectedVersion, \"incorrect version\");\n\t\t});\n\n\t\tit(\"cache expires and network fetch throws\", async () => {\n\t\t\tconst cacheEntry: ICacheEntry = {\n\t\t\t\tkey: \"\",\n\t\t\t\ttype: \"snapshot\",\n\t\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t\t};\n\t\t\tawait localCache.put(cacheEntry, valueWithExpiredCache(maximumCacheDurationMs));\n\n\t\t\tawait assert.rejects(\n\t\t\t\tasync () => {\n\t\t\t\t\tawait mockFetchSingle(\n\t\t\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\t\t\t// 404 response expected so network fetch throws\n\t\t\t\t\t\tnotFound,\n\t\t\t\t\t);\n\t\t\t\t},\n\t\t\t\t/404/,\n\t\t\t\t\"Expected 404 error to be thrown\",\n\t\t\t);\n\t\t});\n\t});\n\tdescribe(\"Tests for snapshot fetch as Summarizer\", () => {\n\t\tbeforeEach(async () => {\n\t\t\tlocalCache = createUtLocalCache();\n\t\t\t// use null logger here as we expect errors\n\t\t\tepochTracker = new EpochTracker(\n\t\t\t\tlocalCache,\n\t\t\t\t{\n\t\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\t\tresolvedUrl,\n\t\t\t\t},\n\t\t\t\tcreateChildLogger(),\n\t\t\t);\n\n\t\t\tconst resolved = await resolver.resolve({ url: odspUrl });\n\t\t\tservice = new OdspDocumentStorageService(\n\t\t\t\tresolved,\n\t\t\t\tasync (_options) => \"token\",\n\t\t\t\tlogger,\n\t\t\t\ttrue,\n\t\t\t\t{ ...nonPersistentCache, persistedCache: epochTracker },\n\t\t\t\tGetHostStoragePolicyInternal(true /* isSummarizer */),\n\t\t\t\tepochTracker,\n\t\t\t\tasync () => {\n\t\t\t\t\treturn {};\n\t\t\t\t},\n\t\t\t\t() => \"tenantid/id\",\n\t\t\t);\n\t\t});\n\n\t\tafterEach(async () => {\n\t\t\tawait epochTracker.removeEntries().catch(() => {});\n\t\t});\n\n\t\tit(\"cache expires and network fetch succeeds\", async () => {\n\t\t\tconst cacheEntry: ICacheEntry = {\n\t\t\t\tkey: \"\",\n\t\t\t\ttype: \"snapshot\",\n\t\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t\t};\n\t\t\tawait localCache.put(\n\t\t\t\tcacheEntry,\n\t\t\t\tvalueWithExpiredCache(defaultSummarizerCacheExpiryTimeout),\n\t\t\t);\n\n\t\t\tconst version = await mockFetchSingle(\n\t\t\t\tasync () => service.getVersions(null, 1),\n\t\t\t\tasync () =>\n\t\t\t\t\tcreateResponse(\n\t\t\t\t\t\t{ \"x-fluid-epoch\": \"epoch1\", \"content-type\": \"application/json\" },\n\t\t\t\t\t\todspSnapshot,\n\t\t\t\t\t\t200,\n\t\t\t\t\t),\n\t\t\t);\n\t\t\tassert.deepStrictEqual(version, expectedVersion, \"incorrect version\");\n\t\t});\n\n\t\tit(\"cache fetch succeeds\", async () => {\n\t\t\tconst cacheEntry: ICacheEntry = {\n\t\t\t\tkey: \"\",\n\t\t\t\ttype: \"snapshot\",\n\t\t\t\tfile: { docId: hashedDocumentId, resolvedUrl },\n\t\t\t};\n\t\t\tawait localCache.put(\n\t\t\t\tcacheEntry,\n\t\t\t\tvalueWithExpiredCache(defaultSummarizerCacheExpiryTimeout - 5000),\n\t\t\t);\n\n\t\t\tassert.notEqual(cacheEntry, undefined, \"Cache should have been restored\");\n\t\t});\n\t});\n});\n"]}

package/lib/test/joinSessionCacheTests.spec.js

@@ -0,0 +1,53 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { OdspDocumentServiceFactory } from "../odspDocumentServiceFactory.js";
+import { getJoinSessionCacheKey } from "../odspUtils.js";
+describe("expose joinSessionInfo Tests", () => {
+    const siteUrl = "https://www.localhost.xxx";
+    const driveId = "driveId";
+    const itemId = "itemId";
+    const resolvedUrl = {
+        siteUrl,
+        driveId,
+        itemId,
+        odspResolvedUrl: true,
+    };
+    const joinSessionResponse = {
+        deltaStorageUrl: "https://fake/deltaStorageUrl",
+        deltaStreamSocketUrl: "https://localhost:3001",
+        id: "id",
+        tenantId: "tenantId",
+        snapshotStorageUrl: "https://fake/snapshotStorageUrl",
+        refreshSessionDurationSeconds: 100,
+    };
+    const odspDocumentServiceFactory = new OdspDocumentServiceFactory(async (_options) => "token", async (_options) => "token");
+    it("Response missing in join session cache", async () => {
+        const info = await odspDocumentServiceFactory.getRelayServiceSessionInfo(resolvedUrl);
+        assert(info === undefined, "no cached response");
+    });
+    it("Response present in join session cache", async () => {
+        // eslint-disable-next-line @typescript-eslint/dot-notation, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+        odspDocumentServiceFactory["nonPersistentCache"].sessionJoinCache.add(getJoinSessionCacheKey(resolvedUrl), async () => {
+            return { entryTime: Date.now(), joinSessionResponse };
+        });
+        const info = await odspDocumentServiceFactory.getRelayServiceSessionInfo(resolvedUrl);
+        assert.deepStrictEqual(info, joinSessionResponse, "cached response should be present");
+    });
+    it("should throw error is resolved url is not odspResolvedUrl", async () => {
+        let failed = false;
+        try {
+            await odspDocumentServiceFactory.getRelayServiceSessionInfo({
+                ...resolvedUrl,
+                odspResolvedUrl: false,
+            });
+        }
+        catch {
+            failed = true;
+        }
+        assert(failed, "resolved url not correct");
+    });
+});
+//# sourceMappingURL=joinSessionCacheTests.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"joinSessionCacheTests.spec.js","sourceRoot":"","sources":["../../src/test/joinSessionCacheTests.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC7C,MAAM,OAAO,GAAG,2BAA2B,CAAC;IAC5C,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC;IAExB,MAAM,WAAW,GAAG;QACnB,OAAO;QACP,OAAO;QACP,MAAM;QACN,eAAe,EAAE,IAAI;KACU,CAAC;IAEjC,MAAM,mBAAmB,GAA4B;QACpD,eAAe,EAAE,8BAA8B;QAC/C,oBAAoB,EAAE,wBAAwB;QAC9C,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,UAAU;QACpB,kBAAkB,EAAE,iCAAiC;QACrD,6BAA6B,EAAE,GAAG;KAClC,CAAC;IACF,MAAM,0BAA0B,GAAG,IAAI,0BAA0B,CAChE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAC3B,CAAC;IAEF,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,IAAI,GAAG,MAAM,0BAA0B,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;QACtF,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACvD,0IAA0I;QAC1I,0BAA0B,CAAC,oBAAoB,CAAC,CAAC,gBAAgB,CAAC,GAAG,CACpE,sBAAsB,CAAC,WAAW,CAAC,EACnC,KAAK,IAAI,EAAE;YACV,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,mBAAmB,EAAE,CAAC;QACvD,CAAC,CACD,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,0BAA0B,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;QACtF,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,mBAAmB,EAAE,mCAAmC,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAC1E,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI;YACH,MAAM,0BAA0B,CAAC,0BAA0B,CAAC;gBAC3D,GAAG,WAAW;gBACd,eAAe,EAAE,KAAK;aACK,CAAC,CAAC;SAC9B;QAAC,MAAM;YACP,MAAM,GAAG,IAAI,CAAC;SACd;QACD,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IAC5C,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 type { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl, ISocketStorageDiscovery } from \"@fluidframework/odsp-driver-definitions\";\nimport { OdspDocumentServiceFactory } from \"../odspDocumentServiceFactory.js\";\nimport { getJoinSessionCacheKey } from \"../odspUtils.js\";\n\ndescribe(\"expose joinSessionInfo Tests\", () => {\n\tconst siteUrl = \"https://www.localhost.xxx\";\n\tconst driveId = \"driveId\";\n\tconst itemId = \"itemId\";\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 joinSessionResponse: ISocketStorageDiscovery = {\n\t\tdeltaStorageUrl: \"https://fake/deltaStorageUrl\",\n\t\tdeltaStreamSocketUrl: \"https://localhost:3001\",\n\t\tid: \"id\",\n\t\ttenantId: \"tenantId\",\n\t\tsnapshotStorageUrl: \"https://fake/snapshotStorageUrl\",\n\t\trefreshSessionDurationSeconds: 100,\n\t};\n\tconst odspDocumentServiceFactory = new OdspDocumentServiceFactory(\n\t\tasync (_options) => \"token\",\n\t\tasync (_options) => \"token\",\n\t);\n\n\tit(\"Response missing in join session cache\", async () => {\n\t\tconst info = await odspDocumentServiceFactory.getRelayServiceSessionInfo(resolvedUrl);\n\t\tassert(info === undefined, \"no cached response\");\n\t});\n\n\tit(\"Response present in join session cache\", async () => {\n\t\t// eslint-disable-next-line @typescript-eslint/dot-notation, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call\n\t\todspDocumentServiceFactory[\"nonPersistentCache\"].sessionJoinCache.add(\n\t\t\tgetJoinSessionCacheKey(resolvedUrl),\n\t\t\tasync () => {\n\t\t\t\treturn { entryTime: Date.now(), joinSessionResponse };\n\t\t\t},\n\t\t);\n\t\tconst info = await odspDocumentServiceFactory.getRelayServiceSessionInfo(resolvedUrl);\n\t\tassert.deepStrictEqual(info, joinSessionResponse, \"cached response should be present\");\n\t});\n\n\tit(\"should throw error is resolved url is not odspResolvedUrl\", async () => {\n\t\tlet failed = false;\n\t\ttry {\n\t\t\tawait odspDocumentServiceFactory.getRelayServiceSessionInfo({\n\t\t\t\t...resolvedUrl,\n\t\t\t\todspResolvedUrl: false,\n\t\t\t} as unknown as IResolvedUrl);\n\t\t} catch {\n\t\t\tfailed = true;\n\t\t}\n\t\tassert(failed, \"resolved url not correct\");\n\t});\n});\n"]}

package/lib/test/joinSessionPeriodicCall.spec.js

@@ -0,0 +1,158 @@
+/*!
+ * 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 { stub, useFakeTimers } from "sinon";
+import * as odspDocumentDeltaConnection from "../odspDocumentDeltaConnection.js";
+import * as joinSession from "../vroom.js";
+import { OdspDocumentServiceFactory } from "../odspDocumentServiceFactory.js";
+import { LocalPersistentCache } from "../odspCache.js";
+import { createOdspUrl } from "../createOdspUrl.js";
+import { OdspDriverUrlResolver } from "../odspDriverUrlResolver.js";
+describe("joinSessions Tests", () => {
+    let clock;
+    const siteUrl = "https://www.localhost.xxx";
+    const driveId = "driveId";
+    const resolver = new OdspDriverUrlResolver();
+    const itemId = "itemId";
+    let service;
+    let logger;
+    const client = {
+        mode: "read",
+        details: { capabilities: { interactive: true } },
+        permission: [],
+        user: { id: "id" },
+        scopes: [],
+    };
+    let deltaConnection;
+    const joinSessionResponse = {
+        deltaStorageUrl: "https://fake/deltaStorageUrl",
+        deltaStreamSocketUrl: "https://localhost:3001",
+        id: "id",
+        tenantId: "tenantId",
+        snapshotStorageUrl: "https://fake/snapshotStorageUrl",
+        refreshSessionDurationSeconds: 100,
+    };
+    let odspDocumentServiceFactory;
+    // Stash the real setTimeout because sinon fake timers will hijack it.
+    const realSetTimeout = setTimeout;
+    // function to yield control in the Javascript event loop.
+    async function yieldEventLoop() {
+        await new Promise((resolve) => {
+            realSetTimeout(resolve, 0);
+        });
+    }
+    async function tickClock(tickValue) {
+        clock.tick(tickValue);
+        // Yield the event loop because the outbound op will be processed asynchronously.
+        await yieldEventLoop();
+    }
+    function addJoinSessionStub(time) {
+        joinSessionResponse.refreshSessionDurationSeconds = time;
+        const joinSessionStub = stub(joinSession, "fetchJoinSession").callsFake(async () => joinSessionResponse);
+        return joinSessionStub;
+    }
+    before(async () => {
+        clock = useFakeTimers();
+    });
+    beforeEach(async () => {
+        odspDocumentServiceFactory = new OdspDocumentServiceFactory(async (_options) => "token", async (_options) => "token", new LocalPersistentCache(2000), { snapshotOptions: { timeout: 2000 } });
+        const locator = { driveId, itemId, siteUrl, dataStorePath: "/" };
+        const request = createOdspUrl(locator);
+        const resolvedUrl = await resolver.resolve({ url: request });
+        logger = new MockLogger();
+        service = (await odspDocumentServiceFactory.createDocumentService(resolvedUrl, logger));
+        deltaConnection = {
+            clientId: "clientId",
+            existing: true,
+            initialClients: [],
+            initialMessages: [],
+            initialSignals: [],
+            version: "1.0",
+            mode: "write",
+            claims: {
+                documentId: "docId",
+                exp: 0,
+                iat: 0,
+                scopes: [],
+                tenantId: "ten",
+                ver: "ver",
+                user: {
+                    id: "id",
+                },
+            },
+            serviceConfiguration: {
+                blockSize: 100,
+                maxMessageSize: 16000,
+                summary: {
+                    minIdleTime: 0,
+                    maxIdleTime: 0,
+                    maxAckWaitTime: 0,
+                    maxOps: 100,
+                    maxTime: 10,
+                },
+            },
+            dispose: () => { },
+            disposed: false,
+            submit: () => { },
+            submitSignal: () => { },
+            on: () => { },
+            once: () => { },
+        };
+    });
+    it("Check periodic join session call", async () => {
+        const createDeltaConnectionStub = stub(odspDocumentDeltaConnection.OdspDocumentDeltaConnection, "create").callsFake(async () => deltaConnection);
+        let joinSessionStub = addJoinSessionStub(100);
+        await service.connectToDeltaStream(client);
+        createDeltaConnectionStub.restore();
+        joinSessionStub.restore();
+        assert(joinSessionStub.calledOnce, "Should called once on first try");
+        // Prepare second response.
+        joinSessionStub = addJoinSessionStub(90);
+        // Tick 70 seconds so as to get second response.
+        await tickClock(70000 - 1);
+        assert(joinSessionStub.notCalled, "Should not be called in 69 sec");
+        await tickClock(1);
+        assert(joinSessionStub.calledOnce, "Should called once on second try");
+        joinSessionStub.restore();
+        // Prepare third response.
+        joinSessionStub = addJoinSessionStub(30);
+        // Tick 60 seconds so as to get third response.
+        await tickClock(50000);
+        assert(joinSessionStub.notCalled, "Should not be called in 50 sec");
+        await tickClock(10000);
+        assert(joinSessionStub.calledOnce, "Should called once on third try");
+        joinSessionStub.restore();
+        // Prepare fourth response.
+        joinSessionStub = addJoinSessionStub(40);
+        // Since last refresh seconds is less than 30 sec, we should not have
+        // scheduled the refresh.
+        await tickClock(100000);
+        assert(joinSessionStub.notCalled, "Should not be called ever");
+        joinSessionStub.restore();
+    });
+    it("Check periodic join session call does not lead to duplicate refresh", async () => {
+        const createDeltaConnectionStub = stub(odspDocumentDeltaConnection.OdspDocumentDeltaConnection, "create").callsFake(async () => deltaConnection);
+        let joinSessionStub = addJoinSessionStub(100);
+        await service.connectToDeltaStream(client);
+        createDeltaConnectionStub.restore();
+        joinSessionStub.restore();
+        assert(joinSessionStub.calledOnce, "Should called once on first try");
+        // Prepare second response.
+        joinSessionStub = addJoinSessionStub(90);
+        // Tick 70 seconds so as to get second response.
+        await tickClock(70000);
+        assert(joinSessionStub.calledOnce, "Should called once on second try");
+        joinSessionStub.restore();
+        logger.assertMatchNone([{ eventName: "OdspDriver:DuplicateJoinSessionRefresh" }], "No duplicate join session should be there");
+    });
+    afterEach(() => {
+        clock.reset();
+    });
+    after(() => {
+        clock.restore();
+    });
+});
+//# sourceMappingURL=joinSessionPeriodicCall.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"joinSessionPeriodicCall.spec.js","sourceRoot":"","sources":["../../src/test/joinSessionPeriodicCall.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,aAAa,EAA8B,MAAM,OAAO,CAAC;AACxE,OAAO,KAAK,2BAA2B,MAAM,mCAAmC,CAAC;AACjF,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAIpE,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IACnC,IAAI,KAAsB,CAAC;IAC3B,MAAM,OAAO,GAAG,2BAA2B,CAAC;IAC5C,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC;IACxB,IAAI,OAA4B,CAAC;IACjC,IAAI,MAAkB,CAAC;IACvB,MAAM,MAAM,GAAY;QACvB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,EAAE,YAAY,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;QAChD,UAAU,EAAE,EAAE;QACd,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;QAClB,MAAM,EAAE,EAAE;KACV,CAAC;IACF,IAAI,eAAe,CAAC;IACpB,MAAM,mBAAmB,GAA4B;QACpD,eAAe,EAAE,8BAA8B;QAC/C,oBAAoB,EAAE,wBAAwB;QAC9C,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE,UAAU;QACpB,kBAAkB,EAAE,iCAAiC;QACrD,6BAA6B,EAAE,GAAG;KAClC,CAAC;IACF,IAAI,0BAAsD,CAAC;IAE3D,sEAAsE;IACtE,MAAM,cAAc,GAAG,UAAU,CAAC;IAElC,0DAA0D;IAC1D,KAAK,UAAU,cAAc;QAC5B,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,UAAU,SAAS,CAAC,SAAiB;QACzC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtB,iFAAiF;QACjF,MAAM,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,SAAS,kBAAkB,CAAC,IAAY;QACvC,mBAAmB,CAAC,6BAA6B,GAAG,IAAI,CAAC;QACzD,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC,SAAS,CACtE,KAAK,IAAI,EAAE,CAAC,mBAAmB,CAC/B,CAAC;QACF,OAAO,eAAe,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,KAAK,GAAG,aAAa,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACrB,0BAA0B,GAAG,IAAI,0BAA0B,CAC1D,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAC9B,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CACtC,CAAC;QACF,MAAM,OAAO,GAA8B,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC;QAC5F,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAC7D,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC1B,OAAO,GAAG,CAAC,MAAM,0BAA0B,CAAC,qBAAqB,CAChE,WAAW,EACX,MAAM,CACN,CAAwB,CAAC;QAE1B,eAAe,GAAG;YACjB,QAAQ,EAAE,UAAU;YACpB,QAAQ,EAAE,IAAI;YACd,cAAc,EAAE,EAAE;YAClB,eAAe,EAAE,EAAE;YACnB,cAAc,EAAE,EAAE;YAClB,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,OAAO;YACb,MAAM,EAAE;gBACP,UAAU,EAAE,OAAO;gBACnB,GAAG,EAAE,CAAC;gBACN,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE;oBACL,EAAE,EAAE,IAAI;iBACR;aACD;YACD,oBAAoB,EAAE;gBACrB,SAAS,EAAE,GAAG;gBACd,cAAc,EAAE,KAAK;gBACrB,OAAO,EAAE;oBACR,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,CAAC;oBACd,cAAc,EAAE,CAAC;oBACjB,MAAM,EAAE,GAAG;oBACX,OAAO,EAAE,EAAE;iBACX;aACD;YACD,OAAO,EAAE,GAAS,EAAE,GAAE,CAAC;YACvB,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,GAAS,EAAE,GAAE,CAAC;YACtB,YAAY,EAAE,GAAS,EAAE,GAAE,CAAC;YAC5B,EAAE,EAAE,GAAS,EAAE,GAAE,CAAC;YAClB,IAAI,EAAE,GAAS,EAAE,GAAE,CAAC;SACpB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,yBAAyB,GAAG,IAAI,CACrC,2BAA2B,CAAC,2BAA2B,EACvD,QAAQ,CACR,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,eAA8C,CAAC,CAAC;QACxE,IAAI,eAAe,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC3C,yBAAyB,CAAC,OAAO,EAAE,CAAC;QACpC,eAAe,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,iCAAiC,CAAC,CAAC;QAEtE,2BAA2B;QAC3B,eAAe,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;QACzC,gDAAgD;QAChD,MAAM,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC3B,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;QACpE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,kCAAkC,CAAC,CAAC;QACvE,eAAe,CAAC,OAAO,EAAE,CAAC;QAE1B,0BAA0B;QAC1B,eAAe,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;QACzC,+CAA+C;QAC/C,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;QACvB,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;QACpE,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;QACvB,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,iCAAiC,CAAC,CAAC;QACtE,eAAe,CAAC,OAAO,EAAE,CAAC;QAE1B,2BAA2B;QAC3B,eAAe,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;QACzC,qEAAqE;QACrE,yBAAyB;QACzB,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QACxB,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAAC;QAC/D,eAAe,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,yBAAyB,GAAG,IAAI,CACrC,2BAA2B,CAAC,2BAA2B,EACvD,QAAQ,CACR,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,eAA8C,CAAC,CAAC;QACxE,IAAI,eAAe,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC3C,yBAAyB,CAAC,OAAO,EAAE,CAAC;QACpC,eAAe,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,iCAAiC,CAAC,CAAC;QAEtE,2BAA2B;QAC3B,eAAe,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;QACzC,gDAAgD;QAChD,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;QACvB,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,kCAAkC,CAAC,CAAC;QACvE,eAAe,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,CAAC,eAAe,CACrB,CAAC,EAAE,SAAS,EAAE,wCAAwC,EAAE,CAAC,EACzD,2CAA2C,CAC3C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACd,KAAK,CAAC,KAAK,EAAE,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE;QACV,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;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 { IClient } from \"@fluidframework/protocol-definitions\";\nimport { ISocketStorageDiscovery } from \"@fluidframework/odsp-driver-definitions\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { stub, useFakeTimers, SinonFakeTimers, SinonStub } from \"sinon\";\nimport * as odspDocumentDeltaConnection from \"../odspDocumentDeltaConnection.js\";\nimport * as joinSession from \"../vroom.js\";\nimport { OdspDocumentServiceFactory } from \"../odspDocumentServiceFactory.js\";\nimport { LocalPersistentCache } from \"../odspCache.js\";\nimport { OdspFluidDataStoreLocator } from \"../contractsPublic.js\";\nimport { createOdspUrl } from \"../createOdspUrl.js\";\nimport { OdspDriverUrlResolver } from \"../odspDriverUrlResolver.js\";\nimport { OdspDocumentService } from \"../odspDocumentService.js\";\nimport { OdspDocumentDeltaConnection } from \"../odspDocumentDeltaConnection.js\";\n\ndescribe(\"joinSessions Tests\", () => {\n\tlet clock: SinonFakeTimers;\n\tconst siteUrl = \"https://www.localhost.xxx\";\n\tconst driveId = \"driveId\";\n\tconst resolver = new OdspDriverUrlResolver();\n\tconst itemId = \"itemId\";\n\tlet service: OdspDocumentService;\n\tlet logger: MockLogger;\n\tconst client: IClient = {\n\t\tmode: \"read\",\n\t\tdetails: { capabilities: { interactive: true } },\n\t\tpermission: [],\n\t\tuser: { id: \"id\" },\n\t\tscopes: [],\n\t};\n\tlet deltaConnection;\n\tconst joinSessionResponse: ISocketStorageDiscovery = {\n\t\tdeltaStorageUrl: \"https://fake/deltaStorageUrl\",\n\t\tdeltaStreamSocketUrl: \"https://localhost:3001\",\n\t\tid: \"id\",\n\t\ttenantId: \"tenantId\",\n\t\tsnapshotStorageUrl: \"https://fake/snapshotStorageUrl\",\n\t\trefreshSessionDurationSeconds: 100,\n\t};\n\tlet odspDocumentServiceFactory: OdspDocumentServiceFactory;\n\n\t// Stash the real setTimeout because sinon fake timers will hijack it.\n\tconst realSetTimeout = setTimeout;\n\n\t// function to yield control in the Javascript event loop.\n\tasync function yieldEventLoop(): Promise<void> {\n\t\tawait new Promise<void>((resolve) => {\n\t\t\trealSetTimeout(resolve, 0);\n\t\t});\n\t}\n\n\tasync function tickClock(tickValue: number): Promise<void> {\n\t\tclock.tick(tickValue);\n\n\t\t// Yield the event loop because the outbound op will be processed asynchronously.\n\t\tawait yieldEventLoop();\n\t}\n\n\tfunction addJoinSessionStub(time: number): SinonStub {\n\t\tjoinSessionResponse.refreshSessionDurationSeconds = time;\n\t\tconst joinSessionStub = stub(joinSession, \"fetchJoinSession\").callsFake(\n\t\t\tasync () => joinSessionResponse,\n\t\t);\n\t\treturn joinSessionStub;\n\t}\n\n\tbefore(async () => {\n\t\tclock = useFakeTimers();\n\t});\n\n\tbeforeEach(async () => {\n\t\todspDocumentServiceFactory = new OdspDocumentServiceFactory(\n\t\t\tasync (_options) => \"token\",\n\t\t\tasync (_options) => \"token\",\n\t\t\tnew LocalPersistentCache(2000),\n\t\t\t{ snapshotOptions: { timeout: 2000 } },\n\t\t);\n\t\tconst locator: OdspFluidDataStoreLocator = { driveId, itemId, siteUrl, dataStorePath: \"/\" };\n\t\tconst request = createOdspUrl(locator);\n\t\tconst resolvedUrl = await resolver.resolve({ url: request });\n\t\tlogger = new MockLogger();\n\t\tservice = (await odspDocumentServiceFactory.createDocumentService(\n\t\t\tresolvedUrl,\n\t\t\tlogger,\n\t\t)) as OdspDocumentService;\n\n\t\tdeltaConnection = {\n\t\t\tclientId: \"clientId\",\n\t\t\texisting: true,\n\t\t\tinitialClients: [],\n\t\t\tinitialMessages: [],\n\t\t\tinitialSignals: [],\n\t\t\tversion: \"1.0\",\n\t\t\tmode: \"write\",\n\t\t\tclaims: {\n\t\t\t\tdocumentId: \"docId\",\n\t\t\t\texp: 0,\n\t\t\t\tiat: 0,\n\t\t\t\tscopes: [],\n\t\t\t\ttenantId: \"ten\",\n\t\t\t\tver: \"ver\",\n\t\t\t\tuser: {\n\t\t\t\t\tid: \"id\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tserviceConfiguration: {\n\t\t\t\tblockSize: 100,\n\t\t\t\tmaxMessageSize: 16000,\n\t\t\t\tsummary: {\n\t\t\t\t\tminIdleTime: 0,\n\t\t\t\t\tmaxIdleTime: 0,\n\t\t\t\t\tmaxAckWaitTime: 0,\n\t\t\t\t\tmaxOps: 100,\n\t\t\t\t\tmaxTime: 10,\n\t\t\t\t},\n\t\t\t},\n\t\t\tdispose: (): void => {},\n\t\t\tdisposed: false,\n\t\t\tsubmit: (): void => {},\n\t\t\tsubmitSignal: (): void => {},\n\t\t\ton: (): void => {},\n\t\t\tonce: (): void => {},\n\t\t};\n\t});\n\n\tit(\"Check periodic join session call\", async () => {\n\t\tconst createDeltaConnectionStub = stub(\n\t\t\todspDocumentDeltaConnection.OdspDocumentDeltaConnection,\n\t\t\t\"create\",\n\t\t).callsFake(async () => deltaConnection as OdspDocumentDeltaConnection);\n\t\tlet joinSessionStub = addJoinSessionStub(100);\n\t\tawait service.connectToDeltaStream(client);\n\t\tcreateDeltaConnectionStub.restore();\n\t\tjoinSessionStub.restore();\n\t\tassert(joinSessionStub.calledOnce, \"Should called once on first try\");\n\n\t\t// Prepare second response.\n\t\tjoinSessionStub = addJoinSessionStub(90);\n\t\t// Tick 70 seconds so as to get second response.\n\t\tawait tickClock(70000 - 1);\n\t\tassert(joinSessionStub.notCalled, \"Should not be called in 69 sec\");\n\t\tawait tickClock(1);\n\t\tassert(joinSessionStub.calledOnce, \"Should called once on second try\");\n\t\tjoinSessionStub.restore();\n\n\t\t// Prepare third response.\n\t\tjoinSessionStub = addJoinSessionStub(30);\n\t\t// Tick 60 seconds so as to get third response.\n\t\tawait tickClock(50000);\n\t\tassert(joinSessionStub.notCalled, \"Should not be called in 50 sec\");\n\t\tawait tickClock(10000);\n\t\tassert(joinSessionStub.calledOnce, \"Should called once on third try\");\n\t\tjoinSessionStub.restore();\n\n\t\t// Prepare fourth response.\n\t\tjoinSessionStub = addJoinSessionStub(40);\n\t\t// Since last refresh seconds is less than 30 sec, we should not have\n\t\t// scheduled the refresh.\n\t\tawait tickClock(100000);\n\t\tassert(joinSessionStub.notCalled, \"Should not be called ever\");\n\t\tjoinSessionStub.restore();\n\t});\n\n\tit(\"Check periodic join session call does not lead to duplicate refresh\", async () => {\n\t\tconst createDeltaConnectionStub = stub(\n\t\t\todspDocumentDeltaConnection.OdspDocumentDeltaConnection,\n\t\t\t\"create\",\n\t\t).callsFake(async () => deltaConnection as OdspDocumentDeltaConnection);\n\t\tlet joinSessionStub = addJoinSessionStub(100);\n\t\tawait service.connectToDeltaStream(client);\n\t\tcreateDeltaConnectionStub.restore();\n\t\tjoinSessionStub.restore();\n\t\tassert(joinSessionStub.calledOnce, \"Should called once on first try\");\n\n\t\t// Prepare second response.\n\t\tjoinSessionStub = addJoinSessionStub(90);\n\t\t// Tick 70 seconds so as to get second response.\n\t\tawait tickClock(70000);\n\t\tassert(joinSessionStub.calledOnce, \"Should called once on second try\");\n\t\tjoinSessionStub.restore();\n\t\tlogger.assertMatchNone(\n\t\t\t[{ eventName: \"OdspDriver:DuplicateJoinSessionRefresh\" }],\n\t\t\t\"No duplicate join session should be there\",\n\t\t);\n\t});\n\n\tafterEach(() => {\n\t\tclock.reset();\n\t});\n\n\tafter(() => {\n\t\tclock.restore();\n\t});\n});\n"]}