@fluidframework/id-compressor 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/id-compressor",
-  "version": "2.0.0-rc.4.0.6",
+  "version": "2.0.0-rc.5.0.0",
   "description": "ID compressor",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -79,29 +79,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
+    "@fluid-internal/client-utils": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluidframework/core-utils": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluid-private/stochastic-test-utils": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
+    "@biomejs/biome": "^1.7.3",
+    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluid-private/stochastic-test-utils": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "^0.38.0",
+    "@fluid-tools/build-cli": "^0.39.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.38.0",
-    "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@fluidframework/id-compressor-previous": "npm:@fluidframework/id-compressor@2.0.0-rc.3.0.0",
-    "@microsoft/api-extractor": "^7.43.1",
+    "@fluidframework/build-tools": "^0.39.0",
+    "@fluidframework/eslint-config-fluid": "^5.3.0",
+    "@fluidframework/id-compressor-previous": "npm:@fluidframework/id-compressor@2.0.0-rc.4.0.0",
+    "@microsoft/api-extractor": "^7.45.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "@types/uuid": "^9.0.2",
     "c8": "^8.0.1",
+    "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.55.0",
@@ -111,7 +112,7 @@
     "moment": "^2.21.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "typescript": "~5.1.6"
+    "typescript": "~5.4.5"
   },
   "typeValidation": {
     "broken": {}
@@ -130,13 +131,21 @@
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
     "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints ./internal/test-utils",
+    "check:biome": "biome check . --formatter-enabled=true",
+    "check:exports": "concurrently \"npm:check:exports:*\"",
+    "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
+    "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
+    "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
+    "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
+    "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
+    "check:format": "npm run check:biome",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "fluid-build --task format .",
+    "format": "npm run format:biome",
+    "format:biome": "biome check . --formatter-enabled=true --apply",
     "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",

package/src/appendOnlySortedMap.ts

@@ -234,10 +234,7 @@ export class AppendOnlySortedMap<K, V> {
 		let prev: readonly [K, unknown] | undefined;
 		for (const kv of this.entries()) {
 			if (prev !== undefined) {
-				assert(
-					this.comparator(kv[0], prev[0]) > 0,
-					0x752 /* Keys in map must be sorted. */,
-				);
+				assert(this.comparator(kv[0], prev[0]) > 0, 0x752 /* Keys in map must be sorted. */);
 			}
 			prev = kv;
 		}

package/src/finalSpace.ts

@@ -6,7 +6,12 @@
 import { assert } from "@fluidframework/core-utils/internal";
 
 import { FinalCompressedId } from "./identifiers.js";
-import { IdCluster, clustersEqual, lastAllocatedFinal, lastFinalizedFinal } from "./sessions.js";
+import {
+	IdCluster,
+	clustersEqual,
+	lastAllocatedFinal,
+	lastFinalizedFinal,
+} from "./sessions.js";
 
 /**
  * All IDs that have been finalized (acked), grouped into clusters sorted by their base final IDs.

package/src/idCompressor.ts

@@ -13,7 +13,12 @@ import {
 } from "@fluidframework/telemetry-utils/internal";
 
 import { FinalSpace } from "./finalSpace.js";
-import { FinalCompressedId, LocalCompressedId, NumericUuid, isFinalId } from "./identifiers.js";
+import {
+	FinalCompressedId,
+	LocalCompressedId,
+	NumericUuid,
+	isFinalId,
+} from "./identifiers.js";
 import {
 	Index,
 	readBoolean,
@@ -178,7 +183,9 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		}
 	}
 
-	public generateDocumentUniqueId(): (SessionSpaceCompressedId & OpSpaceCompressedId) | StableId {
+	public generateDocumentUniqueId():
+		| (SessionSpaceCompressedId & OpSpaceCompressedId)
+		| StableId {
 		const id = this.generateCompressedId();
 		return isFinalId(id) ? id : this.decompress(id);
 	}
@@ -387,7 +394,10 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			capacity,
 			0,
 		);
-		assert(!this.sessions.clusterCollides(newCluster), 0x758 /* Cluster collision detected. */);
+		assert(
+			!this.sessions.clusterCollides(newCluster),
+			0x758 /* Cluster collision detected. */,
+		);
 		this.finalSpace.addCluster(newCluster);
 		return newCluster;
 	}
@@ -462,16 +472,11 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			}
 			const alignedLocal = getAlignedLocal(containingCluster, id);
 			const alignedGenCount = genCountFromLocalId(alignedLocal);
-			const lastFinalizedGenCount = genCountFromLocalId(
-				lastFinalizedLocal(containingCluster),
-			);
+			const lastFinalizedGenCount = genCountFromLocalId(lastFinalizedLocal(containingCluster));
 			if (alignedGenCount > lastFinalizedGenCount) {
 				// should be an eager final id generated by the local session
 				if (containingCluster.session === this.localSession) {
-					assert(
-						!this.normalizer.contains(alignedLocal),
-						0x759 /* Normalizer out of sync. */,
-					);
+					assert(!this.normalizer.contains(alignedLocal), 0x759 /* Normalizer out of sync. */);
 				} else {
 					throw new Error("Unknown ID");
 				}
@@ -561,9 +566,9 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		}
 		const localStateSize = hasLocalState
 			? 1 + // generated ID count
