@fluidframework/tree 2.100.0 → 2.100.1

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

@@ -28,6 +28,20 @@ import type {
 export interface EditManagerEncodingContext {
 	idCompressor: IIdCompressor;
 	readonly schema?: SchemaAndPolicy;
+	/**
+	 * See {@link ChangeEncodingContext.isSummary}. EditManager codec callers
+	 * always set this to `true` (the codec is only invoked for summaries),
+	 * but it is carried explicitly so downstream codecs can read it.
+	 */
+	readonly isSummary: boolean;
+	/**
+	 * See {@link ChangeEncodingContext.healUnresolvableIdentifiersOnDecode}.
+	 */
+	readonly healUnresolvableIdentifiersOnDecode?: boolean;
+	/**
+	 * See {@link ChangeEncodingContext.sharedObjectId}.
+	 */
+	readonly sharedObjectId?: string;
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -53,6 +67,7 @@ function encodeCommit<TChangeset, T extends Commit<TChangeset>>(
 			originatorId: commit.sessionId,
 			idCompressor: context.idCompressor,
 			revision: undefined,
+			isSummary: context.isSummary,
 		}),
 		change: changeCodec.encode(commit.change, { ...context, revision: commit.revision }),
 	};
@@ -79,6 +94,7 @@ function decodeCommit<TChangeset, T extends EncodedCommit<JsonCompatibleReadOnly
 		originatorId: commit.sessionId,
 		idCompressor: context.idCompressor,
 		revision: undefined,
+		isSummary: context.isSummary,
 	});
 
 	return {
@@ -112,6 +128,7 @@ export function encodeSharedBranch<TChangeset>(
 				idCompressor: context.idCompressor,
 				schema: context.schema,
 				revision: undefined,
+				isSummary: context.isSummary,
 			}),
 		),
 		peers: Array.from(data.peerLocalBranches.entries(), ([sessionId, branch]) => [
@@ -121,6 +138,7 @@ export function encodeSharedBranch<TChangeset>(
 					originatorId: sessionId,
 					idCompressor: context.idCompressor,
 					revision: undefined,
+					isSummary: context.isSummary,
 				}),
 				commits: branch.commits.map((commit) =>
 					encodeCommit(changeCodec, revisionTagCodec, commit, {
@@ -128,6 +146,7 @@ export function encodeSharedBranch<TChangeset>(
 						idCompressor: context.idCompressor,
 						schema: context.schema,
 						revision: undefined,
+						isSummary: context.isSummary,
 					}),
 				),
 			},
@@ -154,6 +173,7 @@ export function encodeSharedBranch<TChangeset>(
 			originatorId,
 			idCompressor: context.idCompressor,
 			revision: undefined,
+			isSummary: context.isSummary,
 		});
 	}
 	return json;
@@ -186,6 +206,9 @@ export function decodeSharedBranch<TChangeset>(
 					originatorId: commit.sessionId,
 					idCompressor: context.idCompressor,
 					revision: undefined,
+					isSummary: context.isSummary,
+					healUnresolvableIdentifiersOnDecode: context.healUnresolvableIdentifiersOnDecode,
+					sharedObjectId: context.sharedObjectId,
 				}),
 		),
 		peerLocalBranches: new Map(
@@ -196,6 +219,7 @@ export function decodeSharedBranch<TChangeset>(
 						originatorId: sessionId,
 						idCompressor: context.idCompressor,
 						revision: undefined,
+						isSummary: context.isSummary,
 					}),
 					commits: branch.commits.map((commit) =>
 						// TODO: sort out EncodedCommit vs Commit, and make this type check without `as`.
@@ -207,6 +231,10 @@ export function decodeSharedBranch<TChangeset>(
 								originatorId: commit.sessionId,
 								idCompressor: context.idCompressor,
 								revision: undefined,
+								isSummary: context.isSummary,
+								healUnresolvableIdentifiersOnDecode:
+									context.healUnresolvableIdentifiersOnDecode,
+								sharedObjectId: context.sharedObjectId,
 							},
 						),
 					),
@@ -239,6 +267,7 @@ export function decodeSharedBranch<TChangeset>(
 			originatorId,
 			idCompressor: context.idCompressor,
 			revision: undefined,
+			isSummary: context.isSummary,
 		});
 	}
 	return data;

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

