@fluidframework/odsp-driver 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/lib/{odspDocumentService.d.ts → odspDocumentService.d.mts}

@@ -2,14 +2,13 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 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";
+import { IOdspCache } from "./odspCache.mjs";
+import { EpochTracker } from "./epochTracker.mjs";
+import { OpsCache } from "./opsCaching.mjs";
 /**
  * The DocumentService manages the Socket.IO connection and manages routing requests to connected
  * clients
@@ -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,19 +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: ITelemetryLoggerExt, 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?;
     /**
      * @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
@@ -75,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 The 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.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspDocumentService.d.ts","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,mBAAmB,EAGnB,MAAM,iCAAiC;OAEjC,EACN,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EACxB,MAAM,oCAAoC;OACpC,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC;OAClF,EACN,gBAAgB,EAChB,iBAAiB,EAEjB,iBAAiB,EACjB,+BAA+B,EAC/B,MAAM,yCAAyC;OAEzC,EAAE,UAAU,EAAE;OAKd,EAAE,YAAY,EAAE;OAChB,EAAE,QAAQ,EAAE;AAInB;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,gBAAgB;aAuE1C,eAAe,EAAE,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAIlC,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;IAhFrC,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,CACzB,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,+BAA+B,EAEhD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,SAAS,EACvF,MAAM,EAAE,mBAAmB,EAC3B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,iBAAiB,EAC7B,YAAY,EAAE,YAAY,EAC1B,wBAAwB,CAAC,EAAE,MAAM,EACjC,kBAAkB,CAAC,EAAE,OAAO,GAC1B,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;IAoCP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IA+BjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAqC3E;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAiBrF;;;;;OAKG;YACW,yBAAyB;IA4BhC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAe1B,SAAS,KAAK,QAAQ,yBAgCrB;IAID,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB,EAAE;CAQtD"}

package/lib/odspDocumentService.mjs

@@ -0,0 +1,221 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { createChildMonitoringContext, } from "@fluidframework/telemetry-utils";
+import { assert } from "@fluidframework/core-utils";
+import { OdspDeltaStorageService, OdspDeltaStorageWithCache } from "./odspDeltaStorageService.mjs";
+import { OdspDocumentStorageService } from "./odspDocumentStorageManager.mjs";
+import { getOdspResolvedUrl } from "./odspUtils.mjs";
+import { isOdcOrigin } from "./odspUrlHelper.mjs";
+import { OpsCache } from "./opsCaching.mjs";
+import { RetryErrorsStorageAdapter } from "./retryErrorsStorageAdapter.mjs";
+/**
+ * The DocumentService manages the Socket.IO connection and manages routing requests to connected
+ * clients
+ */
+export class OdspDocumentService {
+    /**
+     * @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
+     * the "Vroom" token in SPO.
+     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred
+     * 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 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, 
+    // eslint-disable-next-line @rushstack/no-new-null
+    getWebsocketToken, logger, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer) {
+        return new OdspDocumentService(getOdspResolvedUrl(resolvedUrl), getStorageToken, getWebsocketToken, logger, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer);
+    }
+    /**
+     * @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
+     * the "Vroom" token in SPO.
+     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred
+     * 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 - host constructed policy which customizes service behavior.
+     * @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, cache, hostPolicy, epochTracker, socketReferenceKeyPrefix, clientIsSummarizer) {
+        this.odspResolvedUrl = odspResolvedUrl;
+        this.getStorageToken = getStorageToken;
+        this.getWebsocketToken = getWebsocketToken;
+        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,
+            summarizeProtocolTree: true,
+        };
+        this.mc = createChildMonitoringContext({
+            logger,
+            properties: {
+                all: {
+                    odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),
+                },
+            },
+        });
+        this.hostPolicy = hostPolicy;
+        if (this.clientIsSummarizer) {
+            this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };
+        }
+    }
+    get resolvedUrl() {
+        return this.odspResolvedUrl;
+    }
+    get policies() {
+        return this._policies;
+    }
+    /**
+     * Connects to a storage endpoint for snapshot service.
+     *
+     * @returns returns the document storage service for sharepoint driver.
+     */
+    async connectToStorage() {
+        if (!this.storageManager) {
+            this.storageManager = new OdspDocumentStorageService(this.odspResolvedUrl, this.getStorageToken, this.mc.logger, true, this.cache, this.hostPolicy, this.epochTracker, 
+            // flushCallback
+            async () => {
+                const currentConnection = this.odspDelayLoadedDeltaStream?.currentDeltaConnection;
+                if (currentConnection !== undefined && !currentConnection.disposed) {
+                    return currentConnection.flush();
+                }
+                throw new Error("Disconnected while uploading summary (attempt to perform flush())");
+            }, () => {
+                return this.odspDelayLoadedDeltaStream?.relayServiceTenantAndSessionId;
+            }, this.mc.config.getNumber("Fluid.Driver.Odsp.snapshotFormatFetchType"));
+        }
+        return new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);
+    }
+    /**
+     * Connects to a delta storage endpoint for getting ops between a range.
+     *
+     * @returns returns the document delta storage service for sharepoint driver.
+     */
+    async connectToDeltaStorage() {
+        const snapshotOps = this.storageManager?.ops ?? [];
+        const service = new OdspDeltaStorageService(this.odspResolvedUrl.endpoints.deltaStorageUrl, this.getStorageToken, this.epochTracker, this.mc.logger);
+        // batch size, please see issue #5211 for data around batch sizing
+        const batchSize = this.hostPolicy.opsBatchSize ?? 5000;
+        const concurrency = this.hostPolicy.concurrentOpsBatches ?? 1;
+        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) => {
+            const res = await this.opsCache?.get(from, to);
+            return res ?? [];
+        }, 
+        // Ops requestFromSocket Callback.
+        (from, to) => {
+            const currentConnection = this.odspDelayLoadedDeltaStream?.currentDeltaConnection;
+            if (currentConnection !== undefined && !currentConnection.disposed) {
+                currentConnection.requestOps(from, to);
+            }
+        }, (ops) => this.opsReceived(ops), () => this.storageManager);
+    }
+    /**
+     * Connects to a delta stream endpoint for emitting ops.
+     *
+     * @returns returns the document delta stream service for onedrive/sharepoint driver.
+     */
+    async connectToDeltaStream(client) {
+        if (this.socketModuleP === undefined) {
+            this.socketModuleP = this.getDelayLoadedDeltaStream();
+        }
+        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 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 The delta stream object.
+     */
+    async getDelayLoadedDeltaStream() {
+        assert(this.odspSocketModuleLoaded === false, 0x507 /* Should be loaded only once */);
+        const module = await import("./odspDelayLoadedDeltaStream.mjs").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) {
+        // Error might indicate mismatch between client & server knowledge about file
+        // (DriverErrorType.fileOverwrittenInStorage).
+        // For example, file might have been overwritten in storage without generating new epoch
+        // In such case client cached info is stale and has to be removed.
+        if (error !== undefined) {
+            this.epochTracker.removeEntries().catch(() => { });
+        }
+        else {
+            this._opsCache?.flushOps();
+        }
+        this._opsCache?.dispose();
+        // Only need to dipose this, if it is already loaded.
+        this.odspDelayLoadedDeltaStream?.dispose();
+    }
+    get opsCache() {
+        if (this._opsCache) {
+            return this._opsCache;
+        }
+        const seqNumber = this.storageManager?.snapshotSequenceNumber;
+        const batchSize = this.hostPolicy.opsCaching?.batchSize ?? 100;
+        if (seqNumber === undefined || batchSize < 1) {
+            return;
+        }
+        const opsKey = {
+            type: "ops",
+        };
+        this._opsCache = new OpsCache(seqNumber, this.mc.logger, 
+        // ICache
+        {
+            write: async (key, opsData) => {
+                return this.cache.persistedCache.put({ ...opsKey, key }, opsData);
+            },
+            read: async (key) => this.cache.persistedCache.get({ ...opsKey, key }),
+            remove: () => {
+                this.cache.persistedCache.removeEntries().catch(() => { });
+            },
+        }, batchSize, this.hostPolicy.opsCaching?.timerGranularity ?? 5000, this.hostPolicy.opsCaching?.totalOpsToCache ?? 5000);
+        return this._opsCache;
+    }
+    // Called whenever re receive ops through any channel for this document (snapshot, delta connection, delta storage)
+    // We use it to notify caching layer of how stale is snapshot stored in cache.
+    opsReceived(ops) {
+        // No need for two clients to save same ops
+        if (ops.length === 0 || this.odspResolvedUrl.summarizer) {
+            return;
+        }
+        this.opsCache?.addOps(ops);
+    }
+}
+//# sourceMappingURL=odspDocumentService.mjs.map

