@fluidframework/id-compressor 3.1.0 → 3.3.0

package/src/idCompressor.ts

@@ -42,6 +42,7 @@ import {
 	lastFinalizedLocal,
 } from "./sessions.js";
 import type {
+	ShardToken,
 	IIdCompressor,
 	IIdCompressorCore,
 	IdCreationRange,
@@ -52,7 +53,9 @@ import type {
 	SessionId,
 	SessionSpaceCompressedId,
 	StableId,
+	ShardSynchronizationToken,
 } from "./types/index.js";
+import { SerializationVersion } from "./types/index.js";
 import {
 	createSessionId,
 	genCountFromLocalId,
@@ -63,12 +66,6 @@ import {
 	subtractNumericUuids,
 } from "./utilities.js";
 
-/**
- * The version of IdCompressor that is currently persisted.
- * This should not be changed without careful consideration to compatibility.
- */
-const currentWrittenVersion = 2;
-
 function rangeFinalizationError(expectedStart: number, actualStart: number): LoggingError {
 	return new LoggingError("Ranges finalized out of order", {
 		expectedStart,
@@ -76,6 +73,8 @@ function rangeFinalizationError(expectedStart: number, actualStart: number): Log
 	});
 }
 
+const MAX_STRIDE_LENGTH = 1000000;
+
 /**
  * See {@link IIdCompressor} and {@link IIdCompressorCore}
  */
@@ -93,13 +92,51 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	// The number of IDs generated by the local session
 	private localGenCount = 0;
 
+	/**
+	 * The sharding state of this compressor, if it has been sharded or is a shard itself.
+	 * When defined, this compressor operates in "sharding mode" where:
+	 * - IDs are generated using stride-based allocation (no eager finals)
+	 * - The normalizer backfills all IDs in each stride cycle
+	 * - Normal operation resumes when all children are disposed
+	 */
+	private shardingState?:
+		| {
+				/**
+				 * Current stride - used when this compressor has active children.
+				 * Changes each time shard() is called.
+				 */
+				currentStride: number;
+
+				/**
+				 * Original stride - the stride this compressor was created with.
+				 * Used when this compressor has no children (is a leaf).
+				 * IMMUTABLE after creation.
+				 */
+				originalStride: number;
+
+				/**
+				 * Set of unique child shard IDs (UUIDs) currently active.
+				 * Each child is assigned a UUID when created via shard().
+				 * Safe across serialization/deserialization cycles.
+				 */
+				activeChildIds: Set<SessionId>;
+
+				/**
+				 * This compressor's unique shard ID within its parent (if it's a child).
+				 * Undefined for root compressors.
+				 * Assigned by parent when creating this shard.
+				 */
+				shardId?: SessionId;
+		  }
+		| undefined;
+
 	// #endregion
 
 	// #region Final state
 
 	/**
 	 * The gen count to be annotated on the range returned by the next call to `takeNextCreationRange`.
-	 * This is advanced to `generatedIdCount` + 1 each time it is called.
+	 * This is advanced to `localGenCount` + 1 each time it is called.
 	 * On the other hand, when `resetUnfinalizedCreationRange` is called,
 	 * this is moved back to the start of the unfinalized range, to ensure those IDs are included in the next range.
 	 */
@@ -131,6 +168,12 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	public constructor(
 		localSessionIdOrDeserialized: SessionId | Sessions,
 		private readonly logger: TelemetryLoggerExt | undefined,
+		/**
+		 * The version this compressor will write out.
+		 * This applies to both `serialize` and creation range functions.
+		 * This number also determines what features are available (e.g. sharding support starts at V3).
+		 */
+		private readonly writeVersion: SerializationVersion,
 	) {
 		if (typeof localSessionIdOrDeserialized === "string") {
 			this.localSessionId = localSessionIdOrDeserialized;
@@ -164,30 +207,42 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			return lastFinalizedFinal(
 				this.ongoingGhostSession.cluster,
 			) as unknown as SessionSpaceCompressedId;
-		} else {
-			this.localGenCount++;
-			const lastCluster = this.localSession.getLastCluster();
-			if (lastCluster === undefined) {
-				this.telemetryLocalIdCount++;
-				return this.generateNextLocalId();
-			}
+		}
 
-			// If there exists a cluster of final IDs already claimed by the local session that still has room in it,
-			// it is known prior to range sequencing what a local ID's corresponding final ID will be.
-			// In this case, it is safe to return the final ID immediately. This is guaranteed to be safe because
-			// any op that the local session sends that contains one of those final IDs are guaranteed to arrive to
-			// collaborators *after* the one containing the creation range.
-			const clusterOffset = this.localGenCount - genCountFromLocalId(lastCluster.baseLocalId);
-			if (lastCluster.capacity > clusterOffset) {
-				this.telemetryEagerFinalIdCount++;
-				// Space in the cluster: eager final
-				return ((lastCluster.baseFinalId as number) +
-					clusterOffset) as SessionSpaceCompressedId;
-			}
-			// No space in the cluster, return next local
+		// In sharding mode, always generate local IDs with stride-based allocation.
+		// Eager finals are disabled because shards backfill IDs not in their stride cycle.
+		// If another shard generated them as eager finals, ingesting IDs from another shard
+		// would fail depending on timing.
+		if (this.shardingState !== undefined) {
+			this.telemetryLocalIdCount++;
+			const { currentStride } = this.shardingState;
+			this.normalizer.addLocalRange(this.localGenCount + 1, currentStride);
+			this.localGenCount += currentStride;
+			return localIdFromGenCount(this.localGenCount);
+		}
+
+		// Normal ID generation
+		this.localGenCount++;
+		const lastCluster = this.localSession.getLastCluster();
+		if (lastCluster === undefined) {
 			this.telemetryLocalIdCount++;
 			return this.generateNextLocalId();
 		}
+
+		// If there exists a cluster of final IDs already claimed by the local session that still has room in it,
+		// it is known prior to range sequencing what a local ID's corresponding final ID will be.
+		// In this case, it is safe to return the final ID immediately. This is guaranteed to be safe because
+		// any op that the local session sends that contains one of those final IDs are guaranteed to arrive to
+		// collaborators *after* the one containing the creation range.
+		const clusterOffset = this.localGenCount - genCountFromLocalId(lastCluster.baseLocalId);
+		if (lastCluster.capacity > clusterOffset) {
+			this.telemetryEagerFinalIdCount++;
+			// Space in the cluster: eager final
+			return ((lastCluster.baseFinalId as number) + clusterOffset) as SessionSpaceCompressedId;
+		}
+		// No space in the cluster, return next local
+		this.telemetryLocalIdCount++;
+		return this.generateNextLocalId();
 	}
 
 	public generateDocumentUniqueId():
@@ -210,6 +265,9 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	 * {@inheritdoc IIdCompressorCore.beginGhostSession}
 	 */
 	public beginGhostSession(ghostSessionId: SessionId, ghostSessionCallback: () => void): void {
+		if (this.shardingState) {
+			throw new Error("Cannot start a ghost session while sharded.");
+		}
 		this.startGhostSession(ghostSessionId);
 		try {
 			ghostSessionCallback();
@@ -218,6 +276,202 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		}
 	}
 
+	/**
+	 * {@inheritdoc IIdCompressorCore.shard}
+	 */
+	public shard(newShardCount: number): SerializedIdCompressorWithOngoingSession[] {
+		if (!Number.isSafeInteger(newShardCount) || newShardCount <= 0) {
+			throw new Error("Shard count must be a positive safe integer");
+		}
+		if (this.ongoingGhostSession) {
+			throw new Error("Cannot shard during ghost session");
+		}
+		if (this.writeVersion < SerializationVersion.V3) {
+			throw new Error(
+				`Sharding requires document version ${SerializationVersion.V3} or higher, but this document is version ${this.writeVersion}`,
+			);
+		}
+
+		const currentStride = this.shardingState?.currentStride ?? 1;
+		const newStride = currentStride * (newShardCount + 1);
+
+		// ID usage is exponential in stride count. Limit to practical size to avoid overflow.
+		if (newStride > MAX_STRIDE_LENGTH) {
+			throw new Error("Sharding limit reached.");
+		}
+		assert(Number.isSafeInteger(newStride), 0xd52 /* Shard stride must be a safe integer */);
+
+		if (this.shardingState === undefined) {
+			// First time sharding - initialize state
+			this.shardingState = {
+				currentStride: newStride,
+				originalStride: 1,
+				activeChildIds: new Set(),
+			};
+		} else {
+			this.shardingState.currentStride = newStride;
+		}
+
+		// Cache to avoid repeating per child
+		const serialized = this.serialize(true);
+		const { localGenCount: parentGenCount } = this;
+
+		const shards: SerializedIdCompressorWithOngoingSession[] = [];
+
+		// Children are positioned at consecutive positions within the parents current stride cycle
+		// e.g. if parent owns the "evens" space (-2, -4, -6, ...) and is sharded into 3 (two children)
+		// while at -8, then the child shards will start at -10 and -12 with a stride of 6
+		for (let i = 1; i <= newShardCount; i++) {
+			const childShardId = createSessionId();
+			this.shardingState.activeChildIds.add(childShardId);
+
+			const childLocalGenCount = parentGenCount + i * currentStride;
+
+			// This code results in a double roundtrip, but is probably plenty fast enough for scenarios that need sharding,
+			// as they necessarily have process boundaries to deal with.
+			// If this ever became an issue we can implement a fast clone of compressors
+			const child = deserializeIdCompressor(serialized, this.writeVersion) as IdCompressor;
+			const genCountJump = childLocalGenCount - parentGenCount;
+			assert(
+				child.localGenCount === parentGenCount && genCountJump > 0,
+				0xd53 /* Child offsets incorrectly calculated. */,
+			);
+
+			child.normalizer.addLocalRange(child.localGenCount + 1, genCountJump);
+			child.localGenCount = childLocalGenCount;
+			child.shardingState = {
+				currentStride: newStride,
+				originalStride: newStride,
+				activeChildIds: new Set(),
+				shardId: childShardId,
+			};
+
+			shards.push(child.serialize(true));
+		}
+
+		return shards;
+	}
+	/**
+	 * {@inheritdoc IIdCompressorCore.synchronizeWithShard}
+	 */
+	public synchronizeWithShard(syncToken: ShardSynchronizationToken): void {
+		const isNowLeaf = this.synchronizeChild(syncToken);
+		// A disposal token additionally reclaims the child's ID space. If reclaiming the last child
+		// returns this compressor to a leaf and it is the root (originalStride === 1), exit sharding mode.
+		if (syncToken.disposed) {
+			assert(this.shardingState !== undefined, 0xd54 /* Must be sharded */);
+			if (isNowLeaf && this.shardingState.originalStride === 1) {
+				this.shardingState = undefined;
+			}
+		}
+	}
+
+	private synchronizeChild(syncToken: ShardToken): boolean {
+		const childDisposed = syncToken.disposed;
+		if (this.writeVersion < SerializationVersion.V3) {
+			throw new Error(
+				`Sharding requires document version ${SerializationVersion.V3} or higher, but this document is version ${this.writeVersion}`,
+			);
+		}
+		if (this.shardingState === undefined) {
+			throw new Error("Must be in sharding mode.");
+		}
+
+		const childShardId = syncToken.shardId;
+		const { activeChildIds, originalStride } = this.shardingState;
+
+		// Verify this child belongs to us
+		if (!activeChildIds.has(childShardId)) {
+			throw new Error(
+				`Cannot synchronize with child with ID ${childShardId}: not in active children set`,
+			);
+		}
+
+		// Only disposal removes the child from the active set. A plain synchronization leaves the
+		// child active so it can continue generating IDs and be synchronized with again later.
+		if (childDisposed) {
+			activeChildIds.delete(childShardId);
+		}
+
+		const isLeaf = activeChildIds.size === 0;
+		if (isLeaf && childDisposed) {
+			this.shardingState.currentStride = originalStride;
+		}
+
+		// Read currentStride after the possible stride reset above, so that a leaf-making disposal
+		// realigns the parent on its original (reclaimed) stride rather than the wider sharded stride.
+		const { currentStride } = this.shardingState;
+		const childGenCount = syncToken.localGenCount;
+
+		// Realign parent to next position in its sequence if child is ahead
+		if (childGenCount > this.localGenCount) {
+			// Find next aligned position in parent's sequence after child's genCount
+			const distance = childGenCount - this.localGenCount + 1;
+			const steps = Math.ceil(distance / currentStride);
+			const count = steps * currentStride;
+			this.normalizer.addLocalRange(this.localGenCount + 1, count);
+			this.localGenCount += count;
+		}
+
+		return isLeaf;
+	}
+
+	/**
+	 * {@inheritdoc IIdCompressorCore.dispose}
+	 */
+	public disposeShard(): ShardSynchronizationToken | undefined {
+		if (this.shardingState === undefined) {
+			return undefined;
+		} else {
+			if (this.shardingState.activeChildIds.size > 0) {
+				throw new Error("Cannot dispose a shard with active children.");
+			}
+		}
+
+		// A disposal token is a sync token that additionally signals reclamation of this shard's ID space.
+		const token = this.makeShardToken(true);
+
+		// Make this compressor unusable by replacing all methods with throwing stubs
+		// This is a one-time mutation that avoids runtime checks in every method
+		makeCompressorUnusable(this);
+
+		return token;
+	}
+
+	/**
+	 * {@inheritdoc IIdCompressorCore.getShardSyncToken}
+	 */
+	public getShardSyncToken(): ShardSynchronizationToken | undefined {
+		if (this.shardingState === undefined) {
+			return undefined;
+		}
+
+		return this.makeShardToken(false);
+	}
+
+	/**
+	 * Builds a token describing this shard's current progress.
+	 * @param disposed - Whether the token also signals disposal (reclamation of this shard's ID space).
+	 */
+	private makeShardToken(disposed: boolean): ShardSynchronizationToken {
+		assert(this.shardingState !== undefined, 0xd55 /* Compressor is not sharded. */);
+
+		// Root cannot produce a token (shardId is undefined for root)
+		if (this.shardingState.shardId === undefined) {
+			throw new Error(
+				"Cannot get a token for a root compressor - only shards can be disposed",
+			);
+		}
+
+		const token: ShardToken = {
+			localGenCount: this.localGenCount,
+			shardId: this.shardingState.shardId,
+			disposed,
+		};
+
+		return token as unknown as ShardSynchronizationToken;
+	}
+
 	private generateNextLocalId(): LocalCompressedId {
 		// Must tell the normalizer that we generated a local ID
 		this.normalizer.addLocalRange(this.localGenCount, 1);
@@ -225,6 +479,14 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	}
 
 	public takeNextCreationRange(): IdCreationRange {
+		// Child (non-root) shards must not submit their own creation ranges. All shards in a shard tree share a
+		// single session, and only the root shard is responsible for finalizing that session's IDs with the server.
+		// A child's generated IDs are reconciled with the root via shard synchronization tokens (see
+		// synchronizeWithShard / disposeShard), not by independently sending ranges, which would overlap and
+		// conflict with the root's ranges for the shared session.
+		if (this.shardingState?.shardId !== undefined) {
+			throw new Error("Cannot take a creation range from a non-root shard.");
+		}
 		assert(
 			!this.ongoingGhostSession,
 			0x8a6 /* IdCompressor should not be operated normally when in a ghost session */,
@@ -577,11 +839,24 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 				sessionIndex++;
 			}
 		}
+		const sizeOfUuid = 2;
+		const shardingStateSize =
+			hasLocalState && this.writeVersion >= SerializationVersion.V3
+				? this.shardingState === undefined
+					? 1 // Boolean: no sharding state
+					: 1 + // Boolean: has sharding state
+						2 + // Numbers: currentStride, originalStride (Float64)
+						1 + // Number: activeChildIds count (Float64)
+						this.shardingState.activeChildIds.size * sizeOfUuid + // UUIDs: each is 128-bit
+						1 + // Boolean: hasShardId
+						(this.shardingState.shardId === undefined ? 0 : sizeOfUuid) // UUID: 128-bit if present
+				: 0;
 		const localStateSize = hasLocalState
 			? 1 + // generated ID count
 				1 + // next range base genCount
 				1 + // count of normalizer pairs
-				normalizer.idRanges.size * 2 // pairs
+				normalizer.idRanges.size * 2 + // pairs
+				shardingStateSize // sharding state if present
 			: 0;
 		// Layout size, in 8 byte increments
 		const totalSize =
@@ -589,14 +864,14 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			1 + // hasLocalState
 			1 + // session count
 			1 + // cluster count
-			sessionIndexMap.size * 2 + // session IDs
+			sessionIndexMap.size * sizeOfUuid + // session IDs
 			finalSpace.clusters.length * 3 + // clusters: (sessionIndex, capacity, count)[]
 			localStateSize; // local state, if present
 
 		const serializedFloat = new Float64Array(totalSize);
 		const serializedUint = new BigUint64Array(serializedFloat.buffer);
 		let index = 0;
-		index = writeNumber(serializedFloat, index, currentWrittenVersion);
+		index = writeNumber(serializedFloat, index, this.writeVersion);
 		index = writeBoolean(serializedFloat, index, hasLocalState);
 		index = writeNumber(serializedFloat, index, sessionIndexMap.size);
 		index = writeNumber(serializedFloat, index, finalSpace.clusters.length);
@@ -623,6 +898,35 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 				index = writeNumber(serializedFloat, index, leadingGenCount);
 				index = writeNumber(serializedFloat, index, count);
 			}
+
+			// Write sharding state (version 3+)
+			if (this.writeVersion >= SerializationVersion.V3) {
+				index = writeBoolean(serializedFloat, index, this.shardingState !== undefined);
+				if (this.shardingState !== undefined) {
+					index = writeNumber(serializedFloat, index, this.shardingState.currentStride);
+					index = writeNumber(serializedFloat, index, this.shardingState.originalStride);
+
+					// Write activeChildIds Set as count + array of NumericUuids
+					index = writeNumber(serializedFloat, index, this.shardingState.activeChildIds.size);
+					for (const childId of this.shardingState.activeChildIds) {
+						index = writeNumericUuid(serializedUint, index, numericUuidFromStableId(childId));
+					}
+
+					// Write shardId (optional)
+					index = writeBoolean(
+						serializedFloat,
+						index,
+						this.shardingState.shardId !== undefined,
+					);
+					if (this.shardingState.shardId !== undefined) {
+						index = writeNumericUuid(
+							serializedUint,
+							index,
+							numericUuidFromStableId(this.shardingState.shardId),
+						);
+					}
+				}
+			}
 		}
 
 		assert(index === totalSize, 0x75b /* Serialized size was incorrectly calculated. */);
