@fluidframework/container-loader 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/container-loader",
-  "version": "2.0.0-dev.4.4.0.162253",
+  "version": "2.0.0-dev.5.2.0.169897",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,14 +37,14 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/container-definitions": "2.0.0-dev.4.4.0.162253",
-    "@fluidframework/container-utils": "2.0.0-dev.4.4.0.162253",
-    "@fluidframework/core-interfaces": "2.0.0-dev.4.4.0.162253",
-    "@fluidframework/driver-definitions": "2.0.0-dev.4.4.0.162253",
-    "@fluidframework/driver-utils": "2.0.0-dev.4.4.0.162253",
+    "@fluidframework/container-definitions": "2.0.0-dev.5.2.0.169897",
+    "@fluidframework/container-utils": "2.0.0-dev.5.2.0.169897",
+    "@fluidframework/core-interfaces": "2.0.0-dev.5.2.0.169897",
+    "@fluidframework/driver-definitions": "2.0.0-dev.5.2.0.169897",
+    "@fluidframework/driver-utils": "2.0.0-dev.5.2.0.169897",
     "@fluidframework/protocol-base": "^0.1039.1000",
     "@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",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
@@ -53,13 +53,13 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-loader-utils": "2.0.0-dev.4.4.0.162253",
-    "@fluid-tools/build-cli": "^0.17.0",
-    "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.17.0",
-    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.4.1.0",
+    "@fluid-internal/test-loader-utils": "2.0.0-dev.5.2.0.169897",
+    "@fluid-tools/build-cli": "^0.20.0-169245",
+    "@fluidframework/build-common": "^1.2.0",
+    "@fluidframework/build-tools": "^0.20.0-169245",
+    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.5.0.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.4.0.162253",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.5.2.0.169897",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",
@@ -85,13 +85,11 @@
     "broken": {}
   },
   "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "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",
     "build:test": "tsc --project ./src/test/tsconfig.json",
     "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",

package/src/connectionManager.ts

@@ -4,11 +4,7 @@
  */
 
 import { default as AbortController } from "abort-controller";
