@fluidframework/merge-tree 0.54.3 → 0.55.2

package/src/client.ts

@@ -5,9 +5,11 @@
 
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
-import { IFluidHandle, IFluidSerializer } from "@fluidframework/core-interfaces";
-import { ISequencedDocumentMessage, ITree, MessageType } from "@fluidframework/protocol-definitions";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { IFluidSerializer } from "@fluidframework/shared-object-base";
+import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 import { IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { assert, Trace } from "@fluidframework/common-utils";
 import { LoggingError } from "@fluidframework/telemetry-utils";
@@ -873,29 +875,27 @@ export class Client {
         return new MergeTreeTextHelper(this.mergeTree);
     }
 
-    // TODO: Remove `catchUpMsgs` once new snapshot format is adopted as default.
-    //       (See https://github.com/microsoft/FluidFramework/issues/84)
-    public snapshot(
+    public summarize(
         runtime: IFluidDataStoreRuntime,
         handle: IFluidHandle,
         serializer: IFluidSerializer,
         catchUpMsgs: ISequencedDocumentMessage[],
-    ): ITree {
+    ): ISummaryTreeWithStats {
         const deltaManager = runtime.deltaManager;
         const minSeq = deltaManager.minimumSequenceNumber;
 
         // Catch up to latest MSN, if we have not had a chance to do it.
         // Required for case where FluidDataStoreRuntime.attachChannel()
-        // generates snapshot right after loading data store.
+        // generates summary right after loading data store.
 
         this.updateSeqNumbers(minSeq, deltaManager.lastSequenceNumber);
 
-        // One of the snapshots (from SPO) I observed to have chunk.chunkSequenceNumber > minSeq!
+        // One of the summaries (from SPO) I observed to have chunk.chunkSequenceNumber > minSeq!
         // Not sure why - need to catch it sooner
         assert(this.getCollabWindow().minSeq === minSeq,
             0x03e /* "minSeq mismatch between collab window and delta manager!" */);
 
-        // TODO: Remove options flag once new snapshot format is adopted as default.
+        // Must continue to support legacy
         //       (See https://github.com/microsoft/FluidFramework/issues/84)
         if (this.mergeTree.options?.newMergeTreeSnapshotFormat === true) {
             assert(

package/src/collections.ts

@@ -61,6 +61,7 @@ export class List<T> {
     public next: List<T>;
     public prev: List<T>;
 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly
     constructor(public isHead: boolean, private data: T | undefined) {
         this.prev = this;
         this.next = this;

package/src/partialLengths.ts

@@ -177,7 +177,8 @@ export class PartialSequenceLengths {
                     // 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
+                        // eslint-disable-next-line max-len
+                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-unnecessary-type-assertion
                         if ((outerIndexOfEarliest < 0) || (cpLen.seq < earliestPartialLength!.seq)) {
                             outerIndexOfEarliest = k;
                             earliestPartialLength = cpLen;
@@ -185,7 +186,8 @@ export class PartialSequenceLengths {
                     }
                 }
                 if (outerIndexOfEarliest >= 0) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    // eslint-disable-next-line max-len
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-unnecessary-type-assertion
                     addNext(earliestPartialLength!);
                     indices[outerIndexOfEarliest]++;
                 }

package/src/snapshotChunks.ts

@@ -5,10 +5,8 @@
 
  /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
-import {
-    IFluidSerializer,
-    IFluidHandle,
-} from "@fluidframework/core-interfaces";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { PropertySet } from "./properties";
 import { SnapshotLegacy } from "./snapshotlegacy";

package/src/snapshotLoader.ts

@@ -6,7 +6,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
 import { assert, bufferToString } from "@fluidframework/common-utils";
-import { IFluidSerializer } from "@fluidframework/core-interfaces";
+import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";

package/src/snapshotV1.ts

@@ -4,19 +4,13 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import {
-    IFluidHandle,
-    IFluidSerializer,
-} from "@fluidframework/core-interfaces";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { assert, bufferToString } from "@fluidframework/common-utils";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
-import {
-    FileMode,
-    ITree,
-    TreeEntry,
-    ITreeEntry,
-} from "@fluidframework/protocol-definitions";
 import { IChannelStorageService } from "@fluidframework/datastore-definitions";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import { UnassignedSequenceNumber } from "./constants";
 import {
     ISegment,
@@ -98,13 +92,13 @@ export class SnapshotV1 {
     }
 
     /**
-     * Emits the snapshot to an ITree. If provided the optional IFluidSerializer will be used when serializing
-     * the summary data rather than JSON.stringify.
+     * Emits the snapshot to an ISummarizeResult. If provided the optional IFluidSerializer will be used when
+     * serializing the summary data rather than JSON.stringify.
      */
     emit(
         serializer: IFluidSerializer,
         bind: IFluidHandle,
-    ): ITree {
+    ): ISummaryTreeWithStats {
         const chunks: MergeTreeChunkV1[] = [];
         this.header.totalSegmentCount = 0;
         this.header.totalLength = 0;
@@ -124,48 +118,32 @@ export class SnapshotV1 {
         const headerChunk = chunks.shift()!;
         headerChunk.headerMetadata = this.header;
         headerChunk.headerMetadata.orderedChunkMetadata = [{ id: SnapshotLegacy.header }];
-        const entries: ITreeEntry[] = chunks.map<ITreeEntry>((chunk, index) => {
+        const blobs: [key: string, content: string][] = [];
+        chunks.forEach((chunk, index) => {
             const id = `${SnapshotLegacy.body}_${index}`;
             this.header.orderedChunkMetadata.push({ id });
-            return {
-                mode: FileMode.File,
-                path: id,
-                type: TreeEntry.Blob,
-                value: {
-                    contents: serializeAsMaxSupportedVersion(
-                        id,
-                        chunk,
-                        this.logger,
-                        this.mergeTree.options,
-                        serializer,
-                        bind),
-                    encoding: "utf-8",
-                },
-            };
+            blobs.push([id, serializeAsMaxSupportedVersion(
+                id,
+                chunk,
+                this.logger,
+                this.mergeTree.options,
+                serializer,
+                bind)]);
         });
 
-        const tree: ITree = {
-            entries: [
-                {
-                    mode: FileMode.File,
-                    path: SnapshotLegacy.header,
-                    type: TreeEntry.Blob,
-                    value: {
-                        contents: serializeAsMaxSupportedVersion(
-                            SnapshotLegacy.header,
-                            headerChunk,
-                            this.logger,
-                            this.mergeTree.options,
-                            serializer,
-                            bind),
-                        encoding: "utf-8",
-                    },
-                },
-                ...entries,
-            ],
-        };
+        const builder = new SummaryTreeBuilder();
+        builder.addBlob(SnapshotLegacy.header, serializeAsMaxSupportedVersion(
+            SnapshotLegacy.header,
+            headerChunk,
+            this.logger,
+            this.mergeTree.options,
+            serializer,
+            bind));
+        blobs.forEach((value) => {
+            builder.addBlob(value[0], value[1]);
+        });
 
-        return tree;
+        return builder.getSummaryTree();
     }
 
     extractSync() {

package/src/snapshotlegacy.ts

@@ -7,12 +7,12 @@
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { assert } from "@fluidframework/common-utils";
-import {
-    IFluidHandle,
-    IFluidSerializer,
-} from "@fluidframework/core-interfaces";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { IFluidSerializer } from "@fluidframework/shared-object-base";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
-import { FileMode, ISequencedDocumentMessage, ITree, TreeEntry } from "@fluidframework/protocol-definitions";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import { NonCollabClient, UnassignedSequenceNumber } from "./constants";
 import {
     ISegment,
@@ -89,57 +89,38 @@ export class SnapshotLegacy {
     }
 
     /**
-     * Emits the snapshot to an ITree. If provided the optional IFluidSerializer will be used when serializing
-     * the summary data rather than JSON.stringify.
+     * Emits the snapshot to an ISummarizeResult. If provided the optional IFluidSerializer will be used when
+     * serializing the summary data rather than JSON.stringify.
      */
     emit(
         catchUpMsgs: ISequencedDocumentMessage[],
         serializer: IFluidSerializer,
         bind: IFluidHandle,
-    ): ITree {
+    ): ISummaryTreeWithStats {
         const chunk1 = this.getSeqLengthSegs(this.segments!, this.segmentLengths!, this.chunkSize);
         let length: number = chunk1.chunkLengthChars;
         let segments: number = chunk1.chunkSegmentCount;
-        const tree: ITree = {
-            entries: [
-                {
-                    mode: FileMode.File,
-                    path: SnapshotLegacy.header,
-                    type: TreeEntry.Blob,
-                    value: {
-                        contents: serializeAsMinSupportedVersion(
-                            SnapshotLegacy.header,
-                            chunk1,
-                            this.logger,
-                            this.mergeTree.options,
-                            serializer,
-                            bind),
-                        encoding: "utf-8",
-                    },
-                },
-            ],
-        };
+        const builder = new SummaryTreeBuilder();
+        builder.addBlob(SnapshotLegacy.header, serializeAsMinSupportedVersion(
+            SnapshotLegacy.header,
+            chunk1,
+            this.logger,
+            this.mergeTree.options,
+            serializer,
+            bind));
 
         if (chunk1.chunkSegmentCount < chunk1.totalSegmentCount!) {
             const chunk2 = this.getSeqLengthSegs(this.segments!, this.segmentLengths!,
                 this.header!.segmentsTotalLength, chunk1.chunkSegmentCount);
             length += chunk2.chunkLengthChars;
             segments += chunk2.chunkSegmentCount;
-            tree.entries.push({
-                mode: FileMode.File,
-                path: SnapshotLegacy.body,
-                type: TreeEntry.Blob,
-                value: {
-                    contents: serializeAsMinSupportedVersion(
-                        SnapshotLegacy.body,
-                        chunk2,
-                        this.logger,
-                        this.mergeTree.options,
-                        serializer,
-                        bind),
-                    encoding: "utf-8",
-                },
-            });
+            builder.addBlob(SnapshotLegacy.body, serializeAsMinSupportedVersion(
+                SnapshotLegacy.body,
+                chunk2,
+                this.logger,
+                this.mergeTree.options,
+                serializer,
+                bind));
         }
 
         assert(
@@ -151,18 +132,12 @@ export class SnapshotLegacy {
             0x05e /* "emit: mismatch in totalSegmentCount" */);
 
         if(catchUpMsgs !== undefined && catchUpMsgs.length > 0) {
-            tree.entries.push({
-                mode: FileMode.File,
-                path: this.mergeTree.options?.catchUpBlobName ?? SnapshotLegacy.catchupOps,
-                type: TreeEntry.Blob,
-                value: {
-                    contents: serializer ? serializer.stringify(catchUpMsgs, bind) : JSON.stringify(catchUpMsgs),
-                    encoding: "utf-8",
-                },
-            });
+            builder.addBlob(
+                this.mergeTree.options?.catchUpBlobName ?? SnapshotLegacy.catchupOps,
+                serializer ? serializer.stringify(catchUpMsgs, bind) : JSON.stringify(catchUpMsgs));
         }
 
-        return tree;
+        return builder.getSummaryTree();
     }
 
     extractSync() {