Make tree's "currentVersion" actually current. (#26033)

## Description

"currentVersion" Inside of shared tree is currently unused except for
tests.

It was set to 2.0.0, and this makes it actually stary current.

As this is only used in tests, all the snapshot tests with update simply
reflect a change to how their tests are configured, ensuring they test
for the latest version and can detect changes in it.

Author: CraigMacomber

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

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { cleanedPackageVersion as runtimeUtilsCleanedPackageVersion } from "@fluidframework/runtime-utils/internal";
 import type { ErasedType } from "@fluidframework/core-interfaces/internal";
 import { IsoBuffer, bufferToString } from "@fluid-internal/client-utils";
 import { assert, fail } from "@fluidframework/core-utils/internal";
@@ -550,15 +551,22 @@ export const FluidClientVersion = {
 } as const satisfies Record<string, MinimumVersionForCollab>;
 
 /**
- * An up to date version which includes all the important stable features.
+ * An up to date version which includes all stable features.
  * @remarks
- * Use for cases when data is not persisted and thus would only ever be read by the current version of the framework.
+ * Use for cases when data is not persisted and thus would only ever be read by the the same version of the code which read this value.
+ *
+ * The pkgVersion from this package (tree) can not be used here as it is not guaranteed to be a valid MinimumVersionForCollab
+ * and would also unexpectedly disable features in prereleases and on CI if it didn't fail validation.
+ * See {@link @fluidframework/runtime-utils/internal#cleanedPackageVersion} for more details on why cleanedPackageVersion is preferred over pkgVersion.
  *
  * @privateRemarks
- * Update as needed.
- * TODO: Consider using packageVersion.ts to keep this current.
+ * It is safe to use CleanedPackageVersion from runtime-utils here since features are enabled in minor versions,
+ * and this package (tree) depends on runtime-utils with a `~` semver range
+ * ensuring that the version of runtime-utils this was imported from will match the version of this (tree) package at least up to the minor version.
+ * Reusing this from runtime-utils avoids duplicating the cleanup logic here as well as the cost or recomputing it.
+ * If in the future for some reason this becomes not okay, runtime-utils could instead export a function that performs that cleanup logic which could be reused here.
  */
