@fluidframework/id-compressor 2.12.0 → 2.20.0

package/src/idCompressor.ts

@@ -64,7 +64,7 @@ import {
  * The version of IdCompressor that is currently persisted.
  * This should not be changed without careful consideration to compatibility.
  */
-const currentWrittenVersion = 2.0;
+const currentWrittenVersion = 2;
 
 function rangeFinalizationError(expectedStart: number, actualStart: number): LoggingError {
 	return new LoggingError("Ranges finalized out of order", {
@@ -202,7 +202,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	/**
 	 * {@inheritdoc IIdCompressorCore.beginGhostSession}
 	 */
-	public beginGhostSession(ghostSessionId: SessionId, ghostSessionCallback: () => void) {
+	public beginGhostSession(ghostSessionId: SessionId, ghostSessionCallback: () => void): void {
 		this.startGhostSession(ghostSessionId);
 		try {
 			ghostSessionCallback();
@@ -554,7 +554,8 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			!this.ongoingGhostSession,
 			0x8a9 /* IdCompressor should not be operated normally when in a ghost session */,
 		);
-		const { normalizer, finalSpace, sessions } = this;
+		const { normalizer, finalSpace, sessions, localGenCount, logger, nextRangeBaseGenCount } =
+			this;
 		const sessionIndexMap = new Map<Session, number>();
 		let sessionIndex = 0;
 		for (const session of sessions.sessions()) {
@@ -568,7 +569,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			? 1 + // generated ID count
 				1 + // next range base genCount
 				1 + // count of normalizer pairs
-				this.normalizer.idRanges.size * 2 // pairs
+				normalizer.idRanges.size * 2 // pairs
 			: 0;
 		// Layout size, in 8 byte increments
 		const totalSize =
@@ -592,7 +593,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			index = writeNumericUuid(serializedUint, index, session.sessionUuid);
 		}
 
-		finalSpace.clusters.forEach((cluster) => {
+		for (const cluster of finalSpace.clusters) {
 			index = writeNumber(
 				serializedFloat,
 				index,
@@ -600,11 +601,11 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			);
 			index = writeNumber(serializedFloat, index, cluster.capacity);
 			index = writeNumber(serializedFloat, index, cluster.count);
-		});
+		}
 
 		if (hasLocalState) {
-			index = writeNumber(serializedFloat, index, this.localGenCount);
-			index = writeNumber(serializedFloat, index, this.nextRangeBaseGenCount);
+			index = writeNumber(serializedFloat, index, localGenCount);
+			index = writeNumber(serializedFloat, index, nextRangeBaseGenCount);
 			index = writeNumber(serializedFloat, index, normalizer.idRanges.size);
 			for (const [leadingGenCount, count] of normalizer.idRanges.entries()) {
 				index = writeNumber(serializedFloat, index, leadingGenCount);
@@ -613,7 +614,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		}
 
 		assert(index === totalSize, 0x75b /* Serialized size was incorrectly calculated. */);
-		this.logger?.sendTelemetryEvent({
+		logger?.sendTelemetryEvent({
 			eventName: "RuntimeIdCompressor:SerializedIdCompressorSize",
 			size: serializedFloat.byteLength,
 			clusterCount: finalSpace.clusters.length,
@@ -652,12 +653,15 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		};
 		const version = readNumber(index);
 		switch (version) {
-			case 1.0:
+			case 1: {
 				throw new Error("IdCompressor version 1.0 is no longer supported.");
-			case 2.0:
+			}
+			case 2: {
 				return IdCompressor.deserialize2_0(index, sessionId, logger);
-			default:
+			}
+			default: {
 				throw new Error("Unknown IdCompressor serialized version.");
+			}
 		}
 	}
 
@@ -673,17 +677,17 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		// Sessions
 		let sessionOffset = 0;
 		const sessions: [NumericUuid, Session][] = [];
-		if (!hasLocalState) {
+		if (hasLocalState) {
+			assert(
+				sessionId === undefined,
+				0x75e /* Local state should not exist in serialized form. */,
+			);
+		} else {
 			// If !hasLocalState, there won't be a serialized local session ID so insert one at the beginning
 			assert(sessionId !== undefined, 0x75d /* Local session ID is undefined. */);
 			const localSessionNumeric = numericUuidFromStableId(sessionId);
 			sessions.push([localSessionNumeric, new Session(localSessionNumeric)]);
 			sessionOffset = 1;
-		} else {
-			assert(
-				sessionId === undefined,
-				0x75e /* Local state should not exist in serialized form. */,
-			);
 		}
 
 		for (let i = 0; i < sessionCount; i++) {

package/src/identifiers.ts

@@ -26,7 +26,7 @@ export type LocalCompressedId = number & {
 } & SessionSpaceCompressedId; // Same brand as CompressedId, as local IDs are always locally normalized
 
 /**
- * @returns true if the supplied ID is a final ID.
+ * Returns true if the supplied ID is a final ID.
  */
 export function isFinalId(
 	id: SessionSpaceCompressedId | OpSpaceCompressedId,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/id-compressor";
-export const pkgVersion = "2.12.0";
+export const pkgVersion = "2.20.0";

package/src/sessions.ts

@@ -131,7 +131,7 @@ export class Sessions {
 	}
 
 	public equals(other: Sessions, includeLocalState: boolean): boolean {
-		const checkIsSubset = (sessionsA: Sessions, sessionsB: Sessions) => {
+		const checkIsSubset = (sessionsA: Sessions, sessionsB: Sessions): boolean => {
 			const first = sessionsA.sessions().next();
 			const firstSessionThis = first.done ? undefined : first.value;
 			for (const [stableId, session] of sessionsA.sessionCache.entries()) {
@@ -296,7 +296,7 @@ export class Session {
 
 	public equals(other: Session): boolean {
 		for (const [index, value] of Object.entries(this.clusterChain)) {
-			if (!clustersEqual(value, other.clusterChain[index])) {
+			if (!clustersEqual(value, other.clusterChain[index] as IdCluster)) {
 				return false;
 			}
 		}

package/src/test/idCompressorTestUtilities.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { strict as assert } from "assert";
+// eslint-disable-next-line import/no-nodejs-modules
+import { strict as assert } from "node:assert";
 
 import {
 	BaseFuzzTestState,
@@ -51,19 +52,25 @@ export interface ClosedMap<K, V> extends Omit<Map<K, V>, "delete" | "clear"> {
 	get(key: K): V;
 }
 
-/** Identifies a compressor in a network */
+/**
+ * Identifies a compressor in a network
+ */
 export enum Client {
 	Client1 = "Client1",
 	Client2 = "Client2",
 	Client3 = "Client3",
 }
 
-/** Identifies categories of compressors */
+/**
+ * Identifies categories of compressors
+ */
 export enum MetaClient {
 	All = "All",
 }
 
-/** Identifies a compressor inside the network but outside the three specially tracked clients. */
+/**
+ * Identifies a compressor inside the network but outside the three specially tracked clients.
+ */
 export enum OutsideClient {
 	Remote = "Remote",
 }
@@ -75,7 +82,9 @@ export enum OutsideClient {
 export type OriginatingClient = Client | OutsideClient;
 export const OriginatingClient = { ...Client, ...OutsideClient };
 
-/** Identifies a compressor to which to send an operation */
+/**
+ * Identifies a compressor to which to send an operation
+ */
 export type DestinationClient = Client | MetaClient;
 export const DestinationClient = { ...Client, ...MetaClient };
 
@@ -171,7 +180,9 @@ function makeSessionIds(): ClientMap<SessionId> {
  */
 export const sessionIds = makeSessionIds();
 
-/** Information about a generated ID in a network to be validated by tests */
+/**
+ * Information about a generated ID in a network to be validated by tests
+ */
 export interface TestIdData {
 	readonly id: SessionSpaceCompressedId;
 	readonly originatingClient: OriginatingClient;
@@ -184,20 +195,30 @@ export interface TestIdData {
  * Not suitable for performance testing.
  */
 export class IdCompressorTestNetwork {
-	/** The compressors used in this network */
+	/**
+	 * The compressors used in this network
+	 */
 	private readonly compressors: ClientMap<IdCompressor>;
-	/** The log of operations seen by the server so far. Append-only. */
+	/**
+	 * The log of operations seen by the server so far. Append-only.
+	 */
 	private readonly serverOperations: [
 		creationRange: IdCreationRange,
 		opSpaceIds: OpSpaceCompressedId[],
 		clientFrom: OriginatingClient,
 		sessionIdFrom: SessionId,
 	][] = [];
-	/** An index into `serverOperations` for each client which represents how many operations have been delivered to that client */
+	/**
+	 * An index into `serverOperations` for each client which represents how many operations have been delivered to that client
+	 */
 	private readonly clientProgress: ClientMap<number>;
-	/** All ids (local and sequenced) that a client has created or received, in order. */
+	/**
+	 * All ids (local and sequenced) that a client has created or received, in order.
+	 */
 	private readonly idLogs: ClientMap<TestIdData[]>;
-	/** All ids that a client has received from the server, in order. */
+	/**
+	 * All ids that a client has received from the server, in order.
+	 */
 	private readonly sequencedIdLogs: ClientMap<TestIdData[]>;
 
 	public constructor(public readonly initialClusterSize = 5) {
@@ -341,6 +362,7 @@ export class IdCompressorTestNetwork {
 				ids: {
 					firstGenCount: 1,
 					count: numIds,
+					// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 					requestedClusterSize: this.getCompressor(Client.Client1)[
 						// eslint-disable-next-line @typescript-eslint/dot-notation
 						"nextRequestedClusterSize"
@@ -391,9 +413,9 @@ export class IdCompressorTestNetwork {
 			opIndexBound = this.serverOperations.length;
 		} else {
 			opIndexBound =
-				opsToDeliver !== undefined
-					? this.clientProgress.get(clientTakingDelivery) + opsToDeliver
-					: this.serverOperations.length;
+				opsToDeliver === undefined
+					? this.serverOperations.length
+					: this.clientProgress.get(clientTakingDelivery) + opsToDeliver;
 		}
 		for (const [clientTo, compressorTo] of this.getTargetCompressors(clientTakingDelivery)) {
 			for (let i = this.clientProgress.get(clientTo); i < opIndexBound; i++) {
@@ -452,38 +474,38 @@ export class IdCompressorTestNetwork {
 		};
 
 		// Ensure creation ranges for clients we track contain the correct local ID ranges
-		this.serverOperations.forEach(([range, opSpaceIds, clientFrom]) => {
+		for (const [range, opSpaceIds, clientFrom] of this.serverOperations) {
 			if (clientFrom !== OriginatingClient.Remote) {
 				const localIdsInCreationRange = getLocalIdsInRange(range, opSpaceIds);
 				let localCount = 0;
-				opSpaceIds.forEach((id) => {
+				for (const id of opSpaceIds) {
 					if (isLocalId(id)) {
 						localCount++;
 						assert(localIdsInCreationRange.has(id), "Local ID not in creation range");
 					}
-				});
+				}
 				assert.strictEqual(
 					localCount,
 					localIdsInCreationRange.size,
 					"Local ID count mismatch",
 				);
 			}
-		});
+		}
 
 		const undeliveredRanges = new Map<Client, IdCreationRange[]>();
-		this.clientProgress.forEach((progress, client) => {
+		for (const [client, progress] of this.clientProgress.entries()) {
 			const ranges = this.serverOperations
 				.slice(progress)
 				.filter((op) => op[2] === client)
 				.map(([range]) => range);
 			undeliveredRanges.set(client, ranges);
-		});
-		undeliveredRanges.forEach((ranges, client) => {
+		}
+		for (const [client, ranges] of undeliveredRanges.entries()) {
 			const compressor = this.compressors.get(client);
 			let firstGenCount: number | undefined;
 			let totalCount = 0;
 			const unionedLocalRanges = new SessionSpaceNormalizer();
-			ranges.forEach((range) => {
+			for (const range of ranges) {
 				assert(range.sessionId === compressor.localSessionId);
 				if (range.ids !== undefined) {
 					// initialize firstGenCount if not set
@@ -491,18 +513,21 @@ export class IdCompressorTestNetwork {
 						firstGenCount = range.ids.firstGenCount;
 					}
 					totalCount += range.ids.count;
-					range.ids.localIdRanges.forEach(([genCount, count]) => {
+					for (const [genCount, count] of range.ids.localIdRanges) {
 						unionedLocalRanges.addLocalRange(genCount, count);
-					});
+					}
 				}
-			});
+			}
 
 			const retakenRange = compressor.takeUnfinalizedCreationRange();
-			if (retakenRange.ids !== undefined) {
+			if (retakenRange.ids === undefined) {
+				assert.strictEqual(totalCount, 0);
+				assert.strictEqual(unionedLocalRanges.idRanges.size, 0);
+			} else {
 				const retakenLocalIds = new SessionSpaceNormalizer();
-				retakenRange.ids.localIdRanges.forEach(([genCount, count]) => {
+				for (const [genCount, count] of retakenRange.ids.localIdRanges) {
 					retakenLocalIds.addLocalRange(genCount, count);
-				});
+				}
 				assert.strictEqual(
 					retakenLocalIds.equals(unionedLocalRanges),
 					true,
@@ -510,11 +535,8 @@ export class IdCompressorTestNetwork {
 				);
 				assert.strictEqual(retakenRange.ids.count, totalCount, "Count mismatch");
 				assert.strictEqual(retakenRange.ids.firstGenCount, firstGenCount, "Count mismatch");
-			} else {
-				assert.strictEqual(totalCount, 0);
-				assert.strictEqual(unionedLocalRanges.idRanges.size, 0);
 			}
-		});
+		}
 
 		// First, ensure all clients each generated a unique ID for each of their own calls to generate.
 		for (const [compressor, ids] of sequencedLogs) {
@@ -528,6 +550,7 @@ export class IdCompressorTestNetwork {
 
 		const maxLogLength = sequencedLogs
 			.map(([_, data]) => data.length)
+			// eslint-disable-next-line unicorn/no-array-reduce
 			.reduce((p, n) => Math.max(p, n));
 
 		function getNextLogWithEntryAt(logsIndex: number, entryIndex: number): number | undefined {
@@ -638,7 +661,7 @@ export class IdCompressorTestNetwork {
 			assert(originatingSession !== undefined, "Expected originating client to be defined");
 			idIndicesAggregator.set(
 				originatingSession,
-				// eslint-disable-next-line @typescript-eslint/restrict-plus-operands
+
 				(idIndicesAggregator.get(originatingSession) ??
 					fail("Expected pre-existing index for originating client")) + 1,
 			);
@@ -680,8 +703,8 @@ export function roundtrip(
 ] {
 	// preserve the capacity request as this property is normally private and resets
 	// to a default on construction (deserialization)
-	// eslint-disable-next-line @typescript-eslint/dot-notation
-	const capacity = compressor["nextRequestedClusterSize"];
+	// eslint-disable-next-line @typescript-eslint/dot-notation, @typescript-eslint/no-unsafe-assignment
+	const capacity: number = compressor["nextRequestedClusterSize"];
 	if (withSession) {
 		const serialized = compressor.serialize(withSession);
 		const roundtripped = IdCompressor.deserialize(serialized);
@@ -732,10 +755,10 @@ export function mergeArrayMaps<K, V>(
 ): Pick<Map<K, V[]>, "get" | "set"> {
 	for (const [key, value] of from.entries()) {
 		const entry = to.get(key);
-		if (entry !== undefined) {
-			entry.push(...value);
-		} else {
+		if (entry === undefined) {
 			to.set(key, [...value]);
+		} else {
+			entry.push(...value);
 		}
 	}
 	return to;
@@ -796,11 +819,17 @@ interface FuzzTestState extends BaseFuzzTestState {
 }
 
 export interface OperationGenerationConfig {
-	/** maximum cluster size of the network. Default: 25 */
+	/**
+	 * maximum cluster size of the network. Default: 25
+	 */
 	maxClusterSize?: number;
-	/** Number of ops between validation ops. Default: 200 */
+	/**
+	 * Number of ops between validation ops. Default: 200
+	 */
 	validateInterval?: number;
-	/** Fraction of ID allocations that are from an outside client (not Client1/2/3). */
+	/**
+	 * Fraction of ID allocations that are from an outside client (not Client1/2/3).
+	 */
 	outsideAllocationFraction?: number;
 }
 

package/src/test/testCommon.ts

@@ -44,6 +44,7 @@ export type LocalCompressedId = number & {
 } & SessionSpaceCompressedId; // Same brand as CompressedId, as local IDs are always locally normalized
 
 /**
+ * Returns true if the supplied ID is a final ID.
  * @returns true if the supplied ID is a final ID.
  */
 export function isFinalId(id: CompressedId): id is FinalCompressedId {
@@ -51,6 +52,7 @@ export function isFinalId(id: CompressedId): id is FinalCompressedId {
 }
 
 /**
+ * Returns true if the supplied ID is a local ID.
  * @returns true if the supplied ID is a local ID.
  */
 export function isLocalId(id: CompressedId): id is LocalCompressedId {
@@ -91,7 +93,9 @@ export function incrementStableId(stableId: StableId, offset: number): StableId
 	return stableIdFromNumericUuid(offsetNumericUuid(numericUuidFromStableId(stableId), offset));
 }
 
-/** An immutable view of an `IdCompressor` */
+/**
+ * An immutable view of an `IdCompressor`
+ */
 export type ReadonlyIdCompressor = Omit<
 	IdCompressor,
 	| "generateCompressedId"

package/src/utilities.ts

@@ -10,7 +10,7 @@ import { v4 } from "uuid";
 import { LocalCompressedId, NumericUuid } from "./identifiers.js";
 import { SessionId, StableId } from "./types/index.js";
 
-const hexadecimalCharCodes = Array.from("09afAF").map((c) => c.charCodeAt(0)) as [
+const hexadecimalCharCodes = [..."09afAF"].map((c) => c.codePointAt(0)) as [
 	zero: number,
 	nine: number,
 	a: number,
@@ -76,17 +76,19 @@ export function isStableId(str: string): str is StableId {
 			case 8:
 			case 13:
 			case 18:
-			case 23:
+			case 23: {
 				if (str.charAt(i) !== "-") {
 					return false;
 				}
 				break;
+			}
 
-			case 14:
+			case 14: {
 				if (str.charAt(i) !== "4") {
 					return false;
 				}
 				break;
+			}
 
 			case 19: {
 				const char = str.charAt(i);
@@ -96,11 +98,14 @@ export function isStableId(str: string): str is StableId {
 				break;
 			}
 
-			default:
-				if (!isHexadecimalCharacter(str.charCodeAt(i))) {
+			default: {
+				const codePoint = str.codePointAt(i);
+				assert(codePoint !== undefined, 0xaaf /* Unexpected undefined code point */);
+				if (!isHexadecimalCharacter(codePoint)) {
 					return false;
 				}
 				break;
+			}
 		}
 	}
 
@@ -172,14 +177,13 @@ export function stableIdFromNumericUuid(numericUuid: NumericUuid): StableId {
 	const uuidU128 = upperMasked | versionMask | middieBittiesMasked | variantMask | lowerMasked;
 	// Pad to 32 characters, inserting leading zeroes if needed
 	const uuidString = uuidU128.toString(16).padStart(32, "0");
-	return `${uuidString.substring(0, 8)}-${uuidString.substring(8, 12)}-${uuidString.substring(
+	return `${uuidString.slice(0, 8)}-${uuidString.slice(8, 12)}-${uuidString.slice(
 		12,
 		16,
-	)}-${uuidString.substring(16, 20)}-${uuidString.substring(20, 32)}` as StableId;
+	)}-${uuidString.slice(16, 20)}-${uuidString.slice(20, 32)}` as StableId;
 }
 
 export function offsetNumericUuid(numericUuid: NumericUuid, offset: number): NumericUuid {
-	// eslint-disable-next-line @typescript-eslint/restrict-plus-operands
 	return (numericUuid + BigInt(offset)) as NumericUuid;
 }
 
@@ -188,6 +192,5 @@ export function subtractNumericUuids(a: NumericUuid, b: NumericUuid): NumericUui
 }
 
 export function addNumericUuids(a: NumericUuid, b: NumericUuid): NumericUuid {
-	// eslint-disable-next-line @typescript-eslint/restrict-plus-operands
 	return (a + b) as NumericUuid;
 }