@fluidframework/container-runtime 2.4.0-297027 → 2.4.0-299374

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime",
-  "version": "2.4.0-297027",
+  "version": "2.4.0-299374",
   "description": "Fluid container runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -127,18 +127,18 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.4.0-297027",
-    "@fluidframework/container-definitions": "2.4.0-297027",
-    "@fluidframework/container-runtime-definitions": "2.4.0-297027",
-    "@fluidframework/core-interfaces": "2.4.0-297027",
-    "@fluidframework/core-utils": "2.4.0-297027",
-    "@fluidframework/datastore": "2.4.0-297027",
-    "@fluidframework/driver-definitions": "2.4.0-297027",
-    "@fluidframework/driver-utils": "2.4.0-297027",
-    "@fluidframework/id-compressor": "2.4.0-297027",
-    "@fluidframework/runtime-definitions": "2.4.0-297027",
-    "@fluidframework/runtime-utils": "2.4.0-297027",
-    "@fluidframework/telemetry-utils": "2.4.0-297027",
+    "@fluid-internal/client-utils": "2.4.0-299374",
+    "@fluidframework/container-definitions": "2.4.0-299374",
+    "@fluidframework/container-runtime-definitions": "2.4.0-299374",
+    "@fluidframework/core-interfaces": "2.4.0-299374",
+    "@fluidframework/core-utils": "2.4.0-299374",
+    "@fluidframework/datastore": "2.4.0-299374",
+    "@fluidframework/driver-definitions": "2.4.0-299374",
+    "@fluidframework/driver-utils": "2.4.0-299374",
+    "@fluidframework/id-compressor": "2.4.0-299374",
+    "@fluidframework/runtime-definitions": "2.4.0-299374",
+    "@fluidframework/runtime-utils": "2.4.0-299374",
+    "@fluidframework/telemetry-utils": "2.4.0-299374",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "double-ended-queue": "^2.1.0-0",
     "lz4js": "^0.2.0",
@@ -147,16 +147,16 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "~1.8.3",
-    "@fluid-internal/mocha-test-setup": "2.4.0-297027",
-    "@fluid-private/stochastic-test-utils": "2.4.0-297027",
-    "@fluid-private/test-pairwise-generator": "2.4.0-297027",
+    "@fluid-internal/mocha-test-setup": "2.4.0-299374",
+    "@fluid-private/stochastic-test-utils": "2.4.0-299374",
+    "@fluid-private/test-pairwise-generator": "2.4.0-299374",
     "@fluid-tools/benchmark": "^0.50.0",
-    "@fluid-tools/build-cli": "^0.46.0",
+    "@fluid-tools/build-cli": "^0.48.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.46.0",
-    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@2.3.0",
+    "@fluidframework/build-tools": "^0.48.0",
+    "@fluidframework/container-runtime-previous": "npm:@fluidframework/container-runtime@~2.3.0",
     "@fluidframework/eslint-config-fluid": "^5.4.0",
-    "@fluidframework/test-runtime-utils": "2.4.0-297027",
+    "@fluidframework/test-runtime-utils": "2.4.0-299374",
     "@microsoft/api-extractor": "7.47.8",
     "@types/double-ended-queue": "^2.1.0",
     "@types/mocha": "^9.1.1",
@@ -169,7 +169,6 @@
     "cross-env": "^7.0.3",
     "eslint": "~8.55.0",
     "mocha": "^10.2.0",
-    "mocha-json-output-reporter": "^2.0.1",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
     "prettier": "~3.0.3",
@@ -183,7 +182,7 @@
         "backCompat": false
       }
     },
-    "entrypoint": "internal"
+    "entrypoint": "legacy"
   },
   "scripts": {
     "api": "fluid-build . --task api",

package/src/containerRuntime.ts

@@ -1148,6 +1148,9 @@ export class ContainerRuntime
 		summaryOp: ISummaryContent,
 		referenceSequenceNumber?: number,
 	) => number;
+	/**
+	 * Do not call directly - use submitAddressesSignal
+	 */
 	private readonly submitSignalFn: (content: ISignalEnvelope, targetClientId?: string) => void;
 	public readonly disposeFn: (error?: ICriticalContainerError) => void;
 	public readonly closeFn: (error?: ICriticalContainerError) => void;
@@ -1711,6 +1714,13 @@ export class ContainerRuntime
 		});
 
 		const loadedFromSequenceNumber = this.deltaManager.initialSequenceNumber;
