@fluidframework/matrix 2.41.0-338186 → 2.41.0

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/matrix";
-export const pkgVersion = "2.41.0-338186";
+export const pkgVersion = "2.41.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,wBAAwB,CAAC;AAChD,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/matrix\";\nexport const pkgVersion = \"2.41.0-338186\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,wBAAwB,CAAC;AAChD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/matrix\";\nexport const pkgVersion = \"2.41.0\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/matrix",
-  "version": "2.41.0-338186",
+  "version": "2.41.0",
   "description": "Distributed matrix",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -81,17 +81,17 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.41.0-338186",
-    "@fluidframework/core-interfaces": "2.41.0-338186",
-    "@fluidframework/core-utils": "2.41.0-338186",
-    "@fluidframework/datastore-definitions": "2.41.0-338186",
-    "@fluidframework/driver-definitions": "2.41.0-338186",
-    "@fluidframework/driver-utils": "2.41.0-338186",
-    "@fluidframework/merge-tree": "2.41.0-338186",
-    "@fluidframework/runtime-definitions": "2.41.0-338186",
-    "@fluidframework/runtime-utils": "2.41.0-338186",
-    "@fluidframework/shared-object-base": "2.41.0-338186",
-    "@fluidframework/telemetry-utils": "2.41.0-338186",
+    "@fluid-internal/client-utils": "~2.41.0",
+    "@fluidframework/core-interfaces": "~2.41.0",
+    "@fluidframework/core-utils": "~2.41.0",
+    "@fluidframework/datastore-definitions": "~2.41.0",
+    "@fluidframework/driver-definitions": "~2.41.0",
+    "@fluidframework/driver-utils": "~2.41.0",
+    "@fluidframework/merge-tree": "~2.41.0",
+    "@fluidframework/runtime-definitions": "~2.41.0",
+    "@fluidframework/runtime-utils": "~2.41.0",
+    "@fluidframework/shared-object-base": "~2.41.0",
+    "@fluidframework/telemetry-utils": "~2.41.0",
     "@tiny-calc/nano": "0.0.0-alpha.5",
     "double-ended-queue": "^2.1.0-0",
     "tslib": "^1.10.0"
@@ -99,17 +99,17 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "2.41.0-338186",
-    "@fluid-private/stochastic-test-utils": "2.41.0-338186",
-    "@fluid-private/test-dds-utils": "2.41.0-338186",
+    "@fluid-internal/mocha-test-setup": "~2.41.0",
+    "@fluid-private/stochastic-test-utils": "~2.41.0",
+    "@fluid-private/test-dds-utils": "~2.41.0",
     "@fluid-tools/benchmark": "^0.51.0",
     "@fluid-tools/build-cli": "^0.55.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.55.0",
-    "@fluidframework/container-definitions": "2.41.0-338186",
-    "@fluidframework/eslint-config-fluid": "^5.7.3",
+    "@fluidframework/container-definitions": "~2.41.0",
+    "@fluidframework/eslint-config-fluid": "^5.7.4",
     "@fluidframework/matrix-previous": "npm:@fluidframework/matrix@2.40.0",
-    "@fluidframework/test-runtime-utils": "2.41.0-338186",
+    "@fluidframework/test-runtime-utils": "~2.41.0",
     "@microsoft/api-extractor": "7.52.8",
     "@tiny-calc/micro": "0.0.0-alpha.5",
     "@types/double-ended-queue": "^2.1.0",

package/src/matrix.ts

@@ -204,6 +204,15 @@ export interface ISharedMatrix<T = any>
 	switchSetCellPolicy(): void;
 }
 
