@fluidframework/matrix 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.0

package/dist/matrix-untrimmed.d.ts

@@ -0,0 +1,214 @@
+import { IChannel } from '@fluidframework/datastore-definitions';
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { IJSONSegment } from '@fluidframework/merge-tree';
+import { IMatrixConsumer } from '@tiny-calc/nano';
+import { IMatrixProducer } from '@tiny-calc/nano';
+import { IMatrixReader } from '@tiny-calc/nano';
+import { IMatrixWriter } from '@tiny-calc/nano';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { Serializable } from '@fluidframework/datastore-definitions';
+import { SharedObject } from '@fluidframework/shared-object-base';
+import { SummarySerializer } from '@fluidframework/shared-object-base';
+
+/**
+ * @alpha
+ */
+export declare interface IRevertible {
+    revert(): any;
+    discard(): any;
+}
+
+/**
+ * Events emitted by Shared Matrix.
+ * @alpha
+ */
+export declare interface ISharedMatrixEvents<T> extends ISharedObjectEvents {
+    /**
+     * This event is only emitted when the SetCell Resolution Policy is First Write Win(FWW).
+     * This is emitted when two clients race and send changes without observing each other changes,
+     * the changes that gets sequenced last would be rejected, and only client who's changes rejected
+     * would be notified via this event, with expectation that it will merge its changes back by
+     * accounting new information (state from winner of the race).
+     *
+     * @remarks Listener parameters:
+     *
+     * - `row` - Row number at which conflict happened.
+     *
+     * - `col` - Col number at which conflict happened.
+     *
+     * - `currentValue` - The current value of the cell.
+     *
+     * - `conflictingValue` - The value that this client tried to set in the cell and got ignored due to conflict.
+     *
+     * - `target` - The {@link SharedMatrix} itself.
+     */
+    (event: "conflict", listener: (row: number, col: number, currentValue: MatrixItem<T>, conflictingValue: MatrixItem<T>, target: IEventThisPlaceHolder) => void): any;
+}
+
+/**
+ * @alpha
+ */
+export declare interface IUndoConsumer {
+    pushToCurrentOperation(revertible: IRevertible): any;
+}
+
+/**
+ * A matrix cell value may be undefined (indicating an empty cell) or any serializable type,
+ * excluding null.  (However, nulls may be embedded inside objects and arrays.)
+ * @alpha
+ */
+export declare type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;
+
+/**
+ * A SharedMatrix holds a rectangular 2D array of values.  Supported operations
+ * include setting values and inserting/removing rows and columns.
+ *
+ * Matrix values may be any Fluid serializable type, which is the set of JSON
+ * serializable types extended to include IFluidHandles.
+ *
+ * Fluid's SharedMatrix implementation works equally well for dense and sparse
+ * matrix data and physically stores data in Z-order to leverage CPU caches and
+ * prefetching when reading in either row or column major order.  (See README.md
+ * for more details.)
+ * @alpha
+ */
+export declare class SharedMatrix<T = any> extends SharedObject<ISharedMatrixEvents<T>> implements IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>> {
+    id: string;
+    private readonly consumers;
+    static getFactory(): SharedMatrixFactory;
+    private readonly rows;
+    private readonly cols;
+    private cells;
+    private readonly pending;
+    private cellLastWriteTracker;
+    private setCellLwwToFwwPolicySwitchOpSeqNumber;
+    private userSwitchedSetCellPolicy;
+    private reentrantCount;
+    /**
+     * Constructor for the Shared Matrix
+     * @param runtime - DataStore runtime.
+     * @param id - id of the dds
+     * @param attributes - channel attributes
+     * @param _isSetCellConflictResolutionPolicyFWW - Conflict resolution for Matrix set op is First Writer Win in case of
+     * race condition. Client can still overwrite values in case of no race.
+     */
+    constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes, _isSetCellConflictResolutionPolicyFWW?: boolean);
+    private undo?;
+    /**
+     * Subscribes the given IUndoConsumer to the matrix.
+     */
+    openUndo(consumer: IUndoConsumer): void;
+    private get rowHandles();
+    private get colHandles();
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+     */
+    static create<T>(runtime: IFluidDataStoreRuntime, id?: string): SharedMatrix<T>;
+    openMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): IMatrixReader<MatrixItem<T>>;
+    closeMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): void;
+    get rowCount(): number;
+    get colCount(): number;
+    isSetCellConflictResolutionPolicyFWW(): boolean;
+    getCell(row: number, col: number): MatrixItem<T>;
+    get matrixProducer(): IMatrixProducer<MatrixItem<T>>;
+    setCell(row: number, col: number, value: MatrixItem<T>): void;
+    setCells(rowStart: number, colStart: number, colCount: number, values: readonly MatrixItem<T>[]): void;
+    private setCellCore;
+    private sendSetCellOp;
+    /**
+     * This makes sure that the code inside the callback is not reentrant. We need to do that because we raise notifications
+     * to the consumers telling about these changes and they can try to change the matrix while listening to those notifications
+     * which can make the shared matrix to be in bad state. For example, we are raising notification for a setCell changes and
+     * a consumer tries to delete that row/col on receiving that notification which can lead to this matrix trying to setCell in
+     * a deleted row/col.
+     * @param callback - code that needs to protected against reentrancy.
+     */
+    private protectAgainstReentrancy;
+    private submitVectorMessage;
+    private submitColMessage;
+    insertCols(colStart: number, count: number): void;
+    removeCols(colStart: number, count: number): void;
+    private submitRowMessage;
+    insertRows(rowStart: number, count: number): void;
+    removeRows(rowStart: number, count: number): void;
+    /***/ _undoRemoveRows(rowStart: number, spec: IJSONSegment): void;
+    /***/ _undoRemoveCols(colStart: number, spec: IJSONSegment): void;
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * Runs serializer on the GC data for this SharedMatrix.
+     * All the IFluidHandle's stored in the cells represent routes to other objects.
+     */
+    protected processGCDataCore(serializer: SummarySerializer): void;
+    /**
+     * Advances the 'localSeq' counter for the cell data operation currently being queued.
+     *
+     * Do not use with 'submitColMessage()/submitRowMessage()' as these helpers + the MergeTree will
+     * automatically advance 'localSeq'.
+     */
+    private nextLocalSeq;
+    protected submitLocalMessage(message: any, localOpMetadata?: any): void;
+    protected didAttach(): void;
+    protected onConnect(): void;
+    private rebasePosition;
+    protected reSubmitCore(content: any, localOpMetadata: unknown): void;
+    protected onDisconnect(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * Tells whether the setCell op should be applied or not based on First Write Win policy. It assumes
+     * we are in FWW mode.
+     */
+    private shouldSetCellBasedOnFWW;
+    protected processCore(rawMessage: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    private readonly onRowDelta;
+    private readonly onColDelta;
+    private readonly onRowHandlesRecycled;
+    private readonly onColHandlesRecycled;
+    /**
+     * Api to switch Set Op policy from Last Writer Win to First Writer Win. It only switches from LWW to FWW
+     * and not from FWW to LWW. The next SetOp which is sent will communicate this policy to other clients.
+     */
+    switchSetCellPolicy(): void;
+    /**
+     * Returns true if the latest pending write to the cell indicated by the given row/col handles
+     * matches the given 'localSeq'.
+     *
+     * A return value of `true` indicates that there are no later local operations queued that will
+     * clobber the write op at the given 'localSeq'.  This includes later ops that overwrite the cell
+     * with a different value as well as row/col removals that might recycled the given row/col handles.
+     */
+    private isLatestPendingWrite;
+    toString(): string;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(content: any): unknown;
+}
+
+/**
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMatrix}.
+ * @alpha
+ */
+export declare class SharedMatrixFactory implements IChannelFactory {
+    static Type: string;
+    static readonly Attributes: IChannelAttributes;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     */
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IChannel>;
+    create(document: IFluidDataStoreRuntime, id: string): IChannel;
+}
+
+export { }

package/dist/{matrix.js → matrix.cjs}

@@ -5,18 +5,19 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedMatrix = void 0;
+/* eslint-disable import/no-deprecated */
 const core_utils_1 = require("@fluidframework/core-utils");
 const shared_object_base_1 = require("@fluidframework/shared-object-base");
 const runtime_utils_1 = require("@fluidframework/runtime-utils");
 const merge_tree_1 = require("@fluidframework/merge-tree");
-const ops_1 = require("./ops");
-const permutationvector_1 = require("./permutationvector");
-const sparsearray2d_1 = require("./sparsearray2d");
-const runtime_1 = require("./runtime");
-const handletable_1 = require("./handletable");
-const serialization_1 = require("./serialization");
-const range_1 = require("./range");
-const undoprovider_1 = require("./undoprovider");
+const ops_1 = require("./ops.cjs");
+const permutationvector_1 = require("./permutationvector.cjs");
+const sparsearray2d_1 = require("./sparsearray2d.cjs");
+const runtime_1 = require("./runtime.cjs");
+const handletable_1 = require("./handletable.cjs");
+const serialization_1 = require("./serialization.cjs");
+const range_1 = require("./range.cjs");
+const undoprovider_1 = require("./undoprovider.cjs");
 /**
  * A SharedMatrix holds a rectangular 2D array of values.  Supported operations
  * include setting values and inserting/removing rows and columns.
@@ -28,19 +29,30 @@ const undoprovider_1 = require("./undoprovider");
  * matrix data and physically stores data in Z-order to leverage CPU caches and
  * prefetching when reading in either row or column major order.  (See README.md
  * for more details.)
- *
- * @public
+ * @alpha
  */
 class SharedMatrix extends shared_object_base_1.SharedObject {
     static getFactory() {
         return new runtime_1.SharedMatrixFactory();
     }
-    constructor(runtime, id, attributes) {
+    /**
+     * Constructor for the Shared Matrix
+     * @param runtime - DataStore runtime.
+     * @param id - id of the dds
+     * @param attributes - channel attributes
+     * @param _isSetCellConflictResolutionPolicyFWW - Conflict resolution for Matrix set op is First Writer Win in case of
+     * race condition. Client can still overwrite values in case of no race.
+     */
+    constructor(runtime, id, attributes, _isSetCellConflictResolutionPolicyFWW) {
         super(id, runtime, attributes, "fluid_matrix_");
         this.id = id;
         this.consumers = new Set();
         this.cells = new sparsearray2d_1.SparseArray2D(); // Stores cell values.
         this.pending = new sparsearray2d_1.SparseArray2D(); // Tracks pending writes.
+        this.cellLastWriteTracker = new sparsearray2d_1.SparseArray2D(); // Tracks last writes sequence number and clientId in a cell.
+        this.userSwitchedSetCellPolicy = false; // Set to true when the user calls switchPolicy.
+        // Used to track if there is any reentrancy in setCell code.
+        this.reentrantCount = 0;
         // Invoked by PermutationVector to notify IMatrixConsumers of row insertion/deletions.
         this.onRowDelta = (position, removedCount, insertedCount) => {
             for (const consumer of this.consumers) {
@@ -57,14 +69,18 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
             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);
             }
         };
         this.onColHandlesRecycled = (colHandles) => {
             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);
             }
         };
+        this.setCellLwwToFwwPolicySwitchOpSeqNumber =
+            _isSetCellConflictResolutionPolicyFWW === true ? 0 : -1;
         this.rows = new permutationvector_1.PermutationVector("rows" /* SnapshotPath.rows */, this.logger, runtime, this.onRowDelta, this.onRowHandlesRecycled);
         this.cols = new permutationvector_1.PermutationVector("cols" /* SnapshotPath.cols */, this.logger, runtime, this.onColDelta, this.onColHandlesRecycled);
     }
