@fluidframework/odsp-driver 0.52.1 → 0.54.0

package/lib/odspDeltaStorageService.js.map

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

package/lib/odspDocumentDeltaConnection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentDeltaConnection.d.ts","sourceRoot":"","sources":["../src/odspDocumentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,OAAO,EACP,QAAQ,EAIX,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAO9C,MAAM,WAAW,WAAW;IACxB,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD,MAAM,WAAW,aAAc,SAAQ,MAAM;IACzC,CAAC,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,KAAK,IAAI,OAAE;CACrF;AAwID;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,uBAAuB;IA+JhE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IA9JxC;;;;;;;;;;;;;;;OAeG;WACiB,MAAM,CACtB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,EAAE,EAAE,oBAAoB,EACxB,MAAM,EAAE,OAAO,EACf,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,EACjC,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,YAAY,EAC1B,wBAAwB,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAiEvF,OAAO,CAAC,eAAe,CAA8B;IAErD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAC/C,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuE;IACjG,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,aAAa,CAAoC;IAEzD;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,UAAO,GAAG,WAAW;IAWvF;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;IA8B3C;;;;;;OAMG;IACH,OAAO;IAYP;;;;;OAKG;IACK,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAwD9B,KAAK,IAAI,OAAO,CAAC,WAAW,CAAC;IA4B1C,SAAS,CAAC,uBAAuB,UAAW,YAAY,GAAG,SAAS,UAElE;cAEc,UAAU,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM;IAqFpE,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAsC9E;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,mBAAmB,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG;CAejE"}
+{"version":3,"file":"odspDocumentDeltaConnection.d.ts","sourceRoot":"","sources":["../src/odspDocumentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,OAAO,EACP,QAAQ,EAIX,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAQ9C,MAAM,WAAW,WAAW;IACxB,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD,MAAM,WAAW,aAAc,SAAQ,MAAM;IACzC,CAAC,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,KAAK,IAAI,OAAE;CACrF;AAwID;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,uBAAuB;IAgKhE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IA/JxC;;;;;;;;;;;;;;;OAeG;WACiB,MAAM,CACtB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,EAAE,EAAE,oBAAoB,EACxB,MAAM,EAAE,OAAO,EACf,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,EACjC,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,YAAY,EAC1B,wBAAwB,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAkEvF,OAAO,CAAC,eAAe,CAA8B;IAErD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAC/C,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuE;IACjG,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,aAAa,CAAoC;IAEzD;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,UAAO,GAAG,WAAW;IAWvF;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;IA8B3C;;;;;;OAMG;IACH,OAAO;IAYP;;;;;OAKG;IACK,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAwD9B,KAAK,IAAI,OAAO,CAAC,WAAW,CAAC;IA4B1C,SAAS,CAAC,uBAAuB,UAAW,YAAY,GAAG,SAAS,UAElE;cAEc,UAAU,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM;IAqFpE,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAsC9E;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,mBAAmB,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG;CAejE"}

package/lib/odspDocumentDeltaConnection.js

@@ -6,6 +6,7 @@ import { assert, performance, Deferred, TypedEventEmitter } from "@fluidframewor
 import { DocumentDeltaConnection } from "@fluidframework/driver-base";
 import { v4 as uuid } from "uuid";
 import { errorObjectFromSocketError } from "./odspError";
+import { pkgVersion } from "./packageVersion";
 const protocolVersions = ["^0.4.0", "^0.3.0", "^0.2.0", "^0.1.0"];
 const feature_get_ops = "api_get_ops";
 const feature_flush_ops = "api_flush_ops";
@@ -182,6 +183,7 @@ export class OdspDocumentDeltaConnection extends DocumentDeltaConnection {
             versions: protocolVersions,
             nonce: uuid(),
             epoch: epochTracker.fluidEpoch,
+            relayUserAgent: [client.details.environment, ` driverVersion:${pkgVersion}`].join(";"),
         };
         // Reference to this client supporting get_ops flow.
         // back-compat: remove cast to any once new definition of IConnect comes through.

package/lib/odspDocumentDeltaConnection.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentDeltaConnection.js","sourceRoot":"","sources":["../src/odspDocumentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAChG,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAWtE,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAGlC,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAClE,MAAM,eAAe,GAAG,aAAa,CAAC;AACtC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAO1C,uFAAuF;AACvF,+DAA+D;AAC/D,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAMvC,MAAM,eAAgB,SAAQ,iBAAgC;IAmE1D,YAAmC,GAAW,EAAE,MAA6B;QACzE,KAAK,EAAE,CAAC;QADuB,QAAG,GAAH,GAAG,CAAQ;QAlEtC,eAAU,GAAW,CAAC,CAAC;QAI/B,iFAAiF;QACjF,0EAA0E;QAC1E,qFAAqF;QACrF,sEAAsE;QAC9D,+BAA0B,GAAG,IAAI,CAAC;QA6DtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,MAAM,CAAC,CAAC,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACtF,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAE/C,iEAAiE;QACjE,wCAAwC;QACxC,MAAM,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,WAA6B,EAAE,EAAE;YAC7D,kFAAkF;YAClF,gDAAgD;YAChD,MAAM,KAAK,GAAG,0BAA0B,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YAC3E,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEtB,uCAAuC;YACvC,mFAAmF;YACnF,qEAAqE;YACrE,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC;YAExC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YACtC,IAAI,CAAC,WAAW,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACP,CAAC;IA5EM,MAAM,CAAC,IAAI,CAAC,GAAW,EAAE,MAAwB;QACpD,MAAM,eAAe,GAAG,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEjE,iDAAiD;QACjD,IAAI,eAAe,IAAI,eAAe,CAAC,YAAY,EAAE;YACjD,2DAA2D;YAC3D,eAAe,CAAC,WAAW,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC;SACpB;QAED,IAAI,eAAe,EAAE;YACjB,6CAA6C;YAC7C,eAAe,CAAC,UAAU,EAAE,CAAC;YAC7B,eAAe,CAAC,UAAU,EAAE,CAAC;SAChC;QAED,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAAC,YAAqB;QAChD,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5E,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,uCAAuC;QACvC,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC;QAExC,IAAI,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE;YACnC,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,OAAO;SACV;QAED,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAChE,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,GAAG,EAAE;gBACtC,4CAA4C;gBAC5C,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACvF,IAAI,CAAC,WAAW,EAAE,CAAC;YACvB,CAAC,EAAE,yBAAyB,CAAC,CAAC;SACjC;IACL,CAAC;IAED,IAAW,MAAM;QACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;SAC1D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IA2BO,UAAU;QACd,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YACvC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACtC,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;SACvC;IACL,CAAC;IAEO,WAAW;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YAAE,OAAO;SAAE;QAE9B,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EACzD,KAAK,CAAC,wEAAwE,CAAC,CAAC;QACpF,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QAEzB,4FAA4F;QAC5F,uEAAuE;QACvE,4FAA4F;QAC5F,sDAAsD;QACtD,mEAAmE;QACnE,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,IAAY,YAAY;QACpB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YAAE,OAAO,IAAI,CAAC;SAAE;QAChD,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAAE,OAAO,KAAK,CAAC;SAAE;QAE5C,0DAA0D;QAC1D,qFAAqF;QACrF,iDAAiD;QACjD,uFAAuF;QACvF,sGAAsG;QACtG,2GAA2G;QAC3G,+GAA+G;QAC/G,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC;IAC5C,CAAC;;AAxHD,+EAA+E;AACvD,+BAAe,GAAiC,IAAI,GAAG,EAAE,CAAC;AA0HtF;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,uBAAuB;IAmJpE;;;;;;OAMG;IACH,YACI,MAA6B,EAC7B,UAAkB,EAClB,eAAgC,EAChC,MAAwB,EACP,kBAA4B;QAE7C,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAFjB,uBAAkB,GAAlB,kBAAkB,CAAU;QAhEzC,oBAAe,GAAG,CAAC,CAAC;QACX,cAAS,GAA6D,IAAI,GAAG,EAAE,CAAC;QAgKvF,4BAAuB,GAAG,CAAC,KAA+B,EAAE,EAAE;YACpE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC,CAAC;QAhGE,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,qBAAqB,GAAG,GAAG,IAAI,EAAE,GAAG,CAAC;IAC9C,CAAC;IAnKD;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAAwB,EACxB,MAAe,EACf,GAAW,EACX,eAAiC,EACjC,SAAiB,EACjB,YAA0B,EAC1B,wBAA4C;QAC5C,qFAAqF;QACrF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,kBAAkB,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEhH,6EAA6E;QAC7E,4EAA4E;QAC5E,MAAM,GAAG,GAAG,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAClF,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,QAAQ,IAAI,UAAU,EAAE,CAAC;QAEzF,MAAM,eAAe,GAAG,2BAA2B,CAAC,4BAA4B,CAC5E,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;QAEvG,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;QAEtC,MAAM,cAAc,GAAa;YAC7B,MAAM;YACN,EAAE,EAAE,UAAU;YACd,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ;YACR,KAAK;YACL,QAAQ,EAAE,gBAAgB;YAC1B,KAAK,EAAE,IAAI,EAAE;YACb,KAAK,EAAE,YAAY,CAAC,UAAU;SACjC,CAAC;QAEF,oDAAoD;QACpD,iFAAiF;QAChF,cAAsB,CAAC,iBAAiB,GAAG,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC;QAExE,MAAM,eAAe,GAAG,IAAI,2BAA2B,CACnD,MAAM,EACN,UAAU,EACV,eAAe,EACf,eAAe,EACf,kBAAkB,CAAC,CAAC;QAExB,IAAI;YACA,MAAM,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAC5D,MAAM,YAAY,CAAC,qBAAqB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;SACrE;QAAC,OAAO,WAAW,EAAE;YAClB,IAAI,WAAW,KAAK,IAAI,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACzD,2EAA2E;gBAC3E,mGAAmG;gBACnG,4FAA4F;gBAC5F,6CAA6C;gBAC7C,yEAAyE;gBACzE,sCAAsC;gBACtC,uFAAuF;gBACvF,6FAA6F;gBAC7F,2BAA2B;gBAC3B,8BAA8B;gBAC9B,mGAAmG;gBACnG,oCAAoC;gBACpC,qFAAqF;gBACrF,IAAI,WAAW,CAAC,UAAU,KAAK,GAAG,IAAI,WAAW,CAAC,UAAU,KAAK,GAAG,EAAE;oBAClE,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;iBAC/B;aACJ;YACD,MAAM,WAAW,CAAC;SACrB;QAED,OAAO,eAAe,CAAC;IAC3B,CAAC;IAUD;;OAEG;IACO,iBAAiB,CAAC,OAAe,EAAE,KAAW,EAAE,QAAQ,GAAG,IAAI;QACrE,wDAAwD;QACxD,wGAAwG;QACxG,4CAA4C;QAC5C,IAAI,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,CAAC,IAAI,QAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAA,KAAK,QAAQ,EAAE;YACjF,OAAO,0BAA0B,CAAC,KAAyB,EAAE,OAAO,CAAgB,CAAC;SACxF;aAAM;YACH,OAAO,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;SAC5D;IACL,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,4BAA4B,CACvC,EAAwB,EACxB,SAAiB,EACjB,GAAW,EACX,GAAW,EACX,kBAA2B,EAC3B,QAAgB,EAChB,UAAkB,EAClB,MAAwB;QAExB,MAAM,uBAAuB,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAClE,IAAI,uBAAuB,EAAE;YACzB,OAAO,uBAAuB,CAAC;SAClC;QAED,MAAM,KAAK,GAAG,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;QAExE,MAAM,MAAM,GAAG,EAAE,CACb,GAAG,EACH;YACI,SAAS,EAAE,KAAK;YAChB,KAAK;YACL,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,CAAC,WAAW,CAAC;YACzB,OAAO,EAAE,SAAS;SACrB,CAAC,CAAC;QAEP,OAAO,IAAI,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAqBD;;;;;OAKG;IACK,UAAU,CAAC,IAAY,EAAE,EAAU;;QACvC,0EAA0E;QAC1E,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAE/C,sCAAsC;QACtC,gFAAgF;QAChF,IAAI,OAAC,IAAI,CAAC,OAAe,CAAC,iBAAiB,0CAAG,eAAe,OAAM,IAAI,EAAE;YACrE,OAAO;SACV;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACrE,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAEhC,qFAAqF;QACrF,qFAAqF;QACrF,uEAAuE;QACvE,yFAAyF;QACzF,sDAAsD;QACtD,uFAAuF;QACvF,gCAAgC;QAChC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,EAAE;YAC1B,IAAI,IAAI,GAAG,KAAK,CAAC;YACjB,IAAI,GAAuB,CAAC;YAC5B,KAAK,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE;gBAC1D,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE;oBAC1C,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC;oBACnB,GAAG,GAAG,YAAY,CAAC;iBACtB;aACJ;YACD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAI,CAAE,CAAC;YAClD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBACvB,SAAS,EAAE,eAAe;gBAC1B,KAAK;gBACL,IAAI,EAAE,eAAe,CAAC,IAAI;gBAC1B,EAAE,EAAE,eAAe,CAAC,EAAE;gBACtB,MAAM,EAAE,eAAe,CAAC,EAAE,GAAG,eAAe,CAAC,IAAI;gBACjD,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,eAAe,CAAC,KAAK;aACtD,CAAC,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAI,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,CACd,KAAK,EACL;YACI,KAAK;YACL,IAAI;YACJ,EAAE;SACL,CACJ,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE;YACvC,KAAK;YACL,IAAI;YACJ,EAAE,EAAE,EAAE,GAAG,CAAC;SACb,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,KAAK;;QACd,gFAAgF;QAChF,IAAI,OAAC,IAAI,CAAC,OAAe,CAAC,iBAAiB,0CAAG,iBAAiB,OAAM,IAAI,EAAE;YACvE,6EAA6E;YAC7E,8EAA8E;YAC9E,gFAAgF;YAChF,iCAAiC;YACjC,uFAAuF;YACvF,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,sBAAsB,EAAE,CAAC,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;SACjG;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACrE,sFAAsF;QACtF,sFAAsF;QACtF,uDAAuD;QACvD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,oEAAoE,CAAC,CAAC;SACnG;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAExD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,EAAe,CAAC;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;IACtC,CAAC;IAMS,KAAK,CAAC,UAAU,CAAC,cAAwB,EAAE,OAAe;QAChE,IAAI,IAAI,CAAC,kBAAkB,EAAE;YACzB,sCAAsC;YACtC,IAAI,CAAC,cAAc,GAAG,CAAC,iBAAyB,EAAE,IAAiC,EAAE,EAAE;gBACnF,IAAI,IAAI,CAAC,UAAU,KAAK,iBAAiB,EAAE;oBACvC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;iBACrC;YACL,CAAC,CAAC;YAEF,IAAI,CAAC,kBAAkB,GAAG,CAAC,GAAmB,EAAE,iBAA0B,EAAE,EAAE;gBAC1E,IAAI,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,KAAK,IAAI,CAAC,UAAU,EAAE;oBAC1E,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBAChC;YACL,CAAC,CAAC;SACL;QAED,IAAI,CAAC,eAAgB,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAE9E,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,kBAAkB,EAAE,CAAC,MAAuB,EAAE,EAAE;YAC3D,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9C,0EAA0E;YAC1E,4FAA4F;YAC5F,mGAAmG;YACnG,4GAA4G;YAC5G,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;gBAC9E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACpC,MAAM,MAAM,GAAG;oBACX,SAAS,EAAE,QAAQ;oBACnB,qFAAqF;oBACrF,KAAK,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;oBACpD,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,IAAI,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI;oBAChB,EAAE,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE;oBACZ,QAAQ,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK;iBAC5E,CAAC;gBACF,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC/C,IAAI,CAAC,MAAM,CAAC,oBAAoB,iCACzB,MAAM,KACT,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EACjC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAClD,MAAM,EAAE,QAAQ,CAAC,MAAM,IACzB,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;iBAC9C;qBAAM;oBACH,IAAI,CAAC,MAAM,CAAC,oBAAoB,iCACzB,MAAM,KACT,MAAM,EAAE,CAAC,IACX,CAAC;iBACN;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,MAAyB,EAAE,EAAE;YAC/D,IAAI,IAAI,CAAC,YAAY,KAAK,MAAM,CAAC,KAAK,EAAE;gBACpC,MAAM,GAAG,GAAG,MAAM,CAAC,2BAA2B,CAAC;gBAC/C,IAAI,QAAQ,GAAwB,SAAS,CAAC;gBAC9C,IAAI,MAAM,CAAC,2BAA2B,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,EAAE;oBACzE,QAAQ,MAAM,CAAC,IAAI,EAAE;wBACjB,KAAK,GAAG,CAAC;wBACT,KAAK,GAAG;4BACJ,QAAQ,GAAG,OAAO,CAAC;4BACnB,MAAM;wBACV,KAAK,GAAG;4BACJ,MAAM;wBACV;4BACI,QAAQ,GAAG,OAAO,CAAC;4BACnB,MAAM;qBACb;iBACJ;gBACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC3B,SAAS,EAAE,aAAa;oBACxB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,cAAc,EAAE,GAAG;oBACnB,QAAQ;iBACX,CAAC,CAAC;gBACH,IAAI,CAAC,aAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACpC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;gBAC/B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;aACjC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,CAAC,UAAU,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAES,kBAAkB,CAAC,KAAa,EAAE,QAAkC;QAC1E,uGAAuG;QACvG,QAAQ,KAAK,EAAE;YACX,KAAK,IAAI;gBACL,2BAA2B;gBAC3B,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC,UAAkB,EAAE,IAAiC,EAAE,EAAE;oBACtF,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE;wBAC5D,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;qBAC9B;gBACL,CAAC,CAAC,CAAC;gBACH,MAAM;YAEV,KAAK,QAAQ;gBACT,+BAA+B;gBAC/B,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC,GAAmB,EAAE,UAAmB,EAAE,EAAE;oBACzE,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,EAAE;wBAC3E,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;qBAC7B;gBACL,CAAC,CAAC,CAAC;gBACH,MAAM;YAEV,KAAK,MAAM;gBACP,sCAAsC;gBACtC,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC,oBAA4B,EAAE,OAAgB,EAAE,EAAE;oBAC/E,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC;wBACjC,oBAAoB,KAAK,IAAI,CAAC,UAAU;wBACxC,CAAC,IAAI,CAAC,UAAU,IAAI,oBAAoB,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE;wBAC7D,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;qBACpD;gBACL,CAAC,CAAC,CAAC;gBACH,MAAM;YAEV;gBACI,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBAC1C,MAAM;SACb;IACL,CAAC;IAED;;OAEG;IACO,UAAU,CAAC,mBAA4B,EAAE,MAAW;QAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC;QACpC,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QAEjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAEnE,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,UAAU,EAAE;YACzC,qEAAqE;YACrE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SAC3E;QAED,MAAM,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger, IEvent } from \"@fluidframework/common-definitions\";\nimport { assert, performance, Deferred, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { DocumentDeltaConnection } from \"@fluidframework/driver-base\";\nimport { DriverError } from \"@fluidframework/driver-definitions\";\nimport { OdspError } from \"@fluidframework/odsp-driver-definitions\";\nimport { LoggingError } from \"@fluidframework/telemetry-utils\";\nimport {\n    IClient,\n    IConnect,\n    INack,\n    ISequencedDocumentMessage,\n    ISignalMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport { IOdspSocketError, IGetOpsResponse, IFlushOpsResponse } from \"./contracts\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { errorObjectFromSocketError } from \"./odspError\";\n\nconst protocolVersions = [\"^0.4.0\", \"^0.3.0\", \"^0.2.0\", \"^0.1.0\"];\nconst feature_get_ops = \"api_get_ops\";\nconst feature_flush_ops = \"api_flush_ops\";\n\nexport interface FlushResult {\n    lastPersistedSequenceNumber?: number;\n    retryAfter?: number;\n}\n\n// How long to wait before disconnecting the socket after the last reference is removed\n// This allows reconnection after receiving a nack to be smooth\nconst socketReferenceBufferTime = 2000;\n\nexport interface ISocketEvents extends IEvent {\n    (event: \"server_disconnect\", listener: (error: LoggingError & OdspError) => void);\n}\n\nclass SocketReference extends TypedEventEmitter<ISocketEvents> {\n    private references: number = 1;\n    private delayDeleteTimeout: ReturnType<typeof setTimeout> | undefined;\n    private _socket: SocketIOClient.Socket | undefined;\n\n    // When making decisions about socket reuse, we do not reuse disconnected socket.\n    // But we want to differentiate the following case from disconnected case:\n    // Socket that never connected and never failed, it's in \"attempting to connect\" mode\n    // such sockets should be reused, despite socket.disconnected === true\n    private isPendingInitialConnection = true;\n\n    // Map of all existing socket io sockets. [url, tenantId, documentId] -> socket\n    private static readonly socketIoSockets: Map<string, SocketReference> = new Map();\n\n    public static find(key: string, logger: ITelemetryLogger) {\n        const socketReference = SocketReference.socketIoSockets.get(key);\n\n        // Verify the socket is healthy before reusing it\n        if (socketReference && socketReference.disconnected) {\n            // The socket is in a bad state. fully remove the reference\n            socketReference.closeSocket();\n            return undefined;\n        }\n\n        if (socketReference) {\n            // Clear the pending deletion if there is one\n            socketReference.clearTimer();\n            socketReference.references++;\n        }\n\n        return socketReference;\n    }\n\n    /**\n     * Removes a reference for the given key\n     * Once the ref count hits 0, the socket is disconnected and removed\n     * @param key - socket reference key\n     * @param isFatalError - true if the socket reference should be removed immediately due to a fatal error\n     */\n    public removeSocketIoReference(isFatalError: boolean) {\n        assert(this.references > 0, 0x09f /* \"No more socketIO refs to remove!\" */);\n        this.references--;\n\n        // see comment in disconnected() getter\n        this.isPendingInitialConnection = false;\n\n        if (isFatalError || this.disconnected) {\n            this.closeSocket();\n            return;\n        }\n\n        if (this.references === 0 && this.delayDeleteTimeout === undefined) {\n            this.delayDeleteTimeout = setTimeout(() => {\n                // We should not get here with active users.\n                assert(this.references === 0, 0x0a0 /* \"Unexpected socketIO references on timeout\" */);\n                this.closeSocket();\n            }, socketReferenceBufferTime);\n        }\n    }\n\n    public get socket() {\n        if (!this._socket) {\n            throw new Error(`Invalid socket for key \"${this.key}`);\n        }\n        return this._socket;\n    }\n\n    public constructor(public readonly key: string, socket: SocketIOClient.Socket) {\n        super();\n\n        this._socket = socket;\n        assert(!SocketReference.socketIoSockets.has(key), 0x220 /* \"socket key collision\" */);\n        SocketReference.socketIoSockets.set(key, this);\n\n        // The server always closes the socket after sending this message\n        // fully remove the socket reference now\n        socket.on(\"server_disconnect\", (socketError: IOdspSocketError) => {\n            // Treat all errors as recoverable, and rely on joinSession / reconnection flow to\n            // filter out retryable vs. non-retryable cases.\n            const error = errorObjectFromSocketError(socketError, \"server_disconnect\");\n            error.canRetry = true;\n\n            // see comment in disconnected() getter\n            // Setting it here to ensure socket reuse does not happen if new request to connect\n            // comes in from \"disconnect\" listener below, before we close socket.\n            this.isPendingInitialConnection = false;\n\n            this.emit(\"server_disconnect\", error);\n            this.closeSocket();\n        });\n    }\n\n    private clearTimer() {\n        if (this.delayDeleteTimeout !== undefined) {\n            clearTimeout(this.delayDeleteTimeout);\n            this.delayDeleteTimeout = undefined;\n        }\n    }\n\n    private closeSocket() {\n        if (!this._socket) { return; }\n\n        this.clearTimer();\n\n        assert(SocketReference.socketIoSockets.get(this.key) === this,\n            0x0a1 /* \"Socket reference set unexpectedly does not point to this socket!\" */);\n        SocketReference.socketIoSockets.delete(this.key);\n\n        const socket = this._socket;\n        this._socket = undefined;\n\n        // Delay closing socket, to make sure all users of socket observe the same event that causes\n        // this instance to close, and thus properly record reason for closure.\n        // All event raising is synchronous, so clients will have a chance to react before socket is\n        // closed without any extra data on why it was closed.\n        // eslint-disable-next-line @typescript-eslint/no-floating-promises\n        Promise.resolve().then(() => { socket.disconnect(); });\n    }\n\n    private get disconnected() {\n        if (this._socket === undefined) { return true; }\n        if (this.socket.connected) { return false; }\n\n        // We have a socket that is not connected. Possible cases:\n        // 1) It was connected some time ago and lost connection. We do not want to reuse it.\n        // 2) It failed to connect (was never connected).\n        // 3) It was just created and never had a chance to connect - connection is in process.\n        // We have to differentiate 1 from 2-3 (specifically 1 & 3) in order to be able to reuse socket in #3.\n        // We will use the fact that socket had some activity. I.e. if socket disconnected, or client stopped using\n        // socket, then removeSocketIoReference() will be called for it, and it will be the indiction that it's not #3.\n        return !this.isPendingInitialConnection;\n    }\n}\n\n/**\n * Represents a connection to a stream of delta updates\n */\nexport class OdspDocumentDeltaConnection extends DocumentDeltaConnection {\n    /**\n     * Create a OdspDocumentDeltaConnection\n     * If url #1 fails to connect, will try url #2 if applicable.\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for storage service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param mode - mode of the client\n     * @param url - websocket URL\n     * @param telemetryLogger - optional telemetry logger\n     * @param timeoutMs - time limit on making the connection\n     * @param epochTracker - track epoch changes\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    public static async create(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: SocketIOClientStatic,\n        client: IClient,\n        url: string,\n        telemetryLogger: ITelemetryLogger,\n        timeoutMs: number,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix: string | undefined): Promise<OdspDocumentDeltaConnection> {\n        // enable multiplexing when the websocket url does not include the tenant/document id\n        const parsedUrl = new URL(url);\n        const enableMultiplexing = !parsedUrl.searchParams.has(\"documentId\") && !parsedUrl.searchParams.has(\"tenantId\");\n\n        // do not include the specific tenant/doc id in the ref key when multiplexing\n        // this will allow multiple documents to share the same websocket connection\n        const key = socketReferenceKeyPrefix ? `${socketReferenceKeyPrefix},${url}` : url;\n        const socketReferenceKey = enableMultiplexing ? key : `${key},${tenantId},${documentId}`;\n\n        const socketReference = OdspDocumentDeltaConnection.getOrCreateSocketIoReference(\n            io, timeoutMs, socketReferenceKey, url, enableMultiplexing, tenantId, documentId, telemetryLogger);\n\n        const socket = socketReference.socket;\n\n        const connectMessage: IConnect = {\n            client,\n            id: documentId,\n            mode: client.mode,\n            tenantId,\n            token,  // Token is going to indicate tenant level information, etc...\n            versions: protocolVersions,\n            nonce: uuid(),\n            epoch: epochTracker.fluidEpoch,\n        };\n\n        // Reference to this client supporting get_ops flow.\n        // back-compat: remove cast to any once new definition of IConnect comes through.\n        (connectMessage as any).supportedFeatures = { [feature_get_ops]: true };\n\n        const deltaConnection = new OdspDocumentDeltaConnection(\n            socket,\n            documentId,\n            socketReference,\n            telemetryLogger,\n            enableMultiplexing);\n\n        try {\n            await deltaConnection.initialize(connectMessage, timeoutMs);\n            await epochTracker.validateEpochFromPush(deltaConnection.details);\n        } catch (errorObject) {\n            if (errorObject !== null && typeof errorObject === \"object\") {\n                // We have to special-case error types here in terms of what is re-triable.\n                // These errors have to re-retried, we just need new joinSession result to connect to right server:\n                //    400: Invalid tenant or document id. The WebSocket is connected to a different document\n                //         Document is full (with retryAfter)\n                //    404: Invalid document. The document \\\"local/w1-...\\\" does not exist\n                // But this has to stay not-retriable:\n                //    406: Unsupported client protocol. This path is the only gatekeeper, have to fail!\n                //    409: Epoch Version Mismatch. Client epoch and server epoch does not match, so app needs\n                //         to be refreshed.\n                // This one is fine either way\n                //    401/403: Code will retry once with new token either way, then it becomes fatal - on this path\n                //         and on join Session path.\n                //    501: (Fluid not enabled): this is fine either way, as joinSession is gatekeeper\n                if (errorObject.statusCode === 400 || errorObject.statusCode === 404) {\n                    errorObject.canRetry = true;\n                }\n            }\n            throw errorObject;\n        }\n\n        return deltaConnection;\n    }\n\n    private socketReference: SocketReference | undefined;\n\n    private readonly requestOpsNoncePrefix: string;\n    private pushCallCounter = 0;\n    private readonly getOpsMap: Map<string, { start: number, from: number, to: number }> = new Map();\n    private flushOpNonce: string | undefined;\n    private flushDeferred: Deferred<FlushResult> | undefined;\n\n    /**\n     * Error raising for socket.io issues\n     */\n    protected createErrorObject(handler: string, error?: any, canRetry = true): DriverError {\n        // Note: we suspect the incoming error object is either:\n        // - a socketError: add it to the OdspError object for driver to be able to parse it and reason over it.\n        // - anything else: let base class handle it\n        if (canRetry && Number.isInteger(error?.code) && typeof error?.message === \"string\") {\n            return errorObjectFromSocketError(error as IOdspSocketError, handler) as DriverError;\n        } else {\n            return super.createErrorObject(handler, error, canRetry);\n        }\n    }\n\n    /**\n     * Gets or create a socket io connection for the given key\n     */\n    private static getOrCreateSocketIoReference(\n        io: SocketIOClientStatic,\n        timeoutMs: number,\n        key: string,\n        url: string,\n        enableMultiplexing: boolean,\n        tenantId: string,\n        documentId: string,\n        logger: ITelemetryLogger,\n    ): SocketReference {\n        const existingSocketReference = SocketReference.find(key, logger);\n        if (existingSocketReference) {\n            return existingSocketReference;\n        }\n\n        const query = enableMultiplexing ? undefined : { documentId, tenantId };\n\n        const socket = io(\n            url,\n            {\n                multiplex: false, // Don't rely on socket.io built-in multiplexing\n                query,\n                reconnection: false,\n                transports: [\"websocket\"],\n                timeout: timeoutMs,\n            });\n\n        return new SocketReference(key, socket);\n    }\n\n    /**\n     * @param socket - websocket to be used\n     * @param documentId - ID of the document\n     * @param details - details of the websocket connection\n     * @param socketReferenceKey - socket reference key\n     * @param enableMultiplexing - If the websocket is multiplexing multiple documents\n     */\n    private constructor(\n        socket: SocketIOClient.Socket,\n        documentId: string,\n        socketReference: SocketReference,\n        logger: ITelemetryLogger,\n        private readonly enableMultiplexing?: boolean,\n    ) {\n        super(socket, documentId, logger);\n        this.socketReference = socketReference;\n        this.requestOpsNoncePrefix = `${uuid()}-`;\n    }\n\n    /**\n     * Retrieves ops from PUSH\n     * @param from - inclusive\n     * @param to - exclusive\n     * @returns ops retrieved\n     */\n     public requestOps(from: number, to: number) {\n        // Given that to is exclusive, we should be asking for at least something!\n        assert(to > from, 0x272 /* \"empty request\" */);\n\n        // PUSH may disable this functionality\n        // back-compat: remove cast to any once latest version of IConnected is consumed\n        if ((this.details as any).supportedFeatures?.[feature_get_ops] !== true) {\n            return;\n        }\n\n        this.pushCallCounter++;\n        const nonce = `${this.requestOpsNoncePrefix}${this.pushCallCounter}`;\n        const start = performance.now();\n\n        // We may keep keep accumulating memory for nothing, if we are not getting responses.\n        // Note that we should not have overlapping requests, as DeltaManager allows only one\n        // outstanding request to storage, and that's the only way to get here.\n        // But requests could be cancelled, and thus overlapping requests might be in the picture\n        // If it happens, we do not care about stale requests.\n        // So track some number of requests, but log if we get too many in flight - that likely\n        // indicates an error somewhere.\n        if (this.getOpsMap.size >= 5) {\n            let time = start;\n            let key: string | undefined;\n            for (const [keyCandidate, value] of this.getOpsMap.entries()) {\n                if (value.start <= time || key === undefined) {\n                    time = value.start;\n                    key = keyCandidate;\n                }\n            }\n            const payloadToDelete = this.getOpsMap.get(key!)!;\n            this.logger.sendErrorEvent({\n                eventName: \"GetOpsTooMany\",\n                nonce,\n                from: payloadToDelete.from,\n                to: payloadToDelete.to,\n                length: payloadToDelete.to - payloadToDelete.from,\n                duration: performance.now() - payloadToDelete.start,\n            });\n            this.getOpsMap.delete(key!);\n        }\n        this.getOpsMap.set(\n            nonce,\n            {\n                start,\n                from,\n                to,\n            },\n        );\n        this.socket.emit(\"get_ops\", this.clientId, {\n            nonce,\n            from,\n            to: to - 1,\n        });\n    }\n\n    public async flush(): Promise<FlushResult> {\n        // back-compat: remove cast to any once latest version of IConnected is consumed\n        if ((this.details as any).supportedFeatures?.[feature_flush_ops] !== true) {\n            // Once single-commit summary is enabled end-to-end, flush support is a must!\n            // The only alternative is change in design where SPO fetches ops from PUSH OR\n            // summary includes required ops and SPO has some validation mechanism to ensure\n            // they are not forged by client.\n            // If design changes, we can reconsider it, but right now it's non-recoverable failure.\n            this.logger.sendErrorEvent({ eventName: \"FlushOpsNotSupported\" });\n            throw new Error(\"flush() API is not supported by PUSH, required for single-commit summaries\");\n        }\n\n        this.pushCallCounter++;\n        const nonce = `${this.requestOpsNoncePrefix}${this.pushCallCounter}`;\n        // There should be only one flush ops in flight, kicked out by upload summary workflow\n        // That said, it could timeout, and request could be repeated, so theoretically we can\n        // get overlapping requests, but it should be very rare\n        if (this.flushDeferred !== undefined) {\n            this.logger.sendErrorEvent({ eventName: \"FlushOpsTooMany\" });\n            this.flushDeferred.reject(\"process involving flush() was cancelled OR unsupported concurrency\");\n        }\n        this.socket.emit(\"flush_ops\", this.clientId, { nonce });\n\n        this.flushOpNonce = nonce;\n        this.flushDeferred = new Deferred<FlushResult>();\n        return this.flushDeferred.promise;\n    }\n\n    protected serverDisconnectHandler = (error: LoggingError & OdspError) => {\n        this.disposeCore(true, error);\n    };\n\n    protected async initialize(connectMessage: IConnect, timeout: number) {\n        if (this.enableMultiplexing) {\n            // multiplex compatible early handlers\n            this.earlyOpHandler = (messageDocumentId: string, msgs: ISequencedDocumentMessage[]) => {\n                if (this.documentId === messageDocumentId) {\n                    this.queuedMessages.push(...msgs);\n                }\n            };\n\n            this.earlySignalHandler = (msg: ISignalMessage, messageDocumentId?: string) => {\n                if (messageDocumentId === undefined || messageDocumentId === this.documentId) {\n                    this.queuedSignals.push(msg);\n                }\n            };\n        }\n\n        this.socketReference!.once(\"server_disconnect\", this.serverDisconnectHandler);\n\n        this.socket.on(\"get_ops_response\", (result: IGetOpsResponse) => {\n            const messages = result.messages;\n            const data = this.getOpsMap.get(result.nonce);\n            // Due to socket multiplexing, this client may not have asked for any data\n            // If so, there it most likely does not need these ops (otherwise it already asked for them)\n            // Also we may have deleted entry in this.getOpsMap due to too many requests and too slow response.\n            // But not processing such result may push us into infinite loop of fast requests and dropping all responses\n            if (data !== undefined || result.nonce.indexOf(this.requestOpsNoncePrefix) === 0) {\n                this.getOpsMap.delete(result.nonce);\n                const common = {\n                    eventName: \"GetOps\",\n                    // We need nonce only to pair with GetOpsTooMany events, i.e. when record was deleted\n                    nonce: data === undefined ? result.nonce : undefined,\n                    code: result.code,\n                    from: data?.from,\n                    to: data?.to,\n                    duration: data === undefined ? undefined : performance.now() - data.start,\n                };\n                if (messages !== undefined && messages.length > 0) {\n                    this.logger.sendPerformanceEvent({\n                        ...common,\n                        first: messages[0].sequenceNumber,\n                        last: messages[messages.length - 1].sequenceNumber,\n                        length: messages.length,\n                    });\n                    this.emit(\"op\", this.documentId, messages);\n                } else {\n                    this.logger.sendPerformanceEvent({\n                        ...common,\n                        length: 0,\n                    });\n                }\n            }\n        });\n\n        this.socket.on(\"flush_ops_response\", (result: IFlushOpsResponse) => {\n            if (this.flushOpNonce === result.nonce) {\n                const seq = result.lastPersistedSequenceNumber;\n                let category: \"generic\" | \"error\" = \"generic\";\n                if (result.lastPersistedSequenceNumber === undefined || result.code !== 200) {\n                    switch (result.code) {\n                        case 409:\n                        case 429:\n                            category = \"error\";\n                            break;\n                        case 204:\n                            break;\n                        default:\n                            category = \"error\";\n                            break;\n                    }\n                }\n                this.logger.sendTelemetryEvent({\n                    eventName: \"FlushResult\",\n                    code: result.code,\n                    sequenceNumber: seq,\n                    category,\n                });\n                this.flushDeferred!.resolve(result);\n                this.flushDeferred = undefined;\n                this.flushOpNonce = undefined;\n            }\n        });\n\n        await super.initialize(connectMessage, timeout);\n    }\n\n    protected addTrackedListener(event: string, listener: (...args: any[]) => void) {\n        // override some event listeners in order to support multiple documents/clients over the same websocket\n        switch (event) {\n            case \"op\":\n                // per document op handling\n                super.addTrackedListener(event, (documentId: string, msgs: ISequencedDocumentMessage[]) => {\n                    if (!this.enableMultiplexing || this.documentId === documentId) {\n                        listener(documentId, msgs);\n                    }\n                });\n                break;\n\n            case \"signal\":\n                // per document signal handling\n                super.addTrackedListener(event, (msg: ISignalMessage, documentId?: string) => {\n                    if (!this.enableMultiplexing || !documentId || documentId === this.documentId) {\n                        listener(msg, documentId);\n                    }\n                });\n                break;\n\n            case \"nack\":\n                // per client / document nack handling\n                super.addTrackedListener(event, (clientIdOrDocumentId: string, message: INack[]) => {\n                    if (clientIdOrDocumentId.length === 0 ||\n                        clientIdOrDocumentId === this.documentId ||\n                        (this.hasDetails && clientIdOrDocumentId === this.clientId)) {\n                        this.emit(\"nack\", clientIdOrDocumentId, message);\n                    }\n                });\n                break;\n\n            default:\n                super.addTrackedListener(event, listener);\n                break;\n        }\n    }\n\n    /**\n     * Disconnect from the websocket\n     */\n    protected disconnect(socketProtocolError: boolean, reason: any) {\n        const socket = this.socketReference;\n        assert(socket !== undefined, 0x0a2 /* \"reentrancy not supported!\" */);\n        this.socketReference = undefined;\n\n        this.socket.off(\"server_disconnect\", this.serverDisconnectHandler);\n\n        if (!socketProtocolError && this.hasDetails) {\n            // tell the server we are disconnecting this client from the document\n            this.socket.emit(\"disconnect_document\", this.clientId, this.documentId);\n        }\n\n        socket.removeSocketIoReference(socketProtocolError);\n        this.emit(\"disconnect\", reason);\n    }\n}\n"]}
+{"version":3,"file":"odspDocumentDeltaConnection.js","sourceRoot":"","sources":["../src/odspDocumentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAChG,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAWtE,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAGlC,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAClE,MAAM,eAAe,GAAG,aAAa,CAAC;AACtC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAO1C,uFAAuF;AACvF,+DAA+D;AAC/D,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAMvC,MAAM,eAAgB,SAAQ,iBAAgC;IAmE1D,YAAmC,GAAW,EAAE,MAA6B;QACzE,KAAK,EAAE,CAAC;QADuB,QAAG,GAAH,GAAG,CAAQ;QAlEtC,eAAU,GAAW,CAAC,CAAC;QAI/B,iFAAiF;QACjF,0EAA0E;QAC1E,qFAAqF;QACrF,sEAAsE;QAC9D,+BAA0B,GAAG,IAAI,CAAC;QA6DtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,MAAM,CAAC,CAAC,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACtF,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAE/C,iEAAiE;QACjE,wCAAwC;QACxC,MAAM,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,WAA6B,EAAE,EAAE;YAC7D,kFAAkF;YAClF,gDAAgD;YAChD,MAAM,KAAK,GAAG,0BAA0B,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YAC3E,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEtB,uCAAuC;YACvC,mFAAmF;YACnF,qEAAqE;YACrE,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC;YAExC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YACtC,IAAI,CAAC,WAAW,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACP,CAAC;IA5EM,MAAM,CAAC,IAAI,CAAC,GAAW,EAAE,MAAwB;QACpD,MAAM,eAAe,GAAG,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEjE,iDAAiD;QACjD,IAAI,eAAe,IAAI,eAAe,CAAC,YAAY,EAAE;YACjD,2DAA2D;YAC3D,eAAe,CAAC,WAAW,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC;SACpB;QAED,IAAI,eAAe,EAAE;YACjB,6CAA6C;YAC7C,eAAe,CAAC,UAAU,EAAE,CAAC;YAC7B,eAAe,CAAC,UAAU,EAAE,CAAC;SAChC;QAED,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAAC,YAAqB;QAChD,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5E,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,uCAAuC;QACvC,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC;QAExC,IAAI,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE;YACnC,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,OAAO;SACV;QAED,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAChE,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,GAAG,EAAE;gBACtC,4CAA4C;gBAC5C,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACvF,IAAI,CAAC,WAAW,EAAE,CAAC;YACvB,CAAC,EAAE,yBAAyB,CAAC,CAAC;SACjC;IACL,CAAC;IAED,IAAW,MAAM;QACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;SAC1D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IA2BO,UAAU;QACd,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YACvC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACtC,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;SACvC;IACL,CAAC;IAEO,WAAW;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YAAE,OAAO;SAAE;QAE9B,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EACzD,KAAK,CAAC,wEAAwE,CAAC,CAAC;QACpF,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QAEzB,4FAA4F;QAC5F,uEAAuE;QACvE,4FAA4F;QAC5F,sDAAsD;QACtD,mEAAmE;QACnE,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,IAAY,YAAY;QACpB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YAAE,OAAO,IAAI,CAAC;SAAE;QAChD,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAAE,OAAO,KAAK,CAAC;SAAE;QAE5C,0DAA0D;QAC1D,qFAAqF;QACrF,iDAAiD;QACjD,uFAAuF;QACvF,sGAAsG;QACtG,2GAA2G;QAC3G,+GAA+G;QAC/G,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC;IAC5C,CAAC;;AAxHD,+EAA+E;AACvD,+BAAe,GAAiC,IAAI,GAAG,EAAE,CAAC;AA0HtF;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,uBAAuB;IAoJpE;;;;;;OAMG;IACH,YACI,MAA6B,EAC7B,UAAkB,EAClB,eAAgC,EAChC,MAAwB,EACP,kBAA4B;QAE7C,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAFjB,uBAAkB,GAAlB,kBAAkB,CAAU;QAhEzC,oBAAe,GAAG,CAAC,CAAC;QACX,cAAS,GAA6D,IAAI,GAAG,EAAE,CAAC;QAgKvF,4BAAuB,GAAG,CAAC,KAA+B,EAAE,EAAE;YACpE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC,CAAC;QAhGE,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,qBAAqB,GAAG,GAAG,IAAI,EAAE,GAAG,CAAC;IAC9C,CAAC;IApKD;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAAwB,EACxB,MAAe,EACf,GAAW,EACX,eAAiC,EACjC,SAAiB,EACjB,YAA0B,EAC1B,wBAA4C;QAC5C,qFAAqF;QACrF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,kBAAkB,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEhH,6EAA6E;QAC7E,4EAA4E;QAC5E,MAAM,GAAG,GAAG,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAClF,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,QAAQ,IAAI,UAAU,EAAE,CAAC;QAEzF,MAAM,eAAe,GAAG,2BAA2B,CAAC,4BAA4B,CAC5E,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;QAEvG,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;QAEtC,MAAM,cAAc,GAAa;YAC7B,MAAM;YACN,EAAE,EAAE,UAAU;YACd,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ;YACR,KAAK;YACL,QAAQ,EAAE,gBAAgB;YAC1B,KAAK,EAAE,IAAI,EAAE;YACb,KAAK,EAAE,YAAY,CAAC,UAAU;YAC9B,cAAc,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,kBAAkB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;SACzF,CAAC;QAEF,oDAAoD;QACpD,iFAAiF;QAChF,cAAsB,CAAC,iBAAiB,GAAG,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC;QAExE,MAAM,eAAe,GAAG,IAAI,2BAA2B,CACnD,MAAM,EACN,UAAU,EACV,eAAe,EACf,eAAe,EACf,kBAAkB,CAAC,CAAC;QAExB,IAAI;YACA,MAAM,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAC5D,MAAM,YAAY,CAAC,qBAAqB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;SACrE;QAAC,OAAO,WAAW,EAAE;YAClB,IAAI,WAAW,KAAK,IAAI,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACzD,2EAA2E;gBAC3E,mGAAmG;gBACnG,4FAA4F;gBAC5F,6CAA6C;gBAC7C,yEAAyE;gBACzE,sCAAsC;gBACtC,uFAAuF;gBACvF,6FAA6F;gBAC7F,2BAA2B;gBAC3B,8BAA8B;gBAC9B,mGAAmG;gBACnG,oCAAoC;gBACpC,qFAAqF;gBACrF,IAAI,WAAW,CAAC,UAAU,KAAK,GAAG,IAAI,WAAW,CAAC,UAAU,KAAK,GAAG,EAAE;oBAClE,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;iBAC/B;aACJ;YACD,MAAM,WAAW,CAAC;SACrB;QAED,OAAO,eAAe,CAAC;IAC3B,CAAC;IAUD;;OAEG;IACO,iBAAiB,CAAC,OAAe,EAAE,KAAW,EAAE,QAAQ,GAAG,IAAI;QACrE,wDAAwD;QACxD,wGAAwG;QACxG,4CAA4C;QAC5C,IAAI,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,CAAC,IAAI,QAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAA,KAAK,QAAQ,EAAE;YACjF,OAAO,0BAA0B,CAAC,KAAyB,EAAE,OAAO,CAAgB,CAAC;SACxF;aAAM;YACH,OAAO,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;SAC5D;IACL,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,4BAA4B,CACvC,EAAwB,EACxB,SAAiB,EACjB,GAAW,EACX,GAAW,EACX,kBAA2B,EAC3B,QAAgB,EAChB,UAAkB,EAClB,MAAwB;QAExB,MAAM,uBAAuB,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAClE,IAAI,uBAAuB,EAAE;YACzB,OAAO,uBAAuB,CAAC;SAClC;QAED,MAAM,KAAK,GAAG,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;QAExE,MAAM,MAAM,GAAG,EAAE,CACb,GAAG,EACH;YACI,SAAS,EAAE,KAAK;YAChB,KAAK;YACL,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,CAAC,WAAW,CAAC;YACzB,OAAO,EAAE,SAAS;SACrB,CAAC,CAAC;QAEP,OAAO,IAAI,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAqBD;;;;;OAKG;IACK,UAAU,CAAC,IAAY,EAAE,EAAU;;QACvC,0EAA0E;QAC1E,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAE/C,sCAAsC;QACtC,gFAAgF;QAChF,IAAI,OAAC,IAAI,CAAC,OAAe,CAAC,iBAAiB,0CAAG,eAAe,OAAM,IAAI,EAAE;YACrE,OAAO;SACV;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACrE,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAEhC,qFAAqF;QACrF,qFAAqF;QACrF,uEAAuE;QACvE,yFAAyF;QACzF,sDAAsD;QACtD,uFAAuF;QACvF,gCAAgC;QAChC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,EAAE;YAC1B,IAAI,IAAI,GAAG,KAAK,CAAC;YACjB,IAAI,GAAuB,CAAC;YAC5B,KAAK,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE;gBAC1D,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE;oBAC1C,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC;oBACnB,GAAG,GAAG,YAAY,CAAC;iBACtB;aACJ;YACD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAI,CAAE,CAAC;YAClD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBACvB,SAAS,EAAE,eAAe;gBAC1B,KAAK;gBACL,IAAI,EAAE,eAAe,CAAC,IAAI;gBAC1B,EAAE,EAAE,eAAe,CAAC,EAAE;gBACtB,MAAM,EAAE,eAAe,CAAC,EAAE,GAAG,eAAe,CAAC,IAAI;gBACjD,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,eAAe,CAAC,KAAK;aACtD,CAAC,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAI,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,CACd,KAAK,EACL;YACI,KAAK;YACL,IAAI;YACJ,EAAE;SACL,CACJ,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE;YACvC,KAAK;YACL,IAAI;YACJ,EAAE,EAAE,EAAE,GAAG,CAAC;SACb,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,KAAK;;QACd,gFAAgF;QAChF,IAAI,OAAC,IAAI,CAAC,OAAe,CAAC,iBAAiB,0CAAG,iBAAiB,OAAM,IAAI,EAAE;YACvE,6EAA6E;YAC7E,8EAA8E;YAC9E,gFAAgF;YAChF,iCAAiC;YACjC,uFAAuF;YACvF,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,sBAAsB,EAAE,CAAC,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;SACjG;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACrE,sFAAsF;QACtF,sFAAsF;QACtF,uDAAuD;QACvD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,oEAAoE,CAAC,CAAC;SACnG;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAExD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,EAAe,CAAC;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;IACtC,CAAC;IAMS,KAAK,CAAC,UAAU,CAAC,cAAwB,EAAE,OAAe;QAChE,IAAI,IAAI,CAAC,kBAAkB,EAAE;YACzB,sCAAsC;YACtC,IAAI,CAAC,cAAc,GAAG,CAAC,iBAAyB,EAAE,IAAiC,EAAE,EAAE;gBACnF,IAAI,IAAI,CAAC,UAAU,KAAK,iBAAiB,EAAE;oBACvC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;iBACrC;YACL,CAAC,CAAC;YAEF,IAAI,CAAC,kBAAkB,GAAG,CAAC,GAAmB,EAAE,iBAA0B,EAAE,EAAE;gBAC1E,IAAI,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,KAAK,IAAI,CAAC,UAAU,EAAE;oBAC1E,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBAChC;YACL,CAAC,CAAC;SACL;QAED,IAAI,CAAC,eAAgB,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAE9E,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,kBAAkB,EAAE,CAAC,MAAuB,EAAE,EAAE;YAC3D,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9C,0EAA0E;YAC1E,4FAA4F;YAC5F,mGAAmG;YACnG,4GAA4G;YAC5G,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;gBAC9E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACpC,MAAM,MAAM,GAAG;oBACX,SAAS,EAAE,QAAQ;oBACnB,qFAAqF;oBACrF,KAAK,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;oBACpD,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,IAAI,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI;oBAChB,EAAE,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE;oBACZ,QAAQ,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK;iBAC5E,CAAC;gBACF,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC/C,IAAI,CAAC,MAAM,CAAC,oBAAoB,iCACzB,MAAM,KACT,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EACjC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAClD,MAAM,EAAE,QAAQ,CAAC,MAAM,IACzB,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;iBAC9C;qBAAM;oBACH,IAAI,CAAC,MAAM,CAAC,oBAAoB,iCACzB,MAAM,KACT,MAAM,EAAE,CAAC,IACX,CAAC;iBACN;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,MAAyB,EAAE,EAAE;YAC/D,IAAI,IAAI,CAAC,YAAY,KAAK,MAAM,CAAC,KAAK,EAAE;gBACpC,MAAM,GAAG,GAAG,MAAM,CAAC,2BAA2B,CAAC;gBAC/C,IAAI,QAAQ,GAAwB,SAAS,CAAC;gBAC9C,IAAI,MAAM,CAAC,2BAA2B,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,EAAE;oBACzE,QAAQ,MAAM,CAAC,IAAI,EAAE;wBACjB,KAAK,GAAG,CAAC;wBACT,KAAK,GAAG;4BACJ,QAAQ,GAAG,OAAO,CAAC;4BACnB,MAAM;wBACV,KAAK,GAAG;4BACJ,MAAM;wBACV;4BACI,QAAQ,GAAG,OAAO,CAAC;4BACnB,MAAM;qBACb;iBACJ;gBACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC3B,SAAS,EAAE,aAAa;oBACxB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,cAAc,EAAE,GAAG;oBACnB,QAAQ;iBACX,CAAC,CAAC;gBACH,IAAI,CAAC,aAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACpC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;gBAC/B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;aACjC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,CAAC,UAAU,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAES,kBAAkB,CAAC,KAAa,EAAE,QAAkC;QAC1E,uGAAuG;QACvG,QAAQ,KAAK,EAAE;YACX,KAAK,IAAI;gBACL,2BAA2B;gBAC3B,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC,UAAkB,EAAE,IAAiC,EAAE,EAAE;oBACtF,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE;wBAC5D,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;qBAC9B;gBACL,CAAC,CAAC,CAAC;gBACH,MAAM;YAEV,KAAK,QAAQ;gBACT,+BAA+B;gBAC/B,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC,GAAmB,EAAE,UAAmB,EAAE,EAAE;oBACzE,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,EAAE;wBAC3E,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;qBAC7B;gBACL,CAAC,CAAC,CAAC;gBACH,MAAM;YAEV,KAAK,MAAM;gBACP,sCAAsC;gBACtC,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC,oBAA4B,EAAE,OAAgB,EAAE,EAAE;oBAC/E,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC;wBACjC,oBAAoB,KAAK,IAAI,CAAC,UAAU;wBACxC,CAAC,IAAI,CAAC,UAAU,IAAI,oBAAoB,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE;wBAC7D,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;qBACpD;gBACL,CAAC,CAAC,CAAC;gBACH,MAAM;YAEV;gBACI,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBAC1C,MAAM;SACb;IACL,CAAC;IAED;;OAEG;IACO,UAAU,CAAC,mBAA4B,EAAE,MAAW;QAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC;QACpC,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QAEjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAEnE,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,UAAU,EAAE;YACzC,qEAAqE;YACrE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SAC3E;QAED,MAAM,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger, IEvent } from \"@fluidframework/common-definitions\";\nimport { assert, performance, Deferred, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { DocumentDeltaConnection } from \"@fluidframework/driver-base\";\nimport { DriverError } from \"@fluidframework/driver-definitions\";\nimport { OdspError } from \"@fluidframework/odsp-driver-definitions\";\nimport { LoggingError } from \"@fluidframework/telemetry-utils\";\nimport {\n    IClient,\n    IConnect,\n    INack,\n    ISequencedDocumentMessage,\n    ISignalMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport { IOdspSocketError, IGetOpsResponse, IFlushOpsResponse } from \"./contracts\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { errorObjectFromSocketError } from \"./odspError\";\nimport { pkgVersion } from \"./packageVersion\";\n\nconst protocolVersions = [\"^0.4.0\", \"^0.3.0\", \"^0.2.0\", \"^0.1.0\"];\nconst feature_get_ops = \"api_get_ops\";\nconst feature_flush_ops = \"api_flush_ops\";\n\nexport interface FlushResult {\n    lastPersistedSequenceNumber?: number;\n    retryAfter?: number;\n}\n\n// How long to wait before disconnecting the socket after the last reference is removed\n// This allows reconnection after receiving a nack to be smooth\nconst socketReferenceBufferTime = 2000;\n\nexport interface ISocketEvents extends IEvent {\n    (event: \"server_disconnect\", listener: (error: LoggingError & OdspError) => void);\n}\n\nclass SocketReference extends TypedEventEmitter<ISocketEvents> {\n    private references: number = 1;\n    private delayDeleteTimeout: ReturnType<typeof setTimeout> | undefined;\n    private _socket: SocketIOClient.Socket | undefined;\n\n    // When making decisions about socket reuse, we do not reuse disconnected socket.\n    // But we want to differentiate the following case from disconnected case:\n    // Socket that never connected and never failed, it's in \"attempting to connect\" mode\n    // such sockets should be reused, despite socket.disconnected === true\n    private isPendingInitialConnection = true;\n\n    // Map of all existing socket io sockets. [url, tenantId, documentId] -> socket\n    private static readonly socketIoSockets: Map<string, SocketReference> = new Map();\n\n    public static find(key: string, logger: ITelemetryLogger) {\n        const socketReference = SocketReference.socketIoSockets.get(key);\n\n        // Verify the socket is healthy before reusing it\n        if (socketReference && socketReference.disconnected) {\n            // The socket is in a bad state. fully remove the reference\n            socketReference.closeSocket();\n            return undefined;\n        }\n\n        if (socketReference) {\n            // Clear the pending deletion if there is one\n            socketReference.clearTimer();\n            socketReference.references++;\n        }\n\n        return socketReference;\n    }\n\n    /**\n     * Removes a reference for the given key\n     * Once the ref count hits 0, the socket is disconnected and removed\n     * @param key - socket reference key\n     * @param isFatalError - true if the socket reference should be removed immediately due to a fatal error\n     */\n    public removeSocketIoReference(isFatalError: boolean) {\n        assert(this.references > 0, 0x09f /* \"No more socketIO refs to remove!\" */);\n        this.references--;\n\n        // see comment in disconnected() getter\n        this.isPendingInitialConnection = false;\n\n        if (isFatalError || this.disconnected) {\n            this.closeSocket();\n            return;\n        }\n\n        if (this.references === 0 && this.delayDeleteTimeout === undefined) {\n            this.delayDeleteTimeout = setTimeout(() => {\n                // We should not get here with active users.\n                assert(this.references === 0, 0x0a0 /* \"Unexpected socketIO references on timeout\" */);\n                this.closeSocket();\n            }, socketReferenceBufferTime);\n        }\n    }\n\n    public get socket() {\n        if (!this._socket) {\n            throw new Error(`Invalid socket for key \"${this.key}`);\n        }\n        return this._socket;\n    }\n\n    public constructor(public readonly key: string, socket: SocketIOClient.Socket) {\n        super();\n\n        this._socket = socket;\n        assert(!SocketReference.socketIoSockets.has(key), 0x220 /* \"socket key collision\" */);\n        SocketReference.socketIoSockets.set(key, this);\n\n        // The server always closes the socket after sending this message\n        // fully remove the socket reference now\n        socket.on(\"server_disconnect\", (socketError: IOdspSocketError) => {\n            // Treat all errors as recoverable, and rely on joinSession / reconnection flow to\n            // filter out retryable vs. non-retryable cases.\n            const error = errorObjectFromSocketError(socketError, \"server_disconnect\");\n            error.canRetry = true;\n\n            // see comment in disconnected() getter\n            // Setting it here to ensure socket reuse does not happen if new request to connect\n            // comes in from \"disconnect\" listener below, before we close socket.\n            this.isPendingInitialConnection = false;\n\n            this.emit(\"server_disconnect\", error);\n            this.closeSocket();\n        });\n    }\n\n    private clearTimer() {\n        if (this.delayDeleteTimeout !== undefined) {\n            clearTimeout(this.delayDeleteTimeout);\n            this.delayDeleteTimeout = undefined;\n        }\n    }\n\n    private closeSocket() {\n        if (!this._socket) { return; }\n\n        this.clearTimer();\n\n        assert(SocketReference.socketIoSockets.get(this.key) === this,\n            0x0a1 /* \"Socket reference set unexpectedly does not point to this socket!\" */);\n        SocketReference.socketIoSockets.delete(this.key);\n\n        const socket = this._socket;\n        this._socket = undefined;\n\n        // Delay closing socket, to make sure all users of socket observe the same event that causes\n        // this instance to close, and thus properly record reason for closure.\n        // All event raising is synchronous, so clients will have a chance to react before socket is\n        // closed without any extra data on why it was closed.\n        // eslint-disable-next-line @typescript-eslint/no-floating-promises\n        Promise.resolve().then(() => { socket.disconnect(); });\n    }\n\n    private get disconnected() {\n        if (this._socket === undefined) { return true; }\n        if (this.socket.connected) { return false; }\n\n        // We have a socket that is not connected. Possible cases:\n        // 1) It was connected some time ago and lost connection. We do not want to reuse it.\n        // 2) It failed to connect (was never connected).\n        // 3) It was just created and never had a chance to connect - connection is in process.\n        // We have to differentiate 1 from 2-3 (specifically 1 & 3) in order to be able to reuse socket in #3.\n        // We will use the fact that socket had some activity. I.e. if socket disconnected, or client stopped using\n        // socket, then removeSocketIoReference() will be called for it, and it will be the indiction that it's not #3.\n        return !this.isPendingInitialConnection;\n    }\n}\n\n/**\n * Represents a connection to a stream of delta updates\n */\nexport class OdspDocumentDeltaConnection extends DocumentDeltaConnection {\n    /**\n     * Create a OdspDocumentDeltaConnection\n     * If url #1 fails to connect, will try url #2 if applicable.\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for storage service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param mode - mode of the client\n     * @param url - websocket URL\n     * @param telemetryLogger - optional telemetry logger\n     * @param timeoutMs - time limit on making the connection\n     * @param epochTracker - track epoch changes\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    public static async create(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: SocketIOClientStatic,\n        client: IClient,\n        url: string,\n        telemetryLogger: ITelemetryLogger,\n        timeoutMs: number,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix: string | undefined): Promise<OdspDocumentDeltaConnection> {\n        // enable multiplexing when the websocket url does not include the tenant/document id\n        const parsedUrl = new URL(url);\n        const enableMultiplexing = !parsedUrl.searchParams.has(\"documentId\") && !parsedUrl.searchParams.has(\"tenantId\");\n\n        // do not include the specific tenant/doc id in the ref key when multiplexing\n        // this will allow multiple documents to share the same websocket connection\n        const key = socketReferenceKeyPrefix ? `${socketReferenceKeyPrefix},${url}` : url;\n        const socketReferenceKey = enableMultiplexing ? key : `${key},${tenantId},${documentId}`;\n\n        const socketReference = OdspDocumentDeltaConnection.getOrCreateSocketIoReference(\n            io, timeoutMs, socketReferenceKey, url, enableMultiplexing, tenantId, documentId, telemetryLogger);\n\n        const socket = socketReference.socket;\n\n        const connectMessage: IConnect = {\n            client,\n            id: documentId,\n            mode: client.mode,\n            tenantId,\n            token,  // Token is going to indicate tenant level information, etc...\n            versions: protocolVersions,\n            nonce: uuid(),\n            epoch: epochTracker.fluidEpoch,\n            relayUserAgent: [client.details.environment, ` driverVersion:${pkgVersion}`].join(\";\"),\n        };\n\n        // Reference to this client supporting get_ops flow.\n        // back-compat: remove cast to any once new definition of IConnect comes through.\n        (connectMessage as any).supportedFeatures = { [feature_get_ops]: true };\n\n        const deltaConnection = new OdspDocumentDeltaConnection(\n            socket,\n            documentId,\n            socketReference,\n            telemetryLogger,\n            enableMultiplexing);\n\n        try {\n            await deltaConnection.initialize(connectMessage, timeoutMs);\n            await epochTracker.validateEpochFromPush(deltaConnection.details);\n        } catch (errorObject) {\n            if (errorObject !== null && typeof errorObject === \"object\") {\n                // We have to special-case error types here in terms of what is re-triable.\n                // These errors have to re-retried, we just need new joinSession result to connect to right server:\n                //    400: Invalid tenant or document id. The WebSocket is connected to a different document\n                //         Document is full (with retryAfter)\n                //    404: Invalid document. The document \\\"local/w1-...\\\" does not exist\n                // But this has to stay not-retriable:\n                //    406: Unsupported client protocol. This path is the only gatekeeper, have to fail!\n                //    409: Epoch Version Mismatch. Client epoch and server epoch does not match, so app needs\n                //         to be refreshed.\n                // This one is fine either way\n                //    401/403: Code will retry once with new token either way, then it becomes fatal - on this path\n                //         and on join Session path.\n                //    501: (Fluid not enabled): this is fine either way, as joinSession is gatekeeper\n                if (errorObject.statusCode === 400 || errorObject.statusCode === 404) {\n                    errorObject.canRetry = true;\n                }\n            }\n            throw errorObject;\n        }\n\n        return deltaConnection;\n    }\n\n    private socketReference: SocketReference | undefined;\n\n    private readonly requestOpsNoncePrefix: string;\n    private pushCallCounter = 0;\n    private readonly getOpsMap: Map<string, { start: number, from: number, to: number }> = new Map();\n    private flushOpNonce: string | undefined;\n    private flushDeferred: Deferred<FlushResult> | undefined;\n\n    /**\n     * Error raising for socket.io issues\n     */\n    protected createErrorObject(handler: string, error?: any, canRetry = true): DriverError {\n        // Note: we suspect the incoming error object is either:\n        // - a socketError: add it to the OdspError object for driver to be able to parse it and reason over it.\n        // - anything else: let base class handle it\n        if (canRetry && Number.isInteger(error?.code) && typeof error?.message === \"string\") {\n            return errorObjectFromSocketError(error as IOdspSocketError, handler) as DriverError;\n        } else {\n            return super.createErrorObject(handler, error, canRetry);\n        }\n    }\n\n    /**\n     * Gets or create a socket io connection for the given key\n     */\n    private static getOrCreateSocketIoReference(\n        io: SocketIOClientStatic,\n        timeoutMs: number,\n        key: string,\n        url: string,\n        enableMultiplexing: boolean,\n        tenantId: string,\n        documentId: string,\n        logger: ITelemetryLogger,\n    ): SocketReference {\n        const existingSocketReference = SocketReference.find(key, logger);\n        if (existingSocketReference) {\n            return existingSocketReference;\n        }\n\n        const query = enableMultiplexing ? undefined : { documentId, tenantId };\n\n        const socket = io(\n            url,\n            {\n                multiplex: false, // Don't rely on socket.io built-in multiplexing\n                query,\n                reconnection: false,\n                transports: [\"websocket\"],\n                timeout: timeoutMs,\n            });\n\n        return new SocketReference(key, socket);\n    }\n\n    /**\n     * @param socket - websocket to be used\n     * @param documentId - ID of the document\n     * @param details - details of the websocket connection\n     * @param socketReferenceKey - socket reference key\n     * @param enableMultiplexing - If the websocket is multiplexing multiple documents\n     */\n    private constructor(\n        socket: SocketIOClient.Socket,\n        documentId: string,\n        socketReference: SocketReference,\n        logger: ITelemetryLogger,\n        private readonly enableMultiplexing?: boolean,\n    ) {\n        super(socket, documentId, logger);\n        this.socketReference = socketReference;\n        this.requestOpsNoncePrefix = `${uuid()}-`;\n    }\n\n    /**\n     * Retrieves ops from PUSH\n     * @param from - inclusive\n     * @param to - exclusive\n     * @returns ops retrieved\n     */\n     public requestOps(from: number, to: number) {\n        // Given that to is exclusive, we should be asking for at least something!\n        assert(to > from, 0x272 /* \"empty request\" */);\n\n        // PUSH may disable this functionality\n        // back-compat: remove cast to any once latest version of IConnected is consumed\n        if ((this.details as any).supportedFeatures?.[feature_get_ops] !== true) {\n            return;\n        }\n\n        this.pushCallCounter++;\n        const nonce = `${this.requestOpsNoncePrefix}${this.pushCallCounter}`;\n        const start = performance.now();\n\n        // We may keep keep accumulating memory for nothing, if we are not getting responses.\n        // Note that we should not have overlapping requests, as DeltaManager allows only one\n        // outstanding request to storage, and that's the only way to get here.\n        // But requests could be cancelled, and thus overlapping requests might be in the picture\n        // If it happens, we do not care about stale requests.\n        // So track some number of requests, but log if we get too many in flight - that likely\n        // indicates an error somewhere.\n        if (this.getOpsMap.size >= 5) {\n            let time = start;\n            let key: string | undefined;\n            for (const [keyCandidate, value] of this.getOpsMap.entries()) {\n                if (value.start <= time || key === undefined) {\n                    time = value.start;\n                    key = keyCandidate;\n                }\n            }\n            const payloadToDelete = this.getOpsMap.get(key!)!;\n            this.logger.sendErrorEvent({\n                eventName: \"GetOpsTooMany\",\n                nonce,\n                from: payloadToDelete.from,\n                to: payloadToDelete.to,\n                length: payloadToDelete.to - payloadToDelete.from,\n                duration: performance.now() - payloadToDelete.start,\n            });\n            this.getOpsMap.delete(key!);\n        }\n        this.getOpsMap.set(\n            nonce,\n            {\n                start,\n                from,\n                to,\n            },\n        );\n        this.socket.emit(\"get_ops\", this.clientId, {\n            nonce,\n            from,\n            to: to - 1,\n        });\n    }\n\n    public async flush(): Promise<FlushResult> {\n        // back-compat: remove cast to any once latest version of IConnected is consumed\n        if ((this.details as any).supportedFeatures?.[feature_flush_ops] !== true) {\n            // Once single-commit summary is enabled end-to-end, flush support is a must!\n            // The only alternative is change in design where SPO fetches ops from PUSH OR\n            // summary includes required ops and SPO has some validation mechanism to ensure\n            // they are not forged by client.\n            // If design changes, we can reconsider it, but right now it's non-recoverable failure.\n            this.logger.sendErrorEvent({ eventName: \"FlushOpsNotSupported\" });\n            throw new Error(\"flush() API is not supported by PUSH, required for single-commit summaries\");\n        }\n\n        this.pushCallCounter++;\n        const nonce = `${this.requestOpsNoncePrefix}${this.pushCallCounter}`;\n        // There should be only one flush ops in flight, kicked out by upload summary workflow\n        // That said, it could timeout, and request could be repeated, so theoretically we can\n        // get overlapping requests, but it should be very rare\n        if (this.flushDeferred !== undefined) {\n            this.logger.sendErrorEvent({ eventName: \"FlushOpsTooMany\" });\n            this.flushDeferred.reject(\"process involving flush() was cancelled OR unsupported concurrency\");\n        }\n        this.socket.emit(\"flush_ops\", this.clientId, { nonce });\n\n        this.flushOpNonce = nonce;\n        this.flushDeferred = new Deferred<FlushResult>();\n        return this.flushDeferred.promise;\n    }\n\n    protected serverDisconnectHandler = (error: LoggingError & OdspError) => {\n        this.disposeCore(true, error);\n    };\n\n    protected async initialize(connectMessage: IConnect, timeout: number) {\n        if (this.enableMultiplexing) {\n            // multiplex compatible early handlers\n            this.earlyOpHandler = (messageDocumentId: string, msgs: ISequencedDocumentMessage[]) => {\n                if (this.documentId === messageDocumentId) {\n                    this.queuedMessages.push(...msgs);\n                }\n            };\n\n            this.earlySignalHandler = (msg: ISignalMessage, messageDocumentId?: string) => {\n                if (messageDocumentId === undefined || messageDocumentId === this.documentId) {\n                    this.queuedSignals.push(msg);\n                }\n            };\n        }\n\n        this.socketReference!.once(\"server_disconnect\", this.serverDisconnectHandler);\n\n        this.socket.on(\"get_ops_response\", (result: IGetOpsResponse) => {\n            const messages = result.messages;\n            const data = this.getOpsMap.get(result.nonce);\n            // Due to socket multiplexing, this client may not have asked for any data\n            // If so, there it most likely does not need these ops (otherwise it already asked for them)\n            // Also we may have deleted entry in this.getOpsMap due to too many requests and too slow response.\n            // But not processing such result may push us into infinite loop of fast requests and dropping all responses\n            if (data !== undefined || result.nonce.indexOf(this.requestOpsNoncePrefix) === 0) {\n                this.getOpsMap.delete(result.nonce);\n                const common = {\n                    eventName: \"GetOps\",\n                    // We need nonce only to pair with GetOpsTooMany events, i.e. when record was deleted\n                    nonce: data === undefined ? result.nonce : undefined,\n                    code: result.code,\n                    from: data?.from,\n                    to: data?.to,\n                    duration: data === undefined ? undefined : performance.now() - data.start,\n                };\n                if (messages !== undefined && messages.length > 0) {\n                    this.logger.sendPerformanceEvent({\n                        ...common,\n                        first: messages[0].sequenceNumber,\n                        last: messages[messages.length - 1].sequenceNumber,\n                        length: messages.length,\n                    });\n                    this.emit(\"op\", this.documentId, messages);\n                } else {\n                    this.logger.sendPerformanceEvent({\n                        ...common,\n                        length: 0,\n                    });\n                }\n            }\n        });\n\n        this.socket.on(\"flush_ops_response\", (result: IFlushOpsResponse) => {\n            if (this.flushOpNonce === result.nonce) {\n                const seq = result.lastPersistedSequenceNumber;\n                let category: \"generic\" | \"error\" = \"generic\";\n                if (result.lastPersistedSequenceNumber === undefined || result.code !== 200) {\n                    switch (result.code) {\n                        case 409:\n                        case 429:\n                            category = \"error\";\n                            break;\n                        case 204:\n                            break;\n                        default:\n                            category = \"error\";\n                            break;\n                    }\n                }\n                this.logger.sendTelemetryEvent({\n                    eventName: \"FlushResult\",\n                    code: result.code,\n                    sequenceNumber: seq,\n                    category,\n                });\n                this.flushDeferred!.resolve(result);\n                this.flushDeferred = undefined;\n                this.flushOpNonce = undefined;\n            }\n        });\n\n        await super.initialize(connectMessage, timeout);\n    }\n\n    protected addTrackedListener(event: string, listener: (...args: any[]) => void) {\n        // override some event listeners in order to support multiple documents/clients over the same websocket\n        switch (event) {\n            case \"op\":\n                // per document op handling\n                super.addTrackedListener(event, (documentId: string, msgs: ISequencedDocumentMessage[]) => {\n                    if (!this.enableMultiplexing || this.documentId === documentId) {\n                        listener(documentId, msgs);\n                    }\n                });\n                break;\n\n            case \"signal\":\n                // per document signal handling\n                super.addTrackedListener(event, (msg: ISignalMessage, documentId?: string) => {\n                    if (!this.enableMultiplexing || !documentId || documentId === this.documentId) {\n                        listener(msg, documentId);\n                    }\n                });\n                break;\n\n            case \"nack\":\n                // per client / document nack handling\n                super.addTrackedListener(event, (clientIdOrDocumentId: string, message: INack[]) => {\n                    if (clientIdOrDocumentId.length === 0 ||\n                        clientIdOrDocumentId === this.documentId ||\n                        (this.hasDetails && clientIdOrDocumentId === this.clientId)) {\n                        this.emit(\"nack\", clientIdOrDocumentId, message);\n                    }\n                });\n                break;\n\n            default:\n                super.addTrackedListener(event, listener);\n                break;\n        }\n    }\n\n    /**\n     * Disconnect from the websocket\n     */\n    protected disconnect(socketProtocolError: boolean, reason: any) {\n        const socket = this.socketReference;\n        assert(socket !== undefined, 0x0a2 /* \"reentrancy not supported!\" */);\n        this.socketReference = undefined;\n\n        this.socket.off(\"server_disconnect\", this.serverDisconnectHandler);\n\n        if (!socketProtocolError && this.hasDetails) {\n            // tell the server we are disconnecting this client from the document\n            this.socket.emit(\"disconnect_document\", this.clientId, this.documentId);\n        }\n\n        socket.removeSocketIoReference(socketProtocolError);\n        this.emit(\"disconnect\", reason);\n    }\n}\n"]}

