@fluidframework/tree 2.113.0-411909 → 2.114.0

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

@@ -10,6 +10,7 @@ import type { CodecWriteOptions, ICodecFamily } from "../../codec/index.js";
 import {
 	type ChangeAtomId,
 	type ChangeEncodingContext,
+	type ChangeDecodingContext,
 	type ChangeFamily,
 	type ChangeFamilyEditor,
 	type ChangeRebaser,
@@ -24,6 +25,7 @@ import {
 	type UpPath,
 	compareFieldUpPaths,
 	topDownPath,
+	type ProcessChangeFn,
 } from "../../core/index.js";
 import { brand } from "../../util/index.js";
 import {
@@ -43,18 +45,20 @@ import { fieldKinds } from "./defaultFieldKinds.js";
 
 export type DefaultChangeset = ModularChangeset;
 
+export type DefaultChangeProcessingContext = ModularChangeFamily;
+
 /**
  * Implementation of {@link ChangeFamily} based on the default set of supported field kinds.
  *
  * @sealed
  */
 export class DefaultChangeFamily
-	implements ChangeFamily<DefaultEditBuilder, DefaultChangeset>
+	implements ChangeFamily<DefaultEditBuilder, DefaultChangeset, DefaultChangeProcessingContext>
 {
 	private readonly modularFamily: ModularChangeFamily;
 
 	public constructor(
-		codecs: ICodecFamily<ModularChangeset, ChangeEncodingContext>,
+		codecs: ICodecFamily<ModularChangeset, ChangeEncodingContext, ChangeDecodingContext>,
 		codecOptions: CodecWriteOptions,
 	) {
 		this.modularFamily = new ModularChangeFamily(fieldKinds, codecs, codecOptions);
@@ -64,7 +68,11 @@ export class DefaultChangeFamily
 		return this.modularFamily.rebaser;
 	}
 
-	public get codecs(): ICodecFamily<DefaultChangeset, ChangeEncodingContext> {
+	public get codecs(): ICodecFamily<
+		DefaultChangeset,
+		ChangeEncodingContext,
+		ChangeDecodingContext
+	> {
 		return this.modularFamily.codecs;
 	}
 
@@ -73,12 +81,18 @@ export class DefaultChangeFamily
 		changeReceiver: (change: TaggedChange<DefaultChangeset>) => void,
 	): DefaultEditBuilder {
 		return new DefaultEditBuilder(
-			this,
+			this.modularFamily.rebaser,
 			mintRevisionTag,
 			changeReceiver,
 			this.modularFamily.codecOptions,
 		);
 	}
+
+	public buildProcessor(
+		processFn: ProcessChangeFn<DefaultChangeset, DefaultChangeProcessingContext>,
+	): (change: DefaultChangeset) => DefaultChangeset {
+		return this.modularFamily.buildProcessor(processFn);
+	}
 }
 
 /**
@@ -194,13 +208,13 @@ export class DefaultEditBuilder implements ChangeFamilyEditor, IDefaultEditBuild
 	private readonly modularBuilder: ModularEditBuilder;
 
 	public constructor(
-		family: ChangeFamily<ChangeFamilyEditor, DefaultChangeset>,
+		rebaser: ChangeRebaser<DefaultChangeset>,
 		private readonly mintRevisionTag: () => RevisionTag,
 		changeReceiver: (change: TaggedChange<DefaultChangeset>) => void,
 		codecOptions: CodecWriteOptions,
 	) {
 		this.modularBuilder = new ModularEditBuilder(
-			family,
+			rebaser,
 			fieldKinds,
 			changeReceiver,
 			codecOptions,

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

@@ -12,6 +12,7 @@ export {
 } from "./defaultFieldKinds.js";
 
 export {
+	type DefaultChangeProcessingContext,
 	type DefaultChangeset,
 	DefaultChangeFamily,
 	DefaultEditBuilder,

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

@@ -4,7 +4,15 @@
  */
 
 import { type ICodecFamily, makeCodecFamily, unitCodec } from "../../codec/index.js";
-import type { FieldChangeEncodingContext } from "../modular-schema/index.js";
+import type {
+	FieldChangeEncodingContext,
+	FieldChangeDecodingContext,
+} from "../modular-schema/index.js";
 
-export const noChangeCodecFamily: ICodecFamily<0, FieldChangeEncodingContext> =
-	makeCodecFamily<0, FieldChangeEncodingContext>([[1, unitCodec]]);
+export const noChangeCodecFamily: ICodecFamily<
+	0,
+	FieldChangeEncodingContext,
+	FieldChangeDecodingContext
+> = makeCodecFamily<0, FieldChangeEncodingContext, FieldChangeDecodingContext>([
+	[1, unitCodec],
+]);

package/src/feature-libraries/detachedFieldIndexSummarizer.ts

@@ -5,6 +5,7 @@
 
 import { bufferToString } from "@fluid-internal/client-utils";
 import type { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
+import type { IIdCompressor } from "@fluidframework/id-compressor";
 import type {
 	IExperimentalIncrementalSummaryContext,
 	ITelemetryContext,
@@ -12,7 +13,18 @@ import type {
 } from "@fluidframework/runtime-definitions/internal";
 import type { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
 
-import type { DetachedFieldIndex } from "../core/index.js";
+import {
+	type CodecWriteOptions,
+	FluidClientVersion,
+	FormatValidatorNoOp,
+	type IJsonCodec,
+} from "../codec/index.js";
+import {
+	type DetachedFieldIndex,
+	type DetachedFieldSummaryData,
+	type RevisionTagCodec,
+	detachedFieldIndexCodecBuilder,
+} from "../core/index.js";
 import {
 	type Summarizable,
 	type SummaryElementParser,
@@ -66,16 +78,31 @@ export class DetachedFieldIndexSummarizer
 	extends VersionedSummarizer<DetachedFieldIndexSummaryFormatVersion>
 	implements Summarizable
 {
+	private readonly codec: IJsonCodec<DetachedFieldSummaryData>;
+
 	public constructor(
 		private readonly detachedFieldIndex: DetachedFieldIndex,
-		minVersionForCollab: MinimumVersionForCollab,
+		revisionTagCodec: RevisionTagCodec,
+		idCompressor: IIdCompressor,
+		options?: CodecWriteOptions,
 	) {
+		const normalizedOptions = options ?? {
+			jsonValidator: FormatValidatorNoOp,
+			minVersionForCollab: FluidClientVersion.v2_0,
+		};
 		super(
 			"DetachedFieldIndex",
-			minVersionToDetachedFieldIndexSummaryFormatVersion(minVersionForCollab),
+			minVersionToDetachedFieldIndexSummaryFormatVersion(
+				normalizedOptions.minVersionForCollab,
+			),
 			supportedVersions,
 			true,
 		);
+		this.codec = detachedFieldIndexCodecBuilder.build({
+			...normalizedOptions,
+			revisionTagCodec,
+			idCompressor,
+		});
 	}
 
 	protected summarizeInternal(props: {
@@ -87,7 +114,7 @@ export class DetachedFieldIndexSummarizer
 		builder: SummaryTreeBuilder;
 	}): void {
 		const { stringify, builder } = props;
-		const data = this.detachedFieldIndex.encode();
+		const data = this.codec.encode(this.detachedFieldIndex.getSummaryData());
 		builder.addBlob(detachedFieldIndexBlobKey, stringify(data));
 	}
 
@@ -99,7 +126,8 @@ export class DetachedFieldIndexSummarizer
 			const detachedFieldIndexBuffer = await services.readBlob(detachedFieldIndexBlobKey);
 			const treeBufferString = bufferToString(detachedFieldIndexBuffer, "utf8");
 			const parsed = parse(treeBufferString) as JsonCompatibleReadOnly;
-			this.detachedFieldIndex.loadData(parsed);
+			const decoded = this.codec.decode(parsed);
+			this.detachedFieldIndex.loadData(decoded);
 		}
 	}
 }

package/src/feature-libraries/forest-summary/forestSummarizer.ts

@@ -20,7 +20,6 @@ import {
 	type IEditableForest,
 	type ITreeCursorSynchronous,
 	type ITreeSubscriptionCursor,
-	type RevisionTagCodec,
 	TreeNavigationResult,
 	applyDelta,
 	forEachField,
@@ -79,7 +78,6 @@ export class ForestSummarizer
 	 */
 	public constructor(
 		private readonly forest: IEditableForest,
-		private readonly revisionTagCodec: RevisionTagCodec,
 		private readonly encoderContext: FieldBatchEncodingContext,
 		private readonly decoderContext: FieldBatchDecodingContext,
 		options: CodecWriteOptions,
@@ -240,7 +238,7 @@ export class ForestSummarizer
 			{ build, fields: new Map(fieldChanges) },
 			undefined,
 			this.forest,
-			makeDetachedFieldIndex("init", this.revisionTagCodec, this.idCompressor),
+			makeDetachedFieldIndex("init"),
 		);
 	}
 }

package/src/feature-libraries/index.ts

@@ -27,6 +27,7 @@ export {
 	type MinimalFieldMap,
 } from "./mapTreeCursor.js";
 export { buildForest } from "./object-forest/index.js";
+export { ComparisonForest } from "./comparison-forest/index.js";
 export {
 	SchemaSummarizer,
 	schemaCodecBuilder,
@@ -45,6 +46,8 @@ export {
 	jsonableTreeFromCursor,
 	jsonableTreeFromFieldCursor,
 	jsonableTreeFromForest,
+	forestsEqual,
+	assertForestsEqual,
 } from "./treeTextCursor.js";
 export {
 	buildNodeComparator,
@@ -88,6 +91,7 @@ export {
 	updateRefreshers,
 	type NodeId,
 	type FieldChangeEncodingContext,
+	type FieldChangeDecodingContext,
 	type FieldKindConfiguration,
 	type FieldKindConfigurationEntry,
 	isNeverTree,
@@ -133,6 +137,7 @@ export {
 
 export {
 	FieldKinds,
+	type DefaultChangeProcessingContext,
 	type DefaultChangeset,
 	DefaultChangeFamily,
 	DefaultEditBuilder,

package/src/feature-libraries/mitigatedChangeFamily.ts

@@ -7,6 +7,7 @@ import type {
 	ChangeFamily,
 	ChangeFamilyEditor,
 	ChangeRebaser,
+	ProcessChangeFn,
 	RevisionMetadataSource,
 	RevisionReplacer,
 	RevisionTag,
@@ -27,11 +28,15 @@ import type {
  * @param onError - A callback invoked for each error thrown.
  * @returns a mitigated change family.
  */
-export function makeMitigatedChangeFamily<TEditor extends ChangeFamilyEditor, TChange>(
-	unmitigatedChangeFamily: ChangeFamily<TEditor, TChange>,
+export function makeMitigatedChangeFamily<
+	TEditor extends ChangeFamilyEditor,
+	TChange,
+	TChangeProcessingContext,
+>(
+	unmitigatedChangeFamily: ChangeFamily<TEditor, TChange, TChangeProcessingContext>,
 	fallbackChange: TChange,
 	onError: (error: unknown) => void,
-): ChangeFamily<TEditor, TChange> {
+): ChangeFamily<TEditor, TChange, TChangeProcessingContext> {
 	return {
 		buildEditor: (
 			mintRevisionTag: () => RevisionTag,
@@ -41,6 +46,19 @@ export function makeMitigatedChangeFamily<TEditor extends ChangeFamilyEditor, TC
 		},
 		rebaser: makeMitigatedRebaser(unmitigatedChangeFamily.rebaser, fallbackChange, onError),
 		codecs: unmitigatedChangeFamily.codecs,
+		buildProcessor: (
+			processFn: ProcessChangeFn<TChange, TChangeProcessingContext>,
+		): ((change: TChange) => TChange) => {
+			const unmitigatedProcessor = unmitigatedChangeFamily.buildProcessor(processFn);
+			return (change: TChange): TChange => {
+				try {
+					return unmitigatedProcessor(change);
+				} catch (error: unknown) {
+					onError(error);
+					return fallbackChange;
+				}
+			};
+		},
 	};
 }
 

package/src/feature-libraries/modular-schema/fieldChangeHandler.ts

@@ -63,7 +63,7 @@ export interface FieldChangeHandler<
 			typeof RevisionTagSchema,
 			ChangeEncodingContext
 		>,
-	) => ICodecFamily<TChangeset, FieldChangeEncodingContext>;
+	) => ICodecFamily<TChangeset, FieldChangeEncodingContext, FieldChangeDecodingContext>;
 	readonly editor: TEditor;
 	intoDelta(change: TChangeset, deltaFromChild: ToDelta): FieldChangeDelta;
 	/**
@@ -302,5 +302,14 @@ export interface RebaseRevisionMetadata extends RevisionMetadataSource {
 export interface FieldChangeEncodingContext {
 	readonly baseContext: ChangeEncodingContext;
 	encodeNode(nodeId: NodeId): EncodedNodeChangeset;
+}
+
+/**
+ * Context provided to field change codecs when decoding.
+ * @remarks
+ * The decode-side counterpart of {@link FieldChangeEncodingContext}.
+ */
+export interface FieldChangeDecodingContext {
+	readonly baseContext: ChangeEncodingContext;
 	decodeNode(encodedNode: EncodedNodeChangeset): NodeId;
 }

package/src/feature-libraries/modular-schema/genericFieldKindCodecs.ts

@@ -5,14 +5,18 @@
 
 import { type ICodecFamily, type IJsonCodec, makeCodecFamily } from "../../codec/index.js";
 
-import type { FieldChangeEncodingContext } from "./fieldChangeHandler.js";
+import type {
+	FieldChangeEncodingContext,
+	FieldChangeDecodingContext,
+} from "./fieldChangeHandler.js";
 import { EncodedGenericChangeset } from "./genericFieldKindFormat.js";
 import { newGenericChangeset, type GenericChangeset } from "./genericFieldKindTypes.js";
 import { EncodedNodeChangeset } from "./modularChangeFormatV1.js";
 
 export function makeGenericChangeCodec(): ICodecFamily<
 	GenericChangeset,
-	FieldChangeEncodingContext
+	FieldChangeEncodingContext,
+	FieldChangeDecodingContext
 > {
 	return makeCodecFamily([[1, makeV1Codec()]]);
 }
@@ -21,7 +25,8 @@ function makeV1Codec(): IJsonCodec<
 	GenericChangeset,
 	EncodedGenericChangeset,
 	EncodedGenericChangeset,
-	FieldChangeEncodingContext
+	FieldChangeEncodingContext,
+	FieldChangeDecodingContext
 > {
 	return {
 		encode: (
@@ -35,7 +40,7 @@ function makeV1Codec(): IJsonCodec<
 		},
 		decode: (
 			encoded: EncodedGenericChangeset,
-			context: FieldChangeEncodingContext,
+			context: FieldChangeDecodingContext,
 		): GenericChangeset => {
 			return newGenericChangeset(
 				encoded.map(([index, nodeChange]) => [index, context.decodeNode(nodeChange)]),

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

@@ -34,6 +34,7 @@ export {
 	type FieldChangeHandler,
 	type FieldChangeDelta,
 	type FieldChangeEncodingContext,
+	type FieldChangeDecodingContext,
 	type FieldChangeRebaser,
 	type FieldEditor,
 	type NestedChangesIndices,