@fluidframework/odsp-driver 1.2.2 → 2.0.0-internal.1.0.0.81589

package/dist/getFileLink.js

@@ -12,6 +12,7 @@ const driver_definitions_1 = require("@fluidframework/driver-definitions");
 const getUrlAndHeadersWithAuth_1 = require("./getUrlAndHeadersWithAuth");
 const odspUtils_1 = require("./odspUtils");
 const packageVersion_1 = require("./packageVersion");
+const retryUtils_1 = require("./retryUtils");
 // Store cached responses for the lifetime of web session as file link remains the same for given file item
 const fileLinkCache = new Map();
 /**
@@ -34,34 +35,25 @@ async function getFileLink(getToken, odspUrlParts, identityType, logger) {
     if (maybeFileLinkCacheEntry !== undefined) {
         return maybeFileLinkCacheEntry;
     }
-    const valueGenerator = async function () {
-        var _a;
-        let result;
-        let success = false;
-        let retryAfterMs = 1000;
-        do {
-            try {
-                result = await getFileLinkCore(getToken, odspUrlParts, identityType, logger);
-                success = true;
+    const fileLinkGenerator = async function () {
+        let fileLinkCore;
+        try {
+            fileLinkCore = await (0, retryUtils_1.runWithRetry)(async () => getFileLinkCore(getToken, odspUrlParts, identityType, logger), "getFileLinkCore", logger);
+        }
+        catch (err) {
+            // runWithRetry throws a non retriable error after it hits the max # of attempts
+            // or encounters an unexpected error type
+            if (!(0, driver_utils_1.canRetryOnError)(err)) {
+                // Delete from the cache to permit retrying later.
+                fileLinkCache.delete(cacheKey);
             }
-            catch (err) {
-                // If it is not retriable, then just throw
-                if (!(0, driver_utils_1.canRetryOnError)(err)) {
-                    // Delete from the cache to permit retrying later.
-                    fileLinkCache.delete(cacheKey);
-                    throw err;
-                }
-                // If the error is throttling error, then wait for the specified time before retrying.
-                // If the waitTime is not specified, then we start with retrying immediately to max of 8s.
-                retryAfterMs = (_a = (0, driver_utils_1.getRetryDelayFromError)(err)) !== null && _a !== void 0 ? _a : Math.min(retryAfterMs * 2, 8000);
-                await (0, common_utils_1.delay)(retryAfterMs);
-            }
-        } while (!success);
+            throw err;
+        }
         // We are guaranteed to run the getFileLinkCore at least once with successful result (which must be a string)
-        (0, common_utils_1.assert)(result !== undefined, 0x292 /* "Unexpected undefined result from getFileLinkCore" */);
-        return result;
+        (0, common_utils_1.assert)(fileLinkCore !== undefined, 0x292 /* "Unexpected undefined result from getFileLinkCore" */);
+        return fileLinkCore;
     };
-    const fileLink = valueGenerator();
+    const fileLink = fileLinkGenerator();
     fileLinkCache.set(cacheKey, fileLink);
     return fileLink;
 }

package/dist/getFileLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"getFileLink.js","sourceRoot":"","sources":["../src/getFileLink.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAA6D;AAC7D,+DAA0G;AAC1G,qEAAmE;AACnE,2EAAqE;AAOrE,yEAAsE;AACtE,2CAAuG;AACvG,qDAA+D;AAE/D,2GAA2G;AAC3G,MAAM,aAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,WAAW,CAC7B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,GAAG,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;IAC1F,MAAM,uBAAuB,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5D,IAAI,uBAAuB,KAAK,SAAS,EAAE;QACvC,OAAO,uBAAuB,CAAC;KAClC;IAED,MAAM,cAAc,GAAG,KAAK;;QACxB,IAAI,MAA0B,CAAC;QAC/B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,YAAY,GAAG,IAAI,CAAC;QACxB,GAAG;YACC,IAAI;gBACA,MAAM,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;gBAC7E,OAAO,GAAG,IAAI,CAAC;aAClB;YAAC,OAAO,GAAG,EAAE;gBACV,0CAA0C;gBAC1C,IAAI,CAAC,IAAA,8BAAe,EAAC,GAAG,CAAC,EAAE;oBACvB,kDAAkD;oBAClD,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC/B,MAAM,GAAG,CAAC;iBACb;gBACD,sFAAsF;gBACtF,0FAA0F;gBAC1F,YAAY,GAAG,MAAA,IAAA,qCAAsB,EAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;gBAC/E,MAAM,IAAA,oBAAK,EAAC,YAAY,CAAC,CAAC;aAC7B;SACJ,QAAQ,CAAC,OAAO,EAAE;QAEnB,6GAA6G;QAC7G,IAAA,qBAAM,EAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC7F,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;IAClC,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC;AACpB,CAAC;AAzCD,kCAyCC;AAED,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,UAAU,CAAC,CAAC;IAEpG,oHAAoH;IACpH,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,uBAAuB,EAAE,EACnE,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,mBAAmB,GAAG,IAAA,0CAA8B,EACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,IAAA,qBAAM,EAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,wFAAwF,CAAC,CAAC;YAEpG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,mDAAwB,EAC7C,GAAG,YAAY,CAAC,OAAO,2EACnB,kBAAkB,CAAC,IAAI,QAAQ,CAAC,SAAS,GAAG,CAChD,EAAE,EACF,YAAY,EACZ,KAAK,CACR,CAAC;YACF,MAAM,WAAW,GAAG;gBAChB,MAAM,EAAE,MAAM;gBACd,OAAO,kBACH,cAAc,EAAE,gCAAgC,EAChD,QAAQ,EAAE,gCAAgC,IACvC,OAAO,CACb;aACJ,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAW,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAClD,MAAM,SAAS,GAAG,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,CAAC,0CAAE,SAAS,CAAC;YAC5C,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;gBAC/B,sDAAsD;gBACtD,MAAM,IAAI,gCAAiB,CACvB,0CAA0C,EAC1C,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,SAAS,CAAC;QACrB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC;AAUD,MAAM,cAAc,GAAG,CAAC,iBAAsB,EAAqC,EAAE;IACjF,IAAI,OAAO,iBAAiB,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,iBAAiB,CAAC,SAAS,KAAK,QAAQ,EAAE;QACjG,OAAO,KAAK,CAAC;KAChB;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,MAAwB,EACxB,sCAA+C;IAE/C,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,iBAAiB,EAAE,EAC7D,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;YAClD,MAAM,mBAAmB,GAAG,IAAA,0CAA8B,EACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,IAAA,qBAAM,EAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,uFAAuF,CAAC,CAAC;YAEnG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,mDAAwB,EAC7C,GAAG,OAAO,qBAAqB,OAAO,UAAU,MAAM,0BAA0B,EAChF,YAAY,EACZ,sCAAsC,CACzC,CAAC;YACF,MAAM,WAAW,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAW,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;gBAC/B,sDAAsD;gBACtD,MAAM,IAAI,gCAAiB,CACvB,oCAAoC,EACpC,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,YAAY,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, delay } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, getRetryDelayFromError, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspUrlParts,\n    OdspResourceTokenFetchOptions,\n    IdentityType,\n    TokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport { fetchHelper, getWithRetryForTokenRefresh, toInstrumentedOdspTokenFetcher } from \"./odspUtils\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n// Store cached responses for the lifetime of web session as file link remains the same for given file item\nconst fileLinkCache = new Map<string, Promise<string>>();\n\n/**\n * Returns file link for a file with given drive and item ids.\n * Scope needed: files.readwrite.all.\n * This function keeps retrying if it gets a retriable error or wait for some delay if it gets a\n * throttling error. In future, we are thinking of app allowing to pass some cancel token, with which\n * we would be able to stop retrying.\n * @param getToken - used to fetch access tokens needed to execute operation\n * @param siteUrl - url of the site that contains the file\n * @param driveId - drive where file is stored\n * @param itemId - file id\n * @param identityType - type of client account\n * @param logger - used to log results of operation, including any error\n * @returns Promise which resolves to file link url when successful; otherwise, undefined.\n */\nexport async function getFileLink(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const cacheKey = `${odspUrlParts.siteUrl}_${odspUrlParts.driveId}_${odspUrlParts.itemId}`;\n    const maybeFileLinkCacheEntry = fileLinkCache.get(cacheKey);\n    if (maybeFileLinkCacheEntry !== undefined) {\n        return maybeFileLinkCacheEntry;\n    }\n\n    const valueGenerator = async function() {\n        let result: string | undefined;\n        let success = false;\n        let retryAfterMs = 1000;\n        do {\n            try {\n                result = await getFileLinkCore(getToken, odspUrlParts, identityType, logger);\n                success = true;\n            } catch (err) {\n                // If it is not retriable, then just throw\n                if (!canRetryOnError(err)) {\n                    // Delete from the cache to permit retrying later.\n                    fileLinkCache.delete(cacheKey);\n                    throw err;\n                }\n                // If the error is throttling error, then wait for the specified time before retrying.\n                // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n                retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n                await delay(retryAfterMs);\n            }\n        } while (!success);\n\n        // We are guaranteed to run the getFileLinkCore at least once with successful result (which must be a string)\n        assert(result !== undefined, 0x292 /* \"Unexpected undefined result from getFileLinkCore\" */);\n        return result;\n    };\n    const fileLink = valueGenerator();\n    fileLinkCache.set(cacheKey, fileLink);\n    return fileLink;\n}\n\nasync function getFileLinkCore(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const fileItem = await getFileItemLite(getToken, odspUrlParts, logger, identityType === \"Consumer\");\n\n    // ODSP link requires extra call to return link that is resistant to file being renamed or moved to different folder\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getSharingInformation\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileLink = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileLinkCore\");\n                assert(storageToken !== null,\n                    0x2bb /* \"Instrumented token fetcher with throwOnNullToken = true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${odspUrlParts.siteUrl}/_api/web/GetFileByUrl(@a1)/ListItemAllFields/GetSharingInformation?@a1=${\n                        encodeURIComponent(`'${fileItem.webDavUrl}'`)\n                    }`,\n                    storageToken,\n                    false,\n                );\n                const requestInit = {\n                    method: \"POST\",\n                    headers: {\n                        \"Content-Type\": \"application/json;odata=verbose\",\n                        \"Accept\": \"application/json;odata=verbose\",\n                        ...headers,\n                    },\n                };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const sharingInfo = await response.content.json();\n                const directUrl = sharingInfo?.d?.directUrl;\n                if (typeof directUrl !== \"string\") {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed GetSharingInformation response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return directUrl;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileLink;\n        },\n    );\n}\n\n/**\n * This represents a lite version of file item containing only the webUrl and webDavUrl properties\n */\ninterface FileItemLite {\n    webUrl: string;\n    webDavUrl: string;\n}\n\nconst isFileItemLite = (maybeFileItemLite: any): maybeFileItemLite is FileItemLite => {\n    if (typeof maybeFileItemLite.webUrl !== \"string\" || typeof maybeFileItemLite.webDavUrl !== \"string\") {\n        return false;\n    }\n    return true;\n};\n\nasync function getFileItemLite(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    logger: ITelemetryLogger,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<FileItemLite> {\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getFileItemLite\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileItem = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const { siteUrl, driveId, itemId } = odspUrlParts;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileItemLite\");\n                assert(storageToken !== null,\n                    0x2bc /* \"Instrumented token fetcher with throwOnNullToken =true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${siteUrl}/_api/v2.0/drives/${driveId}/items/${itemId}?select=webUrl,webDavUrl`,\n                    storageToken,\n                    forceAccessTokenViaAuthorizationHeader,\n                );\n                const requestInit = { method: \"GET\", headers };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const responseJson = await response.content.json();\n                if (!isFileItemLite(responseJson)) {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed getFileItemLite response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return responseJson;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileItem;\n        },\n    );\n}\n"]}
+{"version":3,"file":"getFileLink.js","sourceRoot":"","sources":["../src/getFileLink.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAsD;AACtD,+DAAkF;AAClF,qEAAmE;AACnE,2EAAqE;AAOrE,yEAAsE;AACtE,2CAAuG;AACvG,qDAA+D;AAC/D,6CAA4C;AAE5C,2GAA2G;AAC3G,MAAM,aAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,WAAW,CAC7B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,GAAG,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;IAC1F,MAAM,uBAAuB,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5D,IAAI,uBAAuB,KAAK,SAAS,EAAE;QACvC,OAAO,uBAAuB,CAAC;KAClC;IAED,MAAM,iBAAiB,GAAG,KAAK;QAC3B,IAAI,YAAoB,CAAC;QACzB,IAAI;YACA,YAAY,GAAG,MAAM,IAAA,yBAAY,EAC7B,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,EACzE,iBAAiB,EACjB,MAAM,CACT,CAAC;SACL;QAAC,OAAO,GAAG,EAAE;YACV,gFAAgF;YAChF,yCAAyC;YACzC,IAAI,CAAC,IAAA,8BAAe,EAAC,GAAG,CAAC,EAAE;gBACvB,kDAAkD;gBAClD,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAClC;YACD,MAAM,GAAG,CAAC;SACb;QAED,6GAA6G;QAC7G,IAAA,qBAAM,EAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACnG,OAAO,YAAY,CAAC;IACxB,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,iBAAiB,EAAE,CAAC;IACrC,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC;AACpB,CAAC;AArCD,kCAqCC;AAED,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,UAAU,CAAC,CAAC;IAEpG,oHAAoH;IACpH,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,uBAAuB,EAAE,EACnE,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,mBAAmB,GAAG,IAAA,0CAA8B,EACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,IAAA,qBAAM,EAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,wFAAwF,CAAC,CAAC;YAEpG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,mDAAwB,EAC7C,GAAG,YAAY,CAAC,OAAO,2EACnB,kBAAkB,CAAC,IAAI,QAAQ,CAAC,SAAS,GAAG,CAChD,EAAE,EACF,YAAY,EACZ,KAAK,CACR,CAAC;YACF,MAAM,WAAW,GAAG;gBAChB,MAAM,EAAE,MAAM;gBACd,OAAO,kBACH,cAAc,EAAE,gCAAgC,EAChD,QAAQ,EAAE,gCAAgC,IACvC,OAAO,CACb;aACJ,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAW,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAClD,MAAM,SAAS,GAAG,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,CAAC,0CAAE,SAAS,CAAC;YAC5C,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;gBAC/B,sDAAsD;gBACtD,MAAM,IAAI,gCAAiB,CACvB,0CAA0C,EAC1C,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,SAAS,CAAC;QACrB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC;AAUD,MAAM,cAAc,GAAG,CAAC,iBAAsB,EAAqC,EAAE;IACjF,IAAI,OAAO,iBAAiB,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,iBAAiB,CAAC,SAAS,KAAK,QAAQ,EAAE;QACjG,OAAO,KAAK,CAAC;KAChB;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,MAAwB,EACxB,sCAA+C;IAE/C,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,iBAAiB,EAAE,EAC7D,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;YAClD,MAAM,mBAAmB,GAAG,IAAA,0CAA8B,EACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,IAAA,qBAAM,EAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,uFAAuF,CAAC,CAAC;YAEnG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,mDAAwB,EAC7C,GAAG,OAAO,qBAAqB,OAAO,UAAU,MAAM,0BAA0B,EAChF,YAAY,EACZ,sCAAsC,CACzC,CAAC;YACF,MAAM,WAAW,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAW,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;gBAC/B,sDAAsD;gBACtD,MAAM,IAAI,gCAAiB,CACvB,oCAAoC,EACpC,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,YAAY,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspUrlParts,\n    OdspResourceTokenFetchOptions,\n    IdentityType,\n    TokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport { fetchHelper, getWithRetryForTokenRefresh, toInstrumentedOdspTokenFetcher } from \"./odspUtils\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { runWithRetry } from \"./retryUtils\";\n\n// Store cached responses for the lifetime of web session as file link remains the same for given file item\nconst fileLinkCache = new Map<string, Promise<string>>();\n\n/**\n * Returns file link for a file with given drive and item ids.\n * Scope needed: files.readwrite.all.\n * This function keeps retrying if it gets a retriable error or wait for some delay if it gets a\n * throttling error. In future, we are thinking of app allowing to pass some cancel token, with which\n * we would be able to stop retrying.\n * @param getToken - used to fetch access tokens needed to execute operation\n * @param siteUrl - url of the site that contains the file\n * @param driveId - drive where file is stored\n * @param itemId - file id\n * @param identityType - type of client account\n * @param logger - used to log results of operation, including any error\n * @returns Promise which resolves to file link url when successful; otherwise, undefined.\n */\nexport async function getFileLink(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const cacheKey = `${odspUrlParts.siteUrl}_${odspUrlParts.driveId}_${odspUrlParts.itemId}`;\n    const maybeFileLinkCacheEntry = fileLinkCache.get(cacheKey);\n    if (maybeFileLinkCacheEntry !== undefined) {\n        return maybeFileLinkCacheEntry;\n    }\n\n    const fileLinkGenerator = async function() {\n        let fileLinkCore: string;\n        try {\n            fileLinkCore = await runWithRetry(\n                async () => getFileLinkCore(getToken, odspUrlParts, identityType, logger),\n                \"getFileLinkCore\",\n                logger,\n            );\n        } catch (err) {\n            // runWithRetry throws a non retriable error after it hits the max # of attempts\n            // or encounters an unexpected error type\n            if (!canRetryOnError(err)) {\n                // Delete from the cache to permit retrying later.\n                fileLinkCache.delete(cacheKey);\n            }\n            throw err;\n        }\n\n        // We are guaranteed to run the getFileLinkCore at least once with successful result (which must be a string)\n        assert(fileLinkCore !== undefined, 0x292 /* \"Unexpected undefined result from getFileLinkCore\" */);\n        return fileLinkCore;\n    };\n    const fileLink = fileLinkGenerator();\n    fileLinkCache.set(cacheKey, fileLink);\n    return fileLink;\n}\n\nasync function getFileLinkCore(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const fileItem = await getFileItemLite(getToken, odspUrlParts, logger, identityType === \"Consumer\");\n\n    // ODSP link requires extra call to return link that is resistant to file being renamed or moved to different folder\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getSharingInformation\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileLink = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileLinkCore\");\n                assert(storageToken !== null,\n                    0x2bb /* \"Instrumented token fetcher with throwOnNullToken = true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${odspUrlParts.siteUrl}/_api/web/GetFileByUrl(@a1)/ListItemAllFields/GetSharingInformation?@a1=${\n                        encodeURIComponent(`'${fileItem.webDavUrl}'`)\n                    }`,\n                    storageToken,\n                    false,\n                );\n                const requestInit = {\n                    method: \"POST\",\n                    headers: {\n                        \"Content-Type\": \"application/json;odata=verbose\",\n                        \"Accept\": \"application/json;odata=verbose\",\n                        ...headers,\n                    },\n                };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const sharingInfo = await response.content.json();\n                const directUrl = sharingInfo?.d?.directUrl;\n                if (typeof directUrl !== \"string\") {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed GetSharingInformation response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return directUrl;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileLink;\n        },\n    );\n}\n\n/**\n * This represents a lite version of file item containing only the webUrl and webDavUrl properties\n */\ninterface FileItemLite {\n    webUrl: string;\n    webDavUrl: string;\n}\n\nconst isFileItemLite = (maybeFileItemLite: any): maybeFileItemLite is FileItemLite => {\n    if (typeof maybeFileItemLite.webUrl !== \"string\" || typeof maybeFileItemLite.webDavUrl !== \"string\") {\n        return false;\n    }\n    return true;\n};\n\nasync function getFileItemLite(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    logger: ITelemetryLogger,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<FileItemLite> {\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getFileItemLite\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileItem = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const { siteUrl, driveId, itemId } = odspUrlParts;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileItemLite\");\n                assert(storageToken !== null,\n                    0x2bc /* \"Instrumented token fetcher with throwOnNullToken =true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${siteUrl}/_api/v2.0/drives/${driveId}/items/${itemId}?select=webUrl,webDavUrl`,\n                    storageToken,\n                    forceAccessTokenViaAuthorizationHeader,\n                );\n                const requestInit = { method: \"GET\", headers };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const responseJson = await response.content.json();\n                if (!isFileItemLite(responseJson)) {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed getFileItemLite response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return responseJson;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileItem;\n        },\n    );\n}\n"]}