package/lib/odspDocumentService.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspDocumentService.mjs","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAEN,4BAA4B,GAE5B,MAAM,iCAAiC;OACjC,EAAE,MAAM,EAAE,MAAM,4BAA4B;OAmB5C,EAAE,uBAAuB,EAAE,yBAAyB,EAAE;OACtD,EAAE,0BAA0B,EAAE;OAC9B,EAAE,kBAAkB,EAAE;OACtB,EAAE,WAAW,EAAE;OAEf,EAAE,QAAQ,EAAE;OACZ,EAAE,yBAAyB,EAAE;AAGpC;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAU/B;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACzB,WAAyB,EACzB,eAAgD;IAChD,kDAAkD;IAClD,iBAAuF,EACvF,MAA2B,EAC3B,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAE5B,OAAO,IAAI,mBAAmB,CAC7B,kBAAkB,CAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,EACxB,kBAAkB,CAClB,CAAC;IACH,CAAC;IAUD;;;;;;;;;;;;;OAaG;IACH,YACiB,eAAiC,EAChC,eAAgD,EAChD,iBAEL,EACZ,MAA2B,EACV,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC,EACjC,kBAA4B;QAV7B,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAEtB;QAEK,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QACjC,uBAAkB,GAAlB,kBAAkB,CAAU;QAzEtC,2BAAsB,GAAY,KAAK,CAAC;QA2E/C,IAAI,CAAC,SAAS,GAAG;YAChB,2DAA2D;YAC3D,WAAW,EAAE,eAAe,CAAC,WAAW,KAAK,SAAS;YACtD,qBAAqB,EAAE,IAAI;SAC3B,CAAC;QAEF,IAAI,CAAC,EAAE,GAAG,4BAA4B,CAAC;YACtC,MAAM;YACN,UAAU,EAAE;gBACX,GAAG,EAAE;oBACJ,GAAG,EAAE,WAAW,CACf,IAAI,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,MAAM,CACjE;iBACD;aACD;SACD,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC5B,IAAI,CAAC,UAAU,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;SACjE;IACF,CAAC;IAED,IAAW,WAAW;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;IACD,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC5B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACzB,IAAI,CAAC,cAAc,GAAG,IAAI,0BAA0B,CACnD,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;gBACV,MAAM,iBAAiB,GACtB,IAAI,CAAC,0BAA0B,EAAE,sBAAsB,CAAC;gBACzD,IAAI,iBAAiB,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;oBACnE,OAAO,iBAAiB,CAAC,KAAK,EAAE,CAAC;iBACjC;gBACD,MAAM,IAAI,KAAK,CACd,mEAAmE,CACnE,CAAC;YACH,CAAC,EACD,GAAG,EAAE;gBACJ,OAAO,IAAI,CAAC,0BAA0B,EAAE,8BAA8B,CAAC;YACxE,CAAC,EACD,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,2CAA2C,CAAC,CACrE,CAAC;SACF;QAED,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,IAAI,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,uBAAuB,CAC1C,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,EAC9C,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,EAAE,CAAC,MAAM,CACd,CAAC;QAEF,kEAAkE;QAClE,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,IAAI,IAAI,CAAC;QACvD,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,CAAC;QAC9D,OAAO,IAAI,yBAAyB,CACnC,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,CAC/C,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,CAAC;QACnD,0BAA0B;QAC1B,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;YAClB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC/C,OAAQ,GAAmC,IAAI,EAAE,CAAC;QACnD,CAAC;QACD,kCAAkC;QAClC,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;YACZ,MAAM,iBAAiB,GAAG,IAAI,CAAC,0BAA0B,EAAE,sBAAsB,CAAC;YAClF,IAAI,iBAAiB,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBACnE,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aACvC;QACF,CAAC,EACD,CAAC,GAAgC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAC3D,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CACzB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAChD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YACrC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,aAAa;aACvB,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;YACjB,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACnC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChB,2FAA2F;YAC3F,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;YACpC,MAAM,KAAK,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,yBAAyB;QACtC,MAAM,CAAC,IAAI,CAAC,sBAAsB,KAAK,KAAK,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,MAAM,MAAM,qCAGzB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC,CAAC;YACvE,OAAO,CAAC,CAAC;QACV,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,wBAAwB,EAAE,EAAE,KAAK,CAAC,CAAC;YAC9E,MAAM,KAAK,CAAC;QACb,CAAC,CAAC,CAAC;QACJ,IAAI,CAAC,0BAA0B,GAAG,IAAI,MAAM,CAAC,0BAA0B,CACtE,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,CAC7B,CAAC;QACF,OAAO,IAAI,CAAC,0BAA0B,CAAC;IACxC,CAAC;IAEM,OAAO,CAAC,KAAW;QACzB,6EAA6E;QAC7E,8CAA8C;QAC9C,wFAAwF;QACxF,kEAAkE;QAClE,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SAClD;aAAM;YACN,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;SAC3B;QACD,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC;QAC1B,qDAAqD;QACrD,IAAI,CAAC,0BAA0B,EAAE,OAAO,EAAE,CAAC;IAC5C,CAAC;IAED,IAAc,QAAQ;QACrB,IAAI,IAAI,CAAC,SAAS,EAAE;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;SACtB;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,EAAE,sBAAsB,CAAC;QAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,SAAS,IAAI,GAAG,CAAC;QAC/D,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC7C,OAAO;SACP;QAED,MAAM,MAAM,GAAwB;YACnC,IAAI,EAAE,KAAK;SACX,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CAC5B,SAAS,EACT,IAAI,CAAC,EAAE,CAAC,MAAM;QACd,SAAS;QACT;YACC,KAAK,EAAE,KAAK,EAAE,GAAW,EAAE,OAAe,EAAE,EAAE;gBAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,CAAC;YAC9E,MAAM,EAAE,GAAG,EAAE;gBACZ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAC3D,CAAC;SACD,EACD,SAAS,EACT,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,gBAAgB,IAAI,IAAI,EACpD,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,eAAe,IAAI,IAAI,CACnD,CAAC;QACF,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED,mHAAmH;IACnH,8EAA8E;IACpE,WAAW,CAAC,GAAgC;QACrD,2CAA2C;QAC3C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACxD,OAAO;SACP;QAED,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tITelemetryLoggerExt,\n\tcreateChildMonitoringContext,\n\tMonitoringContext,\n} from \"@fluidframework/telemetry-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport {\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaStorageService,\n\tIDocumentService,\n\tIResolvedUrl,\n\tIDocumentStorageService,\n\tIDocumentServicePolicies,\n} from \"@fluidframework/driver-definitions\";\nimport { IClient, ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n\tIOdspResolvedUrl,\n\tTokenFetchOptions,\n\tIEntry,\n\tHostStoragePolicy,\n\tInstrumentedStorageTokenFetcher,\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\tprivate readonly _policies: IDocumentServicePolicies;\n\n\t// Promise to load socket module only once.\n\tprivate socketModuleP: Promise<OdspDelayLoadedDeltaStream> | undefined;\n\n\tprivate odspDelayLoadedDeltaStream: OdspDelayLoadedDeltaStream | undefined;\n\n\tprivate odspSocketModuleLoaded: boolean = false;\n\n\t/**\n\t * @param resolvedUrl - resolved url identifying document that will be managed by returned service instance.\n\t * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n\t * the \"Vroom\" token in SPO.\n\t * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n\t * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n\t * response payload.\n\t * @param logger - a logger that can capture performance and diagnostic information\n\t * @param cache - This caches response for joinSession.\n\t * @param hostPolicy - This host constructed policy which customizes service behavior.\n\t * @param epochTracker - This helper class which adds epoch to backend calls made by returned service instance.\n\t * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n\t */\n\tpublic static async create(\n\t\tresolvedUrl: IResolvedUrl,\n\t\tgetStorageToken: InstrumentedStorageTokenFetcher,\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tgetWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n\t\tlogger: ITelemetryLoggerExt,\n\t\tcache: IOdspCache,\n\t\thostPolicy: HostStoragePolicy,\n\t\tepochTracker: EpochTracker,\n\t\tsocketReferenceKeyPrefix?: string,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> {\n\t\treturn new OdspDocumentService(\n\t\t\tgetOdspResolvedUrl(resolvedUrl),\n\t\t\tgetStorageToken,\n\t\t\tgetWebsocketToken,\n\t\t\tlogger,\n\t\t\tcache,\n\t\t\thostPolicy,\n\t\t\tepochTracker,\n\t\t\tsocketReferenceKeyPrefix,\n\t\t\tclientIsSummarizer,\n\t\t);\n\t}\n\n\tprivate storageManager?: OdspDocumentStorageService;\n\n\tprivate readonly mc: MonitoringContext;\n\n\tprivate readonly hostPolicy: HostStoragePolicyInternal;\n\n\tprivate _opsCache?: OpsCache;\n\n\t/**\n\t * @param odspResolvedUrl - resolved url identifying document that will be managed by this service instance.\n\t * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n\t * the \"Vroom\" token in SPO.\n\t * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n\t * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n\t * response payload.\n\t * @param logger - a logger that can capture performance and diagnostic information\n\t * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n\t * @param cache - This caches response for joinSession.\n\t * @param hostPolicy - host constructed policy which customizes service behavior.\n\t * @param epochTracker - This helper class which adds epoch to backend calls made by this service instance.\n\t * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n\t */\n\tprivate constructor(\n\t\tpublic readonly odspResolvedUrl: IOdspResolvedUrl,\n\t\tprivate readonly getStorageToken: InstrumentedStorageTokenFetcher,\n\t\tprivate readonly getWebsocketToken:\n\t\t\t| ((options: TokenFetchOptions) => Promise<string | null>)\n\t\t\t| undefined,\n\t\tlogger: ITelemetryLoggerExt,\n\t\tprivate readonly cache: IOdspCache,\n\t\thostPolicy: HostStoragePolicy,\n\t\tprivate readonly epochTracker: EpochTracker,\n\t\tprivate readonly socketReferenceKeyPrefix?: string,\n\t\tprivate readonly clientIsSummarizer?: boolean,\n\t) {\n\t\tthis._policies = {\n\t\t\t// load in storage-only mode if a file version is specified\n\t\t\tstorageOnly: odspResolvedUrl.fileVersion !== undefined,\n\t\t\tsummarizeProtocolTree: true,\n\t\t};\n\n\t\tthis.mc = createChildMonitoringContext({\n\t\t\tlogger,\n\t\t\tproperties: {\n\t\t\t\tall: {\n\t\t\t\t\todc: isOdcOrigin(\n\t\t\t\t\t\tnew URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin,\n\t\t\t\t\t),\n\t\t\t\t},\n\t\t\t},\n\t\t});\n\n\t\tthis.hostPolicy = hostPolicy;\n\t\tif (this.clientIsSummarizer) {\n\t\t\tthis.hostPolicy = { ...this.hostPolicy, summarizerClient: true };\n\t\t}\n\t}\n\n\tpublic get resolvedUrl(): IResolvedUrl {\n\t\treturn this.odspResolvedUrl;\n\t}\n\tpublic get policies() {\n\t\treturn this._policies;\n\t}\n\n\t/**\n\t * Connects to a storage endpoint for snapshot service.\n\t *\n\t * @returns returns the document storage service for sharepoint driver.\n\t */\n\tpublic async connectToStorage(): Promise<IDocumentStorageService> {\n\t\tif (!this.storageManager) {\n\t\t\tthis.storageManager = new OdspDocumentStorageService(\n\t\t\t\tthis.odspResolvedUrl,\n\t\t\t\tthis.getStorageToken,\n\t\t\t\tthis.mc.logger,\n\t\t\t\ttrue,\n\t\t\t\tthis.cache,\n\t\t\t\tthis.hostPolicy,\n\t\t\t\tthis.epochTracker,\n\t\t\t\t// flushCallback\n\t\t\t\tasync () => {\n\t\t\t\t\tconst currentConnection =\n\t\t\t\t\t\tthis.odspDelayLoadedDeltaStream?.currentDeltaConnection;\n\t\t\t\t\tif (currentConnection !== undefined && !currentConnection.disposed) {\n\t\t\t\t\t\treturn currentConnection.flush();\n\t\t\t\t\t}\n\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t\"Disconnected while uploading summary (attempt to perform flush())\",\n\t\t\t\t\t);\n\t\t\t\t},\n\t\t\t\t() => {\n\t\t\t\t\treturn this.odspDelayLoadedDeltaStream?.relayServiceTenantAndSessionId;\n\t\t\t\t},\n\t\t\t\tthis.mc.config.getNumber(\"Fluid.Driver.Odsp.snapshotFormatFetchType\"),\n\t\t\t);\n\t\t}\n\n\t\treturn new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);\n\t}\n\n\t/**\n\t * Connects to a delta storage endpoint for getting ops between a range.\n\t *\n\t * @returns returns the document delta storage service for sharepoint driver.\n\t */\n\tpublic async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {\n\t\tconst snapshotOps = this.storageManager?.ops ?? [];\n\t\tconst service = new OdspDeltaStorageService(\n\t\t\tthis.odspResolvedUrl.endpoints.deltaStorageUrl,\n\t\t\tthis.getStorageToken,\n\t\t\tthis.epochTracker,\n\t\t\tthis.mc.logger,\n\t\t);\n\n\t\t// batch size, please see issue #5211 for data around batch sizing\n\t\tconst batchSize = this.hostPolicy.opsBatchSize ?? 5000;\n\t\tconst concurrency = this.hostPolicy.concurrentOpsBatches ?? 1;\n\t\treturn new OdspDeltaStorageWithCache(\n\t\t\tsnapshotOps,\n\t\t\tthis.mc.logger,\n\t\t\tbatchSize,\n\t\t\tconcurrency,\n\t\t\t// Get Ops from storage callback.\n\t\t\tasync (from, to, telemetryProps, fetchReason) =>\n\t\t\t\tservice.get(from, to, telemetryProps, fetchReason),\n\t\t\t// Get cachedOps Callback.\n\t\t\tasync (from, to) => {\n\t\t\t\tconst res = await this.opsCache?.get(from, to);\n\t\t\t\treturn (res as ISequencedDocumentMessage[]) ?? [];\n\t\t\t},\n\t\t\t// Ops requestFromSocket Callback.\n\t\t\t(from, to) => {\n\t\t\t\tconst currentConnection = this.odspDelayLoadedDeltaStream?.currentDeltaConnection;\n\t\t\t\tif (currentConnection !== undefined && !currentConnection.disposed) {\n\t\t\t\t\tcurrentConnection.requestOps(from, to);\n\t\t\t\t}\n\t\t\t},\n\t\t\t(ops: ISequencedDocumentMessage[]) => this.opsReceived(ops),\n\t\t\t() => this.storageManager,\n\t\t);\n\t}\n\n\t/**\n\t * Connects to a delta stream endpoint for emitting ops.\n\t *\n\t * @returns returns the document delta stream service for onedrive/sharepoint driver.\n\t */\n\tpublic async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {\n\t\tif (this.socketModuleP === undefined) {\n\t\t\tthis.socketModuleP = this.getDelayLoadedDeltaStream();\n\t\t}\n\t\treturn this.socketModuleP\n\t\t\t.then(async (m) => {\n\t\t\t\tthis.odspSocketModuleLoaded = true;\n\t\t\t\treturn m.connectToDeltaStream(client);\n\t\t\t})\n\t\t\t.catch((error) => {\n\t\t\t\t// Setting undefined in case someone tries to recover from module failure by calling again.\n\t\t\t\tthis.socketModuleP = undefined;\n\t\t\t\tthis.odspSocketModuleLoaded = false;\n\t\t\t\tthrow error;\n\t\t\t});\n\t}\n\n\t/**\n\t * This dynamically imports the module for loading the delta connection. In many cases the delta stream, is not\n\t * required during the critical load flow. So this way we don't have to bundle this in the initial bundle and can\n\t * import this later on when required.\n\t * @returns The delta stream object.\n\t */\n\tprivate async getDelayLoadedDeltaStream() {\n\t\tassert(this.odspSocketModuleLoaded === false, 0x507 /* Should be loaded only once */);\n\t\tconst module = await import(\n\t\t\t/* webpackChunkName: \"socketModule\" */ \"./odspDelayLoadedDeltaStream.js\"\n\t\t)\n\t\t\t.then((m) => {\n\t\t\t\tthis.mc.logger.sendTelemetryEvent({ eventName: \"SocketModuleLoaded\" });\n\t\t\t\treturn m;\n\t\t\t})\n\t\t\t.catch((error) => {\n\t\t\t\tthis.mc.logger.sendErrorEvent({ eventName: \"SocketModuleLoadFailed\" }, error);\n\t\t\t\tthrow error;\n\t\t\t});\n\t\tthis.odspDelayLoadedDeltaStream = new module.OdspDelayLoadedDeltaStream(\n\t\t\tthis.odspResolvedUrl,\n\t\t\tthis._policies,\n\t\t\tthis.getStorageToken,\n\t\t\tthis.getWebsocketToken,\n\t\t\tthis.mc,\n\t\t\tthis.cache,\n\t\t\tthis.hostPolicy,\n\t\t\tthis.epochTracker,\n\t\t\t(ops: ISequencedDocumentMessage[]) => this.opsReceived(ops),\n\t\t\tthis.socketReferenceKeyPrefix,\n\t\t);\n\t\treturn this.odspDelayLoadedDeltaStream;\n\t}\n\n\tpublic dispose(error?: any) {\n\t\t// Error might indicate mismatch between client & server knowledge about file\n\t\t// (DriverErrorType.fileOverwrittenInStorage).\n\t\t// For example, file might have been overwritten in storage without generating new epoch\n\t\t// In such case client cached info is stale and has to be removed.\n\t\tif (error !== undefined) {\n\t\t\tthis.epochTracker.removeEntries().catch(() => {});\n\t\t} else {\n\t\t\tthis._opsCache?.flushOps();\n\t\t}\n\t\tthis._opsCache?.dispose();\n\t\t// Only need to dipose this, if it is already loaded.\n\t\tthis.odspDelayLoadedDeltaStream?.dispose();\n\t}\n\n\tprotected get opsCache() {\n\t\tif (this._opsCache) {\n\t\t\treturn this._opsCache;\n\t\t}\n\n\t\tconst seqNumber = this.storageManager?.snapshotSequenceNumber;\n\t\tconst batchSize = this.hostPolicy.opsCaching?.batchSize ?? 100;\n\t\tif (seqNumber === undefined || batchSize < 1) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst opsKey: Omit<IEntry, \"key\"> = {\n\t\t\ttype: \"ops\",\n\t\t};\n\t\tthis._opsCache = new OpsCache(\n\t\t\tseqNumber,\n\t\t\tthis.mc.logger,\n\t\t\t// ICache\n\t\t\t{\n\t\t\t\twrite: async (key: string, opsData: string) => {\n\t\t\t\t\treturn this.cache.persistedCache.put({ ...opsKey, key }, opsData);\n\t\t\t\t},\n\t\t\t\tread: async (key: string) => this.cache.persistedCache.get({ ...opsKey, key }),\n\t\t\t\tremove: () => {\n\t\t\t\t\tthis.cache.persistedCache.removeEntries().catch(() => {});\n\t\t\t\t},\n\t\t\t},\n\t\t\tbatchSize,\n\t\t\tthis.hostPolicy.opsCaching?.timerGranularity ?? 5000,\n\t\t\tthis.hostPolicy.opsCaching?.totalOpsToCache ?? 5000,\n\t\t);\n\t\treturn this._opsCache;\n\t}\n\n\t// Called whenever re receive ops through any channel for this document (snapshot, delta connection, delta storage)\n\t// We use it to notify caching layer of how stale is snapshot stored in cache.\n\tprotected opsReceived(ops: ISequencedDocumentMessage[]) {\n\t\t// No need for two clients to save same ops\n\t\tif (ops.length === 0 || this.odspResolvedUrl.summarizer) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.opsCache?.addOps(ops);\n\t}\n}\n"]}

