@fluidframework/driver-base 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/dist/driverUtils.cjs

@@ -0,0 +1,146 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateMessages = exports.promiseRaceWithWinner = exports.getW3CData = void 0;
+const client_utils_1 = require("@fluid-internal/client-utils");
+/**
+ * Extract and return the w3c data.
+ * @param url - request url for which w3c data needs to be reported.
+ * @param initiatorType - type of the network call
+ * @internal
+ */
+function getW3CData(url, initiatorType) {
+    // From: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
+    // fetchStart: immediately before the browser starts to fetch the resource.
+    // requestStart: immediately before the browser starts requesting the resource from the server
+    // responseStart: immediately after the browser receives the first byte of the response from the server.
+    // responseEnd: immediately after the browser receives the last byte of the resource
+    //              or immediately before the transport connection is closed, whichever comes first.
+    // secureConnectionStart: immediately before the browser starts the handshake process to secure the
+    //              current connection. If a secure connection is not used, this property returns zero.
+    // startTime: Time when the resource fetch started. This value is equivalent to fetchStart.
+    // domainLookupStart: immediately before the browser starts the domain name lookup for the resource.
+    // domainLookupEnd: immediately after the browser finishes the domain name lookup for the resource.
+    // redirectStart: start time of the fetch which that initiates the redirect.
+    // redirectEnd: immediately after receiving the last byte of the response of the last redirect.
+    // Interval between start and finish of the domain name lookup for the resource.
+    let dnsLookupTime; // domainLookupEnd - domainLookupStart
+    // Interval between the first fetch until the last byte of the last redirect.
+    let redirectTime; // redirectEnd - redirectStart
+    // Time to establish the connection to the server to retrieve the resource.
+    let tcpHandshakeTime; // connectEnd  - connectStart
+    // Time from the end of the connection until the inital handshake process to secure the connection.
+    // If 0, then no time is spent here.
+    let secureConnectionTime; // connectEnd  - secureConnectionStart
+    // Interval to receive all (first to last) bytes form the server.
+    let responseNetworkTime; // responsEnd - responseStart
+    // Interval between the initial fetch until the last byte is received.
+    // Likely same as fetchTime + receiveContentTime.
+    let fetchStartToResponseEndTime; // responseEnd  - fetchStart
+    // reqStartToResponseEndTime = fetchStartToResponseEndTime - <initial TCP handshake>
+    // Interval between starting the request for the resource until receiving the last byte.
+    let reqStartToResponseEndTime; // responseEnd - requestStart
+    let w3cStartTime; // W3C Start time = fetchStart time
+    // getEntriesByType is only available in browser performance object
+    const resources1 = client_utils_1.performance.getEntriesByType?.("resource") ?? [];
+    // Usually the latest fetch call is to the end of resources, so we start from the end.
+    for (let i = resources1.length - 1; i > 0; i--) {
+        const indResTime = resources1[i];
+        const resource_name = indResTime.name.toString();
+        const resource_initiatortype = indResTime.initiatorType;
+        if (resource_initiatortype.localeCompare(initiatorType) === 0 &&
+            resource_name.includes(url)) {
+            redirectTime = indResTime.redirectEnd - indResTime.redirectStart;
+            w3cStartTime = indResTime.fetchStart;
+            dnsLookupTime = indResTime.domainLookupEnd - indResTime.domainLookupStart;
+            tcpHandshakeTime = indResTime.connectEnd - indResTime.connectStart;
+            secureConnectionTime =
+                indResTime.secureConnectionStart > 0
+                    ? indResTime.connectEnd - indResTime.secureConnectionStart
+                    : 0;
+            responseNetworkTime =
+                indResTime.responseStart > 0
+                    ? indResTime.responseEnd - indResTime.responseStart
+                    : undefined;
+            fetchStartToResponseEndTime =
+                indResTime.fetchStart > 0
+                    ? indResTime.responseEnd - indResTime.fetchStart
+                    : undefined;
+            reqStartToResponseEndTime =
+                indResTime.requestStart > 0
+                    ? indResTime.responseEnd - indResTime.requestStart
+                    : undefined;
+            break;
+        }
+    }
+    return {
+        dnsLookupTime,
+        w3cStartTime,
+        redirectTime,
+        tcpHandshakeTime,
+        secureConnectionTime,
+        responseNetworkTime,
+        fetchStartToResponseEndTime,
+        reqStartToResponseEndTime,
+    };
+}
+exports.getW3CData = getW3CData;
+/**
+ * An implementation of Promise.race that gives you the winner of the promise race.
+ * If one of the promises is rejected before any other is resolved, this method will return the error/reason from that rejection.
+ * @internal
+ */
+async function promiseRaceWithWinner(promises) {
+    return new Promise((resolve, reject) => {
+        promises.forEach((p, index) => {
+            p.then((v) => resolve({ index, value: v })).catch(reject);
+        });
+    });
+}
+exports.promiseRaceWithWinner = promiseRaceWithWinner;
+/**
+ * @internal
+ */
+function validateMessages(reason, messages, from, logger, strict = true) {
+    if (messages.length !== 0) {
+        const start = messages[0].sequenceNumber;
+        const length = messages.length;
+        const last = messages[length - 1].sequenceNumber;
+        if (last + 1 !== from + length) {
+            // If not strict, then return the first consecutive sub-block. If strict or start
+            // seq number is not what we expected, then return no ops.
+            if (strict || from !== start) {
+                messages.length = 0;
+            }
+            else {
+                let validOpsCount = 1;
+                while (validOpsCount < messages.length &&
+                    messages[validOpsCount].sequenceNumber ===
+                        messages[validOpsCount - 1].sequenceNumber + 1) {
+                    validOpsCount++;
+                }
+                messages.length = validOpsCount;
+            }
+            logger.sendErrorEvent({
+                eventName: "OpsFetchViolation",
+                reason,
+                from,
+                start,
+                last,
+                length,
+                details: JSON.stringify({
+                    validLength: messages.length,
+                    lastValidOpSeqNumber: messages.length > 0
+                        ? messages[messages.length - 1].sequenceNumber
+                        : undefined,
+                    strict,
+                }),
+            });
+        }
+    }
+}
+exports.validateMessages = validateMessages;
+//# sourceMappingURL=driverUtils.cjs.map

