@fluidframework/tree 2.74.0 → 2.81.0-374083

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

@@ -18,6 +18,7 @@ import {
 	mintCommit,
 	type RebaseStatsWithDuration,
 	tagChange,
+	type EditorOptions,
 } from "../core/index.js";
 import { type Mutable, brand, getOrCreate, mapIterable } from "../util/index.js";
 
@@ -123,6 +124,7 @@ export class EditManager<
 		public readonly localSessionId: SessionId,
 		private readonly mintRevisionTag: () => RevisionTag,
 		private readonly onSharedBranchCreated?: (branchId: BranchId) => void,
+		editorOptions?: EditorOptions,
 		logger?: ITelemetryLoggerExt,
 	) {
 		this.trunkBase = {
@@ -147,9 +149,10 @@ export class EditManager<
 			mintRevisionTag,
 			this._events,
 			this.telemetryEventBatcher,
+			editorOptions,
 		);
 
-		this.createAndAddSharedBranch("main", undefined, undefined, mainTrunk);
+		this.createAndAddSharedBranch("main", undefined, undefined, mainTrunk, editorOptions);
 	}
 
 	public getLocalBranch(branchId: BranchId): SharedTreeBranch<TEditor, TChangeset> {
@@ -466,7 +469,7 @@ export class EditManager<
 	}
 
 	public getSharedBranchIds(): BranchId[] {
-		return Array.from(this.sharedBranches.keys());
+		return [...this.sharedBranches.keys()];
 	}
 
 	public removeBranch(branchId: BranchId): void {
@@ -480,8 +483,15 @@ export class EditManager<
 		sessionId: SessionId | undefined,
 		parent: SharedBranch<TEditor, TChangeset> | undefined,
 		branch: SharedTreeBranch<TEditor, TChangeset>,
+		editorOptions?: EditorOptions,
 	): SharedBranch<TEditor, TChangeset> {
-		const sharedBranch = this.createSharedBranch(branchId, sessionId, parent, branch);
+		const sharedBranch = this.createSharedBranch(
+			branchId,
+			sessionId,
+			parent,
+			branch,
+			editorOptions,
+		);
 		this.addSharedBranch(branchId, sharedBranch);
 		return sharedBranch;
 	}
@@ -512,6 +522,7 @@ export class EditManager<
 		sessionId: SessionId | undefined,
 		parent: SharedBranch<TEditor, TChangeset> | undefined,
 		branch: SharedTreeBranch<TEditor, TChangeset>,
+		editorOptions?: EditorOptions,
 	): SharedBranch<TEditor, TChangeset> {
 		const sharedBranch = new SharedBranch(
 			parent,
@@ -523,6 +534,7 @@ export class EditManager<
 			this.mintRevisionTag,
 			this._events,
 			this.telemetryEventBatcher,
+			editorOptions,
 		);
 
 		return sharedBranch;
@@ -695,6 +707,7 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 		private readonly mintRevisionTag: () => RevisionTag,
 		branchTrimmer: Listenable<BranchTrimmingEvents>,
 		telemetryEventBatcher: TelemetryEventBatcher<keyof RebaseStatsWithDuration> | undefined,
+		editorOptions?: EditorOptions,
 	) {
 		this.localBranch = new SharedTreeBranch(
 			this.trunk.getHead(),
@@ -702,6 +715,7 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 			mintRevisionTag,
 			branchTrimmer,
 			telemetryEventBatcher,
+			editorOptions,
 		);
 
 		this.sequenceIdToCommit.set(baseCommitSequenceId, this.trunk.getHead());
@@ -1090,27 +1104,27 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 		const parentTrunkBase =
 			trunkRevisionCache.get(data.base ?? rootRevision) ??
 			fail(0xc61 /* Expected base revision to be in trunk cache */);
-		this.trunk.setHead(
-			data.trunk.reduce((base, c) => {
-				const sequenceId: SequenceId =
-					c.indexInBatch === undefined
-						? {
-								sequenceNumber: c.sequenceNumber,
-							}
-						: {
-								sequenceNumber: c.sequenceNumber,
-								indexInBatch: c.indexInBatch,
-							};
-				const commit = mintCommit(base, c);
-				this.sequenceIdToCommit.set(sequenceId, commit);
-				this.commitMetadata.set(c.revision, {
-					sequenceId,
-					sessionId: c.sessionId,
-				});
-				trunkRevisionCache.set(c.revision, commit);
-				return commit;
-			}, parentTrunkBase),
-		);
+		let trunkHead = parentTrunkBase;
+		for (const c of data.trunk) {
+			const sequenceId: SequenceId =
+				c.indexInBatch === undefined
+					? {
+							sequenceNumber: c.sequenceNumber,
+						}
+					: {
+							sequenceNumber: c.sequenceNumber,
+							indexInBatch: c.indexInBatch,
+						};
+			const commit = mintCommit(trunkHead, c);
+			this.sequenceIdToCommit.set(sequenceId, commit);
+			this.commitMetadata.set(c.revision, {
+				sequenceId,
+				sessionId: c.sessionId,
+			});
+			trunkRevisionCache.set(c.revision, commit);
+			trunkHead = commit;
+		}
+		this.trunk.setHead(trunkHead);
 
 		this.localBranch.setHead(this.trunk.getHead());
 
@@ -1119,13 +1133,13 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 				trunkRevisionCache.get(branch.base) ??
 				fail(0xad7 /* Expected summary branch to be based off of a revision in the trunk */);
 
+			let branchHead = commit;
+			for (const c of branch.commits) {
+				branchHead = mintCommit(branchHead, c);
+			}
 			this.peerLocalBranches.set(
 				sessionId,
-				new SharedTreeBranch(
-					branch.commits.reduce(mintCommit, commit),
-					this.changeFamily,
-					this.mintRevisionTag,
-				),
+				new SharedTreeBranch(branchHead, this.changeFamily, this.mintRevisionTag),
 			);
 		}
 	}

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

