@fluidframework/container-loader 2.0.0-dev.3.1.0.125672 → 2.0.0-dev.4.1.0.148229

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-dev.3.1.0.125672",
+  "version": "2.0.0-dev.4.1.0.148229",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,34 +14,6 @@
   "main": "dist/index.js",
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
-  "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: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/",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
-    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-    "test": "npm run test:mocha",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc",
-    "tsc:watch": "tsc --watch",
-    "typetests:gen": "flub generate typetests --generate --dir .",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
   "nyc": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -64,15 +36,15 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/container-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.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-base": "^0.1038.2000",
+    "@fluidframework/common-utils": "^1.1.1",
+    "@fluidframework/container-definitions": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/container-utils": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/core-interfaces": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/driver-definitions": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/driver-utils": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/protocol-base": "^0.1039.1000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.4.1.0.148229",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
@@ -81,37 +53,73 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.8.0",
+    "@fluid-internal/test-loader-utils": "2.0.0-dev.4.1.0.148229",
+    "@fluid-tools/build-cli": "^0.13.1",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.8.0",
-    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.3.0.0",
+    "@fluidframework/build-tools": "^0.13.1",
+    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.4.0.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/test-loader-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.1.0.148229",
+    "@microsoft/api-extractor": "^7.34.4",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.36",
+    "@types/node": "^14.18.38",
     "@types/sinon": "^7.0.13",
-    "concurrently": "^6.2.0",
+    "concurrently": "^7.6.0",
     "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.2",
+    "cross-env": "^7.0.3",
     "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
+    "rimraf": "^4.4.0",
     "sinon": "^7.4.2",
     "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": {}
+    "broken": {
+      "InterfaceDeclaration_IContainerConfig": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IPendingContainerState": {
+        "forwardCompat": false,
+        "backCompat": false
+      }
+    }
+  },
+  "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: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/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha:multireport": "cross-env FLUID_TEST_MULTIREPORT=1 npm run test:mocha",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc",
+    "tsc:watch": "tsc --watch",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   }
-}
+}

package/src/connectionManager.ts

@@ -13,11 +13,12 @@ import { assert, performance, TypedEventEmitter } from "@fluidframework/common-u
 import {
 	IDeltaQueue,
 	ReadOnlyInfo,
-	IConnectionDetails,
+	IConnectionDetailsInternal,
 	ICriticalContainerError,
 } from "@fluidframework/container-definitions";
 import { GenericError, UsageError } from "@fluidframework/container-utils";
 import {
+	DriverErrorType,
 	IAnyDriverError,
 	IDocumentService,
 	IDocumentDeltaConnection,
@@ -28,8 +29,6 @@ import {
 	createWriteError,
 	createGenericNetworkError,
 	getRetryDelayFromError,
-	waitForConnectedState,
-	DeltaStreamConnectionForbiddenError,
 	logNetworkFailure,
 	isRuntimeMessage,
 } from "@fluidframework/driver-utils";
@@ -135,6 +134,19 @@ class 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) {
+		return new Promise<void>((resolve) => {
+			const resolveAndRemoveListener = () => {
+				resolve();
+				globalThis.removeEventListener("online", resolveAndRemoveListener);
+			};
+			globalThis.addEventListener("online", resolveAndRemoveListener);
+		});
+	}
+};
+
 /**
  * Interface to track the current in-progress connection attempt.
  */
@@ -302,11 +314,12 @@ export class ConnectionManager implements IConnectionManager {
 		return { readonly: this._readonlyPermissions };
 	}
 