-			  1 + // next range base genCount
-			  1 + // count of normalizer pairs
-			  this.normalizer.idRanges.size * 2 // pairs
+				1 + // next range base genCount
+				1 + // count of normalizer pairs
+				this.normalizer.idRanges.size * 2 // pairs
 			: 0;
 		// Layout size, in 8 byte increments
 		const totalSize =
@@ -695,11 +700,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			const session = sessions[sessionIndex + sessionOffset][1];
 			const capacity = readNumber(index);
 			const count = readNumber(index);
-			const cluster = session.addNewCluster(
-				baseFinalId as FinalCompressedId,
-				capacity,
-				count,
-			);
+			const cluster = session.addNewCluster(baseFinalId as FinalCompressedId, capacity, count);
 			compressor.finalSpace.addCluster(cluster);
 			baseFinalId += capacity;
 		}
@@ -809,5 +810,8 @@ export function deserializeIdCompressor(
 		);
 	}
 
-	return IdCompressor.deserialize(serialized as SerializedIdCompressorWithOngoingSession, logger);
+	return IdCompressor.deserialize(
+		serialized as SerializedIdCompressorWithOngoingSession,
+		logger,
+	);
 }

package/src/index.ts

@@ -8,7 +8,12 @@
  */
 
 export { createIdCompressor, deserializeIdCompressor } from "./idCompressor.js";
