@fluidframework/id-compressor 2.33.0-333010 → 2.33.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/id-compressor",
-  "version": "2.33.0-333010",
+  "version": "2.33.1",
   "description": "ID compressor",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -81,25 +81,25 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.33.0-333010",
-    "@fluidframework/core-interfaces": "2.33.0-333010",
-    "@fluidframework/core-utils": "2.33.0-333010",
-    "@fluidframework/telemetry-utils": "2.33.0-333010",
+    "@fluid-internal/client-utils": "~2.33.1",
+    "@fluidframework/core-interfaces": "~2.33.1",
+    "@fluidframework/core-utils": "~2.33.1",
+    "@fluidframework/telemetry-utils": "~2.33.1",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "2.33.0-333010",
-    "@fluid-private/stochastic-test-utils": "2.33.0-333010",
+    "@fluid-internal/mocha-test-setup": "~2.33.1",
+    "@fluid-private/stochastic-test-utils": "~2.33.1",
     "@fluid-tools/benchmark": "^0.50.0",
     "@fluid-tools/build-cli": "^0.55.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.55.0",
     "@fluidframework/eslint-config-fluid": "^5.7.3",
-    "@fluidframework/id-compressor-previous": "npm:@fluidframework/id-compressor@2.31.0",
-    "@microsoft/api-extractor": "7.50.1",
+    "@fluidframework/id-compressor-previous": "npm:@fluidframework/id-compressor@2.33.0",
+    "@microsoft/api-extractor": "7.52.5",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "@types/uuid": "^9.0.2",
@@ -110,7 +110,6 @@
     "eslint": "~8.55.0",
     "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
-    "moment": "^2.21.0",
     "rimraf": "^4.4.0",
     "typescript": "~5.4.5"
   },

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/id-compressor";
-export const pkgVersion = "2.33.0-333010";
+export const pkgVersion = "2.33.1";

package/src/test/idCompressorTestUtilities.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-// eslint-disable-next-line import/no-nodejs-modules
 import { strict as assert } from "node:assert";
 
 import {
@@ -114,12 +113,46 @@ export class CompressorFactory {
 		logger?: ITelemetryBaseLogger,
 	): IdCompressor {
 		const compressor = createIdCompressor(sessionId, logger) as IdCompressor;
-		// eslint-disable-next-line @typescript-eslint/dot-notation
-		compressor["nextRequestedClusterSize"] = clusterCapacity;
+		modifyClusterSize(compressor, clusterCapacity);
 		return compressor;
 	}
 }
 
+/**
+ * Modify the requested cluster size of the provided compressor.
+ * @remarks
+ * This is useful for testing purposes for a few reasons:
+ * - Id compressor bugs are often related to edge cases that occur on cluster boundaries
+ * - Smaller cluster sizes can enable writing tests without for loops generating "ids until a new cluster is created"
+ */
+export function modifyClusterSize(compressor: IIdCompressor, newClusterSize: number): void {
+	verifyCompressorLike(compressor);
+	// eslint-disable-next-line @typescript-eslint/dot-notation
+	compressor["nextRequestedClusterSize"] = newClusterSize;
+}
+
+/**
+ * Returns the current cluster size of the compressor.
+ * @privateRemarks
+ * This is useful in writing tests to avoid having to hardcode the (currently constant) cluster size.
+ */
+export function getClusterSize(compressor: ReadonlyIdCompressor): number {
+	verifyCompressorLike(compressor);
+	// eslint-disable-next-line @typescript-eslint/dot-notation
+	return compressor["nextRequestedClusterSize"] as number;
+}
+
+function verifyCompressorLike(compressor: ReadonlyIdCompressor | IIdCompressor): void {
+	assert(
+		// Some IdCompressor tests wrap underlying compressors with proxies--allow this for now.
+		// Because of id-compressor's dynamic import in container-runtime, instanceof checks for IdCompressor
+		// also won't necessarily work nicely. Get a small amount of validation that this function should work
+		// as intended by at least verifying the property name exists.
+		// eslint-disable-next-line @typescript-eslint/dot-notation
+		typeof compressor["nextRequestedClusterSize"] === "number",
+	);
+}
+
 /**
  * Utility for building a huge compressor.
  * Build via the compressor factory.
@@ -311,7 +344,7 @@ export class IdCompressorTestNetwork {
 	 * Changes the capacity request amount for a client. It will take effect immediately.
 	 */
 	public changeCapacity(client: Client, newClusterCapacity: number): void {
-		changeCapacity(this.compressors.get(client), newClusterCapacity);
+		modifyClusterSize(this.compressors.get(client), newClusterCapacity);
 	}
 
 	private addNewId(
@@ -362,11 +395,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"
-					],
+					requestedClusterSize: getClusterSize(this.getCompressor(Client.Client1)),
 					localIdRanges: [], // remote session, can safely ignore in tests
 				},
 			};
@@ -673,11 +702,6 @@ export class IdCompressorTestNetwork {
 	}
 }
 
-function changeCapacity(compressor: IdCompressor, newClusterCapacity: number): void {
-	// eslint-disable-next-line @typescript-eslint/dot-notation
-	compressor["nextRequestedClusterSize"] = newClusterCapacity;
-}
-
 /**
  * Roundtrips the supplied compressor through serialization and deserialization.
  */
@@ -703,17 +727,16 @@ 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, @typescript-eslint/no-unsafe-assignment
-	const capacity: number = compressor["nextRequestedClusterSize"];
+	const capacity: number = getClusterSize(compressor);
 	if (withSession) {
 		const serialized = compressor.serialize(withSession);
 		const roundtripped = IdCompressor.deserialize(serialized);
-		changeCapacity(roundtripped, capacity);
+		modifyClusterSize(roundtripped, capacity);
 		return [serialized, roundtripped];
 	} else {
 		const nonLocalSerialized = compressor.serialize(withSession);
 		const roundtripped = IdCompressor.deserialize(nonLocalSerialized, createSessionId());
-		changeCapacity(roundtripped, capacity);
+		modifyClusterSize(roundtripped, capacity);
 		return [nonLocalSerialized, roundtripped];
 	}
 }

package/src/test/index.ts

@@ -7,4 +7,7 @@
  * Exports for test utilities for `id-compressor`
  */
 
-export { createAlwaysFinalizedIdCompressor } from "./idCompressorTestUtilities.js";
+export {
+	createAlwaysFinalizedIdCompressor,
+	modifyClusterSize,
+} from "./idCompressorTestUtilities.js";