@@ -104,6 +120,9 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
     get colCount() {
         return this.cols.getLength();
     }
+    isSetCellConflictResolutionPolicyFWW() {
+        return this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1 || this.userSwitchedSetCellPolicy;
+    }
     getCell(row, col) {
         // Perf: When possible, bounds checking is performed inside the implementation for
         //       'getHandle()' so that it can be elided in the case of a cache hit.  This
@@ -130,10 +149,6 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
     setCell(row, col, value) {
         (0, core_utils_1.assert)(0 <= row && row < this.rowCount && 0 <= col && col < this.colCount, 0x01a /* "Trying to set out-of-bounds cell!" */);
         this.setCellCore(row, col, value);
-        // Avoid reentrancy by raising change notifications after the op is queued.
-        for (const consumer of this.consumers.values()) {
-            consumer.cellsChanged(row, col, 1, 1, this);
-        }
     }
     setCells(rowStart, colStart, colCount, values) {
         const rowCount = Math.ceil(values.length / colCount);
@@ -154,23 +169,25 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
                 r++;
             }
         }
-        // Avoid reentrancy by raising change notifications after the op is queued.
-        for (const consumer of this.consumers.values()) {
-            consumer.cellsChanged(rowStart, colStart, rowCount, colCount, this);
-        }
     }
     setCellCore(row, col, value, rowHandle = this.rows.getAllocatedHandle(row), colHandle = this.cols.getAllocatedHandle(col)) {
-        if (this.undo !== undefined) {
-            let oldValue = this.cells.getCell(rowHandle, colHandle);
-            if (oldValue === null) {
-                oldValue = undefined;
+        this.protectAgainstReentrancy(() => {
+            if (this.undo !== undefined) {
+                let oldValue = this.cells.getCell(rowHandle, colHandle);
+                if (oldValue === null) {
+                    oldValue = undefined;
+                }
+                this.undo.cellSet(rowHandle, colHandle, oldValue);
             }
-            this.undo.cellSet(rowHandle, colHandle, oldValue);
-        }
-        this.cells.setCell(rowHandle, colHandle, value);
-        if (this.isAttached()) {
-            this.sendSetCellOp(row, col, value, rowHandle, colHandle);
-        }
+            this.cells.setCell(rowHandle, colHandle, value);
+            if (this.isAttached()) {
+                this.sendSetCellOp(row, col, value, rowHandle, colHandle);
+            }
+            // Avoid reentrancy by raising change notifications after the op is queued.
+            for (const consumer of this.consumers.values()) {
+                consumer.cellsChanged(row, col, 1, 1, this);
+            }
+        });
     }
     sendSetCellOp(row, col, value, rowHandle, colHandle, localSeq = this.nextLocalSeq(), rowsRefSeq = this.rows.getCollabWindow().currentSeq, colsRefSeq = this.cols.getCollabWindow().currentSeq) {
         (0, core_utils_1.assert)(this.isAttached(), 0x1e2 /* "Caller must ensure 'isAttached()' before calling 'sendSetCellOp'." */);
@@ -179,6 +196,7 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
             row,
             col,
             value,
+            fwwMode: this.userSwitchedSetCellPolicy || this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1,
         };
         const metadata = {
             rowHandle,
@@ -186,10 +204,26 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
             localSeq,
             rowsRefSeq,
             colsRefSeq,
+            referenceSeqNumber: this.runtime.deltaManager.lastSequenceNumber,
         };
         this.submitLocalMessage(op, metadata);
         this.pending.setCell(rowHandle, colHandle, localSeq);
     }