+		// If the base snapshot was generated when isolated channels were disabled, set the summary reference
+		// sequence to undefined so that this snapshot will not be used for incremental summaries. This is for
+		// back-compat and will rarely happen so its okay to re-summarize everything in the first summary.
+		const summaryReferenceSequenceNumber =
+			baseSnapshot === undefined || metadata?.disableIsolatedChannels === true
+				? undefined
+				: loadedFromSequenceNumber;
 		this.summarizerNode = createRootSummarizerNodeWithGC(
 			createChildLogger({ logger: this.logger, namespace: "SummarizerNode" }),
 			// Summarize function to call when summarize is called. Summarizer node always tracks summary state.
@@ -1718,8 +1728,7 @@ export class ContainerRuntime
 				this.summarizeInternal(fullTree, trackState, telemetryContext),
 			// Latest change sequence number, no changes since summary applied yet
 			loadedFromSequenceNumber,
-			// Summary reference sequence number, undefined if no summary yet
-			baseSnapshot !== undefined ? loadedFromSequenceNumber : undefined,
+			summaryReferenceSequenceNumber,
 			{
 				// Must set to false to prevent sending summary handle which would be pointing to
 				// a summary with an older protocol state.
@@ -1733,10 +1742,6 @@ export class ContainerRuntime
 			async () => this.garbageCollector.getBaseGCDetails(),
 		);
 
-		if (baseSnapshot) {
-			this.summarizerNode.updateBaseSummaryState(baseSnapshot);
-		}
-
 		const parentContext = wrapContext(this);
 
 		if (snapshotWithContents !== undefined) {
@@ -1753,7 +1758,7 @@ export class ContainerRuntime
 				type,
 				envelope1.contents,
 			);
-			return this.submitSignalFn(envelope2, targetClientId);
+			return this.submitEnvelopedSignal(envelope2, targetClientId);
 		};
 
 		let snapshot: ISnapshot | ISnapshotTree | undefined = getSummaryForDatastores(
@@ -3019,6 +3024,72 @@ export class ContainerRuntime
 		this._signalTracking.totalSignalsSentInLatencyWindow = 0;
 	}
 
