@fluidframework/container-loader 2.20.0 → 2.22.0

package/src/containerContext.ts

@@ -3,6 +3,10 @@
  * Licensed under the MIT License.
  */
 
+import type {
+	ILayerCompatDetails,
+	IProvideLayerCompatDetails,
+} from "@fluid-internal/client-utils";
 import {
 	AttachState,
 	IAudience,
@@ -30,10 +34,15 @@ import {
 } from "@fluidframework/driver-definitions/internal";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
+import { LoaderCompatDetails } from "./layerCompatState.js";
+
 /**
  * {@inheritDoc @fluidframework/container-definitions#IContainerContext}
  */
-export class ContainerContext implements IContainerContext {
+export class ContainerContext implements IContainerContext, IProvideLayerCompatDetails {
+	/**
+	 * @deprecated - This has been replaced by ILayerCompatDetails.
+	 */
 	public readonly supportedFeatures: ReadonlyMap<string, unknown> = new Map([
 		/**
 		 * This version of the loader accepts `referenceSequenceNumber`, provided by the container runtime,
@@ -62,6 +71,10 @@ export class ContainerContext implements IContainerContext {
 		return this._getConnected();
 	}
 
+	public get ILayerCompatDetails(): ILayerCompatDetails {
+		return LoaderCompatDetails;
+	}
+
 	constructor(
 		public readonly options: ILoaderOptions,
 		public readonly scope: FluidObject,

package/src/debugLogger.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { performance } from "@fluid-internal/client-utils";
+import { performanceNow } from "@fluid-internal/client-utils";
 import {
 	ITelemetryBaseEvent,
 	ITelemetryBaseLogger,
@@ -88,7 +88,7 @@ export class DebugLogger implements ITelemetryBaseLogger {
 		newEvent.eventName = undefined;
 
 		let tick = "";
-		tick = `tick=${formatTick(performance.now())}`;
+		tick = `tick=${formatTick(performanceNow())}`;
 
 		// Extract stack to put it last, but also to avoid escaping '\n' in it by JSON.stringify below
 		const stack = newEvent.stack ?? "";

package/src/deltaQueue.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { TypedEventEmitter, performance } from "@fluid-internal/client-utils";
+import { TypedEventEmitter, performanceNow } from "@fluid-internal/client-utils";
 import {
 	IDeltaQueue,
 	IDeltaQueueEvents,
@@ -153,7 +153,7 @@ export class DeltaQueue<T>
 		count: number;
 		duration: number;
 	} {
-		const start = performance.now();
+		const start = performanceNow();
 		let count = 0;
 
 		// For grouping to work we must process all local messages immediately and in the single turn.
@@ -169,7 +169,7 @@ export class DeltaQueue<T>
 			this.emit("op", next);
 		}
 
-		const duration = performance.now() - start;
+		const duration = performanceNow() - start;
 		if (this.q.length === 0) {
 			this.emit("idle", count, duration);
 		}

package/src/layerCompatState.ts

@@ -0,0 +1,75 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {
+	checkLayerCompatibility,
+	type ILayerCompatDetails,
+	type ILayerCompatSupportRequirements,
+} from "@fluid-internal/client-utils";
+import type { ICriticalContainerError } from "@fluidframework/container-definitions";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+
+import { pkgVersion } from "./packageVersion.js";
+
+/**
+ * Loader's compatibility details that is exposed to the Runtime layer.
+ */
+export const LoaderCompatDetails: ILayerCompatDetails = {
+	/**
+	 * The package version of the Loader layer.
+	 */
+	pkgVersion,
+	/**
+	 * The current generation of the Loader layer.
+	 */
+	generation: 1,
+	/**
+	 * The features supported by the Loader layer across the Loader / Runtime boundary.
+	 */
+	supportedFeatures: new Set<string>(),
+};
+
+/**
+ * The requirements that the Runtime layer must meet to be compatible with this Loader.
+ */
+export const RuntimeSupportRequirements: ILayerCompatSupportRequirements = {
+	/**
+	 * Minimum generation that Runtime must be at to be compatible with Loader. Note that 0 is used here for
+	 * Runtime layers before the introduction of the layer compatibility enforcement.
+	 */
+	minSupportedGeneration: 0,
+	/**
+	 * The features that the Runtime must support to be compatible with Loader.
+	 */
+	requiredFeatures: [],
+};
+
+/**
+ * Validates that the Runtime layer is compatible with the Loader.
+ */
+export function validateRuntimeCompatibility(
+	maybeRuntimeCompatDetails: ILayerCompatDetails | undefined,
+	disposeFn: (error?: ICriticalContainerError) => void,
+): void {
+	const layerCheckResult = checkLayerCompatibility(
+		RuntimeSupportRequirements,
+		maybeRuntimeCompatDetails,
+	);
+	if (!layerCheckResult.isCompatible) {
+		const error = new UsageError("Loader is not compatible with Runtime", {
+			errorDetails: JSON.stringify({
+				loaderVersion: LoaderCompatDetails.pkgVersion,
+				runtimeVersion: maybeRuntimeCompatDetails?.pkgVersion,
+				loaderGeneration: LoaderCompatDetails.generation,
+				runtimeGeneration: maybeRuntimeCompatDetails?.generation,
+				minSupportedGeneration: RuntimeSupportRequirements.minSupportedGeneration,
+				isGenerationCompatible: layerCheckResult.isGenerationCompatible,
+				unsupportedFeatures: layerCheckResult.unsupportedFeatures,
+			}),
+		});
+		disposeFn(error);
+		throw error;
+	}
+}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.20.0";
+export const pkgVersion = "2.22.0";

package/src/protocol/quorum.ts

@@ -221,14 +221,6 @@ export class QuorumProposals
 		return this.values.get(key)?.value;
 	}
 
-	/**
-	 * Returns additional data about the approved consensus value
-	 * @deprecated Removed in recent protocol-definitions.  Use get() instead.
-	 */
-	public getApprovalData(key: string): ICommittedProposal | undefined {
-		return this.values.get(key);
-	}
-
 	/**
 	 * Proposes a new value. Returns a promise that will either:
 	 * - Resolve when the proposal is accepted
@@ -505,14 +497,6 @@ export class Quorum extends TypedEventEmitter<IQuorum["on"]> implements IQuorum
 		return this.quorumProposals.get(key);
 	}
 
-	/**
-	 * Returns additional data about the approved consensus value
-	 * @deprecated Removed in recent protocol-definitions.  Use get() instead.
-	 */
-	public getApprovalData(key: string): ICommittedProposal | undefined {
-		return this.quorumProposals.getApprovalData(key);
-	}
-
 	/**
 	 * Adds a new client to the quorum
 	 */

package/src/utils.ts

@@ -145,10 +145,7 @@ function convertSummaryToSnapshotAndBlobs(summary: ISummaryTree): SnapshotWithBl
 		unreferenced: summary.unreferenced,
 		groupId: summary.groupId,
 	};
-	const keys = Object.keys(summary.tree);
-	for (const key of keys) {
-		const summaryObject = summary.tree[key];
-
+	for (const [key, summaryObject] of Object.entries(summary.tree)) {
 		switch (summaryObject.type) {
 			case SummaryType.Tree: {
 				const innerSnapshot = convertSummaryToSnapshotAndBlobs(summaryObject);
@@ -280,7 +277,7 @@ export const combineSnapshotTreeAndSnapshotBlobs = (
 
 	// Process blobs in the current level
 	for (const [, id] of Object.entries(baseSnapshot.blobs)) {
-		if (snapshotBlobs[id]) {
+		if (snapshotBlobs[id] !== undefined) {
 			blobsContents[id] = stringToBuffer(snapshotBlobs[id], "utf8");
 		}
 	}