@fluidframework/merge-tree 1.2.6 → 2.0.0-dev.1.3.0.96595

package/dist/partialLengths.js

@@ -8,7 +8,7 @@ exports.PartialSequenceLengths = void 0;
 const common_utils_1 = require("@fluidframework/common-utils");
 const collections_1 = require("./collections");
 const constants_1 = require("./constants");
-const mergeTree_1 = require("./mergeTree");
+const mergeTreeNodes_1 = require("./mergeTreeNodes");
 /**
  * Returns the partial length whose sequence number is
  * the greatest sequence number within a that is
@@ -35,141 +35,152 @@ function latestLEQ(a, key) {
     return best;
 }
 /**
- * Keep track of partial sums of segment lengths for all sequence numbers
- * in the current collaboration window (if any).  Only used during active
- * collaboration.
+ * Keeps track of partial sums of segment lengths for all sequence numbers in the current collaboration window.
+ * Only used during active collaboration.
+ *
+ * This class is associated with an internal node (block) of a MergeTree. It efficiently answers queries of the form
+ * "What is the length of `block` from the perspective of some particular seq and clientId?".
+ *
+ * It also supports incremental updating of state for newly-sequenced ops that don't affect the structure of the
+ * MergeTree.
+ *
+ * To answer these queries, it pre-builds several lists which track the length of the block at a per-sequence-number
+ * level. These lists are:
+ *
+ * 1. (`partialLengths`): Stores the total length of the block.
+ * 2. (`clientSeqNumbers[clientId]`): Stores only the total lengths of segments submitted by `clientId`. [see footnote]
+ *
+ * The reason both lists are necessary is that resolving the length of the block from the perspective of
+ * (clientId, refSeq) requires including both of the following types of segments:
+ * 1. Segments sequenced before `refSeq`
+ * 2. Segments submitted by `clientId`
+ *
+ * This is possible with the above bookkeeping, using:
+ *
+ * (length of the block at the minimum sequence number)
+ * + (partialLengths total length at refSeq)
+ * + (clientSeqNumbers total length at most recent op)
+ * - (clientSeqNumbers total length at refSeq)
+ *
+ * where the subtraction avoids double-counting segments submitted by clientId sequenced within the collab window.
+ *
+ * To enable reconnect, if constructed with `computeLocalPartials === true` it also supports querying for the length of
+ * the block from the perspective of the local client at a particular `refSeq` and `localSeq`. This computation is
+ * similar to the above:
+ *
+ * (length of the block at the minimum sequence number)
+ * + (partialLengths total length at refSeq)
+ * + (unsequenced edits' total length submitted before localSeq)
+ * - (overlapping remove of the unsequenced edits' total length at refSeq)
+ *
+ * This algorithm scales roughly linearly with number of editing clients and the size of the collab window.
+ * (certain unlikely sequences of operations may introduce log factors on those variables)
+ *
+ * Note: there is some slight complication with clientSeqNumbers resulting from the possibility of different clients
+ * concurrently removing the same segment. See the field's documentation for more details.
  */
 class PartialSequenceLengths {
-    constructor(minSeq) {
+    constructor(
+    /**
+     * The minimumSequenceNumber as defined by the collab window used in the last call to `update`,
+     * or if no such calls have been made, the one used on construction.
+    */
+    minSeq, computeLocalPartials) {
         this.minSeq = minSeq;
+        /**
+         * Length of the block this PartialSequenceLength corresponds to when viewed at `minSeq`.
+         */
         this.minLength = 0;
+        /**
+         * Total number of segments in the subtree rooted at the block this PartialSequenceLength corresponds to.
+         */
         this.segmentCount = 0;
+        /**
+         * List of PartialSequenceLength objects--ordered by increasing seq--giving length information about
+         * the block associated with this PartialSequenceLengths object.
+         *
+         * `partialLengths[i].len` contains the length of this block considering only sequenced segments with
+         * `sequenceNumber <= partialLengths[i].seq`.
+         */
         this.partialLengths = [];
+        /**
+         * clientSeqNumbers[clientId] is a list of partial lengths for sequenced ops which either:
+         * - were submitted by `clientId`.
+         * - deleted a range containing segments that were concurrently deleted by `clientId`
+         *
+         * The second case is referred to as the "overlapping delete" case. It is necessary to avoid double-counting
+         * the removal of those segments in queries including clientId.
+         */
         this.clientSeqNumbers = [];
-    }
-    static combine(mergeTree, block, collabWindow, recur = false) {
-        return PartialSequenceLengths.combineBranch(mergeTree, block, collabWindow, recur);
+        if (computeLocalPartials) {
+            this.unsequencedRecords = {
+                partialLengths: [],
+                overlappingRemoves: [],
+                cachedOverlappingByRefSeq: new Map(),
+            };
+        }
     }
     /**
      * Combine the partial lengths of block's children
-     * @param block - an interior node; it is assumed that each interior node child of this block
-     * has its partials up to date
-     * @param collabWindow - segment window of the segment tree containing textSegmentBlock
+     * @param block - an interior node. If `recur` is false, it is assumed that each interior node child of this block
+     * has its partials up to date.
+     * @param collabWindow - segment window of the segment tree containing `block`.
+     * @param recur - whether to recursively compute partial lengths for internal children of `block`.
+     * This incurs more work, but gives correct bookkeeping in the case that a descendant in the merge tree has been
+     * modified without bubbling up the resulting partial length change to this block's partials.
+     * @param computeLocalPartials - whether to compute partial length information about local unsequenced ops.
+     * This enables querying for the length of the block at a given localSeq, but incurs extra work.
+     * Local partial information doesn't support `update`.
      */
-    static combineBranch(mergeTree, block, collabWindow, recur = false) {
-        let combinedPartialLengths = new PartialSequenceLengths(collabWindow.minSeq);
-        PartialSequenceLengths.fromLeaves(combinedPartialLengths, block, collabWindow);
-        let prevPartial;
-        function cloneOverlapRemoveClients(oldTree) {
-            if (!oldTree) {
-                return undefined;
-            }
-            const newTree = new collections_1.RedBlackTree(mergeTree_1.compareNumbers);
-            oldTree.map((bProp) => {
-                newTree.put(bProp.data.clientId, Object.assign({}, bProp.data));
-                return true;
-            });
-            return newTree;
-        }
-        function combineOverlapClients(a, b) {
-            const overlapRemoveClientsA = a.overlapRemoveClients;
-            if (overlapRemoveClientsA) {
-                if (b.overlapRemoveClients) {
-                    b.overlapRemoveClients.map((bProp) => {
-                        const aProp = overlapRemoveClientsA.get(bProp.key);
-                        if (aProp) {
-                            aProp.data.seglen += bProp.data.seglen;
-                        }
-                        else {
-                            overlapRemoveClientsA.put(bProp.data.clientId, Object.assign({}, bProp.data));
-                        }
-                        return true;
-                    });
-                }
-            }
-            else {
-                a.overlapRemoveClients = cloneOverlapRemoveClients(b.overlapRemoveClients);
-            }
-        }
-        function addNext(partialLength) {
-            const seq = partialLength.seq;
-            let pLen = 0;
-            if (prevPartial) {
-                if (prevPartial.seq === partialLength.seq) {
-                    prevPartial.seglen += partialLength.seglen;
-                    prevPartial.len += partialLength.seglen;
-                    combineOverlapClients(prevPartial, partialLength);
-                    return;
-                }
-                else {
-                    pLen = prevPartial.len;
-                    // Previous sequence number is finished
-                    combinedPartialLengths.addClientSeqNumberFromPartial(prevPartial);
-                }
-            }
-            prevPartial = {
-                clientId: partialLength.clientId,
-                len: pLen + partialLength.seglen,
-                overlapRemoveClients: cloneOverlapRemoveClients(partialLength.overlapRemoveClients),
-                seglen: partialLength.seglen,
-                seq,
-            };
-            combinedPartialLengths.partialLengths.push(prevPartial);
-        }
+    static combine(block, collabWindow, recur = false, computeLocalPartials = false) {
+        const leafPartialLengths = PartialSequenceLengths.fromLeaves(block, collabWindow, computeLocalPartials);
+        let hasInternalChild = false;
         const childPartials = [];
         for (let i = 0; i < block.childCount; i++) {
             const child = block.children[i];
             if (!child.isLeaf()) {
-                const childBlock = child;
+                hasInternalChild = true;
                 if (recur) {
-                    childBlock.partialLengths =
-                        PartialSequenceLengths.combine(mergeTree, childBlock, collabWindow, true);
+                    child.partialLengths =
+                        PartialSequenceLengths.combine(child, collabWindow, true, computeLocalPartials);
                 }
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                childPartials.push(childBlock.partialLengths);
+                childPartials.push(child.partialLengths);
             }
         }
-        let childPartialsLen = childPartials.length;
-        if (childPartialsLen !== 0) {
-            // Some children are interior nodes
-            if (combinedPartialLengths.partialLengths.length > 0) {
+        // If there are no internal children, the PartialSequenceLengths returns from `fromLeaves` is exactly correct.
+        // Otherwise, we must additively combine all of the children partial lengths to get this block's totals.
+        const combinedPartialLengths = hasInternalChild ?
+            new PartialSequenceLengths(collabWindow.minSeq, computeLocalPartials) : leafPartialLengths;
+        if (hasInternalChild) {
+            if (leafPartialLengths.partialLengths.length > 0) {
                 // Some children were leaves; add combined partials from these segments
-                childPartials.push(combinedPartialLengths);
-                childPartialsLen++;
-                combinedPartialLengths = new PartialSequenceLengths(collabWindow.minSeq);
+                childPartials.push(leafPartialLengths);
             }
-            const indices = new Array(childPartialsLen);
-            const childPartialsCounts = new Array(childPartialsLen);
+            const childPartialsLen = childPartials.length;
+            const childPartialLengths = [];
+            const childUnsequencedPartialLengths = [];
+            const childOverlapRemoves = [];
             for (let i = 0; i < childPartialsLen; i++) {
-                indices[i] = 0;
-                childPartialsCounts[i] = childPartials[i].partialLengths.length;
-                combinedPartialLengths.minLength += childPartials[i].minLength;
-                combinedPartialLengths.segmentCount += childPartials[i].segmentCount;
-            }
-            let outerIndexOfEarliest = 0;
-            let earliestPartialLength;
-            while (outerIndexOfEarliest >= 0) {
-                outerIndexOfEarliest = -1;
-                for (let k = 0; k < childPartialsLen; k++) {
-                    // Find next earliest sequence number
-                    if (indices[k] < childPartialsCounts[k]) {
-                        const cpLen = childPartials[k].partialLengths[indices[k]];
-                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                        if ((outerIndexOfEarliest < 0) || (cpLen.seq < earliestPartialLength.seq)) {
-                            outerIndexOfEarliest = k;
-                            earliestPartialLength = cpLen;
-                        }
-                    }
-                }
-                if (outerIndexOfEarliest >= 0) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    addNext(earliestPartialLength);
-                    indices[outerIndexOfEarliest]++;
+                const { segmentCount, minLength, partialLengths, unsequencedRecords } = childPartials[i];
+                combinedPartialLengths.segmentCount += segmentCount;
+                combinedPartialLengths.minLength += minLength;
+                childPartialLengths.push(partialLengths);
+                if (unsequencedRecords) {
+                    childUnsequencedPartialLengths.push(unsequencedRecords.partialLengths);
+                    childOverlapRemoves.push(unsequencedRecords.overlappingRemoves);
                 }
             }
-            // Add client entry for last partial, if any
-            if (prevPartial) {
-                combinedPartialLengths.addClientSeqNumberFromPartial(prevPartial);
+            combinedPartialLengths.partialLengths.push(...mergePartialLengths(childPartialLengths));
+            if (computeLocalPartials) {
+                combinedPartialLengths.unsequencedRecords = {
+                    partialLengths: mergePartialLengths(childUnsequencedPartialLengths),
+                    overlappingRemoves: Array.from(mergeSortedListsBySeq(childOverlapRemoves)),
+                    cachedOverlappingByRefSeq: new Map(),
+                };
+            }
+            for (const partial of combinedPartialLengths.partialLengths) {
+                combinedPartialLengths.addClientSeqNumberFromPartial(partial);
             }
         }
         // TODO: incremental zamboni during build
@@ -177,12 +188,16 @@ class PartialSequenceLengths {
             combinedPartialLengths.zamboni(collabWindow);
         }
         if (PartialSequenceLengths.options.verify) {
-            combinedPartialLengths.verify();
+            verify(combinedPartialLengths);
         }
         return combinedPartialLengths;
     }
-    static fromLeaves(combinedPartialLengths, block, collabWindow) {
-        combinedPartialLengths.minLength = 0;
+    /**
+     * @returns a PartialSequenceLengths structure which tracks only lengths of leaf children of the provided
+     * IMergeBlock.
+     */
+    static fromLeaves(block, collabWindow, computeLocalPartials) {
+        const combinedPartialLengths = new PartialSequenceLengths(collabWindow.minSeq, computeLocalPartials);
         combinedPartialLengths.segmentCount = block.childCount;
         function seqLTE(seq, minSeq) {
             return seq !== undefined && seq !== constants_1.UnassignedSequenceNumber && seq <= minSeq;
@@ -196,19 +211,14 @@ class PartialSequenceLengths {
                     combinedPartialLengths.minLength += segment.cachedLength;
                 }
                 else {
-                    if (segment.seq !== constants_1.UnassignedSequenceNumber) {
-                        PartialSequenceLengths.insertSegment(combinedPartialLengths, segment);
-                    }
+                    PartialSequenceLengths.insertSegment(combinedPartialLengths, segment);
                 }
-                const removalInfo = (0, mergeTree_1.toRemovalInfo)(segment);
+                const removalInfo = (0, mergeTreeNodes_1.toRemovalInfo)(segment);
                 if (seqLTE(removalInfo === null || removalInfo === void 0 ? void 0 : removalInfo.removedSeq, collabWindow.minSeq)) {
                     combinedPartialLengths.minLength -= segment.cachedLength;
                 }
-                else {
-                    if (removalInfo !== undefined
-                        && removalInfo.removedSeq !== constants_1.UnassignedSequenceNumber) {
-                        PartialSequenceLengths.insertSegment(combinedPartialLengths, segment, removalInfo);
-                    }
+                else if (removalInfo !== undefined) {
+                    PartialSequenceLengths.insertSegment(combinedPartialLengths, segment, removalInfo);
                 }
             }
         }
@@ -222,12 +232,21 @@ class PartialSequenceLengths {
             prevLen = seqPartials[i].len;
             combinedPartialLengths.addClientSeqNumberFromPartial(seqPartials[i]);
         }
+        prevLen = 0;
+        if (combinedPartialLengths.unsequencedRecords !== undefined) {
+            const localPartials = combinedPartialLengths.unsequencedRecords.partialLengths;
+            for (const partial of localPartials) {
+                partial.len = prevLen + partial.seglen;
+                prevLen = partial.len;
+            }
+        }
         if (PartialSequenceLengths.options.verify) {
-            combinedPartialLengths.verify();
+            verify(combinedPartialLengths);
         }
+        return combinedPartialLengths;
     }
     static getOverlapClients(overlapClientIds, seglen) {
-        const bst = new collections_1.RedBlackTree(mergeTree_1.compareNumbers);
+        const bst = new collections_1.RedBlackTree(mergeTreeNodes_1.compareNumbers);
         for (const clientId of overlapClientIds) {
             bst.put(clientId, { clientId, seglen });
         }
@@ -250,57 +269,99 @@ class PartialSequenceLengths {
                 PartialSequenceLengths.getOverlapClients(overlapRemoveClientIds, seglen);
         }
     }
+    /**
+     * Inserts length information about the insertion of `segment` into `combinedPartialLengths.partialLengths`.
+     * Does not update the clientSeqNumbers field to account for this segment.
+     * If `removalInfo` is defined, this operation updates the bookkeeping to account for the removal of this
+     * segment at the removedSeq instead.
+     * When the insertion or removal of the segment is un-acked and `combinedPartialLengths` is meant to compute
+     * such records, this does the analogous addition to the bookkeeping for the local segment in
+     * `combinedPartialLengths.unsequencedRecords`.
+     */
     static insertSegment(combinedPartialLengths, segment, removalInfo) {
+        var _a, _b, _c;
+        const isLocal = (removalInfo === undefined && segment.seq === constants_1.UnassignedSequenceNumber)
+            || (removalInfo !== undefined && segment.removedSeq === constants_1.UnassignedSequenceNumber);
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        let seq = segment.seq;
+        let seqOrLocalSeq = isLocal ? segment.localSeq : segment.seq;
         let segmentLen = segment.cachedLength;
         let clientId = segment.clientId;
         let removeClientOverlap;
         if (removalInfo) {
-            seq = removalInfo.removedSeq;
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            seqOrLocalSeq = isLocal ? removalInfo.localRemovedSeq : removalInfo.removedSeq;
             segmentLen = -segmentLen;
-            // this code still assume removed client id and
-            // overlap clients are separate. so we need to pull
-            // then apart first.
+            // The client who performed the remove is always stored
+            // in the first position of removalInfo.
             clientId = removalInfo.removedClientIds[0];
-            removeClientOverlap = removalInfo.removedClientIds.length > 1
-                ? removalInfo.removedClientIds.slice(1)
-                : undefined;
+            const hasOverlap = removalInfo.removedClientIds.length > 1;
+            removeClientOverlap = hasOverlap ? removalInfo.removedClientIds : undefined;
         }
-        const seqPartials = combinedPartialLengths.partialLengths;
-        const seqPartialsLen = seqPartials.length;
+        const partials = isLocal ?
+            (_a = combinedPartialLengths.unsequencedRecords) === null || _a === void 0 ? void 0 : _a.partialLengths : combinedPartialLengths.partialLengths;
+        if (partials === undefined) {
+            // Local partial but its computation isn't required
+            return;
+        }
+        const partialsLen = partials.length;
         // Find the first entry with sequence number greater or equal to seq
         let indexFirstGTE = 0;
-        for (; indexFirstGTE < seqPartialsLen; indexFirstGTE++) {
-            if (seqPartials[indexFirstGTE].seq >= seq) {
+        for (; indexFirstGTE < partialsLen; indexFirstGTE++) {
+            if (partials[indexFirstGTE].seq >= seqOrLocalSeq) {
                 break;
             }
         }
-        if ((indexFirstGTE < seqPartialsLen) && (seqPartials[indexFirstGTE].seq === seq)) {
-            seqPartials[indexFirstGTE].seglen += segmentLen;
+        let partialLengthEntry;
+        if (((_b = partials[indexFirstGTE]) === null || _b === void 0 ? void 0 : _b.seq) === seqOrLocalSeq) {
+            partialLengthEntry = partials[indexFirstGTE];
+            // Existing entry at this seq--this occurs for ops that insert/delete more than one segment.
+            partialLengthEntry.seglen += segmentLen;
             if (removeClientOverlap) {
-                PartialSequenceLengths.accumulateRemoveClientOverlap(seqPartials[indexFirstGTE], removeClientOverlap, segmentLen);
+                PartialSequenceLengths.accumulateRemoveClientOverlap(partials[indexFirstGTE], removeClientOverlap, segmentLen);
             }
         }
         else {
-            let pLen;
-            if (removeClientOverlap) {
-                const overlapClients = PartialSequenceLengths.getOverlapClients(removeClientOverlap, segmentLen);
-                pLen = { seq, clientId, len: 0, seglen: segmentLen, overlapRemoveClients: overlapClients };
-            }
-            else {
-                pLen = { seq, clientId, len: 0, seglen: segmentLen };
+            partialLengthEntry = {
+                seq: seqOrLocalSeq,
+                clientId,
+                len: 0,
+                seglen: segmentLen,
+                overlapRemoveClients: removeClientOverlap
+                    ? PartialSequenceLengths.getOverlapClients(removeClientOverlap, segmentLen)
+                    : undefined,
+            };
+            // TODO: investigate performance improvement using BST
+            insertIntoList(partials, indexFirstGTE, partialLengthEntry);
+        }
+        const { unsequencedRecords } = combinedPartialLengths;
+        if (unsequencedRecords && removeClientOverlap && segment.localRemovedSeq !== undefined) {
+            const localSeq = segment.localRemovedSeq;
+            const localPartialLengthEntry = {
+                seq: seqOrLocalSeq,
+                localSeq,
+                clientId,
+                len: 0,
+                seglen: segmentLen,
+            };
+            let localIndexFirstGTE = 0;
+            for (; localIndexFirstGTE < unsequencedRecords.overlappingRemoves.length; localIndexFirstGTE++) {
+                if (unsequencedRecords.overlappingRemoves[localIndexFirstGTE].seq >= seqOrLocalSeq) {
+                    break;
+                }
             }
-            if (indexFirstGTE < seqPartialsLen) {
-                // Shift entries with greater sequence numbers
-                // TODO: investigate performance improvement using BST
-                for (let k = seqPartialsLen; k > indexFirstGTE; k--) {
-                    seqPartials[k] = seqPartials[k - 1];
+            insertIntoList(unsequencedRecords.overlappingRemoves, localIndexFirstGTE, localPartialLengthEntry);
+            localIndexFirstGTE = 0;
+            for (; localIndexFirstGTE < unsequencedRecords.partialLengths.length; localIndexFirstGTE++) {
+                if (unsequencedRecords.partialLengths[localIndexFirstGTE].seq >= localSeq) {
+                    break;
                 }
-                seqPartials[indexFirstGTE] = pLen;
+            }
+            const tweakedLocalPartialEntry = Object.assign(Object.assign({}, localPartialLengthEntry), { seq: localSeq });
+            if (((_c = unsequencedRecords.partialLengths[localIndexFirstGTE]) === null || _c === void 0 ? void 0 : _c.seq) === localSeq) {
+                unsequencedRecords.partialLengths[localIndexFirstGTE].seglen += localPartialLengthEntry.seglen;
             }
             else {
-                seqPartials.push(pLen);
+                insertIntoList(unsequencedRecords.partialLengths, localIndexFirstGTE, tweakedLocalPartialEntry);
             }
         }
     }
@@ -321,11 +382,11 @@ class PartialSequenceLengths {
                 penultPartialLen = pLen;
             }
         }
+        const len = penultPartialLen !== undefined ? penultPartialLen.len + seqSeglen : seqSeglen;
         if (seqPartialLen === undefined) {
-            // len will be assigned below, making this assertion true.
-            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
             seqPartialLen = {
                 clientId,
+                len,
                 seglen: seqSeglen,
                 seq,
             };
@@ -333,19 +394,15 @@ class PartialSequenceLengths {
         }
         else {
             seqPartialLen.seglen = seqSeglen;
+            seqPartialLen.len = len;
             // Assert client id matches
         }
-        if (penultPartialLen !== undefined) {
-            seqPartialLen.len = seqPartialLen.seglen + penultPartialLen.len;
-        }
-        else {
-            seqPartialLen.len = seqPartialLen.seglen;
-        }
     }
     // Assume: seq is latest sequence number; no structural change to sub-tree, but a segment
-    // with sequence number seq has been added within the sub-tree
+    // with sequence number seq has been added within the sub-tree (and `update` has been called
+    // on all descendant PartialSequenceLengths)
     // TODO: assert client id matches
-    update(mergeTree, node, seq, clientId, collabWindow) {
+    update(node, seq, clientId, collabWindow) {
         let seqSeglen = 0;
         let segCount = 0;
         // Compute length for seq across children
@@ -367,7 +424,7 @@ class PartialSequenceLengths {
             }
             else {
                 const segment = child;
-                const removalInfo = (0, mergeTree_1.toRemovalInfo)(segment);
+                const removalInfo = (0, mergeTreeNodes_1.toRemovalInfo)(segment);
                 if (segment.seq === seq) {
                     if ((removalInfo === null || removalInfo === void 0 ? void 0 : removalInfo.removedSeq) !== seq) {
                         seqSeglen += segment.cachedLength;
@@ -382,6 +439,7 @@ class PartialSequenceLengths {
             }
         }
         this.segmentCount = segCount;
+        this.unsequencedRecords = undefined;
         PartialSequenceLengths.addSeq(this.partialLengths, seq, seqSeglen, clientId);
         if (this.clientSeqNumbers[clientId] === undefined) {
             this.clientSeqNumbers[clientId] = [];
@@ -391,17 +449,28 @@ class PartialSequenceLengths {
             this.zamboni(collabWindow);
         }
         if (PartialSequenceLengths.options.verify) {
-            this.verify();
+            verify(this);
         }
     }
-    getPartialLength(refSeq, clientId) {
+    /**
+     * Returns the length of this block as viewed from the perspective of `clientId` at `refSeq`.
+     * This is the total length of all segments sequenced at or before refSeq OR submitted by `clientId`.
+     * If `clientId` is the local client, `localSeq` can also be provided. In that case, it is the total
+     * length of all segments submitted at or before `refSeq` in addition to any local, unacked segments
+     * with `segment.localSeq <= localSeq`.
+     *
+     * Note: the local case (where `localSeq !== undefined`) is only supported on a PartialSequenceLength object
+     * constructed with `computeLocalPartials` set to true and not subsequently updated with `update`.
+     */
+    getPartialLength(refSeq, clientId, localSeq) {
         let pLen = this.minLength;
         const seqIndex = latestLEQ(this.partialLengths, refSeq);
         const cliLatestIndex = this.cliLatest(clientId);
         const cliSeq = this.clientSeqNumbers[clientId];
         if (seqIndex >= 0) {
-            // Add the partial length up to refSeq
             pLen += this.partialLengths[seqIndex].len;
+        }
+        if (localSeq === undefined) {
             if (cliLatestIndex >= 0) {
                 const cliLatest = cliSeq[cliLatestIndex];
                 if (cliLatest.seq > refSeq) {
@@ -409,21 +478,73 @@ class PartialSequenceLengths {
                     pLen += cliLatest.len;
                     const precedingCliIndex = this.cliLatestLEQ(clientId, refSeq);
                     if (precedingCliIndex >= 0) {
+                        // Subtract out double-counted lengths: segments still in the collab window but before
+                        // the refSeq submitted by the client we're querying for were counted in each addition above.
                         pLen -= cliSeq[precedingCliIndex].len;
                     }
                 }
             }
         }
         else {
-            // RefSeq is before any of the partial lengths
-            // so just add in all local edits of that client (which should all be after the refSeq)
-            if (cliLatestIndex >= 0) {
-                const cliLatest = cliSeq[cliLatestIndex];
-                pLen += cliLatest.len;
+            (0, common_utils_1.assert)(this.unsequencedRecords !== undefined, 0x39f /* Local getPartialLength invoked without computing local partials. */);
+            const unsequencedPartialLengths = this.unsequencedRecords.partialLengths;
+            // Local segments at or before localSeq should also be included
+            const localIndex = latestLEQ(unsequencedPartialLengths, localSeq);
+            if (localIndex >= 0) {
+                pLen += unsequencedPartialLengths[localIndex].len;
+                // Lastly, we must subtract out any double-counted removes, which occur if a currently un-acked local
+                // remove overlaps with a remote client's remove that occurred at sequence number <=refSeq.
+                pLen -= this.computeOverlappingLocalRemoves(refSeq, localSeq);
             }
         }
         return pLen;
     }
+    /**
+     * Computes the seglen for the double-counted removed overlap at (refSeq, localSeq). This logic is equivalent
+     * to the following:
+     *
+     * ```typescript
+     *   let total = 0;
+     *   for (const partialLength of this.unsequencedRecords!.overlappingRemoves) {
+     *       if (partialLength.seq > refSeq) {
+     *           break;
+     *       }
+     *
+     *      if (partialLength.localSeq <= localSeq) {
+     *          total += partialLength.seglen;
+     *      }
+     *   }
+     *
+     *   return total;
+     * ```
+     *
+     * Reconnect happens to only need to compute these lengths for two refSeq values: before and
+     * after the rebase. Since these lists potentially scale with O(collab window * number of local edits)
+     * and potentially need to be queried for each local op that gets rebased,
+     * we cache the results for a given refSeq in `this.unsequencedRecords.cachedOverlappingByRefSeq` so
+     * that they can be binary-searched the same way the usual partialLengths lists are.
+     */
+    computeOverlappingLocalRemoves(refSeq, localSeq) {
+        if (this.unsequencedRecords === undefined) {
+            return 0;
+        }
+        let cachedOverlapPartials = this.unsequencedRecords.cachedOverlappingByRefSeq.get(refSeq);
+        if (!cachedOverlapPartials) {
+            const partials = [];
+            for (const partial of this.unsequencedRecords.overlappingRemoves) {
+                if (partial.seq > refSeq) {
+                    break;
+                }
+                partials.push(Object.assign(Object.assign({}, partial), { seq: partial.localSeq, len: 0 }));
+            }
+            partials.sort((a, b) => a.seq - b.seq);
+            // This coalesces entries with the same localSeq as well as computes overall lengths.
+            cachedOverlapPartials = mergePartialLengths([partials]);
+            this.unsequencedRecords.cachedOverlappingByRefSeq.set(refSeq, cachedOverlapPartials);
+        }
+        const overlapIndex = latestLEQ(cachedOverlapPartials, localSeq);
+        return overlapIndex >= 0 ? cachedOverlapPartials[overlapIndex].len : 0;
+    }
     toString(glc, indentCount = 0) {
         let buf = "";
         for (const partial of this.partialLengths) {
@@ -433,12 +554,7 @@ class PartialSequenceLengths {
         for (const clientId in this.clientSeqNumbers) {
             if (this.clientSeqNumbers[clientId].length > 0) {
                 buf += `Client `;
-                if (glc) {
-                    buf += `${glc(+clientId)}`;
-                }
-                else {
-                    buf += `${clientId}`;
-                }
+                buf += glc ? `${glc(+clientId)}` : `${clientId}`;
                 buf += "[";
                 for (const partial of this.clientSeqNumbers[clientId]) {
                     buf += `(${partial.seq},${partial.len})`;
@@ -471,6 +587,7 @@ class PartialSequenceLengths {
             return minLength;
         }
         this.minLength += copyDown(this.partialLengths);
+        this.minSeq = segmentWindow.minSeq;
         // eslint-disable-next-line @typescript-eslint/no-for-in-array, guard-for-in, no-restricted-syntax
         for (const clientId in this.clientSeqNumbers) {
             const cliPartials = this.clientSeqNumbers[clientId];
@@ -490,106 +607,231 @@ class PartialSequenceLengths {
         }
         cli.push({ seq, len: pLen, seglen });
     }
-    // Assumes sequence number already coalesced
+    // Assumes sequence number already coalesced and that this is called in increasing `seq` order.
     addClientSeqNumberFromPartial(partialLength) {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         this.addClientSeqNumber(partialLength.clientId, partialLength.seq, partialLength.seglen);
         if (partialLength.overlapRemoveClients) {
             partialLength.overlapRemoveClients.map((oc) => {
-                this.addClientSeqNumber(oc.data.clientId, partialLength.seq, oc.data.seglen);
+                // Original client entry was handled above
+                if (partialLength.clientId !== oc.data.clientId) {
+                    this.addClientSeqNumber(oc.data.clientId, partialLength.seq, oc.data.seglen);
+                }
                 return true;
             });
         }
     }
     cliLatestLEQ(clientId, refSeq) {
         const cliSeqs = this.clientSeqNumbers[clientId];
-        if (cliSeqs) {
-            return latestLEQ(cliSeqs, refSeq);
-        }
-        else {
-            return -1;
-        }
+        return cliSeqs ? latestLEQ(cliSeqs, refSeq) : -1;
     }
     cliLatest(clientId) {
         const cliSeqs = this.clientSeqNumbers[clientId];
-        if (cliSeqs && (cliSeqs.length > 0)) {
-            return cliSeqs.length - 1;
+        return cliSeqs && (cliSeqs.length > 0) ? cliSeqs.length - 1 : -1;
+    }
+}
+exports.PartialSequenceLengths = PartialSequenceLengths;
+PartialSequenceLengths.options = {
+    verify: false,
+    zamboni: true,
+};
+/* eslint-disable @typescript-eslint/dot-notation */
+function verifyPartialLengths(partialSeqLengths, partialLengths, clientPartials) {
+    if (partialLengths.length === 0) {
+        return 0;
+    }
+    let lastSeqNum = 0;
+    let accumSegLen = 0;
+    let count = 0;
+    for (const partialLength of partialLengths) {
+        // Count total number of partial length
+        count++;
+        // Sequence number should be larger or equal to minseq
+        (0, common_utils_1.assert)(partialSeqLengths.minSeq <= partialLength.seq, 0x054 /* "Sequence number less than minSeq!" */);
+        // Sequence number should be sorted
+        (0, common_utils_1.assert)(lastSeqNum < partialLength.seq, 0x055 /* "Sequence number is not sorted!" */);
+        lastSeqNum = partialLength.seq;
+        // Len is a accumulation of all the seglen adjustments
+        accumSegLen += partialLength.seglen;
+        if (accumSegLen !== partialLength.len) {
+            (0, common_utils_1.assert)(false, 0x056 /* "Unexpected total for accumulation of all seglen adjustments!" */);
+        }
+        if (clientPartials) {
+            // Client partials used to track local edits so we can account for them some refSeq.
+            // But the information we keep track of are since minSeq, so we keep track of more history
+            // then needed, and some of them doesn't make sense to be used for length calculations
+            // e.g. if you have this sequence, where the minSeq is #5 because of other clients
+            //    seq 10: client 1: insert seg #1
+            //    seq 11: client 2: delete seg #2 refseq: 10
+            // minLength is 0, we would have keep a record of seglen: -1 for clientPartialLengths for client 2
+            // So if you ask for partial length for client 2 @ seq 5, we will have return -1.
+            // However, that combination is invalid, since we should never see any ops with refseq < 10 for
+            // client 2 after seq 11.
         }
         else {
-            return -1;
+            // Len adjustment should not make length negative
+            if (partialSeqLengths["minLength"] + partialLength.len < 0) {
+                (0, common_utils_1.assert)(false, 0x057 /* "Negative length after length adjustment!" */);
+            }
+        }
+        if (partialLength.overlapRemoveClients) {
+            // Only the flat partialLengths can have overlapRemoveClients, the per client view shouldn't
+            (0, common_utils_1.assert)(!clientPartials, 0x058 /* "Both overlapRemoveClients and clientPartials are set!" */);
+            // Each overlap client count as one, but the first remove to sequence was already counted.
+            // (this aligns with the logic to omit the removing client in `addClientSeqNumberFromPartial`)
+            count += partialLength.overlapRemoveClients.size() - 1;
         }
     }
-    // Debug only
-    verifyPartialLengths(partialLengths, clientPartials) {
-        if (partialLengths.length === 0) {
-            return 0;
+    return count;
+}
+function verify(partialSeqLengths) {
+    if (partialSeqLengths["clientSeqNumbers"]) {
+        let cliCount = 0;
+        for (const cliSeq of partialSeqLengths["clientSeqNumbers"]) {
+            if (cliSeq) {
+                cliCount += verifyPartialLengths(partialSeqLengths, cliSeq, true);
+            }
+        }
+        // If we have client view, we should have the flat view
+        (0, common_utils_1.assert)(!!partialSeqLengths["partialLengths"], 0x059 /* "Client view exists but flat view does not!" */);
+        const flatCount = verifyPartialLengths(partialSeqLengths, partialSeqLengths["partialLengths"], false);
+        // The number of partial lengths on the client view and flat view should be the same
+        (0, common_utils_1.assert)(flatCount === cliCount, 0x05a /* "Mismatch between number of partial lengths on client and flat views!" */);
+    }
+    else {
+        // If we don't have a client view, we shouldn't have the flat view either
+        (0, common_utils_1.assert)(!partialSeqLengths["partialLengths"], 0x05b /* "Flat view exists but client view does not!" */);
+    }
+}
+/* eslint-enable @typescript-eslint/dot-notation */
+/**
+ * Clones an `overlapRemoveClients` red-black tree.
+ */
+function cloneOverlapRemoveClients(oldTree) {
+    if (!oldTree) {
+        return undefined;
+    }
+    const newTree = new collections_1.RedBlackTree(mergeTreeNodes_1.compareNumbers);
+    oldTree.map((bProp) => {
+        newTree.put(bProp.data.clientId, Object.assign({}, bProp.data));
+        return true;
+    });
+    return newTree;
+}
+/**
+ * Combines the `overlapRemoveClients` field of two `PartialSequenceLength` objects,
+ * modifying the first PartialSequenceLength's bookkeeping in-place.
+ *
+ * Combination is performed additively on `seglen` on a per-client basis.
+ */
+function combineOverlapClients(a, b) {
+    const overlapRemoveClientsA = a.overlapRemoveClients;
+    if (overlapRemoveClientsA) {
+        if (b.overlapRemoveClients) {
+            b.overlapRemoveClients.map((bProp) => {
+                const aProp = overlapRemoveClientsA.get(bProp.key);
+                if (aProp) {
+                    aProp.data.seglen += bProp.data.seglen;
+                }
+                else {
+                    overlapRemoveClientsA.put(bProp.data.clientId, Object.assign({}, bProp.data));
+                }
+                return true;
+            });
+        }
+    }
+    else {
+        a.overlapRemoveClients = cloneOverlapRemoveClients(b.overlapRemoveClients);
+    }
+}
+/**
+ * Given a number of seq-sorted `partialLength` lists, merges them into a combined seq-sorted `partialLength`
+ * list. This merge includes coalescing `PartialSequenceLength` entries at the same seq.
+ *
+ * Ex: merging the following two lists (some information omitted on each PartialSequenceLength):
+ * ```typescript
+ * [{ seq: 1, seglen: 5 }, { seq: 3, seglen: -1 }]
+ * [{ seq: 1, seglen: -3 }, { seq: 2: seglen: 4 }]
+ * ```
+ * would produce
+ * ```typescript
+ * [{ seq: 1, seglen: 2 }, { seq: 2, seglen: 4 }, { seq: 3, seglen: -1 }]
+ * ```
+ */
+function mergePartialLengths(childPartialLengths) {
+    var _a;
+    const mergedLengths = [];
+    // All child PartialSequenceLengths are now sorted temporally (i.e. by seq). Since
+    // a given MergeTree operation can affect multiple segments, there may be multiple entries
+    // for a given seq. We run through them in order, coalescing all length information for a given
+    // seq together into `combinedPartialLengths`.
+    let currentPartial;
+    for (const partialLength of mergeSortedListsBySeq(childPartialLengths)) {
+        if (!currentPartial || currentPartial.seq !== partialLength.seq) {
+            // Start a new seq entry.
+            currentPartial = Object.assign(Object.assign({}, partialLength), { len: ((_a = currentPartial === null || currentPartial === void 0 ? void 0 : currentPartial.len) !== null && _a !== void 0 ? _a : 0) + partialLength.seglen, overlapRemoveClients: cloneOverlapRemoveClients(partialLength.overlapRemoveClients) });
+            mergedLengths.push(currentPartial);
+        }
+        else {
+            // Update existing entry
+            currentPartial.seglen += partialLength.seglen;
+            currentPartial.len += partialLength.seglen;
+            combineOverlapClients(currentPartial, partialLength);
         }
-        let lastSeqNum = 0;
-        let accumSegLen = 0;
-        let count = 0;
-        for (const partialLength of partialLengths) {
-            // Count total number of partial length
-            count++;
-            // Sequence number should be larger or equal to minseq
-            (0, common_utils_1.assert)(this.minSeq <= partialLength.seq, 0x054 /* "Sequence number less than minSeq!" */);
-            // Sequence number should be sorted
-            (0, common_utils_1.assert)(lastSeqNum < partialLength.seq, 0x055 /* "Sequence number is not sorted!" */);
-            lastSeqNum = partialLength.seq;
-            // Len is a accumulation of all the seglen adjustments
-            accumSegLen += partialLength.seglen;
-            if (accumSegLen !== partialLength.len) {
-                (0, common_utils_1.assert)(false, 0x056 /* "Unexpected total for accumulation of all seglen adjustments!" */);
+    }
+    return mergedLengths;
+}
+/**
+ * Given a collection of PartialSequenceLength lists--each sorted by sequence number--returns an iterable that yields
+ * each PartialSequenceLength in sequence order.
+ *
+ * This is equivalent to flattening the input list and sorting it by sequence number. If the number of lists to merge is
+ * a constant, however, this approach is advantageous asymptotically.
+ */
+function mergeSortedListsBySeq(lists) {
+    class PartialSequenceLengthIterator {
+        constructor(sublists) {
+            this.sublists = sublists;
+            this.nextSmallestIndex = new Array(sublists.length);
+            for (let i = 0; i < sublists.length; i++) {
+                this.nextSmallestIndex[i] = 0;
+            }
+        }
+        next() {
+            const len = this.sublists.length;
+            let currentMin;
+            let currentMinIndex;
+            for (let i = 0; i < len; i++) {
+                const candidateIndex = this.nextSmallestIndex[i];
+                if (candidateIndex < this.sublists[i].length) {
+                    const candidate = this.sublists[i][candidateIndex];
+                    if (!currentMin || candidate.seq < currentMin.seq) {
+                        currentMin = candidate;
+                        currentMinIndex = i;
+                    }
+                }
             }
-            if (clientPartials) {
-                // Client partials used to track local edits so we can account for them some refSeq.
-                // But the information we keep track of are since minSeq, so we keep track of more history
-                // then needed, and some of them doesn't make sense to be used for length calculations
-                // e.g. if you have this sequence, where the minSeq is #5 because of other clients
-                //    seq 10: client 1: insert seg #1
-                //    seq 11: client 2: delete seg #2 refseq: 10
-                // minLength is 0, we would have keep a record of seglen: -1 for clientPartialLengths for client 2
-                // So if you ask for partial length for client 2 @ seq 5, we will have return -1.
-                // However, that combination is invalid, since we should never see any ops with refseq < 10 for
-                // client 2 after seq 11.
+            if (currentMin) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                this.nextSmallestIndex[currentMinIndex]++;
+                return { value: currentMin, done: false };
             }
             else {
-                // Len adjustment should not make length negative
-                if (this.minLength + partialLength.len < 0) {
-                    (0, common_utils_1.assert)(false, 0x057 /* "Negative length after length adjustment!" */);
-                }
-            }
-            if (partialLength.overlapRemoveClients) {
-                // Only the flat partialLengths can have overlapRemoveClients, the per client view shouldn't
-                (0, common_utils_1.assert)(!clientPartials, 0x058 /* "Both overlapRemoveClients and clientPartials are set!" */);
-                // Each overlap client count as one
-                count += partialLength.overlapRemoveClients.size();
+                return { value: undefined, done: true };
             }
         }
-        return count;
     }
-    verify() {
-        if (this.clientSeqNumbers) {
-            let cliCount = 0;
-            for (const cliSeq of this.clientSeqNumbers) {
-                if (cliSeq) {
-                    cliCount += this.verifyPartialLengths(cliSeq, true);
-                }
-            }
-            // If we have client view, we should have the flat view
-            (0, common_utils_1.assert)(!!this.partialLengths, 0x059 /* "Client view exists but flat view does not!" */);
-            const flatCount = this.verifyPartialLengths(this.partialLengths, false);
-            // The number of partial lengths on the client view and flat view should be the same
-            (0, common_utils_1.assert)(flatCount === cliCount, 0x05a /* "Mismatch between number of partial lengths on client and flat views!" */);
-        }
-        else {
-            // If we don't have a client view, we shouldn't have the flat view either
-            (0, common_utils_1.assert)(!this.partialLengths, 0x05b /* "Flat view exists but client view does not!" */);
+    return { [Symbol.iterator]: () => new PartialSequenceLengthIterator(lists) };
+}
+function insertIntoList(list, index, elem) {
+    if (index < list.length) {
+        for (let k = list.length; k > index; k--) {
+            list[k] = list[k - 1];
         }
+        list[index] = elem;
+    }
+    else {
+        list.push(elem);
     }
 }
-exports.PartialSequenceLengths = PartialSequenceLengths;
-PartialSequenceLengths.options = {
-    verify: false,
-    zamboni: true,
-};
 //# sourceMappingURL=partialLengths.js.map