@fluidframework/driver-base 2.0.0-dev.3.1.0.125672 → 2.0.0-dev.4.2.0.153917

package/lib/driverUtils.js

@@ -0,0 +1,98 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { performance } from "@fluidframework/common-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
+ */
+export 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.
+    var _a, _b;
+    // 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 = (_b = (_a = performance.getEntriesByType) === null || _a === void 0 ? void 0 : _a.call(performance, "resource")) !== null && _b !== void 0 ? _b : [];
+    // 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,
+    };
+}
+/*
+ * 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.
+ */
+export async function promiseRaceWithWinner(promises) {
+    return new Promise((resolve, reject) => {
+        promises.forEach((p, index) => {
+            p.then((v) => resolve({ index, value: v })).catch(reject);
+        });
+    });
+}
+//# sourceMappingURL=driverUtils.js.map

package/lib/driverUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"driverUtils.js","sourceRoot":"","sources":["../src/driverUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D;;;;GAIG;AACH,MAAM,UAAU,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,MAAA,MAAA,WAAW,CAAC,gBAAgB,+CAA5B,WAAW,EAAoB,UAAU,CAAC,mCAAI,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;AAED;;;GAGG;AACH,MAAM,CAAC,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","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { performance } from \"@fluidframework/common-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 */\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 */\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"]}

package/lib/index.d.ts

@@ -3,4 +3,5 @@
  * Licensed under the MIT License.
  */
 export { DocumentDeltaConnection } from "./documentDeltaConnection";
+export { getW3CData, promiseRaceWithWinner } from "./driverUtils";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,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,MAAM,eAAe,CAAC"}

package/lib/index.js

@@ -3,4 +3,5 @@
  * Licensed under the MIT License.
  */
 export { DocumentDeltaConnection } from "./documentDeltaConnection";
+export { getW3CData, promiseRaceWithWinner } from "./driverUtils";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DocumentDeltaConnection } from \"./documentDeltaConnection\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC","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 } from \"./driverUtils\";\n"]}

package/lib/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 = "2.0.0-dev.3.1.0.125672";
+export declare const pkgVersion = "2.0.0-dev.4.2.0.153917";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/driver-base";
-export const pkgVersion = "2.0.0-dev.3.1.0.125672";
+export const pkgVersion = "2.0.0-dev.4.2.0.153917";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,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.3.1.0.125672\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,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.4.2.0.153917\";\n"]}

package/lib/test/types/validateDriverBasePrevious.generated.js.map

