@fluidframework/tree 2.117.0 → 3.0.0

package/lib/feature-libraries/flex-tree/lazyNode.js

@@ -2,8 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-var _LazyTreeNode_removeDeleteCallback;
-import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
 import { assert, fail } from "@fluidframework/core-utils/internal";
 import { inCursorField, mapCursorFields, rootFieldKey, } from "../../core/index.js";
 import { disposeSymbol } from "../../util/index.js";
@@ -39,34 +37,23 @@ function cleanupTree(anchor) {
  * Lazy implementation of {@link FlexTreeNode}.
  */
 export class LazyTreeNode extends LazyEntity {
-    get [(_LazyTreeNode_removeDeleteCallback = new WeakMap(), flexTreeMarker)]() {
+    type;
+    anchorNode;
+    get [flexTreeMarker]() {
         return FlexTreeEntityKind.Node;
     }
+    // Using JS private here prevents it from showing up as a enumerable own property, or conflicting with struct fields.
+    #removeDeleteCallback;
+    storedSchema;
     constructor(context, type, cursor, anchorNode, anchor) {
         super(context, cursor, anchor);
         this.type = type;
         this.anchorNode = anchorNode;
-        // Using JS private here prevents it from showing up as a enumerable own property, or conflicting with struct fields.
-        _LazyTreeNode_removeDeleteCallback.set(this, void 0);
-        this.fields = {
-            get: (key) => this.tryGetField(key),
-            [Symbol.iterator]: () => {
-                currentObserver?.observeNodeFields(this);
-                return mapCursorFields(this.cursor, (cursor) => {
-                    const key = cursor.getFieldKey();
-                    const pair = [
-                        key,
-                        makeField(this.context, this.storedSchema.getFieldSchema(key).kind, cursor),
-                    ];
-                    return pair;
-                }).values();
-            },
-        };
         this.storedSchema =
             context.schema.nodeSchema.get(this.type) ?? fail(0xb14 /* missing schema */);
         assert(cursor.mode === 0 /* CursorLocationType.Nodes */, 0x783 /* must be in nodes mode */);
         anchorNode.slots.set(flexTreeSlot, this);
-        __classPrivateFieldSet(this, _LazyTreeNode_removeDeleteCallback, anchorNode.events.on("afterDestroy", cleanupTree), "f");
+        this.#removeDeleteCallback = anchorNode.events.on("afterDestroy", cleanupTree);
     }
     isHydrated() {
         return true;
@@ -79,12 +66,26 @@ export class LazyTreeNode extends LazyEntity {
         // After this point this node will not be usable,
         // so remove it from the anchor incase a different context (or the same context later) uses this AnchorSet.
         this.anchorNode.slots.delete(flexTreeSlot);
-        __classPrivateFieldGet(this, _LazyTreeNode_removeDeleteCallback, "f").call(this);
+        this.#removeDeleteCallback();
         this.context.checkout.forest.anchors.forget(this.anchor);
     }
     get value() {
         return this.cursor.value;
     }
+    fields = {
+        get: (key) => this.tryGetField(key),
+        [Symbol.iterator]: () => {
+            currentObserver?.observeNodeFields(this);
+            return mapCursorFields(this.cursor, (cursor) => {
+                const key = cursor.getFieldKey();
+                const pair = [
+                    key,
+                    makeField(this.context, this.storedSchema.getFieldSchema(key).kind, cursor),
+                ];
+                return pair;
+            }).values();
+        },
+    };
     tryGetField(fieldKey) {
         currentObserver?.observeNodeField(this, fieldKey);
         const schema = this.storedSchema.getFieldSchema(fieldKey);

package/lib/feature-libraries/flex-tree/lazyNode.js.map

@@ -1 +1 @@
-{"version":3,"file":"lazyNode.js","sourceRoot":"","sources":["../../../src/feature-libraries/flex-tree/lazyNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;AAEH,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,qCAAqC,CAAC;AAEnE,OAAO,EAWN,aAAa,EACb,eAAe,EACf,YAAY,GACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAGxD,OAAO,EACN,kBAAkB,EAGlB,cAAc,EACd,YAAY,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAC9C,OAAgB,EAChB,MAA+B;IAE/B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACpC,MAAM,UAAU,GACf,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAC;IACvF,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAClD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,YAAY,YAAY,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC1E,OAAO,MAAM,CAAC;IACf,CAAC;IACD,OAAO,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,WAAW,CAAC,MAAkB;IACtC,MAAM,MAAM,GACX,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACzF,MAAM,CAAC,MAAM,YAAY,YAAY,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC1E,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,UAAkB;IACnD,IAAW,sDAAC,cAAc,EAAC;QAC1B,OAAO,kBAAkB,CAAC,IAAI,CAAC;IAChC,CAAC;IAOD,YACC,OAAgB,EACA,IAA8B,EAC9C,MAA+B,EACf,UAAsB,EACtC,MAAc;QAEd,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QALf,SAAI,GAAJ,IAAI,CAA0B;QAE9B,eAAU,GAAV,UAAU,CAAY;QATvC,qHAAqH;QAC5G,qDAAkC;QA0C3B,WAAM,GACrB;YACC,GAAG,EAAE,CAAC,GAAa,EAA6B,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAgD,EAAE;gBACpE,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAEzC,OAAO,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC9C,MAAM,GAAG,GAAa,MAAM,CAAC,WAAW,EAAE,CAAC;oBAC3C,MAAM,IAAI,GAA8B;wBACvC,GAAG;wBACH,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC;qBAC3E,CAAC;oBACF,OAAO,IAAI,CAAC;gBACb,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;YACb,CAAC;SACD,CAAC;QA7CF,IAAI,CAAC,YAAY;YAChB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC9E,MAAM,CAAC,MAAM,CAAC,IAAI,qCAA6B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACpF,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACzC,uBAAA,IAAI,sCAAyB,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,WAAW,CAAC,MAAA,CAAC;IAChF,CAAC;IAEM,UAAU;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAEkB,qBAAqB,CACvC,MAA+B;QAE/B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAEkB,YAAY;QAC9B,4GAA4G;QAC5G,iDAAiD;QACjD,2GAA2G;QAC3G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC3C,uBAAA,IAAI,0CAAsB,MAA1B,IAAI,CAAwB,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC1B,CAAC;IAmBM,WAAW,CAAC,QAAkB;QACpC,eAAe,EAAE,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC1D,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YACtD,IAAI,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC;gBACnC,OAAO,SAAS,CAAC;YAClB,CAAC;YACD,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,QAAQ,CAAC,GAAa;QAC5B,eAAe,EAAE,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC1D,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE;YACjD,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAC9C,SAAS,CACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,EAC3D,MAAM,CACN,CACD,CAAC,MAAM,EAAE,CAAC;IACZ,CAAC;IAED,IAAW,WAAW;QACrB,eAAe,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QAEvC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QAExC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAClE,IAAI,WAAgC,CAAC;QAErC,uDAAuD;QACvD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1C,uFAAuF;YACvF,kDAAkD;YAClD,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;gBAC1B,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC;YACxD,CAAC;iBAAM,CAAC;gBACP,mDAAmD;gBACnD,mGAAmG;gBACnG,mEAAmE;gBACnE,mHAAmH;gBACnH,EAAE;gBACF,QAAQ;gBACR,8EAA8E;gBAC9E,kEAAkE;gBAClE,4JAA4J;gBAC5J,mCAAmC;gBACnC,2MAA2M;gBAC3M,8NAA8N;gBAC9N,qJAAqJ;gBACrJ,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC9C,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;YAC/B,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACvB,MAAM,UAAU,GACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC;gBAC9C,IAAI,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;YACxD,WAAW,GAAG,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;QACnD,CAAC;QAED,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QACpE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAExB,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;IAC1C,CAAC;IAEM,IAAI;QACV,OAAO,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;IAChF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, fail } from \"@fluidframework/core-utils/internal\";\n\nimport {\n\ttype Anchor,\n\ttype AnchorNode,\n\tCursorLocationType,\n\ttype FieldKey,\n\ttype FieldKindIdentifier,\n\ttype ITreeSubscriptionCursor,\n\ttype TreeNavigationResult,\n\ttype TreeNodeSchemaIdentifier,\n\ttype TreeNodeStoredSchema,\n\ttype Value,\n\tinCursorField,\n\tmapCursorFields,\n\trootFieldKey,\n} from \"../../core/index.js\";\nimport { disposeSymbol } from \"../../util/index.js\";\nimport { FieldKinds } from \"../default-schema/index.js\";\n\nimport type { Context } from \"./context.js\";\nimport {\n\tFlexTreeEntityKind,\n\ttype FlexTreeField,\n\ttype HydratedFlexTreeNode,\n\tflexTreeMarker,\n\tflexTreeSlot,\n} from \"./flexTreeTypes.js\";\nimport { LazyEntity } from \"./lazyEntity.js\";\nimport { makeField } from \"./lazyField.js\";\nimport { currentObserver } from \"./observer.js\";\n\n/**\n * Get or create a {@link HydratedFlexTreeNode} for the given context at node indicated by the cursor.\n * @remarks\n * This does not take ownership of this cursor: Node will fork it as needed.\n */\nexport function getOrCreateHydratedFlexTreeNode(\n\tcontext: Context,\n\tcursor: ITreeSubscriptionCursor,\n): HydratedFlexTreeNode {\n\tconst anchor = cursor.buildAnchor();\n\tconst anchorNode =\n\t\tcontext.checkout.forest.anchors.locate(anchor) ??\n\t\tfail(0xb12 /* cursor should point to a node that is not the root of the AnchorSet */);\n\tconst cached = anchorNode.slots.get(flexTreeSlot);\n\tif (cached !== undefined) {\n\t\tcontext.checkout.forest.anchors.forget(anchor);\n\t\tassert(cached.context === context, 0x782 /* contexts must match */);\n\t\tassert(cached instanceof LazyTreeNode, 0x92c /* Expected LazyTreeNode */);\n\t\treturn cached;\n\t}\n\treturn new LazyTreeNode(context, cursor.type, cursor, anchorNode, anchor);\n}\n\nfunction cleanupTree(anchor: AnchorNode): void {\n\tconst cached =\n\t\tanchor.slots.get(flexTreeSlot) ?? fail(0xb13 /* tree should only be cleaned up once */);\n\tassert(cached instanceof LazyTreeNode, 0x92d /* Expected LazyTreeNode */);\n\tcached[disposeSymbol]();\n}\n\n/**\n * Lazy implementation of {@link FlexTreeNode}.\n */\nexport class LazyTreeNode extends LazyEntity<Anchor> implements HydratedFlexTreeNode {\n\tpublic get [flexTreeMarker](): FlexTreeEntityKind.Node {\n\t\treturn FlexTreeEntityKind.Node;\n\t}\n\n\t// Using JS private here prevents it from showing up as a enumerable own property, or conflicting with struct fields.\n\treadonly #removeDeleteCallback: () => void;\n\n\tprivate readonly storedSchema: TreeNodeStoredSchema;\n\n\tpublic constructor(\n\t\tcontext: Context,\n\t\tpublic readonly type: TreeNodeSchemaIdentifier,\n\t\tcursor: ITreeSubscriptionCursor,\n\t\tpublic readonly anchorNode: AnchorNode,\n\t\tanchor: Anchor,\n\t) {\n\t\tsuper(context, cursor, anchor);\n\t\tthis.storedSchema =\n\t\t\tcontext.schema.nodeSchema.get(this.type) ?? fail(0xb14 /* missing schema */);\n\t\tassert(cursor.mode === CursorLocationType.Nodes, 0x783 /* must be in nodes mode */);\n\t\tanchorNode.slots.set(flexTreeSlot, this);\n\t\tthis.#removeDeleteCallback = anchorNode.events.on(\"afterDestroy\", cleanupTree);\n\t}\n\n\tpublic isHydrated(): this is HydratedFlexTreeNode {\n\t\treturn true;\n\t}\n\n\tprotected override tryMoveCursorToAnchor(\n\t\tcursor: ITreeSubscriptionCursor,\n\t): TreeNavigationResult {\n\t\treturn this.context.checkout.forest.tryMoveCursorToNode(this.anchor, cursor);\n\t}\n\n\tprotected override forgetAnchor(): void {\n\t\t// This type unconditionally has an anchor, so `forgetAnchor` is always called and cleanup can be done here:\n\t\t// After this point this node will not be usable,\n\t\t// so remove it from the anchor incase a different context (or the same context later) uses this AnchorSet.\n\t\tthis.anchorNode.slots.delete(flexTreeSlot);\n\t\tthis.#removeDeleteCallback();\n\t\tthis.context.checkout.forest.anchors.forget(this.anchor);\n\t}\n\n\tpublic get value(): Value {\n\t\treturn this.cursor.value;\n\t}\n\n\tpublic readonly fields: Pick<Map<FieldKey, FlexTreeField>, typeof Symbol.iterator | \"get\"> =\n\t\t{\n\t\t\tget: (key: FieldKey): FlexTreeField | undefined => this.tryGetField(key),\n\t\t\t[Symbol.iterator]: (): IterableIterator<[FieldKey, FlexTreeField]> => {\n\t\t\t\tcurrentObserver?.observeNodeFields(this);\n\n\t\t\t\treturn mapCursorFields(this.cursor, (cursor) => {\n\t\t\t\t\tconst key: FieldKey = cursor.getFieldKey();\n\t\t\t\t\tconst pair: [FieldKey, FlexTreeField] = [\n\t\t\t\t\t\tkey,\n\t\t\t\t\t\tmakeField(this.context, this.storedSchema.getFieldSchema(key).kind, cursor),\n\t\t\t\t\t];\n\t\t\t\t\treturn pair;\n\t\t\t\t}).values();\n\t\t\t},\n\t\t};\n\n\tpublic tryGetField(fieldKey: FieldKey): FlexTreeField | undefined {\n\t\tcurrentObserver?.observeNodeField(this, fieldKey);\n\n\t\tconst schema = this.storedSchema.getFieldSchema(fieldKey);\n\t\treturn inCursorField(this.cursor, fieldKey, (cursor) => {\n\t\t\tif (cursor.getFieldLength() === 0) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t\treturn makeField(this.context, schema.kind, cursor);\n\t\t});\n\t}\n\n\tpublic getBoxed(key: FieldKey): FlexTreeField {\n\t\tcurrentObserver?.observeNodeField(this, key);\n\n\t\tconst fieldSchema = this.storedSchema.getFieldSchema(key);\n\t\treturn inCursorField(this.cursor, key, (cursor) => {\n\t\t\treturn makeField(this.context, fieldSchema.kind, cursor);\n\t\t});\n\t}\n\n\tpublic [Symbol.iterator](): IterableIterator<FlexTreeField> {\n\t\treturn mapCursorFields(this.cursor, (cursor) =>\n\t\t\tmakeField(\n\t\t\t\tthis.context,\n\t\t\t\tthis.storedSchema.getFieldSchema(cursor.getFieldKey()).kind,\n\t\t\t\tcursor,\n\t\t\t),\n\t\t).values();\n\t}\n\n\tpublic get parentField(): { readonly parent: FlexTreeField; readonly index: number } {\n\t\tcurrentObserver?.observeParentOf(this);\n\n\t\tconst cursor = this.cursor;\n\t\tconst index = this.anchorNode.parentIndex;\n\t\tassert(cursor.fieldIndex === index, 0x786 /* mismatched indexes */);\n\t\tconst key = this.anchorNode.parentField;\n\n\t\tcursor.exitNode();\n\t\tassert(key === cursor.getFieldKey(), 0x787 /* mismatched keys */);\n\t\tlet fieldSchema: FieldKindIdentifier;\n\n\t\t// Check if the current node is in a detached sequence.\n\t\tif (this.anchorNode.parent === undefined) {\n\t\t\t// Parent field is a detached sequence, and thus needs special handling for its schema.\n\t\t\t// eslint-disable-next-line unicorn/prefer-ternary\n\t\t\tif (key === rootFieldKey) {\n\t\t\t\tfieldSchema = this.context.schema.rootFieldSchema.kind;\n\t\t\t} else {\n\t\t\t\t// All fields (in the flex tree API) have a schema.\n\t\t\t\t// Since currently there is no known schema for detached field other than the special default root:\n\t\t\t\t// give all other detached fields a schema of sequence of anything.\n\t\t\t\t// That schema is the only one that is safe since its the only field schema that allows any possible field content.\n\t\t\t\t//\n\t\t\t\t// TODO:\n\t\t\t\t// if any of the following are done this schema will need to be more specific:\n\t\t\t\t// 1. Editing APIs start exposing user created detached sequences.\n\t\t\t\t// 2. Remove (and its inverse) start working on subsequences or fields contents (like everything in a sequence or optional field) and not just single nodes.\n\t\t\t\t// 3. Possibly other unknown cases.\n\t\t\t\t// Additionally this approach makes it possible for a user to take a FlexTree node, get its parent, check its schema, down cast based on that, then edit that detached field (ex: removing the node in it).\n\t\t\t\t// This MIGHT work properly with existing merge resolution logic (it must keep client in sync and be unable to violate schema), but this either needs robust testing or to be explicitly banned (error before sending the op).\n\t\t\t\t// Issues like replacing a node in the a removed sequenced then undoing the remove could easily violate schema if not everything works exactly right!\n\t\t\t\tfieldSchema = FieldKinds.sequence.identifier;\n\t\t\t}\n\t\t} else {\n\t\t\tcursor.exitField();\n\t\t\tconst parentType = cursor.type;\n\t\t\tcursor.enterField(key);\n\t\t\tconst nodeSchema =\n\t\t\t\tthis.context.schema.nodeSchema.get(parentType) ??\n\t\t\t\tfail(0xb15 /* requested schema that does not exist */);\n\t\t\tfieldSchema = nodeSchema.getFieldSchema(key).kind;\n\t\t}\n\n\t\tconst proxifiedField = makeField(this.context, fieldSchema, cursor);\n\t\tcursor.enterNode(index);\n\n\t\treturn { parent: proxifiedField, index };\n\t}\n\n\tpublic keys(): IterableIterator<FieldKey> {\n\t\treturn mapCursorFields(this.cursor, (cursor) => cursor.getFieldKey()).values();\n\t}\n}\n"]}
+{"version":3,"file":"lazyNode.js","sourceRoot":"","sources":["../../../src/feature-libraries/flex-tree/lazyNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,qCAAqC,CAAC;AAEnE,OAAO,EAWN,aAAa,EACb,eAAe,EACf,YAAY,GACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAGxD,OAAO,EACN,kBAAkB,EAGlB,cAAc,EACd,YAAY,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAC9C,OAAgB,EAChB,MAA+B;IAE/B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACpC,MAAM,UAAU,GACf,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;QAC9C,IAAI,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAC;IACvF,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAClD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,YAAY,YAAY,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC1E,OAAO,MAAM,CAAC;IACf,CAAC;IACD,OAAO,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,WAAW,CAAC,MAAkB;IACtC,MAAM,MAAM,GACX,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACzF,MAAM,CAAC,MAAM,YAAY,YAAY,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC1E,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,UAAkB;IAYlC;IAEA;IAbjB,IAAW,CAAC,cAAc,CAAC;QAC1B,OAAO,kBAAkB,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,qHAAqH;IAC5G,qBAAqB,CAAa;IAE1B,YAAY,CAAuB;IAEpD,YACC,OAAgB,EACA,IAA8B,EAC9C,MAA+B,EACf,UAAsB,EACtC,MAAc;QAEd,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QALf,SAAI,GAAJ,IAAI,CAA0B;QAE9B,eAAU,GAAV,UAAU,CAAY;QAItC,IAAI,CAAC,YAAY;YAChB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC9E,MAAM,CAAC,MAAM,CAAC,IAAI,qCAA6B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACpF,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,qBAAqB,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IAChF,CAAC;IAEM,UAAU;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAEkB,qBAAqB,CACvC,MAA+B;QAE/B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAEkB,YAAY;QAC9B,4GAA4G;QAC5G,iDAAiD;QACjD,2GAA2G;QAC3G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC1B,CAAC;IAEe,MAAM,GACrB;QACC,GAAG,EAAE,CAAC,GAAa,EAA6B,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;QACxE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAgD,EAAE;YACpE,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAEzC,OAAO,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;gBAC9C,MAAM,GAAG,GAAa,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC3C,MAAM,IAAI,GAA8B;oBACvC,GAAG;oBACH,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC;iBAC3E,CAAC;gBACF,OAAO,IAAI,CAAC;YACb,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QACb,CAAC;KACD,CAAC;IAEI,WAAW,CAAC,QAAkB;QACpC,eAAe,EAAE,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC1D,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YACtD,IAAI,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC;gBACnC,OAAO,SAAS,CAAC;YAClB,CAAC;YACD,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,QAAQ,CAAC,GAAa;QAC5B,eAAe,EAAE,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC1D,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE;YACjD,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAC9C,SAAS,CACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,EAC3D,MAAM,CACN,CACD,CAAC,MAAM,EAAE,CAAC;IACZ,CAAC;IAED,IAAW,WAAW;QACrB,eAAe,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QAEvC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QAExC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAClE,IAAI,WAAgC,CAAC;QAErC,uDAAuD;QACvD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1C,uFAAuF;YACvF,kDAAkD;YAClD,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;gBAC1B,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC;YACxD,CAAC;iBAAM,CAAC;gBACP,mDAAmD;gBACnD,mGAAmG;gBACnG,mEAAmE;gBACnE,mHAAmH;gBACnH,EAAE;gBACF,QAAQ;gBACR,8EAA8E;gBAC9E,kEAAkE;gBAClE,4JAA4J;gBAC5J,mCAAmC;gBACnC,2MAA2M;gBAC3M,8NAA8N;gBAC9N,qJAAqJ;gBACrJ,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC9C,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;YAC/B,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACvB,MAAM,UAAU,GACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC;gBAC9C,IAAI,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;YACxD,WAAW,GAAG,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;QACnD,CAAC;QAED,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QACpE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAExB,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;IAC1C,CAAC;IAEM,IAAI;QACV,OAAO,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;IAChF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, fail } from \"@fluidframework/core-utils/internal\";\n\nimport {\n\ttype Anchor,\n\ttype AnchorNode,\n\tCursorLocationType,\n\ttype FieldKey,\n\ttype FieldKindIdentifier,\n\ttype ITreeSubscriptionCursor,\n\ttype TreeNavigationResult,\n\ttype TreeNodeSchemaIdentifier,\n\ttype TreeNodeStoredSchema,\n\ttype Value,\n\tinCursorField,\n\tmapCursorFields,\n\trootFieldKey,\n} from \"../../core/index.js\";\nimport { disposeSymbol } from \"../../util/index.js\";\nimport { FieldKinds } from \"../default-schema/index.js\";\n\nimport type { Context } from \"./context.js\";\nimport {\n\tFlexTreeEntityKind,\n\ttype FlexTreeField,\n\ttype HydratedFlexTreeNode,\n\tflexTreeMarker,\n\tflexTreeSlot,\n} from \"./flexTreeTypes.js\";\nimport { LazyEntity } from \"./lazyEntity.js\";\nimport { makeField } from \"./lazyField.js\";\nimport { currentObserver } from \"./observer.js\";\n\n/**\n * Get or create a {@link HydratedFlexTreeNode} for the given context at node indicated by the cursor.\n * @remarks\n * This does not take ownership of this cursor: Node will fork it as needed.\n */\nexport function getOrCreateHydratedFlexTreeNode(\n\tcontext: Context,\n\tcursor: ITreeSubscriptionCursor,\n): HydratedFlexTreeNode {\n\tconst anchor = cursor.buildAnchor();\n\tconst anchorNode =\n\t\tcontext.checkout.forest.anchors.locate(anchor) ??\n\t\tfail(0xb12 /* cursor should point to a node that is not the root of the AnchorSet */);\n\tconst cached = anchorNode.slots.get(flexTreeSlot);\n\tif (cached !== undefined) {\n\t\tcontext.checkout.forest.anchors.forget(anchor);\n\t\tassert(cached.context === context, 0x782 /* contexts must match */);\n\t\tassert(cached instanceof LazyTreeNode, 0x92c /* Expected LazyTreeNode */);\n\t\treturn cached;\n\t}\n\treturn new LazyTreeNode(context, cursor.type, cursor, anchorNode, anchor);\n}\n\nfunction cleanupTree(anchor: AnchorNode): void {\n\tconst cached =\n\t\tanchor.slots.get(flexTreeSlot) ?? fail(0xb13 /* tree should only be cleaned up once */);\n\tassert(cached instanceof LazyTreeNode, 0x92d /* Expected LazyTreeNode */);\n\tcached[disposeSymbol]();\n}\n\n/**\n * Lazy implementation of {@link FlexTreeNode}.\n */\nexport class LazyTreeNode extends LazyEntity<Anchor> implements HydratedFlexTreeNode {\n\tpublic get [flexTreeMarker](): FlexTreeEntityKind.Node {\n\t\treturn FlexTreeEntityKind.Node;\n\t}\n\n\t// Using JS private here prevents it from showing up as a enumerable own property, or conflicting with struct fields.\n\treadonly #removeDeleteCallback: () => void;\n\n\tprivate readonly storedSchema: TreeNodeStoredSchema;\n\n\tpublic constructor(\n\t\tcontext: Context,\n\t\tpublic readonly type: TreeNodeSchemaIdentifier,\n\t\tcursor: ITreeSubscriptionCursor,\n\t\tpublic readonly anchorNode: AnchorNode,\n\t\tanchor: Anchor,\n\t) {\n\t\tsuper(context, cursor, anchor);\n\t\tthis.storedSchema =\n\t\t\tcontext.schema.nodeSchema.get(this.type) ?? fail(0xb14 /* missing schema */);\n\t\tassert(cursor.mode === CursorLocationType.Nodes, 0x783 /* must be in nodes mode */);\n\t\tanchorNode.slots.set(flexTreeSlot, this);\n\t\tthis.#removeDeleteCallback = anchorNode.events.on(\"afterDestroy\", cleanupTree);\n\t}\n\n\tpublic isHydrated(): this is HydratedFlexTreeNode {\n\t\treturn true;\n\t}\n\n\tprotected override tryMoveCursorToAnchor(\n\t\tcursor: ITreeSubscriptionCursor,\n\t): TreeNavigationResult {\n\t\treturn this.context.checkout.forest.tryMoveCursorToNode(this.anchor, cursor);\n\t}\n\n\tprotected override forgetAnchor(): void {\n\t\t// This type unconditionally has an anchor, so `forgetAnchor` is always called and cleanup can be done here:\n\t\t// After this point this node will not be usable,\n\t\t// so remove it from the anchor incase a different context (or the same context later) uses this AnchorSet.\n\t\tthis.anchorNode.slots.delete(flexTreeSlot);\n\t\tthis.#removeDeleteCallback();\n\t\tthis.context.checkout.forest.anchors.forget(this.anchor);\n\t}\n\n\tpublic get value(): Value {\n\t\treturn this.cursor.value;\n\t}\n\n\tpublic readonly fields: Pick<Map<FieldKey, FlexTreeField>, typeof Symbol.iterator | \"get\"> =\n\t\t{\n\t\t\tget: (key: FieldKey): FlexTreeField | undefined => this.tryGetField(key),\n\t\t\t[Symbol.iterator]: (): IterableIterator<[FieldKey, FlexTreeField]> => {\n\t\t\t\tcurrentObserver?.observeNodeFields(this);\n\n\t\t\t\treturn mapCursorFields(this.cursor, (cursor) => {\n\t\t\t\t\tconst key: FieldKey = cursor.getFieldKey();\n\t\t\t\t\tconst pair: [FieldKey, FlexTreeField] = [\n\t\t\t\t\t\tkey,\n\t\t\t\t\t\tmakeField(this.context, this.storedSchema.getFieldSchema(key).kind, cursor),\n\t\t\t\t\t];\n\t\t\t\t\treturn pair;\n\t\t\t\t}).values();\n\t\t\t},\n\t\t};\n\n\tpublic tryGetField(fieldKey: FieldKey): FlexTreeField | undefined {\n\t\tcurrentObserver?.observeNodeField(this, fieldKey);\n\n\t\tconst schema = this.storedSchema.getFieldSchema(fieldKey);\n\t\treturn inCursorField(this.cursor, fieldKey, (cursor) => {\n\t\t\tif (cursor.getFieldLength() === 0) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t\treturn makeField(this.context, schema.kind, cursor);\n\t\t});\n\t}\n\n\tpublic getBoxed(key: FieldKey): FlexTreeField {\n\t\tcurrentObserver?.observeNodeField(this, key);\n\n\t\tconst fieldSchema = this.storedSchema.getFieldSchema(key);\n\t\treturn inCursorField(this.cursor, key, (cursor) => {\n\t\t\treturn makeField(this.context, fieldSchema.kind, cursor);\n\t\t});\n\t}\n\n\tpublic [Symbol.iterator](): IterableIterator<FlexTreeField> {\n\t\treturn mapCursorFields(this.cursor, (cursor) =>\n\t\t\tmakeField(\n\t\t\t\tthis.context,\n\t\t\t\tthis.storedSchema.getFieldSchema(cursor.getFieldKey()).kind,\n\t\t\t\tcursor,\n\t\t\t),\n\t\t).values();\n\t}\n\n\tpublic get parentField(): { readonly parent: FlexTreeField; readonly index: number } {\n\t\tcurrentObserver?.observeParentOf(this);\n\n\t\tconst cursor = this.cursor;\n\t\tconst index = this.anchorNode.parentIndex;\n\t\tassert(cursor.fieldIndex === index, 0x786 /* mismatched indexes */);\n\t\tconst key = this.anchorNode.parentField;\n\n\t\tcursor.exitNode();\n\t\tassert(key === cursor.getFieldKey(), 0x787 /* mismatched keys */);\n\t\tlet fieldSchema: FieldKindIdentifier;\n\n\t\t// Check if the current node is in a detached sequence.\n\t\tif (this.anchorNode.parent === undefined) {\n\t\t\t// Parent field is a detached sequence, and thus needs special handling for its schema.\n\t\t\t// eslint-disable-next-line unicorn/prefer-ternary\n\t\t\tif (key === rootFieldKey) {\n\t\t\t\tfieldSchema = this.context.schema.rootFieldSchema.kind;\n\t\t\t} else {\n\t\t\t\t// All fields (in the flex tree API) have a schema.\n\t\t\t\t// Since currently there is no known schema for detached field other than the special default root:\n\t\t\t\t// give all other detached fields a schema of sequence of anything.\n\t\t\t\t// That schema is the only one that is safe since its the only field schema that allows any possible field content.\n\t\t\t\t//\n\t\t\t\t// TODO:\n\t\t\t\t// if any of the following are done this schema will need to be more specific:\n\t\t\t\t// 1. Editing APIs start exposing user created detached sequences.\n\t\t\t\t// 2. Remove (and its inverse) start working on subsequences or fields contents (like everything in a sequence or optional field) and not just single nodes.\n\t\t\t\t// 3. Possibly other unknown cases.\n\t\t\t\t// Additionally this approach makes it possible for a user to take a FlexTree node, get its parent, check its schema, down cast based on that, then edit that detached field (ex: removing the node in it).\n\t\t\t\t// This MIGHT work properly with existing merge resolution logic (it must keep client in sync and be unable to violate schema), but this either needs robust testing or to be explicitly banned (error before sending the op).\n\t\t\t\t// Issues like replacing a node in the a removed sequenced then undoing the remove could easily violate schema if not everything works exactly right!\n\t\t\t\tfieldSchema = FieldKinds.sequence.identifier;\n\t\t\t}\n\t\t} else {\n\t\t\tcursor.exitField();\n\t\t\tconst parentType = cursor.type;\n\t\t\tcursor.enterField(key);\n\t\t\tconst nodeSchema =\n\t\t\t\tthis.context.schema.nodeSchema.get(parentType) ??\n\t\t\t\tfail(0xb15 /* requested schema that does not exist */);\n\t\t\tfieldSchema = nodeSchema.getFieldSchema(key).kind;\n\t\t}\n\n\t\tconst proxifiedField = makeField(this.context, fieldSchema, cursor);\n\t\tcursor.enterNode(index);\n\n\t\treturn { parent: proxifiedField, index };\n\t}\n\n\tpublic keys(): IterableIterator<FieldKey> {\n\t\treturn mapCursorFields(this.cursor, (cursor) => cursor.getFieldKey()).values();\n\t}\n}\n"]}

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

@@ -19,130 +19,135 @@ import { minVersionToForestSummaryFormatVersion, getForestRootSummaryContentKey,
  * Provides methods for summarizing and loading a forest.
  */
 let ForestSummarizer = (() => {
-    var _a;
     let _classSuper = 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 = defaultIncrementalEncodingPolicy) {
-                super(forestSummaryKey, minVersionToForestSummaryFormatVersion(options.minVersionForCollab), supportedForestSummaryFormatVersions, true /* supportPreVersioningFormat */);
-                this.forest = (__runInitializers(this, _instanceExtraInitializers), forest);
-                this.encoderContext = encoderContext;
-                this.decoderContext = decoderContext;
-                this.idCompressor = idCompressor;
-                this.codec = forestCodecBuilder.build(options);
-                const summaryFormatWriteVersion = minVersionToForestSummaryFormatVersion(options.minVersionForCollab);
-                this.forestRootSummaryContentKey = 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 >= ForestSummaryFormatVersion.v3 &&
-                    encoderContext.encodeType === TreeCompressionStrategy.CompressedIncremental;
-                this.incrementalSummaryBuilder = new ForestIncrementalSummaryBuilder(enableIncrementalSummary, (cursor) => this.forest.chunkField(cursor), shouldEncodeIncrementally, initialSequenceNumber);
+    return class ForestSummarizer extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _loadInternal_decorators = [breakingMethod];
+            __esDecorate(this, 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(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        forest = __runInitializers(this, _instanceExtraInitializers);
+        encoderContext;
+        decoderContext;
+        idCompressor;
+        codec;
+        /**
+         * This object is broken if and only if the forest it owns is broken.
+         */
+        get breaker() {
+            return this.forest.breaker;
+        }
+        incrementalSummaryBuilder;
+        forestRootSummaryContentKey;
+        /**
+         * @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 = defaultIncrementalEncodingPolicy) {
+            super(forestSummaryKey, minVersionToForestSummaryFormatVersion(options.minVersionForCollab), supportedForestSummaryFormatVersions, true /* supportPreVersioningFormat */);
+            this.forest = forest;
+            this.encoderContext = encoderContext;
+            this.decoderContext = decoderContext;
+            this.idCompressor = idCompressor;
+            this.codec = forestCodecBuilder.build(options);
+            const summaryFormatWriteVersion = minVersionToForestSummaryFormatVersion(options.minVersionForCollab);
+            this.forestRootSummaryContentKey = 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 >= ForestSummaryFormatVersion.v3 &&
+                encoderContext.encodeType === TreeCompressionStrategy.CompressedIncremental;
+            this.incrementalSummaryBuilder = new 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
+            forEachField(rootCursor, (cursor) => {
+                const key = cursor.getFieldKey();
+                const innerCursor = this.forest.allocateCursor("getTreeString");
+                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 === ForestIncrementalSummaryBehavior.Incremental
+                    ? this.incrementalSummaryBuilder
+                    : undefined,
+            };
+            const encoded = this.codec.encode(fieldMap, encoderContext);
+            for (const value of fieldMap.values()) {
+                value.free();
             }
-            /**
-             * 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
-                forEachField(rootCursor, (cursor) => {
-                    const key = cursor.getFieldKey();
-                    const innerCursor = this.forest.allocateCursor("getTreeString");
-                    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,
+            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 = getForestRootSummaryContentKey(version);
+            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) => 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 readAndParseSnapshotBlob(forestSummaryRootContentKey, services, parse)), this.decoderContext.withIncrementalDecoder(this.incrementalSummaryBuilder));
+            const allocator = idAllocatorFromMaxId();
+            const fieldChanges = [];
+            const build = [];
+            for (const [fieldKey, field] of fields) {
+                const chunked = chunkFieldSingle(field, {
+                    policy: defaultChunkPolicy,
+                    idCompressor: this.idCompressor,
                 });
-                const encoderContext = {
-                    ...this.encoderContext,
-                    incrementalEncoder: incrementalSummaryBehavior === 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,
+                const buildId = { minor: allocator.allocate(chunked.topLevelLength) };
+                build.push({
+                    id: buildId,
+                    trees: chunked,
                 });
+                fieldChanges.push([
+                    fieldKey,
+                    { marks: [{ count: chunked.topLevelLength, attach: buildId }] },
+                ]);
             }
-            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 = getForestRootSummaryContentKey(version);
-                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) => 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 readAndParseSnapshotBlob(forestSummaryRootContentKey, services, parse)), this.decoderContext.withIncrementalDecoder(this.incrementalSummaryBuilder));
-                const allocator = idAllocatorFromMaxId();
-                const fieldChanges = [];
-                const build = [];
-                for (const [fieldKey, field] of fields) {
-                    const chunked = chunkFieldSingle(field, {
-                        policy: 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 }] },
-                    ]);
-                }
-                assert(this.forest.isEmpty, 0x797 /* forest must be empty */);
-                applyDelta({ build, fields: new Map(fieldChanges) }, undefined, this.forest, makeDetachedFieldIndex("init"));
-            }
-        },
-        (() => {
-            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-            _loadInternal_decorators = [breakingMethod];
-            __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;
+            assert(this.forest.isEmpty, 0x797 /* forest must be empty */);
+            applyDelta({ build, fields: new Map(fieldChanges) }, undefined, this.forest, makeDetachedFieldIndex("init"));
+        }
+    };
 })();
 export { ForestSummarizer };
 //# sourceMappingURL=forestSummarizer.js.map

package/lib/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,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAU7D,OAAO,EAQN,UAAU,EACV,YAAY,EACZ,sBAAsB,GACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,mBAAmB,GAInB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,cAAc,EACd,oBAAoB,EACpB,wBAAwB,GAGxB,MAAM,qBAAqB,CAAC;AAC7B,wDAAwD;AACxD,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACtF,OAAO,EACN,gCAAgC,GAIhC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAoB,MAAM,YAAY,CAAC;AAClE,OAAO,EACN,gCAAgC,EAChC,+BAA+B,GAC/B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACN,0BAA0B,EAC1B,gBAAgB,EAChB,oCAAoC,GACpC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACN,sCAAsC,EACtC,8BAA8B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;IACU,gBAAgB;;sBACpB,mBAAmB;;;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,gCAAgC;gBAEvF,KAAK,CACJ,gBAAgB,EAChB,sCAAsC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EACnE,oCAAoC,EACpC,IAAI,CAAC,gCAAgC,CACrC,CAAC;gBAbe,WAAM,IApBZ,mDAAgB,EAoBV,MAAM,EAAiB;gBACvB,mBAAc,GAAd,cAAc,CAA2B;gBACzC,mBAAc,GAAd,cAAc,CAA2B;gBAEzC,iBAAY,GAAZ,YAAY,CAAe;gBAW5C,IAAI,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE/C,MAAM,yBAAyB,GAAG,sCAAsC,CACvE,OAAO,CAAC,mBAAmB,CAC3B,CAAC;gBACF,IAAI,CAAC,2BAA2B,GAAG,8BAA8B,CAChE,yBAAyB,CACzB,CAAC;gBAEF,6EAA6E;gBAC7E,sEAAsE;gBACtE,qHAAqH;gBACrH,MAAM,wBAAwB,GAC7B,yBAAyB,IAAI,0BAA0B,CAAC,EAAE;oBAC1D,cAAc,CAAC,UAAU,KAAK,uBAAuB,CAAC,qBAAqB,CAAC;gBAC7E,IAAI,CAAC,yBAAyB,GAAG,IAAI,+BAA+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,YAAY,CAAC,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,MAAM,CACL,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,gCAAgC,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,8BAA8B,CAAC,OAAO,CAAC,CAAC;gBAC5E,MAAM,CACL,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,wBAAwB,CAAC,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,wBAAwB,CAC9B,2BAA2B,EAC3B,QAAQ,EACR,KAAK,CAEL,CAA2B,EAC5B,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAC1E,CAAC;gBACF,MAAM,SAAS,GAAG,oBAAoB,EAAE,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,gBAAgB,CAAC,KAAK,EAAE;wBACvC,MAAM,EAAE,kBAAkB;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,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;gBAC9D,UAAU,CACT,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,YAAY,CAAC,EAAE,EACxC,SAAS,EACT,IAAI,CAAC,MAAM,EACX,sBAAsB,CAAC,MAAM,CAAC,CAC9B,CAAC;YACH,CAAC;;;;wCA/DA,cAAc;YACf,qLAAgB,YAAY,6DA8D3B;;;;;SAxLW,gBAAgB","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"]}
+{"version":3,"file":"forestSummarizer.js","sourceRoot":"","sources":["../../../src/feature-libraries/forest-summary/forestSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAU7D,OAAO,EAQN,UAAU,EACV,YAAY,EACZ,sBAAsB,GACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,mBAAmB,GAInB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,cAAc,EACd,oBAAoB,EACpB,wBAAwB,GAGxB,MAAM,qBAAqB,CAAC;AAC7B,wDAAwD;AACxD,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACtF,OAAO,EACN,gCAAgC,GAIhC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAoB,MAAM,YAAY,CAAC;AAClE,OAAO,EACN,gCAAgC,EAChC,+BAA+B,GAC/B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACN,0BAA0B,EAC1B,gBAAgB,EAChB,oCAAoC,GACpC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACN,sCAAsC,EACtC,8BAA8B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;IACU,gBAAgB;sBACpB,mBAAmB;;;iBADf,gBACZ,SAAQ,WAA+C;;;wCAwHtD,cAAc;YACf,uLAAgB,YAAY,6DA8D3B;;;QApKiB,MAAM,GApBZ,mDAAgB;QAqBV,cAAc;QACd,cAAc;QAEd,YAAY;QApBb,KAAK,CAAc;QAEpC;;WAEG;QACH,IAAW,OAAO;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAC5B,CAAC;QAEgB,yBAAyB,CAAkC;QAC3D,2BAA2B,CAAS;QAErD;;WAEG;QACH,YACkB,MAAuB,EACvB,cAAyC,EACzC,cAAyC,EAC1D,OAA0B,EACT,YAA2B,EAC5C,qBAA6B,EAC7B,4BAAuD,gCAAgC;YAEvF,KAAK,CACJ,gBAAgB,EAChB,sCAAsC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EACnE,oCAAoC,EACpC,IAAI,CAAC,gCAAgC,CACrC,CAAC;YAbe,WAAM,GAAN,MAAM,CAAiB;YACvB,mBAAc,GAAd,cAAc,CAA2B;YACzC,mBAAc,GAAd,cAAc,CAA2B;YAEzC,iBAAY,GAAZ,YAAY,CAAe;YAW5C,IAAI,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE/C,MAAM,yBAAyB,GAAG,sCAAsC,CACvE,OAAO,CAAC,mBAAmB,CAC3B,CAAC;YACF,IAAI,CAAC,2BAA2B,GAAG,8BAA8B,CAChE,yBAAyB,CACzB,CAAC;YAEF,6EAA6E;YAC7E,sEAAsE;YACtE,qHAAqH;YACrH,MAAM,wBAAwB,GAC7B,yBAAyB,IAAI,0BAA0B,CAAC,EAAE;gBAC1D,cAAc,CAAC,UAAU,KAAK,uBAAuB,CAAC,qBAAqB,CAAC;YAC7E,IAAI,CAAC,yBAAyB,GAAG,IAAI,+BAA+B,CACnE,wBAAwB,EACxB,CAAC,MAA8B,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAClE,yBAAyB,EACzB,qBAAqB,CACrB,CAAC;QACH,CAAC;QAED;;;;;;;;;WASG;QACO,iBAAiB,CAAC,KAO3B;YACA,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,yBAAyB,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;YAElF,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,4BAA4B,EAAE,CAAC;YAC9D,MAAM,QAAQ,GACb,IAAI,GAAG,EAAE,CAAC;YACX,2FAA2F;YAC3F,YAAY,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE;gBACnC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;gBACjC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;gBAChE,MAAM,CACL,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,WAAW,CAAC;mDAC3D,EACxB,KAAK,CAAC,iCAAiC,CACvC,CAAC;gBACF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,WAA+D,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC;YAEH,+EAA+E;YAC/E,sDAAsD;YACtD,MAAM,0BAA0B,GAAG,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC;gBAC9E,QAAQ;gBACR,yBAAyB;gBACzB,SAAS;gBACT,OAAO;aACP,CAAC,CAAC;YACH,MAAM,cAAc,GAA8B;gBACjD,GAAG,IAAI,CAAC,cAAc;gBACtB,kBAAkB,EACjB,0BAA0B,KAAK,gCAAgC,CAAC,WAAW;oBAC1E,CAAC,CAAC,IAAI,CAAC,yBAAyB;oBAChC,CAAC,CAAC,SAAS;aACb,CAAC;YACF,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC5D,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBACvC,KAAK,CAAC,IAAI,EAAE,CAAC;YACd,CAAC;YAED,IAAI,CAAC,yBAAyB,CAAC,eAAe,CAAC;gBAC9C,yBAAyB;gBACzB,wBAAwB,EAAE,SAAS,CAAC,OAAO,CAAC;gBAC5C,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;gBAC7D,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;QAGS,KAAK,CAAC,YAAY,CAC3B,QAAgC,EAChC,KAA2B,EAC3B,OAA+C;YAE/C,oHAAoH;YACpH,4GAA4G;YAC5G,wBAAwB;YACxB,8GAA8G;YAC9G,wCAAwC;YACxC,gHAAgH;YAChH,MAAM,2BAA2B,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;YAC5E,MAAM,CACL,MAAM,QAAQ,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EACpD,KAAK,CAAC,gDAAgD,CACtD,CAAC;YAEF,6FAA6F;YAC7F,YAAY;YACZ,MAAM,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC;gBACzC,QAAQ;gBACR,iBAAiB,EAAE,KAAK,EAAE,aAAqB,EAAE,EAAE,CAClD,wBAAwB,CAAC,aAAa,EAAE,QAAQ,EAAE,KAAK,CAAC;aACzD,CAAC,CAAC;YAEH,2HAA2H;YAC3H,yBAAyB;YACzB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAC/B,CAAC,MAAM,wBAAwB,CAC9B,2BAA2B,EAC3B,QAAQ,EACR,KAAK,CAEL,CAA2B,EAC5B,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAC1E,CAAC;YACF,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;YACzC,MAAM,YAAY,GAAoC,EAAE,CAAC;YACzD,MAAM,KAAK,GAA6B,EAAE,CAAC;YAC3C,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;gBACxC,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE;oBACvC,MAAM,EAAE,kBAAkB;oBAC1B,YAAY,EAAE,IAAI,CAAC,YAAY;iBAC/B,CAAC,CAAC;gBACH,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;gBACtE,KAAK,CAAC,IAAI,CAAC;oBACV,EAAE,EAAE,OAAO;oBACX,KAAK,EAAE,OAAO;iBACd,CAAC,CAAC;gBACH,YAAY,CAAC,IAAI,CAAC;oBACjB,QAAQ;oBACR,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE;iBAC/D,CAAC,CAAC;YACJ,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,UAAU,CACT,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,YAAY,CAAC,EAAE,EACxC,SAAS,EACT,IAAI,CAAC,MAAM,EACX,sBAAsB,CAAC,MAAM,CAAC,CAC9B,CAAC;QACH,CAAC;;;SAxLW,gBAAgB","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"]}

package/lib/feature-libraries/forest-summary/incrementalSummaryBuilder.js

@@ -66,6 +66,29 @@ export var ForestIncrementalSummaryBehavior;
  */
 /* eslint-enable jsdoc/check-indentation */
 export class ForestIncrementalSummaryBuilder {
+    enableIncrementalSummary;
+    getChunkAtCursor;
+    shouldEncodeIncrementally;
+    initialSequenceNumber;
+    /**
+     * The next reference ID to use for a chunk.
+     */
+    nextReferenceId = brand(0);
+    /**
+     * For a given summary sequence number, keeps track of a chunk's properties that will be used to generate
+     * a summary handle for the chunk if it does not change between summaries.
+     *
+     * @remarks
+     * `chunk` (the TreeChunk object) is used as the map key by object identity.
+     * This assumes each chunk appears at exactly one position in the forest — an invariant that holds because every
+     * node in a tree has a single parent.
+     * If the forest ever introduced structural sharing (two positions backed by the same TreeChunk object),
+     * a second call here would silently overwrite the first entry, causing the first position's handle to point
+     * to the second position's parent in subsequent summaries. In theory, this should be fine from summary perspective
+     * because the chunk contents are the same. But, it could lead to confusing handle paths in the summary tree and
+     * may lead to other unexpected behavior. Adequate tests should be added if structural sharing is introduced.
+     */
+    chunkTrackingPropertiesMap = new Map();
     /**
      * True when encoding a summary, false otherwise.
      * @remarks
@@ -74,43 +97,37 @@ export class ForestIncrementalSummaryBuilder {
     get isSummarizing() {
         return this.trackedSummaryProperties !== undefined;
     }
+    /**
+     * The sequence number of the latest summary that was successful.
+     */
+    latestSummarySequenceNumber = -1;
+    /**
+     * The current state of the summary being "tracked".
+     * @remarks
+     * A summary being "tracked" means that a summary is being encoded.
+     * This is undefined if no summary is currently being encoded.
+     *
+     * @privateRemarks
+     * This has nothing to do which how content from a summary being loaded is tracked (thats written all in chunkTrackingPropertiesMap).
+     * "Tracked" should probably be renamed to "encoded" or "summarizing" or something like that to avoid confusion.
+     * Perhaps a better way to clarify this would be to not store this property on this object at all, and have it
+     * only exist within the scope of the summary encoding (use an encoding specific object to accumulate any stat necessary during encode).
+     */
+    trackedSummaryProperties;
+    /**
+     * A map of chunk reference IDs to their encoded contents. This is typically used during the loading of the
+     * forest to retrieve the contents of the chunks that were summarized incrementally.
+     */
+    /**
+     * A map of chunk reference IDs to their {@link ChunkLoadProperties}.
+     * This is used during the loading of the forest to track each chunk that is retrieved and decoded.
+     */
+    loadedChunksMap = new Map();
     constructor(enableIncrementalSummary, getChunkAtCursor, shouldEncodeIncrementally, initialSequenceNumber) {
         this.enableIncrementalSummary = enableIncrementalSummary;
         this.getChunkAtCursor = getChunkAtCursor;
         this.shouldEncodeIncrementally = shouldEncodeIncrementally;
         this.initialSequenceNumber = initialSequenceNumber;
-        /**
-         * The next reference ID to use for a chunk.
-         */
-        this.nextReferenceId = brand(0);
-        /**
-         * For a given summary sequence number, keeps track of a chunk's properties that will be used to generate
-         * a summary handle for the chunk if it does not change between summaries.
-         *
-         * @remarks
-         * `chunk` (the TreeChunk object) is used as the map key by object identity.
-         * This assumes each chunk appears at exactly one position in the forest — an invariant that holds because every
-         * node in a tree has a single parent.
-         * If the forest ever introduced structural sharing (two positions backed by the same TreeChunk object),
-         * a second call here would silently overwrite the first entry, causing the first position's handle to point
-         * to the second position's parent in subsequent summaries. In theory, this should be fine from summary perspective
-         * because the chunk contents are the same. But, it could lead to confusing handle paths in the summary tree and
-         * may lead to other unexpected behavior. Adequate tests should be added if structural sharing is introduced.
-         */
-        this.chunkTrackingPropertiesMap = new Map();
-        /**
-         * The sequence number of the latest summary that was successful.
-         */
-        this.latestSummarySequenceNumber = -1;
-        /**
-         * A map of chunk reference IDs to their encoded contents. This is typically used during the loading of the
-         * forest to retrieve the contents of the chunks that were summarized incrementally.
-         */
-        /**
-         * A map of chunk reference IDs to their {@link ChunkLoadProperties}.
-         * This is used during the loading of the forest to track each chunk that is retrieved and decoded.
-         */
-        this.loadedChunksMap = new Map();
     }
     /**
      * Must be called when the forest is loaded to download the encoded contents of incremental chunks.