-export const currentVersion: MinimumVersionForCollab = FluidClientVersion.v2_0;
+export const currentVersion: MinimumVersionForCollab = runtimeUtilsCleanedPackageVersion;
 
 export interface CodecTree {
 	readonly name: string;

packages/dds/tree/src/test/feature-libraries/forest-summary/forestSummarizerCodec.spec.ts

@@ -10,7 +10,11 @@ import {
 	validateUsageError,
 } from "@fluidframework/test-runtime-utils/internal";
 
-import { currentVersion, type CodecWriteOptions } from "../../../codec/index.js";
+import {
+	currentVersion,
+	FluidClientVersion,
+	type CodecWriteOptions,
+} from "../../../codec/index.js";
 import { rootFieldKey } from "../../../core/index.js";
 import { FormatValidatorBasic } from "../../../external-utilities/index.js";
 import {
@@ -39,18 +43,26 @@ import { brand } from "../../../util/index.js";
 import { EmptyObject } from "../../cursorTestSuite.js";
 import { testIdCompressor } from "../../utils.js";
 
-const codecOptions: CodecWriteOptions = {
+const codecOptionsOld: CodecWriteOptions = {
+	jsonValidator: FormatValidatorBasic,
+	minVersionForCollab: FluidClientVersion.v2_0,
+};
+
+const codecOptionsCurrent: CodecWriteOptions = {
 	jsonValidator: FormatValidatorBasic,
 	minVersionForCollab: currentVersion,
 };
-const fieldBatchCodec = makeFieldBatchCodec(codecOptions);
+
+const fieldBatchCodecOld = makeFieldBatchCodec(codecOptionsOld);
+const fieldBatchCodecCurrent = makeFieldBatchCodec(codecOptionsCurrent);
 const context = {
 	encodeType: TreeCompressionStrategy.Uncompressed,
 	originatorId: testIdCompressor.localSessionId,
 	idCompressor: testIdCompressor,
 };
 
-const codec = makeForestSummarizerCodec(codecOptions, fieldBatchCodec);
+const codecOld = makeForestSummarizerCodec(codecOptionsOld, fieldBatchCodecOld);
+const codecCurrent = makeForestSummarizerCodec(codecOptionsCurrent, fieldBatchCodecCurrent);
 
 const testFieldChunks: TreeChunk[] = chunkField(
 	cursorForJsonableTreeField([{ type: brand(EmptyObject.identifier) }]),
@@ -66,14 +78,14 @@ const malformedData: [string, unknown][] = [
 	],
 	["incorrect data type", ["incorrect data type"]],
 ];
-const validData: [string, FieldSet, FormatV1 | undefined][] = [
+const validDataOld: [string, FieldSet, FormatV1 | undefined][] = [
 	[
 		"no entry",
 		new Map(),
 		{
 			version: brand(ForestFormatVersion.v1),
 			keys: [],
-			fields: fieldBatchCodec.encode([], context),
+			fields: fieldBatchCodecOld.encode([], context),
 		},
 	],
 	[
@@ -82,7 +94,36 @@ const validData: [string, FieldSet, FormatV1 | undefined][] = [
 		{
 			version: brand(ForestFormatVersion.v1),
 			keys: [rootFieldKey],
-			fields: fieldBatchCodec.encode([testFieldChunk.cursor()], context),
+			fields: fieldBatchCodecOld.encode([testFieldChunk.cursor()], context),
+		},
+	],
+	[
+		"multiple entries",
+		new Map([
+			[rootFieldKey, testFieldChunk.cursor()],
+			[brand("X"), testFieldChunk.cursor()],
+		]),
+		undefined,
+	],
+];
+
+const validDataCurrent: [string, FieldSet, FormatV1 | undefined][] = [
+	[
+		"no entry",
+		new Map(),
+		{
+			version: brand(ForestFormatVersion.v2),
+			keys: [],
+			fields: fieldBatchCodecCurrent.encode([], context),
+		},
+	],
+	[
+		"single entry",
+		new Map([[rootFieldKey, testFieldChunk.cursor()]]),
+		{
+			version: brand(ForestFormatVersion.v2),
+			keys: [rootFieldKey],
+			fields: fieldBatchCodecCurrent.encode([testFieldChunk.cursor()], context),
 		},
 	],
 	[
@@ -96,15 +137,29 @@ const validData: [string, FieldSet, FormatV1 | undefined][] = [
 ];
 
 describe("ForestSummarizerCodec", () => {
-	describe("encodes and decodes valid data.", () => {
-		for (const [name, data, expected] of validData) {
+	describe("encodes and decodes valid old data.", () => {
+		for (const [name, data, expected] of validDataOld) {
+			it(name, () => {
+				const encodedData = codecOld.encode(data, context);
+				if (expected !== undefined) {
+					assert.deepEqual(encodedData, expected);
+				}
+
+				const decodedData = codecOld.decode(encodedData, context);
+				assert.deepEqual(decodedData, data);
+			});
+		}
+	});
+
+	describe("encodes and decodes valid current data.", () => {
+		for (const [name, data, expected] of validDataCurrent) {
 			it(name, () => {
-				const encodedData = codec.encode(data, context);
+				const encodedData = codecCurrent.encode(data, context);
 				if (expected !== undefined) {
 					assert.deepEqual(encodedData, expected);
 				}
 
-				const decodedData = codec.decode(encodedData, context);
+				const decodedData = codecCurrent.decode(encodedData, context);
 				assert.deepEqual(decodedData, data);
 			});
 		}
@@ -113,7 +168,7 @@ describe("ForestSummarizerCodec", () => {
 	describe("throws on receiving malformed data during encode.", () => {
 		for (const [name, data] of malformedData) {
 			it(name, () => {
-				assert.throws(() => codec.encode(data as FieldSet, context), "malformed data");
+				assert.throws(() => codecCurrent.encode(data as FieldSet, context), "malformed data");
 			});
 		}
 	});
@@ -122,7 +177,7 @@ describe("ForestSummarizerCodec", () => {
 		it("invalid version", () => {
 			assert.throws(
 				() =>
-					codec.decode(
+					codecCurrent.decode(
 						{
 							version: 2.5 as ForestFormatVersion,
 							fields: {
@@ -142,7 +197,7 @@ describe("ForestSummarizerCodec", () => {
 		it("invalid nested version", () => {
 			assert.throws(
 				() =>
-					codec.decode(
+					codecCurrent.decode(
 						{
 							version: brand(ForestFormatVersion.v1),
 							fields: {
@@ -162,7 +217,7 @@ describe("ForestSummarizerCodec", () => {
 		it("missing fields", () => {
 			assert.throws(
 				() =>
-					codec.decode(
+					codecCurrent.decode(
 						{
 							version: brand<ForestFormatVersion>(ForestFormatVersion.v1),
 							keys: [],
@@ -176,7 +231,7 @@ describe("ForestSummarizerCodec", () => {
 		it("extra field", () => {
 			assert.throws(
 				() =>
-					codec.decode(
+					codecCurrent.decode(
 						{
 							version: brand<ForestFormatVersion>(ForestFormatVersion.v1),
 							fields: { version: brand<FieldBatchFormatVersion>(FieldBatchFormatVersion.v1) },

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/allTheFields-full.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/allTheFields-minimal.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/empty.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/false boolean.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/handle.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/hasAllMetadata.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/hasAllMetadataRootField.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {

packages/dds/tree/src/test/snapshots/output/chunked-forest-schema-compressed/V1/hasAmbiguousField.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "identifiers": [],
   "shapes": [
     {