@fluidframework/tree 2.63.0-359962 → 2.70.0-360374

package/src/feature-libraries/chunked-forest/codec/codecs.ts

@@ -8,7 +8,6 @@ import type { IIdCompressor, SessionId } from "@fluidframework/id-compressor";
 
 import {
 	type CodecTree,
-	type FluidClientVersion,
 	type ICodecOptions,
 	type IJsonCodec,
 	makeVersionedValidatedCodec,
@@ -35,6 +34,7 @@ import type { FieldBatch } from "./fieldBatch.js";
 import { EncodedFieldBatch, validVersions, type FieldBatchFormatVersion } from "./format.js";
 import { schemaCompressedEncode } from "./schemaBasedEncode.js";
 import { uncompressedEncode } from "./uncompressedEncode.js";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 import type { IncrementalEncodingPolicy } from "./incrementalEncodingPolicy.js";
 
 /**
@@ -115,12 +115,12 @@ export type FieldBatchCodec = IJsonCodec<
 >;
 
 /**
- * Get the write version for {@link makeFieldBatchCodec} based on the `oldestCompatibleClient` version.
+ * Get the write version for {@link makeFieldBatchCodec} based on the `minVersionForCollab` version.
  * @privateRemarks
  * TODO: makeFieldBatchCodec (and makeVersionDispatchingCodec transitively) should bake in this versionToFormat logic and the resulting codec can then support use with FluidClientVersion directly.
  */
 export function fluidVersionToFieldBatchCodecWriteVersion(
-	oldestCompatibleClient: FluidClientVersion,
+	minVersionForCollab: MinimumVersionForCollab,
 ): number {
 	// There is currently on only 1 version.
 	return 1;

package/src/feature-libraries/default-schema/defaultFieldKinds.ts

@@ -262,7 +262,7 @@ export function getCodecTreeForModularChangeFormat(
 	version: ModularChangeFormatVersion,
 ): CodecTree {
 	const dependencies =
-		fieldKindConfigurations.get(version) ?? fail("Unknown modular change format");
+		fieldKindConfigurations.get(version) ?? fail(0xc7c /* Unknown modular change format */);
 	const children: CodecTree[] = Array.from(dependencies.entries()).map(
 		([key, { formatVersion }]) => ({
 			name: `FieldKind:${key}`,

package/src/feature-libraries/schema-index/codec.ts

@@ -7,7 +7,6 @@ import { fail, unreachableCase } from "@fluidframework/core-utils/internal";
 
 import {
 	type CodecTree,
-	type FluidClientVersion,
 	type ICodecFamily,
 	type ICodecOptions,
 	type IJsonCodec,
@@ -29,14 +28,15 @@ import { brand, type JsonCompatible } from "../../util/index.js";
 
 import { Format as FormatV1 } from "./formatV1.js";
 import { Format as FormatV2 } from "./formatV2.js";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 
 /**
- * Convert a FluidClientVersion to a SchemaVersion.
- * @param clientVersion - The FluidClientVersion to convert.
- * @returns The SchemaVersion that corresponds to the provided FluidClientVersion.
+ * Convert a MinimumVersionForCollab to a SchemaVersion.
+ * @param clientVersion - The MinimumVersionForCollab to convert.
+ * @returns The SchemaVersion that corresponds to the provided MinimumVersionForCollab.
  */
 export function clientVersionToSchemaVersion(
-	clientVersion: FluidClientVersion,
+	clientVersion: MinimumVersionForCollab,
 ): SchemaVersion {
 	// Only one version of the schema codec is currently supported.
 	return SchemaVersion.v1;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tree";
-export const pkgVersion = "2.63.0-359962";
+export const pkgVersion = "2.70.0-360374";

package/src/shared-tree/schematizingTreeView.ts

@@ -200,9 +200,15 @@ export class SchematizingSimpleTreeView<
 				this,
 				schema.rootFieldSchema,
 				(batches, doHydration) => {
-					assert(this.pendingHydration === undefined, "pendingHydration already set");
+					assert(
+						this.pendingHydration === undefined,
+						0xc74 /* pendingHydration already set */,
+					);
 					this.pendingHydration = () => {
-						assert(batches.length <= 1, "initialize should at most one hydration batch");
+						assert(
+							batches.length <= 1,
+							0xc75 /* initialize should at most one hydration batch */,
+						);
 						for (const batch of batches) {
 							doHydration(batch, {
 								parent: undefined,
@@ -408,7 +414,7 @@ export class SchematizingSimpleTreeView<
 		if (!this.midUpgrade) {
 			assert(
 				this.pendingHydration === undefined,
-				"no nodes should be pending hydration when triggering events that could access nodes",
+				0xc76 /* no nodes should be pending hydration when triggering events that could access nodes */,
 			);
 			this.events.emit("schemaChanged");
 			this.events.emit("rootChanged");
@@ -477,7 +483,7 @@ export class SchematizingSimpleTreeView<
 			view.root.is(FieldKinds.optional) ||
 				view.root.is(FieldKinds.required) ||
 				view.root.is(FieldKinds.identifier),
-			"unexpected root field kind",
+			0xc77 /* unexpected root field kind */,
 		);
 		return view.root;
 	}

package/src/shared-tree/sharedTree.ts

@@ -942,7 +942,7 @@ export function buildConfiguredForest(
 
 export const defaultSharedTreeOptions: Required<SharedTreeOptionsInternal> = {
 	jsonValidator: FormatValidatorNoOp,
-	oldestCompatibleClient: FluidClientVersion.v2_0,
+	minVersionForCollab: FluidClientVersion.v2_0,
 	forest: ForestTypeReference,
 	treeEncodeType: TreeCompressionStrategy.Compressed,
 	formatVersion: SharedTreeFormatVersion.v3,

package/src/shared-tree/sharedTreeChangeCodecs.ts

@@ -94,7 +94,7 @@ export function getCodecTreeForChangeFormat(
 	version: SharedTreeChangeFormatVersion,
 ): CodecTree {
 	const { modularChange, schemaChange } =
-		dependenciesForChangeFormat.get(version) ?? fail("Unknown change format");
+		dependenciesForChangeFormat.get(version) ?? fail(0xc78 /* Unknown change format */);
 	return {
 		name: "SharedTreeChange",
 		version,

package/src/shared-tree/treeAlpha.ts

@@ -331,10 +331,7 @@ export interface TreeAlpha {
 	 */
 	exportCompressed(
 		tree: TreeNode | TreeLeafValue,
-		options: { idCompressor?: IIdCompressor } & Pick<
-			CodecWriteOptions,
-			"oldestCompatibleClient"
-		>,
+		options: { idCompressor?: IIdCompressor } & Pick<CodecWriteOptions, "minVersionForCollab">,
 	): JsonCompatible<IFluidHandle>;
 
 	/**
@@ -812,13 +809,10 @@ export const TreeAlpha: TreeAlpha = {
 
 	exportCompressed(
 		node: TreeNode | TreeLeafValue,
-		options: { idCompressor?: IIdCompressor } & Pick<
-			CodecWriteOptions,
-			"oldestCompatibleClient"
-		>,
+		options: { idCompressor?: IIdCompressor } & Pick<CodecWriteOptions, "minVersionForCollab">,
 	): JsonCompatible<IFluidHandle> {
 		const schema = tryGetSchema(node) ?? fail(0xacf /* invalid input */);
-		const format = fluidVersionToFieldBatchCodecWriteVersion(options.oldestCompatibleClient);
+		const format = fluidVersionToFieldBatchCodecWriteVersion(options.minVersionForCollab);
 		const codec = makeFieldBatchCodec({ jsonValidator: FormatValidatorNoOp }, format);
 		const cursor = borrowFieldCursorFromTreeNodeOrValue(node);
 		const batch: FieldBatch = [cursor];

package/src/shared-tree/treeCheckout.ts

@@ -298,7 +298,7 @@ export function createTreeCheckout(
 	const forest = args?.forest ?? buildForest(breaker, schema);
 	const defaultCodecOptions = {
 		jsonValidator: FormatValidatorNoOp,
-		oldestCompatibleClient: FluidClientVersion.v2_0,
+		minVersionForCollab: FluidClientVersion.v2_0,
 	};
 	const defaultFieldBatchVersion = 1;
 	const changeFamily =

package/src/shared-tree-core/defaultResubmitMachine.ts

@@ -70,7 +70,7 @@ export class DefaultResubmitMachine<TChange> implements ResubmitMachine<TChange>
 		const localCommits = getLocalCommits();
 		assert(
 			localCommits[0]?.revision === revision,
-			"Expected local commits to start with specified revision",
+			0xc79 /* Expected local commits to start with specified revision */,
 		);
 
 		// Some in-flight commits have stale enrichments, so we recompute them.
@@ -128,7 +128,8 @@ export class DefaultResubmitMachine<TChange> implements ResubmitMachine<TChange>
 
 	private getPendingChange(revision: RevisionTag): PendingChange<TChange> {
 		return (
-			this.pendingChanges.get(revision) ?? fail("No pending change stored for this revision")
+			this.pendingChanges.get(revision) ??
+			fail(0xc7a /* No pending change stored for this revision */)
 		);
 	}
 

package/src/simple-tree/api/storedSchema.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import type { FluidClientVersion, ICodecOptions } from "../../codec/index.js";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
+import type { ICodecOptions } from "../../codec/index.js";
 import { SchemaVersion } from "../../core/index.js";
 import { encodeTreeSchema, makeSchemaCodec } from "../../feature-libraries/index.js";
 import {
@@ -24,7 +25,7 @@ import type { SchemaCompatibilityStatus } from "./tree.js";
  * Dumps the "persisted" schema subset of the provided `schema` into a deterministic JSON-compatible, semi-human-readable format.
  *
  * @param schema - The schema to dump.
- * @param oldestCompatibleClient - The oldest client version which can read the schema: impacts the format used.
+ * @param minVersionForCollab - The oldest client version which can read the schema: impacts the format used.
  * @param includeStaged - filter for selecting which staged allowed types to include in the output.
  *
  * @remarks
@@ -54,11 +55,11 @@ import type { SchemaCompatibilityStatus } from "./tree.js";
  */
 export function extractPersistedSchema(
 	schema: ImplicitFieldSchema,
-	oldestCompatibleClient: FluidClientVersion,
+	minVersionForCollab: MinimumVersionForCollab,
 	includeStaged: (upgrade: SchemaUpgrade) => boolean,
 ): JsonCompatible {
 	const stored = toStoredSchema(schema, { includeStaged });
-	const schemaWriteVersion = clientVersionToSchemaVersion(oldestCompatibleClient);
+	const schemaWriteVersion = clientVersionToSchemaVersion(minVersionForCollab);
 	return encodeTreeSchema(stored, schemaWriteVersion);
 }
 

package/src/simple-tree/core/allowedTypes.ts

@@ -539,7 +539,10 @@ export function normalizeAllowedTypesInternal(
 	return getOrCreate(cachedNormalize, type, () => {
 		// Due to more specific internal type, the above does not narrow sufficiently, so more narrowing is needed.
 		// It is possible this will give a false error if a TreeNodeSchema which matches this check is used.
-		assert(!("types" in type && "metadata" in type), "invalid AnnotatedAllowedTypes");
+		assert(
+			!("types" in type && "metadata" in type),
+			0xc7d /* invalid AnnotatedAllowedTypes */,
+		);
 
 		const annotatedTypes: AnnotatedAllowedType[] = (isReadonlyArray(type) ? type : [type]).map(
 			normalizeToAnnotatedAllowedType,

package/src/simple-tree/prepareForInsertion.ts

@@ -343,7 +343,7 @@ function hydrator(
 		// Find or create one as necessary.
 		for (const { path, node } of batch.paths) {
 			const anchor = forest.anchors.track(path);
-			const anchorNode = forest.anchors.locate(anchor) ?? fail("missing anchor");
+			const anchorNode = forest.anchors.locate(anchor) ?? fail(0xc7b /* missing anchor */);
 
 			let flexNode = anchorNode.slots.get(flexTreeSlot);
 			if (flexNode === undefined) {

package/src/treeFactory.ts

@@ -49,10 +49,23 @@ function treeKernelFactory(
 		if (args.idCompressor === undefined) {
 			throw new UsageError("IdCompressor must be enabled to use SharedTree");
 		}
-		const adjustedOptions = { ...options };
-		// TODO: get default from runtime once something like runtime.oldestCompatibleClient exists.
-		// Using default of 2.0 since that is the oldest version that supports SharedTree.
-		adjustedOptions.oldestCompatibleClient ??= FluidClientVersion.v2_0;
+
+		const { minVersionForCollab, ...otherOptions } = options;
+
+		const adjustedOptions = {
+			...otherOptions,
+			// Cases:
+			// A. If options specifies minVersionForCollab, it takes precedence over args.minVersionForCollab.
+			// This value is set when:
+			// - A customer using the declarative SharedTree API specifies the setting at the Shared Tree level.
+			//   There is currently no way to set it via the declarative API, but it could be added in the future.
+			// - treeKernelFactory is invoked in a fuzz test with a specific minVersionForCollab
+			// B. Otherwise, we use args.minVersionForCollab, which is propagated from the ContainerRuntime.
+			// C. If neither specifies it, we fall back to a default value default of 2.0 since that is the oldest version that supports SharedTree.
+			minVersionForCollab:
+				minVersionForCollab ?? args.minVersionForCollab ?? FluidClientVersion.v2_0,
+		};
+
 		return new SharedTreeKernel(
 			new Breakable("SharedTree"),
 			args.sharedObject,