@fluidframework/odsp-driver 0.57.2 → 0.58.1000

package/lib/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;AAOtE,OAAO,EACH,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EAE3B,MAAM,oCAAoC,CAAC;AAG5C,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,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;aAoEpC,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;IA3E9C,OAAO,CAAC,SAAS,CAA2B;IAE5C;;;;;;;;;;;;;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,oBAAoB,CAAC,EAC1D,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,iBAAiB,EAC7B,YAAY,EAAE,YAAY,EAC1B,wBAAwB,CAAC,EAAE,MAAM,GAClC,OAAO,CAAC,gBAAgB,CAAC;IAc5B,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;IAkCP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAuBjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IA+B3E;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;YA6EvE,WAAW;IAsBzB;;;;;;;;;;OAUG;YACW,6BAA6B;IAkCpC,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;AAOtE,OAAO,EACH,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EAE3B,MAAM,oCAAoC,CAAC;AAG5C,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,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;aAqEpC,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;IA5E9C,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,oBAAoB,CAAC,EAC1D,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,iBAAiB,EAC7B,YAAY,EAAE,YAAY,EAC1B,wBAAwB,CAAC,EAAE,MAAM,GAClC,OAAO,CAAC,gBAAgB,CAAC;IAc5B,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;IAkCP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAuBjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IA+B3E;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;IA0DrF,OAAO,CAAC,qBAAqB;YAOf,0BAA0B;YAa1B,WAAW;YA0BX,eAAe;IAuE7B,OAAO,CAAC,gCAAgC;IAKxC;;;;;;;;;;OAUG;YACW,6BAA6B;IAkCpC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAa1B,SAAS,KAAK,QAAQ,yBA8BrB;IAID,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB,EAAE;CAQzD"}

package/lib/odspDocumentService.js