@@ -25,6 +25,9 @@ import { EncodedEditManager } from "./editManagerFormatV1toV4.js";
 export interface EditManagerEncodingContext {
 	idCompressor: IIdCompressor;
 	readonly schema?: SchemaAndPolicy;
+	readonly isSummary: boolean;
+	readonly healUnresolvableIdentifiersOnDecode?: boolean;
+	readonly sharedObjectId?: string;
 }
 
 /**

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

@@ -29,6 +29,9 @@ import { EncodedEditManager } from "./editManagerFormatVSharedBranches.js";
 export interface EditManagerEncodingContext {
 	idCompressor: IIdCompressor;
 	readonly schema?: SchemaAndPolicy;
+	readonly isSummary: boolean;
+	readonly healUnresolvableIdentifiersOnDecode?: boolean;
+	readonly sharedObjectId?: string;
 }
 
 export function makeSharedBranchesCodecWithVersion<TChangeset>(

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

@@ -85,6 +85,10 @@ export class EditManagerSummarizer<TChangeset>
 		private readonly idCompressor: IIdCompressor,
 		minVersionForCollab: MinimumVersionForCollab,
 		private readonly schemaAndPolicy?: SchemaAndPolicy,
+		/** See {@link EditManagerEncodingContext.healUnresolvableIdentifiersOnDecode}. */
+		private readonly healUnresolvableIdentifiersOnDecode?: boolean,
+		/** See {@link EditManagerEncodingContext.sharedObjectId}. */
+		private readonly sharedObjectId?: string,
 	) {
 		super(
 			EditManagerSummarizer.key,
@@ -103,10 +107,13 @@ export class EditManagerSummarizer<TChangeset>
 		builder: SummaryTreeBuilder;
 	}): void {
 		const { stringify, builder } = props;
-		const context: EditManagerEncodingContext =
-			this.schemaAndPolicy === undefined
-				? { idCompressor: this.idCompressor }
-				: { schema: this.schemaAndPolicy, idCompressor: this.idCompressor };
+		const context: EditManagerEncodingContext = {
+			idCompressor: this.idCompressor,
+			schema: this.schemaAndPolicy,
+			isSummary: true,
+			healUnresolvableIdentifiersOnDecode: this.healUnresolvableIdentifiersOnDecode,
+			sharedObjectId: this.sharedObjectId,
+		};
 		const jsonCompatible = this.codec.encode(this.editManager.getSummaryData(), context);
 		const dataString = stringify(jsonCompatible);
 		builder.addBlob(stringKey, dataString);
@@ -127,7 +134,12 @@ export class EditManagerSummarizer<TChangeset>
 		);
 
 		const summary = parse(bufferToString(schemaBuffer, "utf8")) as JsonCompatibleReadOnly;
-		const data = this.codec.decode(summary, { idCompressor: this.idCompressor });
+		const data = this.codec.decode(summary, {
+			idCompressor: this.idCompressor,
+			isSummary: true,
+			healUnresolvableIdentifiersOnDecode: this.healUnresolvableIdentifiersOnDecode,
+			sharedObjectId: this.sharedObjectId,
+		});
 		this.editManager.loadSummaryData(data);
 	}
 }

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

@@ -55,6 +55,7 @@ export function makeV1ToV4CodecWithVersion<TChangeset>(
 					originatorId,
 					idCompressor: context.idCompressor,
 					revision: undefined,
+					isSummary: false,
 				}),
 				originatorId,
 				changeset: changeCodec.encode(commit.change, {
@@ -62,6 +63,7 @@ export function makeV1ToV4CodecWithVersion<TChangeset>(
 					schema: context.schema,
 					idCompressor: context.idCompressor,
 					revision: commit.revision,
+					isSummary: false,
 				}),
 				version,
 			};
@@ -76,6 +78,7 @@ export function makeV1ToV4CodecWithVersion<TChangeset>(
 				originatorId,
 				revision: undefined,
 				idCompressor: context.idCompressor,
+				isSummary: false,
 			});
 
 			return {
@@ -87,6 +90,7 @@ export function makeV1ToV4CodecWithVersion<TChangeset>(
 						originatorId,
 						revision,
 						idCompressor: context.idCompressor,
+						isSummary: false,
 					}),
 				},
 				sessionId: originatorId,

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

@@ -47,6 +47,7 @@ export function makeSharedBranchesCodecWithVersion<TChangeset>(
 						schema: context.schema,
 						idCompressor: context.idCompressor,
 						revision: message.commit.revision,
+						isSummary: false,
 					};
 
 					return {
@@ -54,6 +55,7 @@ export function makeSharedBranchesCodecWithVersion<TChangeset>(
 							originatorId: message.sessionId,
 							idCompressor: context.idCompressor,
 							revision: undefined,
+							isSummary: false,
 						}),
 						originatorId: message.sessionId,
 						changeset: changeCodec.encode(message.commit.change, changeContext),
@@ -84,10 +86,11 @@ export function makeSharedBranchesCodecWithVersion<TChangeset>(
 				branchId: encodedBranchId,
 			} = encoded;
 
-			const changeContext = {
+			const changeContext: ChangeEncodingContext = {
 				originatorId,
 				revision: undefined,
 				idCompressor: context.idCompressor,
+				isSummary: false,
 			};
 
 			const branchId = decodeBranchId(context.idCompressor, encodedBranchId, changeContext);
@@ -107,6 +110,7 @@ export function makeSharedBranchesCodecWithVersion<TChangeset>(
 						originatorId,
 						revision,
 						idCompressor: context.idCompressor,
+						isSummary: false,
 					}),
 				},
 				branchId,

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

@@ -73,7 +73,12 @@ export interface ClonableSchemaAndPolicy extends SchemaAndPolicy {
 	schema: TreeStoredSchemaRepository;
 }
 
-export interface SharedTreeCoreOptionsInternal extends CodecWriteOptions {}
+export interface SharedTreeCoreOptionsInternal extends CodecWriteOptions {
+	/**
+	 * See {@link SharedTreeOptionsBeta.healUnresolvableIdentifiersOnDecode}.
+	 */
+	readonly healUnresolvableIdentifiersOnDecode?: boolean;
+}
 
 export interface EnrichmentConfig<TChange> {
 	readonly enricher: ChangeEnricher<TChange>;
@@ -192,6 +197,8 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 				this.idCompressor,
 				options.minVersionForCollab,
 				this.schemaAndPolicy,
+				options.healUnresolvableIdentifiersOnDecode,
+				sharedObject.id,
 			),
 			...summarizables,
 		];