@@ -1 +1 @@
-{"version":3,"file":"validateDriverBasePrevious.generated.js","sourceRoot":"","sources":["../../../src/test/types/validateDriverBasePrevious.generated.ts"],"names":[],"mappings":"AAwBA,oDAAoD,CAChD,gDAAgD,EAAE,CAAC,CAAC;AAWxD,gDAAgD,CAC5C,oDAAoD,EAAE,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/*\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n * Generated by fluid-type-validator in @fluidframework/build-tools.\n */\nimport * as old from \"@fluidframework/driver-base-previous\";\nimport * as current from \"../../index\";\n\ntype TypeOnly<T> = {\n    [P in keyof T]: TypeOnly<T[P]>;\n};\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DocumentDeltaConnection\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<old.DocumentDeltaConnection>;\ndeclare function use_current_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<current.DocumentDeltaConnection>);\nuse_current_ClassDeclaration_DocumentDeltaConnection(\n    get_old_ClassDeclaration_DocumentDeltaConnection());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DocumentDeltaConnection\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<current.DocumentDeltaConnection>;\ndeclare function use_old_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<old.DocumentDeltaConnection>);\nuse_old_ClassDeclaration_DocumentDeltaConnection(\n    get_current_ClassDeclaration_DocumentDeltaConnection());\n"]}
+{"version":3,"file":"validateDriverBasePrevious.generated.js","sourceRoot":"","sources":["../../../src/test/types/validateDriverBasePrevious.generated.ts"],"names":[],"mappings":"AAwBA,oDAAoD,CAChD,gDAAgD,EAAE,CAAC,CAAC;AAWxD,gDAAgD,CAC5C,oDAAoD,EAAE,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/*\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n * Generated by fluid-type-test-generator in @fluidframework/build-tools.\n */\nimport * as old from \"@fluidframework/driver-base-previous\";\nimport * as current from \"../../index\";\n\ntype TypeOnly<T> = {\n    [P in keyof T]: TypeOnly<T[P]>;\n};\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DocumentDeltaConnection\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<old.DocumentDeltaConnection>;\ndeclare function use_current_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<current.DocumentDeltaConnection>);\nuse_current_ClassDeclaration_DocumentDeltaConnection(\n    get_old_ClassDeclaration_DocumentDeltaConnection());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DocumentDeltaConnection\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<current.DocumentDeltaConnection>;\ndeclare function use_old_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<old.DocumentDeltaConnection>);\nuse_old_ClassDeclaration_DocumentDeltaConnection(\n    get_current_ClassDeclaration_DocumentDeltaConnection());\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-base",
-  "version": "2.0.0-dev.3.1.0.125672",
+  "version": "2.0.0-dev.4.2.0.153917",
   "description": "Shared driver code for Fluid driver implementations",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,9 +14,36 @@
   "main": "dist/index.js",
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
+  "dependencies": {
+    "@fluidframework/common-definitions": "^0.20.1",
+    "@fluidframework/common-utils": "^1.1.1",
+    "@fluidframework/driver-definitions": "2.0.0-dev.4.2.0.153917",
+    "@fluidframework/driver-utils": "2.0.0-dev.4.2.0.153917",
+    "@fluidframework/protocol-definitions": "^1.1.0",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.4.2.0.153917"
+  },
+  "devDependencies": {
+    "@fluid-tools/build-cli": "^0.15.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.15.0",
+    "@fluidframework/driver-base-previous": "npm:@fluidframework/driver-base@2.0.0-internal.4.0.0",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@microsoft/api-extractor": "^7.34.4",
+    "@types/node": "^14.18.38",
+    "concurrently": "^7.6.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "~8.6.0",
+    "prettier": "~2.6.2",
+    "rimraf": "^4.4.0",
+    "socket.io-client": "^4.4.1",
+    "typescript": "~4.5.5"
+  },
+  "typeValidation": {
+    "broken": {}
+  },
   "scripts": {
     "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:compile": "concurrently npm:tsc npm:build:esnext",
+    "build:compile": "npm run typetests:gen && concurrently npm:tsc npm:build:esnext",
     "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:full": "npm run build",
@@ -31,37 +58,8 @@
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-    "tsc": "tsc"
-  },
-  "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/driver-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0"
-  },
-  "devDependencies": {
-    "@fluid-tools/build-cli": "^0.8.0",
-    "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/driver-base-previous": "npm:@fluidframework/driver-base@2.0.0-internal.3.0.0",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
-    "@types/node": "^14.18.36",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
-    "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
-    "socket.io-client": "^4.4.1",
-    "typescript": "~4.5.5"
-  },
-  "typeValidation": {
-    "version": "2.0.0-internal.3.1.0",
-    "previousVersionStyle": "~previousMinor",
-    "baselineRange": ">=2.0.0-internal.3.0.0 <2.0.0-internal.3.1.0",
-    "baselineVersion": "2.0.0-internal.3.0.0",
-    "broken": {}
+    "tsc": "tsc",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   }
-}
+}

package/src/documentDeltaConnection.ts

@@ -30,6 +30,7 @@ import {
 	loggerToMonitoringContext,
 	MonitoringContext,
 	EventEmitterWithErrorHandling,
+	normalizeError,
 } from "@fluidframework/telemetry-utils";
 import type { Socket } from "socket.io-client";
 // For now, this package is versioned and released in unison with the specific drivers
@@ -81,10 +82,21 @@ export class DocumentDeltaConnection
 	}
 
 	public get disposed() {
-		assert(
-			this._disposed || this.socket.connected,
-			0x244 /* "Socket is closed, but connection is not!" */,
-		);
+		// Increase the stack trace limit temporarily, so as to debug better in case it occurs.
+		// We are seeing this in telemetry and we are unable to figure out why it is happening, so this should help.
+		const originalStackTraceLimit = (Error as any).stackTraceLimit;
+		try {
+			(Error as any).stackTraceLimit = 50;
+			assert(
+				this._disposed || this.socket.connected,
+				0x244 /* "Socket is closed, but connection is not!" */,
+			);
+		} catch (error) {
+			const normalizedError = this.addPropsToError(error);
+			throw normalizedError;
+		} finally {
+			(Error as any).stackTraceLimit = originalStackTraceLimit;
+		}
 		return this._disposed;
 	}
 
