@fluidframework/tree 2.62.0 → 2.63.0-359286

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

@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
+import { unreachableCase } from "@fluidframework/core-utils/internal";
 import {
+	type CodecTree,
+	type DependentFormatVersion,
+	type FormatVersion,
 	type ICodecFamily,
 	type ICodecOptions,
 	type IJsonCodec,
@@ -16,7 +20,7 @@ import type {
 	RevisionTag,
 	SchemaAndPolicy,
 } from "../core/index.js";
-import type { JsonCompatibleReadOnly } from "../util/index.js";
+import { brand, type Brand, type JsonCompatibleReadOnly } from "../util/index.js";
 
 import type { DecodedMessage } from "./messageTypes.js";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
@@ -30,6 +34,7 @@ export interface MessageEncodingContext {
 
 export function makeMessageCodec<TChangeset>(
 	changeCodecs: ICodecFamily<TChangeset, ChangeEncodingContext>,
+	dependentChangeFormatVersion: DependentFormatVersion<MessageFormatVersion>,
 	revisionTagCodec: IJsonCodec<
 		RevisionTag,
 		EncodedRevisionTag,
@@ -37,14 +42,19 @@ export function makeMessageCodec<TChangeset>(
 		ChangeEncodingContext
 	>,
 	options: ICodecOptions,
-	writeVersion: number,
+	writeVersion: MessageFormatVersion = brand(1),
 ): IJsonCodec<
 	DecodedMessage<TChangeset>,
 	JsonCompatibleReadOnly,
 	JsonCompatibleReadOnly,
 	MessageEncodingContext
 > {
-	const family = makeMessageCodecs(changeCodecs, revisionTagCodec, options);
+	const family = makeMessageCodecs(
+		changeCodecs,
+		dependentChangeFormatVersion,
+		revisionTagCodec,
+		options,
+	);
 	return makeVersionDispatchingCodec(family, { ...options, writeVersion });
 }
 
@@ -53,6 +63,7 @@ export function makeMessageCodec<TChangeset>(
  */
 export function makeMessageCodecs<TChangeset>(
 	changeCodecs: ICodecFamily<TChangeset, ChangeEncodingContext>,
+	dependentChangeFormatVersion: DependentFormatVersion<MessageFormatVersion>,
 	revisionTagCodec: IJsonCodec<
 		RevisionTag,
 		EncodedRevisionTag,
@@ -61,28 +72,60 @@ export function makeMessageCodecs<TChangeset>(
 	>,
 	options: ICodecOptions,
 ): ICodecFamily<DecodedMessage<TChangeset>, MessageEncodingContext> {
-	const v1Codec = makeV1ToV4CodecWithVersion(
-		changeCodecs.resolve(1).json,
-		revisionTagCodec,
-		options,
-		1,
-	);
-	return makeCodecFamily([
-		// Back-compat: messages weren't always written with an explicit version field.
-		[undefined, v1Codec],
-		[1, v1Codec],
-		[
-			2,
-			makeV1ToV4CodecWithVersion(changeCodecs.resolve(2).json, revisionTagCodec, options, 2),
-		],
-		[
-			3,
-			makeV1ToV4CodecWithVersion(changeCodecs.resolve(3).json, revisionTagCodec, options, 3),
-		],
-		[
-			4,
-			makeV1ToV4CodecWithVersion(changeCodecs.resolve(4).json, revisionTagCodec, options, 4),
-		],
-		[5, makeV5CodecWithVersion(changeCodecs.resolve(4).json, revisionTagCodec, options, 5)],
-	]);
+	const registry: [
+		FormatVersion,
+		IJsonCodec<
+			DecodedMessage<TChangeset>,
+			JsonCompatibleReadOnly,
+			JsonCompatibleReadOnly,
+			MessageEncodingContext
+		>,
+	][] = Array.from(messageFormatVersions).map((version) => {
+		const changeCodec = changeCodecs.resolve(
+			dependentChangeFormatVersion.lookup(version),
+		).json;
+		switch (version) {
+			case undefined:
+			case 1:
+			case 2:
+			case 3:
+			case 4:
+				return [
+					version,
+					makeV1ToV4CodecWithVersion(changeCodec, revisionTagCodec, options, version ?? 1),
+				];
+			case 5:
+				return [
+					version,
+					makeV5CodecWithVersion(changeCodec, revisionTagCodec, options, version),
+				];
+			default:
+				unreachableCase(version);
+		}
+	});
+	return makeCodecFamily(registry);
+}
+
+export type MessageFormatVersion = Brand<
+	undefined | 1 | 2 | 3 | 4 | 5,
+	"MessageFormatVersion"
+>;
+export const messageFormatVersions: ReadonlySet<MessageFormatVersion> = new Set([
+	brand(undefined),
+	brand(1),
+	brand(2),
+	brand(3),
+	brand(4),
+	brand(5),
+]);
+
+export function getCodecTreeForMessageFormatWithChange(
+	version: MessageFormatVersion,
+	changeFormat: CodecTree,
+): CodecTree {
+	return {
+		name: "Message",
+		version,
+		children: [changeFormat],
+	};
 }

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

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { GraphCommit } from "../core/index.js";
+import type { GraphCommit, RevisionTag } from "../core/index.js";
 
 /**
  * Encapsulates a state machine that can be used by a {@link SharedTreeCore} manage resubmit phases,
@@ -11,25 +11,16 @@ import type { GraphCommit } from "../core/index.js";
  */
 export interface ResubmitMachine<TChange> {
 	/**
-	 * Must be called before calling `enrichCommit` as part of a resubmit phase.
-	 * @param toResubmit - the commits that will be resubmitted (from oldest to newest).
-	 * This must be the most rebased version of these commits (i.e., rebased over all known concurrent edits)
-	 * as opposed to the version which was last submitted.
-	 * `toResubmit` can be safely mutated by the caller after this call returns.
+	 * @param revision - the revision of the commit that should be enriched
+	 * @param getLocalCommitsSince - the local commits on this branch from oldest to newest, starting with the `revision`.
+	 * @returns a version of the commit with updated enrichment, or undefined if this revision does not need to be resubmitted.
+	 * A revision does not need to be resubmitted if it has already been sequenced, which can happen if it was also submitted by another client.
+	 * Two clients can submit the same revision by both merging from the same shared branch.
 	 */
-	prepareForResubmit(toResubmit: readonly GraphCommit<TChange>[]): void;
-
-	/**
-	 * @returns the next commit that should be resubmitted.
-	 *
-	 * Throws when invoked outside of a resubmit phase.
-	 */
-	peekNextCommit(): GraphCommit<TChange>;
-
-	/**
-	 * Is true iff the commit enricher is currently in a resubmit phase.
-	 */
-	readonly isInResubmitPhase: boolean;
+	getEnrichedCommit(
+		revision: RevisionTag,
+		getLocalCommitsSince: () => readonly GraphCommit<TChange>[],
+	): GraphCommit<TChange> | undefined;
 
 	/**
 	 * Must be when a commit is submitted or resubmitted.
@@ -48,7 +39,8 @@ export interface ResubmitMachine<TChange> {
 	 * Must be called after a sequenced commit is applied.
 	 * Note that this may be called multiples times in a row after a number of sequenced commits have been applied
 	 * (as opposed to always being called before the next sequenced commit is applied).
+	 * @param revision - the revision of the sequenced commit.
 	 * @param isLocal - whether the sequenced commit was generated by the local session.
 	 */
-	onSequencedCommitApplied(isLocal: boolean): void;
+	onSequencedCommitApplied(revision: RevisionTag, isLocal: boolean): void;
 }

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

@@ -25,7 +25,7 @@ import type {
 } from "@fluidframework/shared-object-base/internal";
 import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
 
-import type { ICodecOptions, IJsonCodec } from "../codec/index.js";
+import type { DependentFormatVersion, ICodecOptions, IJsonCodec } from "../codec/index.js";
 import {
 	type ChangeFamily,
 	type ChangeFamilyEditor,
@@ -51,10 +51,14 @@ import { BranchCommitEnricher } from "./branchCommitEnricher.js";
 import { type ChangeEnricherReadonlyCheckout, NoOpChangeEnricher } from "./changeEnricher.js";
 import { DefaultResubmitMachine } from "./defaultResubmitMachine.js";
 import { EditManager, minimumPossibleSequenceNumber } from "./editManager.js";
-import { makeEditManagerCodec } from "./editManagerCodecs.js";
+import { makeEditManagerCodec, type EditManagerFormatVersion } from "./editManagerCodecs.js";
 import type { SeqNumber } from "./editManagerFormatCommons.js";
 import { EditManagerSummarizer } from "./editManagerSummarizer.js";
-import { type MessageEncodingContext, makeMessageCodec } from "./messageCodecs.js";
+import {
+	type MessageEncodingContext,
+	type MessageFormatVersion,
+	makeMessageCodec,
+} from "./messageCodecs.js";
 import type { DecodedMessage } from "./messageTypes.js";
 import type { ResubmitMachine } from "./resubmitMachine.js";
 
@@ -62,8 +66,8 @@ import type { ResubmitMachine } from "./resubmitMachine.js";
 const summarizablesTreeKey = "indexes";
 
 export interface ExplicitCoreCodecVersions {
-	editManager: number;
-	message: number;
+	editManager: EditManagerFormatVersion;
+	message: MessageFormatVersion;
 }
 
 export interface ClonableSchemaAndPolicy extends SchemaAndPolicy {
@@ -126,6 +130,8 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 		protected readonly changeFamily: ChangeFamily<TEditor, TChange>,
 		options: ICodecOptions,
 		formatOptions: ExplicitCoreCodecVersions,
+		changeFormatVersionForEditManager: DependentFormatVersion<EditManagerFormatVersion>,
+		changeFormatVersionForMessage: DependentFormatVersion<MessageFormatVersion>,
 		protected readonly idCompressor: IIdCompressor,
 		schema: TreeStoredSchemaRepository,
 		schemaPolicy: SchemaPolicy,
@@ -163,6 +169,7 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 		const revisionTagCodec = new RevisionTagCodec(idCompressor);
 		const editManagerCodec = makeEditManagerCodec(
 			this.editManager.changeFamily.codecs,
+			changeFormatVersionForEditManager,
 			revisionTagCodec,
 			options,
 			formatOptions.editManager,
@@ -183,6 +190,7 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 
 		this.messageCodec = makeMessageCodec(
 			changeFamily.codecs,
+			changeFormatVersionForMessage,
 			new RevisionTagCodec(idCompressor),
 			options,
 			formatOptions.message,
@@ -451,8 +459,8 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 		);
 
 		// Update the resubmit machine for each commit applied.
-		for (const _ of commits) {
-			this.tryGetResubmitMachine(branchId)?.onSequencedCommitApplied(isLocal);
+		for (const commit of commits) {
+			this.tryGetResubmitMachine(branchId)?.onSequencedCommitApplied(commit.revision, isLocal);
 		}
 	}
 
@@ -500,24 +508,24 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 				} = message;
 
 				const resubmitMachine = this.getResubmitMachine(branchId);
-				// If a resubmit phase is not already in progress, then this must be the first commit of a new resubmit phase.
-				if (resubmitMachine.isInResubmitPhase === false) {
+
+				const getLocalCommits = (): GraphCommit<TChange>[] => {
 					const localCommits = this.editManager.getLocalCommits(branchId);
 					const revisionIndex = localCommits.findIndex((c) => c.revision === revision);
 					assert(revisionIndex >= 0, 0xbdb /* revision must exist in local commits */);
-					const toResubmit = localCommits.slice(revisionIndex);
-					resubmitMachine.prepareForResubmit(toResubmit);
-				}
+					return localCommits.slice(revisionIndex);
+				};
+
 				assert(
 					isClonableSchemaPolicy(localOpMetadata),
 					0x95e /* Local metadata must contain schema and policy. */,
 				);
-				assert(
-					resubmitMachine.isInResubmitPhase !== false,
-					0x984 /* Invalid resubmit outside of resubmit phase */,
-				);
-				const enrichedCommit = resubmitMachine.peekNextCommit();
-				this.submitCommit(branchId, enrichedCommit, localOpMetadata, true);
+
+				const enrichedCommit = resubmitMachine.getEnrichedCommit(revision, getLocalCommits);
+				if (enrichedCommit !== undefined) {
+					this.submitCommit(branchId, enrichedCommit, localOpMetadata, true);
+				}
+
 				break;
 			}
 			case "branch": {