+type FirstWriterWinsPolicy =
+	| { state: "off" }
+	| { state: "local" }
+	| {
+			state: "on";
+			switchOpSeqNumber: number;
+			cellLastWriteTracker: SparseArray2D<CellLastWriteTrackerItem>;
+	  };
+
 /**
  * A SharedMatrix holds a rectangular 2D array of values.  Supported operations
  * include setting values and inserting/removing rows and columns.
@@ -244,10 +253,10 @@ export class SharedMatrix<T = any>
 
 	private cells = new SparseArray2D<MatrixItem<T>>(); // Stores cell values.
 	private readonly pending = new SparseArray2D<number>(); // Tracks pending writes.
-	private cellLastWriteTracker = new SparseArray2D<CellLastWriteTrackerItem>(); // Tracks last writes sequence number and clientId in a cell.
-	// Tracks the seq number of Op at which policy switch happens from Last Write Win to First Write Win.
-	private setCellLwwToFwwPolicySwitchOpSeqNumber: number;
-	private userSwitchedSetCellPolicy = false; // Set to true when the user calls switchPolicy.
+
+	private fwwPolicy: FirstWriterWinsPolicy = {
+		state: "off",
+	};
 
 	// Used to track if there is any reentrancy in setCell code.
 	private reentrantCount: number = 0;
@@ -267,7 +276,6 @@ export class SharedMatrix<T = any>
 	) {
 		super(id, runtime, attributes, "fluid_matrix_");
 
-		this.setCellLwwToFwwPolicySwitchOpSeqNumber = -1;
 		this.rows = new PermutationVector(
 			SnapshotPath.rows,
 			this.logger,
@@ -333,7 +341,7 @@ export class SharedMatrix<T = any>
 	}
 
 	public isSetCellConflictResolutionPolicyFWW(): boolean {
-		return this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1 || this.userSwitchedSetCellPolicy;
+		return this.fwwPolicy.state !== "off";
 	}
 
 	public getCell(row: number, col: number): MatrixItem<T> {
@@ -470,8 +478,7 @@ export class SharedMatrix<T = any>
 			row,
 			col,
 			value,
-			fwwMode:
-				this.userSwitchedSetCellPolicy || this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1,
+			fwwMode: this.fwwPolicy.state !== "off",
 		};
 
 		const rowsRef = this.createOpMetadataLocalRef(this.rows, row, localSeq);
@@ -668,15 +675,29 @@ export class SharedMatrix<T = any>
 			SnapshotPath.cols,
 			this.cols.summarize(this.runtime, this.handle, serializer),
 		);
-		const artifactsToSummarize = [
-			this.cells.snapshot(),
-			this.pending.snapshot(),
-			this.setCellLwwToFwwPolicySwitchOpSeqNumber,
-		];
+		const artifactsToSummarize: (
+			| undefined
+			| number
+			| ReturnType<SparseArray2D<MatrixItem<T> | number>["snapshot"]>
+		)[] = [this.cells.snapshot(), this.pending.snapshot()];
 
 		// Only need to store it in the snapshot if we have switched the policy already.
-		if (this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1) {
-			artifactsToSummarize.push(this.cellLastWriteTracker.snapshot());
+		if (this.fwwPolicy.state === "on") {
+			artifactsToSummarize.push(
+				this.fwwPolicy.switchOpSeqNumber,
+				this.fwwPolicy.cellLastWriteTracker.snapshot(),
+			);
+		} else {
+			// back-compat:  used -1 for disabled
+			artifactsToSummarize.push(
+				-1,
+				/*
+				 * we should set undefined in place of cellLastWriteTracker to ensure the number of array entries is consistent.
+				 * Doing that currently breaks snapshot tests. Its is probably fine, but if new elements are ever added, we need
+				 * ensure undefined is also set.
+				 */
+				// undefined
+			);
 		}
 		builder.addBlob(
 			SnapshotPath.cells,
@@ -786,19 +807,15 @@ export class SharedMatrix<T = any>
 			this.rows.removeLocalReferencePosition(rowsRef);
 			this.cols.removeLocalReferencePosition(colsRef);
 			if (row !== undefined && col !== undefined && row >= 0 && col >= 0) {
-				const lastCellModificationDetails = this.cellLastWriteTracker.getCell(
-					rowHandle,
-					colHandle,
-				);
 				// If the mode is LWW, then send the op.
 				// Otherwise if the current mode is FWW and if we generated this op, after seeing the
 				// last set op, or it is the first set op for the cell, then regenerate the op,
 				// otherwise raise conflict. We want to check the current mode here and not that
 				// whether op was made in FWW or not.
 				if (
-					this.setCellLwwToFwwPolicySwitchOpSeqNumber === -1 ||
-					lastCellModificationDetails === undefined ||
-					referenceSeqNumber >= lastCellModificationDetails.seqNum
+					this.fwwPolicy.state !== "on" ||
+					referenceSeqNumber >=
+						(this.fwwPolicy.cellLastWriteTracker.getCell(rowHandle, colHandle)?.seqNum ?? 0)
 				) {
 					this.sendSetCellOp(row, col, setOp.value, rowHandle, colHandle, localSeq);
 				} else if (this.pending.getCell(rowHandle, colHandle) !== undefined) {
@@ -854,11 +871,21 @@ export class SharedMatrix<T = any>
 			];
 
 			this.cells = SparseArray2D.load(cellData);
-			this.setCellLwwToFwwPolicySwitchOpSeqNumber =
-				setCellLwwToFwwPolicySwitchOpSeqNumber ?? -1;
-			if (cellLastWriteTracker !== undefined) {
-				this.cellLastWriteTracker = SparseArray2D.load(cellLastWriteTracker);
-			}
+			// back-compat:  used -1 for disabled, also may not exist
+			const switchOpSeqNumber =
+				setCellLwwToFwwPolicySwitchOpSeqNumber === -1
+					? undefined
+					: (setCellLwwToFwwPolicySwitchOpSeqNumber ?? undefined);
+			this.fwwPolicy =
+				switchOpSeqNumber === undefined
+					? {
+							state: "off",
+						}
+					: {
+							state: "on",
+							switchOpSeqNumber,
+							cellLastWriteTracker: SparseArray2D.load(cellLastWriteTracker),
+						};
 		} catch (error) {
 			this.logger.sendErrorEvent({ eventName: "MatrixLoadFailed" }, error);
 		}
@@ -874,11 +901,11 @@ export class SharedMatrix<T = any>
 		message: ISequencedDocumentMessage,
 	): boolean {
 		assert(
-			this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1,
+			this.fwwPolicy.state === "on",
 			0x85f /* should be in Fww mode when calling this method */,
 		);
 		assert(message.clientId !== null, 0x860 /* clientId should not be null */);
-		const lastCellModificationDetails = this.cellLastWriteTracker.getCell(
+		const lastCellModificationDetails = this.fwwPolicy.cellLastWriteTracker.getCell(
 			rowHandle,
 			colHandle,
 		);
@@ -927,11 +954,13 @@ export class SharedMatrix<T = any>
 				);
 
 				const { row, col, value, fwwMode } = contents;
-				const isPreviousSetCellPolicyModeFWW =
-					this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1;
 				// If this is the first op notifying us of the policy change, then set the policy change seq number.
-				if (this.setCellLwwToFwwPolicySwitchOpSeqNumber === -1 && fwwMode === true) {
-					this.setCellLwwToFwwPolicySwitchOpSeqNumber = msg.sequenceNumber;
+				if (fwwMode === true && this.fwwPolicy.state !== "on") {
+					this.fwwPolicy = {
+						state: "on",
+						switchOpSeqNumber: msg.sequenceNumber,
+						cellLastWriteTracker: new SparseArray2D(),
+					};
 				}
 
 				assert(msg.clientId !== null, 0x861 /* clientId should not be null!! */);
@@ -945,11 +974,10 @@ export class SharedMatrix<T = any>
 					// If policy is switched and cell should be modified too based on policy, then update the tracker.
 					// If policy is not switched, then also update the tracker in case it is the latest.
 					if (
-						(this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1 &&
-							this.shouldSetCellBasedOnFWW(rowHandle, colHandle, msg)) ||
-						(this.setCellLwwToFwwPolicySwitchOpSeqNumber === -1 && isLatestPendingOp)
+						this.fwwPolicy.state === "on" &&
+						this.shouldSetCellBasedOnFWW(rowHandle, colHandle, msg)
 					) {
-						this.cellLastWriteTracker.setCell(rowHandle, colHandle, {
+						this.fwwPolicy.cellLastWriteTracker.setCell(rowHandle, colHandle, {
 							seqNum: msg.sequenceNumber,
 							clientId: msg.clientId,
 						});
@@ -971,17 +999,14 @@ export class SharedMatrix<T = any>
 								isHandleValid(rowHandle) && isHandleValid(colHandle),
 								0x022 /* "SharedMatrix row and/or col handles are invalid!" */,
 							);
-							if (this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1) {
+							if (this.fwwPolicy.state === "on") {
 								// If someone tried to Overwrite the cell value or first write on this cell or
 								// same client tried to modify the cell or if the previous mode was LWW, then we need to still
 								// overwrite the cell and raise conflict if we have pending changes as our change is going to be lost.
-								if (
-									!isPreviousSetCellPolicyModeFWW ||
-									this.shouldSetCellBasedOnFWW(rowHandle, colHandle, msg)
-								) {
+								if (this.shouldSetCellBasedOnFWW(rowHandle, colHandle, msg)) {
 									const previousValue = this.cells.getCell(rowHandle, colHandle);
 									this.cells.setCell(rowHandle, colHandle, value);
-									this.cellLastWriteTracker.setCell(rowHandle, colHandle, {
+									this.fwwPolicy.cellLastWriteTracker.setCell(rowHandle, colHandle, {
 										seqNum: msg.sequenceNumber,
 										clientId: msg.clientId,
 									});
@@ -1006,10 +1031,6 @@ export class SharedMatrix<T = any>
 								// If there is a pending (unACKed) local write to the same cell, skip the current op
 								// since it "happened before" the pending write.
 								this.cells.setCell(rowHandle, colHandle, value);
-								this.cellLastWriteTracker.setCell(rowHandle, colHandle, {
-									seqNum: msg.sequenceNumber,
-									clientId: msg.clientId,
-								});
 								for (const consumer of this.consumers.values()) {
 									consumer.cellsChanged(adjustedRow, adjustedCol, 1, 1, this);
 								}
@@ -1051,7 +1072,12 @@ export class SharedMatrix<T = any>
 		for (const rowHandle of rowHandles) {
 			this.cells.clearRows(/* rowStart: */ rowHandle, /* rowCount: */ 1);
 			this.pending.clearRows(/* rowStart: */ rowHandle, /* rowCount: */ 1);
-			this.cellLastWriteTracker.clearRows(/* rowStart: */ rowHandle, /* rowCount: */ 1);
+			if (this.fwwPolicy.state === "on") {
+				this.fwwPolicy.cellLastWriteTracker?.clearRows(
+					/* rowStart: */ rowHandle,
+					/* rowCount: */ 1,
+				);
+			}
 		}
 	};
 
@@ -1059,17 +1085,24 @@ export class SharedMatrix<T = any>
 		for (const colHandle of colHandles) {
 			this.cells.clearCols(/* colStart: */ colHandle, /* colCount: */ 1);
 			this.pending.clearCols(/* colStart: */ colHandle, /* colCount: */ 1);
-			this.cellLastWriteTracker.clearCols(/* colStart: */ colHandle, /* colCount: */ 1);
+			if (this.fwwPolicy.state === "on") {
+				this.fwwPolicy.cellLastWriteTracker?.clearCols(
+					/* colStart: */ colHandle,
+					/* colCount: */ 1,
+				);
+			}
 		}
 	};
 
 	public switchSetCellPolicy(): void {
-		if (this.setCellLwwToFwwPolicySwitchOpSeqNumber === -1) {
-			if (this.isAttached()) {
-				this.userSwitchedSetCellPolicy = true;
-			} else {
-				this.setCellLwwToFwwPolicySwitchOpSeqNumber = 0;
-			}
+		if (this.fwwPolicy.state === "off") {
+			this.fwwPolicy = this.isAttached()
+				? { state: "local" }
+				: {
+						state: "on",
+						switchOpSeqNumber: 0,
+						cellLastWriteTracker: new SparseArray2D(),
+					};
 		}
 	}
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/matrix";
-export const pkgVersion = "2.41.0-338186";
+export const pkgVersion = "2.41.0";