+	/**
+	 * Updates signal telemetry including emitting telemetry events.
+	 */
+	private processSignalForTelemetry(envelope: ISignalEnvelope): void {
+		const { clientBroadcastSignalSequenceNumber } = envelope;
+		if (clientBroadcastSignalSequenceNumber === undefined) {
+			return;
+		}
+
+		if (
+			this._signalTracking.trackingSignalSequenceNumber === undefined ||
+			this._signalTracking.minimumTrackingSignalSequenceNumber === undefined
+		) {
+			return;
+		}
+
+		if (
+			clientBroadcastSignalSequenceNumber >= this._signalTracking.trackingSignalSequenceNumber
+		) {
+			// Calculate the number of signals lost and log the event.
+			const signalsLost =
+				clientBroadcastSignalSequenceNumber -
+				this._signalTracking.trackingSignalSequenceNumber;
+			if (signalsLost > 0) {
+				this._signalTracking.signalsLost += signalsLost;
+				this.mc.logger.sendErrorEvent({
+					eventName: "SignalLost",
+					signalsLost, // Number of lost signals detected.
+					trackingSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
+					clientBroadcastSignalSequenceNumber, // Actual signal sequence number received.
+				});
+			}
+			// Update the tracking signal sequence number to the next expected signal in the sequence.
+			this._signalTracking.trackingSignalSequenceNumber =
+				clientBroadcastSignalSequenceNumber + 1;
+		} else if (
+			// Check if this is a signal in range of interest.
+			clientBroadcastSignalSequenceNumber >=
+			this._signalTracking.minimumTrackingSignalSequenceNumber
+		) {
+			this._signalTracking.signalsOutOfOrder++;
+			this.mc.logger.sendTelemetryEvent({
+				eventName: "SignalOutOfOrder",
+				type: envelope.contents.type, // Type of signal that was received out of order.
+				trackingSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
+				clientBroadcastSignalSequenceNumber, // Sequence number of the out of order signal.
+			});
+		}
+		if (
+			this._signalTracking.roundTripSignalSequenceNumber !== undefined &&
+			clientBroadcastSignalSequenceNumber >= this._signalTracking.roundTripSignalSequenceNumber
+		) {
+			if (
+				clientBroadcastSignalSequenceNumber ===
+				this._signalTracking.roundTripSignalSequenceNumber
+			) {
+				// Latency tracked signal has been received.
+				// We now log the roundtrip duration of the tracked signal.
+				// This telemetry event also logs metrics for signals sent, signals lost, and out of order signals received.
+				// These metrics are reset after logging the telemetry event.
+				this.sendSignalTelemetryEvent();
+			}
+			this._signalTracking.roundTripSignalSequenceNumber = undefined;
+		}
+	}
+
 	public processSignal(message: ISignalMessage, local: boolean) {
 		const envelope = message.content as ISignalEnvelope;
 		const transformed: IInboundSignalMessage = {
@@ -3031,64 +3102,15 @@ export class ContainerRuntime
 		// Only collect signal telemetry for broadcast messages sent by the current client.
 		if (
 			message.clientId === this.clientId &&
-			this.connected &&
-			envelope.clientBroadcastSignalSequenceNumber !== undefined
+			// jason-ha: This `connected` check seems incorrect. Signals that come through
+			// here must have been received while connected to service and there is no need
+			// to avoid processing when connection has dropped. Because container runtime's
+			// `connected` (and `_connected`) state also reflects some ops state, it may
+			//  easily be false when newly connected and signal tracking may very well
+			// complain lost signals (that were simply skipped per this check).
+			this.connected
 		) {
-			if (
-				this._signalTracking.trackingSignalSequenceNumber !== undefined &&
-				this._signalTracking.minimumTrackingSignalSequenceNumber !== undefined
-			) {
-				if (
-					envelope.clientBroadcastSignalSequenceNumber >=
-					this._signalTracking.trackingSignalSequenceNumber
-				) {
-					// Calculate the number of signals lost and log the event.
-					const signalsLost =
-						envelope.clientBroadcastSignalSequenceNumber -
-						this._signalTracking.trackingSignalSequenceNumber;
-					if (signalsLost > 0) {
-						this._signalTracking.signalsLost += signalsLost;
-						this.mc.logger.sendErrorEvent({
-							eventName: "SignalLost",
-							signalsLost, // Number of lost signals detected.
-							trackingSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
-							clientBroadcastSignalSequenceNumber:
-								envelope.clientBroadcastSignalSequenceNumber, // Actual signal sequence number received.
-						});
-					}
-					// Update the tracking signal sequence number to the next expected signal in the sequence.
-					this._signalTracking.trackingSignalSequenceNumber =
-						envelope.clientBroadcastSignalSequenceNumber + 1;
-				} else if (
-					envelope.clientBroadcastSignalSequenceNumber >=
-					this._signalTracking.minimumTrackingSignalSequenceNumber
-				) {
-					this._signalTracking.signalsOutOfOrder++;
-					this.mc.logger.sendTelemetryEvent({
-						eventName: "SignalOutOfOrder",
-						type: envelope.contents.type, // Type of signal that was received out of order.
-						trackingSequenceNumber: this._signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
-						clientBroadcastSignalSequenceNumber: envelope.clientBroadcastSignalSequenceNumber, // Sequence number of the out of order signal.
-					});
-				}
-				if (
-					this._signalTracking.roundTripSignalSequenceNumber !== undefined &&
-					envelope.clientBroadcastSignalSequenceNumber >=
-						this._signalTracking.roundTripSignalSequenceNumber
-				) {
-					if (
-						envelope.clientBroadcastSignalSequenceNumber ===
-						this._signalTracking.roundTripSignalSequenceNumber
-					) {
-						// Latency tracked signal has been received.
-						// We now log the roundtrip duration of the tracked signal.
-						// This telemetry event also logs metrics for signals sent, signals lost, and out of order signals received.
-						// These metrics are reset after logging the telemetry event.
-						this.sendSignalTelemetryEvent();
-					}
-					this._signalTracking.roundTripSignalSequenceNumber = undefined;
-				}
-			}
+			this.processSignalForTelemetry(envelope);
 		}
 
 		if (envelope.address === undefined) {
@@ -3335,19 +3357,24 @@ export class ContainerRuntime
 		address: string | undefined,
 		type: string,
 		content: any,
-		targetClientId?: string,
-	): ISignalEnvelope {
-		const newEnvelope: ISignalEnvelope = {
+	): Omit<ISignalEnvelope, "broadcastSignalSequenceNumber"> {
+		const newEnvelope: Omit<ISignalEnvelope, "broadcastSignalSequenceNumber"> = {
 			address,
 			contents: { type, content },
 		};
 
+		return newEnvelope;
+	}
+
+	private submitEnvelopedSignal(envelope: ISignalEnvelope, targetClientId?: string) {
 		const isBroadcastSignal = targetClientId === undefined;
 
 		if (isBroadcastSignal) {
 			const clientBroadcastSignalSequenceNumber = ++this._signalTracking
 				.broadcastSignalSequenceNumber;
-			newEnvelope.clientBroadcastSignalSequenceNumber = clientBroadcastSignalSequenceNumber;
+			// Stamp with the broadcast signal sequence number.
+			envelope.clientBroadcastSignalSequenceNumber = clientBroadcastSignalSequenceNumber;
+
 			this._signalTracking.signalsSentSinceLastLatencyMeasurement++;
 
 			if (
@@ -3376,7 +3403,7 @@ export class ContainerRuntime
 			}
 		}
 
-		return newEnvelope;
+		this.submitSignalFn(envelope, targetClientId);
 	}
 
 	/**
@@ -3393,13 +3420,8 @@ export class ContainerRuntime
 	 */
 	public submitSignal(type: string, content: unknown, targetClientId?: string) {
 		this.verifyNotClosed();
-		const envelope = this.createNewSignalEnvelope(
-			undefined /* address */,
-			type,
-			content,
-			targetClientId,
-		);
-		return this.submitSignalFn(envelope, targetClientId);
+		const envelope = this.createNewSignalEnvelope(undefined /* address */, type, content);
+		return this.submitEnvelopedSignal(envelope, targetClientId);
 	}
 
 	public setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void {

package/src/dataStoreContext.ts

@@ -1034,9 +1034,6 @@ export class RemoteFluidDataStoreContext extends FluidDataStoreContext {
 			this._baseSnapshot = props.snapshot;
 			this.isSnapshotInISnapshotFormat = false;
 		}
-		if (this._baseSnapshot !== undefined) {
-			this.summarizerNode.updateBaseSummaryState(this._baseSnapshot);
-		}
 	}
 
 	/*

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.4.0-297027";
+export const pkgVersion = "2.4.0-299374";