package/lib/{odspDocumentServiceFactory.d.ts → odspDocumentServiceFactory.d.mts}

@@ -4,13 +4,17 @@
  */
 import { IDocumentServiceFactory } from "@fluidframework/driver-definitions";
 import { OdspResourceTokenFetchOptions, TokenFetcher, IPersistedCache, HostStoragePolicy } from "@fluidframework/odsp-driver-definitions";
-import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore";
+import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore.mjs";
 /**
  * Factory for creating the sharepoint document service. Use this if you want to
  * use the sharepoint implementation.
+ * @alpha
  */
 export declare class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
     constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
 }
+/**
+ * @alpha
+ */
 export declare function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory;
 //# sourceMappingURL=odspDocumentServiceFactory.d.ts.map

package/lib/odspDocumentServiceFactory.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspDocumentServiceFactory.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,uBAAuB,EAAE,MAAM,oCAAoC;OACrE,EACN,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,MAAM,yCAAyC;OACzC,EAAE,8BAA8B,EAAE;AAIzC;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,8BAA8B;gBAE5E,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;CAI/B;AAED;;GAEG;AACH,wBAAgB,qCAAqC,CACpD,aAAa,EAAE,UAAU,GAAG,MAAM,GAChC,uBAAuB,CAEzB"}