package/lib/odspDocumentService.d.ts

@@ -39,7 +39,7 @@ export declare class OdspDocumentService implements IDocumentService {
      */
     static create(resolvedUrl: IResolvedUrl, getStorageToken: InstrumentedStorageTokenFetcher, getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined, logger: ITelemetryLogger, socketIoClientFactory: () => Promise<SocketIOClientStatic>, cache: IOdspCache, hostPolicy: HostStoragePolicy, epochTracker: EpochTracker, socketReferenceKeyPrefix?: string): Promise<IDocumentService>;
     private storageManager?;
-    private readonly logger;
+    private readonly mc;
     private readonly joinSessionKey;
     private readonly hostPolicy;
     private _opsCache?;

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;AAGtE,OAAO,EACH,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EAC3B,MAAM,oCAAoC,CAAC;AAG5C,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;AAOzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAexC;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,gBAAgB;aAoEpC,eAAe,EAAE,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAElC,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK;IAEtB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IA3E9C,OAAO,CAAC,SAAS,CAA2B;IAE5C;;;;;;;;;;;;;OAaG;WACiB,MAAM,CACtB,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,+BAA+B,EAChD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,SAAS,EACvF,MAAM,EAAE,gBAAgB,EACxB,qBAAqB,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,EAC1D,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,iBAAiB,EAC7B,YAAY,EAAE,YAAY,EAC1B,wBAAwB,CAAC,EAAE,MAAM,GAClC,OAAO,CAAC,gBAAgB,CAAC;IAc5B,OAAO,CAAC,cAAc,CAAC,CAA6B;IAEpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IAEzC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA4B;IAEvD,OAAO,CAAC,SAAS,CAAC,CAAW;IAE7B,OAAO,CAAC,iBAAiB,CAAC,CAA8B;IAExD;;;;;;;;;;;;;OAaG;IACH,OAAO;IAgCP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAuBjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IA+B3E;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;YAiEvE,WAAW;IAsBzB;;;;;;;;;;OAUG;YACW,6BAA6B;IAkCpC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAa1B,SAAS,KAAK,QAAQ,yBA8BrB;IAID,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB,EAAE;CAQzD"}
+{"version":3,"file":"odspDocumentService.d.ts","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAOtE,OAAO,EACH,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EAC3B,MAAM,oCAAoC,CAAC;AAG5C,OAAO,EACH,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EAEjB,iBAAiB,EACjB,+BAA+B,EAElC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAOzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAGxC;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,gBAAgB;aAoEpC,eAAe,EAAE,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAElC,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK;IAEtB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IA3E9C,OAAO,CAAC,SAAS,CAA2B;IAE5C;;;;;;;;;;;;;OAaG;WACiB,MAAM,CACtB,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,+BAA+B,EAChD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,SAAS,EACvF,MAAM,EAAE,gBAAgB,EACxB,qBAAqB,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,EAC1D,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,iBAAiB,EAC7B,YAAY,EAAE,YAAY,EAC1B,wBAAwB,CAAC,EAAE,MAAM,GAClC,OAAO,CAAC,gBAAgB,CAAC;IAc5B,OAAO,CAAC,cAAc,CAAC,CAA6B;IAEpD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA4B;IAEvD,OAAO,CAAC,SAAS,CAAC,CAAW;IAE7B,OAAO,CAAC,iBAAiB,CAAC,CAA8B;IAExD;;;;;;;;;;;;;OAaG;IACH,OAAO;IAkCP,IAAW,WAAW,IAAI,YAAY,CAErC;IACD,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAuBjE;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IA+B3E;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;YAoEvE,WAAW;IAsBzB;;;;;;;;;;OAUG;YACW,6BAA6B;IAkCpC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG;IAa1B,SAAS,KAAK,QAAQ,yBA8BrB;IAID,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB,EAAE;CAQzD"}

package/lib/odspDocumentService.js

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 import { performance } from "@fluidframework/common-utils";
-import { ChildLogger } from "@fluidframework/telemetry-utils";
-import { DeltaStreamConnectionForbiddenError } from "@fluidframework/driver-utils";
-import { fetchTokenErrorCode, throwOdspNetworkError } from "@fluidframework/odsp-doclib-utils";
+import { ChildLogger, loggerToMonitoringContext, } from "@fluidframework/telemetry-utils";
+import { DeltaStreamConnectionForbiddenError, NonRetryableError } from "@fluidframework/driver-utils";
+import { OdspErrorType, } from "@fluidframework/odsp-driver-definitions";
 import { OdspDeltaStorageService, OdspDeltaStorageWithCache } from "./odspDeltaStorageService";
 import { OdspDocumentDeltaConnection } from "./odspDocumentDeltaConnection";
 import { OdspDocumentStorageService } from "./odspDocumentStorageManager";
@@ -14,18 +14,6 @@ import { fetchJoinSession } from "./vroom";
 import { isOdcOrigin } from "./odspUrlHelper";
 import { OpsCache } from "./opsCaching";
 import { RetryErrorsStorageAdapter } from "./retryErrorsStorageAdapter";
-// Gate that when set to "1", instructs to fetch the binary format snapshot from the spo.
-function gatesBinaryFormatSnapshot() {
-    try {
-        if (typeof localStorage === "object" && localStorage !== null) {
-            if (localStorage.binaryFormatSnapshot === "1") {
-                return true;
-            }
-        }
-    }
-    catch (e) { }
-    return false;
-}
 /**
  * The DocumentService manages the Socket.IO connection and manages routing requests to connected
  * clients
@@ -60,13 +48,13 @@ export class OdspDocumentService {
             storageOnly: odspResolvedUrl.fileVersion !== undefined,
         };
         this.joinSessionKey = `${this.odspResolvedUrl.hashedDocumentId}/joinsession`;
-        this.logger = ChildLogger.create(logger, undefined, {
+        this.mc = loggerToMonitoringContext(ChildLogger.create(logger, undefined, {
             all: {
                 odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),
             },
-        });
+        }));
         this.hostPolicy = hostPolicy;
-        (_a = (_b = this.hostPolicy).fetchBinarySnapshotFormat) !== null && _a !== void 0 ? _a : (_b.fetchBinarySnapshotFormat = gatesBinaryFormatSnapshot());
+        (_a = (_b = this.hostPolicy).fetchBinarySnapshotFormat) !== null && _a !== void 0 ? _a : (_b.fetchBinarySnapshotFormat = this.mc.config.getBoolean("Fluid.Driver.Odsp.binaryFormatSnapshot"));
         if (this.odspResolvedUrl.summarizer) {
             this.hostPolicy = Object.assign(Object.assign({}, this.hostPolicy), { summarizerClient: true });
         }
@@ -101,7 +89,7 @@ export class OdspDocumentService {
      */
     async connectToStorage() {
         if (!this.storageManager) {
-            this.storageManager = new OdspDocumentStorageService(this.odspResolvedUrl, this.getStorageToken, this.logger, true, this.cache, this.hostPolicy, this.epochTracker, 
+            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) {
@@ -110,7 +98,7 @@ export class OdspDocumentService {
                 throw new Error("Disconnected while uploading summary (attempt to perform flush())");
             });
         }
-        return new RetryErrorsStorageAdapter(this.storageManager, this.logger);
+        return new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);
     }
     /**
      * Connects to a delta storage endpoint for getting ops between a range.
@@ -120,11 +108,11 @@ export class OdspDocumentService {
     async connectToDeltaStorage() {
         var _a, _b, _c, _d;
         const snapshotOps = (_b = (_a = this.storageManager) === null || _a === void 0 ? void 0 : _a.ops) !== null && _b !== void 0 ? _b : [];
-        const service = new OdspDeltaStorageService(this.odspResolvedUrl.endpoints.deltaStorageUrl, this.getStorageToken, this.epochTracker, this.logger);
+        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 = (_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.logger, batchSize, concurrency, async (from, to, telemetryProps) => service.get(from, to, telemetryProps), async (from, to) => {
+        return new OdspDeltaStorageWithCache(snapshotOps, this.mc.logger, batchSize, concurrency, async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason), 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 : [];
@@ -175,7 +163,7 @@ export class OdspDocumentService {
             ]);
             const finalWebsocketToken = websocketToken !== null && websocketToken !== void 0 ? websocketToken : (websocketEndpoint.socketToken || null);
             if (finalWebsocketToken === null) {
-                throwOdspNetworkError("pushTokenIsNull", fetchTokenErrorCode);
+                throw new NonRetryableError("pushTokenIsNull", "Websocket token is null", OdspErrorType.fetchTokenError);
             }
             try {
                 const connection = await this.connectToDeltaStreamWithRetry(websocketEndpoint.tenantId, websocketEndpoint.id, finalWebsocketToken, io, client, websocketEndpoint.deltaStreamSocketUrl);
@@ -197,7 +185,7 @@ export class OdspDocumentService {
     async joinSession(requestSocketToken, options) {
         const executeFetch = async () => {
             var _a;
-            return fetchJoinSession(this.odspResolvedUrl, "opStream/joinSession", "POST", this.logger, this.getStorageToken, this.epochTracker, requestSocketToken, options, (_a = this.hostPolicy.sessionOptions) === null || _a === void 0 ? void 0 : _a.unauthenticatedUserDisplayName);
+            return fetchJoinSession(this.odspResolvedUrl, "opStream/joinSession", "POST", this.mc.logger, this.getStorageToken, this.epochTracker, requestSocketToken, options, (_a = this.hostPolicy.sessionOptions) === null || _a === void 0 ? void 0 : _a.unauthenticatedUserDisplayName);
         };
         // Note: The sessionCache is configured with a sliding expiry of 1 hour,
         // so if we've fetched the join session within the last hour we won't run executeFetch again now.
@@ -216,13 +204,13 @@ export class OdspDocumentService {
      */
     async connectToDeltaStreamWithRetry(tenantId, documentId, token, io, client, webSocketUrl) {
         const startTime = performance.now();
-        const connection = await OdspDocumentDeltaConnection.create(tenantId, documentId, token, io, client, webSocketUrl, this.logger, 60000, this.epochTracker, this.socketReferenceKeyPrefix);
+        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.logger.sendPerformanceEvent({
+            this.mc.logger.sendPerformanceEvent({
                 eventName: "ConnectionSuccess",
                 duration,
             });
@@ -256,7 +244,7 @@ export class OdspDocumentService {
         const opsKey = {
             type: "ops",
         };
-        this._opsCache = new OpsCache(seqNumber, this.logger, 
+        this._opsCache = new OpsCache(seqNumber, this.mc.logger, 
         // ICache
         {
             write: async (key, opsData) => {

package/lib/odspDocumentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentService.js","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAmB,MAAM,iCAAiC,CAAC;AAS/E,OAAO,EAAE,mCAAmC,EAAE,MAAM,8BAA8B,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAe,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAc5G,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;AAExE,yFAAyF;AACzF,SAAS,yBAAyB;IAC9B,IAAI;QACA,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,EAAE;YAC3D,IAAK,YAAY,CAAC,oBAAoB,KAAK,GAAG,EAAE;gBAC5C,OAAO,IAAI,CAAC;aACf;SACJ;KACJ;IAAC,OAAO,CAAC,EAAE,GAAE;IACd,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAqD5B;;;;;;;;;;;;;OAaG;IACH,YACoB,eAAiC,EAChC,eAAgD,EAChD,iBAAuF,EACxG,MAAwB,EACP,qBAA0D,EAC1D,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC;;;QARlC,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAAsE;QAEvF,0BAAqB,GAArB,qBAAqB,CAAqC;QAC1D,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QAElD,IAAI,CAAC,SAAS,GAAG;YACb,2DAA2D;YAC3D,WAAW,EAAE,eAAe,CAAC,WAAW,KAAK,SAAS;SACzD,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,cAAc,CAAC;QAC7E,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EACnC,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;QAEP,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,YAAA,IAAI,CAAC,UAAU,EAAC,yBAAyB,uCAAzB,yBAAyB,GAAK,yBAAyB,EAAE,EAAC;QAC1E,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACjC,IAAI,CAAC,UAAU,mCAAQ,IAAI,CAAC,UAAU,KAAE,gBAAgB,EAAE,IAAI,GAAE,CAAC;SACpE;IACL,CAAC;IA9FD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,WAAyB,EACzB,eAAgD,EAChD,iBAAuF,EACvF,MAAwB,EACxB,qBAA0D,EAC1D,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC;QAEjC,OAAO,IAAI,mBAAmB,CAC1B,kBAAkB,CAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,qBAAqB,EACrB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,CAC3B,CAAC;IACN,CAAC;IA4DD,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,MAAM,EACX,IAAI,EACJ,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,YAAY;YACjB,gBAAgB;YAChB,KAAK,IAAI,EAAE;gBACP,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;oBAC1E,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;iBACzC;gBACD,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;YACzF,CAAC,CACJ,CAAC;SACL;QAED,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB;;QAC9B,MAAM,WAAW,eAAG,IAAI,CAAC,cAAc,0CAAE,GAAG,mCAAI,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,uBAAuB,CACvC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,EAC9C,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,MAAM,CACd,CAAC;QAEF,kEAAkE;QAClE,MAAM,SAAS,SAAG,IAAI,CAAC,UAAU,CAAC,YAAY,mCAAI,IAAI,CAAC;QACvD,MAAM,WAAW,SAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,CAAC,CAAC;QAC9D,OAAO,IAAI,yBAAyB,CAChC,WAAW,EACX,IAAI,CAAC,MAAM,EACX,SAAS,EACT,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,CAAC,EACzE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;;YACf,MAAM,GAAG,GAAG,aAAM,IAAI,CAAC,QAAQ,0CAAE,GAAG,CAAC,IAAI,EAAE,EAAE,EAAC,CAAC;YAC/C,aAAO,GAAkC,mCAAI,EAAE,CAAC;QACpD,CAAC,EACD,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;YACT,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBAC1E,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC/C;QACL,CAAC,EACD,CAAC,GAAgC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAC7C,2DAA2D;QAC3D,OAAO,2BAA2B,CAA2B,KAAK,EAAE,OAAO,EAAE,EAAE;YAC3E,wFAAwF;YACxF,8EAA8E;YAC9E,MAAM,oCAAoC,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS,CAAC;YAClF,MAAM,qBAAqB,GAAG,oCAAoC;gBAC9D,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBACvB,CAAC,CAAC,IAAI,CAAC,iBAAkB,CAAC,OAAO,CAAC,CAAC;YAEvC,MAAM,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACnG,MAAM,gBAAgB,GAAG,CAAgB,CAAC;gBAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;oBAC5C,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,UAAU,EAAE;wBAC5C,QAAQ,IAAI,EAAE;4BACV,KAAK,kCAAkC,CAAC;4BACxC,KAAK,4CAA4C,CAAC;4BAClD,KAAK,mCAAmC;gCACpC,yDAAyD;gCACzD,yCAAyC;gCACzC,8CAA8C;gCAC9C,IAAI,CAAC,SAAS,mCAAO,IAAI,CAAC,SAAS,KAAC,WAAW,EAAE,IAAI,GAAC,CAAC;gCACvD,MAAM,IAAI,mCAAmC,CAAC,IAAI,CAAC,CAAC;4BACxD;gCACI,SAAS;yBAChB;qBACJ;iBACJ;gBACD,MAAM,CAAC,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,iBAAiB,EAAE,cAAc,EAAE,EAAE,CAAC,GACzC,MAAM,OAAO,CAAC,GAAG,CAAC;gBACd,kBAAkB;gBAClB,qBAAqB;gBACrB,IAAI,CAAC,qBAAqB,EAAE;aAC/B,CAAC,CAAC;YAEP,MAAM,mBAAmB,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,CAAC,iBAAiB,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC;YACtF,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,qBAAqB,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;aACjE;YACD,IAAI;gBACA,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,6BAA6B,CACvD,iBAAiB,CAAC,QAAQ,EAC1B,iBAAiB,CAAC,EAAE,EACpB,mBAAmB,EACnB,EAAE,EACF,MAAM,EACN,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;gBAC5C,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,GAAgC,EAAE,EAAE;oBACjE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;gBACpC,OAAO,UAAU,CAAC;aACrB;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;oBAC7C,KAAK,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,EAAE,CAAC;iBACjD;gBACD,MAAM,KAAK,CAAC;aACf;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,WAAW,CACrB,kBAA2B,EAC3B,OAA4B;QAE5B,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;;YAC5B,OAAA,gBAAgB,CACZ,IAAI,CAAC,eAAe,EACpB,sBAAsB,EACtB,MAAM,EACN,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,kBAAkB,EAClB,OAAO,QACP,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,8BAA8B,CACjE,CAAA;SAAA,CAAC;QAEN,wEAAwE;QACxE,iGAAiG;QACjG,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,6BAA6B,CACvC,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAAwB,EACxB,MAAe,EACf,YAAoB;QAEpB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,MAAM,2BAA2B,CAAC,MAAM,CACvD,QAAQ,EACR,UAAU,EACV,KAAK,EACL,EAAE,EACF,MAAM,EACN,YAAY,EACZ,IAAI,CAAC,MAAM,EACX,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,MAAM,CAAC,oBAAoB,CAAC;gBAC7B,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ;aACX,CAAC,CAAC;SACN;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,KAAW;;QACtB,4EAA4E;QAC5E,8CAA8C;QAC9C,wFAAwF;QACxF,kEAAkE;QAClE,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SACrD;aAAM;YACH,MAAA,IAAI,CAAC,SAAS,0CAAE,QAAQ,GAAG;SAC9B;QACD,MAAA,IAAI,CAAC,SAAS,0CAAE,OAAO,GAAG;IAC9B,CAAC;IAED,IAAc,QAAQ;;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,IAAI,CAAC,SAAS,CAAC;SACzB;QAED,MAAM,SAAS,SAAG,IAAI,CAAC,cAAc,0CAAE,sBAAsB,CAAC;QAC9D,MAAM,SAAS,eAAG,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,SAAS,mCAAI,GAAG,CAAC;QAC/D,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC1C,OAAO;SACV;QAED,MAAM,MAAM,GAAwB;YAChC,IAAI,EAAE,KAAK;SACd,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CACzB,SAAS,EACT,IAAI,CAAC,MAAM;QACX,SAAS;QACT;YACI,KAAK,EAAE,KAAK,EAAE,GAAW,EAAE,OAAe,EAAE,EAAE;gBAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAK,MAAM,KAAE,GAAG,KAAG,OAAO,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAK,MAAM,KAAE,GAAG,IAAE;YAC5E,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/E,EACD,SAAS,cACT,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,gBAAgB,mCAAI,IAAI,cACpD,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,eAAe,mCAAI,IAAI,CACtD,CAAC;QACF,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,mHAAmH;IACnH,8EAA8E;IACpE,WAAW,CAAC,GAAgC;;QAClD,2CAA2C;QAC3C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACrD,OAAO;SACV;QAED,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC,GAAG,EAAE;IAC/B,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { performance } from \"@fluidframework/common-utils\";\nimport { ChildLogger, TelemetryLogger } from \"@fluidframework/telemetry-utils\";\nimport {\n    IDocumentDeltaConnection,\n    IDocumentDeltaStorageService,\n    IDocumentService,\n    IResolvedUrl,\n    IDocumentStorageService,\n    IDocumentServicePolicies,\n} from \"@fluidframework/driver-definitions\";\nimport { DeltaStreamConnectionForbiddenError } from \"@fluidframework/driver-utils\";\nimport { fetchTokenErrorCode, IFacetCodes, throwOdspNetworkError } from \"@fluidframework/odsp-doclib-utils\";\nimport {\n    IClient,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    IEntry,\n    HostStoragePolicy,\n    InstrumentedStorageTokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { HostStoragePolicyInternal, ISocketStorageDiscovery } from \"./contracts\";\nimport { IOdspCache } from \"./odspCache\";\nimport { OdspDeltaStorageService, OdspDeltaStorageWithCache } from \"./odspDeltaStorageService\";\nimport { OdspDocumentDeltaConnection } from \"./odspDocumentDeltaConnection\";\nimport { OdspDocumentStorageService } from \"./odspDocumentStorageManager\";\nimport { getWithRetryForTokenRefresh, getOdspResolvedUrl, TokenFetchOptionsEx } from \"./odspUtils\";\nimport { fetchJoinSession } from \"./vroom\";\nimport { isOdcOrigin } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OpsCache } from \"./opsCaching\";\nimport { RetryErrorsStorageAdapter } from \"./retryErrorsStorageAdapter\";\n\n// Gate that when set to \"1\", instructs to fetch the binary format snapshot from the spo.\nfunction gatesBinaryFormatSnapshot() {\n    try {\n        if (typeof localStorage === \"object\" && localStorage !== null) {\n            if  (localStorage.binaryFormatSnapshot === \"1\") {\n                return true;\n            }\n        }\n    } catch (e) {}\n    return false;\n}\n\n/**\n * The DocumentService manages the Socket.IO connection and manages routing requests to connected\n * clients\n */\nexport class OdspDocumentService implements IDocumentService {\n    private _policies: IDocumentServicePolicies;\n\n    /**\n     * @param resolvedUrl - resolved url identifying document that will be managed by returned service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - This host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by returned service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    public static async create(\n        resolvedUrl: IResolvedUrl,\n        getStorageToken: InstrumentedStorageTokenFetcher,\n        getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        socketIoClientFactory: () => Promise<SocketIOClientStatic>,\n        cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix?: string,\n    ): Promise<IDocumentService> {\n        return new OdspDocumentService(\n            getOdspResolvedUrl(resolvedUrl),\n            getStorageToken,\n            getWebsocketToken,\n            logger,\n            socketIoClientFactory,\n            cache,\n            hostPolicy,\n            epochTracker,\n            socketReferenceKeyPrefix,\n        );\n    }\n\n    private storageManager?: OdspDocumentStorageService;\n\n    private readonly logger: TelemetryLogger;\n\n    private readonly joinSessionKey: string;\n\n    private readonly hostPolicy: HostStoragePolicyInternal;\n\n    private _opsCache?: OpsCache;\n\n    private currentConnection?: OdspDocumentDeltaConnection;\n\n    /**\n     * @param odspResolvedUrl - resolved url identifying document that will be managed by this service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by this service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    private constructor(\n        public readonly odspResolvedUrl: IOdspResolvedUrl,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        private readonly getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        private readonly socketIoClientFactory: () => Promise<SocketIOClientStatic>,\n        private readonly cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        private readonly epochTracker: EpochTracker,\n        private readonly socketReferenceKeyPrefix?: string,\n    ) {\n        this._policies = {\n            // load in storage-only mode if a file version is specified\n            storageOnly: odspResolvedUrl.fileVersion !== undefined,\n        };\n\n        this.joinSessionKey = `${this.odspResolvedUrl.hashedDocumentId}/joinsession`;\n        this.logger = ChildLogger.create(logger,\n            undefined,\n            {\n                all: {\n                    odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),\n                },\n            });\n\n        this.hostPolicy = hostPolicy;\n        this.hostPolicy.fetchBinarySnapshotFormat ??= gatesBinaryFormatSnapshot();\n        if (this.odspResolvedUrl.summarizer) {\n            this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };\n        }\n    }\n\n    public get resolvedUrl(): IResolvedUrl {\n        return this.odspResolvedUrl;\n    }\n    public get policies() {\n        return this._policies;\n    }\n\n    /**\n     * Connects to a storage endpoint for snapshot service.\n     *\n     * @returns returns the document storage service for sharepoint driver.\n     */\n    public async connectToStorage(): Promise<IDocumentStorageService> {\n        if (!this.storageManager) {\n            this.storageManager = new OdspDocumentStorageService(\n                this.odspResolvedUrl,\n                this.getStorageToken,\n                this.logger,\n                true,\n                this.cache,\n                this.hostPolicy,\n                this.epochTracker,\n                // flushCallback\n                async () => {\n                    if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                        return this.currentConnection.flush();\n                    }\n                    throw new Error(\"Disconnected while uploading summary (attempt to perform flush())\");\n                },\n            );\n        }\n\n        return new RetryErrorsStorageAdapter(this.storageManager, this.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.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.logger,\n            batchSize,\n            concurrency,\n            async (from, to, telemetryProps) => service.get(from, to, telemetryProps),\n            async (from, to) => {\n                const res = await this.opsCache?.get(from, to);\n                return res as ISequencedDocumentMessage[] ?? [];\n            },\n            (from, to) => {\n                if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                    this.currentConnection.requestOps(from, to);\n                }\n            },\n            (ops: ISequencedDocumentMessage[]) => this.opsReceived(ops),\n        );\n    }\n\n    /**\n     * Connects to a delta stream endpoint for emitting ops.\n     *\n     * @returns returns the document delta stream service for onedrive/sharepoint driver.\n     */\n    public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {\n        // Attempt to connect twice, in case we used expired token.\n        return getWithRetryForTokenRefresh<IDocumentDeltaConnection>(async (options) => {\n            // Presence of getWebsocketToken callback dictates whether callback is used for fetching\n            // websocket token or whether it is returned with joinSession response payload\n            const requestWebsocketTokenFromJoinSession = this.getWebsocketToken === undefined;\n            const websocketTokenPromise = requestWebsocketTokenFromJoinSession\n                ? Promise.resolve(null)\n                : this.getWebsocketToken!(options);\n\n            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options).catch((e) => {\n                const likelyFacetCodes = e as IFacetCodes;\n                if (Array.isArray(likelyFacetCodes.facetCodes)) {\n                    for (const code of likelyFacetCodes.facetCodes) {\n                        switch (code) {\n                            case \"sessionForbiddenOnPreservedFiles\":\n                            case \"sessionForbiddenOnModerationEnabledLibrary\":\n                            case \"sessionForbiddenOnRequireCheckout\":\n                                // This document can only be opened in storage-only mode.\n                                // DeltaManager will recognize this error\n                                // and load without a delta stream connection.\n                                this._policies = {...this._policies,storageOnly: true};\n                                throw new DeltaStreamConnectionForbiddenError(code);\n                            default:\n                                continue;\n                        }\n                    }\n                }\n                throw e;\n            });\n\n            const [websocketEndpoint, websocketToken, io] =\n                await Promise.all([\n                    joinSessionPromise,\n                    websocketTokenPromise,\n                    this.socketIoClientFactory(),\n                ]);\n\n            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken || null);\n            if (finalWebsocketToken === null) {\n                throwOdspNetworkError(\"pushTokenIsNull\", fetchTokenErrorCode);\n            }\n            try {\n                const connection = await this.connectToDeltaStreamWithRetry(\n                    websocketEndpoint.tenantId,\n                    websocketEndpoint.id,\n                    finalWebsocketToken,\n                    io,\n                    client,\n                    websocketEndpoint.deltaStreamSocketUrl);\n                connection.on(\"op\", (documentId, ops: ISequencedDocumentMessage[]) => {\n                    this.opsReceived(ops);\n                });\n                this.currentConnection = connection;\n                return connection;\n            } catch (error) {\n                this.cache.sessionJoinCache.remove(this.joinSessionKey);\n                if (typeof error === \"object\" && error !== null) {\n                    error.socketDocumentId = websocketEndpoint.id;\n                }\n                throw error;\n            }\n        });\n    }\n\n    private async joinSession(\n        requestSocketToken: boolean,\n        options: TokenFetchOptionsEx,\n    ): Promise<ISocketStorageDiscovery> {\n        const executeFetch = async () =>\n            fetchJoinSession(\n                this.odspResolvedUrl,\n                \"opStream/joinSession\",\n                \"POST\",\n                this.logger,\n                this.getStorageToken,\n                this.epochTracker,\n                requestSocketToken,\n                options,\n                this.hostPolicy.sessionOptions?.unauthenticatedUserDisplayName,\n            );\n\n        // Note: The sessionCache is configured with a sliding expiry of 1 hour,\n        // so if we've fetched the join session within the last hour we won't run executeFetch again now.\n        return this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);\n    }\n\n    /**\n     * Connects to a delta stream endpoint\n     * If url #1 fails to connect, tries url #2 if applicable\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for storage service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param webSocketUrl - websocket URL\n     */\n    private async connectToDeltaStreamWithRetry(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: SocketIOClientStatic,\n        client: IClient,\n        webSocketUrl: string,\n    ): Promise<OdspDocumentDeltaConnection> {\n        const startTime = performance.now();\n        const connection = await OdspDocumentDeltaConnection.create(\n            tenantId,\n            documentId,\n            token,\n            io,\n            client,\n            webSocketUrl,\n            this.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.logger.sendPerformanceEvent({\n                eventName: \"ConnectionSuccess\",\n                duration,\n            });\n        }\n        return connection;\n    }\n\n    public dispose(error?: any) {\n        // Error might indicate mismatch between client & server knowlege about file\n        // (DriverErrorType.fileOverwrittenInStorage).\n        // For example, file might have been overwritten in storage without generating new epoch\n        // In such case client cached info is stale and has to be removed.\n        if (error !== undefined) {\n            this.epochTracker.removeEntries().catch(() => {});\n        } else {\n            this._opsCache?.flushOps();\n        }\n        this._opsCache?.dispose();\n    }\n\n    protected get opsCache() {\n        if (this._opsCache) {\n            return this._opsCache;\n        }\n\n        const seqNumber = this.storageManager?.snapshotSequenceNumber;\n        const batchSize = this.hostPolicy.opsCaching?.batchSize ?? 100;\n        if (seqNumber === undefined || batchSize < 1) {\n            return;\n        }\n\n        const opsKey: Omit<IEntry, \"key\"> = {\n            type: \"ops\",\n        };\n        this._opsCache = new OpsCache(\n            seqNumber,\n            this.logger,\n            // ICache\n            {\n                write: async (key: string, opsData: string) => {\n                    return this.cache.persistedCache.put({...opsKey, key}, opsData);\n                },\n                read: async (key: string) => this.cache.persistedCache.get({...opsKey, key}),\n                remove: () => { this.cache.persistedCache.removeEntries().catch(() => {}); },\n            },\n            batchSize,\n            this.hostPolicy.opsCaching?.timerGranularity ?? 5000,\n            this.hostPolicy.opsCaching?.totalOpsToCache ?? 5000,\n        );\n        return this._opsCache;\n    }\n\n    // Called whenever re receive ops through any channel for this document (snapshot, delta connection, delta storage)\n    // We use it to notify caching layer of how stale is snapshot stored in cache.\n    protected opsReceived(ops: ISequencedDocumentMessage[]) {\n        // No need for two clients to save same ops\n        if (ops.length === 0 || this.odspResolvedUrl.summarizer) {\n            return;\n        }\n\n        this.opsCache?.addOps(ops);\n    }\n}\n"]}
+{"version":3,"file":"odspDocumentService.js","sourceRoot":"","sources":["../src/odspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EACH,WAAW,EACX,yBAAyB,GAE5B,MAAM,iCAAiC,CAAC;AASzC,OAAO,EAAE,mCAAmC,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAMtG,OAAO,EAMH,aAAa,GAChB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAuB,MAAM,aAAa,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAqD5B;;;;;;;;;;;;;OAaG;IACH,YACoB,eAAiC,EAChC,eAAgD,EAChD,iBAAuF,EACxG,MAAwB,EACP,qBAA0D,EAC1D,KAAiB,EAClC,UAA6B,EACZ,YAA0B,EAC1B,wBAAiC;;;QARlC,oBAAe,GAAf,eAAe,CAAkB;QAChC,oBAAe,GAAf,eAAe,CAAiC;QAChD,sBAAiB,GAAjB,iBAAiB,CAAsE;QAEvF,0BAAqB,GAArB,qBAAqB,CAAqC;QAC1D,UAAK,GAAL,KAAK,CAAY;QAEjB,iBAAY,GAAZ,YAAY,CAAc;QAC1B,6BAAwB,GAAxB,wBAAwB,CAAS;QAElD,IAAI,CAAC,SAAS,GAAG;YACb,2DAA2D;YAC3D,WAAW,EAAE,eAAe,CAAC,WAAW,KAAK,SAAS;SACzD,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,cAAc,CAAC;QAC7E,IAAI,CAAC,EAAE,GAAG,yBAAyB,CAC/B,WAAW,CAAC,MAAM,CAAC,MAAM,EACzB,SAAS,EACT;YACI,GAAG,EAAE;gBACD,GAAG,EAAE,WAAW,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;aACtF;SACJ,CAAC,CAAC,CAAC;QAER,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,YAAA,IAAI,CAAC,UAAU,EAAC,yBAAyB,uCAAzB,yBAAyB,GACrC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,wCAAwC,CAAC,EAAC;QACxE,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACjC,IAAI,CAAC,UAAU,mCAAQ,IAAI,CAAC,UAAU,KAAE,gBAAgB,EAAE,IAAI,GAAE,CAAC;SACpE;IACL,CAAC;IAhGD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,WAAyB,EACzB,eAAgD,EAChD,iBAAuF,EACvF,MAAwB,EACxB,qBAA0D,EAC1D,KAAiB,EACjB,UAA6B,EAC7B,YAA0B,EAC1B,wBAAiC;QAEjC,OAAO,IAAI,mBAAmB,CAC1B,kBAAkB,CAAC,WAAW,CAAC,EAC/B,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,qBAAqB,EACrB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,wBAAwB,CAC3B,CAAC;IACN,CAAC;IA8DD,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QACzB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACtB,IAAI,CAAC,cAAc,GAAG,IAAI,0BAA0B,CAChD,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,IAAI,EACJ,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,YAAY;YACjB,gBAAgB;YAChB,KAAK,IAAI,EAAE;gBACP,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;oBAC1E,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;iBACzC;gBACD,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;YACzF,CAAC,CACJ,CAAC;SACL;QAED,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB;;QAC9B,MAAM,WAAW,eAAG,IAAI,CAAC,cAAc,0CAAE,GAAG,mCAAI,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,uBAAuB,CACvC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,EAC9C,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,EAAE,CAAC,MAAM,CACjB,CAAC;QAEF,kEAAkE;QAClE,MAAM,SAAS,SAAG,IAAI,CAAC,UAAU,CAAC,YAAY,mCAAI,IAAI,CAAC;QACvD,MAAM,WAAW,SAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,CAAC,CAAC;QAC9D,OAAO,IAAI,yBAAyB,CAChC,WAAW,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,SAAS,EACT,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,WAAW,CAAC,EACnG,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;;YACf,MAAM,GAAG,GAAG,aAAM,IAAI,CAAC,QAAQ,0CAAE,GAAG,CAAC,IAAI,EAAE,EAAE,EAAC,CAAC;YAC/C,aAAO,GAAkC,mCAAI,EAAE,CAAC;QACpD,CAAC,EACD,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;YACT,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBAC1E,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC/C;QACL,CAAC,EACD,CAAC,GAAgC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAC7C,2DAA2D;QAC3D,OAAO,2BAA2B,CAA2B,KAAK,EAAE,OAAO,EAAE,EAAE;YAC3E,wFAAwF;YACxF,8EAA8E;YAC9E,MAAM,oCAAoC,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS,CAAC;YAClF,MAAM,qBAAqB,GAAG,oCAAoC;gBAC9D,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBACvB,CAAC,CAAC,IAAI,CAAC,iBAAkB,CAAC,OAAO,CAAC,CAAC;YAEvC,MAAM,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACnG,MAAM,gBAAgB,GAAG,CAAgB,CAAC;gBAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;oBAC5C,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,UAAU,EAAE;wBAC5C,QAAQ,IAAI,EAAE;4BACV,KAAK,kCAAkC,CAAC;4BACxC,KAAK,4CAA4C,CAAC;4BAClD,KAAK,mCAAmC;gCACpC,yDAAyD;gCACzD,yCAAyC;gCACzC,8CAA8C;gCAC9C,IAAI,CAAC,SAAS,mCAAO,IAAI,CAAC,SAAS,KAAC,WAAW,EAAE,IAAI,GAAC,CAAC;gCACvD,MAAM,IAAI,mCAAmC,CAAC,IAAI,CAAC,CAAC;4BACxD;gCACI,SAAS;yBAChB;qBACJ;iBACJ;gBACD,MAAM,CAAC,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,iBAAiB,EAAE,cAAc,EAAE,EAAE,CAAC,GACzC,MAAM,OAAO,CAAC,GAAG,CAAC;gBACd,kBAAkB;gBAClB,qBAAqB;gBACrB,IAAI,CAAC,qBAAqB,EAAE;aAC/B,CAAC,CAAC;YAEP,MAAM,mBAAmB,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,CAAC,iBAAiB,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC;YACtF,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,MAAM,IAAI,iBAAiB,CACvB,iBAAiB,EACjB,yBAAyB,EACzB,aAAa,CAAC,eAAe,CAAC,CAAC;aACtC;YACD,IAAI;gBACA,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,6BAA6B,CACvD,iBAAiB,CAAC,QAAQ,EAC1B,iBAAiB,CAAC,EAAE,EACpB,mBAAmB,EACnB,EAAE,EACF,MAAM,EACN,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;gBAC5C,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,GAAgC,EAAE,EAAE;oBACjE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;gBACpC,OAAO,UAAU,CAAC;aACrB;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;oBAC7C,KAAK,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,EAAE,CAAC;iBACjD;gBACD,MAAM,KAAK,CAAC;aACf;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,WAAW,CACrB,kBAA2B,EAC3B,OAA4B;QAE5B,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;;YAC5B,OAAA,gBAAgB,CACZ,IAAI,CAAC,eAAe,EACpB,sBAAsB,EACtB,MAAM,EACN,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,EACjB,kBAAkB,EAClB,OAAO,QACP,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,8BAA8B,CACjE,CAAA;SAAA,CAAC;QAEN,wEAAwE;QACxE,iGAAiG;QACjG,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,6BAA6B,CACvC,QAAgB,EAChB,UAAkB,EAClB,KAAoB,EACpB,EAAwB,EACxB,MAAe,EACf,YAAoB;QAEpB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,MAAM,2BAA2B,CAAC,MAAM,CACvD,QAAQ,EACR,UAAU,EACV,KAAK,EACL,EAAE,EACF,MAAM,EACN,YAAY,EACZ,IAAI,CAAC,EAAE,CAAC,MAAM,EACd,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,wBAAwB,CAChC,CAAC;QACF,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAC/C,uEAAuE;QACvE,+EAA+E;QAC/E,sDAAsD;QACtD,IAAI,QAAQ,IAAI,IAAI,EAAE;YAClB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAChC,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ;aACX,CAAC,CAAC;SACN;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,KAAW;;QACtB,4EAA4E;QAC5E,8CAA8C;QAC9C,wFAAwF;QACxF,kEAAkE;QAClE,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SACrD;aAAM;YACH,MAAA,IAAI,CAAC,SAAS,0CAAE,QAAQ,GAAG;SAC9B;QACD,MAAA,IAAI,CAAC,SAAS,0CAAE,OAAO,GAAG;IAC9B,CAAC;IAED,IAAc,QAAQ;;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,IAAI,CAAC,SAAS,CAAC;SACzB;QAED,MAAM,SAAS,SAAG,IAAI,CAAC,cAAc,0CAAE,sBAAsB,CAAC;QAC9D,MAAM,SAAS,eAAG,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,SAAS,mCAAI,GAAG,CAAC;QAC/D,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC1C,OAAO;SACV;QAED,MAAM,MAAM,GAAwB;YAChC,IAAI,EAAE,KAAK;SACd,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CACzB,SAAS,EACT,IAAI,CAAC,EAAE,CAAC,MAAM;QACd,SAAS;QACT;YACI,KAAK,EAAE,KAAK,EAAE,GAAW,EAAE,OAAe,EAAE,EAAE;gBAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAK,MAAM,KAAE,GAAG,KAAG,OAAO,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,iCAAK,MAAM,KAAE,GAAG,IAAE;YAC5E,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/E,EACD,SAAS,cACT,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,gBAAgB,mCAAI,IAAI,cACpD,IAAI,CAAC,UAAU,CAAC,UAAU,0CAAE,eAAe,mCAAI,IAAI,CACtD,CAAC;QACF,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,mHAAmH;IACnH,8EAA8E;IACpE,WAAW,CAAC,GAAgC;;QAClD,2CAA2C;QAC3C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YACrD,OAAO;SACV;QAED,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC,GAAG,EAAE;IAC/B,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { performance } from \"@fluidframework/common-utils\";\nimport {\n    ChildLogger,\n    loggerToMonitoringContext,\n    MonitoringContext,\n} from \"@fluidframework/telemetry-utils\";\nimport {\n    IDocumentDeltaConnection,\n    IDocumentDeltaStorageService,\n    IDocumentService,\n    IResolvedUrl,\n    IDocumentStorageService,\n    IDocumentServicePolicies,\n} from \"@fluidframework/driver-definitions\";\nimport { DeltaStreamConnectionForbiddenError, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { IFacetCodes } from \"@fluidframework/odsp-doclib-utils\";\nimport {\n    IClient,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IOdspResolvedUrl,\n    TokenFetchOptions,\n    IEntry,\n    HostStoragePolicy,\n    InstrumentedStorageTokenFetcher,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { HostStoragePolicyInternal, ISocketStorageDiscovery } from \"./contracts\";\nimport { IOdspCache } from \"./odspCache\";\nimport { OdspDeltaStorageService, OdspDeltaStorageWithCache } from \"./odspDeltaStorageService\";\nimport { OdspDocumentDeltaConnection } from \"./odspDocumentDeltaConnection\";\nimport { OdspDocumentStorageService } from \"./odspDocumentStorageManager\";\nimport { getWithRetryForTokenRefresh, getOdspResolvedUrl, TokenFetchOptionsEx } from \"./odspUtils\";\nimport { fetchJoinSession } from \"./vroom\";\nimport { isOdcOrigin } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OpsCache } from \"./opsCaching\";\nimport { RetryErrorsStorageAdapter } from \"./retryErrorsStorageAdapter\";\n\n/**\n * The DocumentService manages the Socket.IO connection and manages routing requests to connected\n * clients\n */\nexport class OdspDocumentService implements IDocumentService {\n    private _policies: IDocumentServicePolicies;\n\n    /**\n     * @param resolvedUrl - resolved url identifying document that will be managed by returned service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - This host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by returned service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    public static async create(\n        resolvedUrl: IResolvedUrl,\n        getStorageToken: InstrumentedStorageTokenFetcher,\n        getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        socketIoClientFactory: () => Promise<SocketIOClientStatic>,\n        cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        epochTracker: EpochTracker,\n        socketReferenceKeyPrefix?: string,\n    ): Promise<IDocumentService> {\n        return new OdspDocumentService(\n            getOdspResolvedUrl(resolvedUrl),\n            getStorageToken,\n            getWebsocketToken,\n            logger,\n            socketIoClientFactory,\n            cache,\n            hostPolicy,\n            epochTracker,\n            socketReferenceKeyPrefix,\n        );\n    }\n\n    private storageManager?: OdspDocumentStorageService;\n\n    private readonly mc: MonitoringContext;\n\n    private readonly joinSessionKey: string;\n\n    private readonly hostPolicy: HostStoragePolicyInternal;\n\n    private _opsCache?: OpsCache;\n\n    private currentConnection?: OdspDocumentDeltaConnection;\n\n    /**\n     * @param odspResolvedUrl - resolved url identifying document that will be managed by this service instance.\n     * @param getStorageToken - function that can provide the storage token. This is is also referred to as\n     * the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also referred\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param logger - a logger that can capture performance and diagnostic information\n     * @param socketIoClientFactory - A factory that returns a promise to the socket io library required by the driver\n     * @param cache - This caches response for joinSession.\n     * @param hostPolicy - host constructed policy which customizes service behavior.\n     * @param epochTracker - This helper class which adds epoch to backend calls made by this service instance.\n     * @param socketReferenceKeyPrefix - (optional) prefix to isolate socket reuse cache\n     */\n    private constructor(\n        public readonly odspResolvedUrl: IOdspResolvedUrl,\n        private readonly getStorageToken: InstrumentedStorageTokenFetcher,\n        private readonly getWebsocketToken: ((options: TokenFetchOptions) => Promise<string | null>) | undefined,\n        logger: ITelemetryLogger,\n        private readonly socketIoClientFactory: () => Promise<SocketIOClientStatic>,\n        private readonly cache: IOdspCache,\n        hostPolicy: HostStoragePolicy,\n        private readonly epochTracker: EpochTracker,\n        private readonly socketReferenceKeyPrefix?: string,\n    ) {\n        this._policies = {\n            // load in storage-only mode if a file version is specified\n            storageOnly: odspResolvedUrl.fileVersion !== undefined,\n        };\n\n        this.joinSessionKey = `${this.odspResolvedUrl.hashedDocumentId}/joinsession`;\n        this.mc = loggerToMonitoringContext(\n            ChildLogger.create(logger,\n            undefined,\n            {\n                all: {\n                    odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),\n                },\n            }));\n\n        this.hostPolicy = hostPolicy;\n        this.hostPolicy.fetchBinarySnapshotFormat ??=\n            this.mc.config.getBoolean(\"Fluid.Driver.Odsp.binaryFormatSnapshot\");\n        if (this.odspResolvedUrl.summarizer) {\n            this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };\n        }\n    }\n\n    public get resolvedUrl(): IResolvedUrl {\n        return this.odspResolvedUrl;\n    }\n    public get policies() {\n        return this._policies;\n    }\n\n    /**\n     * Connects to a storage endpoint for snapshot service.\n     *\n     * @returns returns the document storage service for sharepoint driver.\n     */\n    public async connectToStorage(): Promise<IDocumentStorageService> {\n        if (!this.storageManager) {\n            this.storageManager = new OdspDocumentStorageService(\n                this.odspResolvedUrl,\n                this.getStorageToken,\n                this.mc.logger,\n                true,\n                this.cache,\n                this.hostPolicy,\n                this.epochTracker,\n                // flushCallback\n                async () => {\n                    if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                        return this.currentConnection.flush();\n                    }\n                    throw new Error(\"Disconnected while uploading summary (attempt to perform flush())\");\n                },\n            );\n        }\n\n        return new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);\n    }\n\n    /**\n     * Connects to a delta storage endpoint for getting ops between a range.\n     *\n     * @returns returns the document delta storage service for sharepoint driver.\n     */\n    public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {\n        const snapshotOps = this.storageManager?.ops ?? [];\n        const service = new OdspDeltaStorageService(\n            this.odspResolvedUrl.endpoints.deltaStorageUrl,\n            this.getStorageToken,\n            this.epochTracker,\n            this.mc.logger,\n        );\n\n        // batch size, please see issue #5211 for data around batch sizing\n        const batchSize = this.hostPolicy.opsBatchSize ?? 5000;\n        const concurrency = this.hostPolicy.concurrentOpsBatches ?? 1;\n        return new OdspDeltaStorageWithCache(\n            snapshotOps,\n            this.mc.logger,\n            batchSize,\n            concurrency,\n            async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason),\n            async (from, to) => {\n                const res = await this.opsCache?.get(from, to);\n                return res as ISequencedDocumentMessage[] ?? [];\n            },\n            (from, to) => {\n                if (this.currentConnection !== undefined && !this.currentConnection.disposed) {\n                    this.currentConnection.requestOps(from, to);\n                }\n            },\n            (ops: ISequencedDocumentMessage[]) => this.opsReceived(ops),\n        );\n    }\n\n    /**\n     * Connects to a delta stream endpoint for emitting ops.\n     *\n     * @returns returns the document delta stream service for onedrive/sharepoint driver.\n     */\n    public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {\n        // Attempt to connect twice, in case we used expired token.\n        return getWithRetryForTokenRefresh<IDocumentDeltaConnection>(async (options) => {\n            // Presence of getWebsocketToken callback dictates whether callback is used for fetching\n            // websocket token or whether it is returned with joinSession response payload\n            const requestWebsocketTokenFromJoinSession = this.getWebsocketToken === undefined;\n            const websocketTokenPromise = requestWebsocketTokenFromJoinSession\n                ? Promise.resolve(null)\n                : this.getWebsocketToken!(options);\n\n            const joinSessionPromise = this.joinSession(requestWebsocketTokenFromJoinSession, options).catch((e) => {\n                const likelyFacetCodes = e as IFacetCodes;\n                if (Array.isArray(likelyFacetCodes.facetCodes)) {\n                    for (const code of likelyFacetCodes.facetCodes) {\n                        switch (code) {\n                            case \"sessionForbiddenOnPreservedFiles\":\n                            case \"sessionForbiddenOnModerationEnabledLibrary\":\n                            case \"sessionForbiddenOnRequireCheckout\":\n                                // This document can only be opened in storage-only mode.\n                                // DeltaManager will recognize this error\n                                // and load without a delta stream connection.\n                                this._policies = {...this._policies,storageOnly: true};\n                                throw new DeltaStreamConnectionForbiddenError(code);\n                            default:\n                                continue;\n                        }\n                    }\n                }\n                throw e;\n            });\n\n            const [websocketEndpoint, websocketToken, io] =\n                await Promise.all([\n                    joinSessionPromise,\n                    websocketTokenPromise,\n                    this.socketIoClientFactory(),\n                ]);\n\n            const finalWebsocketToken = websocketToken ?? (websocketEndpoint.socketToken || null);\n            if (finalWebsocketToken === null) {\n                throw new NonRetryableError(\n                    \"pushTokenIsNull\",\n                    \"Websocket token is null\",\n                    OdspErrorType.fetchTokenError);\n            }\n            try {\n                const connection = await this.connectToDeltaStreamWithRetry(\n                    websocketEndpoint.tenantId,\n                    websocketEndpoint.id,\n                    finalWebsocketToken,\n                    io,\n                    client,\n                    websocketEndpoint.deltaStreamSocketUrl);\n                connection.on(\"op\", (documentId, ops: ISequencedDocumentMessage[]) => {\n                    this.opsReceived(ops);\n                });\n                this.currentConnection = connection;\n                return connection;\n            } catch (error) {\n                this.cache.sessionJoinCache.remove(this.joinSessionKey);\n                if (typeof error === \"object\" && error !== null) {\n                    error.socketDocumentId = websocketEndpoint.id;\n                }\n                throw error;\n            }\n        });\n    }\n\n    private async joinSession(\n        requestSocketToken: boolean,\n        options: TokenFetchOptionsEx,\n    ): Promise<ISocketStorageDiscovery> {\n        const executeFetch = async () =>\n            fetchJoinSession(\n                this.odspResolvedUrl,\n                \"opStream/joinSession\",\n                \"POST\",\n                this.mc.logger,\n                this.getStorageToken,\n                this.epochTracker,\n                requestSocketToken,\n                options,\n                this.hostPolicy.sessionOptions?.unauthenticatedUserDisplayName,\n            );\n\n        // Note: The sessionCache is configured with a sliding expiry of 1 hour,\n        // so if we've fetched the join session within the last hour we won't run executeFetch again now.\n        return this.cache.sessionJoinCache.addOrGet(this.joinSessionKey, executeFetch);\n    }\n\n    /**\n     * Connects to a delta stream endpoint\n     * If url #1 fails to connect, tries url #2 if applicable\n     *\n     * @param tenantId - the ID of the tenant\n     * @param documentId - document ID\n     * @param token - authorization token for storage service\n     * @param io - websocket library\n     * @param client - information about the client\n     * @param webSocketUrl - websocket URL\n     */\n    private async connectToDeltaStreamWithRetry(\n        tenantId: string,\n        documentId: string,\n        token: string | null,\n        io: SocketIOClientStatic,\n        client: IClient,\n        webSocketUrl: string,\n    ): Promise<OdspDocumentDeltaConnection> {\n        const startTime = performance.now();\n        const connection = await OdspDocumentDeltaConnection.create(\n            tenantId,\n            documentId,\n            token,\n            io,\n            client,\n            webSocketUrl,\n            this.mc.logger,\n            60000,\n            this.epochTracker,\n            this.socketReferenceKeyPrefix,\n        );\n        const duration = performance.now() - startTime;\n        // This event happens rather often, so it adds up to cost of telemetry.\n        // Given that most reconnects result in reusing socket and happen very quickly,\n        // report event only if it took longer than threshold.\n        if (duration >= 2000) {\n            this.mc.logger.sendPerformanceEvent({\n                eventName: \"ConnectionSuccess\",\n                duration,\n            });\n        }\n        return connection;\n    }\n\n    public dispose(error?: any) {\n        // Error might indicate mismatch between client & server knowlege about file\n        // (DriverErrorType.fileOverwrittenInStorage).\n        // For example, file might have been overwritten in storage without generating new epoch\n        // In such case client cached info is stale and has to be removed.\n        if (error !== undefined) {\n            this.epochTracker.removeEntries().catch(() => {});\n        } else {\n            this._opsCache?.flushOps();\n        }\n        this._opsCache?.dispose();\n    }\n\n    protected get opsCache() {\n        if (this._opsCache) {\n            return this._opsCache;\n        }\n\n        const seqNumber = this.storageManager?.snapshotSequenceNumber;\n        const batchSize = this.hostPolicy.opsCaching?.batchSize ?? 100;\n        if (seqNumber === undefined || batchSize < 1) {\n            return;\n        }\n\n        const opsKey: Omit<IEntry, \"key\"> = {\n            type: \"ops\",\n        };\n        this._opsCache = new OpsCache(\n            seqNumber,\n            this.mc.logger,\n            // ICache\n            {\n                write: async (key: string, opsData: string) => {\n                    return this.cache.persistedCache.put({...opsKey, key}, opsData);\n                },\n                read: async (key: string) => this.cache.persistedCache.get({...opsKey, key}),\n                remove: () => { this.cache.persistedCache.removeEntries().catch(() => {}); },\n            },\n            batchSize,\n            this.hostPolicy.opsCaching?.timerGranularity ?? 5000,\n            this.hostPolicy.opsCaching?.totalOpsToCache ?? 5000,\n        );\n        return this._opsCache;\n    }\n\n    // Called whenever re receive ops through any channel for this document (snapshot, delta connection, delta storage)\n    // We use it to notify caching layer of how stale is snapshot stored in cache.\n    protected opsReceived(ops: ISequencedDocumentMessage[]) {\n        // No need for two clients to save same ops\n        if (ops.length === 0 || this.odspResolvedUrl.summarizer) {\n            return;\n        }\n\n        this.opsCache?.addOps(ops);\n    }\n}\n"]}

package/lib/odspDocumentStorageManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentStorageManager.d.ts","sourceRoot":"","sources":["../src/odspDocumentStorageManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAQtE,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EACH,eAAe,EACf,uBAAuB,EACvB,mBAAmB,EACtB,MAAM,oCAAoC,CAAC;AAG5C,OAAO,EACH,gBAAgB,EAGhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEH,yBAAyB,EAG5B,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AA6G5D,qBAAa,0BAA2B,YAAW,uBAAuB;IA4DlE,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAlElC,QAAQ,CAAC,QAAQ;;;MAef;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6C;IAEzE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA0B;IAEhE,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IACpE,OAAO,CAAC,IAAI,CAA8C;IAE1D,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,uBAAuB,CAAqB;IAEpD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAqB;IACvD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqB;IAEtD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAa;IAClD,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAU;IAGlD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAsB;IAE5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAE7C,IAAW,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,EAG9D;IAED,IAAW,GAAG,IAAI,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,CAE5D;IAED,IAAW,sBAAsB,uBAEhC;gBAGoB,eAAe,EAAE,gBAAgB,EACjC,eAAe,EAAE,+BAA+B,EAChD,MAAM,EAAE,gBAAgB,EACxB,iBAAiB,EAAE,OAAO,EAC1B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,yBAAyB,EACrC,YAAY,EAAE,YAAY,EAC1B,aAAa,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC;IAS9D,IAAW,aAAa,IAAI,MAAM,CAEjC;IAEY,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;YAsClE,YAAY;IAkDb,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlD,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;IAsD1E,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAsJzE,aAAa;YAcb,iBAAiB;IA4ElB,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;IAMjF,wBAAwB,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAyC9F,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IAInF,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,sBAAsB;IAM9B,OAAO,CAAC,qBAAqB;YAMf,QAAQ;IAsCtB;;;;OAIG;YACW,eAAe;IA4B7B,OAAO,CAAC,iCAAiC;CAqB5C"}
+{"version":3,"file":"odspDocumentStorageManager.d.ts","sourceRoot":"","sources":["../src/odspDocumentStorageManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAQtE,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EACH,eAAe,EACf,uBAAuB,EACvB,mBAAmB,EAEtB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,gBAAgB,EAGhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEH,yBAAyB,EAG5B,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AA6G5D,qBAAa,0BAA2B,YAAW,uBAAuB;IA4DlE,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAlElC,QAAQ,CAAC,QAAQ;;;MAef;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6C;IAEzE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA0B;IAEhE,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IACpE,OAAO,CAAC,IAAI,CAA8C;IAE1D,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,uBAAuB,CAAqB;IAEpD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAqB;IACvD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqB;IAEtD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAa;IAClD,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAU;IAGlD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAsB;IAE5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAE7C,IAAW,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,EAG9D;IAED,IAAW,GAAG,IAAI,GAAG,CAAC,yBAAyB,EAAE,GAAG,SAAS,CAE5D;IAED,IAAW,sBAAsB,uBAEhC;gBAGoB,eAAe,EAAE,gBAAgB,EACjC,eAAe,EAAE,+BAA+B,EAChD,MAAM,EAAE,gBAAgB,EACxB,iBAAiB,EAAE,OAAO,EAC1B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,yBAAyB,EACrC,YAAY,EAAE,YAAY,EAC1B,aAAa,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC;IAS9D,IAAW,aAAa,IAAI,MAAM,CAEjC;IAEY,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;YAsClE,YAAY;IA+Cb,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlD,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;IAsD1E,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAoKzE,aAAa;YAcb,iBAAiB;IA4ElB,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;IAMjF,wBAAwB,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAyC9F,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IAInF,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,qBAAqB;YASf,QAAQ;IAsCtB;;;;OAIG;YACW,eAAe;IA4B7B,OAAO,CAAC,iCAAiC;CAqB5C"}