@fluidframework/matrix 2.0.0-internal.4.3.0 → 2.0.0-internal.5.0.0

package/lib/undoprovider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"undoprovider.d.ts","sourceRoot":"","sources":["../src/undoprovider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEN,2BAA2B,EAG3B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,MAAM,EAAiB,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,qBAAa,kBAAkB;IAQ7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAN5B,OAAO,CAAC,YAAY,CAAC,CAAgB;IACrC,OAAO,CAAC,SAAS,CAAC,CAAqB;gBAGrB,OAAO,EAAE,aAAa,EACtB,UAAU,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,EACjD,UAAU,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI;IAG5D,MAAM,CACZ,SAAS,EAAE,2BAA2B,EACtC,MAAM,EAAE;QAAE,OAAO,EAAE,kBAAkB,CAAA;KAAE,EAAE;IAuD1C,OAAO,CAAC,cAAc;CAwCtB;AAED,qBAAa,kBAAkB,CAAC,CAAC;IAE/B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAHJ,QAAQ,EAAE,aAAa,EACvB,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,IAAI,EAAE,iBAAiB,EACvB,IAAI,EAAE,iBAAiB;IA4BzC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;CAoBrE"}
+{"version":3,"file":"undoprovider.d.ts","sourceRoot":"","sources":["../src/undoprovider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAGN,2BAA2B,EAG3B,yBAAyB,EAIzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,MAAM,EAAiB,MAAM,eAAe,CAAC;AACtD,OAAO,EAAsB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,qBAAa,kBAAkB;IAS7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IANxB,OAAO,CAAC,YAAY,CAAC,CAA6B;IAClD,OAAO,CAAC,SAAS,CAAC,CAAqB;IACvC,OAAO,CAAC,0BAA0B,CAAC,CAAgB;gBAGjC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,yBAAyB;IAG5C,MAAM,CAAC,SAAS,EAAE,2BAA2B;IAuDpD,OAAO,CAAC,cAAc;CAgDtB;AAED,qBAAa,kBAAkB,CAAC,CAAC;IAE/B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAHJ,QAAQ,EAAE,aAAa,EACvB,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,IAAI,EAAE,iBAAiB,EACvB,IAAI,EAAE,iBAAiB;IA0BzC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;CAoBrE"}

package/lib/undoprovider.js

@@ -3,48 +3,47 @@
  * Licensed under the MIT License.
  */
 import { assert } from "@fluidframework/common-utils";
-import { TrackingGroup, MergeTreeDeltaType, toRemovalInfo, } from "@fluidframework/merge-tree";
+import { MergeTreeDeltaType, appendToMergeTreeDeltaRevertibles, revertMergeTreeDeltaRevertibles, discardMergeTreeDeltaRevertible, TrackingGroup, } from "@fluidframework/merge-tree";
 import { isHandleValid } from "./handletable";
 export class VectorUndoProvider {
-    constructor(manager, undoInsert, undoRemove) {
+    constructor(manager, driver) {
         this.manager = manager;
-        this.undoInsert = undoInsert;
-        this.undoRemove = undoRemove;
+        this.driver = driver;
     }
-    record(operation, ranges) {
-        var _a;
-        if (ranges.length > 0) {
-            // Link each segment to a new TrackingGroup.  A TrackingGroup keeps track of the original
-            // set of linked segments, including any fragmentatiton that occurs due to future splitting.
-            //
-            // A TrackingGroup also prevents removed segments from being unlinked from the tree during
-            // Zamboni and guarantees segments will not be merged/coalesced with segments outside of the
-            // current tracking group.
-            //
-            // These properties allow us to rely on MergeTree.getPosition() to find the locations/lengths
-            // of all content contained within the tracking group in the future.
+    record(deltaArgs) {
+        var _a, _b, _c, _d;
+        if (deltaArgs.deltaSegments.length > 0) {
             // If we are in the process of reverting, the `IRevertible.revert()` will provide the tracking
             // group so that we can preserve the original segment ranges as a single op/group as we move
             // ops between the undo <-> redo stacks.
-            const trackingGroup = (_a = this.currentGroup) !== null && _a !== void 0 ? _a : new TrackingGroup();
-            for (const range of ranges) {
-                trackingGroup.link(range.segment);
-            }
+            const revertibles = (_a = this.currentGroup) !== null && _a !== void 0 ? _a : [];
+            appendToMergeTreeDeltaRevertibles(deltaArgs, revertibles);
             // For SharedMatrix, each IRevertibles always holds a single row/col operation.
             // Therefore, 'currentOp' must either be undefined or equal to the current op.
-            assert(this.currentOp === undefined || this.currentOp === operation, 0x02a /* "On vector undo, unexpected 'currentOp' type/state!" */);
-            switch (operation) {
+            assert(this.currentOp === undefined || this.currentOp === deltaArgs.operation, 0x02a /* "On vector undo, unexpected 'currentOp' type/state!" */);
+            let removeTrackingGroup;
+            if (deltaArgs.operation === MergeTreeDeltaType.REMOVE) {
+                // for removed segment we need a tracking group.
+                // this is for a few reason:
+                // 1. the handle for the row/column on the removed segment is still allocated,
+                //		and needs to be in order to process unacked ops sent before the remove.
+                // 2. handles are freed on unlink(zamboni), but that also clears the row/column data.
+                //		which we don't want to happen, so we can re-insert the cells when the row/col comes back.
+                //		the tracking group prevents unlink.
+                // 3. when we re-insert we need to find the old segment and clear their handles
+                //		so the new segment takes them over. there is no efficient look-up for this.
+                //		the tracking group provides one.
+                const trackingGroup = (removeTrackingGroup =
+                    (_b = this.currentRemoveTrackingGroup) !== null && _b !== void 0 ? _b : new TrackingGroup());
+                deltaArgs.deltaSegments.forEach((d) => d.segment.trackingCollection.link(trackingGroup));
+            }
+            switch (deltaArgs.operation) {
+                case MergeTreeDeltaType.REMOVE:
                 case MergeTreeDeltaType.INSERT:
-                    if (this.currentOp !== MergeTreeDeltaType.INSERT) {
-                        this.pushRevertible(trackingGroup, this.undoInsert);
-                    }
-                    break;
-                case MergeTreeDeltaType.REMOVE: {
-                    if (this.currentOp !== MergeTreeDeltaType.REMOVE) {
-                        this.pushRevertible(trackingGroup, this.undoRemove);
+                    if (this.currentOp !== deltaArgs.operation) {
+                        this.pushRevertible(revertibles, removeTrackingGroup);
                     }
                     break;
-                }
                 default:
                     throw new Error("operation type not revertible");
             }
@@ -52,38 +51,49 @@ export class VectorUndoProvider {
             // another revertible until `IRevertable.revert()` finishes the current op and clears this
             // field.
             if (this.currentGroup !== undefined) {
-                this.currentOp = operation;
+                (_c = this.currentOp) !== null && _c !== void 0 ? _c : (this.currentOp = deltaArgs.operation);
+                (_d = this.currentRemoveTrackingGroup) !== null && _d !== void 0 ? _d : (this.currentRemoveTrackingGroup = removeTrackingGroup);
             }
         }
     }
-    pushRevertible(trackingGroup, callback) {
-        const revertible = {
+    pushRevertible(revertibles, removedTrackingGroup) {
+        const reverter = {
             revert: () => {
                 assert(this.currentGroup === undefined && this.currentOp === undefined, 0x02b /* "Must not nest calls to IRevertible.revert()" */);
-                this.currentGroup = new TrackingGroup();
+                this.currentGroup = [];
                 try {
-                    while (trackingGroup.size > 0) {
-                        const segment = trackingGroup.segments[0];
-                        // Unlink 'segment' from the current tracking group before invoking the callback
-                        // to exclude the current undo/redo segment from those copied to the replacement
-                        // segment (if any). (See 'PermutationSegment.transferToReplacement()')
-                        segment.trackingCollection.unlink(trackingGroup);
-                        callback(segment);
+                    if (removedTrackingGroup !== undefined) {
+                        while (removedTrackingGroup.size > 0) {
+                            const tracked = removedTrackingGroup.tracked[0];
+                            removedTrackingGroup.unlink(tracked);
+                            // if there are groups tracked, this in a revert of a remove.
+                            // this means we are about to re-insert the row/column
+                            // with the same handle. We reuse the handle so the row/columns cells
+                            // get re-inserted too.
+                            // since a new segment will have the handle, we need to
+                            // remove it from the  removed segment which was tracked
+                            tracked.reset();
+                        }
                     }
+                    revertMergeTreeDeltaRevertibles(this.driver, revertibles);
                 }
                 finally {
                     this.currentOp = undefined;
                     this.currentGroup = undefined;
+                    this.currentRemoveTrackingGroup = undefined;
                 }
             },
             discard: () => {
-                while (trackingGroup.size > 0) {
-                    trackingGroup.unlink(trackingGroup.segments[0]);
+                if (removedTrackingGroup !== undefined) {
+                    while (removedTrackingGroup.size > 0) {
+                        removedTrackingGroup.unlink(removedTrackingGroup.tracked[0]);
+                    }
                 }
+                discardMergeTreeDeltaRevertible(revertibles);
             },
         };
-        this.manager.pushToCurrentOperation(revertible);
-        return revertible;
+        this.manager.pushToCurrentOperation(reverter);
+        return reverter;
     }
 }
 export class MatrixUndoProvider {
@@ -92,25 +102,27 @@ export class MatrixUndoProvider {
         this.matrix = matrix;
         this.rows = rows;
         this.cols = cols;
-        rows.undo = new VectorUndoProvider(consumer, 
-        /* undoInsert: */ (segment) => {
-            if (toRemovalInfo(segment) === undefined) {
-                const start = this.rows.getPosition(segment);
-                this.matrix.removeRows(start, segment.cachedLength);
-            }
-        }, 
-        /* undoRemove: */ (segment) => {
-            this.matrix._undoRemoveRows(segment);
+        rows.undo = new VectorUndoProvider(consumer, {
+            annotateRange() {
+                throw new Error("not implemented");
+            },
+            insertFromSpec(pos, spec) {
+                matrix._undoRemoveRows(pos, spec);
+            },
+            removeRange(start, end) {
+                matrix.removeRows(start, end - start);
+            },
         });
-        cols.undo = new VectorUndoProvider(consumer, 
-        /* undoInsert: */ (segment) => {
-            if (toRemovalInfo(segment) === undefined) {
-                const start = this.cols.getPosition(segment);
-                this.matrix.removeCols(start, segment.cachedLength);
-            }
-        }, 
-        /* undoRemove: */ (segment) => {
-            this.matrix._undoRemoveCols(segment);
+        cols.undo = new VectorUndoProvider(consumer, {
+            annotateRange() {
+                throw new Error("not implemented");
+            },
+            insertFromSpec(pos, spec) {
+                matrix._undoRemoveCols(pos, spec);
+            },
+            removeRange(start, end) {
+                matrix.removeCols(start, end - start);
+            },
         });
     }
     cellSet(rowHandle, colHandle, oldValue) {

package/lib/undoprovider.js.map

@@ -1 +1 @@
-{"version":3,"file":"undoprovider.js","sourceRoot":"","sources":["../src/undoprovider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EACN,aAAa,EAEb,kBAAkB,EAClB,aAAa,GACb,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAU,aAAa,EAAE,MAAM,eAAe,CAAC;AAItD,MAAM,OAAO,kBAAkB;IAO9B,YACkB,OAAsB,EACtB,UAAiD,EACjD,UAAiD;QAFjD,YAAO,GAAP,OAAO,CAAe;QACtB,eAAU,GAAV,UAAU,CAAuC;QACjD,eAAU,GAAV,UAAU,CAAuC;IAChE,CAAC;IAEG,MAAM,CACZ,SAAsC,EACtC,MAAyC;;QAEzC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,yFAAyF;YACzF,4FAA4F;YAC5F,EAAE;YACF,0FAA0F;YAC1F,4FAA4F;YAC5F,0BAA0B;YAC1B,EAAE;YACF,6FAA6F;YAC7F,oEAAoE;YAEpE,8FAA8F;YAC9F,4FAA4F;YAC5F,wCAAwC;YACxC,MAAM,aAAa,GAAG,MAAA,IAAI,CAAC,YAAY,mCAAI,IAAI,aAAa,EAAE,CAAC;YAC/D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;gBAC3B,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAClC;YAED,+EAA+E;YAC/E,8EAA8E;YAC9E,MAAM,CACL,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAC5D,KAAK,CAAC,0DAA0D,CAChE,CAAC;YAEF,QAAQ,SAAS,EAAE;gBAClB,KAAK,kBAAkB,CAAC,MAAM;oBAC7B,IAAI,IAAI,CAAC,SAAS,KAAK,kBAAkB,CAAC,MAAM,EAAE;wBACjD,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;qBACpD;oBACD,MAAM;gBAEP,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAC;oBAC/B,IAAI,IAAI,CAAC,SAAS,KAAK,kBAAkB,CAAC,MAAM,EAAE;wBACjD,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;qBACpD;oBACD,MAAM;iBACN;gBAED;oBACC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;aAClD;YAED,yFAAyF;YACzF,0FAA0F;YAC1F,SAAS;YACT,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;gBACpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;aAC3B;SACD;IACF,CAAC;IAEO,cAAc,CACrB,aAA4B,EAC5B,QAA+C;QAE/C,MAAM,UAAU,GAAG;YAClB,MAAM,EAAE,GAAG,EAAE;gBACZ,MAAM,CACL,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAC/D,KAAK,CAAC,mDAAmD,CACzD,CAAC;gBAEF,IAAI,CAAC,YAAY,GAAG,IAAI,aAAa,EAAE,CAAC;gBAExC,IAAI;oBACH,OAAO,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;wBAC9B,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAuB,CAAC;wBAEhE,gFAAgF;wBAChF,gFAAgF;wBAChF,uEAAuE;wBACvE,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;wBAEjD,QAAQ,CAAC,OAAO,CAAC,CAAC;qBAClB;iBACD;wBAAS;oBACT,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;oBAC3B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;iBAC9B;YACF,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACb,OAAO,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;oBAC9B,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;iBAChD;YACF,CAAC;SACD,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAEhD,OAAO,UAAU,CAAC;IACnB,CAAC;CACD;AAED,MAAM,OAAO,kBAAkB;IAC9B,YACkB,QAAuB,EACvB,MAAuB,EACvB,IAAuB,EACvB,IAAuB;QAHvB,aAAQ,GAAR,QAAQ,CAAe;QACvB,WAAM,GAAN,MAAM,CAAiB;QACvB,SAAI,GAAJ,IAAI,CAAmB;QACvB,SAAI,GAAJ,IAAI,CAAmB;QAExC,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAkB,CACjC,QAAQ;QACR,iBAAiB,CAAC,CAAC,OAA2B,EAAE,EAAE;YACjD,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;gBACzC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAC7C,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;aACpD;QACF,CAAC;QACD,iBAAiB,CAAC,CAAC,OAA2B,EAAE,EAAE;YACjD,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC,CACD,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAkB,CACjC,QAAQ;QACR,iBAAiB,CAAC,CAAC,OAA2B,EAAE,EAAE;YACjD,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;gBACzC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAC7C,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;aACpD;QACF,CAAC;QACD,iBAAiB,CAAC,CAAC,OAA2B,EAAE,EAAE;YACjD,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC,CACD,CAAC;IACH,CAAC;IAED,OAAO,CAAC,SAAiB,EAAE,SAAiB,EAAE,QAAuB;QACpE,MAAM,CACL,aAAa,CAAC,SAAS,CAAC,IAAI,aAAa,CAAC,SAAS,CAAC,EACpD,KAAK,CAAC,wDAAwD,CAC9D,CAAC;QAEF,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC;gBACpC,MAAM,EAAE,GAAG,EAAE;oBACZ,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;oBAClD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;oBAClD,6DAA6D;oBAC7D,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;wBAC7D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;qBACxC;gBACF,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC;aACjB,CAAC,CAAC;SACH;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n\tTrackingGroup,\n\tMergeTreeDeltaOperationType,\n\tMergeTreeDeltaType,\n\ttoRemovalInfo,\n} from \"@fluidframework/merge-tree\";\nimport { MatrixItem, SharedMatrix } from \"./matrix\";\nimport { Handle, isHandleValid } from \"./handletable\";\nimport { PermutationSegment, PermutationVector } from \"./permutationvector\";\nimport { IUndoConsumer } from \"./types\";\n\nexport class VectorUndoProvider {\n\t// 'currentGroup' and 'currentOp' are used while applying an IRevertable.revert() to coalesce\n\t// the recorded into a single IRevertable / tracking group as they move between the undo <->\n\t// redo stacks.\n\tprivate currentGroup?: TrackingGroup;\n\tprivate currentOp?: MergeTreeDeltaType;\n\n\tconstructor(\n\t\tprivate readonly manager: IUndoConsumer,\n\t\tprivate readonly undoInsert: (segment: PermutationSegment) => void,\n\t\tprivate readonly undoRemove: (segment: PermutationSegment) => void,\n\t) {}\n\n\tpublic record(\n\t\toperation: MergeTreeDeltaOperationType,\n\t\tranges: { segment: PermutationSegment }[],\n\t) {\n\t\tif (ranges.length > 0) {\n\t\t\t// Link each segment to a new TrackingGroup.  A TrackingGroup keeps track of the original\n\t\t\t// set of linked segments, including any fragmentatiton that occurs due to future splitting.\n\t\t\t//\n\t\t\t// A TrackingGroup also prevents removed segments from being unlinked from the tree during\n\t\t\t// Zamboni and guarantees segments will not be merged/coalesced with segments outside of the\n\t\t\t// current tracking group.\n\t\t\t//\n\t\t\t// These properties allow us to rely on MergeTree.getPosition() to find the locations/lengths\n\t\t\t// of all content contained within the tracking group in the future.\n\n\t\t\t// If we are in the process of reverting, the `IRevertible.revert()` will provide the tracking\n\t\t\t// group so that we can preserve the original segment ranges as a single op/group as we move\n\t\t\t// ops between the undo <-> redo stacks.\n\t\t\tconst trackingGroup = this.currentGroup ?? new TrackingGroup();\n\t\t\tfor (const range of ranges) {\n\t\t\t\ttrackingGroup.link(range.segment);\n\t\t\t}\n\n\t\t\t// For SharedMatrix, each IRevertibles always holds a single row/col operation.\n\t\t\t// Therefore, 'currentOp' must either be undefined or equal to the current op.\n\t\t\tassert(\n\t\t\t\tthis.currentOp === undefined || this.currentOp === operation,\n\t\t\t\t0x02a /* \"On vector undo, unexpected 'currentOp' type/state!\" */,\n\t\t\t);\n\n\t\t\tswitch (operation) {\n\t\t\t\tcase MergeTreeDeltaType.INSERT:\n\t\t\t\t\tif (this.currentOp !== MergeTreeDeltaType.INSERT) {\n\t\t\t\t\t\tthis.pushRevertible(trackingGroup, this.undoInsert);\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase MergeTreeDeltaType.REMOVE: {\n\t\t\t\t\tif (this.currentOp !== MergeTreeDeltaType.REMOVE) {\n\t\t\t\t\t\tthis.pushRevertible(trackingGroup, this.undoRemove);\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(\"operation type not revertible\");\n\t\t\t}\n\n\t\t\t// If we are in the process of reverting, set 'currentOp' to remind ourselves not to push\n\t\t\t// another revertible until `IRevertable.revert()` finishes the current op and clears this\n\t\t\t// field.\n\t\t\tif (this.currentGroup !== undefined) {\n\t\t\t\tthis.currentOp = operation;\n\t\t\t}\n\t\t}\n\t}\n\n\tprivate pushRevertible(\n\t\ttrackingGroup: TrackingGroup,\n\t\tcallback: (segment: PermutationSegment) => void,\n\t) {\n\t\tconst revertible = {\n\t\t\trevert: () => {\n\t\t\t\tassert(\n\t\t\t\t\tthis.currentGroup === undefined && this.currentOp === undefined,\n\t\t\t\t\t0x02b /* \"Must not nest calls to IRevertible.revert()\" */,\n\t\t\t\t);\n\n\t\t\t\tthis.currentGroup = new TrackingGroup();\n\n\t\t\t\ttry {\n\t\t\t\t\twhile (trackingGroup.size > 0) {\n\t\t\t\t\t\tconst segment = trackingGroup.segments[0] as PermutationSegment;\n\n\t\t\t\t\t\t// Unlink 'segment' from the current tracking group before invoking the callback\n\t\t\t\t\t\t// to exclude the current undo/redo segment from those copied to the replacement\n\t\t\t\t\t\t// segment (if any). (See 'PermutationSegment.transferToReplacement()')\n\t\t\t\t\t\tsegment.trackingCollection.unlink(trackingGroup);\n\n\t\t\t\t\t\tcallback(segment);\n\t\t\t\t\t}\n\t\t\t\t} finally {\n\t\t\t\t\tthis.currentOp = undefined;\n\t\t\t\t\tthis.currentGroup = undefined;\n\t\t\t\t}\n\t\t\t},\n\t\t\tdiscard: () => {\n\t\t\t\twhile (trackingGroup.size > 0) {\n\t\t\t\t\ttrackingGroup.unlink(trackingGroup.segments[0]);\n\t\t\t\t}\n\t\t\t},\n\t\t};\n\n\t\tthis.manager.pushToCurrentOperation(revertible);\n\n\t\treturn revertible;\n\t}\n}\n\nexport class MatrixUndoProvider<T> {\n\tconstructor(\n\t\tprivate readonly consumer: IUndoConsumer,\n\t\tprivate readonly matrix: SharedMatrix<T>,\n\t\tprivate readonly rows: PermutationVector,\n\t\tprivate readonly cols: PermutationVector,\n\t) {\n\t\trows.undo = new VectorUndoProvider(\n\t\t\tconsumer,\n\t\t\t/* undoInsert: */ (segment: PermutationSegment) => {\n\t\t\t\tif (toRemovalInfo(segment) === undefined) {\n\t\t\t\t\tconst start = this.rows.getPosition(segment);\n\t\t\t\t\tthis.matrix.removeRows(start, segment.cachedLength);\n\t\t\t\t}\n\t\t\t},\n\t\t\t/* undoRemove: */ (segment: PermutationSegment) => {\n\t\t\t\tthis.matrix._undoRemoveRows(segment);\n\t\t\t},\n\t\t);\n\t\tcols.undo = new VectorUndoProvider(\n\t\t\tconsumer,\n\t\t\t/* undoInsert: */ (segment: PermutationSegment) => {\n\t\t\t\tif (toRemovalInfo(segment) === undefined) {\n\t\t\t\t\tconst start = this.cols.getPosition(segment);\n\t\t\t\t\tthis.matrix.removeCols(start, segment.cachedLength);\n\t\t\t\t}\n\t\t\t},\n\t\t\t/* undoRemove: */ (segment: PermutationSegment) => {\n\t\t\t\tthis.matrix._undoRemoveCols(segment);\n\t\t\t},\n\t\t);\n\t}\n\n\tcellSet(rowHandle: Handle, colHandle: Handle, oldValue: MatrixItem<T>) {\n\t\tassert(\n\t\t\tisHandleValid(rowHandle) && isHandleValid(colHandle),\n\t\t\t0x02c /* \"On cellSet(), invalid row and/or column handles!\" */,\n\t\t);\n\n\t\tif (this.consumer !== undefined) {\n\t\t\tthis.consumer.pushToCurrentOperation({\n\t\t\t\trevert: () => {\n\t\t\t\t\tconst row = this.rows.handleToPosition(rowHandle);\n\t\t\t\t\tconst col = this.cols.handleToPosition(colHandle);\n\t\t\t\t\t// if the row/column no longer exists, we cannot set the cell\n\t\t\t\t\tif (row < this.matrix.rowCount && col < this.matrix.colCount) {\n\t\t\t\t\t\tthis.matrix.setCell(row, col, oldValue);\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\tdiscard: () => {},\n\t\t\t});\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"undoprovider.js","sourceRoot":"","sources":["../src/undoprovider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EACN,kBAAkB,EAGlB,iCAAiC,EACjC,+BAA+B,EAE/B,+BAA+B,EAC/B,aAAa,GAEb,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAU,aAAa,EAAE,MAAM,eAAe,CAAC;AAItD,MAAM,OAAO,kBAAkB;IAQ9B,YACkB,OAAsB,EACtB,MAAiC;QADjC,YAAO,GAAP,OAAO,CAAe;QACtB,WAAM,GAAN,MAAM,CAA2B;IAChD,CAAC;IAEG,MAAM,CAAC,SAAsC;;QACnD,IAAI,SAAS,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACvC,8FAA8F;YAC9F,4FAA4F;YAC5F,wCAAwC;YACxC,MAAM,WAAW,GAA+B,MAAA,IAAI,CAAC,YAAY,mCAAI,EAAE,CAAC;YACxE,iCAAiC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAE1D,+EAA+E;YAC/E,8EAA8E;YAC9E,MAAM,CACL,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,EACtE,KAAK,CAAC,0DAA0D,CAChE,CAAC;YACF,IAAI,mBAA8C,CAAC;YACnD,IAAI,SAAS,CAAC,SAAS,KAAK,kBAAkB,CAAC,MAAM,EAAE;gBACtD,gDAAgD;gBAChD,4BAA4B;gBAC5B,8EAA8E;gBAC9E,2EAA2E;gBAC3E,qFAAqF;gBACrF,6FAA6F;gBAC7F,uCAAuC;gBACvC,+EAA+E;gBAC/E,+EAA+E;gBAC/E,oCAAoC;gBACpC,MAAM,aAAa,GAAG,CAAC,mBAAmB;oBACzC,MAAA,IAAI,CAAC,0BAA0B,mCAAI,IAAI,aAAa,EAAE,CAAC,CAAC;gBACzD,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACrC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,CAChD,CAAC;aACF;YAED,QAAQ,SAAS,CAAC,SAAS,EAAE;gBAC5B,KAAK,kBAAkB,CAAC,MAAM,CAAC;gBAC/B,KAAK,kBAAkB,CAAC,MAAM;oBAC7B,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE;wBAC3C,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;qBACtD;oBACD,MAAM;gBAEP;oBACC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;aAClD;YAED,yFAAyF;YACzF,0FAA0F;YAC1F,SAAS;YACT,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;gBACpC,MAAA,IAAI,CAAC,SAAS,oCAAd,IAAI,CAAC,SAAS,GAAK,SAAS,CAAC,SAAS,EAAC;gBACvC,MAAA,IAAI,CAAC,0BAA0B,oCAA/B,IAAI,CAAC,0BAA0B,GAAK,mBAAmB,EAAC;aACxD;SACD;IACF,CAAC;IAEO,cAAc,CACrB,WAAuC,EACvC,oBAAgD;QAEhD,MAAM,QAAQ,GAAG;YAChB,MAAM,EAAE,GAAG,EAAE;gBACZ,MAAM,CACL,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAC/D,KAAK,CAAC,mDAAmD,CACzD,CAAC;gBAEF,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;gBAEvB,IAAI;oBACH,IAAI,oBAAoB,KAAK,SAAS,EAAE;wBACvC,OAAO,oBAAoB,CAAC,IAAI,GAAG,CAAC,EAAE;4BACrC,MAAM,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;4BAChD,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;4BACrC,6DAA6D;4BAC7D,sDAAsD;4BACtD,qEAAqE;4BACrE,uBAAuB;4BACvB,uDAAuD;4BACvD,wDAAwD;4BACvD,OAA8B,CAAC,KAAK,EAAE,CAAC;yBACxC;qBACD;oBACD,+BAA+B,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;iBAC1D;wBAAS;oBACT,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;oBAC3B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;oBAC9B,IAAI,CAAC,0BAA0B,GAAG,SAAS,CAAC;iBAC5C;YACF,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACb,IAAI,oBAAoB,KAAK,SAAS,EAAE;oBACvC,OAAO,oBAAoB,CAAC,IAAI,GAAG,CAAC,EAAE;wBACrC,oBAAoB,CAAC,MAAM,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;qBAC7D;iBACD;gBACD,+BAA+B,CAAC,WAAW,CAAC,CAAC;YAC9C,CAAC;SACD,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QAE9C,OAAO,QAAQ,CAAC;IACjB,CAAC;CACD;AAED,MAAM,OAAO,kBAAkB;IAC9B,YACkB,QAAuB,EACvB,MAAuB,EACvB,IAAuB,EACvB,IAAuB;QAHvB,aAAQ,GAAR,QAAQ,CAAe;QACvB,WAAM,GAAN,MAAM,CAAiB;QACvB,SAAI,GAAJ,IAAI,CAAmB;QACvB,SAAI,GAAJ,IAAI,CAAmB;QAExC,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAkB,CAAC,QAAQ,EAAE;YAC5C,aAAa;gBACZ,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACpC,CAAC;YACD,cAAc,CAAC,GAAG,EAAE,IAAI;gBACvB,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACnC,CAAC;YACD,WAAW,CAAC,KAAK,EAAE,GAAG;gBACrB,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC;YACvC,CAAC;SACD,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAkB,CAAC,QAAQ,EAAE;YAC5C,aAAa;gBACZ,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACpC,CAAC;YACD,cAAc,CAAC,GAAG,EAAE,IAAI;gBACvB,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACnC,CAAC;YACD,WAAW,CAAC,KAAK,EAAE,GAAG;gBACrB,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC;YACvC,CAAC;SACD,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,SAAiB,EAAE,SAAiB,EAAE,QAAuB;QACpE,MAAM,CACL,aAAa,CAAC,SAAS,CAAC,IAAI,aAAa,CAAC,SAAS,CAAC,EACpD,KAAK,CAAC,wDAAwD,CAC9D,CAAC;QAEF,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC;gBACpC,MAAM,EAAE,GAAG,EAAE;oBACZ,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;oBAClD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;oBAClD,6DAA6D;oBAC7D,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;wBAC7D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;qBACxC;gBACF,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC;aACjB,CAAC,CAAC;SACH;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n\tMergeTreeDeltaType,\n\tMergeTreeDeltaRevertible,\n\tIMergeTreeDeltaCallbackArgs,\n\tappendToMergeTreeDeltaRevertibles,\n\trevertMergeTreeDeltaRevertibles,\n\tMergeTreeRevertibleDriver,\n\tdiscardMergeTreeDeltaRevertible,\n\tTrackingGroup,\n\tITrackingGroup,\n} from \"@fluidframework/merge-tree\";\nimport { MatrixItem, SharedMatrix } from \"./matrix\";\nimport { Handle, isHandleValid } from \"./handletable\";\nimport { PermutationSegment, PermutationVector } from \"./permutationvector\";\nimport { IUndoConsumer } from \"./types\";\n\nexport class VectorUndoProvider {\n\t// 'currentGroup' and 'currentOp' are used while applying an IRevertable.revert() to coalesce\n\t// the recorded into a single IRevertable / tracking group as they move between the undo <->\n\t// redo stacks.\n\tprivate currentGroup?: MergeTreeDeltaRevertible[];\n\tprivate currentOp?: MergeTreeDeltaType;\n\tprivate currentRemoveTrackingGroup?: TrackingGroup;\n\n\tconstructor(\n\t\tprivate readonly manager: IUndoConsumer,\n\t\tprivate readonly driver: MergeTreeRevertibleDriver,\n\t) {}\n\n\tpublic record(deltaArgs: IMergeTreeDeltaCallbackArgs) {\n\t\tif (deltaArgs.deltaSegments.length > 0) {\n\t\t\t// If we are in the process of reverting, the `IRevertible.revert()` will provide the tracking\n\t\t\t// group so that we can preserve the original segment ranges as a single op/group as we move\n\t\t\t// ops between the undo <-> redo stacks.\n\t\t\tconst revertibles: MergeTreeDeltaRevertible[] = this.currentGroup ?? [];\n\t\t\tappendToMergeTreeDeltaRevertibles(deltaArgs, revertibles);\n\n\t\t\t// For SharedMatrix, each IRevertibles always holds a single row/col operation.\n\t\t\t// Therefore, 'currentOp' must either be undefined or equal to the current op.\n\t\t\tassert(\n\t\t\t\tthis.currentOp === undefined || this.currentOp === deltaArgs.operation,\n\t\t\t\t0x02a /* \"On vector undo, unexpected 'currentOp' type/state!\" */,\n\t\t\t);\n\t\t\tlet removeTrackingGroup: TrackingGroup | undefined;\n\t\t\tif (deltaArgs.operation === MergeTreeDeltaType.REMOVE) {\n\t\t\t\t// for removed segment we need a tracking group.\n\t\t\t\t// this is for a few reason:\n\t\t\t\t// 1. the handle for the row/column on the removed segment is still allocated,\n\t\t\t\t//\t\tand needs to be in order to process unacked ops sent before the remove.\n\t\t\t\t// 2. handles are freed on unlink(zamboni), but that also clears the row/column data.\n\t\t\t\t//\t\twhich we don't want to happen, so we can re-insert the cells when the row/col comes back.\n\t\t\t\t//\t\tthe tracking group prevents unlink.\n\t\t\t\t// 3. when we re-insert we need to find the old segment and clear their handles\n\t\t\t\t//\t\tso the new segment takes them over. there is no efficient look-up for this.\n\t\t\t\t//\t\tthe tracking group provides one.\n\t\t\t\tconst trackingGroup = (removeTrackingGroup =\n\t\t\t\t\tthis.currentRemoveTrackingGroup ?? new TrackingGroup());\n\t\t\t\tdeltaArgs.deltaSegments.forEach((d) =>\n\t\t\t\t\td.segment.trackingCollection.link(trackingGroup),\n\t\t\t\t);\n\t\t\t}\n\n\t\t\tswitch (deltaArgs.operation) {\n\t\t\t\tcase MergeTreeDeltaType.REMOVE:\n\t\t\t\tcase MergeTreeDeltaType.INSERT:\n\t\t\t\t\tif (this.currentOp !== deltaArgs.operation) {\n\t\t\t\t\t\tthis.pushRevertible(revertibles, removeTrackingGroup);\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(\"operation type not revertible\");\n\t\t\t}\n\n\t\t\t// If we are in the process of reverting, set 'currentOp' to remind ourselves not to push\n\t\t\t// another revertible until `IRevertable.revert()` finishes the current op and clears this\n\t\t\t// field.\n\t\t\tif (this.currentGroup !== undefined) {\n\t\t\t\tthis.currentOp ??= deltaArgs.operation;\n\t\t\t\tthis.currentRemoveTrackingGroup ??= removeTrackingGroup;\n\t\t\t}\n\t\t}\n\t}\n\n\tprivate pushRevertible(\n\t\trevertibles: MergeTreeDeltaRevertible[],\n\t\tremovedTrackingGroup: ITrackingGroup | undefined,\n\t) {\n\t\tconst reverter = {\n\t\t\trevert: () => {\n\t\t\t\tassert(\n\t\t\t\t\tthis.currentGroup === undefined && this.currentOp === undefined,\n\t\t\t\t\t0x02b /* \"Must not nest calls to IRevertible.revert()\" */,\n\t\t\t\t);\n\n\t\t\t\tthis.currentGroup = [];\n\n\t\t\t\ttry {\n\t\t\t\t\tif (removedTrackingGroup !== undefined) {\n\t\t\t\t\t\twhile (removedTrackingGroup.size > 0) {\n\t\t\t\t\t\t\tconst tracked = removedTrackingGroup.tracked[0];\n\t\t\t\t\t\t\tremovedTrackingGroup.unlink(tracked);\n\t\t\t\t\t\t\t// if there are groups tracked, this in a revert of a remove.\n\t\t\t\t\t\t\t// this means we are about to re-insert the row/column\n\t\t\t\t\t\t\t// with the same handle. We reuse the handle so the row/columns cells\n\t\t\t\t\t\t\t// get re-inserted too.\n\t\t\t\t\t\t\t// since a new segment will have the handle, we need to\n\t\t\t\t\t\t\t// remove it from the  removed segment which was tracked\n\t\t\t\t\t\t\t(tracked as PermutationSegment).reset();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\trevertMergeTreeDeltaRevertibles(this.driver, revertibles);\n\t\t\t\t} finally {\n\t\t\t\t\tthis.currentOp = undefined;\n\t\t\t\t\tthis.currentGroup = undefined;\n\t\t\t\t\tthis.currentRemoveTrackingGroup = undefined;\n\t\t\t\t}\n\t\t\t},\n\t\t\tdiscard: () => {\n\t\t\t\tif (removedTrackingGroup !== undefined) {\n\t\t\t\t\twhile (removedTrackingGroup.size > 0) {\n\t\t\t\t\t\tremovedTrackingGroup.unlink(removedTrackingGroup.tracked[0]);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tdiscardMergeTreeDeltaRevertible(revertibles);\n\t\t\t},\n\t\t};\n\n\t\tthis.manager.pushToCurrentOperation(reverter);\n\n\t\treturn reverter;\n\t}\n}\n\nexport class MatrixUndoProvider<T> {\n\tconstructor(\n\t\tprivate readonly consumer: IUndoConsumer,\n\t\tprivate readonly matrix: SharedMatrix<T>,\n\t\tprivate readonly rows: PermutationVector,\n\t\tprivate readonly cols: PermutationVector,\n\t) {\n\t\trows.undo = new VectorUndoProvider(consumer, {\n\t\t\tannotateRange() {\n\t\t\t\tthrow new Error(\"not implemented\");\n\t\t\t},\n\t\t\tinsertFromSpec(pos, spec) {\n\t\t\t\tmatrix._undoRemoveRows(pos, spec);\n\t\t\t},\n\t\t\tremoveRange(start, end) {\n\t\t\t\tmatrix.removeRows(start, end - start);\n\t\t\t},\n\t\t});\n\t\tcols.undo = new VectorUndoProvider(consumer, {\n\t\t\tannotateRange() {\n\t\t\t\tthrow new Error(\"not implemented\");\n\t\t\t},\n\t\t\tinsertFromSpec(pos, spec) {\n\t\t\t\tmatrix._undoRemoveCols(pos, spec);\n\t\t\t},\n\t\t\tremoveRange(start, end) {\n\t\t\t\tmatrix.removeCols(start, end - start);\n\t\t\t},\n\t\t});\n\t}\n\n\tcellSet(rowHandle: Handle, colHandle: Handle, oldValue: MatrixItem<T>) {\n\t\tassert(\n\t\t\tisHandleValid(rowHandle) && isHandleValid(colHandle),\n\t\t\t0x02c /* \"On cellSet(), invalid row and/or column handles!\" */,\n\t\t);\n\n\t\tif (this.consumer !== undefined) {\n\t\t\tthis.consumer.pushToCurrentOperation({\n\t\t\t\trevert: () => {\n\t\t\t\t\tconst row = this.rows.handleToPosition(rowHandle);\n\t\t\t\t\tconst col = this.cols.handleToPosition(colHandle);\n\t\t\t\t\t// if the row/column no longer exists, we cannot set the cell\n\t\t\t\t\tif (row < this.matrix.rowCount && col < this.matrix.colCount) {\n\t\t\t\t\t\tthis.matrix.setCell(row, col, oldValue);\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\tdiscard: () => {},\n\t\t\t});\n\t\t}\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/matrix",
-  "version": "2.0.0-internal.4.3.0",
+  "version": "2.0.0-internal.5.0.0",
   "description": "Distributed matrix",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -33,29 +33,29 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
-    "@fluidframework/merge-tree": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
-    "@fluidframework/protocol-base": "^0.1039.1000",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
+    "@fluidframework/driver-utils": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
+    "@fluidframework/merge-tree": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
-    "@fluidframework/shared-object-base": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
+    "@fluidframework/shared-object-base": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
     "@tiny-calc/nano": "0.0.0-alpha.5",
     "events": "^3.1.0",
     "tslib": "^1.10.0"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
+    "@fluid-internal/test-dds-utils": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
     "@fluid-tools/benchmark": "^0.47.0",
     "@fluid-tools/build-cli": "^0.17.0",
     "@fluidframework/build-common": "^1.1.0",
     "@fluidframework/build-tools": "^0.17.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
     "@fluidframework/matrix-previous": "npm:@fluidframework/matrix@2.0.0-internal.4.1.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
-    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.4.3.0 <2.0.0-internal.4.4.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.5.0.0 <2.0.0-internal.5.1.0",
     "@microsoft/api-extractor": "^7.34.4",
     "@tiny-calc/micro": "0.0.0-alpha.5",
     "@types/mocha": "^9.1.1",

package/src/matrix.ts

@@ -25,11 +25,11 @@ import {
 	MergeTreeDeltaType,
 	IMergeTreeOp,
 	SegmentGroup,
-	ISegment,
 	Client,
+	IJSONSegment,
 } from "@fluidframework/merge-tree";
 import { MatrixOp } from "./ops";
-import { PermutationVector, PermutationSegment } from "./permutationvector";
+import { PermutationVector, reinsertSegmentIntoVector } from "./permutationvector";
 import { SparseArray2D } from "./sparsearray2d";
 import { SharedMatrixFactory } from "./runtime";
 import { Handle, isHandleValid } from "./handletable";
@@ -368,26 +368,10 @@ export class SharedMatrix<T = any>
 		this.submitRowMessage(this.rows.remove(rowStart, count));
 	}
 
-	/** @internal */ public _undoRemoveRows(segment: ISegment) {
-		const original = segment as PermutationSegment;
-
-		// (Re)insert the removed number of rows at the original position.
-		const { op, inserted } = this.rows.insertRelative(original, original.cachedLength);
+	/** @internal */ public _undoRemoveRows(rowStart: number, spec: IJSONSegment) {
+		const { op, inserted } = reinsertSegmentIntoVector(this.rows, rowStart, spec);
 		this.submitRowMessage(op);
 
-		// Transfer handles and undo/redo tracking groups from the original segment to the
-		// newly inserted segment.
-		original.transferToReplacement(inserted);
-
-		// Invalidate the handleCache in case it was populated during the 'rowsChanged'
-		// callback, which occurs before the handle span is populated.
-		const rowStart = this.rows.getPosition(inserted);
-		this.rows.handleCache.itemsChanged(
-			rowStart,
-			/* removedCount: */ 0,
-			/* insertedCount: */ inserted.cachedLength,
-		);
-
 		// Generate setCell ops for each populated cell in the reinserted rows.
 		let rowHandle = inserted.start;
 		const rowCount = inserted.cachedLength;
@@ -407,26 +391,10 @@ export class SharedMatrix<T = any>
 		}
 	}
 
-	/** @internal */ public _undoRemoveCols(segment: ISegment) {
-		const original = segment as PermutationSegment;
-
-		// (Re)insert the removed number of columns at the original position.
-		const { op, inserted } = this.cols.insertRelative(original, original.cachedLength);
+	/** @internal */ public _undoRemoveCols(colStart: number, spec: IJSONSegment) {
+		const { op, inserted } = reinsertSegmentIntoVector(this.cols, colStart, spec);
 		this.submitColMessage(op);
 
-		// Transfer handles and undo/redo tracking groups from the original segment to the
-		// newly inserted segment.
-		original.transferToReplacement(inserted);
-
-		// Invalidate the handleCache in case it was populated during the 'colsChanged'
-		// callback, which occurs before the handle span is populated.
-		const colStart = this.cols.getPosition(inserted);
-		this.cols.handleCache.itemsChanged(
-			colStart,
-			/* removedCount: */ 0,
-			/* insertedCount: */ inserted.cachedLength,
-		);
-
 		// Generate setCell ops for each populated cell in the reinserted cols.
 		let colHandle = inserted.start;
 		const colCount = inserted.cachedLength;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/matrix";
-export const pkgVersion = "2.0.0-internal.4.3.0";
+export const pkgVersion = "2.0.0-internal.5.0.0";

package/src/permutationvector.ts

@@ -19,7 +19,7 @@ import {
 	MergeTreeDeltaType,
 	IMergeTreeMaintenanceCallbackArgs,
 	MergeTreeMaintenanceType,
-	ReferenceType,
+	IJSONSegment,
 } from "@fluidframework/merge-tree";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { IFluidSerializer } from "@fluidframework/shared-object-base";
@@ -71,35 +71,6 @@ export class PermutationSegment extends BaseSegment {
 		this._start = value;
 	}
 
-	/**
-	 * Invoked by '_undoRow/ColRemove' to prepare the newly inserted destination
-	 * segment to serve as the replacement for this removed segment.  This moves handle
-	 * allocations from this segment to the replacement as well as maintains tracking
-	 * groups for the undo/redo stack.
-	 */
-	public transferToReplacement(destination: PermutationSegment) {
-		// When this segment was removed, it may have been split from a larger original
-		// segment.  In this case, it will have been added to an undo/redo tracking group
-		// that associates all of the fragments from the original insertion.
-		//
-		// Move this association from the this removed segment to its replacement so that
-		// it is included if the undo stack continues to unwind to the original insertion.
-		//
-		// Out of paranoia we link and unlink in separate loops to avoid mutating the underlying
-		// set during enumeration.  In practice, this is unlikely to matter since there should be
-		// exactly 0 or 1 items in the enumeration.
-		for (const group of this.trackingCollection.trackingGroups) {
-			group.link(destination);
-		}
-		for (const group of this.trackingCollection.trackingGroups) {
-			group.unlink(this);
-		}
-
-		// Move handle allocations from this segment to its replacement.
-		destination._start = this._start;
-		this.reset();
-	}
-
 	public reset() {
 		this._start = Handle.unallocated;
 	}
@@ -170,6 +141,7 @@ export class PermutationVector extends Client {
 			{
 				...runtime.options,
 				newMergeTreeSnapshotFormat: true, // Temporarily force new snapshot format until it is the default.
+				mergeTreeUseNewLengthCalculations: true,
 			},
 		); // (See https://github.com/microsoft/FluidFramework/issues/84)
 
@@ -181,18 +153,6 @@ export class PermutationVector extends Client {
 		return this.insertSegmentLocal(start, new PermutationSegment(length));
 	}
 
-	public insertRelative(segment: ISegment, length: number) {
-		const inserted = new PermutationSegment(length);
-
-		return {
-			op: this.insertAtReferencePositionLocal(
-				this.createLocalReferencePosition(segment, 0, ReferenceType.Transient, undefined),
-				inserted,
-			),
-			inserted,
-		};
-	}
-
 	public remove(start: number, length: number) {
 		return this.removeRangeLocal(start, start + length);
 	}
@@ -346,10 +306,10 @@ export class PermutationVector extends Client {
 
 	private readonly onDelta = (
 		opArgs: IMergeTreeDeltaOpArgs,
-		{ operation, deltaSegments }: IMergeTreeDeltaCallbackArgs,
+		deltaArgs: IMergeTreeDeltaCallbackArgs,
 	) => {
 		// Apply deltas in descending order to prevent positions from shifting.
-		const ranges = deltaSegments
+		const ranges = deltaArgs.deltaSegments
 			.map(({ segment }) => ({
 				segment: segment as PermutationSegment,
 				position: this.getPosition(segment),
@@ -360,10 +320,10 @@ export class PermutationVector extends Client {
 
 		// Notify the undo provider, if any is attached.
 		if (this.undo !== undefined && isLocal) {
-			this.undo.record(operation, ranges);
+			this.undo.record(deltaArgs);
 		}
 
-		switch (operation) {
+		switch (deltaArgs.operation) {
 			case MergeTreeDeltaType.INSERT:
 				// Pass 1: Perform any internal maintenance first to avoid reentrancy.
 				for (const { segment, position } of ranges) {
@@ -453,3 +413,30 @@ export class PermutationVector extends Client {
 		return s.join("");
 	}
 }
+
+export function reinsertSegmentIntoVector(
+	vector: PermutationVector,
+	pos: number,
+	spec: IJSONSegment,
+) {
+	const original = PermutationSegment.fromJSONObject(spec);
+
+	// (Re)insert the removed number of rows at the original position.
+	const op = vector.insertSegmentLocal(pos, original);
+	const inserted = vector.getContainingSegment(pos).segment as PermutationSegment;
+
+	// we reuse the original handle here
+	// so if cells exist, they can be found, and re-inserted
+	if (isHandleValid(original.start)) {
+		inserted.start = original.start;
+	}
+
+	// Invalidate the handleCache in case it was populated during the 'rowsChanged'
+	// callback, which occurs before the handle span is populated.
+	vector.handleCache.itemsChanged(
+		pos,
+		/* removedCount: */ 0,
+		/* insertedCount: */ inserted.cachedLength,
+	);
+	return { op, inserted };
+}

package/src/serialization.ts

@@ -4,8 +4,8 @@
  */
 
 import { Serializable, IChannelStorageService } from "@fluidframework/datastore-definitions";
-import { BlobTreeEntry } from "@fluidframework/protocol-base";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { BlobTreeEntry } from "@fluidframework/driver-utils";
 import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { bufferToString } from "@fluidframework/common-utils";