+    /**
+     * This makes sure that the code inside the callback is not reentrant. We need to do that because we raise notifications
+     * to the consumers telling about these changes and they can try to change the matrix while listening to those notifications
+     * which can make the shared matrix to be in bad state. For example, we are raising notification for a setCell changes and
+     * a consumer tries to delete that row/col on receiving that notification which can lead to this matrix trying to setCell in
+     * a deleted row/col.
+     * @param callback - code that needs to protected against reentrancy.
+     */
+    protectAgainstReentrancy(callback) {
+        (0, core_utils_1.assert)(this.reentrantCount === 0, 0x85d /* reentrant code */);
+        this.reentrantCount++;
+        callback();
+        this.reentrantCount--;
+        (0, core_utils_1.assert)(this.reentrantCount === 0, 0x85e /* reentrant code on exit */);
+    }
     submitVectorMessage(currentVector, oppositeVector, dimension, message) {
         // Ideally, we would have a single 'localSeq' counter that is shared between both PermutationVectors
         // and the SharedMatrix's cell data.  Instead, we externally advance each MergeTree's 'localSeq' counter
@@ -212,21 +246,21 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
         this.submitVectorMessage(this.cols, this.rows, "cols" /* SnapshotPath.cols */, message);
     }
     insertCols(colStart, count) {
-        this.submitColMessage(this.cols.insert(colStart, count));
+        this.protectAgainstReentrancy(() => this.submitColMessage(this.cols.insert(colStart, count)));
     }
     removeCols(colStart, count) {
-        this.submitColMessage(this.cols.remove(colStart, count));
+        this.protectAgainstReentrancy(() => this.submitColMessage(this.cols.remove(colStart, count)));
     }
     submitRowMessage(message) {
         this.submitVectorMessage(this.rows, this.cols, "rows" /* SnapshotPath.rows */, message);
     }
     insertRows(rowStart, count) {
-        this.submitRowMessage(this.rows.insert(rowStart, count));
+        this.protectAgainstReentrancy(() => this.submitRowMessage(this.rows.insert(rowStart, count)));
     }
     removeRows(rowStart, count) {
-        this.submitRowMessage(this.rows.remove(rowStart, count));
+        this.protectAgainstReentrancy(() => this.submitRowMessage(this.rows.remove(rowStart, count)));
     }
