@fluidframework/tree 2.91.0 → 2.92.0

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

@@ -4,17 +4,18 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
-import type { TAnySchema } from "@sinclair/typebox";
 
-import { type ICodecOptions, type IJsonCodec, withSchemaValidation } from "../codec/index.js";
+import type { CodecAndSchema, IJsonCodec, Versioned } from "../codec/index.js";
 import type {
 	ChangeEncodingContext,
 	ChangeFamilyCodec,
 	EncodedRevisionTag,
 	RevisionTag,
 } from "../core/index.js";
-import type { JsonCompatibleReadOnly } from "../util/index.js";
-import { JsonCompatibleReadOnlySchema } from "../util/index.js";
+import {
+	type JsonCompatibleReadOnlyObject,
+	JsonCompatibleReadOnlySchema,
+} from "../util/index.js";
 
 import type { MessageEncodingContext } from "./messageCodecs.js";
 import type { MessageFormatVersion } from "./messageFormat.js";
@@ -29,83 +30,67 @@ export function makeV1ToV4CodecWithVersion<TChangeset>(
 		EncodedRevisionTag,
 		ChangeEncodingContext
 	>,
-	options: ICodecOptions,
 	version:
 		| typeof MessageFormatVersion.v1
 		| typeof MessageFormatVersion.v2
 		| typeof MessageFormatVersion.v3
 		| typeof MessageFormatVersion.v4
 		| typeof MessageFormatVersion.v6,
-): IJsonCodec<
-	DecodedMessage<TChangeset>,
-	JsonCompatibleReadOnly,
-	JsonCompatibleReadOnly,
-	MessageEncodingContext
-> {
-	return withSchemaValidation<
-		DecodedMessage<TChangeset>,
-		TAnySchema | typeof JsonCompatibleReadOnlySchema,
-		JsonCompatibleReadOnly,
-		JsonCompatibleReadOnly,
-		MessageEncodingContext
-	>(
-		Message(changeCodec.encodedSchema ?? JsonCompatibleReadOnlySchema),
-		{
-			encode: (decoded: DecodedMessage<TChangeset>, context: MessageEncodingContext) => {
-				assert(decoded.type === "commit", 0xc68 /* Only commit messages are supported */);
-				assert(
-					decoded.branchId === "main",
-					0xc69 /* Only commit messages to main are supported */,
-				);
-				const { commit, sessionId: originatorId } = decoded;
-				const message: Message = {
-					revision: revisionTagCodec.encode(commit.revision, {
-						originatorId,
-						idCompressor: context.idCompressor,
-						revision: undefined,
-					}),
-					originatorId,
-					changeset: changeCodec.encode(commit.change, {
-						originatorId,
-						schema: context.schema,
-						idCompressor: context.idCompressor,
-						revision: commit.revision,
-					}),
-					version,
-				};
-				return message as unknown as JsonCompatibleReadOnly;
-			},
-			decode: (
-				encoded: JsonCompatibleReadOnly,
-				context: MessageEncodingContext,
-			): DecodedMessage<TChangeset> => {
-				const {
-					revision: encodedRevision,
-					originatorId,
-					changeset,
-				} = encoded as unknown as Message;
-
-				const revision = revisionTagCodec.decode(encodedRevision, {
+): CodecAndSchema<DecodedMessage<TChangeset>, MessageEncodingContext> {
+	const schema = Message(changeCodec.encodedSchema ?? JsonCompatibleReadOnlySchema);
+	return {
+		schema,
+		encode: (
+			decoded: DecodedMessage<TChangeset>,
+			context: MessageEncodingContext,
+		): Message & JsonCompatibleReadOnlyObject & Versioned => {
+			assert(decoded.type === "commit", 0xc68 /* Only commit messages are supported */);
+			assert(
+				decoded.branchId === "main",
+				0xc69 /* Only commit messages to main are supported */,
+			);
+			const { commit, sessionId: originatorId } = decoded;
+			return {
+				revision: revisionTagCodec.encode(commit.revision, {
 					originatorId,
+					idCompressor: context.idCompressor,
 					revision: undefined,
+				}),
+				originatorId,
+				changeset: changeCodec.encode(commit.change, {
+					originatorId,
+					schema: context.schema,
 					idCompressor: context.idCompressor,
-				});
+					revision: commit.revision,
+				}),
+				version,
+			};
+		},
+		decode: (
+			encoded: Message & JsonCompatibleReadOnlyObject & Versioned,
+			context: MessageEncodingContext,
+		): DecodedMessage<TChangeset> => {
+			const { revision: encodedRevision, originatorId, changeset } = encoded;
 
-				return {
-					branchId: "main",
-					type: "commit",
-					commit: {
+			const revision = revisionTagCodec.decode(encodedRevision, {
+				originatorId,
+				revision: undefined,
+				idCompressor: context.idCompressor,
+			});
+
+			return {
+				branchId: "main",
+				type: "commit",
+				commit: {
+					revision,
+					change: changeCodec.decode(changeset, {
+						originatorId,
 						revision,
-						change: changeCodec.decode(changeset, {
-							originatorId,
-							revision,
-							idCompressor: context.idCompressor,
-						}),
-					},
-					sessionId: originatorId,
-				};
-			},
+						idCompressor: context.idCompressor,
+					}),
+				},
+				sessionId: originatorId,
+			};
 		},
-		options.jsonValidator,
-	);
+	};
 }

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

@@ -6,14 +6,14 @@
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import { type TAnySchema, Type } from "@sinclair/typebox";
 
-import { type ICodecOptions, type IJsonCodec, withSchemaValidation } from "../codec/index.js";
+import type { CodecAndSchema, IJsonCodec, Versioned } from "../codec/index.js";
 import type {
 	ChangeEncodingContext,
 	ChangeFamilyCodec,
 	EncodedRevisionTag,
 	RevisionTag,
 } from "../core/index.js";
-import type { JsonCompatibleReadOnly } from "../util/index.js";
+import type { JsonCompatibleReadOnlyObject } from "../util/index.js";
 
 import { decodeBranchId, encodeBranchId } from "./branchIdCodec.js";
 import type { MessageEncodingContext } from "./messageCodecs.js";
@@ -29,105 +29,89 @@ export function makeSharedBranchesCodecWithVersion<TChangeset>(
 		EncodedRevisionTag,
 		ChangeEncodingContext
 	>,
-	options: ICodecOptions,
 	version: typeof MessageFormatVersion.vSharedBranches,
-): IJsonCodec<
-	DecodedMessage<TChangeset>,
-	JsonCompatibleReadOnly,
-	JsonCompatibleReadOnly,
-	MessageEncodingContext
-> {
-	return withSchemaValidation<
-		DecodedMessage<TChangeset>,
-		TAnySchema,
-		JsonCompatibleReadOnly,
-		JsonCompatibleReadOnly,
-		MessageEncodingContext
-	>(
-		Message(changeCodec.encodedSchema ?? Type.Any()),
-		{
-			encode: (
-				message: DecodedMessage<TChangeset>,
-				context: MessageEncodingContext,
-			): JsonCompatibleReadOnly => {
-				const type = message.type;
-				switch (type) {
-					case "commit": {
-						const changeContext: ChangeEncodingContext = {
-							originatorId: message.sessionId,
-							schema: context.schema,
-							idCompressor: context.idCompressor,
-							revision: message.commit.revision,
-						};
+): CodecAndSchema<DecodedMessage<TChangeset>, MessageEncodingContext> {
+	const schema: TAnySchema = Message(changeCodec.encodedSchema ?? Type.Any());
 
-						return {
-							revision: revisionTagCodec.encode(message.commit.revision, {
-								originatorId: message.sessionId,
-								idCompressor: context.idCompressor,
-								revision: undefined,
-							}),
-							originatorId: message.sessionId,
-							changeset: changeCodec.encode(message.commit.change, changeContext),
-							branchId: encodeBranchId(context.idCompressor, message.branchId),
-							version,
-						} satisfies Message & JsonCompatibleReadOnly;
-					}
-					case "branch": {
-						return {
+	return {
+		schema,
+		encode: (
+			message: DecodedMessage<TChangeset>,
+			context: MessageEncodingContext,
+		): Message & JsonCompatibleReadOnlyObject & Versioned => {
+			const type = message.type;
+			switch (type) {
+				case "commit": {
+					const changeContext: ChangeEncodingContext = {
+						originatorId: message.sessionId,
+						schema: context.schema,
+						idCompressor: context.idCompressor,
+						revision: message.commit.revision,
+					};
+
+					return {
+						revision: revisionTagCodec.encode(message.commit.revision, {
 							originatorId: message.sessionId,
-							branchId: encodeBranchId(context.idCompressor, message.branchId),
-							version,
-						} satisfies Message & JsonCompatibleReadOnly;
-					}
-					default: {
-						unreachableCase(type);
-					}
+							idCompressor: context.idCompressor,
+							revision: undefined,
+						}),
+						originatorId: message.sessionId,
+						changeset: changeCodec.encode(message.commit.change, changeContext),
+						branchId: encodeBranchId(context.idCompressor, message.branchId),
+						version,
+					};
 				}
-			},
-			decode: (
-				encoded: JsonCompatibleReadOnly,
-				context: MessageEncodingContext,
-			): DecodedMessage<TChangeset> => {
-				const {
-					revision: encodedRevision,
-					originatorId,
-					changeset,
-					branchId: encodedBranchId,
-				} = encoded as unknown as Message;
+				case "branch": {
+					return {
+						originatorId: message.sessionId,
+						branchId: encodeBranchId(context.idCompressor, message.branchId),
+						version,
+					};
+				}
+				default: {
+					unreachableCase(type);
+				}
+			}
+		},
+		decode: (
+			encoded: Message & JsonCompatibleReadOnlyObject & Versioned,
+			context: MessageEncodingContext,
+		): DecodedMessage<TChangeset> => {
+			const {
+				revision: encodedRevision,
+				originatorId,
+				changeset,
+				branchId: encodedBranchId,
+			} = encoded;
 
-				const changeContext = {
-					originatorId,
-					revision: undefined,
-					idCompressor: context.idCompressor,
-				};
+			const changeContext = {
+				originatorId,
+				revision: undefined,
+				idCompressor: context.idCompressor,
+			};
 
-				const branchId = decodeBranchId(context.idCompressor, encodedBranchId, changeContext);
+			const branchId = decodeBranchId(context.idCompressor, encodedBranchId, changeContext);
 
-				if (changeset === undefined) {
-					return { type: "branch", sessionId: originatorId, branchId };
-				}
+			if (changeset === undefined) {
+				return { type: "branch", sessionId: originatorId, branchId };
+			}
 
-				assert(
-					encodedRevision !== undefined,
-					0xc6a /* Commit messages must have a revision */,
-				);
-				const revision = revisionTagCodec.decode(encodedRevision, changeContext);
+			assert(encodedRevision !== undefined, 0xc6a /* Commit messages must have a revision */);
+			const revision = revisionTagCodec.decode(encodedRevision, changeContext);
 
-				return {
-					type: "commit",
-					commit: {
+			return {
+				type: "commit",
+				commit: {
+					revision,
+					change: changeCodec.decode(changeset, {
+						originatorId,
 						revision,
-						change: changeCodec.decode(changeset, {
-							originatorId,
-							revision,
-							idCompressor: context.idCompressor,
-						}),
-					},
-					branchId,
-					sessionId: originatorId,
-				};
-			},
+						idCompressor: context.idCompressor,
+					}),
+				},
+				branchId,
+				sessionId: originatorId,
+			};
 		},
-		options.jsonValidator,
-	);
+	};
 }

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

@@ -3,26 +3,20 @@
  * Licensed under the MIT License.
  */
 
-import { unreachableCase } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
-import {
-	getConfigForMinVersionForCollab,
-	lowestMinVersionForCollab,
-} from "@fluidframework/runtime-utils/internal";
+import { lowestMinVersionForCollab } from "@fluidframework/runtime-utils/internal";
 
 import {
+	ClientVersionDispatchingCodecBuilder,
 	type CodecTree,
-	type CodecWriteOptions,
+	type CodecVersion,
 	type DependentFormatVersion,
 	FluidClientVersion,
-	type FormatVersion,
 	type ICodecFamily,
 	type ICodecOptions,
 	type IJsonCodec,
-	makeCodecFamily,
-	makeDiscontinuedCodecVersion,
-	makeVersionDispatchingCodec,
+	makeDiscontinuedCodecAndSchema,
 } from "../codec/index.js";
 import type {
 	ChangeEncodingContext,
@@ -30,11 +24,10 @@ import type {
 	RevisionTag,
 	SchemaAndPolicy,
 } from "../core/index.js";
-import { brand, unbrand, type JsonCompatibleReadOnly } from "../util/index.js";
 
 import { makeV1ToV4CodecWithVersion } from "./messageCodecV1ToV4.js";
 import { makeSharedBranchesCodecWithVersion } from "./messageCodecVSharedBranches.js";
-import { MessageFormatVersion, messageFormatVersions } from "./messageFormat.js";
+import { MessageFormatVersion } from "./messageFormat.js";
 import type { DecodedMessage } from "./messageTypes.js";
 
 export interface MessageEncodingContext {
@@ -43,140 +36,109 @@ export interface MessageEncodingContext {
 }
 
 /**
- * Convert a MinimumVersionForCollab to a MessageFormatVersion.
- * @param clientVersion - The MinimumVersionForCollab to convert.
- * @returns The MessageFormatVersion that corresponds to the provided MinimumVersionForCollab.
+ * Codec name used to identify the message codec, see {@link makeMessageCodecBuilder}.
  */
-export function clientVersionToMessageFormatVersion(
-	clientVersion: MinimumVersionForCollab,
-	writeVersionOverride?: MessageFormatVersion,
-): MessageFormatVersion {
-	const compatibleVersion: MessageFormatVersion = brand(
-		getConfigForMinVersionForCollab(clientVersion, {
-			[lowestMinVersionForCollab]: MessageFormatVersion.v3,
-			[FluidClientVersion.v2_43]: MessageFormatVersion.v4,
-			[FluidClientVersion.v2_80]: MessageFormatVersion.v6,
-		}),
-	);
-	return writeVersionOverride ?? compatibleVersion;
-}
-
-export interface MessageCodecOptions {
-	readonly messageFormatSelector?: (
-		minVersionForCollab: MinimumVersionForCollab,
-	) => MessageFormatVersion;
-}
-
-function messageFormatVersionFromOptions(
-	options: MessageCodecOptions & CodecWriteOptions,
-): MessageFormatVersion {
-	const selector = options.messageFormatSelector ?? clientVersionToMessageFormatVersion;
-	return selector(options.minVersionForCollab);
-}
+export const messageCodecName = "Message";
 
 /**
- * Returns the version that should be used for testing shared branches.
+ * Options for constructing a message codec, see {@link makeMessageCodecBuilder}.
  */
-export function messageFormatVersionSelectorForSharedBranches(
-	clientVersion: MinimumVersionForCollab,
-): MessageFormatVersion {
-	return brand(MessageFormatVersion.vSharedBranches);
-}
-
-export function makeMessageCodec<TChangeset>(
-	changeCodecs: ICodecFamily<TChangeset, ChangeEncodingContext>,
-	dependentChangeFormatVersion: DependentFormatVersion<MessageFormatVersion>,
+interface MessageCodecBuilderOptions<TChangeset> extends ICodecOptions {
+	/** Codecs for encoding changesets. */
+	changeCodecs: ICodecFamily<TChangeset, ChangeEncodingContext>;
+	/** Maps each MessageFormatVersion to the corresponding changeset format version. */
+	dependentChangeFormatVersion: DependentFormatVersion<MessageFormatVersion>;
+	/** Codec for encoding revision tags within changesets. */
 	revisionTagCodec: IJsonCodec<
 		RevisionTag,
 		EncodedRevisionTag,
 		EncodedRevisionTag,
 		ChangeEncodingContext
-	>,
-	options: MessageCodecOptions & CodecWriteOptions,
-): IJsonCodec<
-	DecodedMessage<TChangeset>,
-	JsonCompatibleReadOnly,
-	JsonCompatibleReadOnly,
-	MessageEncodingContext
-> {
-	const family = makeMessageCodecs(
-		changeCodecs,
-		dependentChangeFormatVersion,
-		revisionTagCodec,
-		options,
-	);
-	const writeVersion = messageFormatVersionFromOptions(options);
-	return makeVersionDispatchingCodec(family, { ...options, writeVersion });
+	>;
 }
 
 /**
- * @privateRemarks Exported for testing.
+ * Creates a {@link ClientVersionDispatchingCodecBuilder} for encoding/decoding messages.
  */
-export function makeMessageCodecs<TChangeset>(
-	changeCodecs: ICodecFamily<TChangeset, ChangeEncodingContext>,
-	dependentChangeFormatVersion: DependentFormatVersion<MessageFormatVersion>,
-	revisionTagCodec: IJsonCodec<
-		RevisionTag,
-		EncodedRevisionTag,
-		EncodedRevisionTag,
-		ChangeEncodingContext
-	>,
-	options: ICodecOptions,
-): ICodecFamily<DecodedMessage<TChangeset>, MessageEncodingContext> {
-	const registry: [
-		FormatVersion,
-		IJsonCodec<
-			DecodedMessage<TChangeset>,
-			JsonCompatibleReadOnly,
-			JsonCompatibleReadOnly,
-			MessageEncodingContext
-		>,
-	][] = [...messageFormatVersions].map((version) => {
-		switch (version) {
-			case unbrand(MessageFormatVersion.undefined):
-			case unbrand(MessageFormatVersion.v1):
-			case unbrand(MessageFormatVersion.v2): {
-				const versionOrUndefined =
-					version === unbrand(MessageFormatVersion.undefined) ? undefined : version;
-				return [
-					versionOrUndefined,
-					makeDiscontinuedCodecVersion(options, versionOrUndefined, "2.73.0"),
-				];
-			}
-			case unbrand(MessageFormatVersion.v3):
-			case unbrand(MessageFormatVersion.v4):
-			case unbrand(MessageFormatVersion.v6): {
-				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
-				return [
-					version,
-					makeV1ToV4CodecWithVersion(changeCodec, revisionTagCodec, options, version),
-				];
-			}
-			case unbrand(MessageFormatVersion.v5): {
-				return [version, makeDiscontinuedCodecVersion(options, version, "2.74.0")];
-			}
-			case unbrand(MessageFormatVersion.vSharedBranches): {
-				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
-				return [
-					version,
-					makeSharedBranchesCodecWithVersion(changeCodec, revisionTagCodec, options, version),
-				];
-			}
-			default: {
-				unreachableCase(version);
-			}
-		}
-	});
-	return makeCodecFamily(registry);
+export function makeMessageCodecBuilder<TChangeset>(): ClientVersionDispatchingCodecBuilder<
+	MessageCodecBuilderOptions<TChangeset>,
+	DecodedMessage<TChangeset>,
+	MessageEncodingContext,
+	MessageFormatVersion | undefined,
+	typeof messageCodecName
+> {
+	// See MessageFormatVersion and its members for documentation on what changed in each version.
+	const versions: CodecVersion<
+		DecodedMessage<TChangeset>,
+		MessageEncodingContext,
+		MessageFormatVersion | undefined,
+		MessageCodecBuilderOptions<TChangeset>
+	>[] = [
+		// The "undefined" wire format (no version field) is discontinued.
+		makeDiscontinuedCodecAndSchema(undefined, "2.73.0"),
+		makeDiscontinuedCodecAndSchema(MessageFormatVersion.v1, "2.73.0"),
+		makeDiscontinuedCodecAndSchema(MessageFormatVersion.v2, "2.73.0"),
+		{
+			minVersionForCollab: lowestMinVersionForCollab,
+			formatVersion: MessageFormatVersion.v3,
+			codec: (options: MessageCodecBuilderOptions<TChangeset>) =>
+				makeV1ToV4CodecWithVersion(
+					options.changeCodecs.resolve(
+						options.dependentChangeFormatVersion.lookup(MessageFormatVersion.v3),
+					),
+					options.revisionTagCodec,
+					MessageFormatVersion.v3,
+				),
+		},
+		{
+			minVersionForCollab: FluidClientVersion.v2_43,
+			formatVersion: MessageFormatVersion.v4,
+			codec: (options: MessageCodecBuilderOptions<TChangeset>) =>
+				makeV1ToV4CodecWithVersion(
+					options.changeCodecs.resolve(
+						options.dependentChangeFormatVersion.lookup(MessageFormatVersion.v4),
+					),
+					options.revisionTagCodec,
+					MessageFormatVersion.v4,
+				),
+		},
+		makeDiscontinuedCodecAndSchema(MessageFormatVersion.v5, "2.74.0"),
+		{
+			minVersionForCollab: FluidClientVersion.v2_80,
+			formatVersion: MessageFormatVersion.v6,
+			codec: (options: MessageCodecBuilderOptions<TChangeset>) =>
+				makeV1ToV4CodecWithVersion(
+					options.changeCodecs.resolve(
+						options.dependentChangeFormatVersion.lookup(MessageFormatVersion.v6),
+					),
+					options.revisionTagCodec,
+					MessageFormatVersion.v6,
+				),
+		},
+		{
+			minVersionForCollab: undefined,
+			formatVersion: MessageFormatVersion.vSharedBranches,
+			codec: (options: MessageCodecBuilderOptions<TChangeset>) =>
+				makeSharedBranchesCodecWithVersion(
+					options.changeCodecs.resolve(
+						options.dependentChangeFormatVersion.lookup(MessageFormatVersion.vSharedBranches),
+					),
+					options.revisionTagCodec,
+					MessageFormatVersion.vSharedBranches,
+				),
+		},
+	];
+
+	return ClientVersionDispatchingCodecBuilder.build(messageCodecName, versions);
 }
 
 export function getCodecTreeForMessageFormatWithChange(
 	clientVersion: MinimumVersionForCollab,
 	changeFormat: CodecTree,
 ): CodecTree {
+	const builder = makeMessageCodecBuilder();
 	return {
-		name: "Message",
-		version: clientVersionToMessageFormatVersion(clientVersion),
+		...builder.getCodecTree(clientVersion),
 		children: [changeFormat],
 	};
 }

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

@@ -65,6 +65,3 @@ export const supportedMessageFormatVersions: ReadonlySet<MessageFormatVersion> =
 	MessageFormatVersion.v6,
 	MessageFormatVersion.vSharedBranches,
 ]);
-export const messageFormatVersions: ReadonlySet<MessageFormatVersion> = new Set(
-	Object.values(MessageFormatVersion),
-);