@fluidframework/merge-tree 0.58.2000 → 0.58.3000-61081

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/merge-tree",
-  "version": "0.58.2000",
+  "version": "0.58.3000-61081",
   "description": "Merge tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -31,7 +31,7 @@
     "lint:fix": "npm run eslint:fix",
     "test": "npm run test:mocha",
     "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --recursive dist/test --exit -r node_modules/@fluidframework/mocha-test-setup -r source-map-support/register --unhandled-rejections=strict",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test --exit -r node_modules/@fluidframework/mocha-test-setup -r source-map-support/register --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
@@ -62,18 +62,19 @@
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/container-definitions": "^0.47.1000",
     "@fluidframework/core-interfaces": "^0.42.0",
-    "@fluidframework/datastore-definitions": "^0.58.2000",
+    "@fluidframework/datastore-definitions": "0.58.3000-61081",
     "@fluidframework/protocol-definitions": "^0.1027.1000",
-    "@fluidframework/runtime-definitions": "^0.58.2000",
-    "@fluidframework/runtime-utils": "^0.58.2000",
-    "@fluidframework/shared-object-base": "^0.58.2000",
-    "@fluidframework/telemetry-utils": "^0.58.2000"
+    "@fluidframework/runtime-definitions": "0.58.3000-61081",
+    "@fluidframework/runtime-utils": "0.58.3000-61081",
+    "@fluidframework/shared-object-base": "0.58.3000-61081",
+    "@fluidframework/telemetry-utils": "0.58.3000-61081"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.27.0",
-    "@fluidframework/mocha-test-setup": "^0.58.2000",
-    "@fluidframework/test-runtime-utils": "^0.58.2000",
+    "@fluidframework/eslint-config-fluid": "^0.27.2000-59622",
+    "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@0.58.2000",
+    "@fluidframework/mocha-test-setup": "0.58.3000-61081",
+    "@fluidframework/test-runtime-utils": "0.58.3000-61081",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/diff": "^3.5.1",
@@ -100,5 +101,10 @@
     "source-map-support": "^0.5.16",
     "typescript": "~4.1.3",
     "typescript-formatter": "7.1.0"
+  },
+  "typeValidation": {
+    "version": "0.58.3000",
+    "broken": {},
+    "disabled": true
   }
 }

package/src/client.ts

@@ -545,6 +545,8 @@ export class Client {
             }
         }
 
+        // start and end are guaranteed to be non-null here, otherwise we throw above.
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         return { start, end } as IIntegerRange;
     }
 

package/src/collections.ts

@@ -190,6 +190,7 @@ export class Heap<T> {
         this.fixup(this.count());
     }
 
+    /* eslint-disable no-bitwise */
     private fixup(k: number) {
         let _k = k;
         while (_k > 1 && (this.comp.compare(this.L[_k >> 1], this.L[_k]) > 0)) {
@@ -216,6 +217,7 @@ export class Heap<T> {
             _k = j;
         }
     }
+    /* eslint-enable no-bitwise */
 }
 
 export const enum RBColor {

package/src/localReference.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { assert } from "@fluidframework/common-utils";
 import { Client } from "./client";
 import {
     ISegment,
@@ -133,8 +134,14 @@ export class LocalReferenceCollection {
             if (!seg1.localRefs) {
                 seg1.localRefs = new LocalReferenceCollection(seg1);
             }
+            assert(seg1.localRefs.refsByOffset.length === seg1.cachedLength, "LocalReferences array contains a gap");
             seg1.localRefs.append(seg2.localRefs);
         }
+        else if (seg1.localRefs) {
+            // Since creating the LocalReferenceCollection, we may have appended
+            // segments that had no local references. Account for them now by padding the array.
+            seg1.localRefs.refsByOffset.length += seg2.cachedLength;
+        }
     }
 
     public hierRefCount: number = 0;

package/src/mergeTree.ts

@@ -1035,10 +1035,6 @@ export class MergeTree {
 
     private static readonly initBlockUpdateActions: BlockUpdateActions;
     private static readonly theUnfinishedNode = <IMergeBlock>{ childCount: -1 };
-    // WARNING:
-    // Setting blockUpdateMarkers to false will result in eventual consistency issues
-    // for property updates on markers when loading from snapshots
-    private static readonly blockUpdateMarkers = true;
 
     root: IMergeBlock;
     private readonly blockUpdateActions: BlockUpdateActions = MergeTree.initBlockUpdateActions;
@@ -1059,12 +1055,7 @@ export class MergeTree {
     }
 
     private makeBlock(childCount: number) {
-        let block: MergeBlock;
-        if (MergeTree.blockUpdateMarkers) {
-            block = new HierMergeBlock(childCount);
-        } else {
-            block = new MergeBlock(childCount);
-        }
+        const block: MergeBlock = new HierMergeBlock(childCount);
         block.ordinal = "";
         return block;
     }

package/src/partialLengths.ts

@@ -366,6 +366,8 @@ export class PartialSequenceLengths {
             }
         }
         if (seqPartialLen === undefined) {
+            // len will be assigned below, making this assertion true.
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
             seqPartialLen = {
                 clientId,
                 seglen: seqSeglen,

package/src/snapshotChunks.ts

@@ -62,7 +62,11 @@ export interface IJSONSegmentWithMergeInfo {
     json: IJSONSegment;
     client?: string;
     seq?: number;
+    /**
+     * @deprecated - use removedClientIds instead. this only exists for back-compat
+     */
     removedClient?: string;
+    removedClientIds?: string[];
     removedSeq?: number;
 }
 

package/src/snapshotLoader.ts

@@ -102,9 +102,20 @@ export class SnapshotLoader {
             if (spec.removedSeq !== undefined) {
                 seg.removedSeq = spec.removedSeq;
             }
+            // this format had a bug where it didn't store all the overlap clients
+            // this is for back compat, so we change the singular id to an array
+            // this will only cause problems if there is an overlapping delete
+            // spanning the snapshot, which should be rare
             if (spec.removedClient !== undefined) {
                 seg.removedClientId = this.client.getOrAddShortClientId(spec.removedClient);
             }
+            if (spec.removedClientIds !== undefined) {
+                seg.removedClientId = this.client.getOrAddShortClientId(spec.removedClientIds[0]);
+                if(spec.removedClientIds.length > 1) {
+                    seg.removedClientOverlap = spec.removedClientIds.slice(1).map(
+                        (sid)=> this.client.getOrAddShortClientId(sid));
+                }
+            }
         } else {
             seg = this.client.specToSegment(spec);
             seg.seq = UniversalSequenceNumber;

package/src/snapshotV1.ts

@@ -218,8 +218,17 @@ export class SnapshotV1 {
                     assert(segment.removedSeq !== UnassignedSequenceNumber && segment.removedSeq > minSeq,
                         0x065 /* "On removal info preservation, segment has invalid removed sequence number!" */);
                     raw.removedSeq = segment.removedSeq;
+
+                    // back compat for when we split overlap and removed client
                     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                     raw.removedClient = this.getLongClientId(segment.removedClientId!);
+
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    const removedClientIds = [segment.removedClientId!];
+                    if(segment.removedClientOverlap !== undefined) {
+                        removedClientIds.push(... segment.removedClientOverlap);
+                    }
+                    raw.removedClientIds = removedClientIds.map((id)=>this.getLongClientId(id));
                 }
 
             // Sanity check that we are preserving either the seq < minSeq or a removed segment's info.