-    /** @internal */ _undoRemoveRows(rowStart, spec) {
+    /***/ _undoRemoveRows(rowStart, spec) {
         const { op, inserted } = (0, permutationvector_1.reinsertSegmentIntoVector)(this.rows, rowStart, spec);
         this.submitRowMessage(op);
         // Generate setCell ops for each populated cell in the reinserted rows.
@@ -246,7 +280,7 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
             consumer.cellsChanged(rowStart, /* colStart: */ 0, rowCount, this.colCount, this);
         }
     }
-    /** @internal */ _undoRemoveCols(colStart, spec) {
+    /***/ _undoRemoveCols(colStart, spec) {
         const { op, inserted } = (0, permutationvector_1.reinsertSegmentIntoVector)(this.cols, colStart, spec);
         this.submitColMessage(op);
         // Generate setCell ops for each populated cell in the reinserted cols.
@@ -270,7 +304,16 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
         const builder = new runtime_utils_1.SummaryTreeBuilder();
         builder.addWithStats("rows" /* SnapshotPath.rows */, this.rows.summarize(this.runtime, this.handle, serializer));
         builder.addWithStats("cols" /* SnapshotPath.cols */, this.cols.summarize(this.runtime, this.handle, serializer));
-        builder.addBlob("cells" /* SnapshotPath.cells */, serializer.stringify([this.cells.snapshot(), this.pending.snapshot()], this.handle));
+        const artifactsToSummarize = [
+            this.cells.snapshot(),
+            this.pending.snapshot(),
+            this.setCellLwwToFwwPolicySwitchOpSeqNumber,
+        ];
+        // Only need to store it in the snapshot if we have switched the policy already.
+        if (this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1) {
+            artifactsToSummarize.push(this.cellLastWriteTracker.snapshot());
+        }
+        builder.addBlob("cells" /* SnapshotPath.cells */, serializer.stringify(artifactsToSummarize, this.handle));
         return builder.getSummaryTree();
     }
     /**
@@ -339,16 +382,27 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
             default: {
                 (0, core_utils_1.assert)(content.type === ops_1.MatrixOp.set, 0x020 /* "Unknown SharedMatrix 'op' type." */);
                 const setOp = content;
