@fluidframework/container-runtime 2.81.1 → 2.83.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime",
-  "version": "2.81.1",
+  "version": "2.83.0",
   "description": "Fluid container runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -119,19 +119,19 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.81.1",
-    "@fluidframework/container-definitions": "~2.81.1",
-    "@fluidframework/container-runtime-definitions": "~2.81.1",
-    "@fluidframework/core-interfaces": "~2.81.1",
-    "@fluidframework/core-utils": "~2.81.1",
-    "@fluidframework/datastore": "~2.81.1",
-    "@fluidframework/driver-definitions": "~2.81.1",
-    "@fluidframework/driver-utils": "~2.81.1",
-    "@fluidframework/id-compressor": "~2.81.1",
-    "@fluidframework/runtime-definitions": "~2.81.1",
-    "@fluidframework/runtime-utils": "~2.81.1",
-    "@fluidframework/telemetry-utils": "~2.81.1",
-    "@tylerbu/sorted-btree-es6": "^1.8.0",
+    "@fluid-internal/client-utils": "~2.83.0",
+    "@fluidframework/container-definitions": "~2.83.0",
+    "@fluidframework/container-runtime-definitions": "~2.83.0",
+    "@fluidframework/core-interfaces": "~2.83.0",
+    "@fluidframework/core-utils": "~2.83.0",
+    "@fluidframework/datastore": "~2.83.0",
+    "@fluidframework/driver-definitions": "~2.83.0",
+    "@fluidframework/driver-utils": "~2.83.0",
+    "@fluidframework/id-compressor": "~2.83.0",
+    "@fluidframework/runtime-definitions": "~2.83.0",
+    "@fluidframework/runtime-utils": "~2.83.0",
+    "@fluidframework/telemetry-utils": "~2.83.0",
+    "@tylerbu/sorted-btree-es6": "^2.1.1",
     "double-ended-queue": "^2.1.0-0",
     "lz4js": "^0.2.0",
     "semver-ts": "^1.0.3",
@@ -140,21 +140,21 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.81.1",
-    "@fluid-private/stochastic-test-utils": "~2.81.1",
-    "@fluid-private/test-pairwise-generator": "~2.81.1",
+    "@fluid-internal/mocha-test-setup": "~2.83.0",
+    "@fluid-private/stochastic-test-utils": "~2.83.0",
+    "@fluid-private/test-pairwise-generator": "~2.83.0",
     "@fluid-tools/benchmark": "^0.52.0",
     "@fluid-tools/build-cli": "^0.63.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.63.0",
-    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.81.0",
-    "@fluidframework/eslint-config-fluid": "~2.81.1",
-    "@fluidframework/test-runtime-utils": "~2.81.1",
+    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.82.0",
+    "@fluidframework/eslint-config-fluid": "~2.83.0",
+    "@fluidframework/test-runtime-utils": "~2.83.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/double-ended-queue": "^2.1.0",
     "@types/lz4js": "^0.2.0",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^18.19.0",
+    "@types/node": "~20.19.30",
     "@types/sinon": "^17.0.3",
     "c8": "^10.1.3",
     "concurrently": "^9.2.1",

package/src/containerRuntime.ts