-import {
-	IDisposable,
-	ITelemetryLogger,
-	ITelemetryProperties,
-} from "@fluidframework/common-definitions";
+import { IDisposable, ITelemetryProperties } from "@fluidframework/common-definitions";
 import { assert, performance, TypedEventEmitter } from "@fluidframework/common-utils";
 import {
 	IDeltaQueue,
@@ -18,7 +14,6 @@ import {
 } from "@fluidframework/container-definitions";
 import { GenericError, UsageError } from "@fluidframework/container-utils";
 import {
-	DriverErrorType,
 	IAnyDriverError,
 	IDocumentService,
 	IDocumentDeltaConnection,
@@ -48,10 +43,15 @@ import {
 	ScopeType,
 	ISequencedDocumentSystemMessage,
 } from "@fluidframework/protocol-definitions";
-import { TelemetryLogger, normalizeError } from "@fluidframework/telemetry-utils";
+import {
+	ITelemetryLoggerExt,
+	TelemetryLogger,
+	normalizeError,
+} from "@fluidframework/telemetry-utils";
 import { ReconnectMode, IConnectionManager, IConnectionManagerFactoryArgs } from "./contracts";
 import { DeltaQueue } from "./deltaQueue";
 import { SignalType } from "./protocol";
+import { isDeltaStreamConnectionForbiddenError } from "./utils";
 
 const MaxReconnectDelayInMs = 8000;
 const InitialReconnectDelayInMs = 1000;
@@ -106,6 +106,9 @@ class NoDeltaStream
 		blockSize: 0,
 	};
 	checkpointSequenceNumber?: number | undefined = undefined;
+	constructor(public readonly storageOnlyReason?: string) {
+		super();
+	}
 	submit(messages: IDocumentMessage[]): void {
 		this.emit(
 			"nack",
@@ -134,6 +137,10 @@ class NoDeltaStream
 	}
 }
 
+function isNoDeltaStreamConnection(connection: any): connection is NoDeltaStream {
+	return connection instanceof NoDeltaStream;
+}
+
 const waitForOnline = async (): Promise<void> => {
 	// Only wait if we have a strong signal that we're offline - otherwise assume we're online.
 	if (globalThis.navigator?.onLine === false && globalThis.addEventListener !== undefined) {
@@ -309,14 +316,19 @@ export class ConnectionManager implements IConnectionManager {
 	}
 
 	public get readOnlyInfo(): ReadOnlyInfo {
-		const storageOnly =
-			this.connection !== undefined && this.connection instanceof NoDeltaStream;
+		let storageOnly: boolean = false;
+		let storageOnlyReason: string | undefined;
+		if (isNoDeltaStreamConnection(this.connection)) {
+			storageOnly = true;
+			storageOnlyReason = this.connection.storageOnlyReason;
+		}
 		if (storageOnly || this._forceReadonly || this._readonlyPermissions === true) {
 			return {
 				readonly: true,
 				forced: this._forceReadonly,
 				permissions: this._readonlyPermissions,
 				storageOnly,
+				storageOnlyReason,
 			};
 		}
 
@@ -346,7 +358,7 @@ export class ConnectionManager implements IConnectionManager {
 		public readonly containerDirty: () => boolean,
 		private client: IClient,
 		reconnectAllowed: boolean,
-		private readonly logger: ITelemetryLogger,
+		private readonly logger: ITelemetryLoggerExt,
 		private readonly props: IConnectionManagerFactoryArgs,
 	) {
 		this.clientDetails = this.client.details;
@@ -373,8 +385,6 @@ export class ConnectionManager implements IConnectionManager {
 		}
 		this._disposed = true;
 
-		this.pendingConnection = undefined;
-
 		// Ensure that things like triggerConnect() will short circuit
 		this._reconnectMode = ReconnectMode.Never;
 
@@ -489,7 +499,7 @@ export class ConnectionManager implements IConnectionManager {
 		let pendingConnectionMode;
 		if (this.pendingConnection !== undefined) {
 			pendingConnectionMode = this.pendingConnection.connectionMode;
-			this.cancelConnection(); // Throw out in-progress connection attempt in favor of new attempt
+			this.cancelConnection(reason); // Throw out in-progress connection attempt in favor of new attempt
 			assert(
 				this.pendingConnection === undefined,
 				0x344 /* this.pendingConnection should be undefined */,
@@ -533,6 +543,7 @@ export class ConnectionManager implements IConnectionManager {
 			connectionMode: requestedMode,
 		};
 
+		this.props.establishConnectionHandler(reason);
 		// This loop will keep trying to connect until successful, with a delay between each iteration.
 		while (connection === undefined) {
 			if (this._disposed) {
@@ -562,12 +573,8 @@ export class ConnectionManager implements IConnectionManager {
 					connection = undefined;
 				}
 			} catch (origError: any) {
-				if (
-					typeof origError === "object" &&
-					origError !== null &&
-					origError?.errorType === DriverErrorType.deltaStreamConnectionForbidden
-				) {
-					connection = new NoDeltaStream();
+				if (isDeltaStreamConnectionForbiddenError(origError)) {
+					connection = new NoDeltaStream(origError.storageOnlyReason);
 					requestedMode = "read";
 					break;
 				}
@@ -593,6 +600,7 @@ export class ConnectionManager implements IConnectionManager {
 
 				lastError = origError;
 
+				const waitStartTime = performance.now();
 				const retryDelayFromError = getRetryDelayFromError(origError);
 				if (retryDelayFromError !== undefined) {
 					// If the error told us to wait, then we wait.
@@ -613,6 +621,14 @@ export class ConnectionManager implements IConnectionManager {
 				// NOTE: This isn't strictly true for drivers that don't require network (e.g. local driver).  Really this logic
 				// should probably live in the driver.
 				await waitForOnline();
+				this.logger.sendPerformanceEvent({
+					eventName: "WaitBetweenConnectionAttempts",
+					duration: performance.now() - waitStartTime,
+					details: JSON.stringify({
+						retryDelayFromError,
+						delayMs,
+					}),
+				});
 			}
 		}
 
@@ -674,7 +690,7 @@ export class ConnectionManager implements IConnectionManager {
 
 		if (this.connection === undefined) {
 			if (this.pendingConnection !== undefined) {
-				this.cancelConnection();
+				this.cancelConnection(reason);
 				return true;
 			}
 			return false;
@@ -712,7 +728,7 @@ export class ConnectionManager implements IConnectionManager {
 	/**
 	 * Cancel in-progress connection attempt.
 	 */
-	private cancelConnection() {
+	private cancelConnection(reason: string) {
 		assert(
 			this.pendingConnection !== undefined,
 			0x345 /* this.pendingConnection is undefined when trying to cancel */,
@@ -720,6 +736,7 @@ export class ConnectionManager implements IConnectionManager {
 		this.pendingConnection.abort();
 		this.pendingConnection = undefined;
 		this.logger.sendTelemetryEvent({ eventName: "ConnectionCancelReceived" });
+		this.props.cancelConnectionHandler(`Cancel Pending Connection due to ${reason}`);
 	}
 
 	/**
@@ -941,7 +958,7 @@ export class ConnectionManager implements IConnectionManager {
 
 		this.triggerConnect(
 			error !== undefined
-				? "Reconnect on Error"
+				? "Reconnecting due to Error"
 				: `Reconnecting due to: ${disconnectMessage}`,
 			requestedMode,
 		);
@@ -960,6 +977,7 @@ export class ConnectionManager implements IConnectionManager {
 				forcedReadonly: this.readOnlyInfo.forced,
 				readonlyPermissions: this.readOnlyInfo.permissions,
 				storageOnly: this.readOnlyInfo.storageOnly,
+				storageOnlyReason: this.readOnlyInfo.storageOnlyReason,
 			});
 			this.props.closeHandler(error);
 			return undefined;

package/src/connectionStateHandler.ts

@@ -3,16 +3,16 @@
  * Licensed under the MIT License.
  */
 
-import {
-	ITelemetryLogger,
-	ITelemetryProperties,
-	TelemetryEventCategory,
-} from "@fluidframework/common-definitions";
+import { ITelemetryProperties, TelemetryEventCategory } from "@fluidframework/common-definitions";
 import { assert, Timer } from "@fluidframework/common-utils";
 import { IConnectionDetailsInternal, IDeltaManager } from "@fluidframework/container-definitions";
 import { IAnyDriverError } from "@fluidframework/driver-definitions";
 import { ISequencedClient, IClient } from "@fluidframework/protocol-definitions";
-import { PerformanceEvent, loggerToMonitoringContext } from "@fluidframework/telemetry-utils";
+import {
+	ITelemetryLoggerExt,
+	PerformanceEvent,
+	loggerToMonitoringContext,
+} from "@fluidframework/telemetry-utils";
 import { ConnectionState } from "./connectionState";
 import { CatchUpMonitor, ICatchUpMonitor } from "./catchUpMonitor";
 import { ILocalSequencedClient, IProtocolHandler } from "./protocol";
@@ -27,7 +27,7 @@ const JoinSignalTimeoutMs = 5000;
 
 /** Constructor parameter type for passing in dependencies needed by the ConnectionStateHandler */
 export interface IConnectionStateHandlerInputs {
-	logger: ITelemetryLogger;
+	logger: ITelemetryLoggerExt;
 	/** Log to telemetry any change in state, included to Connecting */
 	connectionStateChanged: (
 		value: ConnectionState,
@@ -59,6 +59,13 @@ export interface IConnectionStateHandler {
 	initProtocol(protocol: IProtocolHandler): void;
 	receivedConnectEvent(details: IConnectionDetailsInternal): void;
 	receivedDisconnectEvent(reason: string, error?: IAnyDriverError): void;
+	establishingConnection(reason: string): void;
+	/**
+	 * Switches state to disconnected when we are still establishing connection during container.load(),
+	 * container connect() or reconnect and the container gets closed or disposed or disconnect happens.
+	 * @param reason - reason for cancelling the connection.
+	 */
+	cancelEstablishingConnection(reason: string): void;
 }
 
 export function createConnectionStateHandler(
@@ -144,6 +151,14 @@ class ConnectionStateHandlerPassThrough
 		return this.pimpl.receivedDisconnectEvent(reason, error);
 	}
 
+	public establishingConnection(reason: string) {
+		return this.pimpl.establishingConnection(reason);
+	}
+
+	public cancelEstablishingConnection(reason: string) {
+		return this.pimpl.cancelEstablishingConnection(reason);
+	}
+
 	public receivedConnectEvent(details: IConnectionDetailsInternal) {
 		return this.pimpl.receivedConnectEvent(details);
 	}
@@ -230,9 +245,17 @@ class ConnectionStateCatchup extends ConnectionStateHandlerPassThrough {
 				this.catchUpMonitor?.dispose();
 				this.catchUpMonitor = undefined;
 				break;
-			case ConnectionState.CatchingUp:
+			// ConnectionState.EstablishingConnection state would be set when we start establishing connection
+			// during container.connect() or reconnect because of an error.
+			case ConnectionState.EstablishingConnection:
 				assert(
 					this._connectionState === ConnectionState.Disconnected,
+					0x6d2 /* connectivity transition to establishing connection */,
+				);
+				break;
+			case ConnectionState.CatchingUp:
+				assert(
+					this._connectionState === ConnectionState.EstablishingConnection,
 					0x3e3 /* connectivity transitions */,
 				);
 				break;
@@ -471,6 +494,27 @@ class ConnectionStateHandler implements IConnectionStateHandler {
 		this.setConnectionState(ConnectionState.Disconnected, reason, error);
 	}
 
+	public cancelEstablishingConnection(reason: string) {
+		assert(
+			this._connectionState === ConnectionState.EstablishingConnection,
+			0x6d3 /* Connection state should be EstablishingConnection */,
+		);
+		assert(this.connection === undefined, 0x6d4 /* No connetion should be present */);
+		const oldState = this._connectionState;
+		this._connectionState = ConnectionState.Disconnected;
+		this.handler.connectionStateChanged(ConnectionState.Disconnected, oldState, reason);
+	}
+
+	public establishingConnection(reason: string) {
+		const oldState = this._connectionState;
+		this._connectionState = ConnectionState.EstablishingConnection;
+		this.handler.connectionStateChanged(
+			ConnectionState.EstablishingConnection,
+			oldState,
+			`Establishing Connection due to ${reason}`,
+		);
+	}
+
 	private shouldWaitForJoinSignal() {
 		assert(
 			this.connection !== undefined,