-                const { rowHandle, colHandle, localSeq, rowsRefSeq, colsRefSeq } = localOpMetadata;
-                // If there are more pending local writes to the same row/col handle, it is important
-                // to skip resubmitting this op since it is possible the row/col handle has been recycled
-                // and now refers to a different position than when this op was originally submitted.
-                if (this.isLatestPendingWrite(rowHandle, colHandle, localSeq)) {
-                    const row = this.rebasePosition(this.rows, setOp.row, rowsRefSeq, localSeq);
-                    const col = this.rebasePosition(this.cols, setOp.col, colsRefSeq, localSeq);
-                    if (row !== undefined && col !== undefined && row >= 0 && col >= 0) {
+                const { rowHandle, colHandle, localSeq, rowsRefSeq, colsRefSeq, referenceSeqNumber, } = localOpMetadata;
+                // If after rebasing the op, we get a valid row/col number, that means the row/col
+                // handles have not been recycled and we can safely use them.
+                const row = this.rebasePosition(this.rows, setOp.row, rowsRefSeq, localSeq);
+                const col = this.rebasePosition(this.cols, setOp.col, colsRefSeq, localSeq);
+                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.sendSetCellOp(row, col, setOp.value, rowHandle, colHandle, localSeq, rowsRefSeq, colsRefSeq);
                     }
+                    else if (this.pending.getCell(rowHandle, colHandle) !== undefined) {
+                        // Clear the pending changes if any as we are not sending the op.
+                        this.pending.setCell(rowHandle, colHandle, undefined);
+                    }
                 }
                 break;
             }
