@fluidframework/driver-base 2.0.0-dev.4.4.0.162253 → 2.0.0-dev.5.2.0.169897

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-base",
-  "version": "2.0.0-dev.4.4.0.162253",
+  "version": "2.0.0-dev.5.2.0.169897",
   "description": "Shared driver code for Fluid driver implementations",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -17,16 +17,16 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/driver-definitions": "2.0.0-dev.4.4.0.162253",
-    "@fluidframework/driver-utils": "2.0.0-dev.4.4.0.162253",
+    "@fluidframework/driver-definitions": "2.0.0-dev.5.2.0.169897",
+    "@fluidframework/driver-utils": "2.0.0-dev.5.2.0.169897",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.4.4.0.162253"
+    "@fluidframework/telemetry-utils": "2.0.0-dev.5.2.0.169897"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.17.0",
-    "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.17.0",
-    "@fluidframework/driver-base-previous": "npm:@fluidframework/driver-base@2.0.0-internal.4.1.0",
+    "@fluid-tools/build-cli": "^0.20.0-169245",
+    "@fluidframework/build-common": "^1.2.0",
+    "@fluidframework/build-tools": "^0.20.0-169245",
+    "@fluidframework/driver-base-previous": "npm:@fluidframework/driver-base@2.0.0-internal.5.0.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/node": "^14.18.38",
@@ -35,20 +35,18 @@
     "eslint": "~8.6.0",
     "prettier": "~2.6.2",
     "rimraf": "^4.4.0",
-    "socket.io-client": "^4.4.1",
+    "socket.io-client": "^4.6.1",
     "typescript": "~4.5.5"
   },
   "typeValidation": {
     "broken": {}
   },
   "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run typetests:gen && npm run tsc",
-    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
     "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",
-    "build:full:compile": "npm run build:compile",
     "build:genver": "gen-version",
     "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",

package/src/documentDeltaConnection.ts

@@ -22,8 +22,9 @@ import {
 	ITokenClaims,
 	ScopeType,
 } from "@fluidframework/protocol-definitions";
-import { IDisposable, ITelemetryLogger } from "@fluidframework/common-definitions";
+import { IDisposable, ITelemetryProperties } from "@fluidframework/common-definitions";
 import {
+	ITelemetryLoggerExt,
 	ChildLogger,
 	extractLogSafeErrorProperties,
 	getCircularReplacer,
@@ -82,21 +83,10 @@ export class DocumentDeltaConnection
 	}
 
 	public get 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 || 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;
-		}
+		assert(
+			this._disposed || this.socket.connected,
+			0x244 /* "Socket is closed, but connection is not!" */,
+		);
 		return this._disposed;
 	}
 
@@ -110,7 +100,7 @@ export class DocumentDeltaConnection
 	/**
 	 * @deprecated Implementors should manage their own logger or monitoring context
 	 */
