@fluidframework/container-runtime 2.30.0 → 2.31.1

package/src/opLifecycle/outbox.ts

@@ -6,8 +6,9 @@
 import { ICriticalContainerError } from "@fluidframework/container-definitions";
 import { IBatchMessage } from "@fluidframework/container-definitions/internal";
 import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
-import { assert } from "@fluidframework/core-utils/internal";
+import { assert, Lazy } from "@fluidframework/core-utils/internal";
 import {
+	DataProcessingError,
 	GenericError,
 	UsageError,
 	createChildLogger,
@@ -34,9 +35,16 @@ import { ensureContentsDeserialized } from "./remoteMessageProcessor.js";
 
 export interface IOutboxConfig {
 	readonly compressionOptions: ICompressionRuntimeOptions;
-	// The maximum size of a batch that we can send over the wire.
+	/**
+	 * The maximum size of a batch that we can send over the wire.
+	 */
 	readonly maxBatchSizeInBytes: number;
-	readonly disablePartialFlush: boolean;
+	/**
+	 * If true, maybeFlushPartialBatch will flush the batch if the reference sequence number changed
+	 * since the batch started. Otherwise, it will throw in this case (apart from reentrancy which is handled elsewhere).
+	 * Once the new throw-based flow is proved in a production environment, this option will be removed.
+	 */
+	readonly flushPartialBatches: boolean;
 }
 
 export interface IOutboxParameters {
@@ -170,8 +178,9 @@ export class Outbox {
 
 	/**
 	 * Detect whether batching has been interrupted by an incoming message being processed. In this case,
-	 * we will flush the accumulated messages to account for that and create a new batch with the new
-	 * message as the first message.
+	 * we will flush the accumulated messages to account for that (if allowed) and create a new batch with the new
+	 * message as the first message. If flushing partial batch is not enabled, we will throw (except for reentrant ops).
+	 * This would indicate we expected this case to be precluded by logic elsewhere.
 	 *
 	 * @remarks - To detect batch interruption, we compare both the reference sequence number
 	 * (i.e. last message processed by DeltaManager) and the client sequence number of the
@@ -183,9 +192,8 @@ export class Outbox {
 		const blobAttachSeqNums = this.blobAttachBatch.sequenceNumbers;
 		const idAllocSeqNums = this.idAllocationBatch.sequenceNumbers;
 		assert(
-			this.params.config.disablePartialFlush ||
-				(sequenceNumbersMatch(mainBatchSeqNums, blobAttachSeqNums) &&
-					sequenceNumbersMatch(mainBatchSeqNums, idAllocSeqNums)),
+			sequenceNumbersMatch(mainBatchSeqNums, blobAttachSeqNums) &&
+				sequenceNumbersMatch(mainBatchSeqNums, idAllocSeqNums),
 			0x58d /* Reference sequence numbers from both batches must be in sync */,
 		);
 
@@ -200,25 +208,54 @@ export class Outbox {
 			return;
 		}
 
+		// Reference and/or Client sequence number will be advancing while processing this batch,
+		// so we can't use this check to detect wrongdoing. But we will still log via telemetry.
+		// This is rare, and the reentrancy will be handled during Flush.
+		const expectedDueToReentrancy = this.isContextReentrant();
+
+		const errorWrapper = new Lazy(() =>
+			getLongStack(() =>
+				DataProcessingError.create(
+					"Sequence numbers advanced as if ops were processed while a batch is accumulating",
+					"outboxSequenceNumberCoherencyCheck",
+				),
+			),
+		);
 		if (++this.mismatchedOpsReported <= this.maxMismatchedOpsToReport) {
 			this.logger.sendTelemetryEvent(
 				{
-					category: this.params.config.disablePartialFlush ? "error" : "generic",
+					// Only log error if this is truly unexpected
+					category:
+						expectedDueToReentrancy || this.params.config.flushPartialBatches
+							? "generic"
+							: "error",
 					eventName: "ReferenceSequenceNumberMismatch",
-					mainReferenceSequenceNumber: mainBatchSeqNums.referenceSequenceNumber,
-					mainClientSequenceNumber: mainBatchSeqNums.clientSequenceNumber,
-					blobAttachReferenceSequenceNumber: blobAttachSeqNums.referenceSequenceNumber,
-					blobAttachClientSequenceNumber: blobAttachSeqNums.clientSequenceNumber,
-					currentReferenceSequenceNumber: currentSequenceNumbers.referenceSequenceNumber,
-					currentClientSequenceNumber: currentSequenceNumbers.clientSequenceNumber,
+					Data_details: {
+						expectedDueToReentrancy,
+						mainReferenceSequenceNumber: mainBatchSeqNums.referenceSequenceNumber,
+						mainClientSequenceNumber: mainBatchSeqNums.clientSequenceNumber,
+						blobAttachReferenceSequenceNumber: blobAttachSeqNums.referenceSequenceNumber,
+						blobAttachClientSequenceNumber: blobAttachSeqNums.clientSequenceNumber,
+						currentReferenceSequenceNumber: currentSequenceNumbers.referenceSequenceNumber,
+						currentClientSequenceNumber: currentSequenceNumbers.clientSequenceNumber,
+					},
 				},
-				getLongStack(() => new UsageError("Submission of an out of order message")),
+				errorWrapper.value,
 			);
 		}
 
-		if (!this.params.config.disablePartialFlush) {
+		// If we're configured to flush partial batches, do that now and return (don't throw)
+		if (this.params.config.flushPartialBatches) {
 			this.flushAll();
+			return;
 		}
+
+		// If we are in a reentrant context, we know this can happen without causing any harm.
+		if (expectedDueToReentrancy) {
+			return;
+		}
+
+		throw errorWrapper.value;
 	}
 
 	public submit(message: BatchMessage): void {
@@ -273,17 +310,20 @@ export class Outbox {
 	}
 
 	private flushAll(resubmittingBatchId?: BatchId): void {
-		// If we're resubmitting and all batches are empty, we need to flush an empty batch.
-		// Note that we currently resubmit one batch at a time, so on resubmit, 2 of the 3 batches will *always* be empty.
-		// It's theoretically possible that we don't *need* to resubmit this empty batch, and in those cases, it'll safely be ignored
-		// by the rest of the system, including remote clients.
-		// In some cases we *must* resubmit the empty batch (to match up with a non-empty version tracked locally by a container fork), so we do it always.
 		const allBatchesEmpty =
 			this.idAllocationBatch.empty && this.blobAttachBatch.empty && this.mainBatch.empty;
-		if (resubmittingBatchId && allBatchesEmpty) {
-			this.flushEmptyBatch(resubmittingBatchId);
+		if (allBatchesEmpty) {
+			// If we're resubmitting and all batches are empty, we need to flush an empty batch.
+			// Note that we currently resubmit one batch at a time, so on resubmit, 2 of the 3 batches will *always* be empty.
+			// It's theoretically possible that we don't *need* to resubmit this empty batch, and in those cases, it'll safely be ignored
+			// by the rest of the system, including remote clients.
+			// In some cases we *must* resubmit the empty batch (to match up with a non-empty version tracked locally by a container fork), so we do it always.
+			if (resubmittingBatchId) {
+				this.flushEmptyBatch(resubmittingBatchId);
+			}
 			return;
 		}
+
 		// Don't use resubmittingBatchId for idAllocationBatch.
 		// ID Allocation messages are not directly resubmitted so we don't want to reuse the batch ID.
 		this.flushInternal(this.idAllocationBatch);

package/src/packageVersion.ts

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

package/src/pendingStateManager.ts

@@ -134,7 +134,7 @@ function scrubAndStringify(
 	// Scrub the whole object in case there are unexpected keys
 	const scrubbed: Record<string, unknown> = typesOfKeys(message);
 
-	// For these known/expected keys, we can either drill in (for contents)
+	// For these known/expected keys, we can either drill into the object (for contents)
 	// or just use the value as-is (since it's not personal info)
 	scrubbed.contents = message.contents && typesOfKeys(message.contents);
 	scrubbed.type = message.type;
@@ -145,7 +145,7 @@ function scrubAndStringify(
 /**
  * Finds and returns the index where the strings diverge, and the character at that index in each string (or undefined if not applicable)
  */
-export function findFirstCharacterMismatched(
+function findFirstRawCharacterMismatched(
 	a: string,
 	b: string,
 ): [index: number, charA?: string, charB?: string] {
@@ -164,6 +164,22 @@ export function findFirstCharacterMismatched(
 		: [minLength, a[minLength], b[minLength]];
 }
 
+/**
+ * Finds and returns the index where the strings diverge, and the character at that index in each string (or undefined if not applicable)
+ * It scrubs non-ASCII characters since they convey more meaning (privacy consideration)
+ */
+export function findFirstCharacterMismatched(
+	a: string,
+	b: string,
+): [index: number, charA?: string, charB?: string] {
+	const [index, rawCharA, rawCharB] = findFirstRawCharacterMismatched(a, b);
+
+	const charA = (rawCharA?.codePointAt(0) ?? 0) <= 0x7f ? rawCharA : "[non-ASCII]";
+	const charB = (rawCharB?.codePointAt(0) ?? 0) <= 0x7f ? rawCharB : "[non-ASCII]";
+
+	return [index, charA, charB];
+}
+
 function withoutLocalOpMetadata(message: IPendingMessage): IPendingMessage {
 	return {
 		...message,

package/src/runCounter.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export class RunCounter {
+	#runs = 0;
+
+	public get running(): boolean {
+		return this.#runs !== 0;
+	}
+
+	public get runs(): number {
+		return this.#runs;
+	}
+
+	public run<T>(act: () => T): T {
+		this.#runs++;
+		try {
+			return act();
+		} finally {
+			this.#runs--;
+		}
+	}
+}

package/src/runtimeLayerCompatState.ts

@@ -0,0 +1,143 @@
+/*!
+ * 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";
+
+/**
+ * The core compatibility details of the Runtime layer that is the same across all layer boundaries.
+ * @internal
+ */
+export const runtimeCoreCompatDetails = {
+	/**
+	 * The package version of the Runtime layer.
+	 */
+	pkgVersion,
+	/**
+	 * The current generation of the Runtime layer.
+	 */
+	generation: 1,
+};
+
+/**
+ * Runtime's compatibility details that is exposed to the Loader layer.
+ * @internal
+ */
+export const runtimeCompatDetailsForLoader: ILayerCompatDetails = {
+	...runtimeCoreCompatDetails,
+	/**
+	 * The features supported by the Runtime layer across the Runtime / Loader boundary.
+	 */
+	supportedFeatures: new Set<string>(),
+};
+
+/**
+ * The requirements that the Loader layer must meet to be compatible with this Runtime.
+ * @internal
+ */
+export const loaderSupportRequirements: 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.
+	 */
+	minSupportedGeneration: 0,
+	/**
+	 * The features that the Loader must support to be compatible with Runtime.
+	 */
+	requiredFeatures: [],
+};
+
+/**
+ * Runtime's compatibility details that is exposed to the DataStore layer.
+ * @internal
+ */
+export const runtimeCompatDetailsForDataStore: ILayerCompatDetails = {
+	...runtimeCoreCompatDetails,
+	/**
+	 * The features supported by the Runtime layer across the Runtime / Loader boundary.
+	 */
+	supportedFeatures: new Set<string>(),
+};
+
+/**
+ * The requirements that the DataStore layer must meet to be compatible with this Runtime.
+ * @internal
+ */
+export const dataStoreSupportRequirements: 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.
+	 */
+	minSupportedGeneration: 0,
+	/**
+	 * The features that the DataStore must support to be compatible with Runtime.
+	 */
+	requiredFeatures: [],
+};
+
+/**
+ * Validates that the Loader layer is compatible with this Runtime.
+ * @internal
+ */
+export function validateLoaderCompatibility(
+	maybeloaderCompatDetailsForRuntime: ILayerCompatDetails | undefined,
+	disposeFn: (error?: ICriticalContainerError) => void,
+): void {
+	const layerCheckResult = checkLayerCompatibility(
+		loaderSupportRequirements,
+		maybeloaderCompatDetailsForRuntime,
+	);
+	if (!layerCheckResult.isCompatible) {
+		const error = new UsageError("Runtime is not compatible with Loader", {
+			errorDetails: JSON.stringify({
+				runtimeVersion: runtimeCoreCompatDetails.pkgVersion,
+				loaderVersion: maybeloaderCompatDetailsForRuntime?.pkgVersion,
+				runtimeGeneration: runtimeCoreCompatDetails.generation,
+				loaderGeneration: maybeloaderCompatDetailsForRuntime?.generation,
+				minSupportedGeneration: loaderSupportRequirements.minSupportedGeneration,
+				isGenerationCompatible: layerCheckResult.isGenerationCompatible,
+				unsupportedFeatures: layerCheckResult.unsupportedFeatures,
+			}),
+		});
+		disposeFn(error);
+		throw error;
+	}
+}
+
+/**
+ * Validates that the DataStore layer is compatible with this Runtime.
+ * @internal
+ */
+export function validateDatastoreCompatibility(
+	maybeDataStoreCompatDetails: ILayerCompatDetails | undefined,
+	disposeFn: () => void,
+): void {
+	const layerCheckResult = checkLayerCompatibility(
+		dataStoreSupportRequirements,
+		maybeDataStoreCompatDetails,
+	);
+	if (!layerCheckResult.isCompatible) {
+		const error = new UsageError("Runtime is not compatible with DataStore", {
+			errorDetails: JSON.stringify({
+				runtimeVersion: runtimeCoreCompatDetails.pkgVersion,
+				dataStoreVersion: maybeDataStoreCompatDetails?.pkgVersion,
+				runtimeGeneration: runtimeCoreCompatDetails.generation,
+				dataStoreGeneration: maybeDataStoreCompatDetails?.generation,
+				minSupportedGeneration: dataStoreSupportRequirements.minSupportedGeneration,
+				isGenerationCompatible: layerCheckResult.isGenerationCompatible,
+				unsupportedFeatures: layerCheckResult.unsupportedFeatures,
+			}),
+		});
+		disposeFn();
+		throw error;
+	}
+}

package/src/summary/summarizerNode/summarizerNode.ts

@@ -11,6 +11,7 @@ import {
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import {
+	channelsTreeName,
 	IExperimentalIncrementalSummaryContext,
 	ITelemetryContext,
 	CreateChildSummarizerNodeParam,
@@ -32,7 +33,6 @@ import {
 } from "@fluidframework/telemetry-utils/internal";
 
 import {
-	EscapedPath,
 	ICreateChildDetails,
 	IRefreshSummaryResult,
 	IStartSummaryResult,
@@ -70,7 +70,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 	 * (this getter is primarily only used in the test code)
 	 */
 	public get summaryHandleId(): string {
-		return this._summaryHandleId.toString();
+		return this._summaryHandleId;
 	}
 
 	protected readonly children = new Map<string, SummarizerNode>();
@@ -101,7 +101,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 		/**
 		 * Encoded handle or path to the node
 		 */
-		private readonly _summaryHandleId: EscapedPath,
+		private readonly _summaryHandleId: string,
 		private _changeSequenceNumber: number,
 		/**
 		 * Summary reference sequence number, i.e. last sequence number seen when last successful summary was created
@@ -591,7 +591,8 @@ export class SummarizerNode implements IRootSummarizerNode {
 		}
 
 		const childTelemetryNodeId = `${this.telemetryNodeId ?? ""}/${id}`;
-		const childSummaryHandleId = this._summaryHandleId.createChildPath(EscapedPath.create(id));
+		// parentHandleId/.channels/childId
+		const childSummaryHandleId = `${this._summaryHandleId}/${channelsTreeName}/${id}`;
 
 		return {
 			changeSequenceNumber,
@@ -671,7 +672,7 @@ export const createRootSummarizerNode = (
 		logger,
 		summarizeInternalFn,
 		config,
-		EscapedPath.create("") /* summaryHandleId */,
+		"" /* summaryHandleId */,
 		changeSequenceNumber,
 		referenceSequenceNumber,
 		undefined /* wipSummaryLogger */,

package/src/summary/summarizerNode/summarizerNodeUtils.ts

@@ -5,7 +5,6 @@
 
 import { SummaryObject } from "@fluidframework/driver-definitions";
 import { ISnapshotTree } from "@fluidframework/driver-definitions/internal";
-import { channelsTreeName } from "@fluidframework/runtime-definitions/internal";
 import {
 	ITelemetryLoggerExt,
 	TelemetryDataTag,
@@ -80,31 +79,6 @@ export interface ISummarizerNodeRootContract {
 	): Promise<IRefreshSummaryResult>;
 }
 
-/**
- * Class to build paths for nodes in a tree with escaped special characters
- */
-export class EscapedPath {
-	private constructor(public readonly path: string) {}
-
-	/**
-	 * Creates and returns a new instance of this class.
-	 * @param path - Id or path part of a node
-	 */
-	public static create(path: string): EscapedPath {
-		return new EscapedPath(encodeURIComponent(path));
-	}
-	public toString(): string {
-		return this.path;
-	}
-	/**
-	 * Creates and returns a new instance of this class for child of the current node.
-	 */
-	public createChildPath(childNodePath: EscapedPath): EscapedPath {
-		return new EscapedPath(
-			`${this.path}/${encodeURIComponent(channelsTreeName)}/${childNodePath.path}`,
-		);
-	}
-}
 export interface PendingSummaryInfo {
 	/**
 	 * The sequence number at which the summary was created.
@@ -127,7 +101,7 @@ export interface ICreateChildDetails {
 	/**
 	 * Summary handle for child node
 	 */
-	summaryHandleId: EscapedPath;
+	summaryHandleId: string;
 	/**
 	 * the reference sequence number of the last successful summary.
 	 */

package/src/summary/summarizerNode/summarizerNodeWithGc.ts

@@ -24,7 +24,6 @@ import { cloneGCData, unpackChildNodesGCDetails } from "../../gc/index.js";
 
 import { SummarizerNode } from "./summarizerNode.js";
 import {
-	EscapedPath,
 	ICreateChildDetails,
 	IStartSummaryResult,
 	ISummarizerNodeRootContract,
@@ -93,7 +92,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 		logger: ITelemetryBaseLogger,
 		summarizeInternalFn: SummarizeInternalFn,
 		config: ISummarizerNodeConfigWithGC,
-		_summaryHandleId: EscapedPath,
+		_summaryHandleId: string,
 		changeSequenceNumber: number,
 		/**
 		 * Summary reference sequence number, i.e. last sequence number seen when it was created
@@ -525,7 +524,7 @@ export const createRootSummarizerNodeWithGC = (
 		logger,
 		summarizeInternalFn,
 		config,
-		EscapedPath.create("") /* summaryHandleId */,
+		"" /* summaryHandleId */,
 		changeSequenceNumber,
 		referenceSequenceNumber,
 		undefined /* wipSummaryLogger */,

package/tsconfig.json

@@ -5,6 +5,7 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
+		// TODO: AB#34168 Enable noUncheckedIndexedAccess for packages/runtime/container-runtime
 		"noUncheckedIndexedAccess": false,
 		"exactOptionalPropertyTypes": false,
 	},

package/dist/layerCompatState.d.ts

@@ -1,19 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type ILayerCompatDetails, type ILayerCompatSupportRequirements } from "@fluid-internal/client-utils";
-import type { ICriticalContainerError } from "@fluidframework/container-definitions";
-/**
- * Runtime's compatibility details that is exposed to the Loader layer.
- */
-export declare const RuntimeCompatDetails: ILayerCompatDetails;
-/**
- * The requirements that the Loader layer must meet to be compatible with this Runtime.
- */
-export declare const LoaderSupportRequirements: ILayerCompatSupportRequirements;
-/**
- * Validates that the Loader layer is compatible with this Runtime.
- */
-export declare function validateLoaderCompatibility(maybeLoaderCompatDetails: ILayerCompatDetails | undefined, disposeFn: (error?: ICriticalContainerError) => void): void;
-//# sourceMappingURL=layerCompatState.d.ts.map

package/dist/layerCompatState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"layerCompatState.d.ts","sourceRoot":"","sources":["../src/layerCompatState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,KAAK,mBAAmB,EACxB,KAAK,+BAA+B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAKrF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,mBAalC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,+BAUvC,CAAC;AAEF;;GAEG;AACH,wBAAgB,2BAA2B,CAC1C,wBAAwB,EAAE,mBAAmB,GAAG,SAAS,EACzD,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,GAClD,IAAI,CAoBN"}

package/dist/layerCompatState.js

@@ -1,64 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateLoaderCompatibility = exports.LoaderSupportRequirements = exports.RuntimeCompatDetails = void 0;
-const client_utils_1 = require("@fluid-internal/client-utils");
-const internal_1 = require("@fluidframework/telemetry-utils/internal");
-const packageVersion_js_1 = require("./packageVersion.js");
-/**
- * Runtime's compatibility details that is exposed to the Loader layer.
- */
-exports.RuntimeCompatDetails = {
-    /**
-     * The package version of the Runtime layer.
-     */
-    pkgVersion: packageVersion_js_1.pkgVersion,
-    /**
-     * The current generation of the Runtime layer.
-     */
-    generation: 1,
-    /**
-     * The features supported by the Runtime layer across the Runtime / Loader boundary.
-     */
-    supportedFeatures: new Set(),
-};
-/**
- * The requirements that the Loader layer must meet to be compatible with this Runtime.
- */
-exports.LoaderSupportRequirements = {
-    /**
-     * Minimum generation that Loader must be at to be compatible with Runtime.
-     */
-    minSupportedGeneration: 0,
-    /**
-     * The features that the Loader must support to be compatible with Runtime. Note that 0 is used here for
-     * Loader layers before the introduction of the layer compatibility enforcement.
-     */
-    requiredFeatures: [],
-};
-/**
- * Validates that the Loader layer is compatible with this Runtime.
- */
-function validateLoaderCompatibility(maybeLoaderCompatDetails, disposeFn) {
-    const layerCheckResult = (0, client_utils_1.checkLayerCompatibility)(exports.LoaderSupportRequirements, maybeLoaderCompatDetails);
-    if (!layerCheckResult.isCompatible) {
-        const error = new internal_1.UsageError("Runtime is not compatible with Loader", {
-            errorDetails: JSON.stringify({
-                runtimeVersion: exports.RuntimeCompatDetails.pkgVersion,
-                loaderVersion: maybeLoaderCompatDetails?.pkgVersion,
-                runtimeGeneration: exports.RuntimeCompatDetails.generation,
-                loaderGeneration: maybeLoaderCompatDetails?.generation,
-                minSupportedGeneration: exports.LoaderSupportRequirements.minSupportedGeneration,
-                isGenerationCompatible: layerCheckResult.isGenerationCompatible,
-                unsupportedFeatures: layerCheckResult.unsupportedFeatures,
-            }),
-        });
-        disposeFn(error);
-        throw error;
-    }
-}
-exports.validateLoaderCompatibility = validateLoaderCompatibility;
-//# sourceMappingURL=layerCompatState.js.map

package/dist/layerCompatState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"layerCompatState.js","sourceRoot":"","sources":["../src/layerCompatState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAIsC;AAEtC,uEAAsE;AAEtE,2DAAiD;AAEjD;;GAEG;AACU,QAAA,oBAAoB,GAAwB;IACxD;;OAEG;IACH,UAAU,EAAV,8BAAU;IACV;;OAEG;IACH,UAAU,EAAE,CAAC;IACb;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;GAEG;AACU,QAAA,yBAAyB,GAAoC;IACzE;;OAEG;IACH,sBAAsB,EAAE,CAAC;IACzB;;;OAGG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;GAEG;AACH,SAAgB,2BAA2B,CAC1C,wBAAyD,EACzD,SAAoD;IAEpD,MAAM,gBAAgB,GAAG,IAAA,sCAAuB,EAC/C,iCAAyB,EACzB,wBAAwB,CACxB,CAAC;IACF,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,qBAAU,CAAC,uCAAuC,EAAE;YACrE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC;gBAC5B,cAAc,EAAE,4BAAoB,CAAC,UAAU;gBAC/C,aAAa,EAAE,wBAAwB,EAAE,UAAU;gBACnD,iBAAiB,EAAE,4BAAoB,CAAC,UAAU;gBAClD,gBAAgB,EAAE,wBAAwB,EAAE,UAAU;gBACtD,sBAAsB,EAAE,iCAAyB,CAAC,sBAAsB;gBACxE,sBAAsB,EAAE,gBAAgB,CAAC,sBAAsB;gBAC/D,mBAAmB,EAAE,gBAAgB,CAAC,mBAAmB;aACzD,CAAC;SACF,CAAC,CAAC;QACH,SAAS,CAAC,KAAK,CAAC,CAAC;QACjB,MAAM,KAAK,CAAC;IACb,CAAC;AACF,CAAC;AAvBD,kEAuBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tcheckLayerCompatibility,\n\ttype ILayerCompatDetails,\n\ttype ILayerCompatSupportRequirements,\n} from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\n\n/**\n * Runtime's compatibility details that is exposed to the Loader layer.\n */\nexport const RuntimeCompatDetails: ILayerCompatDetails = {\n\t/**\n\t * The package version of the Runtime layer.\n\t */\n\tpkgVersion,\n\t/**\n\t * The current generation of the Runtime layer.\n\t */\n\tgeneration: 1,\n\t/**\n\t * The features supported by the Runtime layer across the Runtime / Loader boundary.\n\t */\n\tsupportedFeatures: new Set<string>(),\n};\n\n/**\n * The requirements that the Loader layer must meet to be compatible with this Runtime.\n */\nexport const LoaderSupportRequirements: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Loader must be at to be compatible with Runtime.\n\t */\n\tminSupportedGeneration: 0,\n\t/**\n\t * The features that the Loader must support to be compatible with Runtime. Note that 0 is used here for\n\t * Loader layers before the introduction of the layer compatibility enforcement.\n\t */\n\trequiredFeatures: [],\n};\n\n/**\n * Validates that the Loader layer is compatible with this Runtime.\n */\nexport function validateLoaderCompatibility(\n\tmaybeLoaderCompatDetails: ILayerCompatDetails | undefined,\n\tdisposeFn: (error?: ICriticalContainerError) => void,\n): void {\n\tconst layerCheckResult = checkLayerCompatibility(\n\t\tLoaderSupportRequirements,\n\t\tmaybeLoaderCompatDetails,\n\t);\n\tif (!layerCheckResult.isCompatible) {\n\t\tconst error = new UsageError(\"Runtime is not compatible with Loader\", {\n\t\t\terrorDetails: JSON.stringify({\n\t\t\t\truntimeVersion: RuntimeCompatDetails.pkgVersion,\n\t\t\t\tloaderVersion: maybeLoaderCompatDetails?.pkgVersion,\n\t\t\t\truntimeGeneration: RuntimeCompatDetails.generation,\n\t\t\t\tloaderGeneration: maybeLoaderCompatDetails?.generation,\n\t\t\t\tminSupportedGeneration: LoaderSupportRequirements.minSupportedGeneration,\n\t\t\t\tisGenerationCompatible: layerCheckResult.isGenerationCompatible,\n\t\t\t\tunsupportedFeatures: layerCheckResult.unsupportedFeatures,\n\t\t\t}),\n\t\t});\n\t\tdisposeFn(error);\n\t\tthrow error;\n\t}\n}\n"]}

package/lib/layerCompatState.d.ts

@@ -1,19 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type ILayerCompatDetails, type ILayerCompatSupportRequirements } from "@fluid-internal/client-utils";
-import type { ICriticalContainerError } from "@fluidframework/container-definitions";
-/**
- * Runtime's compatibility details that is exposed to the Loader layer.
- */
-export declare const RuntimeCompatDetails: ILayerCompatDetails;
-/**
- * The requirements that the Loader layer must meet to be compatible with this Runtime.
- */
-export declare const LoaderSupportRequirements: ILayerCompatSupportRequirements;
-/**
- * Validates that the Loader layer is compatible with this Runtime.
- */
-export declare function validateLoaderCompatibility(maybeLoaderCompatDetails: ILayerCompatDetails | undefined, disposeFn: (error?: ICriticalContainerError) => void): void;
-//# sourceMappingURL=layerCompatState.d.ts.map

package/lib/layerCompatState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"layerCompatState.d.ts","sourceRoot":"","sources":["../src/layerCompatState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,KAAK,mBAAmB,EACxB,KAAK,+BAA+B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAKrF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,mBAalC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,+BAUvC,CAAC;AAEF;;GAEG;AACH,wBAAgB,2BAA2B,CAC1C,wBAAwB,EAAE,mBAAmB,GAAG,SAAS,EACzD,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,GAClD,IAAI,CAoBN"}