package/lib/{odspDocumentServiceFactory.js → odspDocumentServiceFactory.mjs}

@@ -2,20 +2,22 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * 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";
+import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore.mjs";
+import { LocalOdspDocumentServiceFactory } from "./localOdspDriver/localOdspDocumentServiceFactory.mjs";
 /**
  * Factory for creating the sharepoint document service. Use this if you want to
  * use the sharepoint implementation.
+ * @alpha
  */
 export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
     constructor(getStorageToken, getWebsocketToken, persistedCache, hostPolicy) {
-        super(getStorageToken, getWebsocketToken, async () => getSocketIo(), persistedCache, hostPolicy);
+        super(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);
     }
 }
+/**
+ * @alpha
+ */
 export function createLocalOdspDocumentServiceFactory(localSnapshot) {
     return new LocalOdspDocumentServiceFactory(localSnapshot);
 }
-//# sourceMappingURL=odspDocumentServiceFactory.js.map
+//# sourceMappingURL=odspDocumentServiceFactory.mjs.map

package/lib/odspDocumentServiceFactory.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspDocumentServiceFactory.mjs","sourceRoot":"","sources":["../src/odspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OASI,EAAE,8BAA8B,EAAE;OAElC,EAAE,+BAA+B,EAAE;AAE1C;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,8BAA8B;IAC7E,YACC,eAA4D,EAC5D,iBAA0E,EAC1E,cAAgC,EAChC,UAA8B;QAE9B,KAAK,CAAC,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC;CACD;AAED;;GAEG;AACH,MAAM,UAAU,qCAAqC,CACpD,aAAkC;IAElC,OAAO,IAAI,+BAA+B,CAAC,aAAa,CAAC,CAAC;AAC3D,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\tOdspResourceTokenFetchOptions,\n\tTokenFetcher,\n\tIPersistedCache,\n\tHostStoragePolicy,\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 * @alpha\n */\nexport class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {\n\tconstructor(\n\t\tgetStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n\t\tgetWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,\n\t\tpersistedCache?: IPersistedCache,\n\t\thostPolicy?: HostStoragePolicy,\n\t) {\n\t\tsuper(getStorageToken, getWebsocketToken, persistedCache, hostPolicy);\n\t}\n}\n\n/**\n * @alpha\n */\nexport function createLocalOdspDocumentServiceFactory(\n\tlocalSnapshot: Uint8Array | string,\n): IDocumentServiceFactory {\n\treturn new LocalOdspDocumentServiceFactory(localSnapshot);\n}\n"]}