-export { createSessionId, assertIsStableId, generateStableId, isStableId } from "./utilities.js";
+export {
+	createSessionId,
+	assertIsStableId,
+	generateStableId,
+	isStableId,
+} from "./utilities.js";
 export {
 	IIdCompressorCore,
 	IIdCompressor,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/id-compressor";
-export const pkgVersion = "2.0.0-rc.4.0.6";
+export const pkgVersion = "2.0.0-rc.5.0.0";

package/src/sessionSpaceNormalizer.ts

@@ -4,6 +4,7 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
+
 import { AppendOnlySortedMap } from "./appendOnlySortedMap.js";
 import { LocalCompressedId } from "./identifiers.js";
 import { compareFiniteNumbers, genCountFromLocalId } from "./utilities.js";
@@ -43,7 +44,9 @@ import { compareFiniteNumbers, genCountFromLocalId } from "./utilities.js";
 export class SessionSpaceNormalizer {
 	// Run-length encoding of IDs that were generated as local IDs. They are stored as a list of tuples (genCount, count)
 	// that are sorted on the genCount so that contains checks can use a binary search.
-	private readonly localIdRanges = new AppendOnlySortedMap<number, number>(compareFiniteNumbers);
+	private readonly localIdRanges = new AppendOnlySortedMap<number, number>(
+		compareFiniteNumbers,
+	);
 
 	public get idRanges(): Pick<AppendOnlySortedMap<number, number>, "size" | "entries"> {
 		return this.localIdRanges;

package/src/test/idCompressorTestUtilities.ts

@@ -31,9 +31,9 @@ import {
 	StableId,
 	createIdCompressor,
 } from "../index.js";
+import { SessionSpaceNormalizer } from "../sessionSpaceNormalizer.js";
 import { assertIsSessionId, createSessionId, localIdFromGenCount } from "../utilities.js";
 
-import { SessionSpaceNormalizer } from "../sessionSpaceNormalizer.js";
 import {
 	FinalCompressedId,
 	ReadonlyIdCompressor,
@@ -120,7 +120,10 @@ export function buildHugeCompressor(
 	capacity = 10,
 	numClustersPerSession = 3,
 ): IdCompressor {
-	const compressor = CompressorFactory.createCompressorWithSession(createSessionId(), capacity);
+	const compressor = CompressorFactory.createCompressorWithSession(
+		createSessionId(),
+		capacity,
+	);
 	const sessions: SessionId[] = [];
 	for (let i = 0; i < numSessions; i++) {
 		sessions.push(createSessionId());
@@ -378,7 +381,10 @@ export class IdCompressorTestNetwork {
 	/**
 	 * Delivers all undelivered ID ranges from the server to the target clients.
 	 */
-	public deliverOperations(clientTakingDelivery: DestinationClient, opsToDeliver?: number): void {
+	public deliverOperations(
+		clientTakingDelivery: DestinationClient,
+		opsToDeliver?: number,
+	): void {
 		let opIndexBound: number;
 		if (clientTakingDelivery === DestinationClient.All) {
 			assert(opsToDeliver === undefined);
@@ -397,10 +403,7 @@ export class IdCompressorTestNetwork {
 				const ids = range.ids;
 				if (ids !== undefined) {
 					for (const id of opSpaceIds) {
-						const sessionSpaceId = compressorTo.normalizeToSessionSpace(
-							id,
-							range.sessionId,
-						);
+						const sessionSpaceId = compressorTo.normalizeToSessionSpace(id, range.sessionId);
 						this.addNewId(clientTo, sessionSpaceId, clientFrom, sessionIdFrom, true);
 					}
 				}
@@ -584,18 +587,14 @@ export class IdCompressorTestNetwork {
 					if (originatingSession !== OriginatingClient.Remote) {
 						assert.strictEqual(
 							idDataA.sessionId,
-							this.compressors.get(idDataA.originatingClient as Client)
-								.localSessionId,
+							this.compressors.get(idDataA.originatingClient as Client).localSessionId,
 						);
 					}
 					idCreatorCount++;
 				}
 
 				const uuidASessionSpace = compressorA.decompress(sessionSpaceIdA);
-				assert.strictEqual(
-					uuidASessionSpace,
-					incrementStableId(idDataA.sessionId, idIndex),
-				);
+				assert.strictEqual(uuidASessionSpace, incrementStableId(idDataA.sessionId, idIndex));
 				assert.strictEqual(compressorA.recompress(uuidASessionSpace), sessionSpaceIdA);
 				uuids.add(uuidASessionSpace);
 				const opSpaceIdA = compressorA.normalizeToOpSpace(sessionSpaceIdA);
@@ -675,7 +674,10 @@ export function roundtrip(
 export function roundtrip(
 	compressor: ReadonlyIdCompressor,
 	withSession: boolean,
-): [SerializedIdCompressorWithOngoingSession | SerializedIdCompressorWithNoSession, IdCompressor] {
+): [
+	SerializedIdCompressorWithOngoingSession | SerializedIdCompressorWithNoSession,
+	IdCompressor,
+] {
 	// 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
@@ -867,7 +869,9 @@ export function makeOpGenerator(
 		selectableClients,
 		network,
 	}: FuzzTestState): DeliverSomeOperations {
-		const pendingClients = selectableClients.filter((c) => network.getPendingOperations(c) > 0);
+		const pendingClients = selectableClients.filter(
+			(c) => network.getPendingOperations(c) > 0,
+		);
 		if (pendingClients.length === 0) {
 			return {
 				type: "deliverSomeOperations",
@@ -1016,8 +1020,8 @@ export function createAlwaysFinalizedIdCompressor(
 		sessionIdOrLogger === undefined
 			? createIdCompressor()
 			: typeof sessionIdOrLogger === "string"
-			? createIdCompressor(sessionIdOrLogger, loggerOrUndefined)
-			: createIdCompressor(sessionIdOrLogger);
+				? createIdCompressor(sessionIdOrLogger, loggerOrUndefined)
+				: createIdCompressor(sessionIdOrLogger);
 	// Permanently put the compressor in a ghost session
 	(compressor as IdCompressor).startGhostSession(createSessionId());
 	return compressor;

package/src/test/testCommon.ts

@@ -16,7 +16,6 @@ import {
 /**
  * An identifier (v4 UUID) that has been shortened by a distributed compression algorithm.
  * Lacks a space (session/op), meaning its scope is the same as the space-specific ID from which it was derived.
- * @alpha
  */
 export type CompressedId =
 	| SessionSpaceCompressedId
@@ -27,7 +26,6 @@ export type CompressedId =
 /**
  * A compressed ID that is stable and unique within the scope of network of compressors (i.e. a document).
  * It can only be used/decompressed in the context of the originating document.
- * @alpha
  */
 export type FinalCompressedId = number & {
 	readonly FinalCompressedId: "5d83d1e2-98b7-4e4e-a889-54c855cfa73d";
@@ -40,7 +38,6 @@ export type FinalCompressedId = number & {
  * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId).
  * Internally, it should not be persisted outside a scope annotated with the originating SessionId in order to be unambiguous.
  * If external persistence is needed (e.g. by a client), a StableId should be used instead.
- * @alpha
  */
 export type LocalCompressedId = number & {
 	readonly LocalCompressedId: "6fccb42f-e2a4-4243-bd29-f13d12b9c6d1";

package/src/test/tsconfig.json

@@ -10,6 +10,8 @@
 		"declaration": true,
 		"declarationMap": true,
 		"noImplicitAny": false,
+		"exactOptionalPropertyTypes": false,
+		"noUncheckedIndexedAccess": false,
 	},
 	"include": ["./**/*"],
 	"references": [

package/src/types/identifiers.ts

@@ -36,4 +36,6 @@ export type StableId = string & { readonly StableId: "53172b0d-a3d5-41ea-bd75-b4
  * A StableId which is suitable for use as a session identifier
  * @public
  */
-export type SessionId = StableId & { readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58" };
+export type SessionId = StableId & {
+	readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
+};

package/tsconfig.json

@@ -3,6 +3,8 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
+		"exactOptionalPropertyTypes": false,
+		"noUncheckedIndexedAccess": false,
 	},
 	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}