-	protected get logger(): ITelemetryLogger {
+	protected get logger(): ITelemetryLoggerExt {
 		return this.mc.logger;
 	}
 
@@ -130,11 +120,12 @@ export class DocumentDeltaConnection
 	protected constructor(
 		protected readonly socket: Socket,
 		public documentId: string,
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		private readonly enableLongPollingDowngrades: boolean = false,
 		protected readonly connectionId?: string,
 	) {
 		super((name, error) => {
+			this.addPropsToError(error);
 			logger.sendErrorEvent(
 				{
 					eventName: "DeltaConnection:EventException",
@@ -236,18 +227,7 @@ export class DocumentDeltaConnection
 	}
 
 	private checkNotDisposed() {
-		// 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;
-		}
+		assert(!this.disposed, 0x20c /* "connection disposed" */);
 	}
 
 	/**
@@ -341,17 +321,6 @@ export class DocumentDeltaConnection
 	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);
@@ -409,14 +378,6 @@ export class DocumentDeltaConnection
 
 		// Let user of connection object know about disconnect.
 		this.emit("disconnect", err);
-		this.logger.sendTelemetryEvent({
-			eventName: "AfterDisconnectEvent",
-			driverVersion,
-			details: JSON.stringify({
-				...this.getConnectionDetailsProps(),
-				disconnectListenerCount: this.listenerCount("disconnect"),
-			}),
-		});
 	}
 
 	/**
@@ -591,9 +552,14 @@ export class DocumentDeltaConnection
 			// Socket can be disconnected while waiting for Fluid protocol messages
 			// (connect_document_error / connect_document_success), as well as before DeltaManager
 			// had a chance to register its handlers.
-			this.addTrackedListener("disconnect", (reason) => {
-				const err = this.createErrorObject("disconnect", reason);
-				failAndCloseSocket(err);
+			this.addTrackedListener("disconnect", (reason, details) => {
+				failAndCloseSocket(
+					this.createErrorObjectWithProps("disconnect", reason, {
+						socketErrorType: details?.context?.type,
+						// https://www.rfc-editor.org/rfc/rfc6455#section-7.4
+						socketCode: details?.context?.code,
+					}),
+				);
 			});
 
 			this.addTrackedListener("error", (error) => {
@@ -705,25 +671,44 @@ export class DocumentDeltaConnection
 		this.connectionListeners.clear();
 	}
 
+	private getErrorMessage(error?: any): string {
+		if (error?.type !== "TransportError") {
+			return extractLogSafeErrorProperties(error, true).message;
+		}
+		// JSON.stringify drops Error.message
+		const messagePrefix = error?.message !== undefined ? `${error.message}: ` : "";
+
+		// Websocket errors reported by engine.io-client.
+		// They are Error objects with description containing WS error and description = "TransportError"
+		// Please see https://github.com/socketio/engine.io-client/blob/7245b80/lib/transport.ts#L44,
+		return `${messagePrefix}${JSON.stringify(error, getCircularReplacer())}`;
+	}
+
+	private createErrorObjectWithProps(
+		handler: string,
+		error?: any,
+		props?: ITelemetryProperties,
+		canRetry = true,
+	): IAnyDriverError {
+		return createGenericNetworkError(
+			`socket.io (${handler}): ${this.getErrorMessage(error)}`,
+			{ canRetry },
+			{
+				...props,
+				driverVersion,
+				details: JSON.stringify({
+					...this.getConnectionDetailsProps(),
+				}),
+			},
+		);
+	}
+
 	/**
 	 * Error raising for socket.io issues
 	 */
 	protected createErrorObject(handler: string, error?: any, canRetry = true): IAnyDriverError {
-		let message: string;
-		if (error?.type === "TransportError") {
-			// JSON.stringify drops Error.message
-			const messagePrefix = error?.message !== undefined ? `${error.message}: ` : "";
-
-			// Websocket errors reported by engine.io-client.
-			// They are Error objects with description containing WS error and description = "TransportError"
-			// Please see https://github.com/socketio/engine.io-client/blob/7245b80/lib/transport.ts#L44,
-			message = `${messagePrefix}${JSON.stringify(error, getCircularReplacer())}`;
-		} else {
-			message = extractLogSafeErrorProperties(error, true).message;
-		}
-
-		const errorObj = createGenericNetworkError(
-			`socket.io (${handler}): ${message}`,
+		return createGenericNetworkError(
+			`socket.io (${handler}): ${this.getErrorMessage(error)}`,
 			{ canRetry },
 			{
 				driverVersion,
@@ -732,7 +717,5 @@ export class DocumentDeltaConnection
 				}),
 			},
 		);
-
-		return errorObj;
 	}
 }

package/src/driverUtils.ts

@@ -4,6 +4,8 @@
  */
 
 import { performance } from "@fluidframework/common-utils";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 
 /**
  * Extract and return the w3c data.
@@ -103,3 +105,39 @@ export async function promiseRaceWithWinner<T>(
 		});
 	});
 }
+
+export function validateMessages(
+	reason: string,
+	messages: ISequencedDocumentMessage[],
+	from: number,
+	logger: ITelemetryLoggerExt,
+) {
+	if (messages.length !== 0) {
+		const start = messages[0].sequenceNumber;
+		const length = messages.length;
+		const last = messages[length - 1].sequenceNumber;
+		if (start !== from) {
+			logger.sendErrorEvent({
+				eventName: "OpsFetchViolation",
+				reason,
+				from,
+				start,
+				last,
+				length,
+			});
+			messages.length = 0;
+		}
+		if (last + 1 !== from + length) {
+			logger.sendErrorEvent({
+				eventName: "OpsFetchViolation",
+				reason,
+				from,
+				start,
+				last,
+				length,
+			});
+			// we can do better here by finding consecutive sub-block and return it
+			messages.length = 0;
+		}
+	}
+}

package/src/index.ts

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

package/src/packageVersion.ts

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