package/dist/driverUtils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"driverUtils.cjs","sourceRoot":"","sources":["../src/driverUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA2D;AAI3D;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,GAAW,EAAE,aAAqB;IAC5D,mFAAmF;IACnF,2EAA2E;IAC3E,8FAA8F;IAC9F,wGAAwG;IACxG,oFAAoF;IACpF,gGAAgG;IAChG,mGAAmG;IACnG,mGAAmG;IACnG,2FAA2F;IAC3F,oGAAoG;IACpG,mGAAmG;IACnG,4EAA4E;IAC5E,+FAA+F;IAE/F,gFAAgF;IAChF,IAAI,aAAiC,CAAC,CAAC,sCAAsC;IAC7E,6EAA6E;IAC7E,IAAI,YAAgC,CAAC,CAAC,8BAA8B;IACpE,2EAA2E;IAC3E,IAAI,gBAAoC,CAAC,CAAC,6BAA6B;IACvE,mGAAmG;IACnG,oCAAoC;IACpC,IAAI,oBAAwC,CAAC,CAAC,sCAAsC;IACpF,iEAAiE;IACjE,IAAI,mBAAuC,CAAC,CAAC,6BAA6B;IAC1E,sEAAsE;IACtE,iDAAiD;IACjD,IAAI,2BAA+C,CAAC,CAAC,4BAA4B;IACjF,oFAAoF;IACpF,wFAAwF;IACxF,IAAI,yBAA6C,CAAC,CAAC,6BAA6B;IAChF,IAAI,YAAgC,CAAC,CAAC,mCAAmC;IAEzE,mEAAmE;IACnE,MAAM,UAAU,GAAG,0BAAW,CAAC,gBAAgB,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;IACpE,sFAAsF;IACtF,KAAK,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/C,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAA8B,CAAC;QAC9D,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjD,MAAM,sBAAsB,GAAG,UAAU,CAAC,aAAa,CAAC;QACxD,IACC,sBAAsB,CAAC,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC;YACzD,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAC1B;YACD,YAAY,GAAG,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,aAAa,CAAC;YACjE,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC;YACrC,aAAa,GAAG,UAAU,CAAC,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC;YAC1E,gBAAgB,GAAG,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC,YAAY,CAAC;YACnE,oBAAoB;gBACnB,UAAU,CAAC,qBAAqB,GAAG,CAAC;oBACnC,CAAC,CAAC,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC,qBAAqB;oBAC1D,CAAC,CAAC,CAAC,CAAC;YACN,mBAAmB;gBAClB,UAAU,CAAC,aAAa,GAAG,CAAC;oBAC3B,CAAC,CAAC,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,aAAa;oBACnD,CAAC,CAAC,SAAS,CAAC;YACd,2BAA2B;gBAC1B,UAAU,CAAC,UAAU,GAAG,CAAC;oBACxB,CAAC,CAAC,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,UAAU;oBAChD,CAAC,CAAC,SAAS,CAAC;YACd,yBAAyB;gBACxB,UAAU,CAAC,YAAY,GAAG,CAAC;oBAC1B,CAAC,CAAC,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,YAAY;oBAClD,CAAC,CAAC,SAAS,CAAC;YACd,MAAM;SACN;KACD;IACD,OAAO;QACN,aAAa;QACb,YAAY;QACZ,YAAY;QACZ,gBAAgB;QAChB,oBAAoB;QACpB,mBAAmB;QACnB,2BAA2B;QAC3B,yBAAyB;KACzB,CAAC;AACH,CAAC;AA9ED,gCA8EC;AAED;;;;GAIG;AACI,KAAK,UAAU,qBAAqB,CAC1C,QAAsB;IAEtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YAC7B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AARD,sDAQC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAC/B,MAAc,EACd,QAAqC,EACrC,IAAY,EACZ,MAA2B,EAC3B,SAAkB,IAAI;IAEtB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;QACjD,IAAI,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,MAAM,EAAE;YAC/B,iFAAiF;YACjF,0DAA0D;YAC1D,IAAI,MAAM,IAAI,IAAI,KAAK,KAAK,EAAE;gBAC7B,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aACpB;iBAAM;gBACN,IAAI,aAAa,GAAG,CAAC,CAAC;gBACtB,OACC,aAAa,GAAG,QAAQ,CAAC,MAAM;oBAC/B,QAAQ,CAAC,aAAa,CAAC,CAAC,cAAc;wBACrC,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,EAC9C;oBACD,aAAa,EAAE,CAAC;iBAChB;gBACD,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC;aAChC;YACD,MAAM,CAAC,cAAc,CAAC;gBACrB,SAAS,EAAE,mBAAmB;gBAC9B,MAAM;gBACN,IAAI;gBACJ,KAAK;gBACL,IAAI;gBACJ,MAAM;gBACN,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;oBACvB,WAAW,EAAE,QAAQ,CAAC,MAAM;oBAC5B,oBAAoB,EACnB,QAAQ,CAAC,MAAM,GAAG,CAAC;wBAClB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc;wBAC9C,CAAC,CAAC,SAAS;oBACb,MAAM;iBACN,CAAC;aACF,CAAC,CAAC;SACH;KACD;AACF,CAAC;AA7CD,4CA6CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { performance } from \"@fluid-internal/client-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLoggerExt } from \"@fluidframework/telemetry-utils\";\n\n/**\n * Extract and return the w3c data.\n * @param url - request url for which w3c data needs to be reported.\n * @param initiatorType - type of the network call\n * @internal\n */\nexport function getW3CData(url: string, initiatorType: string) {\n\t// From: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming\n\t// fetchStart: immediately before the browser starts to fetch the resource.\n\t// requestStart: immediately before the browser starts requesting the resource from the server\n\t// responseStart: immediately after the browser receives the first byte of the response from the server.\n\t// responseEnd: immediately after the browser receives the last byte of the resource\n\t//              or immediately before the transport connection is closed, whichever comes first.\n\t// secureConnectionStart: immediately before the browser starts the handshake process to secure the\n\t//              current connection. If a secure connection is not used, this property returns zero.\n\t// startTime: Time when the resource fetch started. This value is equivalent to fetchStart.\n\t// domainLookupStart: immediately before the browser starts the domain name lookup for the resource.\n\t// domainLookupEnd: immediately after the browser finishes the domain name lookup for the resource.\n\t// redirectStart: start time of the fetch which that initiates the redirect.\n\t// redirectEnd: immediately after receiving the last byte of the response of the last redirect.\n\n\t// Interval between start and finish of the domain name lookup for the resource.\n\tlet dnsLookupTime: number | undefined; // domainLookupEnd - domainLookupStart\n\t// Interval between the first fetch until the last byte of the last redirect.\n\tlet redirectTime: number | undefined; // redirectEnd - redirectStart\n\t// Time to establish the connection to the server to retrieve the resource.\n\tlet tcpHandshakeTime: number | undefined; // connectEnd  - connectStart\n\t// Time from the end of the connection until the inital handshake process to secure the connection.\n\t// If 0, then no time is spent here.\n\tlet secureConnectionTime: number | undefined; // connectEnd  - secureConnectionStart\n\t// Interval to receive all (first to last) bytes form the server.\n\tlet responseNetworkTime: number | undefined; // responsEnd - responseStart\n\t// Interval between the initial fetch until the last byte is received.\n\t// Likely same as fetchTime + receiveContentTime.\n\tlet fetchStartToResponseEndTime: number | undefined; // responseEnd  - fetchStart\n\t// reqStartToResponseEndTime = fetchStartToResponseEndTime - <initial TCP handshake>\n\t// Interval between starting the request for the resource until receiving the last byte.\n\tlet reqStartToResponseEndTime: number | undefined; // responseEnd - requestStart\n\tlet w3cStartTime: number | undefined; // W3C Start time = fetchStart time\n\n\t// getEntriesByType is only available in browser performance object\n\tconst resources1 = performance.getEntriesByType?.(\"resource\") ?? [];\n\t// Usually the latest fetch call is to the end of resources, so we start from the end.\n\tfor (let i = resources1.length - 1; i > 0; i--) {\n\t\tconst indResTime = resources1[i] as PerformanceResourceTiming;\n\t\tconst resource_name = indResTime.name.toString();\n\t\tconst resource_initiatortype = indResTime.initiatorType;\n\t\tif (\n\t\t\tresource_initiatortype.localeCompare(initiatorType) === 0 &&\n\t\t\tresource_name.includes(url)\n\t\t) {\n\t\t\tredirectTime = indResTime.redirectEnd - indResTime.redirectStart;\n\t\t\tw3cStartTime = indResTime.fetchStart;\n\t\t\tdnsLookupTime = indResTime.domainLookupEnd - indResTime.domainLookupStart;\n\t\t\ttcpHandshakeTime = indResTime.connectEnd - indResTime.connectStart;\n\t\t\tsecureConnectionTime =\n\t\t\t\tindResTime.secureConnectionStart > 0\n\t\t\t\t\t? indResTime.connectEnd - indResTime.secureConnectionStart\n\t\t\t\t\t: 0;\n\t\t\tresponseNetworkTime =\n\t\t\t\tindResTime.responseStart > 0\n\t\t\t\t\t? indResTime.responseEnd - indResTime.responseStart\n\t\t\t\t\t: undefined;\n\t\t\tfetchStartToResponseEndTime =\n\t\t\t\tindResTime.fetchStart > 0\n\t\t\t\t\t? indResTime.responseEnd - indResTime.fetchStart\n\t\t\t\t\t: undefined;\n\t\t\treqStartToResponseEndTime =\n\t\t\t\tindResTime.requestStart > 0\n\t\t\t\t\t? indResTime.responseEnd - indResTime.requestStart\n\t\t\t\t\t: undefined;\n\t\t\tbreak;\n\t\t}\n\t}\n\treturn {\n\t\tdnsLookupTime,\n\t\tw3cStartTime,\n\t\tredirectTime,\n\t\ttcpHandshakeTime,\n\t\tsecureConnectionTime,\n\t\tresponseNetworkTime,\n\t\tfetchStartToResponseEndTime,\n\t\treqStartToResponseEndTime,\n\t};\n}\n\n/**\n * An implementation of Promise.race that gives you the winner of the promise race.\n * If one of the promises is rejected before any other is resolved, this method will return the error/reason from that rejection.\n * @internal\n */\nexport async function promiseRaceWithWinner<T>(\n\tpromises: Promise<T>[],\n): Promise<{ index: number; value: T }> {\n\treturn new Promise((resolve, reject) => {\n\t\tpromises.forEach((p, index) => {\n\t\t\tp.then((v) => resolve({ index, value: v })).catch(reject);\n\t\t});\n\t});\n}\n\n/**\n * @internal\n */\nexport function validateMessages(\n\treason: string,\n\tmessages: ISequencedDocumentMessage[],\n\tfrom: number,\n\tlogger: ITelemetryLoggerExt,\n\tstrict: boolean = true,\n) {\n\tif (messages.length !== 0) {\n\t\tconst start = messages[0].sequenceNumber;\n\t\tconst length = messages.length;\n\t\tconst last = messages[length - 1].sequenceNumber;\n\t\tif (last + 1 !== from + length) {\n\t\t\t// If not strict, then return the first consecutive sub-block. If strict or start\n\t\t\t// seq number is not what we expected, then return no ops.\n\t\t\tif (strict || from !== start) {\n\t\t\t\tmessages.length = 0;\n\t\t\t} else {\n\t\t\t\tlet validOpsCount = 1;\n\t\t\t\twhile (\n\t\t\t\t\tvalidOpsCount < messages.length &&\n\t\t\t\t\tmessages[validOpsCount].sequenceNumber ===\n\t\t\t\t\t\tmessages[validOpsCount - 1].sequenceNumber + 1\n\t\t\t\t) {\n\t\t\t\t\tvalidOpsCount++;\n\t\t\t\t}\n\t\t\t\tmessages.length = validOpsCount;\n\t\t\t}\n\t\t\tlogger.sendErrorEvent({\n\t\t\t\teventName: \"OpsFetchViolation\",\n\t\t\t\treason,\n\t\t\t\tfrom,\n\t\t\t\tstart,\n\t\t\t\tlast,\n\t\t\t\tlength,\n\t\t\t\tdetails: JSON.stringify({\n\t\t\t\t\tvalidLength: messages.length,\n\t\t\t\t\tlastValidOpSeqNumber:\n\t\t\t\t\t\tmessages.length > 0\n\t\t\t\t\t\t\t? messages[messages.length - 1].sequenceNumber\n\t\t\t\t\t\t\t: undefined,\n\t\t\t\t\tstrict,\n\t\t\t\t}),\n\t\t\t});\n\t\t}\n\t}\n}\n"]}

