@fluidframework/matrix 2.1.0-276985 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/matrix",
-  "version": "2.1.0-276985",
+  "version": "2.1.0",
   "description": "Distributed matrix",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -63,35 +63,35 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.1.0-276985",
-    "@fluidframework/core-interfaces": "2.1.0-276985",
-    "@fluidframework/core-utils": "2.1.0-276985",
-    "@fluidframework/datastore-definitions": "2.1.0-276985",
-    "@fluidframework/driver-definitions": "2.1.0-276985",
-    "@fluidframework/driver-utils": "2.1.0-276985",
-    "@fluidframework/merge-tree": "2.1.0-276985",
-    "@fluidframework/runtime-definitions": "2.1.0-276985",
-    "@fluidframework/runtime-utils": "2.1.0-276985",
-    "@fluidframework/shared-object-base": "2.1.0-276985",
-    "@fluidframework/telemetry-utils": "2.1.0-276985",
+    "@fluid-internal/client-utils": "~2.1.0",
+    "@fluidframework/core-interfaces": "~2.1.0",
+    "@fluidframework/core-utils": "~2.1.0",
+    "@fluidframework/datastore-definitions": "~2.1.0",
+    "@fluidframework/driver-definitions": "~2.1.0",
+    "@fluidframework/driver-utils": "~2.1.0",
+    "@fluidframework/merge-tree": "~2.1.0",
+    "@fluidframework/runtime-definitions": "~2.1.0",
+    "@fluidframework/runtime-utils": "~2.1.0",
+    "@fluidframework/shared-object-base": "~2.1.0",
+    "@fluidframework/telemetry-utils": "~2.1.0",
     "@tiny-calc/nano": "0.0.0-alpha.5",
     "double-ended-queue": "^2.1.0-0",
     "tslib": "^1.10.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-276985",
-    "@fluid-private/stochastic-test-utils": "2.1.0-276985",
-    "@fluid-private/test-dds-utils": "2.1.0-276985",
+    "@biomejs/biome": "~1.8.3",
+    "@fluid-internal/mocha-test-setup": "~2.1.0",
+    "@fluid-private/stochastic-test-utils": "~2.1.0",
+    "@fluid-private/test-dds-utils": "~2.1.0",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "^0.39.0",
+    "@fluid-tools/build-cli": "^0.41.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.39.0",
-    "@fluidframework/container-definitions": "2.1.0-276985",
+    "@fluidframework/build-tools": "^0.41.0",
+    "@fluidframework/container-definitions": "~2.1.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/matrix-previous": "npm:@fluidframework/matrix@2.0.0-rc.5.0.0",
-    "@fluidframework/test-runtime-utils": "2.1.0-276985",
+    "@fluidframework/matrix-previous": "npm:@fluidframework/matrix@2.0.0",
+    "@fluidframework/test-runtime-utils": "~2.1.0",
     "@microsoft/api-extractor": "^7.45.1",
     "@tiny-calc/micro": "0.0.0-alpha.5",
     "@types/double-ended-queue": "^2.1.0",