@@ -120,6 +132,7 @@ export class DocumentDeltaConnection
 		public documentId: string,
 		logger: ITelemetryLogger,
 		private readonly enableLongPollingDowngrades: boolean = false,
+		protected readonly connectionId?: string,
 	) {
 		super((name, error) => {
 			logger.sendErrorEvent(
@@ -223,7 +236,18 @@ export class DocumentDeltaConnection
 	}
 
 	private checkNotClosed() {
-		assert(!this.disposed, 0x20c /* "connection disposed" */);
+		// Increase the stack trace limit temporarily, so as to debug better in case it occurs.
+		// We are seeing this in telemetry and we are unable to figure out why it is happening, so this should help.
+		const originalStackTraceLimit = (Error as any).stackTraceLimit;
+		try {
+			(Error as any).stackTraceLimit = 50;
+			assert(!this.disposed, 0x20c /* "connection disposed" */);
+		} catch (error) {
+			const normalizedError = this.addPropsToError(error);
+			throw normalizedError;
+		} finally {
+			(Error as any).stackTraceLimit = originalStackTraceLimit;
+		}
 	}
 
 	/**
@@ -318,7 +342,26 @@ export class DocumentDeltaConnection
 	/**
 	 * Disconnect from the websocket and close the websocket too.
 	 */
-	protected closeSocket(error: IAnyDriverError) {
+	private closeSocket(error: IAnyDriverError) {
+		if (this._disposed) {
+			// This would be rare situation due to complexity around socket emitting events.
+			this.logger.sendTelemetryEvent(
+				{
+					eventName: "SocketCloseOnDisposedConnection",
+					driverVersion,
+					details: JSON.stringify({
+						...this.getConnectionDetailsProps(),
+						trackedListenerCount: this.trackedListeners.size,
+					}),
+				},
+				error,
+			);
+			return;
+		}
+		this.closeSocketCore(error);
+	}
+
+	protected closeSocketCore(error: IAnyDriverError) {
 		this.disconnect(error);
 	}
 
@@ -332,8 +375,7 @@ export class DocumentDeltaConnection
 			eventName: "ClientClosingDeltaConnection",
 			driverVersion,
 			details: JSON.stringify({
-				disposed: this._disposed,
-				socketConnected: this.socket.connected,
+				...this.getConnectionDetailsProps(),
 			}),
 		});
 		this.disconnect(
@@ -361,23 +403,24 @@ export class DocumentDeltaConnection
 		// to prevent normal messages from being emitted.
 		this._disposed = true;
 
-		// Let user of connection object know about disconnect. This has to happen in between setting _disposed and
-		// removing all listeners!
+		// Remove all listeners listening on the socket. These are listeners on socket and not on this connection
+		// object. Anyway since we have disposed this connection object, nobody should listen to event on socket
+		// anymore.
+		this.removeTrackedListeners();
+
+		// Clear the connection/socket before letting the deltaManager/connection manager know about the disconnect.
+		this.disconnectCore();
+
+		// Let user of connection object know about disconnect.
 		this.emit("disconnect", err);
 		this.logger.sendTelemetryEvent({
 			eventName: "AfterDisconnectEvent",
 			driverVersion,
 			details: JSON.stringify({
-				socketConnected: this.socket.connected,
+				...this.getConnectionDetailsProps(),
 				disconnectListenerCount: this.listenerCount("disconnect"),
 			}),
 		});
-		// user of DeltaConnection should have processed "disconnect" event and removed all listeners. Not clear
-		// if we want to enforce that, as some users (like LocalDocumentService) do not unregister any handlers
-		// assert(this.listenerCount("disconnect") === 0, "'disconnect` events should be processed synchronously");
-
-		this.removeTrackedListeners();
-		this.disconnectCore();
 	}
 
 	/**
@@ -403,14 +446,34 @@ export class DocumentDeltaConnection
 
 		this._details = await new Promise<IConnected>((resolve, reject) => {
 			const failAndCloseSocket = (err: IAnyDriverError) => {
-				this.closeSocket(err);
+				try {
+					this.closeSocket(err);
+				} catch (failError) {
+					const normalizedError = this.addPropsToError(failError);
+					this.logger.sendErrorEvent({ eventName: "CloseSocketError" }, normalizedError);
+				}
 				reject(err);
 			};
 
 			const failConnection = (err: IAnyDriverError) => {
-				this.disconnect(err);
+				try {
+					this.disconnect(err);
+				} catch (failError) {
+					const normalizedError = this.addPropsToError(failError);
+					this.logger.sendErrorEvent(
+						{ eventName: "FailConnectionError" },
+						normalizedError,
+					);
+				}
 				reject(err);
 			};
+
+			// Immediately set the connection timeout.
+			// Give extra 2 seconds for handshake on top of socket connection timeout.
+			this.socketConnectionTimeout = setTimeout(() => {
+				failConnection(this.createErrorObject("orderingServiceHandshakeTimeout"));
+			}, timeout + 2000);
+
 			// Listen for connection issues
 			this.addConnectionListener("connect_error", (error) => {
 				internalSocketConnectionFailureCount++;
@@ -560,16 +623,31 @@ export class DocumentDeltaConnection
 			});
 
 			this.socket.emit("connect_document", connectMessage);
-
-			// Give extra 2 seconds for handshake on top of socket connection timeout
-			this.socketConnectionTimeout = setTimeout(() => {
-				failConnection(this.createErrorObject("orderingServiceHandshakeTimeout"));
-			}, timeout + 2000);
 		});
 
 		assert(!this.disposed, 0x246 /* "checking consistency of socket & _disposed flags" */);
 	}
 