package/lib/{odspDocumentServiceFactoryCore.d.ts → odspDocumentServiceFactoryCore.d.mts}

@@ -2,29 +2,35 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { ITelemetryBaseLogger, ITelemetryLogger } from "@fluidframework/core-interfaces";
 import { IDocumentService, IDocumentServiceFactory, IResolvedUrl } from "@fluidframework/driver-definitions";
 import { ISummaryTree } from "@fluidframework/protocol-definitions";
-import { TelemetryLogger } from "@fluidframework/telemetry-utils";
-import { OdspResourceTokenFetchOptions, TokenFetcher, IPersistedCache, HostStoragePolicy } from "@fluidframework/odsp-driver-definitions";
-import type { io as SocketIOClientStatic } from "socket.io-client";
-import { ICacheAndTracker } from "./epochTracker";
+import { OdspResourceTokenFetchOptions, TokenFetcher, IPersistedCache, HostStoragePolicy, ISocketStorageDiscovery, IRelaySessionAwareDriverFactory } from "@fluidframework/odsp-driver-definitions";
+import { ICacheAndTracker } from "./epochTracker.mjs";
 /**
  * Factory for creating the sharepoint document service. Use this if you want to
  * use the sharepoint implementation.
  *
  * This constructor should be used by environments that support dynamic imports and that wish
  * to leverage code splitting as a means to keep bundles as small as possible.
+ * @alpha
  */
