@fluidframework/tree 2.115.0 → 2.116.0

package/lib/core/tree/visitorUtils.js

@@ -13,10 +13,28 @@ export function applyDelta(delta, latestRevision, deltaProcessor, detachedFieldI
     visitDelta(delta, visitor, detachedFieldIndex, latestRevision);
     visitor.free();
 }
-export function announceDelta(delta, latestRevision, deltaProcessor, detachedFieldIndex) {
-    const visitor = deltaProcessor.acquireVisitor();
-    visitDelta(delta, combineVisitors([visitor]), detachedFieldIndex, latestRevision);
-    visitor.free();
+/**
+ * Wraps a visitor so any error breaks the supplied scope and all subsequent calls fail.
+ *
+ * @remarks
+ * The `{ readonly type?: never }` intersection restricts this helper to plain visitors. Wrapping
+ * an {@link AnnouncedVisitor} or {@link CombinedVisitor} as a plain visitor would hide its `type`
+ * discriminator and prevent {@link combineVisitors} from preserving announced-event ordering or
+ * flattening nested combined visitors.
+ */
+export function makeBreakingVisitor(visitor, breaker) {
+    return {
+        free: () => breaker.run(() => visitor.free()),
+        create: (...args) => breaker.run(() => visitor.create(...args)),
+        destroy: (...args) => breaker.run(() => visitor.destroy(...args)),
+        attach: (...args) => breaker.run(() => visitor.attach(...args)),
+        detach: (...args) => breaker.run(() => visitor.detach(...args)),
+        enterNode: (...args) => breaker.run(() => visitor.enterNode(...args)),
+        exitNode: (...args) => breaker.run(() => visitor.exitNode(...args)),
+        enterField: (...args) => breaker.run(() => visitor.enterField(...args)),
+        exitField: (...args) => breaker.run(() => visitor.exitField(...args)),
+        fieldMarks: (...args) => breaker.run(() => visitor.fieldMarks?.(...args)),
+    };
 }
 /**
  * Combines multiple visitors into a single visitor.

package/lib/core/tree/visitorUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"visitorUtils.js","sourceRoot":"","sources":["../../../src/core/tree/visitorUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAoB,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAM7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,EAAqB,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEhE,MAAM,UAAU,sBAAsB,CAAC,SAAiB,MAAM;IAC7D,OAAO,IAAI,kBAAkB,CAAC,MAAM,EAAE,oBAAoB,EAA+B,CAAC,CAAC;AAC5F,CAAC;AAED,MAAM,UAAU,UAAU,CACzB,KAAW,EACX,cAAuC,EACvC,cAAsD,EACtD,kBAAsC;IAEtC,MAAM,OAAO,GAAG,cAAc,CAAC,cAAc,EAAE,CAAC;IAChD,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC;IAC/D,OAAO,CAAC,IAAI,EAAE,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAC5B,KAAW,EACX,cAAuC,EACvC,cAAyE,EACzE,kBAAsC;IAEtC,MAAM,OAAO,GAAG,cAAc,CAAC,cAAc,EAAE,CAAC;IAChD,UAAU,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC;IAClF,OAAO,CAAC,IAAI,EAAE,CAAC;AAChB,CAAC;AAaD;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,QAAsC;IACrE,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxF,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,CAC3C,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CACpD,CAAC;IACF,OAAO;QACN,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,WAAW;QACrB,IAAI,EAAE,GAAG,EAAE;YACV,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;gBAC1B,CAAC,CAAC,IAAI,EAAE,CAAC;YACV,CAAC;QACF,CAAC;QACD,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YACnB,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;YACxB,CAAC;QACF,CAAC;QACD,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACpB,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1B,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;QACD,MAAM,EAAE,CAAC,MAAgB,EAAE,KAAa,EAAE,WAAuB,EAAE,EAAE;YACpE,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;YAC5C,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;YACtC,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE;oBACrB,KAAK,EAAE,WAAW;oBAClB,GAAG,EAAE,WAAW,GAAG,KAAK;iBACxB,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QACD,MAAM,EAAE,CACP,MAAa,EACb,WAAqB,EACrB,EAAkB,EAClB,UAAmB,EAClB,EAAE;YACH,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;YACjD,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;YAC/C,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;YACjF,CAAC;QACF,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACtB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;YACtB,CAAC;QACF,CAAC;QACD,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;YACrB,CAAC;QACF,CAAC;QACD,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACvB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;YACvB,CAAC;QACF,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACtB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;YACtB,CAAC;QACF,CAAC;QACD,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAwBD,MAAM,IAAI,GAAG,GAAS,EAAE,GAAE,CAAC,CAAC;AAE5B;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACrC,gBAA2C;IAE3C,OAAO;QACN,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,gBAAgB,CAAC,IAAI,IAAI,IAAI;QACnC,MAAM,EAAE,gBAAgB,CAAC,MAAM,IAAI,IAAI;QACvC,WAAW,EAAE,gBAAgB,CAAC,WAAW,IAAI,IAAI;QACjD,aAAa,EAAE,gBAAgB,CAAC,aAAa,IAAI,IAAI;QACrD,OAAO,EAAE,gBAAgB,CAAC,OAAO,IAAI,IAAI;QACzC,YAAY,EAAE,gBAAgB,CAAC,YAAY,IAAI,IAAI;QACnD,MAAM,EAAE,gBAAgB,CAAC,MAAM,IAAI,IAAI;QACvC,WAAW,EAAE,gBAAgB,CAAC,WAAW,IAAI,IAAI;QACjD,YAAY,EAAE,gBAAgB,CAAC,YAAY,IAAI,IAAI;QACnD,MAAM,EAAE,gBAAgB,CAAC,MAAM,IAAI,IAAI;QACvC,WAAW,EAAE,gBAAgB,CAAC,WAAW,IAAI,IAAI;QACjD,SAAS,EAAE,gBAAgB,CAAC,SAAS,IAAI,IAAI;QAC7C,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,IAAI,IAAI;QAC3C,UAAU,EAAE,gBAAgB,CAAC,UAAU,IAAI,IAAI;QAC/C,SAAS,EAAE,gBAAgB,CAAC,SAAS,IAAI,IAAI;KAC7C,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type IdAllocator, idAllocatorFromMaxId } from \"../../util/index.js\";\nimport type { RevisionTag } from \"../rebase/index.js\";\nimport type { FieldKey } from \"../schema-stored/index.js\";\n\nimport type { ITreeCursorSynchronous } from \"./cursor.js\";\nimport type { DetachedNodeId, Root } from \"./delta.js\";\nimport { DetachedFieldIndex } from \"./detachedFieldIndex.js\";\nimport type { ForestRootId } from \"./detachedFieldIndexTypes.js\";\nimport type { PlaceIndex, Range } from \"./pathTree.js\";\nimport { type DeltaVisitor, visitDelta } from \"./visitDelta.js\";\n\nexport function makeDetachedFieldIndex(prefix: string = \"Temp\"): DetachedFieldIndex {\n\treturn new DetachedFieldIndex(prefix, idAllocatorFromMaxId() as IdAllocator<ForestRootId>);\n}\n\nexport function applyDelta(\n\tdelta: Root,\n\tlatestRevision: RevisionTag | undefined,\n\tdeltaProcessor: { acquireVisitor: () => DeltaVisitor },\n\tdetachedFieldIndex: DetachedFieldIndex,\n): void {\n\tconst visitor = deltaProcessor.acquireVisitor();\n\tvisitDelta(delta, visitor, detachedFieldIndex, latestRevision);\n\tvisitor.free();\n}\n\nexport function announceDelta(\n\tdelta: Root,\n\tlatestRevision: RevisionTag | undefined,\n\tdeltaProcessor: { acquireVisitor: () => DeltaVisitor & AnnouncedVisitor },\n\tdetachedFieldIndex: DetachedFieldIndex,\n): void {\n\tconst visitor = deltaProcessor.acquireVisitor();\n\tvisitDelta(delta, combineVisitors([visitor]), detachedFieldIndex, latestRevision);\n\tvisitor.free();\n}\n\nexport interface CombinedVisitor extends DeltaVisitor {\n\treadonly type: \"Combined\";\n\n\treadonly visitors: readonly CombinableVisitor[];\n}\n\nexport type CombinableVisitor =\n\t| (DeltaVisitor & { type?: never })\n\t| AnnouncedVisitor\n\t| CombinedVisitor;\n\n/**\n * Combines multiple visitors into a single visitor.\n * @param visitors - The returned visitor invokes the corresponding events for all these visitors, in order.\n * @returns a DeltaVisitor combining all `visitors`.\n */\nexport function combineVisitors(visitors: readonly CombinableVisitor[]): CombinedVisitor {\n\tconst allVisitors = visitors.flatMap((v) => (v.type === \"Combined\" ? v.visitors : [v]));\n\tconst announcedVisitors = allVisitors.filter(\n\t\t(v): v is AnnouncedVisitor => v.type === \"Announced\",\n\t);\n\treturn {\n\t\ttype: \"Combined\",\n\t\tvisitors: allVisitors,\n\t\tfree: () => {\n\t\t\tfor (const v of visitors) {\n\t\t\t\tv.free();\n\t\t\t}\n\t\t},\n\t\tcreate: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.create(...args);\n\t\t\t}\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.afterCreate(...args);\n\t\t\t}\n\t\t},\n\t\tdestroy: (...args) => {\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.beforeDestroy(...args);\n\t\t\t}\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.destroy(...args);\n\t\t\t}\n\t\t},\n\t\tattach: (source: FieldKey, count: number, destination: PlaceIndex) => {\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.beforeAttach(source, count, destination);\n\t\t\t}\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.attach(source, count, destination);\n\t\t\t}\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.afterAttach(source, {\n\t\t\t\t\tstart: destination,\n\t\t\t\t\tend: destination + count,\n\t\t\t\t});\n\t\t\t}\n\t\t},\n\t\tdetach: (\n\t\t\tsource: Range,\n\t\t\tdestination: FieldKey,\n\t\t\tid: DetachedNodeId,\n\t\t\tisReplaced: boolean,\n\t\t) => {\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.beforeDetach(source, destination, isReplaced);\n\t\t\t}\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.detach(source, destination, id, isReplaced);\n\t\t\t}\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.afterDetach(source.start, source.end - source.start, destination, isReplaced);\n\t\t\t}\n\t\t},\n\t\tenterNode: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.enterNode(...args);\n\t\t\t}\n\t\t},\n\t\texitNode: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.exitNode(...args);\n\t\t\t}\n\t\t},\n\t\tenterField: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.enterField(...args);\n\t\t\t}\n\t\t},\n\t\texitField: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.exitField(...args);\n\t\t\t}\n\t\t},\n\t\tfieldMarks: (marks) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.fieldMarks?.(marks);\n\t\t\t}\n\t\t},\n\t};\n}\n\n/**\n * Visitor that is notified of changes before, after, and when changes are made.\n * Must be freed after use.\n */\nexport interface AnnouncedVisitor extends DeltaVisitor {\n\treadonly type: \"Announced\";\n\t/**\n\t * A hook that is called after all nodes have been created.\n\t */\n\tafterCreate(content: readonly ITreeCursorSynchronous[], destination: FieldKey): void;\n\tbeforeDestroy(field: FieldKey, count: number): void;\n\tbeforeAttach(source: FieldKey, count: number, destination: PlaceIndex): void;\n\tafterAttach(source: FieldKey, destination: Range): void;\n\tbeforeDetach(source: Range, destination: FieldKey, isReplaced: boolean): void;\n\tafterDetach(\n\t\tsource: PlaceIndex,\n\t\tcount: number,\n\t\tdestination: FieldKey,\n\t\tisReplaced: boolean,\n\t): void;\n}\n\nconst noOp = (): void => {};\n\n/**\n * Creates an announced visitor with only the provided functions and uses a no op for the rest.\n * This is provided to make some of the delta visitor definitions cleaner.\n */\nexport function createAnnouncedVisitor(\n\tvisitorFunctions: Partial<AnnouncedVisitor>,\n): AnnouncedVisitor {\n\treturn {\n\t\ttype: \"Announced\",\n\t\tfree: visitorFunctions.free ?? noOp,\n\t\tcreate: visitorFunctions.create ?? noOp,\n\t\tafterCreate: visitorFunctions.afterCreate ?? noOp,\n\t\tbeforeDestroy: visitorFunctions.beforeDestroy ?? noOp,\n\t\tdestroy: visitorFunctions.destroy ?? noOp,\n\t\tbeforeAttach: visitorFunctions.beforeAttach ?? noOp,\n\t\tattach: visitorFunctions.attach ?? noOp,\n\t\tafterAttach: visitorFunctions.afterAttach ?? noOp,\n\t\tbeforeDetach: visitorFunctions.beforeDetach ?? noOp,\n\t\tdetach: visitorFunctions.detach ?? noOp,\n\t\tafterDetach: visitorFunctions.afterDetach ?? noOp,\n\t\tenterNode: visitorFunctions.enterNode ?? noOp,\n\t\texitNode: visitorFunctions.exitNode ?? noOp,\n\t\tenterField: visitorFunctions.enterField ?? noOp,\n\t\texitField: visitorFunctions.exitField ?? noOp,\n\t};\n}\n"]}
+{"version":3,"file":"visitorUtils.js","sourceRoot":"","sources":["../../../src/core/tree/visitorUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAoC,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAM7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,EAAqB,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEhE,MAAM,UAAU,sBAAsB,CAAC,SAAiB,MAAM;IAC7D,OAAO,IAAI,kBAAkB,CAAC,MAAM,EAAE,oBAAoB,EAA+B,CAAC,CAAC;AAC5F,CAAC;AAED,MAAM,UAAU,UAAU,CACzB,KAAW,EACX,cAAuC,EACvC,cAAsD,EACtD,kBAAsC;IAEtC,MAAM,OAAO,GAAG,cAAc,CAAC,cAAc,EAAE,CAAC;IAChD,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC;IAC/D,OAAO,CAAC,IAAI,EAAE,CAAC;AAChB,CAAC;AAsBD;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CAClC,OAAiD,EACjD,OAAkB;IAElB,OAAO;QACN,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAC7C,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/D,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QACjE,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/D,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/D,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;QACrE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QACnE,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;QACvE,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;QACrE,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;KACzE,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,QAAsC;IACrE,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxF,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,CAC3C,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CACpD,CAAC;IACF,OAAO;QACN,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,WAAW;QACrB,IAAI,EAAE,GAAG,EAAE;YACV,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;gBAC1B,CAAC,CAAC,IAAI,EAAE,CAAC;YACV,CAAC;QACF,CAAC;QACD,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YACnB,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;YACxB,CAAC;QACF,CAAC;QACD,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACpB,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1B,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;QACD,MAAM,EAAE,CAAC,MAAgB,EAAE,KAAa,EAAE,WAAuB,EAAE,EAAE;YACpE,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;YAC5C,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;YACtC,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE;oBACrB,KAAK,EAAE,WAAW;oBAClB,GAAG,EAAE,WAAW,GAAG,KAAK;iBACxB,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QACD,MAAM,EAAE,CACP,MAAa,EACb,WAAqB,EACrB,EAAkB,EAClB,UAAmB,EAClB,EAAE;YACH,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;YACjD,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;YAC/C,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACnC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;YACjF,CAAC;QACF,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACtB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;YACtB,CAAC;QACF,CAAC;QACD,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;YACrB,CAAC;QACF,CAAC;QACD,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACvB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;YACvB,CAAC;QACF,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACtB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;YACtB,CAAC;QACF,CAAC;QACD,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;gBAC7B,CAAC,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAwBD,MAAM,IAAI,GAAG,GAAS,EAAE,GAAE,CAAC,CAAC;AAE5B;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACrC,gBAA2C;IAE3C,OAAO;QACN,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,gBAAgB,CAAC,IAAI,IAAI,IAAI;QACnC,MAAM,EAAE,gBAAgB,CAAC,MAAM,IAAI,IAAI;QACvC,WAAW,EAAE,gBAAgB,CAAC,WAAW,IAAI,IAAI;QACjD,aAAa,EAAE,gBAAgB,CAAC,aAAa,IAAI,IAAI;QACrD,OAAO,EAAE,gBAAgB,CAAC,OAAO,IAAI,IAAI;QACzC,YAAY,EAAE,gBAAgB,CAAC,YAAY,IAAI,IAAI;QACnD,MAAM,EAAE,gBAAgB,CAAC,MAAM,IAAI,IAAI;QACvC,WAAW,EAAE,gBAAgB,CAAC,WAAW,IAAI,IAAI;QACjD,YAAY,EAAE,gBAAgB,CAAC,YAAY,IAAI,IAAI;QACnD,MAAM,EAAE,gBAAgB,CAAC,MAAM,IAAI,IAAI;QACvC,WAAW,EAAE,gBAAgB,CAAC,WAAW,IAAI,IAAI;QACjD,SAAS,EAAE,gBAAgB,CAAC,SAAS,IAAI,IAAI;QAC7C,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,IAAI,IAAI;QAC3C,UAAU,EAAE,gBAAgB,CAAC,UAAU,IAAI,IAAI;QAC/C,SAAS,EAAE,gBAAgB,CAAC,SAAS,IAAI,IAAI;KAC7C,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type Breakable, type IdAllocator, idAllocatorFromMaxId } from \"../../util/index.js\";\nimport type { RevisionTag } from \"../rebase/index.js\";\nimport type { FieldKey } from \"../schema-stored/index.js\";\n\nimport type { ITreeCursorSynchronous } from \"./cursor.js\";\nimport type { DetachedNodeId, Root } from \"./delta.js\";\nimport { DetachedFieldIndex } from \"./detachedFieldIndex.js\";\nimport type { ForestRootId } from \"./detachedFieldIndexTypes.js\";\nimport type { PlaceIndex, Range } from \"./pathTree.js\";\nimport { type DeltaVisitor, visitDelta } from \"./visitDelta.js\";\n\nexport function makeDetachedFieldIndex(prefix: string = \"Temp\"): DetachedFieldIndex {\n\treturn new DetachedFieldIndex(prefix, idAllocatorFromMaxId() as IdAllocator<ForestRootId>);\n}\n\nexport function applyDelta(\n\tdelta: Root,\n\tlatestRevision: RevisionTag | undefined,\n\tdeltaProcessor: { acquireVisitor: () => DeltaVisitor },\n\tdetachedFieldIndex: DetachedFieldIndex,\n): void {\n\tconst visitor = deltaProcessor.acquireVisitor();\n\tvisitDelta(delta, visitor, detachedFieldIndex, latestRevision);\n\tvisitor.free();\n}\n\nexport interface CombinedVisitor extends DeltaVisitor {\n\treadonly type: \"Combined\";\n\n\treadonly visitors: readonly CombinableVisitor[];\n}\n\n/**\n * A visitor accepted by {@link combineVisitors}.\n *\n * @remarks\n * Plain {@link DeltaVisitor}s are intersected with `{ readonly type?: never }` so this forms a\n * discriminated union with {@link AnnouncedVisitor} and {@link CombinedVisitor}. The optional\n * `never` property permits visitors without a `type`, while preventing a visitor with an unknown\n * or widened `type` from being treated as plain and losing its specialized composition behavior.\n */\nexport type CombinableVisitor =\n\t| (DeltaVisitor & { type?: never })\n\t| AnnouncedVisitor\n\t| CombinedVisitor;\n\n/**\n * Wraps a visitor so any error breaks the supplied scope and all subsequent calls fail.\n *\n * @remarks\n * The `{ readonly type?: never }` intersection restricts this helper to plain visitors. Wrapping\n * an {@link AnnouncedVisitor} or {@link CombinedVisitor} as a plain visitor would hide its `type`\n * discriminator and prevent {@link combineVisitors} from preserving announced-event ordering or\n * flattening nested combined visitors.\n */\nexport function makeBreakingVisitor(\n\tvisitor: DeltaVisitor & { readonly type?: never },\n\tbreaker: Breakable,\n): DeltaVisitor & { readonly type?: never } {\n\treturn {\n\t\tfree: () => breaker.run(() => visitor.free()),\n\t\tcreate: (...args) => breaker.run(() => visitor.create(...args)),\n\t\tdestroy: (...args) => breaker.run(() => visitor.destroy(...args)),\n\t\tattach: (...args) => breaker.run(() => visitor.attach(...args)),\n\t\tdetach: (...args) => breaker.run(() => visitor.detach(...args)),\n\t\tenterNode: (...args) => breaker.run(() => visitor.enterNode(...args)),\n\t\texitNode: (...args) => breaker.run(() => visitor.exitNode(...args)),\n\t\tenterField: (...args) => breaker.run(() => visitor.enterField(...args)),\n\t\texitField: (...args) => breaker.run(() => visitor.exitField(...args)),\n\t\tfieldMarks: (...args) => breaker.run(() => visitor.fieldMarks?.(...args)),\n\t};\n}\n\n/**\n * Combines multiple visitors into a single visitor.\n * @param visitors - The returned visitor invokes the corresponding events for all these visitors, in order.\n * @returns a DeltaVisitor combining all `visitors`.\n */\nexport function combineVisitors(visitors: readonly CombinableVisitor[]): CombinedVisitor {\n\tconst allVisitors = visitors.flatMap((v) => (v.type === \"Combined\" ? v.visitors : [v]));\n\tconst announcedVisitors = allVisitors.filter(\n\t\t(v): v is AnnouncedVisitor => v.type === \"Announced\",\n\t);\n\treturn {\n\t\ttype: \"Combined\",\n\t\tvisitors: allVisitors,\n\t\tfree: () => {\n\t\t\tfor (const v of visitors) {\n\t\t\t\tv.free();\n\t\t\t}\n\t\t},\n\t\tcreate: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.create(...args);\n\t\t\t}\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.afterCreate(...args);\n\t\t\t}\n\t\t},\n\t\tdestroy: (...args) => {\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.beforeDestroy(...args);\n\t\t\t}\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.destroy(...args);\n\t\t\t}\n\t\t},\n\t\tattach: (source: FieldKey, count: number, destination: PlaceIndex) => {\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.beforeAttach(source, count, destination);\n\t\t\t}\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.attach(source, count, destination);\n\t\t\t}\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.afterAttach(source, {\n\t\t\t\t\tstart: destination,\n\t\t\t\t\tend: destination + count,\n\t\t\t\t});\n\t\t\t}\n\t\t},\n\t\tdetach: (\n\t\t\tsource: Range,\n\t\t\tdestination: FieldKey,\n\t\t\tid: DetachedNodeId,\n\t\t\tisReplaced: boolean,\n\t\t) => {\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.beforeDetach(source, destination, isReplaced);\n\t\t\t}\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.detach(source, destination, id, isReplaced);\n\t\t\t}\n\t\t\tfor (const v of announcedVisitors) {\n\t\t\t\tv.afterDetach(source.start, source.end - source.start, destination, isReplaced);\n\t\t\t}\n\t\t},\n\t\tenterNode: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.enterNode(...args);\n\t\t\t}\n\t\t},\n\t\texitNode: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.exitNode(...args);\n\t\t\t}\n\t\t},\n\t\tenterField: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.enterField(...args);\n\t\t\t}\n\t\t},\n\t\texitField: (...args) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.exitField(...args);\n\t\t\t}\n\t\t},\n\t\tfieldMarks: (marks) => {\n\t\t\tfor (const v of allVisitors) {\n\t\t\t\tv.fieldMarks?.(marks);\n\t\t\t}\n\t\t},\n\t};\n}\n\n/**\n * Visitor that is notified of changes before, after, and when changes are made.\n * Must be freed after use.\n */\nexport interface AnnouncedVisitor extends DeltaVisitor {\n\treadonly type: \"Announced\";\n\t/**\n\t * A hook that is called after all nodes have been created.\n\t */\n\tafterCreate(content: readonly ITreeCursorSynchronous[], destination: FieldKey): void;\n\tbeforeDestroy(field: FieldKey, count: number): void;\n\tbeforeAttach(source: FieldKey, count: number, destination: PlaceIndex): void;\n\tafterAttach(source: FieldKey, destination: Range): void;\n\tbeforeDetach(source: Range, destination: FieldKey, isReplaced: boolean): void;\n\tafterDetach(\n\t\tsource: PlaceIndex,\n\t\tcount: number,\n\t\tdestination: FieldKey,\n\t\tisReplaced: boolean,\n\t): void;\n}\n\nconst noOp = (): void => {};\n\n/**\n * Creates an announced visitor with only the provided functions and uses a no op for the rest.\n * This is provided to make some of the delta visitor definitions cleaner.\n */\nexport function createAnnouncedVisitor(\n\tvisitorFunctions: Partial<AnnouncedVisitor>,\n): AnnouncedVisitor {\n\treturn {\n\t\ttype: \"Announced\",\n\t\tfree: visitorFunctions.free ?? noOp,\n\t\tcreate: visitorFunctions.create ?? noOp,\n\t\tafterCreate: visitorFunctions.afterCreate ?? noOp,\n\t\tbeforeDestroy: visitorFunctions.beforeDestroy ?? noOp,\n\t\tdestroy: visitorFunctions.destroy ?? noOp,\n\t\tbeforeAttach: visitorFunctions.beforeAttach ?? noOp,\n\t\tattach: visitorFunctions.attach ?? noOp,\n\t\tafterAttach: visitorFunctions.afterAttach ?? noOp,\n\t\tbeforeDetach: visitorFunctions.beforeDetach ?? noOp,\n\t\tdetach: visitorFunctions.detach ?? noOp,\n\t\tafterDetach: visitorFunctions.afterDetach ?? noOp,\n\t\tenterNode: visitorFunctions.enterNode ?? noOp,\n\t\texitNode: visitorFunctions.exitNode ?? noOp,\n\t\tenterField: visitorFunctions.enterField ?? noOp,\n\t\texitField: visitorFunctions.exitField ?? noOp,\n\t};\n}\n"]}

package/lib/feature-libraries/chunked-forest/chunkedForest.d.ts

@@ -5,21 +5,45 @@
 import type { Listenable } from "@fluidframework/core-interfaces";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 import { type Anchor, AnchorSet, type AnnouncedVisitor, type DeltaVisitor, type DetachedField, type FieldAnchor, type FieldKey, type ForestEvents, type IEditableForest, type ITreeCursorSynchronous, type ITreeSubscriptionCursor, ITreeSubscriptionCursorState, TreeNavigationResult, type TreeStoredSchemaSubscription, type UpPath, type ChunkedCursor, type TreeChunk } from "../../core/index.js";
-import { type Breakable } from "../../util/index.js";
+import { Breakable, type WithBreakable } from "../../util/index.js";
 import { BasicChunk, BasicChunkCursor, type SiblingsOrKey } from "./basicChunk.js";
-import { type IChunker } from "./chunkTree.js";
+import { type ChunkCompressor, type IChunker } from "./chunkTree.js";
+/**
+ * Locates a top-level node within a field's chunk representation.
+ * @param chunks - The chunks representing the field.
+ * @param index - The node index within the field.
+ * @returns The containing chunk, its array index, and the node's offset within it.
+ */
+export declare function locateNodeInChunks(chunks: readonly TreeChunk[], index: number): {
+    chunk: TreeChunk;
+    indexOfChunk: number;
+    indexWithinChunk: number;
+};
+/**
+ * Ensures the node at index `index` within the field represented by `chunks` is contained in a non-shared {@link BasicChunk}.
+ *
+ * @param chunks - The chunks representing the field which will be modified to ensure the node at
+ * `index` is in a non-shared {@link BasicChunk}.
+ * @param index - The node index within the field.
+ * @returns The exclusively owned {@link BasicChunk} containing the node at `index`. This chunk is part of and owned by `chunks`.
+ * @remarks
+ * This function may modify the `chunks` array to ensure the node at `index` is in a non-shared {@link BasicChunk}.
+ * This can include splitting chunks, and cloning.
+ */
+export declare function ensureExclusiveBasicChunk(chunks: TreeChunk[], index: number, compressor: ChunkCompressor): BasicChunk;
 /**
  * Implementation of IEditableForest based on copy on write chunks.
  *
  * This implementation focuses on performance.
  */
-export declare class ChunkedForest implements IEditableForest {
+export declare class ChunkedForest implements IEditableForest, WithBreakable {
     #private;
     roots: BasicChunk;
     readonly schema: TreeStoredSchemaSubscription;
     readonly chunker: IChunker;
     readonly anchors: AnchorSet;
     readonly idCompressor?: IIdCompressor | undefined;
+    readonly breaker: Breakable;
     private activeVisitor?;
     private readonly deltaVisitors;
     readonly events: Listenable<ForestEvents>;
@@ -29,9 +53,9 @@ export declare class ChunkedForest implements IEditableForest {
      * @param chunker - Chunking policy. TODO: dispose of this when forest is disposed.
      * @param anchors - anchorSet used to track location in this forest across changes. Callers of applyDelta must ensure this is updated accordingly.
      */
-    constructor(roots: BasicChunk, schema: TreeStoredSchemaSubscription, chunker: IChunker, anchors?: AnchorSet, idCompressor?: IIdCompressor | undefined);
+    constructor(roots: BasicChunk, schema: TreeStoredSchemaSubscription, chunker: IChunker, anchors?: AnchorSet, idCompressor?: IIdCompressor | undefined, breaker?: Breakable);
     get isEmpty(): boolean;
-    clone(schema: TreeStoredSchemaSubscription, _breaker?: Breakable): ChunkedForest;
+    clone(schema: TreeStoredSchemaSubscription, breaker?: Breakable): ChunkedForest;
     chunkField(cursor: ITreeCursorSynchronous): TreeChunk[];
     forgetAnchor(anchor: Anchor): void;
     registerAnnouncedVisitor(visitor: () => AnnouncedVisitor): void;
@@ -59,6 +83,6 @@ declare class Cursor extends BasicChunkCursor implements ITreeSubscriptionCursor
 /**
  * Creates an implementation of {@link IEditableForest} with no data or schema.
  */
-export declare function buildChunkedForest(chunker: IChunker, anchors?: AnchorSet, idCompressor?: IIdCompressor): ChunkedForest;
+export declare function buildChunkedForest(chunker: IChunker, anchors?: AnchorSet, idCompressor?: IIdCompressor, breaker?: Breakable): ChunkedForest;
 export {};
 //# sourceMappingURL=chunkedForest.d.ts.map

package/lib/feature-libraries/chunked-forest/chunkedForest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chunkedForest.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/chunked-forest/chunkedForest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EACN,KAAK,MAAM,EACX,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,4BAA4B,EAG5B,oBAAoB,EACpB,KAAK,4BAA4B,EACjC,KAAK,MAAM,EAMX,KAAK,aAAa,EAClB,KAAK,SAAS,EAEd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAKN,KAAK,SAAS,EACd,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAEN,KAAK,QAAQ,EAKb,MAAM,gBAAgB,CAAC;AAWxB;;;;GAIG;AACH,qBAAa,aAAc,YAAW,eAAe;;IAc5C,KAAK,EAAE,UAAU;aACR,MAAM,EAAE,4BAA4B;aACpC,OAAO,EAAE,QAAQ;aACjB,OAAO,EAAE,SAAS;aAClB,YAAY,CAAC;IAjB9B,OAAO,CAAC,aAAa,CAAC,CAAe;IAErC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA0C;IAExE,SAAgB,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,CAAgB;IAEhE;;;;;OAKG;gBAEK,KAAK,EAAE,UAAU,EACR,MAAM,EAAE,4BAA4B,EACpC,OAAO,EAAE,QAAQ,EACjB,OAAO,GAAE,SAA2B,EACpC,YAAY,CAAC,2BAAe;IAG7C,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEM,KAAK,CAAC,MAAM,EAAE,4BAA4B,EAAE,QAAQ,CAAC,EAAE,SAAS,GAAG,aAAa;IAKhF,UAAU,CAAC,MAAM,EAAE,sBAAsB,GAAG,SAAS,EAAE;IAIvD,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIlC,wBAAwB,CAAC,OAAO,EAAE,MAAM,gBAAgB,GAAG,IAAI;IAI/D,0BAA0B,CAAC,OAAO,EAAE,MAAM,gBAAgB,GAAG,IAAI;IAIjE,cAAc,IAAI,YAAY;IAgMrC,OAAO,CAAC,2BAA2B,CAAK;IACjC,gBAAgB,IAAI,aAAa;IAUjC,cAAc,IAAI,MAAM;IAiBxB,mBAAmB,CACzB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,uBAAuB,GACnC,oBAAoB;IAShB,oBAAoB,CAC1B,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,uBAAuB,GACnC,oBAAoB;IAkBhB,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,uBAAuB,GAAG,IAAI;IAmClF,4BAA4B,IAAI,sBAAsB;CAK7D;AAED,cAAM,MAAO,SAAQ,gBAAiB,YAAW,uBAAuB;aAEtD,MAAM,EAAE,aAAa;IAC9B,KAAK,EAAE,4BAA4B;gBAD1B,MAAM,EAAE,aAAa,EAC9B,KAAK,EAAE,4BAA4B,EAC1C,IAAI,EAAE,SAAS,SAAS,EAAE,EAC1B,YAAY,EAAE,aAAa,EAAE,EAC7B,UAAU,EAAE,MAAM,EAAE,EACpB,iBAAiB,EAAE,MAAM,EAAE,EAC3B,qBAAqB,EAAE,MAAM,EAAE,EAC/B,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,YAAY,EAAE,aAAa,GAAG,SAAS;IAgBjC,qBAAqB,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI;IAajC,IAAI,IAAI,MAAM;IAmBvB,gBAAgB,IAAI,WAAW;IAO/B,IAAI,IAAI,IAAI;IAIZ,WAAW,IAAI,MAAM;IAIrB,KAAK,IAAI,IAAI;CAIpB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CACjC,OAAO,EAAE,QAAQ,EACjB,OAAO,CAAC,EAAE,SAAS,EACnB,YAAY,CAAC,EAAE,aAAa,GAC1B,aAAa,CAEf"}
+{"version":3,"file":"chunkedForest.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/chunked-forest/chunkedForest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EACN,KAAK,MAAM,EACX,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,4BAA4B,EAG5B,oBAAoB,EACpB,KAAK,4BAA4B,EACjC,KAAK,MAAM,EAOX,KAAK,aAAa,EAClB,KAAK,SAAS,EAEd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAMN,SAAS,EACT,KAAK,aAAa,EAClB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,QAAQ,EAKb,MAAM,gBAAgB,CAAC;AAWxB;;;;;GAKG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,SAAS,SAAS,EAAE,EAC5B,KAAK,EAAE,MAAM,GACX;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAA;CAAE,CAiBtE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CACxC,MAAM,EAAE,SAAS,EAAE,EACnB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,eAAe,GACzB,UAAU,CA6CZ;AAgBD;;;;GAIG;AACH,qBAAa,aAAc,YAAW,eAAe,EAAE,aAAa;;IAc3D,KAAK,EAAE,UAAU;aACR,MAAM,EAAE,4BAA4B;aACpC,OAAO,EAAE,QAAQ;aACjB,OAAO,EAAE,SAAS;aAClB,YAAY,CAAC;aACb,OAAO,EAAE,SAAS;IAlBnC,OAAO,CAAC,aAAa,CAAC,CAAe;IAErC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA0C;IAExE,SAAgB,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,CAAgB;IAEhE;;;;;OAKG;gBAEK,KAAK,EAAE,UAAU,EACR,MAAM,EAAE,4BAA4B,EACpC,OAAO,EAAE,QAAQ,EACjB,OAAO,GAAE,SAA2B,EACpC,YAAY,CAAC,2BAAe,EAC5B,OAAO,GAAE,SAA0C;IAGpE,IAAW,OAAO,IAAI,OAAO,CAG5B;IAEM,KAAK,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,SAAS,GAAG,aAAa;IAa/E,UAAU,CAAC,MAAM,EAAE,sBAAsB,GAAG,SAAS,EAAE;IAKvD,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIlC,wBAAwB,CAAC,OAAO,EAAE,MAAM,gBAAgB,GAAG,IAAI;IAI/D,0BAA0B,CAAC,OAAO,EAAE,MAAM,gBAAgB,GAAG,IAAI;IAIjE,cAAc,IAAI,YAAY;IAwNrC,OAAO,CAAC,2BAA2B,CAAK;IACjC,gBAAgB,IAAI,aAAa;IAUjC,cAAc,IAAI,MAAM;IAkBxB,mBAAmB,CACzB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,uBAAuB,GACnC,oBAAoB;IAUhB,oBAAoB,CAC1B,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,uBAAuB,GACnC,oBAAoB;IAmBhB,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,uBAAuB,GAAG,IAAI;IAoClF,4BAA4B,IAAI,sBAAsB;CAM7D;AAED,cAAM,MAAO,SAAQ,gBAAiB,YAAW,uBAAuB;aAEtD,MAAM,EAAE,aAAa;IAC9B,KAAK,EAAE,4BAA4B;gBAD1B,MAAM,EAAE,aAAa,EAC9B,KAAK,EAAE,4BAA4B,EAC1C,IAAI,EAAE,SAAS,SAAS,EAAE,EAC1B,YAAY,EAAE,aAAa,EAAE,EAC7B,UAAU,EAAE,MAAM,EAAE,EACpB,iBAAiB,EAAE,MAAM,EAAE,EAC3B,qBAAqB,EAAE,MAAM,EAAE,EAC/B,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,YAAY,EAAE,aAAa,GAAG,SAAS;IAgBjC,qBAAqB,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI;IAajC,IAAI,IAAI,MAAM;IAmBvB,gBAAgB,IAAI,WAAW;IAO/B,IAAI,IAAI,IAAI;IAIZ,WAAW,IAAI,MAAM;IAIrB,KAAK,IAAI,IAAI;CAIpB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CACjC,OAAO,EAAE,QAAQ,EACjB,OAAO,CAAC,EAAE,SAAS,EACnB,YAAY,CAAC,EAAE,aAAa,EAC5B,OAAO,CAAC,EAAE,SAAS,GACjB,aAAa,CASf"}

package/lib/feature-libraries/chunked-forest/chunkedForest.js

@@ -5,14 +5,92 @@
 var _ChunkedForest_events;
 import { __classPrivateFieldGet } from "tslib";
 import { createEmitter } from "@fluid-internal/client-utils";
-import { assert, oob, fail } from "@fluidframework/core-utils/internal";
-import { AnchorSet, ITreeSubscriptionCursorState, aboveRootPlaceholder, combineVisitors, detachedFieldAsKey, mapCursorField, rootFieldKey, } from "../../core/index.js";
-import { brand, getLast, getOrAddEmptyToMap, hasSome, } from "../../util/index.js";
+import { assert, oob, fail, debugAssert } from "@fluidframework/core-utils/internal";
+import { AnchorSet, ITreeSubscriptionCursorState, aboveRootPlaceholder, combineVisitors, detachedFieldAsKey, makeBreakingVisitor, mapCursorField, rootFieldKey, } from "../../core/index.js";
+import { assertNonNegativeSafeInteger, brand, getLast, getOrAddEmptyToMap, hasSome, Breakable, } from "../../util/index.js";
 import { BasicChunk, BasicChunkCursor } from "./basicChunk.js";
 import { basicChunkTree, chunkField, chunkTree, splitFieldAtIndex, } from "./chunkTree.js";
 function makeRoot() {
     return new BasicChunk(aboveRootPlaceholder, new Map());
 }
+/** Returns the number of top-level nodes represented by a field's chunks. */
+function getFieldLength(field) {
+    return field.reduce((length, chunk) => length + chunk.topLevelLength, 0);
+}
+/**
+ * Locates a top-level node within a field's chunk representation.
+ * @param chunks - The chunks representing the field.
+ * @param index - The node index within the field.
+ * @returns The containing chunk, its array index, and the node's offset within it.
+ */
+export function locateNodeInChunks(chunks, index) {
+    assertNonNegativeSafeInteger(index);
+    // Remaining node offset while scanning chunks; afterward, the offset within the matched chunk.
+    let indexWithinChunk = index;
+    // Array index of the chunk currently being examined.
+    let indexOfChunk = 0;
+    while (true) {
+        const chunk = chunks[indexOfChunk] ?? oob();
+        if (indexWithinChunk < chunk.topLevelLength) {
+            return { chunk, indexOfChunk, indexWithinChunk };
+        }
+        indexWithinChunk -= chunk.topLevelLength;
+        indexOfChunk++;
+        if (indexOfChunk === chunks.length) {
+            fail(0xaf7 /* missing edited node */);
+        }
+    }
+}
+/**
+ * Ensures the node at index `index` within the field represented by `chunks` is contained in a non-shared {@link BasicChunk}.
+ *
+ * @param chunks - The chunks representing the field which will be modified to ensure the node at
+ * `index` is in a non-shared {@link BasicChunk}.
+ * @param index - The node index within the field.
+ * @returns The exclusively owned {@link BasicChunk} containing the node at `index`. This chunk is part of and owned by `chunks`.
+ * @remarks
+ * This function may modify the `chunks` array to ensure the node at `index` is in a non-shared {@link BasicChunk}.
+ * This can include splitting chunks, and cloning.
+ */
+export function ensureExclusiveBasicChunk(chunks, index, compressor) {
+    const { chunk, indexOfChunk, indexWithinChunk } = locateNodeInChunks(chunks, index);
+    // Normalize to a BasicChunk, splitting the chunk if needed.
+    let finalIndexOfChunk;
+    let basicChunk;
+    if (chunk instanceof BasicChunk) {
+        basicChunk = chunk;
+        finalIndexOfChunk = indexOfChunk;
+    }
+    else {
+        // TODO:Perf: support in place editing of other chunk formats when possible:
+        // 1. Support updating values in uniform chunks.
+        // 2. Support traversing sequence chunks.
+        //
+        // Maybe build path when visitor navigates then lazily sync to chunk tree when editing?
+        const newChunks = mapCursorField(chunk.cursor(), (cursor) => basicChunkTree(cursor, compressor));
+        // TODO: this could fail for really long chunks being split (due to argument count limits).
+        // Current implementations of chunks shouldn't ever be that long, but it could be an issue if they get bigger.
+        chunks.splice(indexOfChunk, 1, ...newChunks);
+        // We just overwrote the reference to the old chunk in the array, so drop the ref count for it.
+        chunk.referenceRemoved();
+        // Sanity check that the chunk indexing is as expected before updating it.
+        debugAssert(() => newChunks[indexWithinChunk] === chunks[indexOfChunk + indexWithinChunk] ||
+            "bad chunk indexing");
+        basicChunk = newChunks[indexWithinChunk] ?? oob();
+        finalIndexOfChunk = indexOfChunk + indexWithinChunk;
+    }
+    debugAssert(() => chunks[finalIndexOfChunk] === basicChunk || "bad child index");
+    // Ensure the BasicChunk we have is exclusively owned, so we can edit it in place.
+    let exclusiveChunk;
+    if (basicChunk.isShared()) {
+        exclusiveChunk = chunks[finalIndexOfChunk] = basicChunk.clone();
+        basicChunk.referenceRemoved();
+    }
+    else {
+        exclusiveChunk = basicChunk;
+    }
+    return exclusiveChunk;
+}
 /**
  * Implementation of IEditableForest based on copy on write chunks.
  *
@@ -25,25 +103,29 @@ export class ChunkedForest {
      * @param chunker - Chunking policy. TODO: dispose of this when forest is disposed.
      * @param anchors - anchorSet used to track location in this forest across changes. Callers of applyDelta must ensure this is updated accordingly.
      */
-    constructor(roots, schema, chunker, anchors = new AnchorSet(), idCompressor) {
+    constructor(roots, schema, chunker, anchors = new AnchorSet(), idCompressor, breaker = new Breakable("ChunkedForest")) {
         this.roots = roots;
         this.schema = schema;
         this.chunker = chunker;
         this.anchors = anchors;
         this.idCompressor = idCompressor;
+        this.breaker = breaker;
         this.deltaVisitors = new Set();
         _ChunkedForest_events.set(this, createEmitter());
         this.events = __classPrivateFieldGet(this, _ChunkedForest_events, "f");
         this.nextDetachedFieldIdentifier = 0;
     }
     get isEmpty() {
+        this.breaker.use();
         return this.roots.fields.size === 0;
     }
-    clone(schema, _breaker) {
+    clone(schema, breaker) {
+        this.breaker.use();
         this.roots.referenceAdded();
-        return new ChunkedForest(this.roots, schema, this.chunker.clone(schema));
+        return new ChunkedForest(this.roots, schema, this.chunker.clone(schema), undefined, this.idCompressor, breaker ?? this.breaker);
     }
     chunkField(cursor) {
+        this.breaker.use();
         return chunkField(cursor, { idCompressor: this.idCompressor, policy: this.chunker });
     }
     forgetAnchor(anchor) {
@@ -56,15 +138,29 @@ export class ChunkedForest {
         this.deltaVisitors.delete(visitor);
     }
     acquireVisitor() {
+        this.breaker.use();
         assert(this.activeVisitor === undefined, 0x76a /* Must release existing visitor before acquiring another */);
         if (this.roots.isShared()) {
             this.roots = this.roots.clone();
         }
+        // The `CombinableVisitor` which can apply deltas to this forest.
+        // Annoyingly declaring the type here or in a satisfies clause causes this code not to build,
+        // so the type is inferred.
+        //
+        // This visitor works by shallow copying (where needed) the forest as it's walked down
+        // to ensure the location being traversed (and thus possibly edited) is an exclusively owned BasicChunk.
+        // Future optimizations may improve this, but currently that is a requirement for the editing code to work.
         const forestVisitor = {
             forest: this,
-            // Current location in the tree, as a non-shared BasicChunk (TODO: support in-place modification of other chunk formats when possible).
-            // Start above root detached sequences.
+            /**
+             * Current location in the tree, as a non-shared BasicChunk (TODO: support in-place modification of other chunk formats when possible).
+             * Starts above root detached sequences.
+             */
             mutableChunkStack: [],
+            /**
+             * When at a node level, this is set to the basic chunk for the current node.
+             * When at a field level, undefined, see mutableChunkStack for the field.
+             */
             mutableChunk: this.roots,
             getParent() {
                 assert(hasSome(this.mutableChunkStack), 0x532 /* invalid access to root's parent */);
@@ -78,10 +174,17 @@ export class ChunkedForest {
             },
             destroy(detachedField, count) {
                 __classPrivateFieldGet(this.forest, _ChunkedForest_events, "f").emit("beforeChange");
+                const field = this.forest.roots.fields.get(detachedField);
+                assert(field !== undefined, 0xd1d /* Destroyed field must exist */);
+                assert(getFieldLength(field) === count, 0xd1e /* Destroy count must match field length */);
                 this.forest.roots.fields.delete(detachedField);
+                for (const chunk of field) {
+                    chunk.referenceRemoved();
+                }
             },
             create(content, destination) {
                 __classPrivateFieldGet(this.forest, _ChunkedForest_events, "f").emit("beforeChange");
+                assert(!this.forest.roots.fields.has(destination), 0xd1f /* Create destination must be a new empty field */);
                 const chunks = content.map((c) => chunkTree(c, {
                     policy: this.forest.chunker,
                     idCompressor: this.forest.idCompressor,
@@ -103,17 +206,18 @@ export class ChunkedForest {
              */
             attachEdit(source, count, destination) {
                 __classPrivateFieldGet(this.forest, _ChunkedForest_events, "f").emit("beforeChange");
-                const sourceField = this.forest.roots.fields.get(source) ?? [];
-                this.forest.roots.fields.delete(source);
-                if (sourceField.length === 0) {
-                    return; // Prevent creating 0 sized fields when inserting empty into empty.
-                }
                 const parent = this.getParent();
+                assert(parent.mutableChunk !== this.forest.roots || parent.key !== source, 0xd20 /* Attach source field must be different from current field */);
+                const sourceField = this.forest.roots.fields.get(source);
+                assert(sourceField !== undefined, 0xd21 /* Attach source field must exist */);
+                assert(getFieldLength(sourceField) === count, 0xd22 /* Attach must consume all nodes in source field */);
                 const destinationField = getOrAddEmptyToMap(parent.mutableChunk.fields, parent.key);
+                assert(destination <= getFieldLength(destinationField), 0xd23 /* Attach destination must not exceed field length */);
                 const destinationChunkIndex = splitFieldAtIndex(destinationField, destination, {
                     policy: this.forest.chunker,
                     idCompressor: this.forest.idCompressor,
                 });
+                this.forest.roots.fields.delete(source);
                 // TODO: this will fail for very large moves due to argument limits.
                 destinationField.splice(destinationChunkIndex, 0, ...sourceField);
             },
@@ -133,7 +237,12 @@ export class ChunkedForest {
                 __classPrivateFieldGet(this.forest, _ChunkedForest_events, "f").emit("beforeChange");
                 const parent = this.getParent();
                 const sourceField = parent.mutableChunk.fields.get(parent.key) ?? [];
-                assert(source.start <= source.end, 0xcf8 /* detach range start must not exceed end */);
+                assert(source.start <= source.end, 0xd24 /* Detach range start must not exceed end */);
+                assert(source.end <= getFieldLength(sourceField), 0xd25 /* Detach range must not exceed field length */);
+                if (destination !== undefined) {
+                    assert(parent.mutableChunk !== this.forest.roots || parent.key !== destination, 0xd26 /* Detach destination field must be different from current field */);
+                    assert(!this.forest.roots.fields.has(destination), 0xd27 /* Detach destination must be a new empty field */);
+                }
                 const policy = {
                     policy: this.forest.chunker,
                     idCompressor: this.forest.idCompressor,
@@ -151,7 +260,6 @@ export class ChunkedForest {
                     }
                 }
                 else {
-                    assert(!this.forest.roots.fields.has(destination), 0x7af /* Destination must be a new empty detached field */);
                     if (newField.length > 0) {
                         this.forest.roots.fields.set(destination, newField);
                     }
@@ -162,46 +270,20 @@ export class ChunkedForest {
                     parent.mutableChunk.fields.delete(parent.key);
                 }
             },
+            /**
+             * Ensure the selected node (by `index`) is an exclusively owned basic node,
+             * and store it under `this.mutableChunk`.
+             */
             enterNode(index) {
                 assert(this.mutableChunk === undefined, 0x535 /* should be in field */);
+                // Get the mutable parent, which we might have to modify to ensure the desired child is an exclusively owned (and thus mutable) BasicChunk.
                 const parent = this.getParent();
+                // Lookup the current location of the node to be entered
                 const chunks = parent.mutableChunk.fields.get(parent.key) ?? fail(0xaf6 /* missing edited field */);
-                let indexWithinChunk = index;
-                let indexOfChunk = 0;
-                let chunk = chunks[indexOfChunk] ?? oob();
-                while (indexWithinChunk >= chunk.topLevelLength) {
-                    indexWithinChunk -= chunk.topLevelLength;
-                    indexOfChunk++;
-                    if (indexOfChunk === chunks.length) {
-                        fail(0xaf7 /* missing edited node */);
-                    }
-                    chunk = chunks[indexOfChunk] ?? oob();
-                }
-                let found = chunks[indexOfChunk] ?? oob();
-                if (!(found instanceof BasicChunk)) {
-                    // TODO:Perf: support in place editing of other chunk formats when possible:
-                    // 1. Support updating values in uniform chunks.
-                    // 2. Support traversing sequence chunks.
-                    //
-                    // Maybe build path when visitor navigates then lazily sync to chunk tree when editing?
-                    const newChunks = mapCursorField(found.cursor(), (cursor) => basicChunkTree(cursor, {
-                        policy: this.forest.chunker,
-                        idCompressor: this.forest.idCompressor,
-                    }));
-                    // TODO: this could fail for really long chunks being split (due to argument count limits).
-                    // Current implementations of chunks shouldn't ever be that long, but it could be an issue if they get bigger.
-                    chunks.splice(indexOfChunk, 1, ...newChunks);
-                    found.referenceRemoved();
-                    found = newChunks[indexWithinChunk] ?? oob();
-                }
-                assert(found instanceof BasicChunk, 0x536 /* chunk should have been normalized */);
-                if (found.isShared()) {
-                    this.mutableChunk = chunks[indexOfChunk] = found.clone();
-                    found.referenceRemoved();
-                }
-                else {
-                    this.mutableChunk = found;
-                }
+                this.mutableChunk = ensureExclusiveBasicChunk(chunks, index, {
+                    policy: this.forest.chunker,
+                    idCompressor: this.forest.idCompressor,
+                });
             },
             exitNode(index) {
                 assert(this.mutableChunk !== undefined, 0x537 /* should be in node */);
@@ -222,9 +304,12 @@ export class ChunkedForest {
         for (const getVisitor of this.deltaVisitors) {
             announcedVisitors.push(getVisitor());
         }
-        const combinedVisitor = combineVisitors([forestVisitor, ...announcedVisitors]);
-        this.activeVisitor = combinedVisitor;
-        return combinedVisitor;
+        const visitor = combineVisitors([
+            makeBreakingVisitor(forestVisitor, this.breaker),
+            ...announcedVisitors,
+        ]);
+        this.activeVisitor = visitor;
+        return visitor;
     }
     newDetachedField() {
         const field = brand(String(this.nextDetachedFieldIdentifier));
@@ -233,9 +318,11 @@ export class ChunkedForest {
         return field;
     }
     allocateCursor() {
+        this.breaker.use();
         return new Cursor(this, ITreeSubscriptionCursorState.Cleared, [], [], [], [], [], [], 0, 0, 0, undefined);
     }
     tryMoveCursorToNode(destination, cursorToMove) {
+        this.breaker.use();
         const path = this.anchors.locate(destination);
         if (path === undefined) {
             return -1 /* TreeNavigationResult.NotFound */;
@@ -244,6 +331,7 @@ export class ChunkedForest {
         return 1 /* TreeNavigationResult.Ok */;
     }
     tryMoveCursorToField(destination, cursorToMove) {
+        this.breaker.use();
         assert(cursorToMove instanceof Cursor, 0x53b /* ChunkedForest must only be given its own Cursor type */);
         if (destination.parent === undefined) {
             cursorToMove.setToDetachedSequence(destination.fieldKey);
@@ -257,6 +345,7 @@ export class ChunkedForest {
         return 1 /* TreeNavigationResult.Ok */;
     }
     moveCursorToPath(destination, cursorToMove) {
+        this.breaker.use();
         assert(cursorToMove instanceof Cursor, 0x53c /* ChunkedForest must only be given its own Cursor type */);
         assert(cursorToMove.forest === this, 0x53d /* ChunkedForest must only be given its own Cursor */);
         const indexStack = [];
@@ -283,6 +372,7 @@ export class ChunkedForest {
         }
     }
     getCursorAboveDetachedFields() {
+        this.breaker.use();
         const rootCursor = this.roots.cursor();
         rootCursor.enterNode(0);
         return rootCursor;
@@ -331,7 +421,7 @@ class Cursor extends BasicChunkCursor {
 /**
  * Creates an implementation of {@link IEditableForest} with no data or schema.
  */
-export function buildChunkedForest(chunker, anchors, idCompressor) {
-    return new ChunkedForest(makeRoot(), chunker.schema, chunker, anchors, idCompressor);
+export function buildChunkedForest(chunker, anchors, idCompressor, breaker) {
+    return new ChunkedForest(makeRoot(), chunker.schema, chunker, anchors, idCompressor, breaker);
 }
 //# sourceMappingURL=chunkedForest.js.map