@@ -640,41 +944,45 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		params:
 			| {
 					serialized: SerializedIdCompressorWithOngoingSession;
+					requestedWriteVersion: SerializationVersion;
 					logger?: TelemetryLoggerExt | undefined;
 					newSessionId?: never;
 			  }
 			| {
 					serialized: SerializedIdCompressorWithNoSession;
 					newSessionId: SessionId;
+					requestedWriteVersion: SerializationVersion;
 					logger?: TelemetryLoggerExt | undefined;
 			  },
 	): IdCompressor {
-		const { serialized, newSessionId, logger } = params;
+		const { serialized, newSessionId: sessionId, logger, requestedWriteVersion } = params;
 		const buffer = stringToBuffer(serialized, "base64");
 		const index: Index = {
 			index: 0,
 			bufferFloat: new Float64Array(buffer),
 			bufferUint: new BigUint64Array(buffer),
 		};
-		const version = readNumber(index);
-		switch (version) {
-			case 1: {
-				throw new Error("IdCompressor version 1.0 is no longer supported.");
-			}
-			case 2: {
-				return IdCompressor.deserialize2_0(index, newSessionId, logger);
+		const serializedVersion = readNumber(index) as SerializationVersion;
+		// If requested version is < the serialized version, we must write the version serialized
+		// to avoid losing data.
+		const writeVersion = Math.max(
+			requestedWriteVersion,
+			serializedVersion,
+		) as SerializationVersion;
+
+		switch (serializedVersion) {
+			case 2:
+			case 3: {
+				break;
 			}
 			default: {
+				if (serializedVersion === 1) {
+					throw new Error("IdCompressor version 1.0 is no longer supported.");
+				}
 				throw new Error("Unknown IdCompressor serialized version.");
 			}
 		}
-	}
 
-	static deserialize2_0(
-		index: Index,
-		sessionId: SessionId | undefined,
-		logger: TelemetryLoggerExt | undefined,
-	): IdCompressor {
 		const hasLocalState = readBoolean(index);
 		const sessionCount = readNumber(index);
 		const clusterCount = readNumber(index);
@@ -700,7 +1008,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			sessions.push([numeric, new Session(numeric)]);
 		}
 
-		const compressor = new IdCompressor(new Sessions(sessions), logger);
+		const compressor = new IdCompressor(new Sessions(sessions), logger, writeVersion);
 
 		// Clusters
 		let baseFinalId = 0;
@@ -727,6 +1035,38 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			for (let i = 0; i < normalizerCount; i++) {
 				compressor.normalizer.addLocalRange(readNumber(index), readNumber(index));
 			}
+
+			// Sharding state (version 3+)
+			if (serializedVersion >= 3) {
+				const hasShardingState = readBoolean(index);
+				if (hasShardingState) {
+					const currentStride = readNumber(index);
+					const originalStride = readNumber(index);
+
+					// Read activeChildIds Set
+					const activeChildCount = readNumber(index);
+					const activeChildIds = new Set<SessionId>();
+					for (let i = 0; i < activeChildCount; i++) {
+						const childIdNumeric = readNumericUuid(index);
+						// Safe cast: these were serialized as SessionIds
+						activeChildIds.add(stableIdFromNumericUuid(childIdNumeric) as SessionId);
+					}
+
+					// Read shardId (optional)
+					const hasShardId = readBoolean(index);
+					const shardId: SessionId | undefined = hasShardId
+						? (stableIdFromNumericUuid(readNumericUuid(index)) as SessionId)
+						: undefined;
+
+					// Build sharding state object, conditionally including shardId
+					compressor.shardingState = {
+						currentStride,
+						originalStride,
+						activeChildIds,
+						...(shardId !== undefined && { shardId }),
+					};
+				}
+			}
 		}
 
 		assert(
@@ -747,6 +1087,34 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		) {
 			return false;
 		}
+		// Shard ownership affects future local ID allocation, even when the generated IDs match.
+		// It is not part of finalized state, so ignore it when comparing only that state.
+		if (includeLocalState) {
+			const state = this.shardingState;
+			const otherState = other.shardingState;
+			if (state === undefined || otherState === undefined) {
+				// Two unsharded compressors match here; a sharded and an unsharded compressor do not.
+				if (state !== otherState) {
+					return false;
+				}
+			} else {
+				if (
+					state.currentStride !== otherState.currentStride ||
+					state.originalStride !== otherState.originalStride ||
+					state.shardId !== otherState.shardId ||
+					state.activeChildIds.size !== otherState.activeChildIds.size
+				) {
+					return false;
+				}
+				// Child ownership is an unordered set. Equal sizes and membership imply equal sets,
+				// regardless of insertion order or whether the state was deserialized.
+				for (const childId of state.activeChildIds) {
+					if (!otherState.activeChildIds.has(childId)) {
+						return false;
+					}
+				}
+			}
+		}
 		return (
 			this.sessions.equals(other.sessions, includeLocalState) &&
 			this.finalSpace.equals(other.finalSpace)
@@ -756,73 +1124,94 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 
 /**
  * Create a new {@link IIdCompressor}.
- *
- * @legacy @beta
+ * @param writeVersion - The version the compressor will write when serializing. Use SerializationVersion.V2 for base format, or SerializationVersion.V3 for sharding support.
+ * @param logger - Optional telemetry logger.
+ * @internal
  */
-export function createIdCompressor(logger?: ITelemetryBaseLogger): IIdCompressor;
+export function createIdCompressor(
+	writeVersion: SerializationVersion,
+	logger?: ITelemetryBaseLogger,
+): IIdCompressor & IIdCompressorCore;
 /**
  * Create a new {@link IIdCompressor}.
  * @param sessionId - The seed ID for the compressor.
- *
- * @legacy @beta
+ * @param writeVersion - The version the compressor will write when serializing. Use SerializationVersion.V2 for base format, or SerializationVersion.V3 for sharding support.
+ * @param logger - Optional telemetry logger.
+ * @internal
  */
 export function createIdCompressor(
 	sessionId: SessionId,
+	writeVersion: SerializationVersion,
 	logger?: ITelemetryBaseLogger,
-): IIdCompressor;
+): IIdCompressor & IIdCompressorCore;
 export function createIdCompressor(
-	sessionIdOrLogger?: SessionId | ITelemetryBaseLogger,
+	sessionIdOrDocumentVersion: SessionId | SerializationVersion,
+	writeVersionOrLogger?: SerializationVersion | ITelemetryBaseLogger,
 	loggerOrUndefined?: ITelemetryBaseLogger,
 ): IIdCompressor & IIdCompressorCore {
 	let localSessionId: SessionId;
+	let writeVersion: SerializationVersion;
 	let logger: ITelemetryBaseLogger | undefined;
-	if (sessionIdOrLogger === undefined) {
-		localSessionId = createSessionId();
+
+	if (typeof sessionIdOrDocumentVersion === "string") {
+		// Called with sessionId, writeVersion, logger?
+		localSessionId = sessionIdOrDocumentVersion;
+		writeVersion = writeVersionOrLogger as SerializationVersion;
+		logger = loggerOrUndefined;
 	} else {
-		if (typeof sessionIdOrLogger === "string") {
-			localSessionId = sessionIdOrLogger;
-			logger = loggerOrUndefined;
-		} else {
-			localSessionId = createSessionId();
-			logger = sessionIdOrLogger;
-		}
+		// Called with writeVersion, logger?
+		localSessionId = createSessionId();
+		writeVersion = sessionIdOrDocumentVersion;
+		logger = writeVersionOrLogger as ITelemetryBaseLogger | undefined;
 	}
+
 	const compressor = new IdCompressor(
 		localSessionId,
 		logger === undefined ? undefined : createChildLogger({ logger }),
+		writeVersion,
 	);
 	return compressor;
 }
 
 /**
  * Deserializes the supplied state into an ID compressor.
- *
- * @legacy @beta
+ * @param serialized - The serialized compressor state with an ongoing session.
+ * @param writeVersion - The version the compressor will write when serializing. This determines what features are available (e.g., V3 enables sharding support).
+ * @param logger - Optional telemetry logger.
+ * @internal
  */
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressorWithOngoingSession,
+	writeVersion: SerializationVersion,
 	logger?: ITelemetryLoggerExt,
-): IIdCompressor;
+): IIdCompressor & IIdCompressorCore;
 /**
  * Deserializes the supplied state into an ID compressor.
- *
- * @legacy @beta
+ * @param serialized - The serialized compressor state without a session.
+ * @param newSessionId - The session ID to use for the deserialized compressor.
+ * @param writeVersion - The version the compressor will write when serializing. This determines what features are available (e.g., V3 enables sharding support).
+ * @param logger - Optional telemetry logger.
+ * @internal
  */
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressorWithNoSession,
 	newSessionId: SessionId,