package/dist/driverUtils.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+/**
+ * Extract and return the w3c data.
+ * @param url - request url for which w3c data needs to be reported.
+ * @param initiatorType - type of the network call
+ * @internal
+ */
+export declare function getW3CData(url: string, initiatorType: string): {
+    dnsLookupTime: number | undefined;
+    w3cStartTime: number | undefined;
+    redirectTime: number | undefined;
+    tcpHandshakeTime: number | undefined;
+    secureConnectionTime: number | undefined;
+    responseNetworkTime: number | undefined;
+    fetchStartToResponseEndTime: number | undefined;
+    reqStartToResponseEndTime: number | undefined;
+};
+/**
+ * An implementation of Promise.race that gives you the winner of the promise race.
+ * If one of the promises is rejected before any other is resolved, this method will return the error/reason from that rejection.
+ * @internal
+ */
+export declare function promiseRaceWithWinner<T>(promises: Promise<T>[]): Promise<{
+    index: number;
+    value: T;
+}>;
+/**
+ * @internal
+ */
+export declare function validateMessages(reason: string, messages: ISequencedDocumentMessage[], from: number, logger: ITelemetryLoggerExt, strict?: boolean): void;
+//# sourceMappingURL=driverUtils.d.ts.map

package/dist/driverUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driverUtils.d.ts","sourceRoot":"","sources":["../src/driverUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;;;;;;;;;EA8E5D;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,CAAC,EAC5C,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GACpB,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC,CAMtC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,yBAAyB,EAAE,EACrC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,mBAAmB,EAC3B,MAAM,GAAE,OAAc,QAwCtB"}