@@ -58,6 +58,7 @@ export function clientVersionToEditManagerFormatVersion(
 		getConfigForMinVersionForCollab(clientVersion, {
 			[lowestMinVersionForCollab]: EditManagerFormatVersion.v3,
 			[FluidClientVersion.v2_43]: EditManagerFormatVersion.v4,
+			[FluidClientVersion.v2_80]: EditManagerFormatVersion.v6,
 		}),
 	);
 
@@ -73,6 +74,15 @@ export function editManagerFormatVersionSelectorForSharedBranches(
 	return brand(EditManagerFormatVersion.vSharedBranches);
 }
 
+/**
+ * Returns the version that should be used for testing shared branches.
+ */
+export function editManagerFormatVersionSelectorForDetachedRootEditing(
+	clientVersion: MinimumVersionForCollab,
+): EditManagerFormatVersion {
+	return brand(EditManagerFormatVersion.vDetachedRoots);
+}
+
 export interface EditManagerCodecOptions {
 	readonly editManagerFormatSelector?: (
 		minVersionForCollab: MinimumVersionForCollab,
@@ -135,18 +145,22 @@ export function makeEditManagerCodecs<TChangeset>(
 	][] = Array.from(editManagerFormatVersions, (version) => {
 		switch (version) {
 			case unbrand(EditManagerFormatVersion.v1):
-			case unbrand(EditManagerFormatVersion.v2):
+			case unbrand(EditManagerFormatVersion.v2): {
 				return [version, makeDiscontinuedCodecVersion(options, version, "2.73.0")];
+			}
 			case unbrand(EditManagerFormatVersion.v3):
-			case unbrand(EditManagerFormatVersion.v4): {
+			case unbrand(EditManagerFormatVersion.v4):
+			case unbrand(EditManagerFormatVersion.v6):
+			case unbrand(EditManagerFormatVersion.vDetachedRoots): {
 				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
 				return [
 					version,
 					makeV1CodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
-			case unbrand(EditManagerFormatVersion.v5):
+			case unbrand(EditManagerFormatVersion.v5): {
 				return [version, makeDiscontinuedCodecVersion(options, version, "2.74.0")];
+			}
 			case unbrand(EditManagerFormatVersion.vSharedBranches): {
 				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
 				return [
@@ -154,8 +168,9 @@ export function makeEditManagerCodecs<TChangeset>(
 					makeSharedBranchesCodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
-			default:
+			default: {
 				unreachableCase(version);
+			}
 		}
 	});
 	return makeCodecFamily(registry);

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

@@ -156,18 +156,30 @@ export const EditManagerFormatVersion = strictEnum("editManager.FormatVersion",
 	 * @deprecated Use {@link EditManagerFormatVersion.vSharedBranches} for testing shared branches.
 	 */
 	v5: 5,
+	/**
+	 * Introduced and made available for writing in 2.80.0
+	 * Adds support for "no change" constraints.
+	 */
+	v6: 6,
 	/**
 	 * Not yet released.
 	 * Only used for testing shared branches.
 	 */
 	vSharedBranches: "shared-branches|v0.1",
+	/**
+	 * Not yet released.
+	 * Only used for testing detached roots.
+	 */
+	vDetachedRoots: "detached-roots|v0.1",
 });
 export type EditManagerFormatVersion = Values<typeof EditManagerFormatVersion>;
 export const supportedEditManagerFormatVersions: ReadonlySet<EditManagerFormatVersion> =
 	new Set([
 		EditManagerFormatVersion.v3,
 		EditManagerFormatVersion.v4,
+		EditManagerFormatVersion.v6,
 		EditManagerFormatVersion.vSharedBranches,
+		EditManagerFormatVersion.vDetachedRoots,
 	]);
 export const editManagerFormatVersions: ReadonlySet<EditManagerFormatVersion> = new Set(
 	Object.values(EditManagerFormatVersion),

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

@@ -26,7 +26,9 @@ export interface EncodedEditManager<TChangeset> {
 		| typeof EditManagerFormatVersion.v1
 		| typeof EditManagerFormatVersion.v2
 		| typeof EditManagerFormatVersion.v3
-		| typeof EditManagerFormatVersion.v4;
+		| typeof EditManagerFormatVersion.v4
+		| typeof EditManagerFormatVersion.v6
+		| typeof EditManagerFormatVersion.vDetachedRoots;
 }
 
 export const EncodedEditManager = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>
@@ -37,6 +39,8 @@ export const EncodedEditManager = <ChangeSchema extends TSchema>(tChange: Change
 				Type.Literal(EditManagerFormatVersion.v2),
 				Type.Literal(EditManagerFormatVersion.v3),
 				Type.Literal(EditManagerFormatVersion.v4),
+				Type.Literal(EditManagerFormatVersion.v6),
+				Type.Literal(EditManagerFormatVersion.vDetachedRoots),
 			]),
 			trunk: Type.Array(SequencedCommit(tChange)),
 			branches: Type.Array(Type.Tuple([SessionIdSchema, SummarySessionBranch(tChange)])),

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

@@ -104,9 +104,9 @@ export class EditManagerSummarizer<TChangeset>
 	}): void {
 		const { stringify, builder } = props;
 		const context: EditManagerEncodingContext =
-			this.schemaAndPolicy !== undefined
-				? { schema: this.schemaAndPolicy, idCompressor: this.idCompressor }
-				: { idCompressor: this.idCompressor };
+			this.schemaAndPolicy === undefined
+				? { idCompressor: this.idCompressor }
+				: { schema: this.schemaAndPolicy, idCompressor: this.idCompressor };
 		const jsonCompatible = this.codec.encode(this.editManager.getSummaryData(), context);
 		const dataString = stringify(jsonCompatible);
 		builder.addBlob(stringKey, dataString);

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

@@ -51,6 +51,7 @@ export {
 	type EditManagerCodecOptions,
 	clientVersionToEditManagerFormatVersion,
 	editManagerFormatVersionSelectorForSharedBranches,
+	editManagerFormatVersionSelectorForDetachedRootEditing,
 } from "./editManagerCodecs.js";
 export {
 	EditManagerFormatVersion,
@@ -76,6 +77,7 @@ export {
 	getCodecTreeForMessageFormatWithChange,
 	clientVersionToMessageFormatVersion,
 	messageFormatVersionSelectorForSharedBranches,
+	messageFormatVersionSelectorForDetachedRootEditing,
 	makeMessageCodec,
 	type MessageEncodingContext,
 } from "./messageCodecs.js";

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

@@ -33,7 +33,9 @@ export function makeV1ToV4CodecWithVersion<TChangeset>(
 		| typeof MessageFormatVersion.v1
 		| typeof MessageFormatVersion.v2
 		| typeof MessageFormatVersion.v3
-		| typeof MessageFormatVersion.v4,
+		| typeof MessageFormatVersion.v4
+		| typeof MessageFormatVersion.v6
+		| typeof MessageFormatVersion.vDetachedRoots,
 ): IJsonCodec<
 	DecodedMessage<TChangeset>,
 	JsonCompatibleReadOnly,

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

@@ -79,8 +79,9 @@ export function makeSharedBranchesCodecWithVersion<TChangeset>(
 							version,
 						} satisfies Message & JsonCompatibleReadOnly;
 					}
-					default:
+					default: {
 						unreachableCase(type);
+					}
 				}
 			},
 			decode: (

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

@@ -55,6 +55,7 @@ export function clientVersionToMessageFormatVersion(
 		getConfigForMinVersionForCollab(clientVersion, {
 			[lowestMinVersionForCollab]: MessageFormatVersion.v3,
 			[FluidClientVersion.v2_43]: MessageFormatVersion.v4,
+			[FluidClientVersion.v2_80]: MessageFormatVersion.v6,
 		}),
 	);
 	return writeVersionOverride ?? compatibleVersion;
@@ -82,6 +83,15 @@ export function messageFormatVersionSelectorForSharedBranches(
 	return brand(MessageFormatVersion.vSharedBranches);
 }
 
+/**
+ * Returns the version that should be used for testing detached root editing.
+ */
+export function messageFormatVersionSelectorForDetachedRootEditing(
+	clientVersion: MinimumVersionForCollab,
+): MessageFormatVersion {
+	return brand(MessageFormatVersion.vDetachedRoots);
+}
+
 export function makeMessageCodec<TChangeset>(
 	changeCodecs: ICodecFamily<TChangeset, ChangeEncodingContext>,
 	dependentChangeFormatVersion: DependentFormatVersion<MessageFormatVersion>,
@@ -130,7 +140,7 @@ export function makeMessageCodecs<TChangeset>(
 			JsonCompatibleReadOnly,
 			MessageEncodingContext
 		>,
-	][] = Array.from(messageFormatVersions).map((version) => {
+	][] = [...messageFormatVersions].map((version) => {
 		switch (version) {
 			case unbrand(MessageFormatVersion.undefined):
 			case unbrand(MessageFormatVersion.v1):
@@ -143,7 +153,9 @@ export function makeMessageCodecs<TChangeset>(
 				];
 			}
 			case unbrand(MessageFormatVersion.v3):
-			case unbrand(MessageFormatVersion.v4): {
+			case unbrand(MessageFormatVersion.v4):
+			case unbrand(MessageFormatVersion.v6):
+			case unbrand(MessageFormatVersion.vDetachedRoots): {
 				const changeCodec = changeCodecs.resolve(
 					dependentChangeFormatVersion.lookup(version),
 				).json;
@@ -152,8 +164,9 @@ export function makeMessageCodecs<TChangeset>(
 					makeV1ToV4CodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
-			case unbrand(MessageFormatVersion.v5):
+			case unbrand(MessageFormatVersion.v5): {
 				return [version, makeDiscontinuedCodecVersion(options, version, "2.74.0")];
+			}
 			case unbrand(MessageFormatVersion.vSharedBranches): {
 				const changeCodec = changeCodecs.resolve(
 					dependentChangeFormatVersion.lookup(version),
@@ -163,8 +176,9 @@ export function makeMessageCodecs<TChangeset>(
 					makeSharedBranchesCodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
-			default:
+			default: {
 				unreachableCase(version);
+			}
 		}
 	});
 	return makeCodecFamily(registry);

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

@@ -47,18 +47,29 @@ export const MessageFormatVersion = strictEnum("MessageFormatVersion", {
 	 * @deprecated Use {@link MessageFormatVersion.vSharedBranches} for testing shared branches.
 	 */
 	v5: 5,
+	/**
+	 * Introduced and made available for writing in 2.80.0
+	 * Adds support for "no change" constraints.
+	 */
+	v6: 6,
 	/**
 	 * Not yet released.
 	 * Only used for testing shared branches.
 	 */
 	vSharedBranches: "shared-branches|v0.1",
+	/**
+	 * Not yet released.
+	 * Only used for testing detached roots.
+	 */
+	vDetachedRoots: "detached-roots|v0.1",
 });
 export type MessageFormatVersion = Values<typeof MessageFormatVersion>;
-
 export const supportedMessageFormatVersions: ReadonlySet<MessageFormatVersion> = new Set([
 	MessageFormatVersion.v3,
 	MessageFormatVersion.v4,
+	MessageFormatVersion.v6,
 	MessageFormatVersion.vSharedBranches,
+	MessageFormatVersion.vDetachedRoots,
 ]);
 export const messageFormatVersions: ReadonlySet<MessageFormatVersion> = new Set(
 	Object.values(MessageFormatVersion),

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

@@ -8,6 +8,7 @@ import { type TSchema, Type } from "@sinclair/typebox";
 
 import { type EncodedRevisionTag, RevisionTagSchema, SessionIdSchema } from "../core/index.js";
 import type { JsonCompatibleReadOnly } from "../util/index.js";
+import { MessageFormatVersion } from "./messageFormat.js";
 
 /**
  * The format of messages that SharedTree sends and receives.
@@ -32,7 +33,13 @@ export interface Message {
 	 * This was not set historically and was added before making any breaking changes to the format.
 	 * For that reason, absence of a 'version' field is synonymous with version 1.
 	 */
-	readonly version?: number;
+	readonly version?:
+		| typeof MessageFormatVersion.v1
+		| typeof MessageFormatVersion.v2
+		| typeof MessageFormatVersion.v3
+		| typeof MessageFormatVersion.v4
+		| typeof MessageFormatVersion.v6
+		| typeof MessageFormatVersion.vDetachedRoots;
 }
 
 // Return type is intentionally derived.
@@ -42,5 +49,14 @@ export const Message = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>
 		revision: RevisionTagSchema,
 		originatorId: SessionIdSchema,
 		changeset: tChange,
-		version: Type.Optional(Type.Number()),
+		version: Type.Optional(
+			Type.Union([
+				Type.Literal(MessageFormatVersion.v1),
+				Type.Literal(MessageFormatVersion.v2),
+				Type.Literal(MessageFormatVersion.v3),
+				Type.Literal(MessageFormatVersion.v4),
+				Type.Literal(MessageFormatVersion.v6),
+				Type.Literal(MessageFormatVersion.vDetachedRoots),
+			]),
+		),
 	});

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

@@ -14,11 +14,11 @@ import type { SequenceId } from "./editManagerFormatCommons.js";
  * Note that this handles cases where indexInBatch is Number.POSITIVE_INFINITY.
  */
 export const sequenceIdComparator = (a: SequenceId, b: SequenceId): number =>
-	a.sequenceNumber !== b.sequenceNumber
-		? a.sequenceNumber - b.sequenceNumber
-		: a.indexInBatch === b.indexInBatch
+	a.sequenceNumber === b.sequenceNumber
+		? a.indexInBatch === b.indexInBatch
 			? 0
-			: (a.indexInBatch ?? 0) - (b.indexInBatch ?? 0);
+			: (a.indexInBatch ?? 0) - (b.indexInBatch ?? 0)
+		: a.sequenceNumber - b.sequenceNumber;
 export const equalSequenceIds = (a: SequenceId, b: SequenceId): boolean =>
 	sequenceIdComparator(a, b) === 0;
 export const minSequenceId = (a: SequenceId, b: SequenceId): SequenceId =>

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

@@ -80,7 +80,9 @@ export interface ClonableSchemaAndPolicy extends SchemaAndPolicy {
 export interface SharedTreeCoreOptionsInternal
 	extends CodecWriteOptions,
 		EditManagerCodecOptions,
-		MessageCodecOptions {}
+		MessageCodecOptions {
+	canMakeDetachedRootEdits: boolean;
+}
 
 /**
  * Generic shared tree, which needs to be configured with indexes, field kinds and other configuration.
@@ -176,6 +178,7 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 			localSessionId,
 			this.mintRevisionTag,
 			(branchId) => this.registerSharedBranch(branchId),
+			options,
 			rebaseLogger,
 		);
 
@@ -264,7 +267,9 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 			this.loadSummarizable(s, services, parse),
 		);
 
-		if (this.detachedRevision !== undefined) {
+		if (this.detachedRevision === undefined) {
+			await Promise.all([loadEditManager, ...loadSummarizables]);
+		} else {
 			// If we are detached but loading from a summary, then we need to update our detached revision to ensure that it is ahead of all detached revisions in the summary.
 			// First, finish loading the edit manager so that we can inspect the sequence numbers of the commits on the trunk.
 			await loadEditManager;
@@ -277,8 +282,6 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 				this.detachedRevision = latestDetachedSequenceNumber;
 			}
 			await Promise.all(loadSummarizables);
-		} else {
-			await Promise.all([loadEditManager, ...loadSummarizables]);
 		}
 	}
 
@@ -467,8 +470,9 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 					);
 					break;
 				}
-				default:
+				default: {
 					unreachableCase(type);
+				}
 			}
 		}
 
@@ -569,8 +573,9 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 				this.submitBranchCreation(message.branchId);
 				break;
 			}
-			default:
+			default: {
 				unreachableCase(type);
+			}
 		}
 	}
 
@@ -599,8 +604,9 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 				this.editManager.removeBranch(message.branchId);
 				break;
 			}
-			default:
+			default: {
 				unreachableCase(type);
+			}
 		}
 	}
 
@@ -624,8 +630,9 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 				this.editManager.addNewBranch(message.branchId);
 				break;
 			}
-			default:
+			default: {
 				unreachableCase(type);
+			}
 		}
 	}