-	private static detailsFromConnection(connection: IDocumentDeltaConnection): IConnectionDetails {
+	private static detailsFromConnection(
+		connection: IDocumentDeltaConnection,
+	): IConnectionDetailsInternal {
 		return {
 			claims: connection.claims,
 			clientId: connection.clientId,
-			existing: connection.existing,
 			checkpointSequenceNumber: connection.checkpointSequenceNumber,
 			get initialClients() {
 				return connection.initialClients;
@@ -355,10 +368,7 @@ export class ConnectionManager implements IConnectionManager {
 
 		this._outbound.clear();
 
-		const disconnectReason =
-			error !== undefined
-				? `Closing DeltaManager (${error.message})`
-				: "Closing DeltaManager";
+		const disconnectReason = "Closing DeltaManager";
 
 		// This raises "disconnect" event if we have active connection.
 		this.disconnectFromDeltaStream(disconnectReason);
@@ -543,7 +553,7 @@ export class ConnectionManager implements IConnectionManager {
 				if (
 					typeof origError === "object" &&
 					origError !== null &&
-					origError?.errorType === DeltaStreamConnectionForbiddenError.errorType
+					origError?.errorType === DriverErrorType.deltaStreamConnectionForbidden
 				) {
 					connection = new NoDeltaStream();
 					requestedMode = "read";
@@ -572,12 +582,25 @@ export class ConnectionManager implements IConnectionManager {
 				lastError = origError;
 
 				const retryDelayFromError = getRetryDelayFromError(origError);
-				delayMs = retryDelayFromError ?? Math.min(delayMs * 2, MaxReconnectDelayInMs);
-
 				if (retryDelayFromError !== undefined) {
+					// If the error told us to wait, then we wait.
 					this.props.reconnectionDelayHandler(retryDelayFromError, origError);
+					await new Promise<void>((resolve) => {
+						setTimeout(resolve, retryDelayFromError);
+					});
+				} else if (globalThis.navigator?.onLine !== false) {
+					// If the error didn't tell us to wait, let's still wait a little bit before retrying.
+					// We skip this delay if we're confident we're offline, because we probably just need to wait to come back online.
+					await new Promise<void>((resolve) => {
+						setTimeout(resolve, delayMs);
+						delayMs = Math.min(delayMs * 2, MaxReconnectDelayInMs);
+					});
 				}
-				await waitForConnectedState(delayMs);
+
+				// If we believe we're offline, we assume there's no point in trying until we at least think we're online.
+				// 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();
 			}
 		}
 
@@ -615,7 +638,7 @@ export class ConnectionManager implements IConnectionManager {
 	 * @param args - The connection arguments
 	 */
 	private triggerConnect(connectionMode: ConnectionMode) {
-		// reconnect() has async await of waitForConnectedState(), and that causes potential race conditions
+		// reconnect() includes async awaits, and that causes potential race conditions
 		// where we might already have a connection. If it were to happen, it's possible that we will connect
 		// with different mode to `connectionMode`. Glancing through the caller chains, it looks like code should be
 		// fine (if needed, reconnect flow will get triggered again). Places where new mode matters should encode it
@@ -664,10 +687,10 @@ export class ConnectionManager implements IConnectionManager {
 		// eslint-disable-next-line @typescript-eslint/no-floating-promises
 		this._outbound.pause();
 		this._outbound.clear();
-		this.props.disconnectHandler(reason);
-
 		connection.dispose();
 
+		this.props.disconnectHandler(reason);
+
 		this._connectionVerboseProps = {};
 
 		return true;
@@ -888,12 +911,20 @@ export class ConnectionManager implements IConnectionManager {
 			return;
 		}
 
+		// If the error tells us to wait before retrying, then do so.
 		const delayMs = getRetryDelayFromError(error);
 		if (error !== undefined && delayMs !== undefined) {
 			this.props.reconnectionDelayHandler(delayMs, error);
-			await waitForConnectedState(delayMs);
+			await new Promise<void>((resolve) => {
+				setTimeout(resolve, delayMs);
+			});
 		}
 
+		// If we believe we're offline, we assume there's no point in trying again until we at least think we're online.
+		// 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.triggerConnect(requestedMode);
 	}
 

package/src/connectionStateHandler.ts

@@ -9,7 +9,7 @@ import {
 	TelemetryEventCategory,
 } from "@fluidframework/common-definitions";
 import { assert, Timer } from "@fluidframework/common-utils";
-import { IConnectionDetails, IDeltaManager } from "@fluidframework/container-definitions";
+import { IConnectionDetailsInternal, IDeltaManager } from "@fluidframework/container-definitions";
 import { ILocalSequencedClient } from "@fluidframework/protocol-base";
 import { ISequencedClient, IClient } from "@fluidframework/protocol-definitions";
 import { PerformanceEvent, loggerToMonitoringContext } from "@fluidframework/telemetry-utils";
@@ -56,7 +56,7 @@ export interface IConnectionStateHandler {
 	containerSaved(): void;
 	dispose(): void;
 	initProtocol(protocol: IProtocolHandler): void;
-	receivedConnectEvent(details: IConnectionDetails): void;
+	receivedConnectEvent(details: IConnectionDetailsInternal): void;
 	receivedDisconnectEvent(reason: string): void;
 }
 
@@ -143,7 +143,7 @@ class ConnectionStateHandlerPassThrough
 		return this.pimpl.receivedDisconnectEvent(reason);
 	}
 
-	public receivedConnectEvent(details: IConnectionDetails) {
+	public receivedConnectEvent(details: IConnectionDetailsInternal) {
 		return this.pimpl.receivedConnectEvent(details);
 	}
 
@@ -288,7 +288,7 @@ class ConnectionStateHandler implements IConnectionStateHandler {
 	private readonly prevClientLeftTimer: Timer;
 	private readonly joinOpTimer: Timer;
 	private protocol?: IProtocolHandler;
-	private connection?: IConnectionDetails;
+	private connection?: IConnectionDetailsInternal;
 	private _clientId?: string;
 
 	private waitEvent: PerformanceEvent | undefined;
@@ -398,6 +398,18 @@ class ConnectionStateHandler implements IConnectionStateHandler {
 				});
 			}
 			this.applyForConnectedState("addMemberEvent");
+		} else if (clientId === this.clientId) {
+			// If we see our clientId and it's not also our pending ID, it's our own join op
+			// being replayed, so start the timer in case our previous client is still in quorum
+			assert(
+				!this.waitingForLeaveOp,
+				"Unexpected join op with current clientId while waiting",
+			);
+			assert(
+				this.connectionState !== ConnectionState.Connected,
+				"Unexpected join op with current clientId while connected",
+			);
+			this.prevClientLeftTimer.restart();
 		}
 	}
 
@@ -472,7 +484,7 @@ class ConnectionStateHandler implements IConnectionStateHandler {
 	 * @param deltaManager - DeltaManager to be used for delaying Connected transition until caught up.
 	 * If it's undefined, then don't delay and transition to Connected as soon as Leave/Join op are accounted for
 	 */
-	public receivedConnectEvent(details: IConnectionDetails) {
+	public receivedConnectEvent(details: IConnectionDetailsInternal) {
 		this.connection = details;
 
 		const oldState = this._connectionState;