@@ -2872,6 +2872,7 @@ export class ContainerRuntime
 			}
 			case ConnectionState.CatchingUp: {
 				assert(
+					// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- TODO: ADO#58523 Code owners should verify if this code change is safe and make it if so or update this comment otherwise
 					this.getConnectionState !== undefined &&
 						this.getConnectionState() === ConnectionState.CatchingUp,
 					0xc8d /* connection state mismatch between getConnectionState and setConnectionStatus notification */,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.81.1";
+export const pkgVersion = "2.83.0";

package/src/runtimeLayerCompatState.ts

@@ -5,6 +5,7 @@
 
 import {
 	generation,
+	LayerCompatibilityPolicyWindowMonths,
 	type ILayerCompatDetails,
 	type ILayerCompatSupportRequirements,
 } from "@fluid-internal/client-utils";
@@ -59,10 +60,15 @@ export const runtimeCompatDetailsForLoader: ILayerCompatDetails = {
  */
 export const loaderSupportRequirementsForRuntime: ILayerCompatSupportRequirements = {
 	/**
-	 * Minimum generation that Loader must be at to be compatible with Runtime. Note that 0 is used here so
-	 * that Loader layers before the introduction of the layer compatibility enforcement are compatible.
+	 * Minimum generation that Loader must be at to be compatible with this Runtime. This is calculated
+	 * based on the LayerCompatibilityPolicyWindowMonths.RuntimeLoader value which defines how many months old can
+	 * the Loader layer be compared to the Runtime layer for them to still be considered compatible.
+	 * The minimum valid generation value is 0.
 	 */
-	minSupportedGeneration: 0,
+	minSupportedGeneration: Math.max(
+		0,
+		runtimeCoreCompatDetails.generation - LayerCompatibilityPolicyWindowMonths.RuntimeLoader,
+	),
 	/**
 	 * The features that the Loader must support to be compatible with Runtime.
 	 */
@@ -87,10 +93,16 @@ export const runtimeCompatDetailsForDataStore: ILayerCompatDetails = {
  */
 export const dataStoreSupportRequirementsForRuntime: ILayerCompatSupportRequirements = {
 	/**
-	 * Minimum generation that DataStore must be at to be compatible with Runtime. Note that 0 is used here so
-	 * that DataStore layers before the introduction of the layer compatibility enforcement are compatible.
+	 * Minimum generation that DataStore must be at to be compatible with this Runtime. This is calculated
+	 * based on the LayerCompatibilityPolicyWindowMonths.RuntimeDataStore value which defines how many months old can
+	 * the DataStore layer be compared to the Runtime layer for them to still be considered compatible.
+	 * The minimum valid generation value is 0.
 	 */
-	minSupportedGeneration: 0,
+	minSupportedGeneration: Math.max(
+		0,
+		runtimeCoreCompatDetails.generation -
+			LayerCompatibilityPolicyWindowMonths.RuntimeDataStore,
+	),
 	/**
 	 * The features that the DataStore must support to be compatible with Runtime.
 	 */

package/src/summary/summaryDelayLoadedModule/summarizer.ts

@@ -9,7 +9,7 @@ import type {
 	SummarizerStopReason,
 } from "@fluidframework/container-runtime-definitions/internal";
 import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
-import { Deferred } from "@fluidframework/core-utils/internal";
+import { assert, Deferred } from "@fluidframework/core-utils/internal";
 import {
 	type IFluidErrorBase,
 	type ITelemetryLoggerExt,
@@ -165,9 +165,40 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 	}
 
 	private async runCore(onBehalfOf: string): Promise<SummarizerStopReason> {
-		const runCoordinator: ICancellableSummarizerController = await this.runCoordinatorCreateFn(
-			this.runtime,
+		// Race coordinator creation against a timeout to ensure we don't hang indefinitely
+		// if the summarizer container fails to connect.
+		let coordinatorTimedOut = false;
+		const coordinatorTimeoutMs = 2 * 60 * 1000; // 2 minutes
+		const coordinatorResult = await Promise.race([
+			this.runCoordinatorCreateFn(this.runtime).then((coordinator) => {
+				if (coordinatorTimedOut) {
+					coordinator.stop("summarizerClientDisconnected");
+				}
+				return coordinator;
+			}),
+			new Promise<undefined>((resolve) =>
+				setTimeout(() => {
+					coordinatorTimedOut = true;
+					resolve(undefined);
+				}, coordinatorTimeoutMs),
+			),
+		]);
+
+		// If we timed out before coordinator was created, exit early
+		if (coordinatorTimedOut) {
+			this.logger.sendTelemetryEvent({
+				eventName: "CreateRunCoordinatorTimeout",
+				onBehalfOf,
+				timeoutMs: coordinatorTimeoutMs,
+			});
+			return "summarizerClientDisconnected";
+		}
+
+		assert(
+			coordinatorResult !== undefined,
+			0xcd6 /* Expect coordinatorResult to be defined */,
 		);
+		const runCoordinator = coordinatorResult;
 
 		// Wait for either external signal to cancel, or loss of connectivity.
 		const stopP = Promise.race([runCoordinator.waitCancelled, this.stopDeferred.promise]);
@@ -216,10 +247,22 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 		// summarizer client to not be created until current summarizer fully moves to exit, and that would reduce
 		// cons of #2 substantially.
 
-		// Cleanup after running
-		await runningSummarizer.waitStop(
+		// Cleanup after running with a timeout to prevent hanging
+		const waitStopPromise = runningSummarizer.waitStop(
 			!runCoordinator.cancelled && Summarizer.stopReasonCanRunLastSummary(stopReason),
 		);
+		const summarizerStopTimeoutMs = 2 * 60 * 1000; // 2 minutes
+		const timeoutPromise = new Promise<"timeout">((resolve) =>
+			setTimeout(() => resolve("timeout"), summarizerStopTimeoutMs),
+		);
+		const waitStopResult = await Promise.race([waitStopPromise, timeoutPromise]);
+		if (waitStopResult === "timeout") {
+			this.logger.sendTelemetryEvent({
+				eventName: "SummarizerStopTimeout",
+				onBehalfOf,
+				timeoutMs: summarizerStopTimeoutMs,
+			});
+		}
 
 		// Propagate reason and ensure that if someone is waiting for cancellation token, they are moving to exit
 		runCoordinator.stop(stopReason);

package/src/summary/summaryManager.ts

@@ -103,6 +103,7 @@ export class SummaryManager
 	private state = SummaryManagerState.Off;
 	private summarizer?: ISummarizer;
 	private _disposed = false;
+	private summarizerStopTimeout?: ReturnType<typeof setTimeout>;
 
 	public get disposed(): boolean {
 		return this._disposed;
@@ -347,16 +348,26 @@ export class SummaryManager
 			})
 			.finally(() => {
 				assert(this.state !== SummaryManagerState.Off, 0x264 /* "Expected: Not Off" */);
-				this.state = SummaryManagerState.Off;
+				this.cleanupAfterSummarizerStop();
+			});
+	}
 
-				this.cleanupForwardedEvents();
-				this.summarizer?.close();
-				this.summarizer = undefined;
+	private cleanupAfterSummarizerStop(): void {
+		this.state = SummaryManagerState.Off;
 
-				if (this.getShouldSummarizeState().shouldSummarize) {
-					this.startSummarization();
-				}
-			});
+		// Clear any pending stop timeout to avoid it firing for a different summarizer
+		if (this.summarizerStopTimeout !== undefined) {
+			clearTimeout(this.summarizerStopTimeout);
+			this.summarizerStopTimeout = undefined;
+		}
+
+		this.cleanupForwardedEvents();
+		this.summarizer?.close();
+		this.summarizer = undefined;
+
+		if (this.getShouldSummarizeState().shouldSummarize) {
+			this.startSummarization();
+		}
 	}
 
 	private stop(reason: SummarizerStopReason): void {
@@ -368,6 +379,23 @@ export class SummaryManager
 		// Stopping the running summarizer client should trigger a change
 		// in states when the running summarizer closes
 		this.summarizer?.stop(reason);
+
+		const summarizerCloseTimeoutMs = 2 * 60 * 1000; // 2 minutes
+		// Clear any existing timeout before setting a new one
+		if (this.summarizerStopTimeout !== undefined) {
+			clearTimeout(this.summarizerStopTimeout);
+		}
+		// Set a timeout to force cleanup if the summarizer doesn't close in time
+		this.summarizerStopTimeout = setTimeout(() => {
+			if (this.state === SummaryManagerState.Stopping && this.summarizer !== undefined) {
+				this.logger.sendTelemetryEvent({
+					eventName: "SummarizerStopTimeout",
+					timeoutMs: summarizerCloseTimeoutMs,
+					stopReason: reason,
+				});
+				this.cleanupAfterSummarizerStop();
+			}
+		}, summarizerCloseTimeoutMs);
 	}
 
 	/**
@@ -453,6 +481,9 @@ export class SummaryManager
 		this.connectedState.off("connected", this.handleConnected);
 		this.connectedState.off("disconnected", this.handleDisconnected);
 		this.cleanupForwardedEvents();
+		if (this.summarizerStopTimeout !== undefined) {
+			clearTimeout(this.summarizerStopTimeout);
+		}
 		this._disposed = true;
 	}
 

package/api-extractor-lint.json

@@ -1,4 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
-}

package/biome.jsonc

@@ -1,4 +0,0 @@
-{
-	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
-	"extends": ["../../../biome.jsonc"]
-}