@fluidframework/tree 2.116.0-416006 → 2.116.1

package/dist/feature-libraries/comparison-forest/comparisonForest.js

@@ -5,7 +5,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComparisonForest = void 0;
+const tslib_1 = require("tslib");
 const index_js_1 = require("../../core/index.js");
+const index_js_2 = require("../../util/index.js");
 const treeTextCursor_js_1 = require("../treeTextCursor.js");
 /**
  * An {@link IEditableForest} which wraps two other forests: a `main` forest and a `reference` forest.
@@ -24,75 +26,90 @@ const treeTextCursor_js_1 = require("../treeTextCursor.js");
  * This forest is intentionally expensive: it maintains two full copies of the data and re-reads and
  * structurally compares all of their contents after every delta.
  */
-class ComparisonForest {
-    /**
-     * @param main - The forest whose behavior is under test.
-     * All reads are delegated to this forest, and it is the source of truth for anchors and events.
-     * @param reference - The forest to compare against.
-     * This forest receives all the same deltas as `main`, and its contents are asserted to match `main` after each delta.
-     */
-    constructor(main, reference) {
-        this.main = main;
-        this.reference = reference;
-        this.assertValid();
-    }
-    assertValid() {
-        (0, treeTextCursor_js_1.assertForestsEqual)(this.main, this.reference);
-    }
-    get events() {
-        return this.main.events;
-    }
-    get anchors() {
-        return this.main.anchors;
-    }
-    get isEmpty() {
-        return this.main.isEmpty;
-    }
-    clone(schema, breaker) {
-        this.assertValid();
-        return new ComparisonForest(this.main.clone(schema, breaker), this.reference.clone(schema, breaker));
-    }
-    chunkField(cursor) {
-        return this.main.chunkField(cursor);
-    }
-    allocateCursor(source) {
-        // Currently we just use the cursor from "main", but we could use "reference" or a custom cursor ensuring both match in behavior.
-        // TODO: Add a custom combined cursor type which validates two cursors match, and use it here.
-        return this.main.allocateCursor(source);
-    }
-    forgetAnchor(anchor) {
-        this.main.forgetAnchor(anchor);
-    }
-    tryMoveCursorToNode(destination, cursorToMove) {
-        return this.main.tryMoveCursorToNode(destination, cursorToMove);
-    }
-    tryMoveCursorToField(destination, cursorToMove) {
-        return this.main.tryMoveCursorToField(destination, cursorToMove);
-    }
-    moveCursorToPath(destination, cursorToMove) {
-        this.main.moveCursorToPath(destination, cursorToMove);
-    }
-    getCursorAboveDetachedFields() {
-        return this.main.getCursorAboveDetachedFields();
-    }
-    registerAnnouncedVisitor(visitor) {
-        this.main.registerAnnouncedVisitor(visitor);
-    }
-    deregisterAnnouncedVisitor(visitor) {
-        this.main.deregisterAnnouncedVisitor(visitor);
-    }
-    acquireVisitor() {
-        this.assertValid();
-        const main = this.main;
-        const reference = this.reference;
-        const mainVisitor = main.acquireVisitor();
-        const referenceVisitor = reference.acquireVisitor();
-        // A visitor which does nothing except assert the two forests match once the delta has been fully applied to both.
-        const comparisonVisitor = (0, index_js_1.createAnnouncedVisitor)({
-            free: () => this.assertValid(),
-        });
-        return (0, index_js_1.combineVisitors)([mainVisitor, referenceVisitor, comparisonVisitor]);
-    }
-}
+let ComparisonForest = (() => {
+    var _a;
+    let _instanceExtraInitializers = [];
+    let _assertValid_decorators;
+    return _a = class ComparisonForest {
+            /**
+             * @param main - The forest whose behavior is under test.
+             * All reads are delegated to this forest, and it is the source of truth for anchors and events.
+             * @param reference - The forest to compare against.
+             * This forest receives all the same deltas as `main`, and its contents are asserted to match `main` after each delta.
+             */
+            constructor(main, reference) {
+                this.main = (tslib_1.__runInitializers(this, _instanceExtraInitializers), main);
+                this.reference = reference;
+                this.assertValid();
+            }
+            assertValid() {
+                (0, treeTextCursor_js_1.assertForestsEqual)(this.main, this.reference);
+            }
+            get events() {
+                return this.main.events;
+            }
+            get anchors() {
+                return this.main.anchors;
+            }
+            get isEmpty() {
+                return this.main.isEmpty;
+            }
+            get breaker() {
+                return this.main.breaker;
+            }
+            clone(schema, breaker) {
+                this.assertValid();
+                return new _a(this.main.clone(schema, breaker), this.reference.clone(schema, breaker));
+            }
+            chunkField(cursor) {
+                return this.main.chunkField(cursor);
+            }
+            allocateCursor(source) {
+                // Currently we just use the cursor from "main", but we could use "reference" or a custom cursor ensuring both match in behavior.
+                // TODO: Add a custom combined cursor type which validates two cursors match, and use it here.
+                return this.main.allocateCursor(source);
+            }
+            forgetAnchor(anchor) {
+                this.main.forgetAnchor(anchor);
+            }
+            tryMoveCursorToNode(destination, cursorToMove) {
+                return this.main.tryMoveCursorToNode(destination, cursorToMove);
+            }
+            tryMoveCursorToField(destination, cursorToMove) {
+                return this.main.tryMoveCursorToField(destination, cursorToMove);
+            }
+            moveCursorToPath(destination, cursorToMove) {
+                this.main.moveCursorToPath(destination, cursorToMove);
+            }
+            getCursorAboveDetachedFields() {
+                return this.main.getCursorAboveDetachedFields();
+            }
+            registerAnnouncedVisitor(visitor) {
+                this.main.registerAnnouncedVisitor(visitor);
+            }
+            deregisterAnnouncedVisitor(visitor) {
+                this.main.deregisterAnnouncedVisitor(visitor);
+            }
+            acquireVisitor() {
+                this.assertValid();
+                const main = this.main;
+                const reference = this.reference;
+                const mainVisitor = main.acquireVisitor();
+                const referenceVisitor = reference.acquireVisitor();
+                // A visitor which does nothing except assert the two forests match once the delta has been fully applied to both.
+                const comparisonVisitor = (0, index_js_1.createAnnouncedVisitor)({
+                    free: () => this.assertValid(),
+                });
+                return (0, index_js_1.combineVisitors)([mainVisitor, referenceVisitor, comparisonVisitor]);
+            }
+        },
+        (() => {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            _assertValid_decorators = [index_js_2.breakingMethod];
+            tslib_1.__esDecorate(_a, null, _assertValid_decorators, { kind: "method", name: "assertValid", static: false, private: false, access: { has: obj => "assertValid" in obj, get: obj => obj.assertValid }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        })(),
+        _a;
+})();
 exports.ComparisonForest = ComparisonForest;
 //# sourceMappingURL=comparisonForest.js.map

package/dist/feature-libraries/comparison-forest/comparisonForest.js.map

@@ -1 +1 @@
-{"version":3,"file":"comparisonForest.js","sourceRoot":"","sources":["../../../src/feature-libraries/comparison-forest/comparisonForest.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,kDAgB6B;AAG7B,4DAA0D;AAE1D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,gBAAgB;IAC5B;;;;;OAKG;IACH,YACiB,IAAqB,EACrB,SAA0B;QAD1B,SAAI,GAAJ,IAAI,CAAiB;QACrB,cAAS,GAAT,SAAS,CAAiB;QAE1C,IAAI,CAAC,WAAW,EAAE,CAAC;IACpB,CAAC;IAEO,WAAW;QAClB,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACzB,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC1B,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,MAAoC,EAAE,OAAmB;QACrE,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,OAAO,IAAI,gBAAgB,CAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CACrC,CAAC;IACH,CAAC;IAEM,UAAU,CAAC,MAA8B;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAEM,cAAc,CAAC,MAAe;QACpC,iIAAiI;QACjI,8FAA8F;QAC9F,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAEM,YAAY,CAAC,MAAc;QACjC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAEM,mBAAmB,CACzB,WAAmB,EACnB,YAAqC;QAErC,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACjE,CAAC;IAEM,oBAAoB,CAC1B,WAAwB,EACxB,YAAqC;QAErC,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAClE,CAAC;IAEM,gBAAgB,CAAC,WAAmB,EAAE,YAAqC;QACjF,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACvD,CAAC;IAEM,4BAA4B;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC;IACjD,CAAC;IAEM,wBAAwB,CAAC,OAA+B;QAC9D,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,0BAA0B,CAAC,OAA+B;QAChE,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAEM,cAAc;QACpB,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,gBAAgB,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;QACpD,kHAAkH;QAClH,MAAM,iBAAiB,GAAG,IAAA,iCAAsB,EAAC;YAChD,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;SAC9B,CAAC,CAAC;QACH,OAAO,IAAA,0BAAe,EAAC,CAAC,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAC5E,CAAC;CACD;AA9FD,4CA8FC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { Listenable } from \"@fluidframework/core-interfaces\";\n\nimport {\n\ttype Anchor,\n\ttype AnchorSet,\n\ttype AnnouncedVisitor,\n\ttype DeltaVisitor,\n\ttype FieldAnchor,\n\ttype ForestEvents,\n\ttype IEditableForest,\n\ttype ITreeCursorSynchronous,\n\ttype ITreeSubscriptionCursor,\n\ttype TreeChunk,\n\ttype TreeNavigationResult,\n\ttype TreeStoredSchemaSubscription,\n\ttype UpPath,\n\tcombineVisitors,\n\tcreateAnnouncedVisitor,\n} from \"../../core/index.js\";\nimport type { Breakable } from \"../../util/index.js\";\n\nimport { assertForestsEqual } from \"../treeTextCursor.js\";\n\n/**\n * An {@link IEditableForest} which wraps two other forests: a `main` forest and a `reference` forest.\n *\n * @remarks\n * All read operations are delegated to `main`, so from the outside a `ComparisonForest` behaves exactly like its `main` forest.\n *\n * When a delta is applied (via {@link IEditableForest.acquireVisitor}), the delta is applied to both `main` and `reference`.\n * Once the visitor is freed, the full contents of both forests (including all detached/removed fields) are compared,\n * and an error is thrown if they differ.\n *\n * This is a testing/debugging aid: it allows validating that a forest implementation (for example the optimized `ChunkedForest`)\n * produces the same results as a simpler reference implementation (for example the `ObjectForest`) for every delta that is applied.\n *\n * @privateRemarks\n * This forest is intentionally expensive: it maintains two full copies of the data and re-reads and\n * structurally compares all of their contents after every delta.\n */\nexport class ComparisonForest implements IEditableForest {\n\t/**\n\t * @param main - The forest whose behavior is under test.\n\t * All reads are delegated to this forest, and it is the source of truth for anchors and events.\n\t * @param reference - The forest to compare against.\n\t * This forest receives all the same deltas as `main`, and its contents are asserted to match `main` after each delta.\n\t */\n\tpublic constructor(\n\t\tpublic readonly main: IEditableForest,\n\t\tpublic readonly reference: IEditableForest,\n\t) {\n\t\tthis.assertValid();\n\t}\n\n\tprivate assertValid(): void {\n\t\tassertForestsEqual(this.main, this.reference);\n\t}\n\n\tpublic get events(): Listenable<ForestEvents> {\n\t\treturn this.main.events;\n\t}\n\n\tpublic get anchors(): AnchorSet {\n\t\treturn this.main.anchors;\n\t}\n\n\tpublic get isEmpty(): boolean {\n\t\treturn this.main.isEmpty;\n\t}\n\n\tpublic clone(schema: TreeStoredSchemaSubscription, breaker?: Breakable): ComparisonForest {\n\t\tthis.assertValid();\n\t\treturn new ComparisonForest(\n\t\t\tthis.main.clone(schema, breaker),\n\t\t\tthis.reference.clone(schema, breaker),\n\t\t);\n\t}\n\n\tpublic chunkField(cursor: ITreeCursorSynchronous): TreeChunk[] {\n\t\treturn this.main.chunkField(cursor);\n\t}\n\n\tpublic allocateCursor(source?: string): ITreeSubscriptionCursor {\n\t\t// Currently we just use the cursor from \"main\", but we could use \"reference\" or a custom cursor ensuring both match in behavior.\n\t\t// TODO: Add a custom combined cursor type which validates two cursors match, and use it here.\n\t\treturn this.main.allocateCursor(source);\n\t}\n\n\tpublic forgetAnchor(anchor: Anchor): void {\n\t\tthis.main.forgetAnchor(anchor);\n\t}\n\n\tpublic tryMoveCursorToNode(\n\t\tdestination: Anchor,\n\t\tcursorToMove: ITreeSubscriptionCursor,\n\t): TreeNavigationResult {\n\t\treturn this.main.tryMoveCursorToNode(destination, cursorToMove);\n\t}\n\n\tpublic tryMoveCursorToField(\n\t\tdestination: FieldAnchor,\n\t\tcursorToMove: ITreeSubscriptionCursor,\n\t): TreeNavigationResult {\n\t\treturn this.main.tryMoveCursorToField(destination, cursorToMove);\n\t}\n\n\tpublic moveCursorToPath(destination: UpPath, cursorToMove: ITreeSubscriptionCursor): void {\n\t\tthis.main.moveCursorToPath(destination, cursorToMove);\n\t}\n\n\tpublic getCursorAboveDetachedFields(): ITreeCursorSynchronous {\n\t\treturn this.main.getCursorAboveDetachedFields();\n\t}\n\n\tpublic registerAnnouncedVisitor(visitor: () => AnnouncedVisitor): void {\n\t\tthis.main.registerAnnouncedVisitor(visitor);\n\t}\n\n\tpublic deregisterAnnouncedVisitor(visitor: () => AnnouncedVisitor): void {\n\t\tthis.main.deregisterAnnouncedVisitor(visitor);\n\t}\n\n\tpublic acquireVisitor(): DeltaVisitor {\n\t\tthis.assertValid();\n\t\tconst main = this.main;\n\t\tconst reference = this.reference;\n\t\tconst mainVisitor = main.acquireVisitor();\n\t\tconst referenceVisitor = reference.acquireVisitor();\n\t\t// A visitor which does nothing except assert the two forests match once the delta has been fully applied to both.\n\t\tconst comparisonVisitor = createAnnouncedVisitor({\n\t\t\tfree: () => this.assertValid(),\n\t\t});\n\t\treturn combineVisitors([mainVisitor, referenceVisitor, comparisonVisitor]);\n\t}\n}\n"]}
+{"version":3,"file":"comparisonForest.js","sourceRoot":"","sources":["../../../src/feature-libraries/comparison-forest/comparisonForest.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAIH,kDAgB6B;AAC7B,kDAAqE;AAErE,4DAA0D;AAE1D;;;;;;;;;;;;;;;;GAgBG;IACU,gBAAgB;;;;sBAAhB,gBAAgB;YAC5B;;;;;eAKG;YACH,YACiB,IAAqB,EACrB,SAA0B;gBAD1B,SAAI,IART,2DAAgB,EAQX,IAAI,EAAiB;gBACrB,cAAS,GAAT,SAAS,CAAiB;gBAE1C,IAAI,CAAC,WAAW,EAAE,CAAC;YACpB,CAAC;YAGO,WAAW;gBAClB,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/C,CAAC;YAED,IAAW,MAAM;gBAChB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YACzB,CAAC;YAED,IAAW,OAAO;gBACjB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1B,CAAC;YAED,IAAW,OAAO;gBACjB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1B,CAAC;YAED,IAAW,OAAO;gBACjB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1B,CAAC;YAEM,KAAK,CAAC,MAAoC,EAAE,OAAmB;gBACrE,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnB,OAAO,IAAI,EAAgB,CAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CACrC,CAAC;YACH,CAAC;YAEM,UAAU,CAAC,MAA8B;gBAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACrC,CAAC;YAEM,cAAc,CAAC,MAAe;gBACpC,iIAAiI;gBACjI,8FAA8F;gBAC9F,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YACzC,CAAC;YAEM,YAAY,CAAC,MAAc;gBACjC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;YAEM,mBAAmB,CACzB,WAAmB,EACnB,YAAqC;gBAErC,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YACjE,CAAC;YAEM,oBAAoB,CAC1B,WAAwB,EACxB,YAAqC;gBAErC,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YAClE,CAAC;YAEM,gBAAgB,CAAC,WAAmB,EAAE,YAAqC;gBACjF,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YACvD,CAAC;YAEM,4BAA4B;gBAClC,OAAO,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACjD,CAAC;YAEM,wBAAwB,CAAC,OAA+B;gBAC9D,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,CAAC;YAEM,0BAA0B,CAAC,OAA+B;gBAChE,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;YAC/C,CAAC;YAEM,cAAc;gBACpB,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;gBACvB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;gBACjC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC1C,MAAM,gBAAgB,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;gBACpD,kHAAkH;gBAClH,MAAM,iBAAiB,GAAG,IAAA,iCAAsB,EAAC;oBAChD,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;iBAC9B,CAAC,CAAC;gBACH,OAAO,IAAA,0BAAe,EAAC,CAAC,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC;YAC5E,CAAC;;;;uCApFA,yBAAc;YACf,0LAAQ,WAAW,6DAElB;;;;;AAjBW,4CAAgB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { Listenable } from \"@fluidframework/core-interfaces\";\n\nimport {\n\ttype Anchor,\n\ttype AnchorSet,\n\ttype AnnouncedVisitor,\n\ttype DeltaVisitor,\n\ttype FieldAnchor,\n\ttype ForestEvents,\n\ttype IEditableForest,\n\ttype ITreeCursorSynchronous,\n\ttype ITreeSubscriptionCursor,\n\ttype TreeChunk,\n\ttype TreeNavigationResult,\n\ttype TreeStoredSchemaSubscription,\n\ttype UpPath,\n\tcombineVisitors,\n\tcreateAnnouncedVisitor,\n} from \"../../core/index.js\";\nimport { breakingMethod, type Breakable } from \"../../util/index.js\";\n\nimport { assertForestsEqual } from \"../treeTextCursor.js\";\n\n/**\n * An {@link IEditableForest} which wraps two other forests: a `main` forest and a `reference` forest.\n *\n * @remarks\n * All read operations are delegated to `main`, so from the outside a `ComparisonForest` behaves exactly like its `main` forest.\n *\n * When a delta is applied (via {@link IEditableForest.acquireVisitor}), the delta is applied to both `main` and `reference`.\n * Once the visitor is freed, the full contents of both forests (including all detached/removed fields) are compared,\n * and an error is thrown if they differ.\n *\n * This is a testing/debugging aid: it allows validating that a forest implementation (for example the optimized `ChunkedForest`)\n * produces the same results as a simpler reference implementation (for example the `ObjectForest`) for every delta that is applied.\n *\n * @privateRemarks\n * This forest is intentionally expensive: it maintains two full copies of the data and re-reads and\n * structurally compares all of their contents after every delta.\n */\nexport class ComparisonForest implements IEditableForest {\n\t/**\n\t * @param main - The forest whose behavior is under test.\n\t * All reads are delegated to this forest, and it is the source of truth for anchors and events.\n\t * @param reference - The forest to compare against.\n\t * This forest receives all the same deltas as `main`, and its contents are asserted to match `main` after each delta.\n\t */\n\tpublic constructor(\n\t\tpublic readonly main: IEditableForest,\n\t\tpublic readonly reference: IEditableForest,\n\t) {\n\t\tthis.assertValid();\n\t}\n\n\t@breakingMethod\n\tprivate assertValid(): void {\n\t\tassertForestsEqual(this.main, this.reference);\n\t}\n\n\tpublic get events(): Listenable<ForestEvents> {\n\t\treturn this.main.events;\n\t}\n\n\tpublic get anchors(): AnchorSet {\n\t\treturn this.main.anchors;\n\t}\n\n\tpublic get isEmpty(): boolean {\n\t\treturn this.main.isEmpty;\n\t}\n\n\tpublic get breaker(): Breakable {\n\t\treturn this.main.breaker;\n\t}\n\n\tpublic clone(schema: TreeStoredSchemaSubscription, breaker?: Breakable): ComparisonForest {\n\t\tthis.assertValid();\n\t\treturn new ComparisonForest(\n\t\t\tthis.main.clone(schema, breaker),\n\t\t\tthis.reference.clone(schema, breaker),\n\t\t);\n\t}\n\n\tpublic chunkField(cursor: ITreeCursorSynchronous): TreeChunk[] {\n\t\treturn this.main.chunkField(cursor);\n\t}\n\n\tpublic allocateCursor(source?: string): ITreeSubscriptionCursor {\n\t\t// Currently we just use the cursor from \"main\", but we could use \"reference\" or a custom cursor ensuring both match in behavior.\n\t\t// TODO: Add a custom combined cursor type which validates two cursors match, and use it here.\n\t\treturn this.main.allocateCursor(source);\n\t}\n\n\tpublic forgetAnchor(anchor: Anchor): void {\n\t\tthis.main.forgetAnchor(anchor);\n\t}\n\n\tpublic tryMoveCursorToNode(\n\t\tdestination: Anchor,\n\t\tcursorToMove: ITreeSubscriptionCursor,\n\t): TreeNavigationResult {\n\t\treturn this.main.tryMoveCursorToNode(destination, cursorToMove);\n\t}\n\n\tpublic tryMoveCursorToField(\n\t\tdestination: FieldAnchor,\n\t\tcursorToMove: ITreeSubscriptionCursor,\n\t): TreeNavigationResult {\n\t\treturn this.main.tryMoveCursorToField(destination, cursorToMove);\n\t}\n\n\tpublic moveCursorToPath(destination: UpPath, cursorToMove: ITreeSubscriptionCursor): void {\n\t\tthis.main.moveCursorToPath(destination, cursorToMove);\n\t}\n\n\tpublic getCursorAboveDetachedFields(): ITreeCursorSynchronous {\n\t\treturn this.main.getCursorAboveDetachedFields();\n\t}\n\n\tpublic registerAnnouncedVisitor(visitor: () => AnnouncedVisitor): void {\n\t\tthis.main.registerAnnouncedVisitor(visitor);\n\t}\n\n\tpublic deregisterAnnouncedVisitor(visitor: () => AnnouncedVisitor): void {\n\t\tthis.main.deregisterAnnouncedVisitor(visitor);\n\t}\n\n\tpublic acquireVisitor(): DeltaVisitor {\n\t\tthis.assertValid();\n\t\tconst main = this.main;\n\t\tconst reference = this.reference;\n\t\tconst mainVisitor = main.acquireVisitor();\n\t\tconst referenceVisitor = reference.acquireVisitor();\n\t\t// A visitor which does nothing except assert the two forests match once the delta has been fully applied to both.\n\t\tconst comparisonVisitor = createAnnouncedVisitor({\n\t\t\tfree: () => this.assertValid(),\n\t\t});\n\t\treturn combineVisitors([mainVisitor, referenceVisitor, comparisonVisitor]);\n\t}\n}\n"]}

package/dist/feature-libraries/detachedFieldIndexSummarizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"detachedFieldIndexSummarizer.js","sourceRoot":"","sources":["../../src/feature-libraries/detachedFieldIndexSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA8D;AAU9D,gDAK2B;AAC3B,+CAK0B;AAC1B,2DAKsC;AAGtC;;GAEG;AACU,QAAA,yBAAyB,GAAG,wBAAwB,CAAC;AAElE;;GAEG;AACH,IAAkB,sCAajB;AAbD,WAAkB,sCAAsC;IACvD;;OAEG;IACH,+FAAM,CAAA;IACN;;OAEG;IACH,+FAAM,CAAA;IACN;;OAEG;IACH,yGAAY,CAAA;AACb,CAAC,EAbiB,sCAAsC,sDAAtC,sCAAsC,QAavD;AAED,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAyC;;;CAGzE,CAAC,CAAC;AAEH;;GAEG;AACH,SAAS,kDAAkD,CAC1D,OAAgC;IAEhC,2EAA2E;IAC3E,yDAAiD;AAClD,CAAC;AAED;;GAEG;AACH,MAAa,4BACZ,SAAQ,8BAA2D;IAKnE,YACkB,kBAAsC,EACvD,gBAAkC,EAClC,YAA2B,EAC3B,OAA2B;QAE3B,MAAM,iBAAiB,GAAG,OAAO,IAAI;YACpC,aAAa,EAAE,8BAAmB;YAClC,mBAAmB,EAAE,6BAAkB,CAAC,IAAI;SAC5C,CAAC;QACF,KAAK,CACJ,oBAAoB,EACpB,kDAAkD,CACjD,iBAAiB,CAAC,mBAAmB,CACrC,EACD,iBAAiB,EACjB,IAAI,CACJ,CAAC;QAhBe,uBAAkB,GAAlB,kBAAkB,CAAoB;QAiBvD,IAAI,CAAC,KAAK,GAAG,yCAA8B,CAAC,KAAK,CAAC;YACjD,GAAG,iBAAiB;YACpB,gBAAgB;YAChB,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;IAES,iBAAiB,CAAC,KAO3B;QACA,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,CAAC,CAAC;QACzE,OAAO,CAAC,OAAO,CAAC,iCAAyB,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAES,KAAK,CAAC,YAAY,CAC3B,QAAgC,EAChC,KAA2B;QAE3B,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAAC,iCAAyB,CAAC,EAAE,CAAC;YACxD,MAAM,wBAAwB,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,iCAAyB,CAAC,CAAC;YACpF,MAAM,gBAAgB,GAAG,IAAA,6BAAc,EAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;YAC1E,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,CAA2B,CAAC;YACjE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC;IACF,CAAC;CACD;AAxDD,oEAwDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport type {\n\tIExperimentalIncrementalSummaryContext,\n\tITelemetryContext,\n\tMinimumVersionForCollab,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport type { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport {\n\ttype CodecWriteOptions,\n\tFluidClientVersion,\n\tFormatValidatorNoOp,\n\ttype IJsonCodec,\n} from \"../codec/index.js\";\nimport {\n\ttype DetachedFieldIndex,\n\ttype DetachedFieldSummaryData,\n\ttype RevisionTagCodec,\n\tdetachedFieldIndexCodecBuilder,\n} from \"../core/index.js\";\nimport {\n\ttype Summarizable,\n\ttype SummaryElementParser,\n\ttype SummaryElementStringifier,\n\tVersionedSummarizer,\n} from \"../shared-tree-core/index.js\";\nimport type { JsonCompatibleReadOnly } from \"../util/index.js\";\n\n/**\n * The storage key for the blob in the summary containing schema data\n */\nexport const detachedFieldIndexBlobKey = \"DetachedFieldIndexBlob\";\n\n/**\n * The versions for the detached field index summary format.\n */\nexport const enum DetachedFieldIndexSummaryFormatVersion {\n\t/**\n\t * This version represents summary format before summary versioning was introduced.\n\t */\n\tv1 = 1,\n\t/**\n\t * This version adds metadata to the summary. This is backward compatible with version 1.\n\t */\n\tv2 = 2,\n\t/**\n\t * The latest version of the summary. Must be updated when a new version is added.\n\t */\n\tvLatest = v2,\n}\n\nconst supportedVersions = new Set<DetachedFieldIndexSummaryFormatVersion>([\n\tDetachedFieldIndexSummaryFormatVersion.v1,\n\tDetachedFieldIndexSummaryFormatVersion.v2,\n]);\n\n/**\n * Returns the summary version to use as per the given minimum version for collab.\n */\nfunction minVersionToDetachedFieldIndexSummaryFormatVersion(\n\tversion: MinimumVersionForCollab,\n): DetachedFieldIndexSummaryFormatVersion {\n\t// Currently, version 2 is written which adds metadata blob to the summary.\n\treturn DetachedFieldIndexSummaryFormatVersion.v2;\n}\n\n/**\n * Provides methods for summarizing and loading a tree index.\n */\nexport class DetachedFieldIndexSummarizer\n\textends VersionedSummarizer<DetachedFieldIndexSummaryFormatVersion>\n\timplements Summarizable\n{\n\tprivate readonly codec: IJsonCodec<DetachedFieldSummaryData>;\n\n\tpublic constructor(\n\t\tprivate readonly detachedFieldIndex: DetachedFieldIndex,\n\t\trevisionTagCodec: RevisionTagCodec,\n\t\tidCompressor: IIdCompressor,\n\t\toptions?: CodecWriteOptions,\n\t) {\n\t\tconst normalizedOptions = options ?? {\n\t\t\tjsonValidator: FormatValidatorNoOp,\n\t\t\tminVersionForCollab: FluidClientVersion.v2_0,\n\t\t};\n\t\tsuper(\n\t\t\t\"DetachedFieldIndex\",\n\t\t\tminVersionToDetachedFieldIndexSummaryFormatVersion(\n\t\t\t\tnormalizedOptions.minVersionForCollab,\n\t\t\t),\n\t\t\tsupportedVersions,\n\t\t\ttrue,\n\t\t);\n\t\tthis.codec = detachedFieldIndexCodecBuilder.build({\n\t\t\t...normalizedOptions,\n\t\t\trevisionTagCodec,\n\t\t\tidCompressor,\n\t\t});\n\t}\n\n\tprotected summarizeInternal(props: {\n\t\tstringify: SummaryElementStringifier;\n\t\tfullTree?: boolean;\n\t\ttrackState?: boolean;\n\t\ttelemetryContext?: ITelemetryContext;\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext;\n\t\tbuilder: SummaryTreeBuilder;\n\t}): void {\n\t\tconst { stringify, builder } = props;\n\t\tconst data = this.codec.encode(this.detachedFieldIndex.getSummaryData());\n\t\tbuilder.addBlob(detachedFieldIndexBlobKey, stringify(data));\n\t}\n\n\tprotected async loadInternal(\n\t\tservices: IChannelStorageService,\n\t\tparse: SummaryElementParser,\n\t): Promise<void> {\n\t\tif (await services.contains(detachedFieldIndexBlobKey)) {\n\t\t\tconst detachedFieldIndexBuffer = await services.readBlob(detachedFieldIndexBlobKey);\n\t\t\tconst treeBufferString = bufferToString(detachedFieldIndexBuffer, \"utf8\");\n\t\t\tconst parsed = parse(treeBufferString) as JsonCompatibleReadOnly;\n\t\t\tconst decoded = this.codec.decode(parsed);\n\t\t\tthis.detachedFieldIndex.loadData(decoded);\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"detachedFieldIndexSummarizer.js","sourceRoot":"","sources":["../../src/feature-libraries/detachedFieldIndexSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA8D;AAU9D,gDAK2B;AAC3B,+CAK0B;AAC1B,2DAKsC;AAGtC;;GAEG;AACU,QAAA,yBAAyB,GAAG,wBAAwB,CAAC;AAElE;;GAEG;AACH,IAAkB,sCAajB;AAbD,WAAkB,sCAAsC;IACvD;;OAEG;IACH,+FAAM,CAAA;IACN;;OAEG;IACH,+FAAM,CAAA;IACN;;OAEG;IACH,yGAAY,CAAA;AACb,CAAC,EAbiB,sCAAsC,sDAAtC,sCAAsC,QAavD;AAED,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAyC;;;CAGzE,CAAC,CAAC;AAEH;;GAEG;AACH,SAAS,kDAAkD,CAC1D,OAAqC;IAErC,2EAA2E;IAC3E,yDAAiD;AAClD,CAAC;AAED;;GAEG;AACH,MAAa,4BACZ,SAAQ,8BAA2D;IAKnE,YACkB,kBAAsC,EACvD,gBAAkC,EAClC,YAA2B,EAC3B,OAA2B;QAE3B,MAAM,iBAAiB,GAAG,OAAO,IAAI;YACpC,aAAa,EAAE,8BAAmB;YAClC,mBAAmB,EAAE,6BAAkB,CAAC,IAAI;SAC5C,CAAC;QACF,KAAK,CACJ,oBAAoB,EACpB,kDAAkD,CACjD,iBAAiB,CAAC,mBAAmB,CACrC,EACD,iBAAiB,EACjB,IAAI,CACJ,CAAC;QAhBe,uBAAkB,GAAlB,kBAAkB,CAAoB;QAiBvD,IAAI,CAAC,KAAK,GAAG,yCAA8B,CAAC,KAAK,CAAC;YACjD,GAAG,iBAAiB;YACpB,gBAAgB;YAChB,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;IAES,iBAAiB,CAAC,KAO3B;QACA,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,CAAC,CAAC;QACzE,OAAO,CAAC,OAAO,CAAC,iCAAyB,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAES,KAAK,CAAC,YAAY,CAC3B,QAAgC,EAChC,KAA2B;QAE3B,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAAC,iCAAyB,CAAC,EAAE,CAAC;YACxD,MAAM,wBAAwB,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,iCAAyB,CAAC,CAAC;YACpF,MAAM,gBAAgB,GAAG,IAAA,6BAAc,EAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;YAC1E,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,CAA2B,CAAC;YACjE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC;IACF,CAAC;CACD;AAxDD,oEAwDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport type {\n\tIExperimentalIncrementalSummaryContext,\n\tITelemetryContext,\n\tOldestSupportedClientVersion,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport type { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport {\n\ttype CodecWriteOptions,\n\tFluidClientVersion,\n\tFormatValidatorNoOp,\n\ttype IJsonCodec,\n} from \"../codec/index.js\";\nimport {\n\ttype DetachedFieldIndex,\n\ttype DetachedFieldSummaryData,\n\ttype RevisionTagCodec,\n\tdetachedFieldIndexCodecBuilder,\n} from \"../core/index.js\";\nimport {\n\ttype Summarizable,\n\ttype SummaryElementParser,\n\ttype SummaryElementStringifier,\n\tVersionedSummarizer,\n} from \"../shared-tree-core/index.js\";\nimport type { JsonCompatibleReadOnly } from \"../util/index.js\";\n\n/**\n * The storage key for the blob in the summary containing schema data\n */\nexport const detachedFieldIndexBlobKey = \"DetachedFieldIndexBlob\";\n\n/**\n * The versions for the detached field index summary format.\n */\nexport const enum DetachedFieldIndexSummaryFormatVersion {\n\t/**\n\t * This version represents summary format before summary versioning was introduced.\n\t */\n\tv1 = 1,\n\t/**\n\t * This version adds metadata to the summary. This is backward compatible with version 1.\n\t */\n\tv2 = 2,\n\t/**\n\t * The latest version of the summary. Must be updated when a new version is added.\n\t */\n\tvLatest = v2,\n}\n\nconst supportedVersions = new Set<DetachedFieldIndexSummaryFormatVersion>([\n\tDetachedFieldIndexSummaryFormatVersion.v1,\n\tDetachedFieldIndexSummaryFormatVersion.v2,\n]);\n\n/**\n * Returns the summary version to use as per the given minimum version for collab.\n */\nfunction minVersionToDetachedFieldIndexSummaryFormatVersion(\n\tversion: OldestSupportedClientVersion,\n): DetachedFieldIndexSummaryFormatVersion {\n\t// Currently, version 2 is written which adds metadata blob to the summary.\n\treturn DetachedFieldIndexSummaryFormatVersion.v2;\n}\n\n/**\n * Provides methods for summarizing and loading a tree index.\n */\nexport class DetachedFieldIndexSummarizer\n\textends VersionedSummarizer<DetachedFieldIndexSummaryFormatVersion>\n\timplements Summarizable\n{\n\tprivate readonly codec: IJsonCodec<DetachedFieldSummaryData>;\n\n\tpublic constructor(\n\t\tprivate readonly detachedFieldIndex: DetachedFieldIndex,\n\t\trevisionTagCodec: RevisionTagCodec,\n\t\tidCompressor: IIdCompressor,\n\t\toptions?: CodecWriteOptions,\n\t) {\n\t\tconst normalizedOptions = options ?? {\n\t\t\tjsonValidator: FormatValidatorNoOp,\n\t\t\tminVersionForCollab: FluidClientVersion.v2_0,\n\t\t};\n\t\tsuper(\n\t\t\t\"DetachedFieldIndex\",\n\t\t\tminVersionToDetachedFieldIndexSummaryFormatVersion(\n\t\t\t\tnormalizedOptions.minVersionForCollab,\n\t\t\t),\n\t\t\tsupportedVersions,\n\t\t\ttrue,\n\t\t);\n\t\tthis.codec = detachedFieldIndexCodecBuilder.build({\n\t\t\t...normalizedOptions,\n\t\t\trevisionTagCodec,\n\t\t\tidCompressor,\n\t\t});\n\t}\n\n\tprotected summarizeInternal(props: {\n\t\tstringify: SummaryElementStringifier;\n\t\tfullTree?: boolean;\n\t\ttrackState?: boolean;\n\t\ttelemetryContext?: ITelemetryContext;\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext;\n\t\tbuilder: SummaryTreeBuilder;\n\t}): void {\n\t\tconst { stringify, builder } = props;\n\t\tconst data = this.codec.encode(this.detachedFieldIndex.getSummaryData());\n\t\tbuilder.addBlob(detachedFieldIndexBlobKey, stringify(data));\n\t}\n\n\tprotected async loadInternal(\n\t\tservices: IChannelStorageService,\n\t\tparse: SummaryElementParser,\n\t): Promise<void> {\n\t\tif (await services.contains(detachedFieldIndexBlobKey)) {\n\t\t\tconst detachedFieldIndexBuffer = await services.readBlob(detachedFieldIndexBlobKey);\n\t\t\tconst treeBufferString = bufferToString(detachedFieldIndexBuffer, \"utf8\");\n\t\t\tconst parsed = parse(treeBufferString) as JsonCompatibleReadOnly;\n\t\t\tconst decoded = this.codec.decode(parsed);\n\t\t\tthis.detachedFieldIndex.loadData(decoded);\n\t\t}\n\t}\n}\n"]}

package/dist/feature-libraries/forest-summary/forestSummarizer.d.ts

@@ -9,6 +9,7 @@ import type { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal"
 import type { CodecWriteOptions } from "../../codec/index.js";
 import { type IEditableForest } from "../../core/index.js";
 import { VersionedSummarizer, type Summarizable, type SummaryElementParser, type SummaryElementStringifier } from "../../shared-tree-core/index.js";
+import { type Breakable } from "../../util/index.js";
 import { type FieldBatchDecodingContext, type FieldBatchEncodingContext, type IncrementalEncodingPolicy } from "../chunked-forest/index.js";
 import { ForestSummaryFormatVersion } from "./summaryFormatCommon.js";
 /**
@@ -20,6 +21,10 @@ export declare class ForestSummarizer extends VersionedSummarizer<ForestSummaryF
     private readonly decoderContext;
     private readonly idCompressor;
     private readonly codec;
+    /**
+     * This object is broken if and only if the forest it owns is broken.
+     */
+    get breaker(): Breakable;
     private readonly incrementalSummaryBuilder;
     private readonly forestRootSummaryContentKey;
     /**

package/dist/feature-libraries/forest-summary/forestSummarizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forestSummarizer.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/forest-summary/forestSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACX,sCAAsC,EACtC,iBAAiB,EACjB,MAAM,8CAA8C,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAEjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAIN,KAAK,eAAe,EAOpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,mBAAmB,EACnB,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,MAAM,iCAAiC,CAAC;AAQzC,OAAO,EAEN,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,MAAM,4BAA4B,CAAC;AAQpC,OAAO,EACN,0BAA0B,EAG1B,MAAM,0BAA0B,CAAC;AAMlC;;GAEG;AACH,qBAAa,gBACZ,SAAQ,mBAAmB,CAAC,0BAA0B,CACtD,YAAW,YAAY;IAWtB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAE/B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAb9B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;IAEpC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAkC;IAC5E,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAS;IAErD;;OAEG;gBAEe,MAAM,EAAE,eAAe,EACvB,cAAc,EAAE,yBAAyB,EACzC,cAAc,EAAE,yBAAyB,EAC1D,OAAO,EAAE,iBAAiB,EACT,YAAY,EAAE,aAAa,EAC5C,qBAAqB,EAAE,MAAM,EAC7B,yBAAyB,GAAE,yBAA4D;IAgCxF;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE;QAClC,SAAS,EAAE,yBAAyB,CAAC;QACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;QACrC,yBAAyB,CAAC,EAAE,sCAAsC,CAAC;QACnE,OAAO,EAAE,kBAAkB,CAAC;KAC5B,GAAG,IAAI;cA8CQ,YAAY,CAC3B,QAAQ,EAAE,sBAAsB,EAChC,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,0BAA0B,GAAG,SAAS,GAC7C,OAAO,CAAC,IAAI,CAAC;CA2DhB"}
+{"version":3,"file":"forestSummarizer.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/forest-summary/forestSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACX,sCAAsC,EACtC,iBAAiB,EACjB,MAAM,8CAA8C,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAEjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAIN,KAAK,eAAe,EAOpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,mBAAmB,EACnB,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAIN,KAAK,SAAS,EAEd,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAEN,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,MAAM,4BAA4B,CAAC;AAQpC,OAAO,EACN,0BAA0B,EAG1B,MAAM,0BAA0B,CAAC;AAMlC;;GAEG;AACH,qBAAa,gBACZ,SAAQ,mBAAmB,CAAC,0BAA0B,CACtD,YAAW,YAAY;IAkBtB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAE/B,OAAO,CAAC,QAAQ,CAAC,YAAY;IApB9B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;IAEpC;;OAEG;IACH,IAAW,OAAO,IAAI,SAAS,CAE9B;IAED,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAkC;IAC5E,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAS;IAErD;;OAEG;gBAEe,MAAM,EAAE,eAAe,EACvB,cAAc,EAAE,yBAAyB,EACzC,cAAc,EAAE,yBAAyB,EAC1D,OAAO,EAAE,iBAAiB,EACT,YAAY,EAAE,aAAa,EAC5C,qBAAqB,EAAE,MAAM,EAC7B,yBAAyB,GAAE,yBAA4D;IAgCxF;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE;QAClC,SAAS,EAAE,yBAAyB,CAAC;QACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;QACrC,yBAAyB,CAAC,EAAE,sCAAsC,CAAC;QACnE,OAAO,EAAE,kBAAkB,CAAC;KAC5B,GAAG,IAAI;cA+CQ,YAAY,CAC3B,QAAQ,EAAE,sBAAsB,EAChC,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,0BAA0B,GAAG,SAAS,GAC7C,OAAO,CAAC,IAAI,CAAC;CA2DhB"}

package/dist/feature-libraries/forest-summary/forestSummarizer.js

@@ -5,6 +5,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForestSummarizer = void 0;
+const tslib_1 = require("tslib");
 const internal_1 = require("@fluidframework/core-utils/internal");
 const index_js_1 = require("../../core/index.js");
 const index_js_2 = require("../../shared-tree-core/index.js");
@@ -20,112 +21,131 @@ const summaryTypes_js_1 = require("./summaryTypes.js");
 /**
  * Provides methods for summarizing and loading a forest.
  */
-class ForestSummarizer extends index_js_2.VersionedSummarizer {
-    /**
-     * @param encoderContext - The schema if provided here must be mutated by the caller to keep it up to date.
-     */
-    constructor(forest, encoderContext, decoderContext, options, idCompressor, initialSequenceNumber, shouldEncodeIncrementally = index_js_4.defaultIncrementalEncodingPolicy) {
-        super(summaryFormatCommon_js_1.forestSummaryKey, (0, summaryTypes_js_1.minVersionToForestSummaryFormatVersion)(options.minVersionForCollab), summaryFormatCommon_js_1.supportedForestSummaryFormatVersions, true /* supportPreVersioningFormat */);
-        this.forest = forest;
-        this.encoderContext = encoderContext;
-        this.decoderContext = decoderContext;
-        this.idCompressor = idCompressor;
-        this.codec = codec_js_1.forestCodecBuilder.build(options);
-        const summaryFormatWriteVersion = (0, summaryTypes_js_1.minVersionToForestSummaryFormatVersion)(options.minVersionForCollab);
-        this.forestRootSummaryContentKey = (0, summaryTypes_js_1.getForestRootSummaryContentKey)(summaryFormatWriteVersion);
-        // Incremental summary is supported in ForestSummaryFormatVersion.v3 onwards.
-        // Note that even in versions that support it, it is possible that the
-        // FieldBatchCodec will not use incremental encoding (for example if using its v1 formats which does not support it).
-        const enableIncrementalSummary = summaryFormatWriteVersion >= summaryFormatCommon_js_1.ForestSummaryFormatVersion.v3 &&
-            encoderContext.encodeType === treeCompressionUtils_js_1.TreeCompressionStrategy.CompressedIncremental;
-        this.incrementalSummaryBuilder = new incrementalSummaryBuilder_js_1.ForestIncrementalSummaryBuilder(enableIncrementalSummary, (cursor) => this.forest.chunkField(cursor), shouldEncodeIncrementally, initialSequenceNumber);
-    }
-    /**
-     * Summarization of the forest's tree content.
-     * @returns a summary tree containing the forest's tree content.
-     * @remarks
-     * If incremental summary is disabled, all the content will be added to a single summary blob.
-     * If incremental summary is enabled, the summary will be a tree.
-     * See {@link ForestIncrementalSummaryBuilder} for details of what this tree looks like.
-     *
-     * TODO: when perf matters, this should be replaced with a chunked async version using a binary format.
-     */
-    summarizeInternal(props) {
-        const { stringify, fullTree = false, incrementalSummaryContext, builder } = props;
-        const rootCursor = this.forest.getCursorAboveDetachedFields();
-        const fieldMap = new Map();
-        // TODO: Encode all detached fields in one operation for better performance and compression
-        (0, index_js_1.forEachField)(rootCursor, (cursor) => {
-            const key = cursor.getFieldKey();
-            const innerCursor = this.forest.allocateCursor("getTreeString");
-            (0, internal_1.assert)(this.forest.tryMoveCursorToField({ fieldKey: key, parent: undefined }, innerCursor) ===
-                1 /* TreeNavigationResult.Ok */, 0x892 /* failed to navigate to field */);
-            fieldMap.set(key, innerCursor);
-        });
-        // Let the incremental summary builder know that we are starting a new summary.
-        // It returns whether incremental encoding is enabled.
-        const incrementalSummaryBehavior = this.incrementalSummaryBuilder.startSummary({
-            fullTree,
-            incrementalSummaryContext,
-            stringify,
-            builder,
-        });
-        const encoderContext = {
-            ...this.encoderContext,
-            incrementalEncoder: incrementalSummaryBehavior === incrementalSummaryBuilder_js_1.ForestIncrementalSummaryBehavior.Incremental
-                ? this.incrementalSummaryBuilder
-                : undefined,
-        };
-        const encoded = this.codec.encode(fieldMap, encoderContext);
-        for (const value of fieldMap.values()) {
-            value.free();
-        }
-        this.incrementalSummaryBuilder.completeSummary({
-            incrementalSummaryContext,
-            forestSummaryRootContent: stringify(encoded),
-            forestSummaryRootContentKey: this.forestRootSummaryContentKey,
-            builder,
-        });
-    }
-    async loadInternal(services, parse, version) {
-        // Get the key of the summary blob where the top-level forest content is stored based on the summary format version.
-        // If the summary was generated as `ForestIncrementalSummaryBehavior.SingleBlob`, this blob will contain all
-        // of forest's contents.
-        // If the summary was generated as `ForestIncrementalSummaryBehavior.Incremental`, this blob will contain only
-        // the top-level forest node's contents.
-        // The contents of the incremental chunks will be in separate tree nodes and will be read later during decoding.
-        const forestSummaryRootContentKey = (0, summaryTypes_js_1.getForestRootSummaryContentKey)(version);
-        (0, internal_1.assert)(await services.contains(forestSummaryRootContentKey), 0xc21 /* Forest summary content missing in snapshot */);
-        // Load the incremental summary builder so that it can download any incremental chunks in the
-        // snapshot.
-        await this.incrementalSummaryBuilder.load({
-            services,
-            readAndParseChunk: async (chunkBlobPath) => (0, index_js_3.readAndParseSnapshotBlob)(chunkBlobPath, services, parse),
-        });
-        // TODO: this code is parsing data without an optional validator, this should be defined in a typebox schema as part of the
-        // forest summary format.
-        const fields = this.codec.decode((await (0, index_js_3.readAndParseSnapshotBlob)(forestSummaryRootContentKey, services, parse)), this.decoderContext.withIncrementalDecoder(this.incrementalSummaryBuilder));
-        const allocator = (0, index_js_3.idAllocatorFromMaxId)();
-        const fieldChanges = [];
-        const build = [];
-        for (const [fieldKey, field] of fields) {
-            const chunked = (0, chunkTree_js_1.chunkFieldSingle)(field, {
-                policy: chunkTree_js_1.defaultChunkPolicy,
-                idCompressor: this.idCompressor,
-            });
-            const buildId = { minor: allocator.allocate(chunked.topLevelLength) };
-            build.push({
-                id: buildId,
-                trees: chunked,
-            });
-            fieldChanges.push([
-                fieldKey,
-                { marks: [{ count: chunked.topLevelLength, attach: buildId }] },
-            ]);
-        }
-        (0, internal_1.assert)(this.forest.isEmpty, 0x797 /* forest must be empty */);
-        (0, index_js_1.applyDelta)({ build, fields: new Map(fieldChanges) }, undefined, this.forest, (0, index_js_1.makeDetachedFieldIndex)("init"));
-    }
-}
+let ForestSummarizer = (() => {
+    var _a;
+    let _classSuper = index_js_2.VersionedSummarizer;
+    let _instanceExtraInitializers = [];
+    let _loadInternal_decorators;
+    return _a = class ForestSummarizer extends _classSuper {
+            /**
+             * This object is broken if and only if the forest it owns is broken.
+             */
+            get breaker() {
+                return this.forest.breaker;
+            }
+            /**
+             * @param encoderContext - The schema if provided here must be mutated by the caller to keep it up to date.
+             */
+            constructor(forest, encoderContext, decoderContext, options, idCompressor, initialSequenceNumber, shouldEncodeIncrementally = index_js_4.defaultIncrementalEncodingPolicy) {
+                super(summaryFormatCommon_js_1.forestSummaryKey, (0, summaryTypes_js_1.minVersionToForestSummaryFormatVersion)(options.minVersionForCollab), summaryFormatCommon_js_1.supportedForestSummaryFormatVersions, true /* supportPreVersioningFormat */);
+                this.forest = (tslib_1.__runInitializers(this, _instanceExtraInitializers), forest);
+                this.encoderContext = encoderContext;
+                this.decoderContext = decoderContext;
+                this.idCompressor = idCompressor;
+                this.codec = codec_js_1.forestCodecBuilder.build(options);
+                const summaryFormatWriteVersion = (0, summaryTypes_js_1.minVersionToForestSummaryFormatVersion)(options.minVersionForCollab);
+                this.forestRootSummaryContentKey = (0, summaryTypes_js_1.getForestRootSummaryContentKey)(summaryFormatWriteVersion);
+                // Incremental summary is supported in ForestSummaryFormatVersion.v3 onwards.
+                // Note that even in versions that support it, it is possible that the
+                // FieldBatchCodec will not use incremental encoding (for example if using its v1 formats which does not support it).
+                const enableIncrementalSummary = summaryFormatWriteVersion >= summaryFormatCommon_js_1.ForestSummaryFormatVersion.v3 &&
+                    encoderContext.encodeType === treeCompressionUtils_js_1.TreeCompressionStrategy.CompressedIncremental;
+                this.incrementalSummaryBuilder = new incrementalSummaryBuilder_js_1.ForestIncrementalSummaryBuilder(enableIncrementalSummary, (cursor) => this.forest.chunkField(cursor), shouldEncodeIncrementally, initialSequenceNumber);
+            }
+            /**
+             * Summarization of the forest's tree content.
+             * @returns a summary tree containing the forest's tree content.
+             * @remarks
+             * If incremental summary is disabled, all the content will be added to a single summary blob.
+             * If incremental summary is enabled, the summary will be a tree.
+             * See {@link ForestIncrementalSummaryBuilder} for details of what this tree looks like.
+             *
+             * TODO: when perf matters, this should be replaced with a chunked async version using a binary format.
+             */
+            summarizeInternal(props) {
+                const { stringify, fullTree = false, incrementalSummaryContext, builder } = props;
+                const rootCursor = this.forest.getCursorAboveDetachedFields();
+                const fieldMap = new Map();
+                // TODO: Encode all detached fields in one operation for better performance and compression
+                (0, index_js_1.forEachField)(rootCursor, (cursor) => {
+                    const key = cursor.getFieldKey();
+                    const innerCursor = this.forest.allocateCursor("getTreeString");
+                    (0, internal_1.assert)(this.forest.tryMoveCursorToField({ fieldKey: key, parent: undefined }, innerCursor) ===
+                        1 /* TreeNavigationResult.Ok */, 0x892 /* failed to navigate to field */);
+                    fieldMap.set(key, innerCursor);
+                });
+                // Let the incremental summary builder know that we are starting a new summary.
+                // It returns whether incremental encoding is enabled.
+                const incrementalSummaryBehavior = this.incrementalSummaryBuilder.startSummary({
+                    fullTree,
+                    incrementalSummaryContext,
+                    stringify,
+                    builder,
+                });
+                const encoderContext = {
+                    ...this.encoderContext,
+                    incrementalEncoder: incrementalSummaryBehavior === incrementalSummaryBuilder_js_1.ForestIncrementalSummaryBehavior.Incremental
+                        ? this.incrementalSummaryBuilder
+                        : undefined,
+                };
+                const encoded = this.codec.encode(fieldMap, encoderContext);
+                for (const value of fieldMap.values()) {
+                    value.free();
+                }
+                this.incrementalSummaryBuilder.completeSummary({
+                    incrementalSummaryContext,
+                    forestSummaryRootContent: stringify(encoded),
+                    forestSummaryRootContentKey: this.forestRootSummaryContentKey,
+                    builder,
+                });
+            }
+            async loadInternal(services, parse, version) {
+                // Get the key of the summary blob where the top-level forest content is stored based on the summary format version.
+                // If the summary was generated as `ForestIncrementalSummaryBehavior.SingleBlob`, this blob will contain all
+                // of forest's contents.
+                // If the summary was generated as `ForestIncrementalSummaryBehavior.Incremental`, this blob will contain only
+                // the top-level forest node's contents.
+                // The contents of the incremental chunks will be in separate tree nodes and will be read later during decoding.
+                const forestSummaryRootContentKey = (0, summaryTypes_js_1.getForestRootSummaryContentKey)(version);
+                (0, internal_1.assert)(await services.contains(forestSummaryRootContentKey), 0xc21 /* Forest summary content missing in snapshot */);
+                // Load the incremental summary builder so that it can download any incremental chunks in the
+                // snapshot.
+                await this.incrementalSummaryBuilder.load({
+                    services,
+                    readAndParseChunk: async (chunkBlobPath) => (0, index_js_3.readAndParseSnapshotBlob)(chunkBlobPath, services, parse),
+                });
+                // TODO: this code is parsing data without an optional validator, this should be defined in a typebox schema as part of the
+                // forest summary format.
+                const fields = this.codec.decode((await (0, index_js_3.readAndParseSnapshotBlob)(forestSummaryRootContentKey, services, parse)), this.decoderContext.withIncrementalDecoder(this.incrementalSummaryBuilder));
+                const allocator = (0, index_js_3.idAllocatorFromMaxId)();
+                const fieldChanges = [];
+                const build = [];
+                for (const [fieldKey, field] of fields) {
+                    const chunked = (0, chunkTree_js_1.chunkFieldSingle)(field, {
+                        policy: chunkTree_js_1.defaultChunkPolicy,
+                        idCompressor: this.idCompressor,
+                    });
+                    const buildId = { minor: allocator.allocate(chunked.topLevelLength) };
+                    build.push({
+                        id: buildId,
+                        trees: chunked,
+                    });
+                    fieldChanges.push([
+                        fieldKey,
+                        { marks: [{ count: chunked.topLevelLength, attach: buildId }] },
+                    ]);
+                }
+                (0, internal_1.assert)(this.forest.isEmpty, 0x797 /* forest must be empty */);
+                (0, index_js_1.applyDelta)({ build, fields: new Map(fieldChanges) }, undefined, this.forest, (0, index_js_1.makeDetachedFieldIndex)("init"));
+            }
+        },
+        (() => {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _loadInternal_decorators = [index_js_3.breakingMethod];
+            tslib_1.__esDecorate(_a, null, _loadInternal_decorators, { kind: "method", name: "loadInternal", static: false, private: false, access: { has: obj => "loadInternal" in obj, get: obj => obj.loadInternal }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        })(),
+        _a;
+})();
 exports.ForestSummarizer = ForestSummarizer;
 //# sourceMappingURL=forestSummarizer.js.map

package/dist/feature-libraries/forest-summary/forestSummarizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"forestSummarizer.js","sourceRoot":"","sources":["../../../src/feature-libraries/forest-summary/forestSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAU7D,kDAW6B;AAC7B,8DAKyC;AACzC,kDAI6B;AAC7B,wDAAwD;AACxD,iEAAsF;AACtF,yDAKoC;AACpC,wEAAqE;AAErE,yCAAkE;AAClE,iFAGwC;AACxC,qEAIkC;AAClC,uDAG2B;AAE3B;;GAEG;AACH,MAAa,gBACZ,SAAQ,8BAA+C;IAQvD;;OAEG;IACH,YACkB,MAAuB,EACvB,cAAyC,EACzC,cAAyC,EAC1D,OAA0B,EACT,YAA2B,EAC5C,qBAA6B,EAC7B,4BAAuD,2CAAgC;QAEvF,KAAK,CACJ,yCAAgB,EAChB,IAAA,wDAAsC,EAAC,OAAO,CAAC,mBAAmB,CAAC,EACnE,6DAAoC,EACpC,IAAI,CAAC,gCAAgC,CACrC,CAAC;QAbe,WAAM,GAAN,MAAM,CAAiB;QACvB,mBAAc,GAAd,cAAc,CAA2B;QACzC,mBAAc,GAAd,cAAc,CAA2B;QAEzC,iBAAY,GAAZ,YAAY,CAAe;QAW5C,IAAI,CAAC,KAAK,GAAG,6BAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE/C,MAAM,yBAAyB,GAAG,IAAA,wDAAsC,EACvE,OAAO,CAAC,mBAAmB,CAC3B,CAAC;QACF,IAAI,CAAC,2BAA2B,GAAG,IAAA,gDAA8B,EAChE,yBAAyB,CACzB,CAAC;QAEF,6EAA6E;QAC7E,sEAAsE;QACtE,qHAAqH;QACrH,MAAM,wBAAwB,GAC7B,yBAAyB,IAAI,mDAA0B,CAAC,EAAE;YAC1D,cAAc,CAAC,UAAU,KAAK,iDAAuB,CAAC,qBAAqB,CAAC;QAC7E,IAAI,CAAC,yBAAyB,GAAG,IAAI,8DAA+B,CACnE,wBAAwB,EACxB,CAAC,MAA8B,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAClE,yBAAyB,EACzB,qBAAqB,CACrB,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACO,iBAAiB,CAAC,KAO3B;QACA,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,yBAAyB,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAElF,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,4BAA4B,EAAE,CAAC;QAC9D,MAAM,QAAQ,GACb,IAAI,GAAG,EAAE,CAAC;QACX,2FAA2F;QAC3F,IAAA,uBAAY,EAAC,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE;YACnC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;YACjC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;YAChE,IAAA,iBAAM,EACL,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,WAAW,CAAC;+CAC3D,EACxB,KAAK,CAAC,iCAAiC,CACvC,CAAC;YACF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,WAA+D,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QAEH,+EAA+E;QAC/E,sDAAsD;QACtD,MAAM,0BAA0B,GAAG,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC;YAC9E,QAAQ;YACR,yBAAyB;YACzB,SAAS;YACT,OAAO;SACP,CAAC,CAAC;QACH,MAAM,cAAc,GAA8B;YACjD,GAAG,IAAI,CAAC,cAAc;YACtB,kBAAkB,EACjB,0BAA0B,KAAK,+DAAgC,CAAC,WAAW;gBAC1E,CAAC,CAAC,IAAI,CAAC,yBAAyB;gBAChC,CAAC,CAAC,SAAS;SACb,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC5D,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;YACvC,KAAK,CAAC,IAAI,EAAE,CAAC;QACd,CAAC;QAED,IAAI,CAAC,yBAAyB,CAAC,eAAe,CAAC;YAC9C,yBAAyB;YACzB,wBAAwB,EAAE,SAAS,CAAC,OAAO,CAAC;YAC5C,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;YAC7D,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,YAAY,CAC3B,QAAgC,EAChC,KAA2B,EAC3B,OAA+C;QAE/C,oHAAoH;QACpH,4GAA4G;QAC5G,wBAAwB;QACxB,8GAA8G;QAC9G,wCAAwC;QACxC,gHAAgH;QAChH,MAAM,2BAA2B,GAAG,IAAA,gDAA8B,EAAC,OAAO,CAAC,CAAC;QAC5E,IAAA,iBAAM,EACL,MAAM,QAAQ,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EACpD,KAAK,CAAC,gDAAgD,CACtD,CAAC;QAEF,6FAA6F;QAC7F,YAAY;QACZ,MAAM,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC;YACzC,QAAQ;YACR,iBAAiB,EAAE,KAAK,EAAE,aAAqB,EAAE,EAAE,CAClD,IAAA,mCAAwB,EAAC,aAAa,EAAE,QAAQ,EAAE,KAAK,CAAC;SACzD,CAAC,CAAC;QAEH,2HAA2H;QAC3H,yBAAyB;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAC/B,CAAC,MAAM,IAAA,mCAAwB,EAC9B,2BAA2B,EAC3B,QAAQ,EACR,KAAK,CAEL,CAA2B,EAC5B,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAC1E,CAAC;QACF,MAAM,SAAS,GAAG,IAAA,+BAAoB,GAAE,CAAC;QACzC,MAAM,YAAY,GAAoC,EAAE,CAAC;QACzD,MAAM,KAAK,GAA6B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;YACxC,MAAM,OAAO,GAAG,IAAA,+BAAgB,EAAC,KAAK,EAAE;gBACvC,MAAM,EAAE,iCAAkB;gBAC1B,YAAY,EAAE,IAAI,CAAC,YAAY;aAC/B,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACtE,KAAK,CAAC,IAAI,CAAC;gBACV,EAAE,EAAE,OAAO;gBACX,KAAK,EAAE,OAAO;aACd,CAAC,CAAC;YACH,YAAY,CAAC,IAAI,CAAC;gBACjB,QAAQ;gBACR,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE;aAC/D,CAAC,CAAC;QACJ,CAAC;QAED,IAAA,iBAAM,EAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9D,IAAA,qBAAU,EACT,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,YAAY,CAAC,EAAE,EACxC,SAAS,EACT,IAAI,CAAC,MAAM,EACX,IAAA,iCAAsB,EAAC,MAAM,CAAC,CAC9B,CAAC;IACH,CAAC;CACD;AAjLD,4CAiLC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport type {\n\tIExperimentalIncrementalSummaryContext,\n\tITelemetryContext,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport type { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport type { CodecWriteOptions } from \"../../codec/index.js\";\nimport {\n\ttype DeltaDetachedNodeBuild,\n\ttype DeltaFieldChanges,\n\ttype FieldKey,\n\ttype IEditableForest,\n\ttype ITreeCursorSynchronous,\n\ttype ITreeSubscriptionCursor,\n\tTreeNavigationResult,\n\tapplyDelta,\n\tforEachField,\n\tmakeDetachedFieldIndex,\n} from \"../../core/index.js\";\nimport {\n\tVersionedSummarizer,\n\ttype Summarizable,\n\ttype SummaryElementParser,\n\ttype SummaryElementStringifier,\n} from \"../../shared-tree-core/index.js\";\nimport {\n\tidAllocatorFromMaxId,\n\treadAndParseSnapshotBlob,\n\ttype JsonCompatibleReadOnly,\n} from \"../../util/index.js\";\n// eslint-disable-next-line import-x/no-internal-modules\nimport { chunkFieldSingle, defaultChunkPolicy } from \"../chunked-forest/chunkTree.js\";\nimport {\n\tdefaultIncrementalEncodingPolicy,\n\ttype FieldBatchDecodingContext,\n\ttype FieldBatchEncodingContext,\n\ttype IncrementalEncodingPolicy,\n} from \"../chunked-forest/index.js\";\nimport { TreeCompressionStrategy } from \"../treeCompressionUtils.js\";\n\nimport { forestCodecBuilder, type ForestCodec } from \"./codec.js\";\nimport {\n\tForestIncrementalSummaryBehavior,\n\tForestIncrementalSummaryBuilder,\n} from \"./incrementalSummaryBuilder.js\";\nimport {\n\tForestSummaryFormatVersion,\n\tforestSummaryKey,\n\tsupportedForestSummaryFormatVersions,\n} from \"./summaryFormatCommon.js\";\nimport {\n\tminVersionToForestSummaryFormatVersion,\n\tgetForestRootSummaryContentKey,\n} from \"./summaryTypes.js\";\n\n/**\n * Provides methods for summarizing and loading a forest.\n */\nexport class ForestSummarizer\n\textends VersionedSummarizer<ForestSummaryFormatVersion>\n\timplements Summarizable\n{\n\tprivate readonly codec: ForestCodec;\n\n\tprivate readonly incrementalSummaryBuilder: ForestIncrementalSummaryBuilder;\n\tprivate readonly forestRootSummaryContentKey: string;\n\n\t/**\n\t * @param encoderContext - The schema if provided here must be mutated by the caller to keep it up to date.\n\t */\n\tpublic constructor(\n\t\tprivate readonly forest: IEditableForest,\n\t\tprivate readonly encoderContext: FieldBatchEncodingContext,\n\t\tprivate readonly decoderContext: FieldBatchDecodingContext,\n\t\toptions: CodecWriteOptions,\n\t\tprivate readonly idCompressor: IIdCompressor,\n\t\tinitialSequenceNumber: number,\n\t\tshouldEncodeIncrementally: IncrementalEncodingPolicy = defaultIncrementalEncodingPolicy,\n\t) {\n\t\tsuper(\n\t\t\tforestSummaryKey,\n\t\t\tminVersionToForestSummaryFormatVersion(options.minVersionForCollab),\n\t\t\tsupportedForestSummaryFormatVersions,\n\t\t\ttrue /* supportPreVersioningFormat */,\n\t\t);\n\n\t\tthis.codec = forestCodecBuilder.build(options);\n\n\t\tconst summaryFormatWriteVersion = minVersionToForestSummaryFormatVersion(\n\t\t\toptions.minVersionForCollab,\n\t\t);\n\t\tthis.forestRootSummaryContentKey = getForestRootSummaryContentKey(\n\t\t\tsummaryFormatWriteVersion,\n\t\t);\n\n\t\t// Incremental summary is supported in ForestSummaryFormatVersion.v3 onwards.\n\t\t// Note that even in versions that support it, it is possible that the\n\t\t// FieldBatchCodec will not use incremental encoding (for example if using its v1 formats which does not support it).\n\t\tconst enableIncrementalSummary =\n\t\t\tsummaryFormatWriteVersion >= ForestSummaryFormatVersion.v3 &&\n\t\t\tencoderContext.encodeType === TreeCompressionStrategy.CompressedIncremental;\n\t\tthis.incrementalSummaryBuilder = new ForestIncrementalSummaryBuilder(\n\t\t\tenableIncrementalSummary,\n\t\t\t(cursor: ITreeCursorSynchronous) => this.forest.chunkField(cursor),\n\t\t\tshouldEncodeIncrementally,\n\t\t\tinitialSequenceNumber,\n\t\t);\n\t}\n\n\t/**\n\t * Summarization of the forest's tree content.\n\t * @returns a summary tree containing the forest's tree content.\n\t * @remarks\n\t * If incremental summary is disabled, all the content will be added to a single summary blob.\n\t * If incremental summary is enabled, the summary will be a tree.\n\t * See {@link ForestIncrementalSummaryBuilder} for details of what this tree looks like.\n\t *\n\t * TODO: when perf matters, this should be replaced with a chunked async version using a binary format.\n\t */\n\tprotected summarizeInternal(props: {\n\t\tstringify: SummaryElementStringifier;\n\t\tfullTree?: boolean;\n\t\ttrackState?: boolean;\n\t\ttelemetryContext?: ITelemetryContext;\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext;\n\t\tbuilder: SummaryTreeBuilder;\n\t}): void {\n\t\tconst { stringify, fullTree = false, incrementalSummaryContext, builder } = props;\n\n\t\tconst rootCursor = this.forest.getCursorAboveDetachedFields();\n\t\tconst fieldMap: Map<FieldKey, ITreeCursorSynchronous & ITreeSubscriptionCursor> =\n\t\t\tnew Map();\n\t\t// TODO: Encode all detached fields in one operation for better performance and compression\n\t\tforEachField(rootCursor, (cursor) => {\n\t\t\tconst key = cursor.getFieldKey();\n\t\t\tconst innerCursor = this.forest.allocateCursor(\"getTreeString\");\n\t\t\tassert(\n\t\t\t\tthis.forest.tryMoveCursorToField({ fieldKey: key, parent: undefined }, innerCursor) ===\n\t\t\t\t\tTreeNavigationResult.Ok,\n\t\t\t\t0x892 /* failed to navigate to field */,\n\t\t\t);\n\t\t\tfieldMap.set(key, innerCursor as ITreeCursorSynchronous & ITreeSubscriptionCursor);\n\t\t});\n\n\t\t// Let the incremental summary builder know that we are starting a new summary.\n\t\t// It returns whether incremental encoding is enabled.\n\t\tconst incrementalSummaryBehavior = this.incrementalSummaryBuilder.startSummary({\n\t\t\tfullTree,\n\t\t\tincrementalSummaryContext,\n\t\t\tstringify,\n\t\t\tbuilder,\n\t\t});\n\t\tconst encoderContext: FieldBatchEncodingContext = {\n\t\t\t...this.encoderContext,\n\t\t\tincrementalEncoder:\n\t\t\t\tincrementalSummaryBehavior === ForestIncrementalSummaryBehavior.Incremental\n\t\t\t\t\t? this.incrementalSummaryBuilder\n\t\t\t\t\t: undefined,\n\t\t};\n\t\tconst encoded = this.codec.encode(fieldMap, encoderContext);\n\t\tfor (const value of fieldMap.values()) {\n\t\t\tvalue.free();\n\t\t}\n\n\t\tthis.incrementalSummaryBuilder.completeSummary({\n\t\t\tincrementalSummaryContext,\n\t\t\tforestSummaryRootContent: stringify(encoded),\n\t\t\tforestSummaryRootContentKey: this.forestRootSummaryContentKey,\n\t\t\tbuilder,\n\t\t});\n\t}\n\n\tprotected async loadInternal(\n\t\tservices: IChannelStorageService,\n\t\tparse: SummaryElementParser,\n\t\tversion: ForestSummaryFormatVersion | undefined,\n\t): Promise<void> {\n\t\t// Get the key of the summary blob where the top-level forest content is stored based on the summary format version.\n\t\t// If the summary was generated as `ForestIncrementalSummaryBehavior.SingleBlob`, this blob will contain all\n\t\t// of forest's contents.\n\t\t// If the summary was generated as `ForestIncrementalSummaryBehavior.Incremental`, this blob will contain only\n\t\t// the top-level forest node's contents.\n\t\t// The contents of the incremental chunks will be in separate tree nodes and will be read later during decoding.\n\t\tconst forestSummaryRootContentKey = getForestRootSummaryContentKey(version);\n\t\tassert(\n\t\t\tawait services.contains(forestSummaryRootContentKey),\n\t\t\t0xc21 /* Forest summary content missing in snapshot */,\n\t\t);\n\n\t\t// Load the incremental summary builder so that it can download any incremental chunks in the\n\t\t// snapshot.\n\t\tawait this.incrementalSummaryBuilder.load({\n\t\t\tservices,\n\t\t\treadAndParseChunk: async (chunkBlobPath: string) =>\n\t\t\t\treadAndParseSnapshotBlob(chunkBlobPath, services, parse),\n\t\t});\n\n\t\t// TODO: this code is parsing data without an optional validator, this should be defined in a typebox schema as part of the\n\t\t// forest summary format.\n\t\tconst fields = this.codec.decode(\n\t\t\t(await readAndParseSnapshotBlob(\n\t\t\t\tforestSummaryRootContentKey,\n\t\t\t\tservices,\n\t\t\t\tparse,\n\t\t\t\t// TODO: this type cast assumes there are no handles, which should probably be enforced at runtime or the need for this cast should be removed altogether.\n\t\t\t)) as JsonCompatibleReadOnly,\n\t\t\tthis.decoderContext.withIncrementalDecoder(this.incrementalSummaryBuilder),\n\t\t);\n\t\tconst allocator = idAllocatorFromMaxId();\n\t\tconst fieldChanges: [FieldKey, DeltaFieldChanges][] = [];\n\t\tconst build: DeltaDetachedNodeBuild[] = [];\n\t\tfor (const [fieldKey, field] of fields) {\n\t\t\tconst chunked = chunkFieldSingle(field, {\n\t\t\t\tpolicy: defaultChunkPolicy,\n\t\t\t\tidCompressor: this.idCompressor,\n\t\t\t});\n\t\t\tconst buildId = { minor: allocator.allocate(chunked.topLevelLength) };\n\t\t\tbuild.push({\n\t\t\t\tid: buildId,\n\t\t\t\ttrees: chunked,\n\t\t\t});\n\t\t\tfieldChanges.push([\n\t\t\t\tfieldKey,\n\t\t\t\t{ marks: [{ count: chunked.topLevelLength, attach: buildId }] },\n\t\t\t]);\n\t\t}\n\n\t\tassert(this.forest.isEmpty, 0x797 /* forest must be empty */);\n\t\tapplyDelta(\n\t\t\t{ build, fields: new Map(fieldChanges) },\n\t\t\tundefined,\n\t\t\tthis.forest,\n\t\t\tmakeDetachedFieldIndex(\"init\"),\n\t\t);\n\t}\n}\n"]}
+{"version":3,"file":"forestSummarizer.js","sourceRoot":"","sources":["../../../src/feature-libraries/forest-summary/forestSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,kEAA6D;AAU7D,kDAW6B;AAC7B,8DAKyC;AACzC,kDAM6B;AAC7B,wDAAwD;AACxD,iEAAsF;AACtF,yDAKoC;AACpC,wEAAqE;AAErE,yCAAkE;AAClE,iFAGwC;AACxC,qEAIkC;AAClC,uDAG2B;AAE3B;;GAEG;IACU,gBAAgB;;sBACpB,8BAAmB;;;sBADf,gBACZ,SAAQ,WAA+C;YAKvD;;eAEG;YACH,IAAW,OAAO;gBACjB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YAC5B,CAAC;YAKD;;eAEG;YACH,YACkB,MAAuB,EACvB,cAAyC,EACzC,cAAyC,EAC1D,OAA0B,EACT,YAA2B,EAC5C,qBAA6B,EAC7B,4BAAuD,2CAAgC;gBAEvF,KAAK,CACJ,yCAAgB,EAChB,IAAA,wDAAsC,EAAC,OAAO,CAAC,mBAAmB,CAAC,EACnE,6DAAoC,EACpC,IAAI,CAAC,gCAAgC,CACrC,CAAC;gBAbe,WAAM,IApBZ,2DAAgB,EAoBV,MAAM,EAAiB;gBACvB,mBAAc,GAAd,cAAc,CAA2B;gBACzC,mBAAc,GAAd,cAAc,CAA2B;gBAEzC,iBAAY,GAAZ,YAAY,CAAe;gBAW5C,IAAI,CAAC,KAAK,GAAG,6BAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE/C,MAAM,yBAAyB,GAAG,IAAA,wDAAsC,EACvE,OAAO,CAAC,mBAAmB,CAC3B,CAAC;gBACF,IAAI,CAAC,2BAA2B,GAAG,IAAA,gDAA8B,EAChE,yBAAyB,CACzB,CAAC;gBAEF,6EAA6E;gBAC7E,sEAAsE;gBACtE,qHAAqH;gBACrH,MAAM,wBAAwB,GAC7B,yBAAyB,IAAI,mDAA0B,CAAC,EAAE;oBAC1D,cAAc,CAAC,UAAU,KAAK,iDAAuB,CAAC,qBAAqB,CAAC;gBAC7E,IAAI,CAAC,yBAAyB,GAAG,IAAI,8DAA+B,CACnE,wBAAwB,EACxB,CAAC,MAA8B,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAClE,yBAAyB,EACzB,qBAAqB,CACrB,CAAC;YACH,CAAC;YAED;;;;;;;;;eASG;YACO,iBAAiB,CAAC,KAO3B;gBACA,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,yBAAyB,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;gBAElF,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,4BAA4B,EAAE,CAAC;gBAC9D,MAAM,QAAQ,GACb,IAAI,GAAG,EAAE,CAAC;gBACX,2FAA2F;gBAC3F,IAAA,uBAAY,EAAC,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE;oBACnC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;oBACjC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;oBAChE,IAAA,iBAAM,EACL,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,WAAW,CAAC;uDAC3D,EACxB,KAAK,CAAC,iCAAiC,CACvC,CAAC;oBACF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,WAA+D,CAAC,CAAC;gBACpF,CAAC,CAAC,CAAC;gBAEH,+EAA+E;gBAC/E,sDAAsD;gBACtD,MAAM,0BAA0B,GAAG,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC;oBAC9E,QAAQ;oBACR,yBAAyB;oBACzB,SAAS;oBACT,OAAO;iBACP,CAAC,CAAC;gBACH,MAAM,cAAc,GAA8B;oBACjD,GAAG,IAAI,CAAC,cAAc;oBACtB,kBAAkB,EACjB,0BAA0B,KAAK,+DAAgC,CAAC,WAAW;wBAC1E,CAAC,CAAC,IAAI,CAAC,yBAAyB;wBAChC,CAAC,CAAC,SAAS;iBACb,CAAC;gBACF,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;gBAC5D,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;oBACvC,KAAK,CAAC,IAAI,EAAE,CAAC;gBACd,CAAC;gBAED,IAAI,CAAC,yBAAyB,CAAC,eAAe,CAAC;oBAC9C,yBAAyB;oBACzB,wBAAwB,EAAE,SAAS,CAAC,OAAO,CAAC;oBAC5C,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;oBAC7D,OAAO;iBACP,CAAC,CAAC;YACJ,CAAC;YAGS,KAAK,CAAC,YAAY,CAC3B,QAAgC,EAChC,KAA2B,EAC3B,OAA+C;gBAE/C,oHAAoH;gBACpH,4GAA4G;gBAC5G,wBAAwB;gBACxB,8GAA8G;gBAC9G,wCAAwC;gBACxC,gHAAgH;gBAChH,MAAM,2BAA2B,GAAG,IAAA,gDAA8B,EAAC,OAAO,CAAC,CAAC;gBAC5E,IAAA,iBAAM,EACL,MAAM,QAAQ,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EACpD,KAAK,CAAC,gDAAgD,CACtD,CAAC;gBAEF,6FAA6F;gBAC7F,YAAY;gBACZ,MAAM,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC;oBACzC,QAAQ;oBACR,iBAAiB,EAAE,KAAK,EAAE,aAAqB,EAAE,EAAE,CAClD,IAAA,mCAAwB,EAAC,aAAa,EAAE,QAAQ,EAAE,KAAK,CAAC;iBACzD,CAAC,CAAC;gBAEH,2HAA2H;gBAC3H,yBAAyB;gBACzB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAC/B,CAAC,MAAM,IAAA,mCAAwB,EAC9B,2BAA2B,EAC3B,QAAQ,EACR,KAAK,CAEL,CAA2B,EAC5B,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAC1E,CAAC;gBACF,MAAM,SAAS,GAAG,IAAA,+BAAoB,GAAE,CAAC;gBACzC,MAAM,YAAY,GAAoC,EAAE,CAAC;gBACzD,MAAM,KAAK,GAA6B,EAAE,CAAC;gBAC3C,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;oBACxC,MAAM,OAAO,GAAG,IAAA,+BAAgB,EAAC,KAAK,EAAE;wBACvC,MAAM,EAAE,iCAAkB;wBAC1B,YAAY,EAAE,IAAI,CAAC,YAAY;qBAC/B,CAAC,CAAC;oBACH,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;oBACtE,KAAK,CAAC,IAAI,CAAC;wBACV,EAAE,EAAE,OAAO;wBACX,KAAK,EAAE,OAAO;qBACd,CAAC,CAAC;oBACH,YAAY,CAAC,IAAI,CAAC;wBACjB,QAAQ;wBACR,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE;qBAC/D,CAAC,CAAC;gBACJ,CAAC;gBAED,IAAA,iBAAM,EAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;gBAC9D,IAAA,qBAAU,EACT,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,YAAY,CAAC,EAAE,EACxC,SAAS,EACT,IAAI,CAAC,MAAM,EACX,IAAA,iCAAsB,EAAC,MAAM,CAAC,CAC9B,CAAC;YACH,CAAC;;;;wCA/DA,yBAAc;YACf,6LAAgB,YAAY,6DA8D3B;;;;;AAxLW,4CAAgB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport type {\n\tIExperimentalIncrementalSummaryContext,\n\tITelemetryContext,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport type { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport type { CodecWriteOptions } from \"../../codec/index.js\";\nimport {\n\ttype DeltaDetachedNodeBuild,\n\ttype DeltaFieldChanges,\n\ttype FieldKey,\n\ttype IEditableForest,\n\ttype ITreeCursorSynchronous,\n\ttype ITreeSubscriptionCursor,\n\tTreeNavigationResult,\n\tapplyDelta,\n\tforEachField,\n\tmakeDetachedFieldIndex,\n} from \"../../core/index.js\";\nimport {\n\tVersionedSummarizer,\n\ttype Summarizable,\n\ttype SummaryElementParser,\n\ttype SummaryElementStringifier,\n} from \"../../shared-tree-core/index.js\";\nimport {\n\tbreakingMethod,\n\tidAllocatorFromMaxId,\n\treadAndParseSnapshotBlob,\n\ttype Breakable,\n\ttype JsonCompatibleReadOnly,\n} from \"../../util/index.js\";\n// eslint-disable-next-line import-x/no-internal-modules\nimport { chunkFieldSingle, defaultChunkPolicy } from \"../chunked-forest/chunkTree.js\";\nimport {\n\tdefaultIncrementalEncodingPolicy,\n\ttype FieldBatchDecodingContext,\n\ttype FieldBatchEncodingContext,\n\ttype IncrementalEncodingPolicy,\n} from \"../chunked-forest/index.js\";\nimport { TreeCompressionStrategy } from \"../treeCompressionUtils.js\";\n\nimport { forestCodecBuilder, type ForestCodec } from \"./codec.js\";\nimport {\n\tForestIncrementalSummaryBehavior,\n\tForestIncrementalSummaryBuilder,\n} from \"./incrementalSummaryBuilder.js\";\nimport {\n\tForestSummaryFormatVersion,\n\tforestSummaryKey,\n\tsupportedForestSummaryFormatVersions,\n} from \"./summaryFormatCommon.js\";\nimport {\n\tminVersionToForestSummaryFormatVersion,\n\tgetForestRootSummaryContentKey,\n} from \"./summaryTypes.js\";\n\n/**\n * Provides methods for summarizing and loading a forest.\n */\nexport class ForestSummarizer\n\textends VersionedSummarizer<ForestSummaryFormatVersion>\n\timplements Summarizable\n{\n\tprivate readonly codec: ForestCodec;\n\n\t/**\n\t * This object is broken if and only if the forest it owns is broken.\n\t */\n\tpublic get breaker(): Breakable {\n\t\treturn this.forest.breaker;\n\t}\n\n\tprivate readonly incrementalSummaryBuilder: ForestIncrementalSummaryBuilder;\n\tprivate readonly forestRootSummaryContentKey: string;\n\n\t/**\n\t * @param encoderContext - The schema if provided here must be mutated by the caller to keep it up to date.\n\t */\n\tpublic constructor(\n\t\tprivate readonly forest: IEditableForest,\n\t\tprivate readonly encoderContext: FieldBatchEncodingContext,\n\t\tprivate readonly decoderContext: FieldBatchDecodingContext,\n\t\toptions: CodecWriteOptions,\n\t\tprivate readonly idCompressor: IIdCompressor,\n\t\tinitialSequenceNumber: number,\n\t\tshouldEncodeIncrementally: IncrementalEncodingPolicy = defaultIncrementalEncodingPolicy,\n\t) {\n\t\tsuper(\n\t\t\tforestSummaryKey,\n\t\t\tminVersionToForestSummaryFormatVersion(options.minVersionForCollab),\n\t\t\tsupportedForestSummaryFormatVersions,\n\t\t\ttrue /* supportPreVersioningFormat */,\n\t\t);\n\n\t\tthis.codec = forestCodecBuilder.build(options);\n\n\t\tconst summaryFormatWriteVersion = minVersionToForestSummaryFormatVersion(\n\t\t\toptions.minVersionForCollab,\n\t\t);\n\t\tthis.forestRootSummaryContentKey = getForestRootSummaryContentKey(\n\t\t\tsummaryFormatWriteVersion,\n\t\t);\n\n\t\t// Incremental summary is supported in ForestSummaryFormatVersion.v3 onwards.\n\t\t// Note that even in versions that support it, it is possible that the\n\t\t// FieldBatchCodec will not use incremental encoding (for example if using its v1 formats which does not support it).\n\t\tconst enableIncrementalSummary =\n\t\t\tsummaryFormatWriteVersion >= ForestSummaryFormatVersion.v3 &&\n\t\t\tencoderContext.encodeType === TreeCompressionStrategy.CompressedIncremental;\n\t\tthis.incrementalSummaryBuilder = new ForestIncrementalSummaryBuilder(\n\t\t\tenableIncrementalSummary,\n\t\t\t(cursor: ITreeCursorSynchronous) => this.forest.chunkField(cursor),\n\t\t\tshouldEncodeIncrementally,\n\t\t\tinitialSequenceNumber,\n\t\t);\n\t}\n\n\t/**\n\t * Summarization of the forest's tree content.\n\t * @returns a summary tree containing the forest's tree content.\n\t * @remarks\n\t * If incremental summary is disabled, all the content will be added to a single summary blob.\n\t * If incremental summary is enabled, the summary will be a tree.\n\t * See {@link ForestIncrementalSummaryBuilder} for details of what this tree looks like.\n\t *\n\t * TODO: when perf matters, this should be replaced with a chunked async version using a binary format.\n\t */\n\tprotected summarizeInternal(props: {\n\t\tstringify: SummaryElementStringifier;\n\t\tfullTree?: boolean;\n\t\ttrackState?: boolean;\n\t\ttelemetryContext?: ITelemetryContext;\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext;\n\t\tbuilder: SummaryTreeBuilder;\n\t}): void {\n\t\tconst { stringify, fullTree = false, incrementalSummaryContext, builder } = props;\n\n\t\tconst rootCursor = this.forest.getCursorAboveDetachedFields();\n\t\tconst fieldMap: Map<FieldKey, ITreeCursorSynchronous & ITreeSubscriptionCursor> =\n\t\t\tnew Map();\n\t\t// TODO: Encode all detached fields in one operation for better performance and compression\n\t\tforEachField(rootCursor, (cursor) => {\n\t\t\tconst key = cursor.getFieldKey();\n\t\t\tconst innerCursor = this.forest.allocateCursor(\"getTreeString\");\n\t\t\tassert(\n\t\t\t\tthis.forest.tryMoveCursorToField({ fieldKey: key, parent: undefined }, innerCursor) ===\n\t\t\t\t\tTreeNavigationResult.Ok,\n\t\t\t\t0x892 /* failed to navigate to field */,\n\t\t\t);\n\t\t\tfieldMap.set(key, innerCursor as ITreeCursorSynchronous & ITreeSubscriptionCursor);\n\t\t});\n\n\t\t// Let the incremental summary builder know that we are starting a new summary.\n\t\t// It returns whether incremental encoding is enabled.\n\t\tconst incrementalSummaryBehavior = this.incrementalSummaryBuilder.startSummary({\n\t\t\tfullTree,\n\t\t\tincrementalSummaryContext,\n\t\t\tstringify,\n\t\t\tbuilder,\n\t\t});\n\t\tconst encoderContext: FieldBatchEncodingContext = {\n\t\t\t...this.encoderContext,\n\t\t\tincrementalEncoder:\n\t\t\t\tincrementalSummaryBehavior === ForestIncrementalSummaryBehavior.Incremental\n\t\t\t\t\t? this.incrementalSummaryBuilder\n\t\t\t\t\t: undefined,\n\t\t};\n\t\tconst encoded = this.codec.encode(fieldMap, encoderContext);\n\t\tfor (const value of fieldMap.values()) {\n\t\t\tvalue.free();\n\t\t}\n\n\t\tthis.incrementalSummaryBuilder.completeSummary({\n\t\t\tincrementalSummaryContext,\n\t\t\tforestSummaryRootContent: stringify(encoded),\n\t\t\tforestSummaryRootContentKey: this.forestRootSummaryContentKey,\n\t\t\tbuilder,\n\t\t});\n\t}\n\n\t@breakingMethod\n\tprotected async loadInternal(\n\t\tservices: IChannelStorageService,\n\t\tparse: SummaryElementParser,\n\t\tversion: ForestSummaryFormatVersion | undefined,\n\t): Promise<void> {\n\t\t// Get the key of the summary blob where the top-level forest content is stored based on the summary format version.\n\t\t// If the summary was generated as `ForestIncrementalSummaryBehavior.SingleBlob`, this blob will contain all\n\t\t// of forest's contents.\n\t\t// If the summary was generated as `ForestIncrementalSummaryBehavior.Incremental`, this blob will contain only\n\t\t// the top-level forest node's contents.\n\t\t// The contents of the incremental chunks will be in separate tree nodes and will be read later during decoding.\n\t\tconst forestSummaryRootContentKey = getForestRootSummaryContentKey(version);\n\t\tassert(\n\t\t\tawait services.contains(forestSummaryRootContentKey),\n\t\t\t0xc21 /* Forest summary content missing in snapshot */,\n\t\t);\n\n\t\t// Load the incremental summary builder so that it can download any incremental chunks in the\n\t\t// snapshot.\n\t\tawait this.incrementalSummaryBuilder.load({\n\t\t\tservices,\n\t\t\treadAndParseChunk: async (chunkBlobPath: string) =>\n\t\t\t\treadAndParseSnapshotBlob(chunkBlobPath, services, parse),\n\t\t});\n\n\t\t// TODO: this code is parsing data without an optional validator, this should be defined in a typebox schema as part of the\n\t\t// forest summary format.\n\t\tconst fields = this.codec.decode(\n\t\t\t(await readAndParseSnapshotBlob(\n\t\t\t\tforestSummaryRootContentKey,\n\t\t\t\tservices,\n\t\t\t\tparse,\n\t\t\t\t// TODO: this type cast assumes there are no handles, which should probably be enforced at runtime or the need for this cast should be removed altogether.\n\t\t\t)) as JsonCompatibleReadOnly,\n\t\t\tthis.decoderContext.withIncrementalDecoder(this.incrementalSummaryBuilder),\n\t\t);\n\t\tconst allocator = idAllocatorFromMaxId();\n\t\tconst fieldChanges: [FieldKey, DeltaFieldChanges][] = [];\n\t\tconst build: DeltaDetachedNodeBuild[] = [];\n\t\tfor (const [fieldKey, field] of fields) {\n\t\t\tconst chunked = chunkFieldSingle(field, {\n\t\t\t\tpolicy: defaultChunkPolicy,\n\t\t\t\tidCompressor: this.idCompressor,\n\t\t\t});\n\t\t\tconst buildId = { minor: allocator.allocate(chunked.topLevelLength) };\n\t\t\tbuild.push({\n\t\t\t\tid: buildId,\n\t\t\t\ttrees: chunked,\n\t\t\t});\n\t\t\tfieldChanges.push([\n\t\t\t\tfieldKey,\n\t\t\t\t{ marks: [{ count: chunked.topLevelLength, attach: buildId }] },\n\t\t\t]);\n\t\t}\n\n\t\tassert(this.forest.isEmpty, 0x797 /* forest must be empty */);\n\t\tapplyDelta(\n\t\t\t{ build, fields: new Map(fieldChanges) },\n\t\t\tundefined,\n\t\t\tthis.forest,\n\t\t\tmakeDetachedFieldIndex(\"init\"),\n\t\t);\n\t}\n}\n"]}