package/dist/index.cjs

@@ -0,0 +1,14 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateMessages = exports.promiseRaceWithWinner = exports.getW3CData = exports.DocumentDeltaConnection = void 0;
+var documentDeltaConnection_1 = require("./documentDeltaConnection.cjs");
+Object.defineProperty(exports, "DocumentDeltaConnection", { enumerable: true, get: function () { return documentDeltaConnection_1.DocumentDeltaConnection; } });
+var driverUtils_1 = require("./driverUtils.cjs");
+Object.defineProperty(exports, "getW3CData", { enumerable: true, get: function () { return driverUtils_1.getW3CData; } });
+Object.defineProperty(exports, "promiseRaceWithWinner", { enumerable: true, get: function () { return driverUtils_1.promiseRaceWithWinner; } });
+Object.defineProperty(exports, "validateMessages", { enumerable: true, get: function () { return driverUtils_1.validateMessages; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,yEAAoE;AAA3D,kIAAA,uBAAuB,OAAA;AAChC,iDAAoF;AAA3E,yGAAA,UAAU,OAAA;AAAE,oHAAA,qBAAqB,OAAA;AAAE,+GAAA,gBAAgB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DocumentDeltaConnection } from \"./documentDeltaConnection\";\nexport { getW3CData, promiseRaceWithWinner, validateMessages } from \"./driverUtils\";\n"]}