@@ -138,26 +138,7 @@ export class OdspDocumentService {
             const websocketTokenPromise = requestWebsocketTokenFromJoinSession
                 ? Promise.resolve(null)
                 : this.getWebsocketToken(options);
-            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options).catch((e) => {
-                const likelyFacetCodes = e;
-                if (Array.isArray(likelyFacetCodes.facetCodes)) {
-                    for (const code of likelyFacetCodes.facetCodes) {
-                        switch (code) {
-                            case "sessionForbiddenOnPreservedFiles":
-                            case "sessionForbiddenOnModerationEnabledLibrary":
-                            case "sessionForbiddenOnRequireCheckout":
-                                // This document can only be opened in storage-only mode.
-                                // DeltaManager will recognize this error
-                                // and load without a delta stream connection.
-                                this._policies = Object.assign(Object.assign({}, this._policies), { storageOnly: true });
-                                throw new DeltaStreamConnectionForbiddenError(code, { driverVersion });
-                            default:
-                                continue;
-                        }
-                    }
-                }
-                throw e;
-            });
+            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options);
             const [websocketEndpoint, websocketToken, io] = await Promise.all([
                 joinSessionPromise,
                 websocketTokenPromise,
@@ -165,7 +146,7 @@ export class OdspDocumentService {
             ]);
             const finalWebsocketToken = websocketToken !== null && websocketToken !== void 0 ? websocketToken : (websocketEndpoint.socketToken || null);
             if (finalWebsocketToken === null) {
-                throw new NonRetryableError("pushTokenIsNull", "Websocket token is null", OdspErrorType.fetchTokenError, { driverVersion });
+                throw new NonRetryableError("Websocket token is null", OdspErrorType.fetchTokenError, { driverVersion });
             }
             try {
                 const connection = await this.connectToDeltaStreamWithRetry(websocketEndpoint.tenantId, websocketEndpoint.id, finalWebsocketToken, io, client, websocketEndpoint.deltaStreamSocketUrl);
@@ -175,6 +156,8 @@ export class OdspDocumentService {
                 // On disconnect with 401/403 error code, we can just clear the joinSession cache as we will again
                 // get the auth error on reconnecting and face latency.
                 connection.on("disconnect", (error) => {
+                    // Clear the join session refresh timer so that it can be restarted on reconnection.
+                    this.clearJoinSessionTimer();
                     if (typeof error === "object" && error !== null
                         && error.errorType === DriverErrorType.authorizationError) {
                         this.cache.sessionJoinCache.remove(this.joinSessionKey);
@@ -192,14 +175,94 @@ export class OdspDocumentService {
             }
         });
     }
+    clearJoinSessionTimer() {
+        if (this.joinSessionRefreshTimer !== undefined) {
+            clearTimeout(this.joinSessionRefreshTimer);
+            this.joinSessionRefreshTimer = undefined;
+        }
+    }
+    async scheduleJoinSessionRefresh(delta) {
+        await new Promise((resolve, reject) => {
+            this.joinSessionRefreshTimer = setTimeout(() => {
+                getWithRetryForTokenRefresh(async (options) => {
+                    await this.joinSession(false, options);
+                    resolve();
+                }).catch((error) => {
+                    reject(error);
+                });
+            }, delta);
+        });
+    }
     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) {
+                    switch (code) {
+                        case "sessionForbiddenOnPreservedFiles":
+                        case "sessionForbiddenOnModerationEnabledLibrary":
+                        case "sessionForbiddenOnRequireCheckout":
+                            // This document can only be opened in storage-only mode.
+                            // DeltaManager will recognize this error
+                            // and load without a delta stream connection.
+                            this._policies = Object.assign(Object.assign({}, this._policies), { storageOnly: true });
+                            throw new DeltaStreamConnectionForbiddenError(code, { driverVersion });
+                        default:
+                            continue;
+                    }
+                }
+            }
+            throw e;
+        });
+    }
+    async joinSessionCore(requestSocketToken, options) {
+        const disableJoinSessionRefresh = this.mc.config.getBoolean("Fluid.Driver.Odsp.disableJoinSessionRefresh");
         const executeFetch = async () => {
             var _a;
-            return fetchJoinSession(this.odspResolvedUrl, "opStream/joinSession", "POST", this.mc.logger, this.getStorageToken, this.epochTracker, requestSocketToken, options, (_a = this.hostPolicy.sessionOptions) === null || _a === void 0 ? void 0 : _a.unauthenticatedUserDisplayName);
+            const joinSessionResponse = await fetchJoinSession(this.odspResolvedUrl, "opStream/joinSession", "POST", this.mc.logger, this.getStorageToken, this.epochTracker, requestSocketToken, options, disableJoinSessionRefresh, (_a = this.hostPolicy.sessionOptions) === null || _a === void 0 ? void 0 : _a.unauthenticatedUserDisplayName);
+            return {
+                entryTime: Date.now(),
+                joinSessionResponse,
+            };
         };
-        // Note: The sessionCache is configured with a sliding expiry of 1 hour,
-        // so if we've fetched the join session within the last hour we won't run executeFetch again now.
-        return this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);
+        const getResponseAndRefreshAfterDeltaMs = async () => {
+            var _a;
+            let response = await this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);
+            // If the response does not contain refreshSessionDurationSeconds, then treat it as old flow and let the
+            // cache entry to be treated as expired after 1 hour.
+            response.joinSessionResponse.refreshSessionDurationSeconds = (_a = response.joinSessionResponse.refreshSessionDurationSeconds) !== null && _a !== void 0 ? _a : 3600;
+            return Object.assign(Object.assign({}, response), { refreshAfterDeltaMs: this.calculateJoinSessionRefreshDelta(response.entryTime, response.joinSessionResponse.refreshSessionDurationSeconds) });
+        };
+        let response = await getResponseAndRefreshAfterDeltaMs();
+        // This means that the cached entry has expired(This should not be possible if the response is fetched
+        // from the network call). In this case we remove the cached entry and fetch the new response.
+        if (response.refreshAfterDeltaMs <= 0) {
+            this.cache.sessionJoinCache.remove(this.joinSessionKey);
+            response = await getResponseAndRefreshAfterDeltaMs();
+        }
+        if (!disableJoinSessionRefresh) {
+            const props = {
+                entryTime: response.entryTime,
+                refreshSessionDurationSeconds: response.joinSessionResponse.refreshSessionDurationSeconds,
+                refreshAfterDeltaMs: response.refreshAfterDeltaMs,
+            };
+            if (response.refreshAfterDeltaMs > 0) {
+                this.scheduleJoinSessionRefresh(response.refreshAfterDeltaMs)
+                    .catch((error) => {
+                    this.mc.logger.sendErrorEvent(Object.assign({ eventName: "JoinSessionRefreshError" }, props), error);
+                });
+                ;
+            }
+            else {
+                // Logging just for informational purposes to help with debugging as this is a new feature.
+                this.mc.logger.sendErrorEvent(Object.assign({ eventName: "JoinSessionRefreshNotScheduled" }, props));
+            }
+        }
+        return response.joinSessionResponse;
+    }
+    calculateJoinSessionRefreshDelta(responseFetchTime, refreshSessionDurationSeconds) {
+        // 30 seconds is buffer time to refresh the session.
+        return responseFetchTime + ((refreshSessionDurationSeconds * 1000) - 30000) - Date.now();
     }
     /**
      * Connects to a delta stream endpoint

package/lib/odspDocumentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentService.js","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EACH,WAAW,EACX,yBAAyB,GAE5B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAOH,eAAe,GAClB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,mCAAmC,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAMtG,OAAO,EAMH,aAAa,GAChB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAuB,MAAM,aAAa,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAqD5B;;;;;;;;;;;;;OAaG;IACH,YACoB,eAAiC,EAChC,eAAgD,EAChD,iBAAuF,EACxG,MAAwB,EACP,qBAA0D,EAC1D,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC;;;QARlC,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAAsE;QAEvF,0BAAqB,GAArB,qBAAqB,CAAqC;QAC1D,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QAElD,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,yBAAyB,CAC/B,WAAW,CAAC,MAAM,CAAC,MAAM,EACzB,SAAS,EACT;YACI,GAAG,EAAE;gBACD,GAAG,EAAE,WAAW,CAAC,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,YAAA,IAAI,CAAC,UAAU,EAAC,yBAAyB,uCAAzB,yBAAyB,GACrC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,wCAAwC,CAAC,EAAC;QACxE,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACjC,IAAI,CAAC,UAAU,mCAAQ,IAAI,CAAC,UAAU,KAAE,gBAAgB,EAAE,IAAI,GAAE,CAAC;SACpE;IACL,CAAC;IAhGD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,WAAyB,EACzB,eAAgD,EAChD,iBAAuF,EACvF,MAAwB,EACxB,qBAA0D,EAC1D,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC;QAEjC,OAAO,IAAI,mBAAmB,CAC1B,kBAAkB,CAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,qBAAqB,EACrB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,CAC3B,CAAC;IACN,CAAC;IA8DD,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,0BAA0B,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,CACJ,CAAC;SACL;QAED,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB;;QAC9B,MAAM,WAAW,eAAG,IAAI,CAAC,cAAc,0CAAE,GAAG,mCAAI,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,uBAAuB,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,SAAG,IAAI,CAAC,UAAU,CAAC,YAAY,mCAAI,IAAI,CAAC;QACvD,MAAM,WAAW,SAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,CAAC,CAAC;QAC9D,OAAO,IAAI,yBAAyB,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,aAAM,IAAI,CAAC,QAAQ,0CAAE,GAAG,CAAC,IAAI,EAAE,EAAE,EAAC,CAAC;YAC/C,aAAO,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;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAC7C,2DAA2D;QAC3D,OAAO,2BAA2B,CAA2B,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,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACnG,MAAM,gBAAgB,GAAG,CAAgB,CAAC;gBAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;oBAC5C,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,UAAU,EAAE;wBAC5C,QAAQ,IAAI,EAAE;4BACV,KAAK,kCAAkC,CAAC;4BACxC,KAAK,4CAA4C,CAAC;4BAClD,KAAK,mCAAmC;gCACpC,yDAAyD;gCACzD,yCAAyC;gCACzC,8CAA8C;gCAC9C,IAAI,CAAC,SAAS,mCAAO,IAAI,CAAC,SAAS,KAAC,WAAW,EAAE,IAAI,GAAC,CAAC;gCACvD,MAAM,IAAI,mCAAmC,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;4BAC3E;gCACI,SAAS;yBAChB;qBACJ;iBACJ;gBACD,MAAM,CAAC,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,iBAAiB,EAAE,cAAc,EAAE,EAAE,CAAC,GACzC,MAAM,OAAO,CAAC,GAAG,CAAC;gBACd,kBAAkB;gBAClB,qBAAqB;gBACrB,IAAI,CAAC,qBAAqB,EAAE;aAC/B,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,iBAAiB,CACvB,iBAAiB,EACjB,yBAAyB,EACzB,aAAa,CAAC,eAAe,EAC7B,EAAE,aAAa,EAAE,CAAC,CAAC;aAC1B;YACD,IAAI;gBACA,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,6BAA6B,CACvD,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,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;2BACxC,KAAK,CAAC,SAAS,KAAK,eAAe,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;gBACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;oBAC7C,KAAK,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,EAAE,CAAC;iBACjD;gBACD,MAAM,KAAK,CAAC;aACf;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,WAAW,CACrB,kBAA2B,EAC3B,OAA4B;QAE5B,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;;YAC5B,OAAA,gBAAgB,CACZ,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,QACP,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,8BAA8B,CACjE,CAAA;SAAA,CAAC;QAEN,wEAAwE;QACxE,iGAAiG;QACjG,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,6BAA6B,CACvC,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAAwB,EACxB,MAAe,EACf,YAAoB;QAEpB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,MAAM,2BAA2B,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,WAAW,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,GAAG;SAC9B;QACD,MAAA,IAAI,CAAC,SAAS,0CAAE,OAAO,GAAG;IAC9B,CAAC;IAED,IAAc,QAAQ;;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,IAAI,CAAC,SAAS,CAAC;SACzB;QAED,MAAM,SAAS,SAAG,IAAI,CAAC,cAAc,0CAAE,sBAAsB,CAAC;QAC9D,MAAM,SAAS,eAAG,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,QAAQ,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,iCAAK,MAAM,KAAE,GAAG,KAAG,OAAO,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAK,MAAM,KAAE,GAAG,IAAE;YAC5E,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,cACT,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,gBAAgB,mCAAI,IAAI,cACpD,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,EAAE;IAC/B,CAAC;CACJ","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    loggerToMonitoringContext,\n    MonitoringContext,\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 { DeltaStreamConnectionForbiddenError, NonRetryableError } 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 { 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\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<SocketIOClientStatic>,\n        cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix?: string,\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        );\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<SocketIOClientStatic>,\n        private readonly cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        private readonly epochTracker: EpochTracker,\n        private readonly socketReferenceKeyPrefix?: string,\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        this.hostPolicy.fetchBinarySnapshotFormat ??=\n            this.mc.config.getBoolean(\"Fluid.Driver.Odsp.binaryFormatSnapshot\");\n        if (this.odspResolvedUrl.summarizer) {\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        }\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    /**\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 joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, 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            const [websocketEndpoint, websocketToken, io] =\n                await Promise.all([\n                    joinSessionPromise,\n                    websocketTokenPromise,\n                    this.socketIoClientFactory(),\n                ]);\n\n            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken || null);\n            if (finalWebsocketToken === null) {\n                throw new NonRetryableError(\n                    \"pushTokenIsNull\",\n                    \"Websocket token is null\",\n                    OdspErrorType.fetchTokenError,\n                    { driverVersion });\n            }\n            try {\n                const connection = await this.connectToDeltaStreamWithRetry(\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                    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                if (typeof error === \"object\" && error !== null) {\n                    error.socketDocumentId = websocketEndpoint.id;\n                }\n                throw error;\n            }\n        });\n    }\n\n    private async joinSession(\n        requestSocketToken: boolean,\n        options: TokenFetchOptionsEx,\n    ): Promise<ISocketStorageDiscovery> {\n        const executeFetch = async () =>\n            fetchJoinSession(\n                this.odspResolvedUrl,\n                \"opStream/joinSession\",\n                \"POST\",\n                this.mc.logger,\n                this.getStorageToken,\n                this.epochTracker,\n                requestSocketToken,\n                options,\n                this.hostPolicy.sessionOptions?.unauthenticatedUserDisplayName,\n            );\n\n        // Note: The sessionCache is configured with a sliding expiry of 1 hour,\n        // so if we've fetched the join session within the last hour we won't run executeFetch again now.\n        return this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);\n    }\n\n    /**\n     * Connects to a delta stream endpoint\n     * If url #1 fails to connect, tries url #2 if applicable\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for storage service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param webSocketUrl - websocket URL\n     */\n    private async connectToDeltaStreamWithRetry(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: 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,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EACH,WAAW,EACX,yBAAyB,GAE5B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAOH,eAAe,GAClB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,mCAAmC,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAMtG,OAAO,EAMH,aAAa,GAChB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAuB,MAAM,aAAa,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAsD5B;;;;;;;;;;;;;OAaG;IACH,YACoB,eAAiC,EAChC,eAAgD,EAChD,iBAAuF,EACxG,MAAwB,EACP,qBAA0D,EAC1D,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC;;;QARlC,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAAsE;QAEvF,0BAAqB,GAArB,qBAAqB,CAAqC;QAC1D,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QAElD,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,yBAAyB,CAC/B,WAAW,CAAC,MAAM,CAAC,MAAM,EACzB,SAAS,EACT;YACI,GAAG,EAAE;gBACD,GAAG,EAAE,WAAW,CAAC,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,YAAA,IAAI,CAAC,UAAU,EAAC,yBAAyB,uCAAzB,yBAAyB,GACrC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,wCAAwC,CAAC,EAAC;QACxE,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACjC,IAAI,CAAC,UAAU,mCAAQ,IAAI,CAAC,UAAU,KAAE,gBAAgB,EAAE,IAAI,GAAE,CAAC;SACpE;IACL,CAAC;IAhGD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,WAAyB,EACzB,eAAgD,EAChD,iBAAuF,EACvF,MAAwB,EACxB,qBAA0D,EAC1D,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC;QAEjC,OAAO,IAAI,mBAAmB,CAC1B,kBAAkB,CAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,qBAAqB,EACrB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,CAC3B,CAAC;IACN,CAAC;IA8DD,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,0BAA0B,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,CACJ,CAAC;SACL;QAED,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB;;QAC9B,MAAM,WAAW,eAAG,IAAI,CAAC,cAAc,0CAAE,GAAG,mCAAI,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,uBAAuB,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,SAAG,IAAI,CAAC,UAAU,CAAC,YAAY,mCAAI,IAAI,CAAC;QACvD,MAAM,WAAW,SAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,CAAC,CAAC;QAC9D,OAAO,IAAI,yBAAyB,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,aAAM,IAAI,CAAC,QAAQ,0CAAE,GAAG,CAAC,IAAI,EAAE,EAAE,EAAC,CAAC;YAC/C,aAAO,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;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAC7C,2DAA2D;QAC3D,OAAO,2BAA2B,CAA2B,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,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;gBAClB,qBAAqB;gBACrB,IAAI,CAAC,qBAAqB,EAAE;aAC/B,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,iBAAiB,CACvB,yBAAyB,EACzB,aAAa,CAAC,eAAe,EAC7B,EAAE,aAAa,EAAE,CAAC,CAAC;aAC1B;YACD,IAAI;gBACA,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,6BAA6B,CACvD,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,eAAe,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;gBACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;oBAC7C,KAAK,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,EAAE,CAAC;iBACjD;gBACD,MAAM,KAAK,CAAC;aACf;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,2BAA2B,CAAC,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,mCAAO,IAAI,CAAC,SAAS,KAAC,WAAW,EAAE,IAAI,GAAC,CAAC;4BACvD,MAAM,IAAI,mCAAmC,CAAC,IAAI,EAAE,EAAE,aAAa,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,gBAAgB,CAC9C,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,QACzB,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,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC7F,wGAAwG;YACxG,qDAAqD;YACrD,QAAQ,CAAC,mBAAmB,CAAC,6BAA6B,SACtD,QAAQ,CAAC,mBAAmB,CAAC,6BAA6B,mCAAI,IAAI,CAAC;YACvE,uCACO,QAAQ,KACX,mBAAmB,EAAE,IAAI,CAAC,gCAAgC,CACtD,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,mBAAmB,CAAC,6BAA6B,CAAC,IACtF;QACL,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,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,iBACrB,SAAS,EAAE,yBAAyB,IACjC,KAAK,GAEZ,KAAK,CACR,CAAA;gBACL,CAAC,CAAC,CAAC;gBAAA,CAAC;aACX;iBAAM;gBACH,2FAA2F;gBAC3F,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,iBACzB,SAAS,EAAE,gCAAgC,IACxC,KAAK,EACV,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;;;;;;;;;;OAUG;IACK,KAAK,CAAC,6BAA6B,CACvC,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAAwB,EACxB,MAAe,EACf,YAAoB;QAEpB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,MAAM,2BAA2B,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,WAAW,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,GAAG;SAC9B;QACD,MAAA,IAAI,CAAC,SAAS,0CAAE,OAAO,GAAG;IAC9B,CAAC;IAED,IAAc,QAAQ;;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,IAAI,CAAC,SAAS,CAAC;SACzB;QAED,MAAM,SAAS,SAAG,IAAI,CAAC,cAAc,0CAAE,sBAAsB,CAAC;QAC9D,MAAM,SAAS,eAAG,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,QAAQ,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,iCAAK,MAAM,KAAE,GAAG,KAAG,OAAO,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAK,MAAM,KAAE,GAAG,IAAE;YAC5E,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,cACT,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,gBAAgB,mCAAI,IAAI,cACpD,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,EAAE;IAC/B,CAAC;CACJ","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    loggerToMonitoringContext,\n    MonitoringContext,\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 { DeltaStreamConnectionForbiddenError, NonRetryableError } 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 { 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<SocketIOClientStatic>,\n        cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix?: string,\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        );\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<SocketIOClientStatic>,\n        private readonly cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        private readonly epochTracker: EpochTracker,\n        private readonly socketReferenceKeyPrefix?: string,\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        this.hostPolicy.fetchBinarySnapshotFormat ??=\n            this.mc.config.getBoolean(\"Fluid.Driver.Odsp.binaryFormatSnapshot\");\n        if (this.odspResolvedUrl.summarizer) {\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        }\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    /**\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 joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options);\n            const [websocketEndpoint, websocketToken, io] =\n                await Promise.all([\n                    joinSessionPromise,\n                    websocketTokenPromise,\n                    this.socketIoClientFactory(),\n                ]);\n\n            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken || null);\n            if (finalWebsocketToken === null) {\n                throw new NonRetryableError(\n                    \"Websocket token is null\",\n                    OdspErrorType.fetchTokenError,\n                    { driverVersion });\n            }\n            try {\n                const connection = await this.connectToDeltaStreamWithRetry(\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                if (typeof error === \"object\" && error !== null) {\n                    error.socketDocumentId = websocketEndpoint.id;\n                }\n                throw error;\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            let 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                        this.mc.logger.sendErrorEvent({\n                                eventName: \"JoinSessionRefreshError\",\n                                ...props,\n                            },\n                            error,\n                        )\n                    });;\n            } else {\n                // Logging just for informational purposes to help with debugging as this is a new feature.\n                this.mc.logger.sendErrorEvent({\n                    eventName: \"JoinSessionRefreshNotScheduled\",\n                    ...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     * Connects to a delta stream endpoint\n     * If url #1 fails to connect, tries url #2 if applicable\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for storage service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param webSocketUrl - websocket URL\n     */\n    private async connectToDeltaStreamWithRetry(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: 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/lib/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,EACf,uBAAuB,EACvB,mBAAmB,EAEtB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,gBAAgB,EAGhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEH,yBAAyB,EAG5B,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EAA+B,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AA8G5D,qBAAa,0BAA2B,YAAW,uBAAuB;IA6DlE,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;IAnElC,QAAQ,CAAC,QAAQ;;;;MAgBf;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6C;IAEzE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA0B;IAEhE,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IACpE,OAAO,CAAC,IAAI,CAA8C;IAE1D,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,uBAAuB,CAAqB;IAEpD,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;IAE5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAE7C,IAAW,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,EAG9D;IAED,IAAW,GAAG,IAAI,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,CAE5D;IAED,IAAW,sBAAsB,uBAEhC;gBAGoB,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;IAe9D,IAAW,aAAa,IAAI,MAAM,CAEjC;IAEY,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;YA0ClE,YAAY;IAmDb,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlD,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;IAsD1E,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YA0KzE,aAAa;YAcb,iBAAiB;IAgFlB,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;IAMjF,wBAAwB,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC9F,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IAInF,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,sBAAsB;IAU9B,OAAO,CAAC,qBAAqB;YAUf,QAAQ;IA8CtB;;;;OAIG;YACW,eAAe;IA4B7B,OAAO,CAAC,iCAAiC;CAqB5C"}
+{"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,EACf,uBAAuB,EACvB,mBAAmB,EAEtB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,gBAAgB,EAGhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEH,yBAAyB,EAG5B,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EAA+B,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AA8G5D,qBAAa,0BAA2B,YAAW,uBAAuB;IA6DlE,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;IAnElC,QAAQ,CAAC,QAAQ;;;;MAgBf;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6C;IAEzE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA0B;IAEhE,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IACpE,OAAO,CAAC,IAAI,CAA8C;IAE1D,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,uBAAuB,CAAqB;IAEpD,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;IAE5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAE7C,IAAW,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,EAG9D;IAED,IAAW,GAAG,IAAI,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,CAE5D;IAED,IAAW,sBAAsB,uBAEhC;gBAGoB,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;IAe9D,IAAW,aAAa,IAAI,MAAM,CAEjC;IAEY,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;YA0ClE,YAAY;IAmDb,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlD,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;IAsD1E,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAwKzE,aAAa;YAcb,iBAAiB;IAgFlB,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;IAMjF,wBAAwB,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC9F,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IAInF,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,qBAAqB;YASf,QAAQ;IA8CtB;;;;OAIG;YACW,eAAe;IA4B7B,OAAO,CAAC,iCAAiC;CAqB5C"}

package/lib/odspDocumentStorageManager.js

@@ -389,10 +389,10 @@ export class OdspDocumentStorageService {
             }, async () => this.epochTracker.fetchAndParseAsJSON(url, { headers }, "versions"));
             const versionsResponse = response.content;
             if (!versionsResponse) {
-                throw new NonRetryableError("getVersionsReturnedNoResponse", "No response from /versions endpoint", DriverErrorType.genericNetworkError, { driverVersion });
+                throw new NonRetryableError("No response from /versions endpoint", DriverErrorType.genericNetworkError, { driverVersion });
             }
             if (!Array.isArray(versionsResponse.value)) {
-                throw new NonRetryableError("getVersionsReturnedNonArrayResponse", "Incorrect response from /versions endpoint", DriverErrorType.genericNetworkError, { driverVersion });
+                throw new NonRetryableError("Incorrect response from /versions endpoint, expected an array", DriverErrorType.genericNetworkError, { driverVersion });
             }
             return versionsResponse.value.map((version) => {
                 // Parse the date from the message
@@ -504,17 +504,17 @@ export class OdspDocumentStorageService {
     }
     checkSnapshotUrl() {
         if (!this.snapshotUrl) {
-            throw new NonRetryableError("noSnapshotUrlProvided", "Method failed because no snapshot url was available", DriverErrorType.genericError, { driverVersion });
+            throw new NonRetryableError("Method failed because no snapshot url was available", DriverErrorType.genericError, { driverVersion });
         }
     }
     checkAttachmentPOSTUrl() {
         if (!this.attachmentPOSTUrl) {
-            throw new NonRetryableError("noAttachmentPOSTUrlProvided", "Method failed because no attachment POST url was available", DriverErrorType.genericError, { driverVersion });
+            throw new NonRetryableError("Method failed because no attachment POST url was available", DriverErrorType.genericError, { driverVersion });
         }
     }
     checkAttachmentGETUrl() {
         if (!this.attachmentGETUrl) {
-            throw new NonRetryableError("noAttachmentGETUrlWasProvided", "Method failed because no attachment GET url was available", DriverErrorType.genericError, { driverVersion });
+            throw new NonRetryableError("Method failed because no attachment GET url was available", DriverErrorType.genericError, { driverVersion });
         }
     }
     async readTree(id) {