+	private addPropsToError(errorToBeNormalized: unknown) {
+		const normalizedError = normalizeError(errorToBeNormalized, {
+			props: {
+				details: JSON.stringify({
+					...this.getConnectionDetailsProps(),
+				}),
+			},
+		});
+		return normalizedError;
+	}
+
+	private getConnectionDetailsProps() {
+		return {
+			disposed: this._disposed,
+			socketConnected: this.socket?.connected,
+			clientId: this._details?.clientId,
+			connectionId: this.connectionId,
+		};
+	}
+
 	protected earlyOpHandler = (documentId: string, msgs: ISequencedDocumentMessage[]) => {
 		this.queuedMessages.push(...msgs);
 	};
@@ -654,7 +732,12 @@ export class DocumentDeltaConnection
 		const errorObj = createGenericNetworkError(
 			`socket.io (${handler}): ${message}`,
 			{ canRetry },
-			{ driverVersion },
+			{
+				driverVersion,
+				details: JSON.stringify({
+					...this.getConnectionDetailsProps(),
+				}),
+			},
 		);
 
 		return errorObj;

package/src/driverUtils.ts

@@ -0,0 +1,105 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { performance } from "@fluidframework/common-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
+ */
+export function getW3CData(url: string, initiatorType: string) {
+	// 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: number | undefined; // domainLookupEnd - domainLookupStart
+	// Interval between the first fetch until the last byte of the last redirect.
+	let redirectTime: number | undefined; // redirectEnd - redirectStart
+	// Time to establish the connection to the server to retrieve the resource.
+	let tcpHandshakeTime: number | undefined; // 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: number | undefined; // connectEnd  - secureConnectionStart
+	// Interval to receive all (first to last) bytes form the server.
+	let responseNetworkTime: number | undefined; // responsEnd - responseStart
+	// Interval between the initial fetch until the last byte is received.
+	// Likely same as fetchTime + receiveContentTime.
+	let fetchStartToResponseEndTime: number | undefined; // responseEnd  - fetchStart
+	// reqStartToResponseEndTime = fetchStartToResponseEndTime - <initial TCP handshake>
+	// Interval between starting the request for the resource until receiving the last byte.
+	let reqStartToResponseEndTime: number | undefined; // responseEnd - requestStart
+	let w3cStartTime: number | undefined; // W3C Start time = fetchStart time
+
+	// getEntriesByType is only available in browser performance object
+	const resources1 = 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] as PerformanceResourceTiming;
+		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,
+	};
+}
+
+/*
+ * 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.
+ */
+export async function promiseRaceWithWinner<T>(
+	promises: Promise<T>[],
+): Promise<{ index: number; value: T }> {
+	return new Promise((resolve, reject) => {
+		promises.forEach((p, index) => {
+			p.then((v) => resolve({ index, value: v })).catch(reject);
+		});
+	});
+}

package/src/index.ts

@@ -4,3 +4,4 @@
  */
 
 export { DocumentDeltaConnection } from "./documentDeltaConnection";
+export { getW3CData, promiseRaceWithWinner } from "./driverUtils";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-base";
-export const pkgVersion = "2.0.0-dev.3.1.0.125672";
+export const pkgVersion = "2.0.0-dev.4.2.0.153917";