Merge branch 'main' into ConfigMap

Author: CraigMacomber

fluidBuild.config.cjs

@@ -344,8 +344,14 @@ module.exports = {
 				"^packages/test/test-utils/package.json",
 				// TODO: AB#7630 uses lint only ts projects for coverage which don't have representative tsc scripts
 				"^packages/tools/fluid-runner/package.json",
+
+				// Server packages need to be cleaned up; excluding as a workaround
+				"^server/routerlicious/packages/.*/package.json",
+			],
+			"fluid-build-tasks-tsc": [
+				// Server packages need to be cleaned up; excluding as a workaround
+				"^server/routerlicious/packages/.*/package.json",
 			],
-			"fluid-build-tasks-tsc": [],
 			"html-copyright-file-header": [
 				// Tests generate HTML "snapshot" artifacts
 				"tools/api-markdown-documenter/src/test/snapshots/.*",

packages/dds/tree/api-report/tree.alpha.api.md

@@ -1021,18 +1021,6 @@ export interface SharedTreeFormatOptions {
     treeEncodeType: TreeCompressionStrategy;
 }
 
-// @alpha
-export const SharedTreeFormatVersion: {
-    readonly v1: 1;
-    readonly v2: 2;
-    readonly v3: 3;
-    readonly v5: 5;
-    readonly vSharedBranches: 100;
-};
-
-// @alpha
-export type SharedTreeFormatVersion = typeof SharedTreeFormatVersion;
-
 // @alpha @input
 export interface SharedTreeOptions extends Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions>, SharedTreeOptionsBeta {
     readonly enableSharedBranches?: boolean;

packages/dds/tree/src/codec/index.ts

@@ -39,4 +39,5 @@ export {
 	makeVersionedCodec,
 	makeVersionedValidatedCodec,
 	makeVersionDispatchingCodec,
+	makeDiscontinuedCodecVersion,
 } from "./versioned/index.js";

packages/dds/tree/src/codec/versioned/codec.ts

@@ -5,7 +5,8 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
-import type { TSchema } from "@sinclair/typebox";
+import type { SemanticVersion } from "@fluidframework/runtime-utils/internal";
+import { Type, type TSchema } from "@sinclair/typebox";
 
 import type { JsonCompatibleReadOnly } from "../../util/index.js";
 import {
@@ -66,7 +67,7 @@ export function makeVersionedValidatedCodec<
 	TContext = void,
 >(
 	options: ICodecOptions,
-	supportedVersions: Set<number>,
+	supportedVersions: Set<FormatVersion>,
 	schema: EncodedSchema,
 	codec: IJsonCodec<TDecoded, TEncoded, TValidate, TContext>,
 ): IJsonCodec<TDecoded, TEncoded, TValidate, TContext> {
@@ -77,6 +78,43 @@ export function makeVersionedValidatedCodec<
 	);
 }
 
+/**
+ * Creates a codec which always throws a UsageError when encoding or decoding, indicating that the format version is discontinued.
+ */
+export function makeDiscontinuedCodecVersion<
+	TDecoded,
+	TEncoded extends Versioned = JsonCompatibleReadOnly & Versioned,
+	TContext = unknown,
+>(
+	options: ICodecOptions,
+	discontinuedVersion: FormatVersion,
+	discontinuedSince: SemanticVersion,
+): IJsonCodec<TDecoded, TEncoded, TEncoded, TContext> {
+	const schema = Type.Object(
+		{
+			version:
+				discontinuedVersion === undefined
+					? Type.Undefined()
+					: Type.Literal(discontinuedVersion),
+		},
+		// Using `additionalProperties: true` allows this schema to be used when loading data encoded by older versions even though they contain additional properties.
+		{ additionalProperties: true },
+	);
+	const codec: IJsonCodec<TDecoded, TEncoded, TEncoded, TContext> = {
+		encode: (_: TDecoded): TEncoded => {
+			throw new UsageError(
+				`Cannot encode data to format ${discontinuedVersion}. The codec was discontinued in FF version ${discontinuedSince}.`,
+			);
+		},
+		decode: (data: TEncoded): TDecoded => {
+			throw new UsageError(
+				`Cannot decode data to format ${data.version}. The codec was discontinued in FF version ${discontinuedSince}.`,
+			);
+		},
+	};
+	return makeVersionedValidatedCodec(options, new Set([discontinuedVersion]), schema, codec);
+}
+
 /**
  * Creates a codec which dispatches to the appropriate member of a codec family based on the version of
  * data it encounters.

packages/dds/tree/src/codec/versioned/index.ts

@@ -8,4 +8,5 @@ export {
 	makeVersionedCodec,
 	makeVersionedValidatedCodec,
 	makeVersionDispatchingCodec,
+	makeDiscontinuedCodecVersion,
 } from "./codec.js";

packages/dds/tree/src/feature-libraries/default-schema/defaultFieldKinds.ts

@@ -193,26 +193,6 @@ export const fieldKindConfigurations: ReadonlyMap<
 	ModularChangeFormatVersion,
 	FieldKindConfiguration
 > = new Map([
-	[
-		brand(1),
-		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
-			[required.identifier, { kind: required, formatVersion: 1 }],
-			[optional.identifier, { kind: optional, formatVersion: 1 }],
-			[sequence.identifier, { kind: sequence, formatVersion: 1 }],
-			[forbidden.identifier, { kind: forbidden, formatVersion: 1 }],
-			[identifier.identifier, { kind: identifier, formatVersion: 1 }],
-		]),
-	],
-	[
-		brand(2),
-		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
-			[required.identifier, { kind: required, formatVersion: 2 }],
-			[optional.identifier, { kind: optional, formatVersion: 2 }],
-			[sequence.identifier, { kind: sequence, formatVersion: 1 }],
-			[forbidden.identifier, { kind: forbidden, formatVersion: 1 }],
-			[identifier.identifier, { kind: identifier, formatVersion: 1 }],
-		]),
-	],
 	[
 		brand(3),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
@@ -235,7 +215,7 @@ export const fieldKindConfigurations: ReadonlyMap<
 	],
 ]);
 
-export type ModularChangeFormatVersion = Brand<1 | 2 | 3 | 4, "ModularChangeFormatVersion">;
+export type ModularChangeFormatVersion = Brand<3 | 4, "ModularChangeFormatVersion">;
 export function getCodecTreeForModularChangeFormat(
 	version: ModularChangeFormatVersion,
 ): CodecTree {

packages/dds/tree/src/feature-libraries/optional-field/optionalFieldCodecV1.ts

@@ -12,7 +12,6 @@ import type {
 import type { FieldChangeEncodingContext } from "../modular-schema/index.js";
 
 import type { OptionalChangeset } from "./optionalFieldChangeTypes.js";
-import { makeOptionalFieldCodec as makeV1Codec } from "./optionalFieldCodecV1.js";
 import { makeOptionalFieldCodec as makeV2Codec } from "./optionalFieldCodecV2.js";
 
 export const makeOptionalFieldCodecFamily = (
@@ -23,7 +22,4 @@ export const makeOptionalFieldCodecFamily = (
 		ChangeEncodingContext
 	>,
 ): ICodecFamily<OptionalChangeset, FieldChangeEncodingContext> =>
-	makeCodecFamily([
-		[1, makeV1Codec(revisionTagCodec)],
-		[2, makeV2Codec(revisionTagCodec)],
-	]);
+	makeCodecFamily([[2, makeV2Codec(revisionTagCodec)]]);