@fluidframework/odsp-driver 2.0.0-internal.2.2.1 → 2.0.0-internal.2.3.0

package/lib/odspDocumentService.d.ts

@@ -6,7 +6,6 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IDocumentDeltaConnection, IDocumentDeltaStorageService, IDocumentService, IResolvedUrl, IDocumentStorageService, IDocumentServicePolicies } from "@fluidframework/driver-definitions";
 import { IClient, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IOdspResolvedUrl, TokenFetchOptions, HostStoragePolicy, InstrumentedStorageTokenFetcher } from "@fluidframework/odsp-driver-definitions";
-import type { io as SocketIOClientStatic } from "socket.io-client";
 import { IOdspCache } from "./odspCache";
 import { EpochTracker } from "./epochTracker";
 import { OpsCache } from "./opsCaching";
@@ -18,13 +17,14 @@ export declare class OdspDocumentService implements IDocumentService {
     readonly odspResolvedUrl: IOdspResolvedUrl;
     private readonly getStorageToken;
     private readonly getWebsocketToken;
-    private readonly socketIoClientFactory;
     private readonly cache;
     private readonly epochTracker;
     private readonly socketReferenceKeyPrefix?;
     private readonly clientIsSummarizer?;
-    private _policies;
-    private joinSessionRefreshTimer;
+    private readonly _policies;
+    private socketModuleP;
+    private odspDelayLoadedDeltaStream;
+    private odspSocketModuleLoaded;
     /**
      * @param resolvedUrl - resolved url identifying document that will be managed by returned service instance.
      * @param getStorageToken - function that can provide the storage token. This is is also referred to as
@@ -33,20 +33,16 @@ export declare class OdspDocumentService implements IDocumentService {
      * to as the "Push" token in SPO. If undefined then websocket token is expected to be returned with joinSession
      * response payload.
      * @param logger - a logger that can capture performance and diagnostic information
-     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver
      * @param cache - This caches response for joinSession.
      * @param hostPolicy - This host constructed policy which customizes service behavior.
      * @param epochTracker - This helper class which adds epoch to backend calls made by returned service instance.
      * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache
      */
-    static create(resolvedUrl: IResolvedUrl, getStorageToken: InstrumentedStorageTokenFetcher, getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined, logger: ITelemetryLogger, socketIoClientFactory: () => Promise<typeof SocketIOClientStatic>, cache: IOdspCache, hostPolicy: HostStoragePolicy, epochTracker: EpochTracker, socketReferenceKeyPrefix?: string, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    static create(resolvedUrl: IResolvedUrl, getStorageToken: InstrumentedStorageTokenFetcher, getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined, logger: ITelemetryLogger, cache: IOdspCache, hostPolicy: HostStoragePolicy, epochTracker: EpochTracker, socketReferenceKeyPrefix?: string, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     private storageManager?;
     private readonly mc;
-    private readonly joinSessionKey;
     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
@@ -76,30 +72,19 @@ export declare class OdspDocumentService implements IDocumentService {
      * @returns returns the document delta storage service for sharepoint driver.
      */
     connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
-    /** Annotate the given error indicating which connection step failed */
-    private annotateConnectionError;
     /**
      * Connects to a delta stream endpoint for emitting ops.
      *
      * @returns returns the document delta stream service for onedrive/sharepoint driver.
      */
     connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
-    private clearJoinSessionTimer;
-    private scheduleJoinSessionRefresh;
-    private joinSession;
-    private joinSessionCore;
-    private calculateJoinSessionRefreshDelta;
     /**
-     * Creats a connection to the given delta stream endpoint
-     *
-     * @param tenantId - the ID of the tenant
-     * @param documentId - document ID
-     * @param token - authorization token for delta service
-     * @param io - websocket library
-     * @param client - information about the client
-     * @param webSocketUrl - websocket URL
+     * This dynamically imports the module for loading the delta connection. In many cases the delta stream, is not
+     * required during the critical load flow. So this way we don't have to bundle this in the initial bundle and can
+     * import this later on when required.
+     * @returns - delta stream object.
      */
-    private createDeltaConnection;
+    private getDelayLoadedDeltaStream;
     dispose(error?: any): void;
     protected get opsCache(): OpsCache | undefined;
     protected opsReceived(ops: ISequencedDocumentMessage[]): void;

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;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;IA2BjE;;;;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;IA4ErF,OAAO,CAAC,qBAAqB;YAOf,0BAA0B;YAa1B,WAAW;YA2BX,eAAe;IA2E7B,OAAO,CAAC,gCAAgC;IAKxC;;;;;;;;;OASG;YACW,qBAAqB;IAkC5B,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAgB1B,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,EAC3B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EAEjB,iBAAiB,EACjB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,gBAAgB;aAsEpC,eAAe,EAAE,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAElC,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;IA7ExC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA2B;IAGrD,OAAO,CAAC,aAAa,CAAkD;IAEvE,OAAO,CAAC,0BAA0B,CAAyC;IAE3E,OAAO,CAAC,sBAAsB,CAAkB;IAEhD;;;;;;;;;;;;OAYG;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,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;IAc5B,OAAO,CAAC,cAAc,CAAC,CAA6B;IAEpD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA4B;IAEvD,OAAO,CAAC,SAAS,CAAC,CAAW;IAE7B;;;;;;;;;;;;;OAaG;IACH,OAAO;IA+BP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IA4BjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAmC3E;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAiBrF;;;;;OAKG;YACW,yBAAyB;IA0BhC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAe1B,SAAS,KAAK,QAAQ,yBA8BrB;IAID,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB,EAAE;CAQzD"}

package/lib/odspDocumentService.js

@@ -2,21 +2,14 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { assert, performance } from "@fluidframework/common-utils";
-import { ChildLogger, loggerToMonitoringContext, normalizeError, } from "@fluidframework/telemetry-utils";
-import { DriverErrorType, } from "@fluidframework/driver-definitions";
-import { canRetryOnError, DeltaStreamConnectionForbiddenError, NonRetryableError } from "@fluidframework/driver-utils";
-import { OdspErrorType, } from "@fluidframework/odsp-driver-definitions";
-import { hasFacetCodes } from "@fluidframework/odsp-doclib-utils";
+import { assert } from "@fluidframework/common-utils";
+import { ChildLogger, loggerToMonitoringContext, } from "@fluidframework/telemetry-utils";
 import { OdspDeltaStorageService, OdspDeltaStorageWithCache } from "./odspDeltaStorageService";
-import { OdspDocumentDeltaConnection } from "./odspDocumentDeltaConnection";
 import { OdspDocumentStorageService } from "./odspDocumentStorageManager";
-import { getWithRetryForTokenRefresh, getOdspResolvedUrl } from "./odspUtils";
-import { fetchJoinSession } from "./vroom";
+import { getOdspResolvedUrl } from "./odspUtils";
 import { isOdcOrigin } from "./odspUrlHelper";
 import { OpsCache } from "./opsCaching";
 import { RetryErrorsStorageAdapter } from "./retryErrorsStorageAdapter";
-import { pkgVersion as driverVersion } from "./packageVersion";
 /**
  * The DocumentService manages the Socket.IO connection and manages routing requests to connected
  * clients
@@ -36,20 +29,19 @@ export class OdspDocumentService {
      * @param epochTracker - This helper class which adds epoch to backend calls made by this service instance.
      * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache
      */
-    constructor(odspResolvedUrl, getStorageToken, getWebsocketToken, logger, socketIoClientFactory, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer) {
+    constructor(odspResolvedUrl, getStorageToken, getWebsocketToken, logger, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer) {
         this.odspResolvedUrl = odspResolvedUrl;
         this.getStorageToken = getStorageToken;
         this.getWebsocketToken = getWebsocketToken;
-        this.socketIoClientFactory = socketIoClientFactory;
         this.cache = cache;
         this.epochTracker = epochTracker;
         this.socketReferenceKeyPrefix = socketReferenceKeyPrefix;
         this.clientIsSummarizer = clientIsSummarizer;
+        this.odspSocketModuleLoaded = false;
         this._policies = {
             // load in storage-only mode if a file version is specified
             storageOnly: odspResolvedUrl.fileVersion !== undefined,
         };
-        this.joinSessionKey = `${this.odspResolvedUrl.hashedDocumentId}/joinsession`;
         this.mc = loggerToMonitoringContext(ChildLogger.create(logger, undefined, {
             all: {
                 odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),
@@ -68,14 +60,13 @@ export class OdspDocumentService {
      * to as the "Push" token in SPO. If undefined then websocket token is expected to be returned with joinSession
      * response payload.
      * @param logger - a logger that can capture performance and diagnostic information
-     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver
      * @param cache - This caches response for joinSession.
      * @param hostPolicy - This host constructed policy which customizes service behavior.
      * @param epochTracker - This helper class which adds epoch to backend calls made by returned service instance.
      * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache
      */
-    static async create(resolvedUrl, getStorageToken, getWebsocketToken, logger, socketIoClientFactory, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer) {
-        return new OdspDocumentService(getOdspResolvedUrl(resolvedUrl), getStorageToken, getWebsocketToken, logger, socketIoClientFactory, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer);
+    static async create(resolvedUrl, getStorageToken, getWebsocketToken, logger, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer) {
+        return new OdspDocumentService(getOdspResolvedUrl(resolvedUrl), getStorageToken, getWebsocketToken, logger, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer);
     }
     get resolvedUrl() {
         return this.odspResolvedUrl;
@@ -93,12 +84,15 @@ export class OdspDocumentService {
             this.storageManager = new OdspDocumentStorageService(this.odspResolvedUrl, this.getStorageToken, this.mc.logger, true, this.cache, this.hostPolicy, this.epochTracker, 
             // flushCallback
             async () => {
-                if (this.currentConnection !== undefined && !this.currentConnection.disposed) {
-                    return this.currentConnection.flush();
+                var _a;
+                const currentConnection = (_a = this.odspDelayLoadedDeltaStream) === null || _a === void 0 ? void 0 : _a.currentDeltaConnection;
+                if (currentConnection !== undefined && !currentConnection.disposed) {
+                    return currentConnection.flush();
                 }
                 throw new Error("Disconnected while uploading summary (attempt to perform flush())");
             }, () => {
-                return this.relayServiceTenantAndSessionId;
+                var _a;
+                return (_a = this.odspDelayLoadedDeltaStream) === null || _a === void 0 ? void 0 : _a.relayServiceTenantAndSessionId;
             }, this.mc.config.getNumber("Fluid.Driver.Odsp.snapshotFormatFetchType"));
         }
         return new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);
@@ -115,208 +109,64 @@ export class OdspDocumentService {
         // batch size, please see issue #5211 for data around batch sizing
         const batchSize = (_c = this.hostPolicy.opsBatchSize) !== null && _c !== void 0 ? _c : 5000;
         const concurrency = (_d = this.hostPolicy.concurrentOpsBatches) !== null && _d !== void 0 ? _d : 1;
-        return new OdspDeltaStorageWithCache(snapshotOps, this.mc.logger, batchSize, concurrency, async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason), async (from, to) => {
+        return new OdspDeltaStorageWithCache(snapshotOps, this.mc.logger, batchSize, concurrency, 
+        // Get Ops from storage callback.
+        async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason), 
+        // Get cachedOps Callback.
+        async (from, to) => {
             var _a, _b;
             const res = await ((_a = this.opsCache) === null || _a === void 0 ? void 0 : _a.get(from, to));
             return (_b = res) !== null && _b !== void 0 ? _b : [];
-        }, (from, to) => {
-            if (this.currentConnection !== undefined && !this.currentConnection.disposed) {
-                this.currentConnection.requestOps(from, to);
+        }, 
+        // Ops requestFromSocket Callback.
+        (from, to) => {
+            var _a;
+            const currentConnection = (_a = this.odspDelayLoadedDeltaStream) === null || _a === void 0 ? void 0 : _a.currentDeltaConnection;
+            if (currentConnection !== undefined && !currentConnection.disposed) {
+                currentConnection.requestOps(from, to);
             }
         }, (ops) => this.opsReceived(ops));
     }
-    /** Annotate the given error indicating which connection step failed */
-    annotateConnectionError(error, failedConnectionStep, separateTokenRequest) {
-        return normalizeError(error, { props: {
-                failedConnectionStep,
-                separateTokenRequest,
-            } });
-    }
     /**
      * Connects to a delta stream endpoint for emitting ops.
      *
      * @returns returns the document delta stream service for onedrive/sharepoint driver.
      */
     async connectToDeltaStream(client) {
-        assert(this.currentConnection === undefined, 0x4ad /* Should not be called when connection is already present! */);
-        // Attempt to connect twice, in case we used expired token.
-        return 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;
-            const websocketTokenPromise = requestWebsocketTokenFromJoinSession
-                ? Promise.resolve(null)
-                : this.getWebsocketToken(options);
-            const annotateAndRethrowConnectionError = (step) => (error) => {
-                throw this.annotateConnectionError(error, step, !requestWebsocketTokenFromJoinSession);
-            };
-            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options);
-            const [websocketEndpoint, websocketToken, io] = await Promise.all([
-                joinSessionPromise.catch(annotateAndRethrowConnectionError("joinSession")),
-                websocketTokenPromise.catch(annotateAndRethrowConnectionError("getWebsocketToken")),
-                this.socketIoClientFactory().catch(annotateAndRethrowConnectionError("socketIoClientFactory")),
-            ]);
-            const finalWebsocketToken = websocketToken !== null && websocketToken !== void 0 ? websocketToken : ((_a = websocketEndpoint.socketToken) !== null && _a !== void 0 ? _a : null);
-            if (finalWebsocketToken === null) {
-                throw this.annotateConnectionError(new NonRetryableError("Websocket token is null", OdspErrorType.fetchTokenError, { driverVersion }), "getWebsocketToken", !requestWebsocketTokenFromJoinSession);
-            }
-            try {
-                const connection = await this.createDeltaConnection(websocketEndpoint.tenantId, websocketEndpoint.id, finalWebsocketToken, io, client, websocketEndpoint.deltaStreamSocketUrl);
-                connection.on("op", (documentId, ops) => {
-                    this.opsReceived(ops);
-                });
-                // 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.once("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);
-                    }
-                    // If we hit this assert, it means that "disconnect" event is emitted before the connection went through
-                    // dispose flow which is not correct and could lead to a bunch of erros.
-                    assert(connection.disposed, 0x4ae /* Connection should be disposed by now */);
-                    this.currentConnection = undefined;
-                });
-                this.currentConnection = connection;
-                return connection;
-            }
-            catch (error) {
-                this.cache.sessionJoinCache.remove(this.joinSessionKey);
-                const normalizedError = this.annotateConnectionError(error, "createDeltaConnection", !requestWebsocketTokenFromJoinSession);
-                if (typeof error === "object" && error !== null) {
-                    normalizedError.addTelemetryProperties({ socketDocumentId: websocketEndpoint.id });
-                }
-                throw normalizedError;
-            }
-        });
-    }
-    clearJoinSessionTimer() {
-        if (this.joinSessionRefreshTimer !== undefined) {
-            clearTimeout(this.joinSessionRefreshTimer);
-            this.joinSessionRefreshTimer = undefined;
+        if (this.socketModuleP === undefined) {
+            this.socketModuleP = this.getDelayLoadedDeltaStream();
         }
-    }
-    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) {
-        const response = await this.joinSessionCore(requestSocketToken, options).catch((e) => {
-            if (hasFacetCodes(e) && e.facetCodes !== undefined) {
-                for (const code of e.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;
+        return this.socketModuleP
+            .then(async (m) => {
+            this.odspSocketModuleLoaded = true;
+            return m.connectToDeltaStream(client);
+        })
+            .catch((error) => {
+            // Setting undefined in case someone tries to recover from module failure by calling again.
+            this.socketModuleP = undefined;
+            this.odspSocketModuleLoaded = false;
+            throw error;
         });
-        this.relayServiceTenantAndSessionId = `${response.tenantId}/${response.id}`;
-        return response;
-    }
-    async joinSessionCore(requestSocketToken, options) {
-        const disableJoinSessionRefresh = this.mc.config.getBoolean("Fluid.Driver.Odsp.disableJoinSessionRefresh");
-        const executeFetch = async () => {
-            var _a;
-            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,
-            };
-        };
-        const getResponseAndRefreshAfterDeltaMs = async () => {
-            var _a;
-            const _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) => {
-                    const canRetry = canRetryOnError(error);
-                    // Only record error event in case it is non retriable.
-                    if (!canRetry) {
-                        this.mc.logger.sendErrorEvent({
-                            eventName: "JoinSessionRefreshError",
-                            details: JSON.stringify(props),
-                        }, error);
-                    }
-                });
-            }
-            else {
-                // Logging just for informational purposes to help with debugging as this is a new feature.
-                this.mc.logger.sendTelemetryEvent({
-                    eventName: "JoinSessionRefreshNotScheduled",
-                    details: JSON.stringify(props),
-                });
-            }
-        }
-        return response.joinSessionResponse;
-    }
-    calculateJoinSessionRefreshDelta(responseFetchTime, refreshSessionDurationSeconds) {
-        // 30 seconds is buffer time to refresh the session.
-        return responseFetchTime + ((refreshSessionDurationSeconds * 1000) - 30000) - Date.now();
     }
     /**
-     * Creats a connection to the given delta stream endpoint
-     *
-     * @param tenantId - the ID of the tenant
-     * @param documentId - document ID
-     * @param token - authorization token for delta service
-     * @param io - websocket library
-     * @param client - information about the client
-     * @param webSocketUrl - websocket URL
+     * This dynamically imports the module for loading the delta connection. In many cases the delta stream, is not
+     * required during the critical load flow. So this way we don't have to bundle this in the initial bundle and can
+     * import this later on when required.
+     * @returns - delta stream object.
      */
-    async createDeltaConnection(tenantId, documentId, token, io, client, webSocketUrl) {
-        const startTime = performance.now();
-        const connection = await OdspDocumentDeltaConnection.create(tenantId, documentId, token, io, client, webSocketUrl, this.mc.logger, 60000, this.epochTracker, this.socketReferenceKeyPrefix);
-        const duration = performance.now() - startTime;
-        // This event happens rather often, so it adds up to cost of telemetry.
-        // Given that most reconnects result in reusing socket and happen very quickly,
-        // report event only if it took longer than threshold.
-        if (duration >= 2000) {
-            this.mc.logger.sendPerformanceEvent({
-                eventName: "ConnectionSuccess",
-                duration,
-            });
-        }
-        return connection;
+    async getDelayLoadedDeltaStream() {
+        assert(this.odspSocketModuleLoaded === false, 0x507 /* Should be loaded only once */);
+        const module = await import(/* webpackChunkName: "socketModule" */ "./odspDelayLoadedDeltaStream")
+            .then((m) => {
+            this.mc.logger.sendTelemetryEvent({ eventName: "SocketModuleLoaded" });
+            return m;
+        })
+            .catch((error) => {
+            this.mc.logger.sendErrorEvent({ eventName: "SocketModuleLoadFailed" }, error);
+            throw error;
+        });
+        this.odspDelayLoadedDeltaStream = new module.OdspDelayLoadedDeltaStream(this.odspResolvedUrl, this._policies, this.getStorageToken, this.getWebsocketToken, this.mc, this.cache, this.hostPolicy, this.epochTracker, (ops) => this.opsReceived(ops), this.socketReferenceKeyPrefix);
+        return this.odspDelayLoadedDeltaStream;
     }
     dispose(error) {
         var _a, _b, _c;
@@ -331,9 +181,8 @@ export class OdspDocumentService {
             (_a = this._opsCache) === null || _a === void 0 ? void 0 : _a.flushOps();
         }
         (_b = this._opsCache) === null || _b === void 0 ? void 0 : _b.dispose();
-        this.clearJoinSessionTimer();
-        (_c = this.currentConnection) === null || _c === void 0 ? void 0 : _c.dispose();
-        this.currentConnection = undefined;
+        // Only need to dipose this, if it is already loaded.
+        (_c = this.odspDelayLoadedDeltaStream) === null || _c === void 0 ? void 0 : _c.dispose();
     }
     get opsCache() {
         var _a, _b, _c, _d, _e, _f, _g;

package/lib/odspDocumentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentService.js","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EACH,WAAW,EAEX,yBAAyB,EAEzB,cAAc,GACjB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAOH,eAAe,GAClB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,mCAAmC,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKvH,OAAO,EAMH,aAAa,GAChB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAIlE,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;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,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,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,kBAAkB,CAAC,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,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,EACD,GAAG,EAAE;gBACD,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,yBAAyB,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,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,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,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,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,cAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE;gBAClC,oBAAoB;gBACpB,oBAAoB;aACvB,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAC7C,MAAM,CAAC,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,KAAK,CAAC,8DAA8D,CAAC,CAAC;QACnH,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,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,iBAAiB,CACjB,yBAAyB,EACzB,aAAa,CAAC,eAAe,EAC7B,EAAE,aAAa,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,IAAI,CAAC,YAAY,EAAE,CAAC,KAAU,EAAE,EAAE;oBACzC,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;oBACD,wGAAwG;oBACxG,wEAAwE;oBACxE,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;oBAC9E,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;gBACvC,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,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,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACjF,IAAI,aAAa,CAAC,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,mCAAmC,CAAC,IAAI,EAAE,EAAE,aAAa,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,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,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,eAAe,CAAC,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,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,EAAE,CAAC;SAC9B;QACD,MAAA,IAAI,CAAC,SAAS,0CAAE,OAAO,EAAE,CAAC;QAC1B,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7B,MAAA,IAAI,CAAC,iBAAiB,0CAAE,OAAO,EAAE,CAAC;QAClC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;IACvC,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,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,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","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                    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        assert(this.currentConnection === undefined, 0x4ad /* Should not be called when connection is already present! */);\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.once(\"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                    // If we hit this assert, it means that \"disconnect\" event is emitted before the connection went through\n                    // dispose flow which is not correct and could lead to a bunch of erros.\n                    assert(connection.disposed, 0x4ae /* Connection should be disposed by now */);\n                    this.currentConnection = undefined;\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        this.clearJoinSessionTimer();\n        this.currentConnection?.dispose();\n        this.currentConnection = undefined;\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,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EACH,WAAW,EACX,yBAAyB,GAE5B,MAAM,iCAAiC,CAAC;AAsBzC,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAGxE;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAuD5B;;;;;;;;;;;;;OAaG;IACH,YACoB,eAAiC,EAChC,eAAgD,EAChD,iBAAuF,EACxG,MAAwB,EACP,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAR7B,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAAsE;QAEvF,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QACjC,uBAAkB,GAAlB,kBAAkB,CAAU;QAtEzC,2BAAsB,GAAY,KAAK,CAAC;QAwE5C,IAAI,CAAC,SAAS,GAAG;YACb,2DAA2D;YAC3D,WAAW,EAAE,eAAe,CAAC,WAAW,KAAK,SAAS;SACzD,CAAC;QAEF,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,IAAI,IAAI,CAAC,kBAAkB,EAAE;YACzB,IAAI,CAAC,UAAU,mCAAQ,IAAI,CAAC,UAAU,KAAE,gBAAgB,EAAE,IAAI,GAAE,CAAC;SACpE;IACL,CAAC;IAxFD;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,WAAyB,EACzB,eAAgD,EAChD,iBAAuF,EACvF,MAAwB,EACxB,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAE5B,OAAO,IAAI,mBAAmB,CAC1B,kBAAkB,CAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,EACxB,kBAAkB,CACrB,CAAC;IACN,CAAC;IAuDD,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,MAAM,iBAAiB,GAAG,MAAA,IAAI,CAAC,0BAA0B,0CAAE,sBAAsB,CAAC;gBAClF,IAAI,iBAAiB,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;oBAChE,OAAO,iBAAiB,CAAC,KAAK,EAAE,CAAC;iBACpC;gBACD,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;YACzF,CAAC,EACD,GAAG,EAAE;;gBACD,OAAO,MAAA,IAAI,CAAC,0BAA0B,0CAAE,8BAA8B,CAAC;YAC3E,CAAC,EACD,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,2CAA2C,CAAC,CACxE,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,GAAG,MAAA,MAAA,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,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,yBAAyB,CAChC,WAAW,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,SAAS,EACT,WAAW;QACX,iCAAiC;QACjC,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,CAAC;QACnG,0BAA0B;QAC1B,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;QACD,kCAAkC;QAClC,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;;YACT,MAAM,iBAAiB,GAAG,MAAA,IAAI,CAAC,0BAA0B,0CAAE,sBAAsB,CAAC;YAClF,IAAI,iBAAiB,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBAChE,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC1C;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,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAC;SACzD;QACD,OAAO,IAAI,CAAC,aAAa;aACpB,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;YACd,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACnC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,2FAA2F;YAC3F,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;YACpC,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,yBAAyB;QACnC,MAAM,CAAC,IAAI,CAAC,sBAAsB,KAAK,KAAK,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,sCAAsC,CAAC,8BAA8B,CAAC;aAC7F,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YACR,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC,CAAC;YACvE,OAAO,CAAC,CAAC;QACb,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAE,EAAE,SAAS,EAAE,wBAAwB,EAAE,EAAE,KAAK,CAAC,CAAC;YAC/E,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;QACP,IAAI,CAAC,0BAA0B,GAAG,IAAI,MAAM,CAAC,0BAA0B,CACnE,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,YAAY,EACjB,CAAC,GAAgC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAC3D,IAAI,CAAC,wBAAwB,CAChC,CAAC;QACF,OAAO,IAAI,CAAC,0BAA0B,CAAC;IAC3C,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;QAC1B,qDAAqD;QACrD,MAAA,IAAI,CAAC,0BAA0B,0CAAE,OAAO,EAAE,CAAC;IAC/C,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,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,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","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 {\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} from \"@fluidframework/driver-definitions\";\nimport {\n    IClient,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    IEntry,\n    HostStoragePolicy,\n    InstrumentedStorageTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { HostStoragePolicyInternal } from \"./contracts\";\nimport { IOdspCache } from \"./odspCache\";\nimport { OdspDeltaStorageService, OdspDeltaStorageWithCache } from \"./odspDeltaStorageService\";\nimport { OdspDocumentStorageService } from \"./odspDocumentStorageManager\";\nimport { getOdspResolvedUrl } from \"./odspUtils\";\nimport { isOdcOrigin } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OpsCache } from \"./opsCaching\";\nimport { RetryErrorsStorageAdapter } from \"./retryErrorsStorageAdapter\";\nimport type { OdspDelayLoadedDeltaStream } from \"./odspDelayLoadedDeltaStream\";\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 readonly _policies: IDocumentServicePolicies;\n\n    // Promise to load socket module only once.\n    private socketModuleP: Promise<OdspDelayLoadedDeltaStream> | undefined;\n\n    private odspDelayLoadedDeltaStream: OdspDelayLoadedDeltaStream | undefined;\n\n    private odspSocketModuleLoaded: boolean = false;\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 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        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            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 hostPolicy: HostStoragePolicyInternal;\n\n    private _opsCache?: OpsCache;\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 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.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                    const currentConnection = this.odspDelayLoadedDeltaStream?.currentDeltaConnection;\n                    if (currentConnection !== undefined && !currentConnection.disposed) {\n                        return currentConnection.flush();\n                    }\n                    throw new Error(\"Disconnected while uploading summary (attempt to perform flush())\");\n                },\n                () => {\n                    return this.odspDelayLoadedDeltaStream?.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            // Get Ops from storage callback.\n            async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason),\n            // Get cachedOps Callback.\n            async (from, to) => {\n                const res = await this.opsCache?.get(from, to);\n                return res as ISequencedDocumentMessage[] ?? [];\n            },\n            // Ops requestFromSocket Callback.\n            (from, to) => {\n                const currentConnection = this.odspDelayLoadedDeltaStream?.currentDeltaConnection;\n                if (currentConnection !== undefined && !currentConnection.disposed) {\n                    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        if (this.socketModuleP === undefined) {\n            this.socketModuleP = this.getDelayLoadedDeltaStream();\n        }\n        return this.socketModuleP\n            .then(async (m) => {\n                this.odspSocketModuleLoaded = true;\n                return m.connectToDeltaStream(client);\n            })\n            .catch((error) => {\n                // Setting undefined in case someone tries to recover from module failure by calling again.\n                this.socketModuleP = undefined;\n                this.odspSocketModuleLoaded = false;\n                throw error;\n            });\n    }\n\n    /**\n     * This dynamically imports the module for loading the delta connection. In many cases the delta stream, is not\n     * required during the critical load flow. So this way we don't have to bundle this in the initial bundle and can\n     * import this later on when required.\n     * @returns - delta stream object.\n     */\n    private async getDelayLoadedDeltaStream() {\n        assert(this.odspSocketModuleLoaded === false, 0x507 /* Should be loaded only once */);\n        const module = await import(/* webpackChunkName: \"socketModule\" */ \"./odspDelayLoadedDeltaStream\")\n            .then((m) => {\n                this.mc.logger.sendTelemetryEvent({ eventName: \"SocketModuleLoaded\" });\n                return m;\n            })\n            .catch((error) => {\n                this.mc.logger.sendErrorEvent( { eventName: \"SocketModuleLoadFailed\" }, error);\n                throw error;\n            });\n        this.odspDelayLoadedDeltaStream = new module.OdspDelayLoadedDeltaStream(\n            this.odspResolvedUrl,\n            this._policies,\n            this.getStorageToken,\n            this.getWebsocketToken,\n            this.mc,\n            this.cache,\n            this.hostPolicy,\n            this.epochTracker,\n            (ops: ISequencedDocumentMessage[]) => this.opsReceived(ops),\n            this.socketReferenceKeyPrefix,\n        );\n        return this.odspDelayLoadedDeltaStream;\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        // Only need to dipose this, if it is already loaded.\n        this.odspDelayLoadedDeltaStream?.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/odspDocumentServiceFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentServiceFactory.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EACpB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAKlF;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,8BAA8B;gBAEtE,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,EAC5D,iBAAiB,EAAE,YAAY,CAAC,6BAA6B,CAAC,GAAG,SAAS,EAC1E,cAAc,CAAC,EAAE,eAAe,EAChC,UAAU,CAAC,EAAE,iBAAiB;CAUrC;AAED,wBAAgB,qCAAqC,CAAC,aAAa,EAAE,UAAU,GAAG,MAAM,GAAG,uBAAuB,CAEjH"}
+{"version":3,"file":"odspDocumentServiceFactory.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EACpB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAIlF;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,8BAA8B;gBAEtE,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,EAC5D,iBAAiB,EAAE,YAAY,CAAC,6BAA6B,CAAC,GAAG,SAAS,EAC1E,cAAc,CAAC,EAAE,eAAe,EAChC,UAAU,CAAC,EAAE,iBAAiB;CASrC;AAED,wBAAgB,qCAAqC,CAAC,aAAa,EAAE,UAAU,GAAG,MAAM,GAAG,uBAAuB,CAEjH"}

package/lib/odspDocumentServiceFactory.js

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore";
-import { getSocketIo } from "./getSocketIo";
 // eslint-disable-next-line import/no-internal-modules
 import { LocalOdspDocumentServiceFactory } from "./localOdspDriver/localOdspDocumentServiceFactory";
 /**
@@ -12,7 +11,7 @@ import { LocalOdspDocumentServiceFactory } from "./localOdspDriver/localOdspDocu
  */
 export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
     constructor(getStorageToken, getWebsocketToken, persistedCache, hostPolicy) {
-        super(getStorageToken, getWebsocketToken, async () => getSocketIo(), persistedCache, hostPolicy);
+        super(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);
     }
 }
 export function createLocalOdspDocumentServiceFactory(localSnapshot) {

package/lib/odspDocumentServiceFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentServiceFactory.js","sourceRoot":"","sources":["../src/odspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,sDAAsD;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,mDAAmD,CAAC;AAEpG;;;GAGG;AACH,MAAM,OAAO,0BAA2B,SAAQ,8BAA8B;IAC1E,YACI,eAA4D,EAC5D,iBAA0E,EAC1E,cAAgC,EAChC,UAA8B;QAE9B,KAAK,CACD,eAAe,EACf,iBAAiB,EACjB,KAAK,IAAI,EAAE,CAAC,WAAW,EAAE,EACzB,cAAc,EACd,UAAU,CACb,CAAC;IACN,CAAC;CACJ;AAED,MAAM,UAAU,qCAAqC,CAAC,aAAkC;IACpF,OAAO,IAAI,+BAA+B,CAAC,aAAa,CAAC,CAAC;AAC9D,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentServiceFactory } from \"@fluidframework/driver-definitions\";\nimport {\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    IPersistedCache,\n    HostStoragePolicy,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { OdspDocumentServiceFactoryCore } from \"./odspDocumentServiceFactoryCore\";\nimport { getSocketIo } from \"./getSocketIo\";\n// eslint-disable-next-line import/no-internal-modules\nimport { LocalOdspDocumentServiceFactory } from \"./localOdspDriver/localOdspDocumentServiceFactory\";\n\n/**\n * Factory for creating the sharepoint document service. Use this if you want to\n * use the sharepoint implementation.\n */\nexport class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {\n    constructor(\n        getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n        getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,\n        persistedCache?: IPersistedCache,\n        hostPolicy?: HostStoragePolicy,\n    ) {\n        super(\n            getStorageToken,\n            getWebsocketToken,\n            async () => getSocketIo(),\n            persistedCache,\n            hostPolicy,\n        );\n    }\n}\n\nexport function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory {\n    return new LocalOdspDocumentServiceFactory(localSnapshot);\n}\n"]}
+{"version":3,"file":"odspDocumentServiceFactory.js","sourceRoot":"","sources":["../src/odspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAClF,sDAAsD;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,mDAAmD,CAAC;AAEpG;;;GAGG;AACH,MAAM,OAAO,0BAA2B,SAAQ,8BAA8B;IAC1E,YACI,eAA4D,EAC5D,iBAA0E,EAC1E,cAAgC,EAChC,UAA8B;QAE9B,KAAK,CACD,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,UAAU,CACb,CAAC;IACN,CAAC;CACJ;AAED,MAAM,UAAU,qCAAqC,CAAC,aAAkC;IACpF,OAAO,IAAI,+BAA+B,CAAC,aAAa,CAAC,CAAC;AAC9D,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentServiceFactory } from \"@fluidframework/driver-definitions\";\nimport {\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    IPersistedCache,\n    HostStoragePolicy,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { OdspDocumentServiceFactoryCore } from \"./odspDocumentServiceFactoryCore\";\n// eslint-disable-next-line import/no-internal-modules\nimport { LocalOdspDocumentServiceFactory } from \"./localOdspDriver/localOdspDocumentServiceFactory\";\n\n/**\n * Factory for creating the sharepoint document service. Use this if you want to\n * use the sharepoint implementation.\n */\nexport class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {\n    constructor(\n        getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n        getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,\n        persistedCache?: IPersistedCache,\n        hostPolicy?: HostStoragePolicy,\n    ) {\n        super(\n            getStorageToken,\n            getWebsocketToken,\n            persistedCache,\n            hostPolicy,\n        );\n    }\n}\n\nexport function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory {\n    return new LocalOdspDocumentServiceFactory(localSnapshot);\n}\n"]}