+	writeVersion: SerializationVersion,
 	logger?: ITelemetryLoggerExt,
-): IIdCompressor;
+): IIdCompressor & IIdCompressorCore;
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressor | SerializedIdCompressorWithNoSession,
-	sessionIdOrLogger: SessionId | ITelemetryLoggerExt | undefined,
+	sessionIdOrDocumentVersion: SessionId | SerializationVersion,
+	writeVersionOrLogger?: SerializationVersion | ITelemetryLoggerExt,
 	loggerOrUndefined?: ITelemetryLoggerExt,
 ): IIdCompressor & IIdCompressorCore {
-	if (typeof sessionIdOrLogger === "string") {
+	if (typeof sessionIdOrDocumentVersion === "string") {
+		// Called with (serialized, sessionId, writeVersion, logger?)
 		return IdCompressor.deserialize({
 			serialized: serialized as SerializedIdCompressorWithNoSession,
 			logger: extractTelemetryLoggerExt<{ PossiblyUndefined: true }>(loggerOrUndefined),
-			newSessionId: sessionIdOrLogger,
+			newSessionId: sessionIdOrDocumentVersion,
+			requestedWriteVersion: writeVersionOrLogger as SerializationVersion,
 		});
 	}
 
@@ -830,18 +1219,53 @@ export function deserializeIdCompressor(
 		loggerOrUndefined === undefined,
 		0xc2d /* logger would be in sessionIdOrLogger in this codepath */,
 	);
+	// Called with (serialized, writeVersion, logger?)
 	return IdCompressor.deserialize({
 		serialized: serialized as SerializedIdCompressorWithOngoingSession,
-		logger: extractTelemetryLoggerExt<{ PossiblyUndefined: true }>(sessionIdOrLogger),
+		logger: extractTelemetryLoggerExt<{ PossiblyUndefined: true }>(
+			writeVersionOrLogger as ITelemetryLoggerExt | undefined,
+		),
+		requestedWriteVersion: sessionIdOrDocumentVersion,
 	});
 }
 
+/**
+ * Throws an error indicating the compressor has been disposed.
+ */
+const throwDisposed = (): never => {
+	throw new Error(
+		"This compressor has been disposed via disposeShard() and can no longer be used.",
+	);
+};
+
+/**
+ * Makes an IdCompressor instance unusable by replacing all its methods with functions that throw.
+ * This is called once when disposeShard() is invoked to make the compressor permanently unusable.
+ * @param compressor - The compressor instance to make unusable
+ */
+function makeCompressorUnusable(compressor: IdCompressor): void {
+	// Get all method names from the prototype (where class methods live)
+	const proto = Object.getPrototypeOf(compressor) as object;
+	for (const key of Reflect.ownKeys(proto)) {
+		if (key !== "constructor" && typeof Reflect.get(proto, key) === "function") {
+			// Shadow the method only on this instance so other compressors remain usable.
+			// Omitting `enumerable` keeps new overrides non-enumerable, like class methods.
+			// Reflection supports string and symbol keys without adding an index signature.
+			Object.defineProperty(compressor, key, {
+				value: throwDisposed,
+				configurable: true,
+				writable: true,
+			});
+		}
+	}
+}
+
 /**
  * Serializes an ID compressor.
  * @param compressor - The compressor to serialize.
  * @param withSession - If true, the serialized state will include local session
  * state (for stashing). If false, only finalized state is included (for summaries).
- * @legacy @beta
+ * @internal
  */
 export function serializeIdCompressor(
 	compressor: IIdCompressor,
@@ -852,7 +1276,7 @@ export function serializeIdCompressor(
  * @param compressor - The compressor to serialize.
  * @param withSession - If true, the serialized state will include local session
  * state (for stashing). If false, only finalized state is included (for summaries).
- * @legacy @beta
+ * @internal
  */
 export function serializeIdCompressor(
 	compressor: IIdCompressor,