@@ -362,14 +416,32 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
         try {
             await this.rows.load(this.runtime, new runtime_utils_1.ObjectStoragePartition(storage, "rows" /* SnapshotPath.rows */), this.serializer);
             await this.cols.load(this.runtime, new runtime_utils_1.ObjectStoragePartition(storage, "cols" /* SnapshotPath.cols */), this.serializer);
-            const [cellData, pendingCliSeqData] = await (0, serialization_1.deserializeBlob)(storage, "cells" /* SnapshotPath.cells */, this.serializer);
+            const [cellData, _pendingCliSeqData, setCellLwwToFwwPolicySwitchOpSeqNumber, cellLastWriteTracker,] = await (0, serialization_1.deserializeBlob)(storage, "cells" /* SnapshotPath.cells */, this.serializer);
             this.cells = sparsearray2d_1.SparseArray2D.load(cellData);
-            this.pending = sparsearray2d_1.SparseArray2D.load(pendingCliSeqData);
+            this.setCellLwwToFwwPolicySwitchOpSeqNumber =
+                setCellLwwToFwwPolicySwitchOpSeqNumber ?? -1;
+            if (cellLastWriteTracker !== undefined) {
+                this.cellLastWriteTracker = sparsearray2d_1.SparseArray2D.load(cellLastWriteTracker);
+            }
         }
         catch (error) {
             this.logger.sendErrorEvent({ eventName: "MatrixLoadFailed" }, error);
         }
     }