-export declare class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
+export declare class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory, IRelaySessionAwareDriverFactory {
     private readonly getStorageToken;
     private readonly getWebsocketToken;
-    private readonly getSocketIOClient;
     protected persistedCache: IPersistedCache;
     private readonly hostPolicy;
-    readonly protocolName = "fluid-odsp:";
     private readonly nonPersistentCache;
     private readonly socketReferenceKeyPrefix?;
+    get snapshotPrefetchResultCache(): import("@fluidframework/core-utils").PromiseCache<string, import("./odspCache").IPrefetchSnapshotContents>;
+    get IRelaySessionAwareDriverFactory(): this;
+    /**
+     * This function would return info about relay service session only if this factory established (or attempted to
+     * establish) connection very recently. Otherwise, it will return undefined.
+     * @param resolvedUrl - resolved url for container
+     * @returns The current join session response stored in cache. `undefined` if not present.
+     */
+    getRelayServiceSessionInfo(resolvedUrl: IResolvedUrl): Promise<ISocketStorageDiscovery | undefined>;
     createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     /**
      * @param getStorageToken - function that can provide the storage token for a given site. This is
@@ -32,12 +38,11 @@ export declare class OdspDocumentServiceFactoryCore implements IDocumentServiceF
      * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also
      * to as the "Push" token in SPO. If undefined then websocket token is expected to be returned with joinSession
      * response payload.
-     * @param storageFetchWrapper - if not provided FetchWrapper will be used
-     * @param deltasFetchWrapper - if not provided FetchWrapper will be used
      * @param persistedCache - PersistedCache provided by host for use in this session.
+     * @param hostPolicy - Policy for storage provided by host.
      */
-    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, getSocketIOClient: () => Promise<typeof SocketIOClientStatic>, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
+    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    protected createDocumentServiceCore(resolvedUrl: IResolvedUrl, odspLogger: TelemetryLogger, cacheAndTrackerArg?: ICacheAndTracker, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    protected createDocumentServiceCore(resolvedUrl: IResolvedUrl, odspLogger: ITelemetryLogger, cacheAndTrackerArg?: ICacheAndTracker, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 //# sourceMappingURL=odspDocumentServiceFactoryCore.d.ts.map

package/lib/odspDocumentServiceFactoryCore.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspDocumentServiceFactoryCore.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryCore.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC;OACjF,EACN,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACZ,MAAM,oCAAoC;OACpC,EAAE,YAAY,EAAE,MAAM,sCAAsC;OAM5D,EAEN,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EAOjB,uBAAuB,EACvB,+BAA+B,EAC/B,MAAM,yCAAyC;OAGzC,EAA6B,gBAAgB,EAAE;AAYtD;;;;;;;GAOG;AACH,qBAAa,8BACZ,YAAW,uBAAuB,EAAE,+BAA+B;IAqLlE,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,SAAS,CAAC,cAAc,EAAE,eAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,UAAU;IAtL5B,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAiD;IACpF,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAS;IAEnD,IAAW,2BAA2B,+GAErC;IAED,IAAW,+BAA+B,SAEzC;IAED;;;;;OAKG;IACU,0BAA0B,CACtC,WAAW,EAAE,YAAY,GACvB,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;IAQlC,eAAe,CAC3B,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAyI5B;;;;;;;;OAQG;gBAEe,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,EAC5D,iBAAiB,EAAE,YAAY,CAAC,6BAA6B,CAAC,GAAG,SAAS,EACjF,cAAc,GAAE,eAA4C,EACrD,UAAU,GAAE,iBAAsB;IAcvC,qBAAqB,CACjC,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;cASZ,yBAAyB,CACxC,WAAW,EAAE,YAAY,EACzB,UAAU,EAAE,gBAAgB,EAC5B,kBAAkB,CAAC,EAAE,gBAAgB,EACrC,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;CA+C5B"}