package/dist/index.d.ts

@@ -2,5 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./documentDeltaConnection";
+export { DocumentDeltaConnection } from "./documentDeltaConnection";
+export { getW3CData, promiseRaceWithWinner, validateMessages } from "./driverUtils";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/dist/{packageVersion.js → packageVersion.cjs}

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/driver-base";
-exports.pkgVersion = "1.4.0-121020";
-//# sourceMappingURL=packageVersion.js.map
+exports.pkgVersion = "2.0.0-dev-rc.1.0.0.225277";
+//# sourceMappingURL=packageVersion.cjs.map

package/dist/packageVersion.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,6BAA6B,CAAC;AACxC,QAAA,UAAU,GAAG,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-base\";\nexport const pkgVersion = \"2.0.0-dev-rc.1.0.0.225277\";\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/driver-base";
-export declare const pkgVersion = "1.4.0-121020";
+export declare const pkgVersion = "2.0.0-dev-rc.1.0.0.225277";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,gCAAgC,CAAC;AACrD,eAAO,MAAM,UAAU,iBAAiB,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,gCAAgC,CAAC;AACrD,eAAO,MAAM,UAAU,8BAA8B,CAAC"}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}

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

@@ -2,19 +2,20 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IDocumentDeltaConnection, IDocumentDeltaConnectionEvents } from "@fluidframework/driver-definitions";
-import { IAnyDriverError } from "@fluidframework/driver-utils";
+import { IAnyDriverError, IDocumentDeltaConnection, IDocumentDeltaConnectionEvents } from "@fluidframework/driver-definitions";
 import { ConnectionMode, IClientConfiguration, IConnect, IConnected, IDocumentMessage, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
-import { IDisposable, ITelemetryLogger } from "@fluidframework/common-definitions";
-import { EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
+import { IDisposable } from "@fluidframework/core-interfaces";
+import { ITelemetryLoggerExt, EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
 import type { Socket } from "socket.io-client";
 /**
- * Represents a connection to a stream of delta updates
+ * Represents a connection to a stream of delta updates.
+ * @internal
  */
 export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandling<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
     protected readonly socket: Socket;
     documentId: string;
     private readonly enableLongPollingDowngrades;
+    protected readonly connectionId?: string | undefined;
     static readonly eventsToForward: string[];
     static readonly eventsAlwaysForwarded: string[];
     /**
@@ -34,6 +35,7 @@ export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandli
     private earlyOpHandlerAttached;
     private socketConnectionTimeout;
     private _details;
+    private trackLatencyTimeout;
     private readonly connectionListeners;
     private readonly trackedListeners;
     protected get hasDetails(): boolean;
@@ -45,9 +47,9 @@ export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandli
     protected _disposed: boolean;
     private readonly mc;
     /**
-     * @deprecated - Implementors should manage their own logger or monitoring context
+     * @deprecated Implementors should manage their own logger or monitoring context
      */
-    protected get logger(): ITelemetryLogger;
+    protected get logger(): ITelemetryLoggerExt;
     get details(): IConnected;
     /**
      * @param socket - websocket to be used
@@ -55,7 +57,7 @@ export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandli
      * @param logger - for reporting telemetry events
      * @param enableLongPollingDowngrades - allow connection to be downgraded to long-polling on websocket failure
      */
-    protected constructor(socket: Socket, documentId: string, logger: ITelemetryLogger, enableLongPollingDowngrades?: boolean);
+    protected constructor(socket: Socket, documentId: string, logger: ITelemetryLoggerExt, enableLongPollingDowngrades?: boolean, connectionId?: string | undefined);
     /**
      * Get the ID of the client who is sending the message
      *
@@ -94,7 +96,7 @@ export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandli
      * Configuration details provided by the service
      */
     get serviceConfiguration(): IClientConfiguration;
-    private checkNotClosed;
+    private checkNotDisposed;
     /**
      * Get messages sent during the connection
      *
@@ -114,7 +116,6 @@ export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandli
      */
     get initialClients(): ISignalClient[];
     protected emitMessages(type: string, messages: IDocumentMessage[][]): void;
-    protected submitCore(type: string, messages: IDocumentMessage[]): void;
     /**
      * Submits a new delta operation to the server
      *
@@ -124,33 +125,48 @@ export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandli
     /**
      * Submits a new signal to the server
      *
-     * @param message - signal to submit
+     * @param content - Content of the signal.
+     * @param targetClientId - When specified, the signal is only sent to the provided client id.
      */
-    submitSignal(message: IDocumentMessage): void;
+    submitSignal(content: IDocumentMessage, targetClientId?: string): void;
     /**
-     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection.
+     * Disconnect from the websocket and close the websocket too.
+     */
+    private closeSocket;
+    protected closeSocketCore(error: IAnyDriverError): void;
+    /**
+     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection and close the socket.
+     * However the OdspDocumentDeltaConnection differ in dispose as in there we don't close the socket. There is no
+     * multiplexing here, so we need to close the socket here.
      */
     dispose(): void;
-    protected disposeCore(socketProtocolError: boolean, err: IAnyDriverError): void;
+    protected disconnect(err: IAnyDriverError): void;
     /**
      * Disconnect from the websocket.
-     * @param socketProtocolError - true if error happened on socket / socket.io protocol level
-     *  (not on Fluid protocol level)
      * @param reason - reason for disconnect
      */
-    protected disconnect(socketProtocolError: boolean, reason: IAnyDriverError): void;
+    protected disconnectCore(): void;
     protected initialize(connectMessage: IConnect, timeout: number): Promise<void>;
+    private addPropsToError;
+    protected getConnectionDetailsProps(): {
+        disposed: boolean;
+        socketConnected: boolean;
+        clientId: string | undefined;
+        connectionId: string | undefined;
+    };
     protected earlyOpHandler: (documentId: string, msgs: ISequencedDocumentMessage[]) => void;
-    protected earlySignalHandler: (msg: ISignalMessage) => void;
+    protected earlySignalHandler: (msg: ISignalMessage | ISignalMessage[]) => void;
     private removeEarlyOpHandler;
     private removeEarlySignalHandler;
     private addConnectionListener;
     protected addTrackedListener(event: string, listener: (...args: any[]) => void): void;
     private removeTrackedListeners;
     private removeConnectionListeners;
+    private getErrorMessage;
+    private createErrorObjectWithProps;
     /**
      * Error raising for socket.io issues
      */
     protected createErrorObject(handler: string, error?: any, canRetry?: boolean): IAnyDriverError;
 }
-//# sourceMappingURL=documentDeltaConnection.d.ts.map
+//# sourceMappingURL=documentDeltaConnection.d.mts.map

package/lib/documentDeltaConnection.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentDeltaConnection.d.mts","sourceRoot":"","sources":["../src/documentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAGI,EACN,eAAe,EACf,wBAAwB,EACxB,8BAA8B,EAC9B,MAAM,oCAAoC;OAEpC,EACN,cAAc,EACd,oBAAoB,EACpB,QAAQ,EACR,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EAEZ,MAAM,sCAAsC;OACtC,EAAE,WAAW,EAAkC,MAAM,iCAAiC;OACtF,EACN,mBAAmB,EAInB,6BAA6B,EAG7B,MAAM,iCAAiC;OACjC,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB;AAI9C;;;GAGG;AACH,qBAAa,uBACZ,SAAQ,6BAA6B,CAAC,8BAA8B,CACpE,YAAW,wBAAwB,EAAE,WAAW;IA8E/C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM;IAC1B,UAAU,EAAE,MAAM;IAEzB,OAAO,CAAC,QAAQ,CAAC,2BAA2B;IAC5C,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC;IAhFjC,MAAM,CAAC,QAAQ,CAAC,eAAe,WAAoC;IAInE,MAAM,CAAC,QAAQ,CAAC,qBAAqB,WAA2B;IAEhE;;;;;;OAMG;IACI,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;IAGpD,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,EAAE,CAAM;IACpE,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,cAAc,EAAE,CAAM;IAExD;;;OAGG;IACH,OAAO,CAAC,sBAAsB,CAAkB;IAEhD,OAAO,CAAC,uBAAuB,CAA4C;IAE3E,OAAO,CAAC,QAAQ,CAAyB;IAEzC,OAAO,CAAC,mBAAmB,CAA4C;IAGvE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAoD;IAExF,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAoD;IAErF,SAAS,KAAK,UAAU,IAAI,OAAO,CAElC;IAED,IAAW,QAAQ,YAMlB;IAED;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,OAAO,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;OAEG;IACH,SAAS,KAAK,MAAM,IAAI,mBAAmB,CAE1C;IAED,IAAW,OAAO,IAAI,UAAU,CAK/B;IAED;;;;;OAKG;IACH,SAAS,aACW,MAAM,EAAE,MAAM,EAC1B,UAAU,EAAE,MAAM,EACzB,MAAM,EAAE,mBAAmB,EACV,2BAA2B,GAAE,OAAe,EAC1C,YAAY,CAAC,oBAAQ;IAiEzC;;;;OAIG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;;;OAIG;IACH,IAAW,IAAI,IAAI,cAAc,CAEhC;IAED;;;;OAIG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;IAED;;;;OAIG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;;;OAIG;IACH,IAAW,cAAc,IAAI,MAAM,CAElC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;OAEG;IACH,IAAW,oBAAoB,IAAI,oBAAoB,CAEtD;IAED,OAAO,CAAC,gBAAgB;IAIxB;;;;OAIG;IACH,IAAW,eAAe,IAAI,yBAAyB,EAAE,CAmBxD;IAED;;;;OAIG;IACH,IAAW,cAAc,IAAI,cAAc,EAAE,CAa5C;IAED;;;;OAIG;IACH,IAAW,cAAc,IAAI,aAAa,EAAE,CAG3C;IAED,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,EAAE;IASnE;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAKjD;;;;;OAKG;IACI,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI;IAU7E;;OAEG;IACH,OAAO,CAAC,WAAW;IAQnB,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,eAAe;IAIhD;;;;OAIG;IACI,OAAO;IAkBd,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,eAAe;IAgCzC;;;OAGG;IACH,SAAS,CAAC,cAAc;cAIR,UAAU,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM;IAmNpE,OAAO,CAAC,eAAe;IAWvB,SAAS,CAAC,yBAAyB;;;;;;IASnC,SAAS,CAAC,cAAc,eAAgB,MAAM,QAAQ,yBAAyB,EAAE,UAE/E;IAEF,SAAS,CAAC,kBAAkB,QAAS,cAAc,GAAG,cAAc,EAAE,UAMpE;IAEF,OAAO,CAAC,oBAAoB;IAK5B,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,qBAAqB;IAc7B,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAM9E,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,0BAA0B;IAmBlC;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,UAAO,GAAG,eAAe;CAY3F"}