@@ -115,7 +115,11 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "Variable_SharedMatrix": {
+        "forwardCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
@@ -124,18 +128,19 @@
     "bench": "cd bench && node --expose-gc -r ts-node/register src/index.ts",
     "bench:profile": "cd bench && node -r ts-node/register --prof --logfile=profile.log --no-logfile-per-isolate src/index.ts --runInBand && node --prof-process profile.log > profile.txt && rimraf profile.log && echo See results in bench/profile.txt",
     "build": "fluid-build . --task build",
+    "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
+    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "concurrently \"npm:build:docs:*\"",
-    "build:docs:current": "api-extractor run --local",
-    "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "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 .",
-    "check:biome": "biome check . --formatter-enabled=true",
+    "check:biome": "biome check .",
     "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",
@@ -144,14 +149,15 @@
     "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",
-    "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
-    "ci:build:docs:current": "api-extractor run",
-    "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
+    "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
+    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
+    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
+    "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"*.d.ts\" bench/dist \"**/*.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": "npm run format:biome",
-    "format:biome": "biome check . --formatter-enabled=true --apply",
+    "format:biome": "biome check . --write",
     "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",

package/src/handlecache.ts

@@ -28,7 +28,7 @@ export class HandleCache implements IVectorConsumer<Handle> {
 	 * Returns the index of the given position in the 'handles' array as a Uint32.
 	 * (If the position is not in the array, returns an integer greater than 'handles.length').
 	 */
-	private getIndex(position: number) {
+	private getIndex(position: number): number {
 		return (position - this.start) >>> 0;
 	}
 
@@ -37,10 +37,10 @@ export class HandleCache implements IVectorConsumer<Handle> {
 	 * the result with 'isValidHandle(..)' to see if a handle has been allocated for
 	 * the given position.
 	 *
-	 * Throws a 'RangeError' if the provided 'position' is out-of-bounds wrt. the
+	 * @throws A 'RangeError' if the provided 'position' is out-of-bounds with regards to the
 	 * PermutationVector's length.
 	 */
-	public getHandle(position: number) {
+	public getHandle(position: number): Handle {
 		const index = this.getIndex(position);
 
 		// Perf: To encourage inlining, handling of the 'cacheMiss(..)' case has been extracted
@@ -50,25 +50,35 @@ export class HandleCache implements IVectorConsumer<Handle> {
 		//       checking that 'position' is in bounds until 'cacheMiss(..)'.  This yields an
 		//       ~40% speedup when the position is in the cache (node v12 x64).
 
-		return index < this.handles.length ? this.handles[index] : this.cacheMiss(position);
+		const handle = this.handles[index];
+		if (handle !== undefined) {
+			return handle;
+		}
+		return this.cacheMiss(position);
 	}
 
-	/** Update the cache when a handle has been allocated for a given position. */
-	public addHandle(position: number, handle: Handle) {
+	/**
+	 * Update the cache when a handle has been allocated for a given position.
+	 */
+	public addHandle(position: number, handle: Handle): void {
 		assert(isHandleValid(handle), 0x017 /* "Trying to add invalid handle!" */);
 
 		const index = this.getIndex(position);
 		if (index < this.handles.length) {
 			assert(
-				!isHandleValid(this.handles[index]),
+				// Non null asserting, above we checked that the index is less than the length.
+				// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+				!isHandleValid(this.handles[index]!),
 				0x018 /* "Trying to insert handle into position with already valid handle!" */,
 			);
 			this.handles[index] = handle;
 		}
 	}
 
-	/** Used by 'CacheMiss()' to retrieve handles for a range of positions. */
-	private getHandles(start: number, end: number) {
+	/**
+	 * Used by {@link HandleCache.cacheMiss} to retrieve handles for a range of positions.
+	 */
+	private getHandles(start: number, end: number): Handle[] {
 		// TODO: This can be accelerated substantially using 'walkSegments()'.  The only catch
 		//       is that
 
@@ -85,7 +95,7 @@ export class HandleCache implements IVectorConsumer<Handle> {
 		return handles;
 	}
 
-	private cacheMiss(position: number) {
+	private cacheMiss(position: number): Handle {
 		// Coercing 'position' to an Uint32 allows us to handle a negative 'position' value
 		// with the same logic that handles 'position' >= length.
 		const _position = position >>> 0;
@@ -98,16 +108,21 @@ export class HandleCache implements IVectorConsumer<Handle> {
 		//       the handle cache).
 
 		if (_position < this.start) {
-			this.handles = this.getHandles(_position, this.start).concat(this.handles);
+			this.handles = [...this.getHandles(_position, this.start), ...this.handles];
 			this.start = _position;
-			return this.handles[0];
+			// TODO why are we non null asserting here?
+			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+			return this.handles[0]!;
 		} else {
 			ensureRange(_position, this.vector.getLength());
 
-			this.handles = this.handles.concat(
-				this.getHandles(this.start + this.handles.length, _position + 1),
-			);
-			return this.handles[this.handles.length - 1];
+			this.handles = [
+				...this.handles,
+				...this.getHandles(this.start + this.handles.length, _position + 1),
+			];
+			// TODO why are we non null asserting here?
+			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+			return this.handles[this.handles.length - 1]!;
 		}
 	}
 

package/src/handletable.ts

@@ -9,7 +9,9 @@ export const enum Handle {
 	 */
 	none = 0,
 
-	/** Minimum valid handle. */
+	/**
+	 * Minimum valid handle.
+	 */
 	valid = 1,
 
 	/**
@@ -19,7 +21,7 @@ export const enum Handle {
 	unallocated = -0x80000000,
 }
 
-export const isHandleValid = (handle: Handle) => handle >= Handle.valid;
+export const isHandleValid = (handle: Handle): boolean => handle >= Handle.valid;
 
 /**
  * A handle table provides a fast mapping from an integer `handle` to a value `T`.
@@ -30,7 +32,7 @@ export class HandleTable<T> {
 	//       us to delay allocate the following slot in the array on the first allocation.
 	public constructor(private readonly handles: (Handle | T)[] = [1]) {}
 
-	public clear() {
+	public clear(): void {
 		// Restore the HandleTable's initial state by deleting all items in the handles array
 		// and then re-inserting the value '1' in the 0th slot.  (See comment at `handles` decl
 		// for explanation.)
@@ -62,7 +64,7 @@ export class HandleTable<T> {
 	/**
 	 * Allocates and returns the next available `count` handles.
 	 */
-	public allocateMany(count: Handle) {
+	public allocateMany(count: Handle): Uint32Array {
 		const handles = new Uint32Array(count);
 		for (let i = 0; i < count; i++) {
 			handles[i] = this.allocate();
@@ -73,7 +75,7 @@ export class HandleTable<T> {
 	/**
 	 * Returns the given handle to the free list.
 	 */
-	public free(handle: Handle) {
+	public free(handle: Handle): void {
 		this.handles[handle] = this.next;
 		this.next = handle;
 	}
@@ -88,24 +90,24 @@ export class HandleTable<T> {
 	/**
 	 * Set the value `T` associated with the given handle.
 	 */
-	public set(handle: Handle, value: T) {
+	public set(handle: Handle, value: T): void {
 		this.handles[handle] = value;
 	}
 
 	// Private helpers to get/set the head of the free list, which is stored in the 0th slot
 	// of the handle array.
-	private get next() {
+	private get next(): Handle {
 		return this.handles[0] as Handle;
 	}
 	private set next(handle: Handle) {
 		this.handles[0] = handle;
 	}
 
-	public getSummaryContent() {
+	public getSummaryContent(): (Handle | T)[] {
 		return this.handles;
 	}
 
-	public static load<T>(data: (Handle | T)[]) {
+	public static load<T>(data: (Handle | T)[]): HandleTable<T> {
 		return new HandleTable<T>(data);
 	}
 }