+    /**
+     * Tells whether the setCell op should be applied or not based on First Write Win policy. It assumes
+     * we are in FWW mode.
+     */
+    shouldSetCellBasedOnFWW(rowHandle, colHandle, message) {
+        (0, core_utils_1.assert)(this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1, 0x85f /* should be in Fww mode when calling this method */);
+        (0, core_utils_1.assert)(message.clientId !== null, 0x860 /* clientId should not be null */);
+        const lastCellModificationDetails = this.cellLastWriteTracker.getCell(rowHandle, colHandle);
+        // If someone tried to Overwrite the cell value or first write on this cell or
+        // same client tried to modify the cell.
+        return (lastCellModificationDetails === undefined ||
+            lastCellModificationDetails.clientId === message.clientId ||
+            message.referenceSequenceNumber >= lastCellModificationDetails.seqNum);
+    }
     processCore(rawMessage, local, localOpMetadata) {
         const msg = (0, shared_object_base_1.parseHandles)(rawMessage, this.serializer);
         const contents = msg.contents;
@@ -382,13 +454,28 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
                 break;
             default: {
                 (0, core_utils_1.assert)(contents.type === ops_1.MatrixOp.set, 0x021 /* "SharedMatrix message contents have unexpected type!" */);
-                const { row, col } = contents;
+                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 = rawMessage.sequenceNumber;
+                }
+                (0, core_utils_1.assert)(rawMessage.clientId !== null, 0x861 /* clientId should not be null!! */);
                 if (local) {
                     // We are receiving the ACK for a local pending set operation.
                     const { rowHandle, colHandle, localSeq } = localOpMetadata;
-                    // If this is the most recent write to the cell by the local client, remove our
-                    // entry from 'pendingCliSeqs' to resume allowing remote writes.
-                    if (this.isLatestPendingWrite(rowHandle, colHandle, localSeq)) {
+                    const isLatestPendingOp = this.isLatestPendingWrite(rowHandle, colHandle, localSeq);
+                    // 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, rawMessage)) ||
+                        (this.setCellLwwToFwwPolicySwitchOpSeqNumber === -1 && isLatestPendingOp)) {
+                        this.cellLastWriteTracker.setCell(rowHandle, colHandle, {
+                            seqNum: rawMessage.sequenceNumber,
+                            clientId: rawMessage.clientId,
+                        });
+                    }
+                    if (isLatestPendingOp) {
                         this.pending.setCell(rowHandle, colHandle, undefined);
                     }
                 }
@@ -400,11 +487,39 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
                             const rowHandle = this.rows.getAllocatedHandle(adjustedRow);
                             const colHandle = this.cols.getAllocatedHandle(adjustedCol);
                             (0, core_utils_1.assert)((0, handletable_1.isHandleValid)(rowHandle) && (0, handletable_1.isHandleValid)(colHandle), 0x022 /* "SharedMatrix row and/or col handles are invalid!" */);
-                            // If there is a pending (unACKed) local write to the same cell, skip the current op
-                            // since it "happened before" the pending write.
-                            if (this.pending.getCell(rowHandle, colHandle) === undefined) {
-                                const { value } = contents;
+                            if (this.setCellLwwToFwwPolicySwitchOpSeqNumber > -1) {
+                                // 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, rawMessage)) {
+                                    const previousValue = this.cells.getCell(rowHandle, colHandle);
+                                    this.cells.setCell(rowHandle, colHandle, value);
+                                    this.cellLastWriteTracker.setCell(rowHandle, colHandle, {
+                                        seqNum: rawMessage.sequenceNumber,
+                                        clientId: rawMessage.clientId,
+                                    });
+                                    for (const consumer of this.consumers.values()) {
+                                        consumer.cellsChanged(adjustedRow, adjustedCol, 1, 1, this);
+                                    }
+                                    // Check is there are any pending changes, which will be rejected. If so raise conflict.
+                                    if (this.pending.getCell(rowHandle, colHandle) !== undefined) {
+                                        // Don't reset the pending value yet, as there maybe more fww op from same client, so we want
+                                        // to raise conflict event for that op also.
+                                        this.emit("conflict", row, col, value, // Current value
+                                        previousValue, // Ignored local value
+                                        this);
+                                    }
+                                }
+                            }
+                            else if (this.pending.getCell(rowHandle, colHandle) === undefined) {
+                                // 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: rawMessage.sequenceNumber,
+                                    clientId: rawMessage.clientId,
+                                });
                                 for (const consumer of this.consumers.values()) {
                                     consumer.cellsChanged(adjustedRow, adjustedCol, 1, 1, this);
                                 }
@@ -415,6 +530,20 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
             }
         }
     }
+    /**
+     * Api to switch Set Op policy from Last Writer Win to First Writer Win. It only switches from LWW to FWW
+     * and not from FWW to LWW. The next SetOp which is sent will communicate this policy to other clients.
+     */
+    switchSetCellPolicy() {
+        if (this.setCellLwwToFwwPolicySwitchOpSeqNumber === -1) {
+            if (this.isAttached()) {
+                this.userSwitchedSetCellPolicy = true;
+            }
+            else {
+                this.setCellLwwToFwwPolicySwitchOpSeqNumber = 0;
+            }
+        }
+    }
     /**
      * Returns true if the latest pending write to the cell indicated by the given row/col handles
      * matches the given 'localSeq'.
@@ -487,6 +616,7 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
                 localSeq,
                 rowsRefSeq,
                 colsRefSeq,
+                referenceSeqNumber: this.runtime.deltaManager.lastSequenceNumber,
             };
             this.pending.setCell(rowHandle, colHandle, localSeq);
             return metadata;
@@ -494,4 +624,4 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
     }
 }
 exports.SharedMatrix = SharedMatrix;
-//# sourceMappingURL=matrix.js.map
+//# sourceMappingURL=matrix.cjs.map