package/dist/odspDeltaStorageService.d.ts

@@ -21,9 +21,10 @@ export declare class OdspDeltaStorageService {
      * @param from - inclusive
      * @param to - exclusive
      * @param telemetryProps - properties to add when issuing telemetry events
+     * @param scenarioName - reason for fetching ops
      * @returns ops retrieved & info if result was partial (i.e. more is available)
      */
-    get(from: number, to: number, telemetryProps: ITelemetryProperties, fetchReason?: string): Promise<IDeltasFetchResult>;
+    get(from: number, to: number, telemetryProps: ITelemetryProperties, scenarioName?: string): Promise<IDeltasFetchResult>;
     buildUrl(from: number, to: number): string;
 }
 export declare class OdspDeltaStorageWithCache implements IDocumentDeltaStorageService {

package/dist/odspDeltaStorageService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDeltaStorageService.d.ts","sourceRoot":"","sources":["../src/odspDeltaStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,+BAA+B,EAAE,MAAM,yCAAyC,CAAC;AAC1F,OAAO,EAAE,kBAAkB,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAMtG,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;GAEG;AACH,qBAAa,uBAAuB;IAE5B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAHN,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,+BAA+B,EAChD,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,gBAAgB;IAI7C;;;;;;OAMG;IACW,GAAG,CACb,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,cAAc,EAAE,oBAAoB,EACpC,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC;IAiEvB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;CAK3C;AAED,qBAAa,yBAA0B,YAAW,4BAA4B;IAItE,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAK/B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAdhC,OAAO,CAAC,cAAc,CAA2B;gBAGrC,WAAW,EAAE,yBAAyB,EAAE,GAAG,SAAS,EAC3C,MAAM,EAAE,gBAAgB,EACxB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,CAC7B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,cAAc,EAAE,oBAAoB,EACpC,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,EACvC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,yBAAyB,EAAE,CAAC,EAC7E,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,EACrD,WAAW,EAAE,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,IAAI;IAI5E,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,EAAE,IAAI,EAAE,MAAM;IAiBvF,aAAa,CAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM;CAkF3B"}
+{"version":3,"file":"odspDeltaStorageService.d.ts","sourceRoot":"","sources":["../src/odspDeltaStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,+BAA+B,EAAE,MAAM,yCAAyC,CAAC;AAC1F,OAAO,EAAE,kBAAkB,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAMtG,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;GAEG;AACH,qBAAa,uBAAuB;IAE5B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAHN,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,+BAA+B,EAChD,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,gBAAgB;IAI7C;;;;;;;OAOG;IACW,GAAG,CACb,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,cAAc,EAAE,oBAAoB,EACpC,YAAY,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,kBAAkB,CAAC;IAkEvB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;CAK3C;AAED,qBAAa,yBAA0B,YAAW,4BAA4B;IAItE,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAK/B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAdhC,OAAO,CAAC,cAAc,CAA2B;gBAGrC,WAAW,EAAE,yBAAyB,EAAE,GAAG,SAAS,EAC3C,MAAM,EAAE,gBAAgB,EACxB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,CAC7B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,cAAc,EAAE,oBAAoB,EACpC,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,EACvC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,yBAAyB,EAAE,CAAC,EAC7E,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,EACrD,WAAW,EAAE,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,IAAI;IAI5E,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,EAAE,IAAI,EAAE,MAAM;IAiBvF,aAAa,CAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM;CAkF3B"}

package/dist/odspDeltaStorageService.js

@@ -28,9 +28,10 @@ class OdspDeltaStorageService {
      * @param from - inclusive
      * @param to - exclusive
      * @param telemetryProps - properties to add when issuing telemetry events
+     * @param scenarioName - reason for fetching ops
      * @returns ops retrieved & info if result was partial (i.e. more is available)
      */
-    async get(from, to, telemetryProps, fetchReason) {
+    async get(from, to, telemetryProps, scenarioName) {
         return (0, odspUtils_1.getWithRetryForTokenRefresh)(async (options) => {
             // Note - this call ends up in getSocketStorageDiscovery() and can refresh token
             // Thus it needs to be done before we call getStorageToken() to reduce extra calls
@@ -57,7 +58,7 @@ class OdspDeltaStorageService {
                 body: postBody,
                 method: "POST",
                 signal: abort.signal,
-            }, "ops", true, fetchReason);
+            }, "ops", true, scenarioName);
             clearTimeout(timer);
             const deltaStorageResponse = response.content;
             let messages;
@@ -67,8 +68,8 @@ class OdspDeltaStorageService {
             else {
                 messages = deltaStorageResponse.value;
             }
-            this.logger.sendPerformanceEvent(Object.assign(Object.assign(Object.assign({ eventName: "OpsFetch", headers: Object.keys(headers).length !== 0 ? true : undefined, length: messages.length, duration: response.duration }, response.propsToLog), { attempts: options.refresh ? 2 : 1, from,
-                to }), telemetryProps));
+            this.logger.sendPerformanceEvent(Object.assign(Object.assign(Object.assign(Object.assign({ eventName: "OpsFetch", headers: Object.keys(headers).length !== 0 ? true : undefined, length: messages.length, duration: response.duration }, response.propsToLog), { attempts: options.refresh ? 2 : 1, from,
+                to }), telemetryProps), { reason: scenarioName }));
             // It is assumed that server always returns all the ops that it has in the range that was requested.
             // This may change in the future, if so, we need to adjust and receive "end" value from server in such case.
             return { messages, partialResult: false };

package/dist/odspDeltaStorageService.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDeltaStorageService.js","sourceRoot":"","sources":["../src/odspDeltaStorageService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,wEAA8D;AAC9D,+BAAkC;AAElC,+DAAsD;AAItD,+DAGsC;AAGtC,2CAA0D;AAE1D;;GAEG;AACH,MAAa,uBAAuB;IAChC,YACqB,YAAoB,EACpB,eAAgD,EAChD,YAA0B,EAC1B,MAAwB;QAHxB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,oBAAe,GAAf,eAAe,CAAiC;QAChD,iBAAY,GAAZ,YAAY,CAAc;QAC1B,WAAM,GAAN,MAAM,CAAkB;IAE7C,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,GAAG,CACb,IAAY,EACZ,EAAU,EACV,cAAoC,EACpC,WAAoB;QAEpB,OAAO,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjD,gFAAgF;YAChF,kFAAkF;YAClF,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAEzE,MAAM,YAAY,GAAG,IAAA,SAAI,GAAE,CAAC;YAC5B,IAAI,QAAQ,GAAG,KAAK,YAAY,MAAM,CAAC;YACvC,QAAQ,IAAI,yBAAyB,YAAY,MAAM,CAAC;YACxD,QAAQ,IAAI,iCAAiC,CAAC;YAE9C,QAAQ,IAAI,cAAc,CAAC;YAC3B,QAAQ,IAAI,SAAS,YAAY,IAAI,CAAC;YACtC,MAAM,OAAO,GAA8B;gBACvC,cAAc,EAAE,gCAAgC,YAAY,EAAE;aACjE,CAAC;YAEF,mGAAmG;YACnG,oGAAoG;YACpG,0GAA0G;YAC1G,6EAA6E;YAC7E,kFAAkF;YAClF,MAAM,KAAK,GAAG,IAAI,0BAAe,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;YAErD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,mBAAmB,CACxD,OAAO,EACP;gBACI,OAAO;gBACP,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,KAAK,CAAC,MAAM;aACvB,EACD,KAAK,EACL,IAAI,EACJ,WAAW,CACd,CAAC;YACF,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,oBAAoB,GAAG,QAAQ,CAAC,OAAO,CAAC;YAC9C,IAAI,QAAqC,CAAC;YAC1C,IAAI,oBAAoB,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,IAAI,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBAChF,QAAQ,GAAI,oBAAoB,CAAC,KAAoC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aAC1G;iBAAM;gBACH,QAAQ,GAAG,oBAAoB,CAAC,KAAoC,CAAC;aACxE;YAED,IAAI,CAAC,MAAM,CAAC,oBAAoB,6CAC5B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAC7D,MAAM,EAAE,QAAQ,CAAC,MAAM,EACvB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IACxB,QAAQ,CAAC,UAAU,KACtB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACjC,IAAI;gBACJ,EAAE,KACC,cAAc,EACnB,CAAC;YAEH,oGAAoG;YACpG,4GAA4G;YAC5G,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,QAAQ,CAAC,IAAY,EAAE,EAAU;QACpC,MAAM,MAAM,GAAG,kBAAkB,CAAC,qBAAqB,IAAI,0BAA0B,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAC/F,MAAM,WAAW,GAAG,iBAAiB,MAAM,EAAE,CAAC;QAC9C,OAAO,GAAG,IAAI,CAAC,YAAY,GAAG,WAAW,EAAE,CAAC;IAChD,CAAC;CACJ;AA3FD,0DA2FC;AAED,MAAa,yBAAyB;IAGlC,YACY,WAAoD,EAC3C,MAAwB,EACxB,SAAiB,EACjB,WAAmB,EACnB,cAIuC,EACvC,SAA6E,EAC7E,iBAAqD,EACrD,WAAuD;QAXhE,gBAAW,GAAX,WAAW,CAAyC;QAC3C,WAAM,GAAN,MAAM,CAAkB;QACxB,cAAS,GAAT,SAAS,CAAQ;QACjB,gBAAW,GAAX,WAAW,CAAQ;QACnB,mBAAc,GAAd,cAAc,CAIyB;QACvC,cAAS,GAAT,SAAS,CAAoE;QAC7E,sBAAiB,GAAjB,iBAAiB,CAAoC;QACrD,gBAAW,GAAX,WAAW,CAA4C;QAdpE,mBAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC;IAgBjD,CAAC;IAES,gBAAgB,CAAC,MAAc,EAAE,QAAqC,EAAE,IAAY;QAC1F,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;YACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;YACjD,IAAI,KAAK,KAAK,IAAI,EAAE;gBAChB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBAClG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aACvB;YACD,IAAI,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,MAAM,EAAE;gBAC5B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBAClG,uEAAuE;gBACvE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aACvB;SACJ;IACL,CAAC;IAEM,aAAa,CAChB,SAAiB,EACjB,OAA2B,EAC3B,WAAyB,EACzB,UAAoB,EACpB,WAAoB;QACpB,mGAAmG;QACnG,yGAAyG;QACzG,4BAA4B;QAC5B,gGAAgG;QAChG,IAAA,qBAAM,EAAC,CAAC,UAAU,IAAI,OAAO,KAAK,SAAS,EAAE,KAAK,CAAC,CAAC;QAEpD,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,IAAI,cAAc,GAAG,CAAC,CAAC;QAEvB,MAAM,eAAe,GAAG,KAAK,EAAE,IAAY,EAAE,EAAU,EAAE,cAAoC,EAAE,EAAE;YAC7F,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBACjE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC5C,EAAE,CAAC,cAAc,IAAI,IAAI,IAAI,EAAE,CAAC,cAAc,GAAG,EAAE,CAAC,CAAC;gBACzD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;gBAChD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,IAAI,EAAE;oBAC5D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;oBAC5E,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC;oBAClC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;iBAC5C;gBACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;aAChC;YAED,kDAAkD;YAClD,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAEjC,mFAAmF;YACnF,sCAAsC;YACtC,IAAI,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE;gBAC5B,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACzD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;gBACzD,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;oBAChC,YAAY,IAAI,iBAAiB,CAAC,MAAM,CAAC;oBACzC,OAAO;wBACH,QAAQ,EAAE,iBAAiB;wBAC3B,aAAa,EAAE,IAAI;qBACtB,CAAC;iBACL;gBACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;aAC7D;YAED,IAAI,UAAU,EAAE;gBACZ,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;aACjD;YAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;YAC7E,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACrD,cAAc,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;YACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC/B,OAAO,GAAG,CAAC;QACf,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAA,yBAAU,EACrB,KAAK,EAAE,IAAY,EAAE,EAAU,EAAE,cAAoC,EAAE,EAAE;YACrE,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;YAC/D,+BAA+B;YAC/B,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,uEAAuE;QACvE,0DAA0D;QAC1D,IAAI,CAAC,WAAW,EAChB,SAAS,EAAE,YAAY;QACvB,OAAO,EAAE,YAAY;QACrB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,WAAW,EACX,WAAW,CACd,CAAC;QAEF,OAAO,IAAA,6BAAc,EAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;YACrC,IAAI,MAAM,CAAC,IAAI,IAAI,eAAe,GAAG,YAAY,GAAG,cAAc,KAAK,CAAC,EAAE;gBACtE,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,mBAAmB;oBAC9B,eAAe;oBACf,YAAY;oBACZ,cAAc;iBACjB,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA3HD,8DA2HC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { default as AbortController } from \"abort-controller\";\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger, ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { InstrumentedStorageTokenFetcher } from \"@fluidframework/odsp-driver-definitions\";\nimport { IDeltasFetchResult, IDocumentDeltaStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    requestOps,\n    streamObserver,\n} from \"@fluidframework/driver-utils\";\nimport { IDeltaStorageGetResponse, ISequencedDeltaOpMessage } from \"./contracts\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { getWithRetryForTokenRefresh } from \"./odspUtils\";\n\n/**\n * Provides access to the underlying delta storage on the server for sharepoint driver.\n */\nexport class OdspDeltaStorageService {\n    constructor(\n        private readonly deltaFeedUrl: string,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        private readonly epochTracker: EpochTracker,\n        private readonly logger: ITelemetryLogger,\n    ) {\n    }\n\n    /**\n     * Retrieves ops from cache\n     * @param from - inclusive\n     * @param to - exclusive\n     * @param telemetryProps - properties to add when issuing telemetry events\n     * @returns ops retrieved & info if result was partial (i.e. more is available)\n     */\n     public async get(\n        from: number,\n        to: number,\n        telemetryProps: ITelemetryProperties,\n        fetchReason?: string,\n    ): Promise<IDeltasFetchResult> {\n        return getWithRetryForTokenRefresh(async (options) => {\n            // Note - this call ends up in getSocketStorageDiscovery() and can refresh token\n            // Thus it needs to be done before we call getStorageToken() to reduce extra calls\n            const baseUrl = this.buildUrl(from, to);\n            const storageToken = await this.getStorageToken(options, \"DeltaStorage\");\n\n            const formBoundary = uuid();\n            let postBody = `--${formBoundary}\\r\\n`;\n            postBody += `Authorization: Bearer ${storageToken}\\r\\n`;\n            postBody += `X-HTTP-Method-Override: GET\\r\\n`;\n\n            postBody += `_post: 1\\r\\n`;\n            postBody += `\\r\\n--${formBoundary}--`;\n            const headers: { [index: string]: any; } = {\n                \"Content-Type\": `multipart/form-data;boundary=${formBoundary}`,\n            };\n\n            // Some request take a long time (1-2 minutes) to complete, where telemetry shows very small amount\n            // of time spent on server, and usually small payload sizes. I.e. all the time is spent somewhere in\n            // networking. Even bigger problem - a lot of requests timeout (based on cursory look - after 1-2 minutes)\n            // So adding some timeout to ensure we retry again in hope of faster success.\n            // Please see https://github.com/microsoft/FluidFramework/issues/6997 for details.\n            const abort = new AbortController();\n            const timer = setTimeout(() => abort.abort(), 30000);\n\n            const response = await this.epochTracker.fetchAndParseAsJSON<IDeltaStorageGetResponse>(\n                baseUrl,\n                {\n                    headers,\n                    body: postBody,\n                    method: \"POST\",\n                    signal: abort.signal,\n                },\n                \"ops\",\n                true,\n                fetchReason,\n            );\n            clearTimeout(timer);\n            const deltaStorageResponse = response.content;\n            let messages: ISequencedDocumentMessage[];\n            if (deltaStorageResponse.value.length > 0 && \"op\" in deltaStorageResponse.value[0]) {\n                messages = (deltaStorageResponse.value as ISequencedDeltaOpMessage[]).map((operation) => operation.op);\n            } else {\n                messages = deltaStorageResponse.value as ISequencedDocumentMessage[];\n            }\n\n            this.logger.sendPerformanceEvent({\n                eventName: \"OpsFetch\",\n                headers: Object.keys(headers).length !== 0 ? true : undefined,\n                length: messages.length,\n                duration: response.duration, // this duration for single attempt!\n                ...response.propsToLog,\n                attempts: options.refresh ? 2 : 1,\n                from,\n                to,\n                ...telemetryProps,\n            });\n\n            // It is assumed that server always returns all the ops that it has in the range that was requested.\n            // This may change in the future, if so, we need to adjust and receive \"end\" value from server in such case.\n            return { messages, partialResult: false };\n        });\n    }\n\n    public buildUrl(from: number, to: number) {\n        const filter = encodeURIComponent(`sequenceNumber ge ${from} and sequenceNumber le ${to - 1}`);\n        const queryString = `?ump=1&filter=${filter}`;\n        return `${this.deltaFeedUrl}${queryString}`;\n    }\n}\n\nexport class OdspDeltaStorageWithCache implements IDocumentDeltaStorageService {\n    private firstCacheMiss = Number.MAX_SAFE_INTEGER;\n\n    public constructor(\n        private snapshotOps: ISequencedDocumentMessage[] | undefined,\n        private readonly logger: ITelemetryLogger,\n        private readonly batchSize: number,\n        private readonly concurrency: number,\n        private readonly getFromStorage: (\n            from: number,\n            to: number,\n            telemetryProps: ITelemetryProperties,\n            fetchReason?: string) => Promise<IDeltasFetchResult>,\n        private readonly getCached: (from: number, to: number) => Promise<ISequencedDocumentMessage[]>,\n        private readonly requestFromSocket: (from: number, to: number) => void,\n        private readonly opsReceived: (ops: ISequencedDocumentMessage[]) => void,\n    ) {\n    }\n\n    protected validateMessages(reason: string, messages: ISequencedDocumentMessage[], from: number) {\n        if (messages.length !== 0) {\n            const start = messages[0].sequenceNumber;\n            const length = messages.length;\n            const last = messages[length - 1].sequenceNumber;\n            if (start !== from) {\n                this.logger.sendErrorEvent({ eventName: \"OpsFetchViolation\", reason, from, start, last, length });\n                messages.length = 0;\n            }\n            if (last + 1 !== from + length) {\n                this.logger.sendErrorEvent({ eventName: \"OpsFetchViolation\", reason, from, start, last, length });\n                // we can do better here by finding consecutive sub-block and return it\n                messages.length = 0;\n            }\n        }\n    }\n\n    public fetchMessages(\n        fromTotal: number,\n        toTotal: number | undefined,\n        abortSignal?: AbortSignal,\n        cachedOnly?: boolean,\n        fetchReason?: string) {\n        // We do not control what's in the cache. Current API assumes that fetchMessages() keeps banging on\n        // storage / cache until it gets ops it needs. This would result in deadlock if fixed range is asked from\n        // cache and it's not there.\n        // Better implementation would be to return only what we have in cache, but that also breaks API\n        assert(!cachedOnly || toTotal === undefined, 0x1e3);\n\n        let opsFromSnapshot = 0;\n        let opsFromCache = 0;\n        let opsFromStorage = 0;\n\n        const requestCallback = async (from: number, to: number, telemetryProps: ITelemetryProperties) => {\n            if (this.snapshotOps !== undefined && this.snapshotOps.length !== 0) {\n                const messages = this.snapshotOps.filter((op) =>\n                    op.sequenceNumber >= from && op.sequenceNumber < to);\n                this.validateMessages(\"cached\", messages, from);\n                if (messages.length > 0 && messages[0].sequenceNumber === from) {\n                    this.snapshotOps = this.snapshotOps.filter((op) => op.sequenceNumber >= to);\n                    opsFromSnapshot = messages.length;\n                    return { messages, partialResult: true };\n                }\n                this.snapshotOps = undefined;\n            }\n\n            // Kick out request to PUSH for ops if it has them\n            this.requestFromSocket(from, to);\n\n            // Cache in normal flow is continuous. Once there is a miss, stop consulting cache.\n            // This saves a bit of processing time\n            if (from < this.firstCacheMiss) {\n                const messagesFromCache = await this.getCached(from, to);\n                this.validateMessages(\"cached\", messagesFromCache, from);\n                if (messagesFromCache.length !== 0) {\n                    opsFromCache += messagesFromCache.length;\n                    return {\n                        messages: messagesFromCache,\n                        partialResult: true,\n                    };\n                }\n                this.firstCacheMiss = Math.min(this.firstCacheMiss, from);\n            }\n\n            if (cachedOnly) {\n                return { messages: [], partialResult: false };\n            }\n\n            const ops = await this.getFromStorage(from, to, telemetryProps, fetchReason);\n            this.validateMessages(\"storage\", ops.messages, from);\n            opsFromStorage += ops.messages.length;\n            this.opsReceived(ops.messages);\n            return ops;\n        };\n\n        const stream = requestOps(\n            async (from: number, to: number, telemetryProps: ITelemetryProperties) => {\n                const result = await requestCallback(from, to, telemetryProps);\n                // Catch all case, just in case\n                this.validateMessages(\"catch all\", result.messages, from);\n                return result;\n            },\n            // Staging: starting with no concurrency, listening for feedback first.\n            // In future releases we will switch to actual concurrency\n            this.concurrency,\n            fromTotal, // inclusive\n            toTotal, // exclusive\n            this.batchSize,\n            this.logger,\n            abortSignal,\n            fetchReason,\n        );\n\n        return streamObserver(stream, (result) => {\n            if (result.done && opsFromSnapshot + opsFromCache + opsFromStorage !== 0) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"CacheOpsRetrieved\",\n                    opsFromSnapshot,\n                    opsFromCache,\n                    opsFromStorage,\n                });\n            }\n        });\n    }\n}\n"]}
+{"version":3,"file":"odspDeltaStorageService.js","sourceRoot":"","sources":["../src/odspDeltaStorageService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,wEAA8D;AAC9D,+BAAkC;AAElC,+DAAsD;AAItD,+DAGsC;AAGtC,2CAA0D;AAE1D;;GAEG;AACH,MAAa,uBAAuB;IAChC,YACqB,YAAoB,EACpB,eAAgD,EAChD,YAA0B,EAC1B,MAAwB;QAHxB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,oBAAe,GAAf,eAAe,CAAiC;QAChD,iBAAY,GAAZ,YAAY,CAAc;QAC1B,WAAM,GAAN,MAAM,CAAkB;IAE7C,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,GAAG,CACb,IAAY,EACZ,EAAU,EACV,cAAoC,EACpC,YAAqB;QAErB,OAAO,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjD,gFAAgF;YAChF,kFAAkF;YAClF,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAEzE,MAAM,YAAY,GAAG,IAAA,SAAI,GAAE,CAAC;YAC5B,IAAI,QAAQ,GAAG,KAAK,YAAY,MAAM,CAAC;YACvC,QAAQ,IAAI,yBAAyB,YAAY,MAAM,CAAC;YACxD,QAAQ,IAAI,iCAAiC,CAAC;YAE9C,QAAQ,IAAI,cAAc,CAAC;YAC3B,QAAQ,IAAI,SAAS,YAAY,IAAI,CAAC;YACtC,MAAM,OAAO,GAA8B;gBACvC,cAAc,EAAE,gCAAgC,YAAY,EAAE;aACjE,CAAC;YAEF,mGAAmG;YACnG,oGAAoG;YACpG,0GAA0G;YAC1G,6EAA6E;YAC7E,kFAAkF;YAClF,MAAM,KAAK,GAAG,IAAI,0BAAe,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;YAErD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,mBAAmB,CACxD,OAAO,EACP;gBACI,OAAO;gBACP,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,KAAK,CAAC,MAAM;aACvB,EACD,KAAK,EACL,IAAI,EACJ,YAAY,CACf,CAAC;YACF,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,oBAAoB,GAAG,QAAQ,CAAC,OAAO,CAAC;YAC9C,IAAI,QAAqC,CAAC;YAC1C,IAAI,oBAAoB,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,IAAI,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBAChF,QAAQ,GAAI,oBAAoB,CAAC,KAAoC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aAC1G;iBAAM;gBACH,QAAQ,GAAG,oBAAoB,CAAC,KAAoC,CAAC;aACxE;YAED,IAAI,CAAC,MAAM,CAAC,oBAAoB,2DAC5B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAC7D,MAAM,EAAE,QAAQ,CAAC,MAAM,EACvB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IACxB,QAAQ,CAAC,UAAU,KACtB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACjC,IAAI;gBACJ,EAAE,KACC,cAAc,KACjB,MAAM,EAAE,YAAY,IACtB,CAAC;YAEH,oGAAoG;YACpG,4GAA4G;YAC5G,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,QAAQ,CAAC,IAAY,EAAE,EAAU;QACpC,MAAM,MAAM,GAAG,kBAAkB,CAAC,qBAAqB,IAAI,0BAA0B,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAC/F,MAAM,WAAW,GAAG,iBAAiB,MAAM,EAAE,CAAC;QAC9C,OAAO,GAAG,IAAI,CAAC,YAAY,GAAG,WAAW,EAAE,CAAC;IAChD,CAAC;CACJ;AA7FD,0DA6FC;AAED,MAAa,yBAAyB;IAGlC,YACY,WAAoD,EAC3C,MAAwB,EACxB,SAAiB,EACjB,WAAmB,EACnB,cAIuC,EACvC,SAA6E,EAC7E,iBAAqD,EACrD,WAAuD;QAXhE,gBAAW,GAAX,WAAW,CAAyC;QAC3C,WAAM,GAAN,MAAM,CAAkB;QACxB,cAAS,GAAT,SAAS,CAAQ;QACjB,gBAAW,GAAX,WAAW,CAAQ;QACnB,mBAAc,GAAd,cAAc,CAIyB;QACvC,cAAS,GAAT,SAAS,CAAoE;QAC7E,sBAAiB,GAAjB,iBAAiB,CAAoC;QACrD,gBAAW,GAAX,WAAW,CAA4C;QAdpE,mBAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC;IAgBjD,CAAC;IAES,gBAAgB,CAAC,MAAc,EAAE,QAAqC,EAAE,IAAY;QAC1F,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;YACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;YACjD,IAAI,KAAK,KAAK,IAAI,EAAE;gBAChB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBAClG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aACvB;YACD,IAAI,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,MAAM,EAAE;gBAC5B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBAClG,uEAAuE;gBACvE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aACvB;SACJ;IACL,CAAC;IAEM,aAAa,CAChB,SAAiB,EACjB,OAA2B,EAC3B,WAAyB,EACzB,UAAoB,EACpB,WAAoB;QACpB,mGAAmG;QACnG,yGAAyG;QACzG,4BAA4B;QAC5B,gGAAgG;QAChG,IAAA,qBAAM,EAAC,CAAC,UAAU,IAAI,OAAO,KAAK,SAAS,EAAE,KAAK,CAAC,CAAC;QAEpD,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,IAAI,cAAc,GAAG,CAAC,CAAC;QAEvB,MAAM,eAAe,GAAG,KAAK,EAAE,IAAY,EAAE,EAAU,EAAE,cAAoC,EAAE,EAAE;YAC7F,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBACjE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC5C,EAAE,CAAC,cAAc,IAAI,IAAI,IAAI,EAAE,CAAC,cAAc,GAAG,EAAE,CAAC,CAAC;gBACzD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;gBAChD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,IAAI,EAAE;oBAC5D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;oBAC5E,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC;oBAClC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;iBAC5C;gBACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;aAChC;YAED,kDAAkD;YAClD,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAEjC,mFAAmF;YACnF,sCAAsC;YACtC,IAAI,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE;gBAC5B,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACzD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;gBACzD,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;oBAChC,YAAY,IAAI,iBAAiB,CAAC,MAAM,CAAC;oBACzC,OAAO;wBACH,QAAQ,EAAE,iBAAiB;wBAC3B,aAAa,EAAE,IAAI;qBACtB,CAAC;iBACL;gBACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;aAC7D;YAED,IAAI,UAAU,EAAE;gBACZ,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;aACjD;YAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;YAC7E,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACrD,cAAc,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;YACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC/B,OAAO,GAAG,CAAC;QACf,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAA,yBAAU,EACrB,KAAK,EAAE,IAAY,EAAE,EAAU,EAAE,cAAoC,EAAE,EAAE;YACrE,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;YAC/D,+BAA+B;YAC/B,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,uEAAuE;QACvE,0DAA0D;QAC1D,IAAI,CAAC,WAAW,EAChB,SAAS,EAAE,YAAY;QACvB,OAAO,EAAE,YAAY;QACrB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,WAAW,EACX,WAAW,CACd,CAAC;QAEF,OAAO,IAAA,6BAAc,EAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;YACrC,IAAI,MAAM,CAAC,IAAI,IAAI,eAAe,GAAG,YAAY,GAAG,cAAc,KAAK,CAAC,EAAE;gBACtE,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,mBAAmB;oBAC9B,eAAe;oBACf,YAAY;oBACZ,cAAc;iBACjB,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA3HD,8DA2HC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { default as AbortController } from \"abort-controller\";\nimport { v4 as uuid } from \"uuid\";\nimport { ITelemetryLogger, ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { assert } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { InstrumentedStorageTokenFetcher } from \"@fluidframework/odsp-driver-definitions\";\nimport { IDeltasFetchResult, IDocumentDeltaStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    requestOps,\n    streamObserver,\n} from \"@fluidframework/driver-utils\";\nimport { IDeltaStorageGetResponse, ISequencedDeltaOpMessage } from \"./contracts\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { getWithRetryForTokenRefresh } from \"./odspUtils\";\n\n/**\n * Provides access to the underlying delta storage on the server for sharepoint driver.\n */\nexport class OdspDeltaStorageService {\n    constructor(\n        private readonly deltaFeedUrl: string,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        private readonly epochTracker: EpochTracker,\n        private readonly logger: ITelemetryLogger,\n    ) {\n    }\n\n    /**\n     * Retrieves ops from cache\n     * @param from - inclusive\n     * @param to - exclusive\n     * @param telemetryProps - properties to add when issuing telemetry events\n     * @param scenarioName - reason for fetching ops\n     * @returns ops retrieved & info if result was partial (i.e. more is available)\n     */\n     public async get(\n        from: number,\n        to: number,\n        telemetryProps: ITelemetryProperties,\n        scenarioName?: string,\n    ): Promise<IDeltasFetchResult> {\n        return getWithRetryForTokenRefresh(async (options) => {\n            // Note - this call ends up in getSocketStorageDiscovery() and can refresh token\n            // Thus it needs to be done before we call getStorageToken() to reduce extra calls\n            const baseUrl = this.buildUrl(from, to);\n            const storageToken = await this.getStorageToken(options, \"DeltaStorage\");\n\n            const formBoundary = uuid();\n            let postBody = `--${formBoundary}\\r\\n`;\n            postBody += `Authorization: Bearer ${storageToken}\\r\\n`;\n            postBody += `X-HTTP-Method-Override: GET\\r\\n`;\n\n            postBody += `_post: 1\\r\\n`;\n            postBody += `\\r\\n--${formBoundary}--`;\n            const headers: { [index: string]: any; } = {\n                \"Content-Type\": `multipart/form-data;boundary=${formBoundary}`,\n            };\n\n            // Some request take a long time (1-2 minutes) to complete, where telemetry shows very small amount\n            // of time spent on server, and usually small payload sizes. I.e. all the time is spent somewhere in\n            // networking. Even bigger problem - a lot of requests timeout (based on cursory look - after 1-2 minutes)\n            // So adding some timeout to ensure we retry again in hope of faster success.\n            // Please see https://github.com/microsoft/FluidFramework/issues/6997 for details.\n            const abort = new AbortController();\n            const timer = setTimeout(() => abort.abort(), 30000);\n\n            const response = await this.epochTracker.fetchAndParseAsJSON<IDeltaStorageGetResponse>(\n                baseUrl,\n                {\n                    headers,\n                    body: postBody,\n                    method: \"POST\",\n                    signal: abort.signal,\n                },\n                \"ops\",\n                true,\n                scenarioName,\n            );\n            clearTimeout(timer);\n            const deltaStorageResponse = response.content;\n            let messages: ISequencedDocumentMessage[];\n            if (deltaStorageResponse.value.length > 0 && \"op\" in deltaStorageResponse.value[0]) {\n                messages = (deltaStorageResponse.value as ISequencedDeltaOpMessage[]).map((operation) => operation.op);\n            } else {\n                messages = deltaStorageResponse.value as ISequencedDocumentMessage[];\n            }\n\n            this.logger.sendPerformanceEvent({\n                eventName: \"OpsFetch\",\n                headers: Object.keys(headers).length !== 0 ? true : undefined,\n                length: messages.length,\n                duration: response.duration, // this duration for single attempt!\n                ...response.propsToLog,\n                attempts: options.refresh ? 2 : 1,\n                from,\n                to,\n                ...telemetryProps,\n                reason: scenarioName,\n            });\n\n            // It is assumed that server always returns all the ops that it has in the range that was requested.\n            // This may change in the future, if so, we need to adjust and receive \"end\" value from server in such case.\n            return { messages, partialResult: false };\n        });\n    }\n\n    public buildUrl(from: number, to: number) {\n        const filter = encodeURIComponent(`sequenceNumber ge ${from} and sequenceNumber le ${to - 1}`);\n        const queryString = `?ump=1&filter=${filter}`;\n        return `${this.deltaFeedUrl}${queryString}`;\n    }\n}\n\nexport class OdspDeltaStorageWithCache implements IDocumentDeltaStorageService {\n    private firstCacheMiss = Number.MAX_SAFE_INTEGER;\n\n    public constructor(\n        private snapshotOps: ISequencedDocumentMessage[] | undefined,\n        private readonly logger: ITelemetryLogger,\n        private readonly batchSize: number,\n        private readonly concurrency: number,\n        private readonly getFromStorage: (\n            from: number,\n            to: number,\n            telemetryProps: ITelemetryProperties,\n            fetchReason?: string) => Promise<IDeltasFetchResult>,\n        private readonly getCached: (from: number, to: number) => Promise<ISequencedDocumentMessage[]>,\n        private readonly requestFromSocket: (from: number, to: number) => void,\n        private readonly opsReceived: (ops: ISequencedDocumentMessage[]) => void,\n    ) {\n    }\n\n    protected validateMessages(reason: string, messages: ISequencedDocumentMessage[], from: number) {\n        if (messages.length !== 0) {\n            const start = messages[0].sequenceNumber;\n            const length = messages.length;\n            const last = messages[length - 1].sequenceNumber;\n            if (start !== from) {\n                this.logger.sendErrorEvent({ eventName: \"OpsFetchViolation\", reason, from, start, last, length });\n                messages.length = 0;\n            }\n            if (last + 1 !== from + length) {\n                this.logger.sendErrorEvent({ eventName: \"OpsFetchViolation\", reason, from, start, last, length });\n                // we can do better here by finding consecutive sub-block and return it\n                messages.length = 0;\n            }\n        }\n    }\n\n    public fetchMessages(\n        fromTotal: number,\n        toTotal: number | undefined,\n        abortSignal?: AbortSignal,\n        cachedOnly?: boolean,\n        fetchReason?: string) {\n        // We do not control what's in the cache. Current API assumes that fetchMessages() keeps banging on\n        // storage / cache until it gets ops it needs. This would result in deadlock if fixed range is asked from\n        // cache and it's not there.\n        // Better implementation would be to return only what we have in cache, but that also breaks API\n        assert(!cachedOnly || toTotal === undefined, 0x1e3);\n\n        let opsFromSnapshot = 0;\n        let opsFromCache = 0;\n        let opsFromStorage = 0;\n\n        const requestCallback = async (from: number, to: number, telemetryProps: ITelemetryProperties) => {\n            if (this.snapshotOps !== undefined && this.snapshotOps.length !== 0) {\n                const messages = this.snapshotOps.filter((op) =>\n                    op.sequenceNumber >= from && op.sequenceNumber < to);\n                this.validateMessages(\"cached\", messages, from);\n                if (messages.length > 0 && messages[0].sequenceNumber === from) {\n                    this.snapshotOps = this.snapshotOps.filter((op) => op.sequenceNumber >= to);\n                    opsFromSnapshot = messages.length;\n                    return { messages, partialResult: true };\n                }\n                this.snapshotOps = undefined;\n            }\n\n            // Kick out request to PUSH for ops if it has them\n            this.requestFromSocket(from, to);\n\n            // Cache in normal flow is continuous. Once there is a miss, stop consulting cache.\n            // This saves a bit of processing time\n            if (from < this.firstCacheMiss) {\n                const messagesFromCache = await this.getCached(from, to);\n                this.validateMessages(\"cached\", messagesFromCache, from);\n                if (messagesFromCache.length !== 0) {\n                    opsFromCache += messagesFromCache.length;\n                    return {\n                        messages: messagesFromCache,\n                        partialResult: true,\n                    };\n                }\n                this.firstCacheMiss = Math.min(this.firstCacheMiss, from);\n            }\n\n            if (cachedOnly) {\n                return { messages: [], partialResult: false };\n            }\n\n            const ops = await this.getFromStorage(from, to, telemetryProps, fetchReason);\n            this.validateMessages(\"storage\", ops.messages, from);\n            opsFromStorage += ops.messages.length;\n            this.opsReceived(ops.messages);\n            return ops;\n        };\n\n        const stream = requestOps(\n            async (from: number, to: number, telemetryProps: ITelemetryProperties) => {\n                const result = await requestCallback(from, to, telemetryProps);\n                // Catch all case, just in case\n                this.validateMessages(\"catch all\", result.messages, from);\n                return result;\n            },\n            // Staging: starting with no concurrency, listening for feedback first.\n            // In future releases we will switch to actual concurrency\n            this.concurrency,\n            fromTotal, // inclusive\n            toTotal, // exclusive\n            this.batchSize,\n            this.logger,\n            abortSignal,\n            fetchReason,\n        );\n\n        return streamObserver(stream, (result) => {\n            if (result.done && opsFromSnapshot + opsFromCache + opsFromStorage !== 0) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"CacheOpsRetrieved\",\n                    opsFromSnapshot,\n                    opsFromCache,\n                    opsFromStorage,\n                });\n            }\n        });\n    }\n}\n"]}

package/dist/odspDocumentService.d.ts

@@ -46,6 +46,7 @@ export declare class OdspDocumentService implements IDocumentService {
     private readonly hostPolicy;
     private _opsCache?;
     private currentConnection?;
+    private relayServiceTenantAndSessionId;
     /**
      * @param odspResolvedUrl - resolved url identifying document that will be managed by this service instance.
      * @param getStorageToken - function that can provide the storage token. This is is also referred to as

package/dist/odspDocumentService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentService.d.ts","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAStE,OAAO,EACH,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EAE3B,MAAM,oCAAoC,CAAC;AAO5C,OAAO,EACH,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EAEjB,iBAAiB,EACjB,+BAA+B,EAElC,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EAAE,EAAE,IAAI,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAOzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,gBAAgB;aAuEpC,eAAe,EAAE,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAElC,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK;IAEtB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IA/ExC,OAAO,CAAC,SAAS,CAA2B;IAE5C,OAAO,CAAC,uBAAuB,CAA4C;IAC3E;;;;;;;;;;;;;OAaG;WACiB,MAAM,CACtB,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,+BAA+B,EAChD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,SAAS,EACvF,MAAM,EAAE,gBAAgB,EACxB,qBAAqB,EAAE,MAAM,OAAO,CAAC,OAAO,oBAAoB,CAAC,EACjE,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,iBAAiB,EAC7B,YAAY,EAAE,YAAY,EAC1B,wBAAwB,CAAC,EAAE,MAAM,EACjC,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAe5B,OAAO,CAAC,cAAc,CAAC,CAA6B;IAEpD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA4B;IAEvD,OAAO,CAAC,SAAS,CAAC,CAAW;IAE7B,OAAO,CAAC,iBAAiB,CAAC,CAA8B;IAExD;;;;;;;;;;;;;OAaG;IACH,OAAO;IAiCP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAwBjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IA+B3E,uEAAuE;IACvE,OAAO,CAAC,uBAAuB;IAW/B;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAuErF,OAAO,CAAC,qBAAqB;YAOf,0BAA0B;YAa1B,WAAW;YA0BX,eAAe;IA2E7B,OAAO,CAAC,gCAAgC;IAKxC;;;;;;;;;OASG;YACW,qBAAqB;IAkC5B,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAa1B,SAAS,KAAK,QAAQ,yBA8BrB;IAID,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB,EAAE;CAQzD"}
+{"version":3,"file":"odspDocumentService.d.ts","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAStE,OAAO,EACH,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EAE3B,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EAEjB,iBAAiB,EACjB,+BAA+B,EAElC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,EAAE,IAAI,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAOzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,gBAAgB;aAyEpC,eAAe,EAAE,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAElC,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK;IAEtB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAjFxC,OAAO,CAAC,SAAS,CAA2B;IAE5C,OAAO,CAAC,uBAAuB,CAA4C;IAC3E;;;;;;;;;;;;;OAaG;WACiB,MAAM,CACtB,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,+BAA+B,EAChD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,SAAS,EACvF,MAAM,EAAE,gBAAgB,EACxB,qBAAqB,EAAE,MAAM,OAAO,CAAC,OAAO,oBAAoB,CAAC,EACjE,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,iBAAiB,EAC7B,YAAY,EAAE,YAAY,EAC1B,wBAAwB,CAAC,EAAE,MAAM,EACjC,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAe5B,OAAO,CAAC,cAAc,CAAC,CAA6B;IAEpD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA4B;IAEvD,OAAO,CAAC,SAAS,CAAC,CAAW;IAE7B,OAAO,CAAC,iBAAiB,CAAC,CAA8B;IAExD,OAAO,CAAC,8BAA8B,CAAqB;IAE3D;;;;;;;;;;;;;OAaG;IACH,OAAO;IAiCP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IA6BjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IA+B3E,uEAAuE;IACvE,OAAO,CAAC,uBAAuB;IAW/B;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAuErF,OAAO,CAAC,qBAAqB;YAOf,0BAA0B;YAa1B,WAAW;YA2BX,eAAe;IA2E7B,OAAO,CAAC,gCAAgC;IAKxC;;;;;;;;;OASG;YACW,qBAAqB;IAkC5B,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAa1B,SAAS,KAAK,QAAQ,yBA8BrB;IAID,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB,EAAE;CAQzD"}

package/dist/odspDocumentService.js

@@ -10,6 +10,7 @@ const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const driver_definitions_1 = require("@fluidframework/driver-definitions");
 const driver_utils_1 = require("@fluidframework/driver-utils");
 const odsp_driver_definitions_1 = require("@fluidframework/odsp-driver-definitions");
+const odsp_doclib_utils_1 = require("@fluidframework/odsp-doclib-utils");
 const odspDeltaStorageService_1 = require("./odspDeltaStorageService");
 const odspDocumentDeltaConnection_1 = require("./odspDocumentDeltaConnection");
 const odspDocumentStorageManager_1 = require("./odspDocumentStorageManager");
@@ -99,6 +100,9 @@ class OdspDocumentService {
                     return this.currentConnection.flush();
                 }
                 throw new Error("Disconnected while uploading summary (attempt to perform flush())");
+            }, () => {
+                (0, common_utils_1.assert)(this.relayServiceTenantAndSessionId !== undefined, "relayServiceTenantAndSessionId should be present");
+                return this.relayServiceTenantAndSessionId;
             }, this.mc.config.getNumber("Fluid.Driver.Odsp.snapshotFormatFetchType"));
         }
         return new retryErrorsStorageAdapter_1.RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);
@@ -140,6 +144,7 @@ class OdspDocumentService {
     async connectToDeltaStream(client) {
         // Attempt to connect twice, in case we used expired token.
         return (0, odspUtils_1.getWithRetryForTokenRefresh)(async (options) => {
+            var _a;
             // Presence of getWebsocketToken callback dictates whether callback is used for fetching
             // websocket token or whether it is returned with joinSession response payload
             const requestWebsocketTokenFromJoinSession = this.getWebsocketToken === undefined;
@@ -155,7 +160,7 @@ class OdspDocumentService {
                 websocketTokenPromise.catch(annotateAndRethrowConnectionError("getWebsocketToken")),
                 this.socketIoClientFactory().catch(annotateAndRethrowConnectionError("socketIoClientFactory")),
             ]);
-            const finalWebsocketToken = websocketToken !== null && websocketToken !== void 0 ? websocketToken : (websocketEndpoint.socketToken || null);
+            const finalWebsocketToken = websocketToken !== null && websocketToken !== void 0 ? websocketToken : ((_a = websocketEndpoint.socketToken) !== null && _a !== void 0 ? _a : null);
             if (finalWebsocketToken === null) {
                 throw this.annotateConnectionError(new driver_utils_1.NonRetryableError("Websocket token is null", odsp_driver_definitions_1.OdspErrorType.fetchTokenError, { driverVersion: packageVersion_1.pkgVersion }), "getWebsocketToken", !requestWebsocketTokenFromJoinSession);
             }
@@ -206,10 +211,9 @@ class OdspDocumentService {
         });
     }
     async joinSession(requestSocketToken, options) {
-        return this.joinSessionCore(requestSocketToken, options).catch((e) => {
-            const likelyFacetCodes = e;
-            if (Array.isArray(likelyFacetCodes.facetCodes)) {
-                for (const code of likelyFacetCodes.facetCodes) {
+        const response = await this.joinSessionCore(requestSocketToken, options).catch((e) => {
+            if ((0, odsp_doclib_utils_1.hasFacetCodes)(e) && e.facetCodes !== undefined) {
+                for (const code of e.facetCodes) {
                     switch (code) {
                         case "sessionForbiddenOnPreservedFiles":
                         case "sessionForbiddenOnModerationEnabledLibrary":
@@ -226,6 +230,8 @@ class OdspDocumentService {
             }
             throw e;
         });
+        this.relayServiceTenantAndSessionId = `${response.tenantId}/${response.id}`;
+        return response;
     }
     async joinSessionCore(requestSocketToken, options) {
         const disableJoinSessionRefresh = this.mc.config.getBoolean("Fluid.Driver.Odsp.disableJoinSessionRefresh");

package/dist/odspDocumentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentService.js","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAA2D;AAC3D,qEAMyC;AACzC,2EAQ4C;AAC5C,+DAIsC;AAMtC,qFAOiD;AAIjD,uEAA+F;AAC/F,+EAA4E;AAC5E,6EAA0E;AAC1E,2CAAmG;AACnG,mCAA2C;AAC3C,mDAA8C;AAE9C,6CAAwC;AACxC,2EAAwE;AACxE,qDAA+D;AAE/D;;;GAGG;AACH,MAAa,mBAAmB;IAwD5B;;;;;;;;;;;;;OAaG;IACH,YACoB,eAAiC,EAChC,eAAgD,EAChD,iBAAuF,EACxG,MAAwB,EACP,qBAAiE,EACjE,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAT7B,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAAsE;QAEvF,0BAAqB,GAArB,qBAAqB,CAA4C;QACjE,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QACjC,uBAAkB,GAAlB,kBAAkB,CAAU;QAE7C,IAAI,CAAC,SAAS,GAAG;YACb,2DAA2D;YAC3D,WAAW,EAAE,eAAe,CAAC,WAAW,KAAK,SAAS;SACzD,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,cAAc,CAAC;QAC7E,IAAI,CAAC,EAAE,GAAG,IAAA,2CAAyB,EAC/B,6BAAW,CAAC,MAAM,CAAC,MAAM,EACzB,SAAS,EACT;YACI,GAAG,EAAE;gBACD,GAAG,EAAE,IAAA,2BAAW,EAAC,IAAI,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;aACtF;SACJ,CAAC,CAAC,CAAC;QAER,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,IAAI,CAAC,kBAAkB,EAAE;YACzB,IAAI,CAAC,UAAU,mCAAQ,IAAI,CAAC,UAAU,KAAE,gBAAgB,EAAE,IAAI,GAAE,CAAC;SACpE;IACL,CAAC;IAjGD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,WAAyB,EACzB,eAAgD,EAChD,iBAAuF,EACvF,MAAwB,EACxB,qBAAiE,EACjE,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAE5B,OAAO,IAAI,mBAAmB,CAC1B,IAAA,8BAAkB,EAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,qBAAqB,EACrB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,EACxB,kBAAkB,CACrB,CAAC;IACN,CAAC;IA6DD,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QACzB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACtB,IAAI,CAAC,cAAc,GAAG,IAAI,uDAA0B,CAChD,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,IAAI,EACJ,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,YAAY;YACjB,gBAAgB;YAChB,KAAK,IAAI,EAAE;gBACP,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;oBAC1E,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;iBACzC;gBACD,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;YACzF,CAAC,EACD,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,2CAA2C,CAAC,CACxE,CAAC;SACL;QAED,OAAO,IAAI,qDAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB;;QAC9B,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,cAAc,0CAAE,GAAG,mCAAI,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,iDAAuB,CACvC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,EAC9C,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,EAAE,CAAC,MAAM,CACjB,CAAC;QAEF,kEAAkE;QAClE,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,UAAU,CAAC,YAAY,mCAAI,IAAI,CAAC;QACvD,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,CAAC,CAAC;QAC9D,OAAO,IAAI,mDAAyB,CAChC,WAAW,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,SAAS,EACT,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,CAAC,EACnG,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;;YACf,MAAM,GAAG,GAAG,MAAM,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA,CAAC;YAC/C,OAAO,MAAA,GAAkC,mCAAI,EAAE,CAAC;QACpD,CAAC,EACD,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;YACT,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBAC1E,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC/C;QACL,CAAC,EACD,CAAC,GAAgC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAC9D,CAAC;IACN,CAAC;IAED,uEAAuE;IAC/D,uBAAuB,CAC3B,KAAU,EACV,oBAA4B,EAC5B,oBAA6B;QAE7B,OAAO,IAAA,gCAAc,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE;gBAClC,oBAAoB;gBACpB,oBAAoB;aACvB,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAC7C,2DAA2D;QAC3D,OAAO,IAAA,uCAA2B,EAA2B,KAAK,EAAE,OAAO,EAAE,EAAE;YAC3E,wFAAwF;YACxF,8EAA8E;YAC9E,MAAM,oCAAoC,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS,CAAC;YAClF,MAAM,qBAAqB,GAAG,oCAAoC;gBAC9D,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBACvB,CAAC,CAAC,IAAI,CAAC,iBAAkB,CAAC,OAAO,CAAC,CAAC;YAEvC,MAAM,iCAAiC,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,KAAU,EAAE,EAAE;gBACvE,MAAM,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,oCAAoC,CAAC,CAAC;YAC3F,CAAC,CAAC;YAEF,MAAM,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC;YAC3F,MAAM,CAAC,iBAAiB,EAAE,cAAc,EAAE,EAAE,CAAC,GACzC,MAAM,OAAO,CAAC,GAAG,CAAC;gBACd,kBAAkB,CAAC,KAAK,CAAC,iCAAiC,CAAC,aAAa,CAAC,CAAC;gBAC1E,qBAAqB,CAAC,KAAK,CAAC,iCAAiC,CAAC,mBAAmB,CAAC,CAAC;gBACnF,IAAI,CAAC,qBAAqB,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,uBAAuB,CAAC,CAAC;aACjG,CAAC,CAAC;YAEP,MAAM,mBAAmB,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,CAAC,iBAAiB,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC;YACtF,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,MAAM,IAAI,CAAC,uBAAuB,CAC9B,IAAI,gCAAiB,CACjB,yBAAyB,EACzB,uCAAa,CAAC,eAAe,EAC7B,EAAE,aAAa,EAAb,2BAAa,EAAE,CACpB,EACD,mBAAmB,EACnB,CAAC,oCAAoC,CAAC,CAAC;aAC9C;YACD,IAAI;gBACA,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAC/C,iBAAiB,CAAC,QAAQ,EAC1B,iBAAiB,CAAC,EAAE,EACpB,mBAAmB,EACnB,EAAE,EACF,MAAM,EACN,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;gBAC5C,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,GAAgC,EAAE,EAAE;oBACjE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,kGAAkG;gBAClG,uDAAuD;gBACvD,UAAU,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,KAAU,EAAE,EAAE;oBACvC,oFAAoF;oBACpF,IAAI,CAAC,qBAAqB,EAAE,CAAC;oBAC7B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;2BACxC,KAAK,CAAC,SAAS,KAAK,oCAAe,CAAC,kBAAkB,EAAE;wBAC3D,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;qBAC3D;gBACL,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;gBACpC,OAAO,UAAU,CAAC;aACrB;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAExD,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAChD,KAAK,EACL,uBAAuB,EACvB,CAAC,oCAAoC,CAAC,CAAC;gBAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;oBAC7C,eAAe,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC;iBACtF;gBACD,MAAM,eAAe,CAAC;aACzB;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB;QACzB,IAAI,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAAE;YAC5C,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC3C,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;SAC5C;IACL,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,KAAa;QAClD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,CAAC,uBAAuB,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC3C,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;oBAC1C,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;oBACvC,OAAO,EAAE,CAAC;gBACd,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACf,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClB,CAAC,CAAC,CAAC;YACP,CAAC,EAAE,KAAK,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,WAAW,CACrB,kBAA2B,EAC3B,OAA4B;QAE5B,OAAO,IAAI,CAAC,eAAe,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACjE,MAAM,gBAAgB,GAAG,CAAgB,CAAC;YAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;gBAC5C,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,UAAU,EAAE;oBAC5C,QAAQ,IAAI,EAAE;wBACV,KAAK,kCAAkC,CAAC;wBACxC,KAAK,4CAA4C,CAAC;wBAClD,KAAK,mCAAmC;4BACpC,yDAAyD;4BACzD,yCAAyC;4BACzC,8CAA8C;4BAC9C,IAAI,CAAC,SAAS,mCAAQ,IAAI,CAAC,SAAS,KAAE,WAAW,EAAE,IAAI,GAAE,CAAC;4BAC1D,MAAM,IAAI,kDAAmC,CAAC,IAAI,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;wBAC3E;4BACI,SAAS;qBAChB;iBACJ;aACJ;YACD,MAAM,CAAC,CAAC;QACZ,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,eAAe,CACzB,kBAA2B,EAC3B,OAA4B;QAE5B,MAAM,yBAAyB,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,6CAA6C,CAAC,CAAC;QAC3G,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;;YAC5B,MAAM,mBAAmB,GAAG,MAAM,IAAA,wBAAgB,EAC9C,IAAI,CAAC,eAAe,EACpB,sBAAsB,EACtB,MAAM,EACN,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,kBAAkB,EAClB,OAAO,EACP,yBAAyB,EACzB,MAAA,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,8BAA8B,CACjE,CAAC;YACF,OAAO;gBACH,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;gBACrB,mBAAmB;aACtB,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,iCAAiC,GAAG,KAAK,IAAI,EAAE;;YACjD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAChG,wGAAwG;YACxG,qDAAqD;YACrD,SAAS,CAAC,mBAAmB,CAAC,6BAA6B;gBACvD,MAAA,SAAS,CAAC,mBAAmB,CAAC,6BAA6B,mCAAI,IAAI,CAAC;YACxE,uCACO,SAAS,KACZ,mBAAmB,EAAE,IAAI,CAAC,gCAAgC,CACtD,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,mBAAmB,CAAC,6BAA6B,CAAC,IACvF;QACN,CAAC,CAAC;QACF,IAAI,QAAQ,GAAG,MAAM,iCAAiC,EAAE,CAAC;QACzD,sGAAsG;QACtG,8FAA8F;QAC9F,IAAI,QAAQ,CAAC,mBAAmB,IAAI,CAAC,EAAE;YACnC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACxD,QAAQ,GAAG,MAAM,iCAAiC,EAAE,CAAC;SACxD;QACD,IAAI,CAAC,yBAAyB,EAAE;YAC5B,MAAM,KAAK,GAAG;gBACV,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,6BAA6B,EACzB,QAAQ,CAAC,mBAAmB,CAAC,6BAA6B;gBAC9D,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB;aACpD,CAAC;YACF,IAAI,QAAQ,CAAC,mBAAmB,GAAG,CAAC,EAAE;gBAClC,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,mBAAmB,CAAC;qBACxD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACb,MAAM,QAAQ,GAAG,IAAA,8BAAe,EAAC,KAAK,CAAC,CAAC;oBACxC,uDAAuD;oBACvD,IAAI,CAAC,QAAQ,EAAE;wBACX,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;4BAC1B,SAAS,EAAE,yBAAyB;4BACpC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;yBACjC,EACD,KAAK,CACJ,CAAC;qBACL;gBACL,CAAC,CAAC,CAAC;aACV;iBAAM;gBACH,2FAA2F;gBAC3F,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,EAAE,gCAAgC;oBAC3C,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;iBACjC,CAAC,CAAC;aACN;SACJ;QACD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;IACxC,CAAC;IAEO,gCAAgC,CAAC,iBAAyB,EAAE,6BAAqC;QACrG,oDAAoD;QACpD,OAAO,iBAAiB,GAAG,CAAC,CAAC,6BAA6B,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,qBAAqB,CAC/B,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAA+B,EAC/B,MAAe,EACf,YAAoB;QAEpB,MAAM,SAAS,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,MAAM,yDAA2B,CAAC,MAAM,CACvD,QAAQ,EACR,UAAU,EACV,KAAK,EACL,EAAE,EACF,MAAM,EACN,YAAY,EACZ,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,wBAAwB,CAChC,CAAC;QACF,MAAM,QAAQ,GAAG,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAC/C,uEAAuE;QACvE,+EAA+E;QAC/E,sDAAsD;QACtD,IAAI,QAAQ,IAAI,IAAI,EAAE;YAClB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAChC,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ;aACX,CAAC,CAAC;SACN;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,KAAW;;QACtB,4EAA4E;QAC5E,8CAA8C;QAC9C,wFAAwF;QACxF,kEAAkE;QAClE,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SACrD;aAAM;YACH,MAAA,IAAI,CAAC,SAAS,0CAAE,QAAQ,EAAE,CAAC;SAC9B;QACD,MAAA,IAAI,CAAC,SAAS,0CAAE,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED,IAAc,QAAQ;;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,IAAI,CAAC,SAAS,CAAC;SACzB;QAED,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,cAAc,0CAAE,sBAAsB,CAAC;QAC9D,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,SAAS,mCAAI,GAAG,CAAC;QAC/D,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC1C,OAAO;SACV;QAED,MAAM,MAAM,GAAwB;YAChC,IAAI,EAAE,KAAK;SACd,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAQ,CACzB,SAAS,EACT,IAAI,CAAC,EAAE,CAAC,MAAM;QACd,SAAS;QACT;YACI,KAAK,EAAE,KAAK,EAAE,GAAW,EAAE,OAAe,EAAE,EAAE;gBAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAM,MAAM,KAAE,GAAG,KAAI,OAAO,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAM,MAAM,KAAE,GAAG,IAAG;YAC9E,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/E,EACD,SAAS,EACT,MAAA,MAAA,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,gBAAgB,mCAAI,IAAI,EACpD,MAAA,MAAA,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,eAAe,mCAAI,IAAI,CACtD,CAAC;QACF,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,mHAAmH;IACnH,8EAA8E;IACpE,WAAW,CAAC,GAAgC;;QAClD,2CAA2C;QAC3C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACrD,OAAO;SACV;QAED,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;CACJ;AAxeD,kDAweC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { performance } from \"@fluidframework/common-utils\";\nimport {\n    ChildLogger,\n    IFluidErrorBase,\n    loggerToMonitoringContext,\n    MonitoringContext,\n    normalizeError,\n} from \"@fluidframework/telemetry-utils\";\nimport {\n    IDocumentDeltaConnection,\n    IDocumentDeltaStorageService,\n    IDocumentService,\n    IResolvedUrl,\n    IDocumentStorageService,\n    IDocumentServicePolicies,\n    DriverErrorType,\n} from \"@fluidframework/driver-definitions\";\nimport {\n    canRetryOnError,\n    DeltaStreamConnectionForbiddenError,\n    NonRetryableError,\n} from \"@fluidframework/driver-utils\";\nimport { IFacetCodes } from \"@fluidframework/odsp-doclib-utils\";\nimport {\n    IClient,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    IEntry,\n    HostStoragePolicy,\n    InstrumentedStorageTokenFetcher,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport type { io as SocketIOClientStatic } from \"socket.io-client\";\nimport { HostStoragePolicyInternal, ISocketStorageDiscovery } from \"./contracts\";\nimport { IOdspCache } from \"./odspCache\";\nimport { OdspDeltaStorageService, OdspDeltaStorageWithCache } from \"./odspDeltaStorageService\";\nimport { OdspDocumentDeltaConnection } from \"./odspDocumentDeltaConnection\";\nimport { OdspDocumentStorageService } from \"./odspDocumentStorageManager\";\nimport { getWithRetryForTokenRefresh, getOdspResolvedUrl, TokenFetchOptionsEx } from \"./odspUtils\";\nimport { fetchJoinSession } from \"./vroom\";\nimport { isOdcOrigin } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OpsCache } from \"./opsCaching\";\nimport { RetryErrorsStorageAdapter } from \"./retryErrorsStorageAdapter\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n/**\n * The DocumentService manages the Socket.IO connection and manages routing requests to connected\n * clients\n */\nexport class OdspDocumentService implements IDocumentService {\n    private _policies: IDocumentServicePolicies;\n    // Timer which runs and executes the join session call after intervals.\n    private joinSessionRefreshTimer: ReturnType<typeof setTimeout> | undefined;\n    /**\n     * @param resolvedUrl - resolved url identifying document that will be managed by returned service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - This host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by returned service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    public static async create(\n        resolvedUrl: IResolvedUrl,\n        getStorageToken: InstrumentedStorageTokenFetcher,\n        getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        socketIoClientFactory: () => Promise<typeof SocketIOClientStatic>,\n        cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix?: string,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        return new OdspDocumentService(\n            getOdspResolvedUrl(resolvedUrl),\n            getStorageToken,\n            getWebsocketToken,\n            logger,\n            socketIoClientFactory,\n            cache,\n            hostPolicy,\n            epochTracker,\n            socketReferenceKeyPrefix,\n            clientIsSummarizer,\n        );\n    }\n\n    private storageManager?: OdspDocumentStorageService;\n\n    private readonly mc: MonitoringContext;\n\n    private readonly joinSessionKey: string;\n\n    private readonly hostPolicy: HostStoragePolicyInternal;\n\n    private _opsCache?: OpsCache;\n\n    private currentConnection?: OdspDocumentDeltaConnection;\n\n    /**\n     * @param odspResolvedUrl - resolved url identifying document that will be managed by this service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by this service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    private constructor(\n        public readonly odspResolvedUrl: IOdspResolvedUrl,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        private readonly getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        private readonly socketIoClientFactory: () => Promise<typeof SocketIOClientStatic>,\n        private readonly cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        private readonly epochTracker: EpochTracker,\n        private readonly socketReferenceKeyPrefix?: string,\n        private readonly clientIsSummarizer?: boolean,\n    ) {\n        this._policies = {\n            // load in storage-only mode if a file version is specified\n            storageOnly: odspResolvedUrl.fileVersion !== undefined,\n        };\n\n        this.joinSessionKey = `${this.odspResolvedUrl.hashedDocumentId}/joinsession`;\n        this.mc = loggerToMonitoringContext(\n            ChildLogger.create(logger,\n            undefined,\n            {\n                all: {\n                    odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),\n                },\n            }));\n\n        this.hostPolicy = hostPolicy;\n        if (this.clientIsSummarizer) {\n            this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };\n        }\n    }\n\n    public get resolvedUrl(): IResolvedUrl {\n        return this.odspResolvedUrl;\n    }\n    public get policies() {\n        return this._policies;\n    }\n\n    /**\n     * Connects to a storage endpoint for snapshot service.\n     *\n     * @returns returns the document storage service for sharepoint driver.\n     */\n    public async connectToStorage(): Promise<IDocumentStorageService> {\n        if (!this.storageManager) {\n            this.storageManager = new OdspDocumentStorageService(\n                this.odspResolvedUrl,\n                this.getStorageToken,\n                this.mc.logger,\n                true,\n                this.cache,\n                this.hostPolicy,\n                this.epochTracker,\n                // flushCallback\n                async () => {\n                    if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                        return this.currentConnection.flush();\n                    }\n                    throw new Error(\"Disconnected while uploading summary (attempt to perform flush())\");\n                },\n                this.mc.config.getNumber(\"Fluid.Driver.Odsp.snapshotFormatFetchType\"),\n            );\n        }\n\n        return new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);\n    }\n\n    /**\n     * Connects to a delta storage endpoint for getting ops between a range.\n     *\n     * @returns returns the document delta storage service for sharepoint driver.\n     */\n    public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {\n        const snapshotOps = this.storageManager?.ops ?? [];\n        const service = new OdspDeltaStorageService(\n            this.odspResolvedUrl.endpoints.deltaStorageUrl,\n            this.getStorageToken,\n            this.epochTracker,\n            this.mc.logger,\n        );\n\n        // batch size, please see issue #5211 for data around batch sizing\n        const batchSize = this.hostPolicy.opsBatchSize ?? 5000;\n        const concurrency = this.hostPolicy.concurrentOpsBatches ?? 1;\n        return new OdspDeltaStorageWithCache(\n            snapshotOps,\n            this.mc.logger,\n            batchSize,\n            concurrency,\n            async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason),\n            async (from, to) => {\n                const res = await this.opsCache?.get(from, to);\n                return res as ISequencedDocumentMessage[] ?? [];\n            },\n            (from, to) => {\n                if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                    this.currentConnection.requestOps(from, to);\n                }\n            },\n            (ops: ISequencedDocumentMessage[]) => this.opsReceived(ops),\n        );\n    }\n\n    /** Annotate the given error indicating which connection step failed */\n    private annotateConnectionError(\n        error: any,\n        failedConnectionStep: string,\n        separateTokenRequest: boolean,\n    ): IFluidErrorBase {\n        return normalizeError(error, { props: {\n            failedConnectionStep,\n            separateTokenRequest,\n        } });\n    }\n\n    /**\n     * Connects to a delta stream endpoint for emitting ops.\n     *\n     * @returns returns the document delta stream service for onedrive/sharepoint driver.\n     */\n    public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {\n        // Attempt to connect twice, in case we used expired token.\n        return getWithRetryForTokenRefresh<IDocumentDeltaConnection>(async (options) => {\n            // Presence of getWebsocketToken callback dictates whether callback is used for fetching\n            // websocket token or whether it is returned with joinSession response payload\n            const requestWebsocketTokenFromJoinSession = this.getWebsocketToken === undefined;\n            const websocketTokenPromise = requestWebsocketTokenFromJoinSession\n                ? Promise.resolve(null)\n                : this.getWebsocketToken!(options);\n\n            const annotateAndRethrowConnectionError = (step: string) => (error: any) => {\n                throw this.annotateConnectionError(error, step, !requestWebsocketTokenFromJoinSession);\n            };\n\n            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options);\n            const [websocketEndpoint, websocketToken, io] =\n                await Promise.all([\n                    joinSessionPromise.catch(annotateAndRethrowConnectionError(\"joinSession\")),\n                    websocketTokenPromise.catch(annotateAndRethrowConnectionError(\"getWebsocketToken\")),\n                    this.socketIoClientFactory().catch(annotateAndRethrowConnectionError(\"socketIoClientFactory\")),\n                ]);\n\n            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken || null);\n            if (finalWebsocketToken === null) {\n                throw this.annotateConnectionError(\n                    new NonRetryableError(\n                        \"Websocket token is null\",\n                        OdspErrorType.fetchTokenError,\n                        { driverVersion },\n                    ),\n                    \"getWebsocketToken\",\n                    !requestWebsocketTokenFromJoinSession);\n            }\n            try {\n                const connection = await this.createDeltaConnection(\n                    websocketEndpoint.tenantId,\n                    websocketEndpoint.id,\n                    finalWebsocketToken,\n                    io,\n                    client,\n                    websocketEndpoint.deltaStreamSocketUrl);\n                connection.on(\"op\", (documentId, ops: ISequencedDocumentMessage[]) => {\n                    this.opsReceived(ops);\n                });\n                // On disconnect with 401/403 error code, we can just clear the joinSession cache as we will again\n                // get the auth error on reconnecting and face latency.\n                connection.on(\"disconnect\", (error: any) => {\n                    // Clear the join session refresh timer so that it can be restarted on reconnection.\n                    this.clearJoinSessionTimer();\n                    if (typeof error === \"object\" && error !== null\n                        && error.errorType === DriverErrorType.authorizationError) {\n                        this.cache.sessionJoinCache.remove(this.joinSessionKey);\n                    }\n                });\n                this.currentConnection = connection;\n                return connection;\n            } catch (error) {\n                this.cache.sessionJoinCache.remove(this.joinSessionKey);\n\n                const normalizedError = this.annotateConnectionError(\n                    error,\n                    \"createDeltaConnection\",\n                    !requestWebsocketTokenFromJoinSession);\n                if (typeof error === \"object\" && error !== null) {\n                    normalizedError.addTelemetryProperties({ socketDocumentId: websocketEndpoint.id });\n                }\n                throw normalizedError;\n            }\n        });\n    }\n\n    private clearJoinSessionTimer() {\n        if (this.joinSessionRefreshTimer !== undefined) {\n            clearTimeout(this.joinSessionRefreshTimer);\n            this.joinSessionRefreshTimer = undefined;\n        }\n    }\n\n    private async scheduleJoinSessionRefresh(delta: number) {\n        await new Promise<void>((resolve, reject) => {\n            this.joinSessionRefreshTimer = setTimeout(() => {\n                getWithRetryForTokenRefresh(async (options) => {\n                    await this.joinSession(false, options);\n                    resolve();\n                }).catch((error) => {\n                    reject(error);\n                });\n            }, delta);\n        });\n    }\n\n    private async joinSession(\n        requestSocketToken: boolean,\n        options: TokenFetchOptionsEx,\n    ) {\n        return this.joinSessionCore(requestSocketToken, options).catch((e) => {\n            const likelyFacetCodes = e as IFacetCodes;\n            if (Array.isArray(likelyFacetCodes.facetCodes)) {\n                for (const code of likelyFacetCodes.facetCodes) {\n                    switch (code) {\n                        case \"sessionForbiddenOnPreservedFiles\":\n                        case \"sessionForbiddenOnModerationEnabledLibrary\":\n                        case \"sessionForbiddenOnRequireCheckout\":\n                            // This document can only be opened in storage-only mode.\n                            // DeltaManager will recognize this error\n                            // and load without a delta stream connection.\n                            this._policies = { ...this._policies, storageOnly: true };\n                            throw new DeltaStreamConnectionForbiddenError(code, { driverVersion });\n                        default:\n                            continue;\n                    }\n                }\n            }\n            throw e;\n        });\n    }\n\n    private async joinSessionCore(\n        requestSocketToken: boolean,\n        options: TokenFetchOptionsEx,\n    ): Promise<ISocketStorageDiscovery> {\n        const disableJoinSessionRefresh = this.mc.config.getBoolean(\"Fluid.Driver.Odsp.disableJoinSessionRefresh\");\n        const executeFetch = async () => {\n            const joinSessionResponse = await fetchJoinSession(\n                this.odspResolvedUrl,\n                \"opStream/joinSession\",\n                \"POST\",\n                this.mc.logger,\n                this.getStorageToken,\n                this.epochTracker,\n                requestSocketToken,\n                options,\n                disableJoinSessionRefresh,\n                this.hostPolicy.sessionOptions?.unauthenticatedUserDisplayName,\n            );\n            return {\n                entryTime: Date.now(),\n                joinSessionResponse,\n            };\n        };\n\n        const getResponseAndRefreshAfterDeltaMs = async () => {\n            const _response = await this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);\n            // If the response does not contain refreshSessionDurationSeconds, then treat it as old flow and let the\n            // cache entry to be treated as expired after 1 hour.\n            _response.joinSessionResponse.refreshSessionDurationSeconds =\n                _response.joinSessionResponse.refreshSessionDurationSeconds ?? 3600;\n            return {\n                ..._response,\n                refreshAfterDeltaMs: this.calculateJoinSessionRefreshDelta(\n                    _response.entryTime, _response.joinSessionResponse.refreshSessionDurationSeconds),\n            };\n        };\n        let response = await getResponseAndRefreshAfterDeltaMs();\n        // This means that the cached entry has expired(This should not be possible if the response is fetched\n        // from the network call). In this case we remove the cached entry and fetch the new response.\n        if (response.refreshAfterDeltaMs <= 0) {\n            this.cache.sessionJoinCache.remove(this.joinSessionKey);\n            response = await getResponseAndRefreshAfterDeltaMs();\n        }\n        if (!disableJoinSessionRefresh) {\n            const props = {\n                entryTime: response.entryTime,\n                refreshSessionDurationSeconds:\n                    response.joinSessionResponse.refreshSessionDurationSeconds,\n                refreshAfterDeltaMs: response.refreshAfterDeltaMs,\n            };\n            if (response.refreshAfterDeltaMs > 0) {\n                this.scheduleJoinSessionRefresh(response.refreshAfterDeltaMs)\n                    .catch((error) => {\n                        const canRetry = canRetryOnError(error);\n                        // Only record error event in case it is non retriable.\n                        if (!canRetry) {\n                            this.mc.logger.sendErrorEvent({\n                                eventName: \"JoinSessionRefreshError\",\n                                details: JSON.stringify(props),\n                            },\n                            error,\n                            );\n                        }\n                    });\n            } else {\n                // Logging just for informational purposes to help with debugging as this is a new feature.\n                this.mc.logger.sendTelemetryEvent({\n                    eventName: \"JoinSessionRefreshNotScheduled\",\n                    details: JSON.stringify(props),\n                });\n            }\n        }\n        return response.joinSessionResponse;\n    }\n\n    private calculateJoinSessionRefreshDelta(responseFetchTime: number, refreshSessionDurationSeconds: number) {\n        // 30 seconds is buffer time to refresh the session.\n        return responseFetchTime + ((refreshSessionDurationSeconds * 1000) - 30000) - Date.now();\n    }\n\n    /**\n     * Creats a connection to the given delta stream endpoint\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for delta service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param webSocketUrl - websocket URL\n     */\n    private async createDeltaConnection(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: typeof SocketIOClientStatic,\n        client: IClient,\n        webSocketUrl: string,\n    ): Promise<OdspDocumentDeltaConnection> {\n        const startTime = performance.now();\n        const connection = await OdspDocumentDeltaConnection.create(\n            tenantId,\n            documentId,\n            token,\n            io,\n            client,\n            webSocketUrl,\n            this.mc.logger,\n            60000,\n            this.epochTracker,\n            this.socketReferenceKeyPrefix,\n        );\n        const duration = performance.now() - startTime;\n        // This event happens rather often, so it adds up to cost of telemetry.\n        // Given that most reconnects result in reusing socket and happen very quickly,\n        // report event only if it took longer than threshold.\n        if (duration >= 2000) {\n            this.mc.logger.sendPerformanceEvent({\n                eventName: \"ConnectionSuccess\",\n                duration,\n            });\n        }\n        return connection;\n    }\n\n    public dispose(error?: any) {\n        // Error might indicate mismatch between client & server knowlege about file\n        // (DriverErrorType.fileOverwrittenInStorage).\n        // For example, file might have been overwritten in storage without generating new epoch\n        // In such case client cached info is stale and has to be removed.\n        if (error !== undefined) {\n            this.epochTracker.removeEntries().catch(() => {});\n        } else {\n            this._opsCache?.flushOps();\n        }\n        this._opsCache?.dispose();\n    }\n\n    protected get opsCache() {\n        if (this._opsCache) {\n            return this._opsCache;\n        }\n\n        const seqNumber = this.storageManager?.snapshotSequenceNumber;\n        const batchSize = this.hostPolicy.opsCaching?.batchSize ?? 100;\n        if (seqNumber === undefined || batchSize < 1) {\n            return;\n        }\n\n        const opsKey: Omit<IEntry, \"key\"> = {\n            type: \"ops\",\n        };\n        this._opsCache = new OpsCache(\n            seqNumber,\n            this.mc.logger,\n            // ICache\n            {\n                write: async (key: string, opsData: string) => {\n                    return this.cache.persistedCache.put({ ...opsKey, key }, opsData);\n                },\n                read: async (key: string) => this.cache.persistedCache.get({ ...opsKey, key }),\n                remove: () => { this.cache.persistedCache.removeEntries().catch(() => {}); },\n            },\n            batchSize,\n            this.hostPolicy.opsCaching?.timerGranularity ?? 5000,\n            this.hostPolicy.opsCaching?.totalOpsToCache ?? 5000,\n        );\n        return this._opsCache;\n    }\n\n    // Called whenever re receive ops through any channel for this document (snapshot, delta connection, delta storage)\n    // We use it to notify caching layer of how stale is snapshot stored in cache.\n    protected opsReceived(ops: ISequencedDocumentMessage[]) {\n        // No need for two clients to save same ops\n        if (ops.length === 0 || this.odspResolvedUrl.summarizer) {\n            return;\n        }\n\n        this.opsCache?.addOps(ops);\n    }\n}\n"]}
+{"version":3,"file":"odspDocumentService.js","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAmE;AACnE,qEAMyC;AACzC,2EAQ4C;AAC5C,+DAAuH;AAKvH,qFAOiD;AACjD,yEAAkE;AAIlE,uEAA+F;AAC/F,+EAA4E;AAC5E,6EAA0E;AAC1E,2CAAmG;AACnG,mCAA2C;AAC3C,mDAA8C;AAE9C,6CAAwC;AACxC,2EAAwE;AACxE,qDAA+D;AAE/D;;;GAGG;AACH,MAAa,mBAAmB;IA0D5B;;;;;;;;;;;;;OAaG;IACH,YACoB,eAAiC,EAChC,eAAgD,EAChD,iBAAuF,EACxG,MAAwB,EACP,qBAAiE,EACjE,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAT7B,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAAsE;QAEvF,0BAAqB,GAArB,qBAAqB,CAA4C;QACjE,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QACjC,uBAAkB,GAAlB,kBAAkB,CAAU;QAE7C,IAAI,CAAC,SAAS,GAAG;YACb,2DAA2D;YAC3D,WAAW,EAAE,eAAe,CAAC,WAAW,KAAK,SAAS;SACzD,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,cAAc,CAAC;QAC7E,IAAI,CAAC,EAAE,GAAG,IAAA,2CAAyB,EAC/B,6BAAW,CAAC,MAAM,CAAC,MAAM,EACzB,SAAS,EACT;YACI,GAAG,EAAE;gBACD,GAAG,EAAE,IAAA,2BAAW,EAAC,IAAI,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;aACtF;SACJ,CAAC,CAAC,CAAC;QAER,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,IAAI,CAAC,kBAAkB,EAAE;YACzB,IAAI,CAAC,UAAU,mCAAQ,IAAI,CAAC,UAAU,KAAE,gBAAgB,EAAE,IAAI,GAAE,CAAC;SACpE;IACL,CAAC;IAnGD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,WAAyB,EACzB,eAAgD,EAChD,iBAAuF,EACvF,MAAwB,EACxB,qBAAiE,EACjE,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAE5B,OAAO,IAAI,mBAAmB,CAC1B,IAAA,8BAAkB,EAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,qBAAqB,EACrB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,EACxB,kBAAkB,CACrB,CAAC;IACN,CAAC;IA+DD,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QACzB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACtB,IAAI,CAAC,cAAc,GAAG,IAAI,uDAA0B,CAChD,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,IAAI,EACJ,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,YAAY;YACjB,gBAAgB;YAChB,KAAK,IAAI,EAAE;gBACP,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;oBAC1E,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;iBACzC;gBACD,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;YACzF,CAAC,EACD,GAAG,EAAE;gBACD,IAAA,qBAAM,EAAC,IAAI,CAAC,8BAA8B,KAAK,SAAS,EACpD,kDAAkD,CAAC,CAAC;gBACxD,OAAO,IAAI,CAAC,8BAA8B,CAAC;YAC/C,CAAC,EACD,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,2CAA2C,CAAC,CACxE,CAAC;SACL;QAED,OAAO,IAAI,qDAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB;;QAC9B,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,cAAc,0CAAE,GAAG,mCAAI,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,iDAAuB,CACvC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,EAC9C,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,EAAE,CAAC,MAAM,CACjB,CAAC;QAEF,kEAAkE;QAClE,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,UAAU,CAAC,YAAY,mCAAI,IAAI,CAAC;QACvD,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,CAAC,CAAC;QAC9D,OAAO,IAAI,mDAAyB,CAChC,WAAW,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,SAAS,EACT,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,CAAC,EACnG,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;;YACf,MAAM,GAAG,GAAG,MAAM,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA,CAAC;YAC/C,OAAO,MAAA,GAAkC,mCAAI,EAAE,CAAC;QACpD,CAAC,EACD,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;YACT,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBAC1E,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC/C;QACL,CAAC,EACD,CAAC,GAAgC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAC9D,CAAC;IACN,CAAC;IAED,uEAAuE;IAC/D,uBAAuB,CAC3B,KAAU,EACV,oBAA4B,EAC5B,oBAA6B;QAE7B,OAAO,IAAA,gCAAc,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE;gBAClC,oBAAoB;gBACpB,oBAAoB;aACvB,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAC7C,2DAA2D;QAC3D,OAAO,IAAA,uCAA2B,EAA2B,KAAK,EAAE,OAAO,EAAE,EAAE;;YAC3E,wFAAwF;YACxF,8EAA8E;YAC9E,MAAM,oCAAoC,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS,CAAC;YAClF,MAAM,qBAAqB,GAAG,oCAAoC;gBAC9D,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBACvB,CAAC,CAAC,IAAI,CAAC,iBAAkB,CAAC,OAAO,CAAC,CAAC;YAEvC,MAAM,iCAAiC,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,KAAU,EAAE,EAAE;gBACvE,MAAM,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,oCAAoC,CAAC,CAAC;YAC3F,CAAC,CAAC;YAEF,MAAM,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC;YAC3F,MAAM,CAAC,iBAAiB,EAAE,cAAc,EAAE,EAAE,CAAC,GACzC,MAAM,OAAO,CAAC,GAAG,CAAC;gBACd,kBAAkB,CAAC,KAAK,CAAC,iCAAiC,CAAC,aAAa,CAAC,CAAC;gBAC1E,qBAAqB,CAAC,KAAK,CAAC,iCAAiC,CAAC,mBAAmB,CAAC,CAAC;gBACnF,IAAI,CAAC,qBAAqB,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,uBAAuB,CAAC,CAAC;aACjG,CAAC,CAAC;YAEP,MAAM,mBAAmB,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,CAAC,MAAA,iBAAiB,CAAC,WAAW,mCAAI,IAAI,CAAC,CAAC;YACtF,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,MAAM,IAAI,CAAC,uBAAuB,CAC9B,IAAI,gCAAiB,CACjB,yBAAyB,EACzB,uCAAa,CAAC,eAAe,EAC7B,EAAE,aAAa,EAAb,2BAAa,EAAE,CACpB,EACD,mBAAmB,EACnB,CAAC,oCAAoC,CAAC,CAAC;aAC9C;YACD,IAAI;gBACA,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAC/C,iBAAiB,CAAC,QAAQ,EAC1B,iBAAiB,CAAC,EAAE,EACpB,mBAAmB,EACnB,EAAE,EACF,MAAM,EACN,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;gBAC5C,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,GAAgC,EAAE,EAAE;oBACjE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,kGAAkG;gBAClG,uDAAuD;gBACvD,UAAU,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,KAAU,EAAE,EAAE;oBACvC,oFAAoF;oBACpF,IAAI,CAAC,qBAAqB,EAAE,CAAC;oBAC7B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;2BACxC,KAAK,CAAC,SAAS,KAAK,oCAAe,CAAC,kBAAkB,EAAE;wBAC3D,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;qBAC3D;gBACL,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;gBACpC,OAAO,UAAU,CAAC;aACrB;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAExD,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAChD,KAAK,EACL,uBAAuB,EACvB,CAAC,oCAAoC,CAAC,CAAC;gBAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;oBAC7C,eAAe,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC;iBACtF;gBACD,MAAM,eAAe,CAAC;aACzB;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB;QACzB,IAAI,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAAE;YAC5C,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC3C,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;SAC5C;IACL,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,KAAa;QAClD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,CAAC,uBAAuB,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC3C,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;oBAC1C,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;oBACvC,OAAO,EAAE,CAAC;gBACd,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACf,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClB,CAAC,CAAC,CAAC;YACP,CAAC,EAAE,KAAK,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,WAAW,CACrB,kBAA2B,EAC3B,OAA4B;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACjF,IAAI,IAAA,iCAAa,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS,EAAE;gBAChD,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,UAAU,EAAE;oBAC7B,QAAQ,IAAI,EAAE;wBACV,KAAK,kCAAkC,CAAC;wBACxC,KAAK,4CAA4C,CAAC;wBAClD,KAAK,mCAAmC;4BACpC,yDAAyD;4BACzD,yCAAyC;4BACzC,8CAA8C;4BAC9C,IAAI,CAAC,SAAS,mCAAQ,IAAI,CAAC,SAAS,KAAE,WAAW,EAAE,IAAI,GAAE,CAAC;4BAC1D,MAAM,IAAI,kDAAmC,CAAC,IAAI,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;wBAC3E;4BACI,SAAS;qBAChB;iBACJ;aACJ;YACD,MAAM,CAAC,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,8BAA8B,GAAG,GAAG,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;QAC5E,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,eAAe,CACzB,kBAA2B,EAC3B,OAA4B;QAE5B,MAAM,yBAAyB,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,6CAA6C,CAAC,CAAC;QAC3G,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;;YAC5B,MAAM,mBAAmB,GAAG,MAAM,IAAA,wBAAgB,EAC9C,IAAI,CAAC,eAAe,EACpB,sBAAsB,EACtB,MAAM,EACN,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,kBAAkB,EAClB,OAAO,EACP,yBAAyB,EACzB,MAAA,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,8BAA8B,CACjE,CAAC;YACF,OAAO;gBACH,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;gBACrB,mBAAmB;aACtB,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,iCAAiC,GAAG,KAAK,IAAI,EAAE;;YACjD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAChG,wGAAwG;YACxG,qDAAqD;YACrD,SAAS,CAAC,mBAAmB,CAAC,6BAA6B;gBACvD,MAAA,SAAS,CAAC,mBAAmB,CAAC,6BAA6B,mCAAI,IAAI,CAAC;YACxE,uCACO,SAAS,KACZ,mBAAmB,EAAE,IAAI,CAAC,gCAAgC,CACtD,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,mBAAmB,CAAC,6BAA6B,CAAC,IACvF;QACN,CAAC,CAAC;QACF,IAAI,QAAQ,GAAG,MAAM,iCAAiC,EAAE,CAAC;QACzD,sGAAsG;QACtG,8FAA8F;QAC9F,IAAI,QAAQ,CAAC,mBAAmB,IAAI,CAAC,EAAE;YACnC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACxD,QAAQ,GAAG,MAAM,iCAAiC,EAAE,CAAC;SACxD;QACD,IAAI,CAAC,yBAAyB,EAAE;YAC5B,MAAM,KAAK,GAAG;gBACV,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,6BAA6B,EACzB,QAAQ,CAAC,mBAAmB,CAAC,6BAA6B;gBAC9D,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB;aACpD,CAAC;YACF,IAAI,QAAQ,CAAC,mBAAmB,GAAG,CAAC,EAAE;gBAClC,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,mBAAmB,CAAC;qBACxD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACb,MAAM,QAAQ,GAAG,IAAA,8BAAe,EAAC,KAAK,CAAC,CAAC;oBACxC,uDAAuD;oBACvD,IAAI,CAAC,QAAQ,EAAE;wBACX,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;4BAC1B,SAAS,EAAE,yBAAyB;4BACpC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;yBACjC,EACD,KAAK,CACJ,CAAC;qBACL;gBACL,CAAC,CAAC,CAAC;aACV;iBAAM;gBACH,2FAA2F;gBAC3F,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,EAAE,gCAAgC;oBAC3C,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;iBACjC,CAAC,CAAC;aACN;SACJ;QACD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;IACxC,CAAC;IAEO,gCAAgC,CAAC,iBAAyB,EAAE,6BAAqC;QACrG,oDAAoD;QACpD,OAAO,iBAAiB,GAAG,CAAC,CAAC,6BAA6B,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,qBAAqB,CAC/B,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAA+B,EAC/B,MAAe,EACf,YAAoB;QAEpB,MAAM,SAAS,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,MAAM,yDAA2B,CAAC,MAAM,CACvD,QAAQ,EACR,UAAU,EACV,KAAK,EACL,EAAE,EACF,MAAM,EACN,YAAY,EACZ,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,wBAAwB,CAChC,CAAC;QACF,MAAM,QAAQ,GAAG,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAC/C,uEAAuE;QACvE,+EAA+E;QAC/E,sDAAsD;QACtD,IAAI,QAAQ,IAAI,IAAI,EAAE;YAClB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAChC,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ;aACX,CAAC,CAAC;SACN;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,KAAW;;QACtB,4EAA4E;QAC5E,8CAA8C;QAC9C,wFAAwF;QACxF,kEAAkE;QAClE,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SACrD;aAAM;YACH,MAAA,IAAI,CAAC,SAAS,0CAAE,QAAQ,EAAE,CAAC;SAC9B;QACD,MAAA,IAAI,CAAC,SAAS,0CAAE,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED,IAAc,QAAQ;;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,IAAI,CAAC,SAAS,CAAC;SACzB;QAED,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,cAAc,0CAAE,sBAAsB,CAAC;QAC9D,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,SAAS,mCAAI,GAAG,CAAC;QAC/D,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC1C,OAAO;SACV;QAED,MAAM,MAAM,GAAwB;YAChC,IAAI,EAAE,KAAK;SACd,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAQ,CACzB,SAAS,EACT,IAAI,CAAC,EAAE,CAAC,MAAM;QACd,SAAS;QACT;YACI,KAAK,EAAE,KAAK,EAAE,GAAW,EAAE,OAAe,EAAE,EAAE;gBAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAM,MAAM,KAAE,GAAG,KAAI,OAAO,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAM,MAAM,KAAE,GAAG,IAAG;YAC9E,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/E,EACD,SAAS,EACT,MAAA,MAAA,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,gBAAgB,mCAAI,IAAI,EACpD,MAAA,MAAA,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,eAAe,mCAAI,IAAI,CACtD,CAAC;QACF,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,mHAAmH;IACnH,8EAA8E;IACpE,WAAW,CAAC,GAAgC;;QAClD,2CAA2C;QAC3C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACrD,OAAO;SACV;QAED,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;CACJ;AAhfD,kDAgfC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport {\n    ChildLogger,\n    IFluidErrorBase,\n    loggerToMonitoringContext,\n    MonitoringContext,\n    normalizeError,\n} from \"@fluidframework/telemetry-utils\";\nimport {\n    IDocumentDeltaConnection,\n    IDocumentDeltaStorageService,\n    IDocumentService,\n    IResolvedUrl,\n    IDocumentStorageService,\n    IDocumentServicePolicies,\n    DriverErrorType,\n} from \"@fluidframework/driver-definitions\";\nimport { canRetryOnError, DeltaStreamConnectionForbiddenError, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport {\n    IClient,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    IEntry,\n    HostStoragePolicy,\n    InstrumentedStorageTokenFetcher,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { hasFacetCodes } from \"@fluidframework/odsp-doclib-utils\";\nimport type { io as SocketIOClientStatic } from \"socket.io-client\";\nimport { HostStoragePolicyInternal, ISocketStorageDiscovery } from \"./contracts\";\nimport { IOdspCache } from \"./odspCache\";\nimport { OdspDeltaStorageService, OdspDeltaStorageWithCache } from \"./odspDeltaStorageService\";\nimport { OdspDocumentDeltaConnection } from \"./odspDocumentDeltaConnection\";\nimport { OdspDocumentStorageService } from \"./odspDocumentStorageManager\";\nimport { getWithRetryForTokenRefresh, getOdspResolvedUrl, TokenFetchOptionsEx } from \"./odspUtils\";\nimport { fetchJoinSession } from \"./vroom\";\nimport { isOdcOrigin } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OpsCache } from \"./opsCaching\";\nimport { RetryErrorsStorageAdapter } from \"./retryErrorsStorageAdapter\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n/**\n * The DocumentService manages the Socket.IO connection and manages routing requests to connected\n * clients\n */\nexport class OdspDocumentService implements IDocumentService {\n    private _policies: IDocumentServicePolicies;\n    // Timer which runs and executes the join session call after intervals.\n    private joinSessionRefreshTimer: ReturnType<typeof setTimeout> | undefined;\n    /**\n     * @param resolvedUrl - resolved url identifying document that will be managed by returned service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - This host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by returned service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    public static async create(\n        resolvedUrl: IResolvedUrl,\n        getStorageToken: InstrumentedStorageTokenFetcher,\n        getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        socketIoClientFactory: () => Promise<typeof SocketIOClientStatic>,\n        cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix?: string,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        return new OdspDocumentService(\n            getOdspResolvedUrl(resolvedUrl),\n            getStorageToken,\n            getWebsocketToken,\n            logger,\n            socketIoClientFactory,\n            cache,\n            hostPolicy,\n            epochTracker,\n            socketReferenceKeyPrefix,\n            clientIsSummarizer,\n        );\n    }\n\n    private storageManager?: OdspDocumentStorageService;\n\n    private readonly mc: MonitoringContext;\n\n    private readonly joinSessionKey: string;\n\n    private readonly hostPolicy: HostStoragePolicyInternal;\n\n    private _opsCache?: OpsCache;\n\n    private currentConnection?: OdspDocumentDeltaConnection;\n\n    private relayServiceTenantAndSessionId: string | undefined;\n\n    /**\n     * @param odspResolvedUrl - resolved url identifying document that will be managed by this service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by this service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    private constructor(\n        public readonly odspResolvedUrl: IOdspResolvedUrl,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        private readonly getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        private readonly socketIoClientFactory: () => Promise<typeof SocketIOClientStatic>,\n        private readonly cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        private readonly epochTracker: EpochTracker,\n        private readonly socketReferenceKeyPrefix?: string,\n        private readonly clientIsSummarizer?: boolean,\n    ) {\n        this._policies = {\n            // load in storage-only mode if a file version is specified\n            storageOnly: odspResolvedUrl.fileVersion !== undefined,\n        };\n\n        this.joinSessionKey = `${this.odspResolvedUrl.hashedDocumentId}/joinsession`;\n        this.mc = loggerToMonitoringContext(\n            ChildLogger.create(logger,\n            undefined,\n            {\n                all: {\n                    odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),\n                },\n            }));\n\n        this.hostPolicy = hostPolicy;\n        if (this.clientIsSummarizer) {\n            this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };\n        }\n    }\n\n    public get resolvedUrl(): IResolvedUrl {\n        return this.odspResolvedUrl;\n    }\n    public get policies() {\n        return this._policies;\n    }\n\n    /**\n     * Connects to a storage endpoint for snapshot service.\n     *\n     * @returns returns the document storage service for sharepoint driver.\n     */\n    public async connectToStorage(): Promise<IDocumentStorageService> {\n        if (!this.storageManager) {\n            this.storageManager = new OdspDocumentStorageService(\n                this.odspResolvedUrl,\n                this.getStorageToken,\n                this.mc.logger,\n                true,\n                this.cache,\n                this.hostPolicy,\n                this.epochTracker,\n                // flushCallback\n                async () => {\n                    if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                        return this.currentConnection.flush();\n                    }\n                    throw new Error(\"Disconnected while uploading summary (attempt to perform flush())\");\n                },\n                () => {\n                    assert(this.relayServiceTenantAndSessionId !== undefined,\n                        \"relayServiceTenantAndSessionId should be present\");\n                    return this.relayServiceTenantAndSessionId;\n                },\n                this.mc.config.getNumber(\"Fluid.Driver.Odsp.snapshotFormatFetchType\"),\n            );\n        }\n\n        return new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);\n    }\n\n    /**\n     * Connects to a delta storage endpoint for getting ops between a range.\n     *\n     * @returns returns the document delta storage service for sharepoint driver.\n     */\n    public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {\n        const snapshotOps = this.storageManager?.ops ?? [];\n        const service = new OdspDeltaStorageService(\n            this.odspResolvedUrl.endpoints.deltaStorageUrl,\n            this.getStorageToken,\n            this.epochTracker,\n            this.mc.logger,\n        );\n\n        // batch size, please see issue #5211 for data around batch sizing\n        const batchSize = this.hostPolicy.opsBatchSize ?? 5000;\n        const concurrency = this.hostPolicy.concurrentOpsBatches ?? 1;\n        return new OdspDeltaStorageWithCache(\n            snapshotOps,\n            this.mc.logger,\n            batchSize,\n            concurrency,\n            async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason),\n            async (from, to) => {\n                const res = await this.opsCache?.get(from, to);\n                return res as ISequencedDocumentMessage[] ?? [];\n            },\n            (from, to) => {\n                if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                    this.currentConnection.requestOps(from, to);\n                }\n            },\n            (ops: ISequencedDocumentMessage[]) => this.opsReceived(ops),\n        );\n    }\n\n    /** Annotate the given error indicating which connection step failed */\n    private annotateConnectionError(\n        error: any,\n        failedConnectionStep: string,\n        separateTokenRequest: boolean,\n    ): IFluidErrorBase {\n        return normalizeError(error, { props: {\n            failedConnectionStep,\n            separateTokenRequest,\n        } });\n    }\n\n    /**\n     * Connects to a delta stream endpoint for emitting ops.\n     *\n     * @returns returns the document delta stream service for onedrive/sharepoint driver.\n     */\n    public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {\n        // Attempt to connect twice, in case we used expired token.\n        return getWithRetryForTokenRefresh<IDocumentDeltaConnection>(async (options) => {\n            // Presence of getWebsocketToken callback dictates whether callback is used for fetching\n            // websocket token or whether it is returned with joinSession response payload\n            const requestWebsocketTokenFromJoinSession = this.getWebsocketToken === undefined;\n            const websocketTokenPromise = requestWebsocketTokenFromJoinSession\n                ? Promise.resolve(null)\n                : this.getWebsocketToken!(options);\n\n            const annotateAndRethrowConnectionError = (step: string) => (error: any) => {\n                throw this.annotateConnectionError(error, step, !requestWebsocketTokenFromJoinSession);\n            };\n\n            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options);\n            const [websocketEndpoint, websocketToken, io] =\n                await Promise.all([\n                    joinSessionPromise.catch(annotateAndRethrowConnectionError(\"joinSession\")),\n                    websocketTokenPromise.catch(annotateAndRethrowConnectionError(\"getWebsocketToken\")),\n                    this.socketIoClientFactory().catch(annotateAndRethrowConnectionError(\"socketIoClientFactory\")),\n                ]);\n\n            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken ?? null);\n            if (finalWebsocketToken === null) {\n                throw this.annotateConnectionError(\n                    new NonRetryableError(\n                        \"Websocket token is null\",\n                        OdspErrorType.fetchTokenError,\n                        { driverVersion },\n                    ),\n                    \"getWebsocketToken\",\n                    !requestWebsocketTokenFromJoinSession);\n            }\n            try {\n                const connection = await this.createDeltaConnection(\n                    websocketEndpoint.tenantId,\n                    websocketEndpoint.id,\n                    finalWebsocketToken,\n                    io,\n                    client,\n                    websocketEndpoint.deltaStreamSocketUrl);\n                connection.on(\"op\", (documentId, ops: ISequencedDocumentMessage[]) => {\n                    this.opsReceived(ops);\n                });\n                // On disconnect with 401/403 error code, we can just clear the joinSession cache as we will again\n                // get the auth error on reconnecting and face latency.\n                connection.on(\"disconnect\", (error: any) => {\n                    // Clear the join session refresh timer so that it can be restarted on reconnection.\n                    this.clearJoinSessionTimer();\n                    if (typeof error === \"object\" && error !== null\n                        && error.errorType === DriverErrorType.authorizationError) {\n                        this.cache.sessionJoinCache.remove(this.joinSessionKey);\n                    }\n                });\n                this.currentConnection = connection;\n                return connection;\n            } catch (error) {\n                this.cache.sessionJoinCache.remove(this.joinSessionKey);\n\n                const normalizedError = this.annotateConnectionError(\n                    error,\n                    \"createDeltaConnection\",\n                    !requestWebsocketTokenFromJoinSession);\n                if (typeof error === \"object\" && error !== null) {\n                    normalizedError.addTelemetryProperties({ socketDocumentId: websocketEndpoint.id });\n                }\n                throw normalizedError;\n            }\n        });\n    }\n\n    private clearJoinSessionTimer() {\n        if (this.joinSessionRefreshTimer !== undefined) {\n            clearTimeout(this.joinSessionRefreshTimer);\n            this.joinSessionRefreshTimer = undefined;\n        }\n    }\n\n    private async scheduleJoinSessionRefresh(delta: number) {\n        await new Promise<void>((resolve, reject) => {\n            this.joinSessionRefreshTimer = setTimeout(() => {\n                getWithRetryForTokenRefresh(async (options) => {\n                    await this.joinSession(false, options);\n                    resolve();\n                }).catch((error) => {\n                    reject(error);\n                });\n            }, delta);\n        });\n    }\n\n    private async joinSession(\n        requestSocketToken: boolean,\n        options: TokenFetchOptionsEx,\n    ) {\n        const response = await this.joinSessionCore(requestSocketToken, options).catch((e) => {\n            if (hasFacetCodes(e) && e.facetCodes !== undefined) {\n                for (const code of e.facetCodes) {\n                    switch (code) {\n                        case \"sessionForbiddenOnPreservedFiles\":\n                        case \"sessionForbiddenOnModerationEnabledLibrary\":\n                        case \"sessionForbiddenOnRequireCheckout\":\n                            // This document can only be opened in storage-only mode.\n                            // DeltaManager will recognize this error\n                            // and load without a delta stream connection.\n                            this._policies = { ...this._policies, storageOnly: true };\n                            throw new DeltaStreamConnectionForbiddenError(code, { driverVersion });\n                        default:\n                            continue;\n                    }\n                }\n            }\n            throw e;\n        });\n        this.relayServiceTenantAndSessionId = `${response.tenantId}/${response.id}`;\n        return response;\n    }\n\n    private async joinSessionCore(\n        requestSocketToken: boolean,\n        options: TokenFetchOptionsEx,\n    ): Promise<ISocketStorageDiscovery> {\n        const disableJoinSessionRefresh = this.mc.config.getBoolean(\"Fluid.Driver.Odsp.disableJoinSessionRefresh\");\n        const executeFetch = async () => {\n            const joinSessionResponse = await fetchJoinSession(\n                this.odspResolvedUrl,\n                \"opStream/joinSession\",\n                \"POST\",\n                this.mc.logger,\n                this.getStorageToken,\n                this.epochTracker,\n                requestSocketToken,\n                options,\n                disableJoinSessionRefresh,\n                this.hostPolicy.sessionOptions?.unauthenticatedUserDisplayName,\n            );\n            return {\n                entryTime: Date.now(),\n                joinSessionResponse,\n            };\n        };\n\n        const getResponseAndRefreshAfterDeltaMs = async () => {\n            const _response = await this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);\n            // If the response does not contain refreshSessionDurationSeconds, then treat it as old flow and let the\n            // cache entry to be treated as expired after 1 hour.\n            _response.joinSessionResponse.refreshSessionDurationSeconds =\n                _response.joinSessionResponse.refreshSessionDurationSeconds ?? 3600;\n            return {\n                ..._response,\n                refreshAfterDeltaMs: this.calculateJoinSessionRefreshDelta(\n                    _response.entryTime, _response.joinSessionResponse.refreshSessionDurationSeconds),\n            };\n        };\n        let response = await getResponseAndRefreshAfterDeltaMs();\n        // This means that the cached entry has expired(This should not be possible if the response is fetched\n        // from the network call). In this case we remove the cached entry and fetch the new response.\n        if (response.refreshAfterDeltaMs <= 0) {\n            this.cache.sessionJoinCache.remove(this.joinSessionKey);\n            response = await getResponseAndRefreshAfterDeltaMs();\n        }\n        if (!disableJoinSessionRefresh) {\n            const props = {\n                entryTime: response.entryTime,\n                refreshSessionDurationSeconds:\n                    response.joinSessionResponse.refreshSessionDurationSeconds,\n                refreshAfterDeltaMs: response.refreshAfterDeltaMs,\n            };\n            if (response.refreshAfterDeltaMs > 0) {\n                this.scheduleJoinSessionRefresh(response.refreshAfterDeltaMs)\n                    .catch((error) => {\n                        const canRetry = canRetryOnError(error);\n                        // Only record error event in case it is non retriable.\n                        if (!canRetry) {\n                            this.mc.logger.sendErrorEvent({\n                                eventName: \"JoinSessionRefreshError\",\n                                details: JSON.stringify(props),\n                            },\n                            error,\n                            );\n                        }\n                    });\n            } else {\n                // Logging just for informational purposes to help with debugging as this is a new feature.\n                this.mc.logger.sendTelemetryEvent({\n                    eventName: \"JoinSessionRefreshNotScheduled\",\n                    details: JSON.stringify(props),\n                });\n            }\n        }\n        return response.joinSessionResponse;\n    }\n\n    private calculateJoinSessionRefreshDelta(responseFetchTime: number, refreshSessionDurationSeconds: number) {\n        // 30 seconds is buffer time to refresh the session.\n        return responseFetchTime + ((refreshSessionDurationSeconds * 1000) - 30000) - Date.now();\n    }\n\n    /**\n     * Creats a connection to the given delta stream endpoint\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for delta service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param webSocketUrl - websocket URL\n     */\n    private async createDeltaConnection(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: typeof SocketIOClientStatic,\n        client: IClient,\n        webSocketUrl: string,\n    ): Promise<OdspDocumentDeltaConnection> {\n        const startTime = performance.now();\n        const connection = await OdspDocumentDeltaConnection.create(\n            tenantId,\n            documentId,\n            token,\n            io,\n            client,\n            webSocketUrl,\n            this.mc.logger,\n            60000,\n            this.epochTracker,\n            this.socketReferenceKeyPrefix,\n        );\n        const duration = performance.now() - startTime;\n        // This event happens rather often, so it adds up to cost of telemetry.\n        // Given that most reconnects result in reusing socket and happen very quickly,\n        // report event only if it took longer than threshold.\n        if (duration >= 2000) {\n            this.mc.logger.sendPerformanceEvent({\n                eventName: \"ConnectionSuccess\",\n                duration,\n            });\n        }\n        return connection;\n    }\n\n    public dispose(error?: any) {\n        // Error might indicate mismatch between client & server knowlege about file\n        // (DriverErrorType.fileOverwrittenInStorage).\n        // For example, file might have been overwritten in storage without generating new epoch\n        // In such case client cached info is stale and has to be removed.\n        if (error !== undefined) {\n            this.epochTracker.removeEntries().catch(() => {});\n        } else {\n            this._opsCache?.flushOps();\n        }\n        this._opsCache?.dispose();\n    }\n\n    protected get opsCache() {\n        if (this._opsCache) {\n            return this._opsCache;\n        }\n\n        const seqNumber = this.storageManager?.snapshotSequenceNumber;\n        const batchSize = this.hostPolicy.opsCaching?.batchSize ?? 100;\n        if (seqNumber === undefined || batchSize < 1) {\n            return;\n        }\n\n        const opsKey: Omit<IEntry, \"key\"> = {\n            type: \"ops\",\n        };\n        this._opsCache = new OpsCache(\n            seqNumber,\n            this.mc.logger,\n            // ICache\n            {\n                write: async (key: string, opsData: string) => {\n                    return this.cache.persistedCache.put({ ...opsKey, key }, opsData);\n                },\n                read: async (key: string) => this.cache.persistedCache.get({ ...opsKey, key }),\n                remove: () => { this.cache.persistedCache.removeEntries().catch(() => {}); },\n            },\n            batchSize,\n            this.hostPolicy.opsCaching?.timerGranularity ?? 5000,\n            this.hostPolicy.opsCaching?.totalOpsToCache ?? 5000,\n        );\n        return this._opsCache;\n    }\n\n    // Called whenever re receive ops through any channel for this document (snapshot, delta connection, delta storage)\n    // We use it to notify caching layer of how stale is snapshot stored in cache.\n    protected opsReceived(ops: ISequencedDocumentMessage[]) {\n        // No need for two clients to save same ops\n        if (ops.length === 0 || this.odspResolvedUrl.summarizer) {\n            return;\n        }\n\n        this.opsCache?.addOps(ops);\n    }\n}\n"]}

package/dist/odspDocumentStorageManager.d.ts

@@ -22,6 +22,7 @@ export declare class OdspDocumentStorageService extends OdspDocumentStorageServi
     private readonly hostPolicy;
     private readonly epochTracker;
     private readonly flushCallback;
+    private readonly relayServiceTenantAndSessionId;
     private readonly snapshotFormatFetchType?;
     private readonly odspSummaryUploadManager;
     private firstVersionCall;
@@ -37,7 +38,7 @@ export declare class OdspDocumentStorageService extends OdspDocumentStorageServi
     private readonly maxSnapshotSizeLimit;
     private readonly maxSnapshotFetchTimeout;
     private readonly createBlobRateLimiter;
-    constructor(odspResolvedUrl: IOdspResolvedUrl, getStorageToken: InstrumentedStorageTokenFetcher, logger: ITelemetryLogger, fetchFullSnapshot: boolean, cache: IOdspCache, hostPolicy: HostStoragePolicyInternal, epochTracker: EpochTracker, flushCallback: () => Promise<FlushResult>, snapshotFormatFetchType?: SnapshotFormatSupportType | undefined);
+    constructor(odspResolvedUrl: IOdspResolvedUrl, getStorageToken: InstrumentedStorageTokenFetcher, logger: ITelemetryLogger, fetchFullSnapshot: boolean, cache: IOdspCache, hostPolicy: HostStoragePolicyInternal, epochTracker: EpochTracker, flushCallback: () => Promise<FlushResult>, relayServiceTenantAndSessionId: () => string, snapshotFormatFetchType?: SnapshotFormatSupportType | undefined);
     createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
     protected fetchBlobFromStorage(blobId: string, evicted: boolean): Promise<ArrayBuffer>;
     getSnapshotTree(version?: api.IVersion, scenarioName?: string): Promise<api.ISnapshotTree | null>;

package/dist/odspDocumentStorageManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentStorageManager.d.ts","sourceRoot":"","sources":["../src/odspDocumentStorageManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAQtE,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EACH,eAAe,EAElB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,gBAAgB,EAGhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEH,yBAAyB,EAG5B,MAAM,aAAa,CAAC;AACrB,OAAO,EAA4D,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAEtH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF,eAAO,MAAM,mCAAmC,EAAE,MAAkB,CAAC;AAkBrE,qBAAa,0BAA2B,SAAQ,8BAA8B;IAsBtE,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IA7B7C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IAEpE,OAAO,CAAC,gBAAgB,CAAQ;IAEhC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAqB;IACvD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqB;IAEtD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAa;IAClD,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAU;IAGlD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAsB;gBAGvC,eAAe,EAAE,gBAAgB,EACjC,eAAe,EAAE,+BAA+B,EAChD,MAAM,EAAE,gBAAgB,EACxB,iBAAiB,EAAE,OAAO,EAC1B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,yBAAyB,EACrC,YAAY,EAAE,YAAY,EAC1B,aAAa,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,EACzC,uBAAuB,CAAC,uCAA2B;IAkB3D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;cA0ChE,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IA6C/E,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;IAOjG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YA4JhG,aAAa;YAcb,iBAAiB;IAiFlB,wBAAwB,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC3G,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,qBAAqB;cASb,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,SAAS,CAAC;CAmCnH"}
+{"version":3,"file":"odspDocumentStorageManager.d.ts","sourceRoot":"","sources":["../src/odspDocumentStorageManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAQtE,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EACH,eAAe,EAElB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,gBAAgB,EAGhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEH,yBAAyB,EAG5B,MAAM,aAAa,CAAC;AACrB,OAAO,EAA4D,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAEtH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF,eAAO,MAAM,mCAAmC,EAAE,MAAkB,CAAC;AAkBrE,qBAAa,0BAA2B,SAAQ,8BAA8B;IAsBtE,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,8BAA8B;IAC/C,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IA9B7C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IAEpE,OAAO,CAAC,gBAAgB,CAAQ;IAEhC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAqB;IACvD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqB;IAEtD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAa;IAClD,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAU;IAGlD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAsB;gBAGvC,eAAe,EAAE,gBAAgB,EACjC,eAAe,EAAE,+BAA+B,EAChD,MAAM,EAAE,gBAAgB,EACxB,iBAAiB,EAAE,OAAO,EAC1B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,yBAAyB,EACrC,YAAY,EAAE,YAAY,EAC1B,aAAa,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,EACzC,8BAA8B,EAAE,MAAM,MAAM,EAC5C,uBAAuB,CAAC,uCAA2B;IAmB3D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;cA0ChE,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IA6C/E,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;IAOjG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YA4JhG,aAAa;YAcb,iBAAiB;IAiFlB,wBAAwB,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC3G,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,qBAAqB;cASb,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,SAAS,CAAC;CAmCnH"}

package/dist/odspDocumentStorageManager.js

@@ -27,7 +27,7 @@ async function promiseRaceWithWinner(promises) {
     });
 }
 class OdspDocumentStorageService extends odspDocumentStorageServiceBase_1.OdspDocumentStorageServiceBase {
-    constructor(odspResolvedUrl, getStorageToken, logger, fetchFullSnapshot, cache, hostPolicy, epochTracker, flushCallback, snapshotFormatFetchType) {
+    constructor(odspResolvedUrl, getStorageToken, logger, fetchFullSnapshot, cache, hostPolicy, epochTracker, flushCallback, relayServiceTenantAndSessionId, snapshotFormatFetchType) {
         var _a;
         super();
         this.odspResolvedUrl = odspResolvedUrl;
@@ -38,6 +38,7 @@ class OdspDocumentStorageService extends odspDocumentStorageServiceBase_1.OdspDo
         this.hostPolicy = hostPolicy;
         this.epochTracker = epochTracker;
         this.flushCallback = flushCallback;
+        this.relayServiceTenantAndSessionId = relayServiceTenantAndSessionId;
         this.snapshotFormatFetchType = snapshotFormatFetchType;
         this.firstVersionCall = true;
         // Driver specified limits for snapshot size and time.
@@ -54,7 +55,7 @@ class OdspDocumentStorageService extends odspDocumentStorageServiceBase_1.OdspDo
         this.snapshotUrl = this.odspResolvedUrl.endpoints.snapshotStorageUrl;
         this.attachmentPOSTUrl = this.odspResolvedUrl.endpoints.attachmentPOSTStorageUrl;
         this.attachmentGETUrl = this.odspResolvedUrl.endpoints.attachmentGETStorageUrl;
-        this.odspSummaryUploadManager = new odspSummaryUploadManager_1.OdspSummaryUploadManager(this.snapshotUrl, getStorageToken, logger, epochTracker, !!((_a = this.hostPolicy.sessionOptions) === null || _a === void 0 ? void 0 : _a.forceAccessTokenViaAuthorizationHeader));
+        this.odspSummaryUploadManager = new odspSummaryUploadManager_1.OdspSummaryUploadManager(this.snapshotUrl, getStorageToken, logger, epochTracker, !!((_a = this.hostPolicy.sessionOptions) === null || _a === void 0 ? void 0 : _a.forceAccessTokenViaAuthorizationHeader), this.relayServiceTenantAndSessionId);
     }
     async createBlob(file) {
         this.checkAttachmentPOSTUrl();