@fluidframework/tree 2.90.0-378676 → 2.91.0

package/dist/shared-tree/treeCheckout.js

@@ -30,7 +30,34 @@ const index_js_6 = require("../util/index.js");
 const schematizingTreeView_js_1 = require("./schematizingTreeView.js");
 const sharedTreeChangeEnricher_js_1 = require("./sharedTreeChangeEnricher.js");
 const sharedTreeChangeFamily_js_1 = require("./sharedTreeChangeFamily.js");
-const sharedTreeEditBuilder_js_1 = require("./sharedTreeEditBuilder.js");
+/**
+ * Yields all defined (non-`undefined`) labels from a {@link LabelTree}, depth-first.
+ */
+function* collectTreeLabels(node) {
+    if (node.label !== undefined) {
+        yield node.label;
+    }
+    for (const child of node.sublabels) {
+        yield* collectTreeLabels(child);
+    }
+}
+/**
+ * Builds the labels set for a change event from the label tree.
+ * If the tree exists and contains at least one defined label, returns a set of all
+ * values with the tree attached. Otherwise returns an empty set.
+ */
+function buildLabelsSet(labelTreeNode) {
+    const set = new Set();
+    if (labelTreeNode !== undefined) {
+        for (const value of collectTreeLabels(labelTreeNode)) {
+            set.add(value);
+        }
+        if (set.size > 0) {
+            set.tree = labelTreeNode;
+        }
+    }
+    return set;
+}
 /**
  * Creates a {@link TreeCheckout}.
  * @param args - an object containing optional components that will be used to build the view.
@@ -38,7 +65,7 @@ const sharedTreeEditBuilder_js_1 = require("./sharedTreeEditBuilder.js");
  * @remarks This does not create a {@link SharedTree}, but rather a view with the minimal state
  * and functionality required to implement {@link ITreeCheckout}.
  */
-function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, editorOptions, args) {
+function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, args) {
     const breaker = args?.breaker ?? new index_js_6.Breakable("TreeCheckout");
     const schema = args?.schema ?? new index_js_2.TreeStoredSchemaRepository();
     const forest = args?.forest ?? (0, index_js_3.buildForest)(breaker, schema);
@@ -48,7 +75,7 @@ function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, edi
     };
     const codecOptions = { ...defaultCodecOptions, ...args?.codecOptions };
     const changeFamily = args?.changeFamily ??
-        new sharedTreeChangeFamily_js_1.SharedTreeChangeFamily(revisionTagCodec, args?.fieldBatchCodec ?? (0, index_js_3.makeFieldBatchCodec)(codecOptions), codecOptions, args?.chunkCompressionStrategy, idCompressor);
+        new sharedTreeChangeFamily_js_1.SharedTreeChangeFamily(revisionTagCodec, args?.fieldBatchCodec ?? index_js_3.fieldBatchCodecBuilder.build(codecOptions), codecOptions, args?.chunkCompressionStrategy, idCompressor);
     // TODO: If a branch is passed in, is it supposed to be local main?
     // Otherwise shouldn't we set `isSharedBranch` to false?
     const branch = args?.branch ??
@@ -56,7 +83,7 @@ function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, edi
             change: changeFamily.rebaser.compose([]),
             revision: "root",
         }, changeFamily, () => idCompressor.generateCompressedId());
-    return new TreeCheckout(branch, true, changeFamily, schema, forest, mintRevisionTag, revisionTagCodec, idCompressor, editorOptions, args?.removedRoots, args?.logger, breaker, args?.disposeForksAfterTransaction);
+    return new TreeCheckout(branch, true, changeFamily, schema, forest, mintRevisionTag, revisionTagCodec, idCompressor, args?.removedRoots, args?.logger, breaker, args?.disposeForksAfterTransaction);
 }
 exports.createTreeCheckout = createTreeCheckout;
 /**
@@ -65,7 +92,7 @@ exports.createTreeCheckout = createTreeCheckout;
 class TreeCheckout {
     constructor(branch, 
     /** True if and only if this checkout is for a branch which is persisted and shared with other clients. */
-    isSharedBranch, changeFamily, storedSchema, forest, mintRevisionTag, revisionTagCodec, idCompressor, editorOptions, _removedRoots = (0, index_js_2.makeDetachedFieldIndex)("repair", revisionTagCodec, idCompressor), 
+    isSharedBranch, changeFamily, storedSchema, forest, mintRevisionTag, revisionTagCodec, idCompressor, _removedRoots = (0, index_js_2.makeDetachedFieldIndex)("repair", revisionTagCodec, idCompressor), 
     /** Optional logger for telemetry. */
     logger, breaker = new index_js_6.Breakable("TreeCheckout"), disposeForksAfterTransaction = true) {
         this.isSharedBranch = isSharedBranch;
@@ -75,7 +102,6 @@ class TreeCheckout {
         this.mintRevisionTag = mintRevisionTag;
         this.revisionTagCodec = revisionTagCodec;
         this.idCompressor = idCompressor;
-        this.editorOptions = editorOptions;
         this._removedRoots = _removedRoots;
         this.logger = logger;
         this.breaker = breaker;
@@ -137,7 +163,8 @@ class TreeCheckout {
                             };
                         },
                         getRevertible: (onDisposed) => getRevertible?.(onDisposed),
-                        label: this.transactionLabel,
+                        label: this.labelTreeNode?.label,
+                        labels: buildLabelsSet(this.labelTreeNode),
                     };
                     __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("changed", metadata, getRevertible);
                     withinEventContext = false;
@@ -148,6 +175,7 @@ class TreeCheckout {
                 __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("changed", {
                     isLocal: false,
                     kind: index_js_2.CommitKind.Default,
+                    labels: new Set(),
                 });
             }
         };
@@ -207,36 +235,83 @@ class TreeCheckout {
         this.enrichmentStats = { batches: 0, diffs: 0, commitsEnriched: 0, refreshers: 0, forks: 0, applied: 0 };
         __classPrivateFieldSet(this, _TreeCheckout_transaction, this.createTransactionStack(branch), "f");
         this.editLock = new EditLock(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEditor);
-        this.locator = {
-            locationFromId: (id) => {
-                const rootId = this.removedRoots.getEntry((0, index_js_3.nodeIdFromChangeAtom)(id));
-                return this.removedRoots.toFieldKey(rootId);
-            },
-            idFromLocation: (location) => {
-                const nodeId = this.removedRoots.fromFieldKey(location);
-                return (0, index_js_3.changeAtomFromDetachedNodeId)(nodeId);
-            },
-            locationsFromIdRanges: (ids) => {
-                return ids.flatMap((id) => {
-                    return (0, index_js_6.makeArray)(id.count, (offset) => {
-                        const field = this.locator.locationFromId((0, index_js_2.offsetChangeAtomId)(id.first, offset));
-                        return { field, count: 1 };
-                    });
-                });
-            },
-            idRangesFromLocations: (ids) => {
-                return ids.map((id) => {
-                    (0, internal_1.assert)(id.count === 1, "Expected count of 1");
-                    const first = this.locator.idFromLocation(id.field);
-                    return { first, count: id.count };
-                });
-            },
-            isAttachable: (id) => {
-                return this.removedRoots.isAttachable((0, index_js_3.nodeIdFromChangeAtom)(id));
-            },
-        };
         this.registerForBranchEvents();
     }
+    /**
+     * Pushes a new label node for a transaction nesting level.
+     *
+     * @param label - The label for this transaction level.
+     *
+     * @remarks
+     * Called at the start of each transaction (including nested ones).
+     * Creates a new {@link LabelTree} node as a child of the current deepest node (if any),
+     * or as the root if this is the outermost transaction.
+     */
+    pushLabelFrame(label) {
+        const node = { label, sublabels: [] };
+        if (this.labelTreeNode === undefined) {
+            this.labelTreeNode = node;
+        }
+        else {
+            const current = this.currentLabelNode();
+            (0, internal_1.assert)(current !== undefined, 0xcdb /* Expected current label node to exist */);
+            current.sublabels.push(node);
+        }
+    }
+    /**
+     * Returns the deepest open node on the right side of the label tree, which corresponds
+     * to the current (most recently pushed, not yet committed or aborted) transaction.
+     * Returns `undefined` when {@link TreeCheckout.labelTreeNode} is not set.
+     */
+    currentLabelNode() {
+        if (this.labelTreeNode === undefined) {
+            return undefined;
+        }
+        // Walk down the right spine of the tree. Only one closed node is ever reachable
+        // during this traversal, so a single pointer (mostRecentlyClosedLabelNode) suffices
+        // to stop descending past committed nodes.
+        let node = this.labelTreeNode;
+        while (node.sublabels.length > 0) {
+            const lastChild = node.sublabels[node.sublabels.length - 1];
+            (0, internal_1.assert)(lastChild !== undefined, 0xcdc /* Expected label tree node to have children */);
+            if (lastChild === this.mostRecentlyClosedLabelNode) {
+                break;
+            }
+            node = lastChild;
+        }
+        return node;
+    }
+    /**
+     * Pops the current label frame from the label tree.
+     * @param aborted - If true, the node is removed from the tree (transaction was aborted).
+     * If false, the node is kept in the tree but marked as closed (transaction was committed).
+     */
+    popLabelFrame(aborted) {
+        const node = this.currentLabelNode();
+        if (node === undefined) {
+            return;
+        }
+        if (aborted) {
+            if (node === this.labelTreeNode) {
+                this.labelTreeNode = undefined;
+                this.mostRecentlyClosedLabelNode = undefined;
+            }
+            else {
+                // Temporarily mark node as closed so currentLabelNode() returns its parent.
+                this.mostRecentlyClosedLabelNode = node;
+                const parent = this.currentLabelNode();
+                (0, internal_1.assert)(parent !== undefined, 0xcdd /* Expected parent label node to exist */);
+                parent.sublabels.pop();
+                // Point to the parent's new last child (guaranteed closed if it exists),
+                // or undefined if the parent has no more children.
+                const newLastChild = parent.sublabels[parent.sublabels.length - 1];
+                this.mostRecentlyClosedLabelNode = newLastChild;
+            }
+        }
+        else {
+            this.mostRecentlyClosedLabelNode = node;
+        }
+    }
     /**
      * Helper method for {@link SchematizingSimpleTreeView.runTransaction} to properly clear transaction labels once the function completes.
      *
@@ -250,16 +325,17 @@ class TreeCheckout {
      * @returns The result of executing `fn`.
      */
     runWithTransactionLabel(fn, label) {
-        // If a transaction label is already set, nesting is occurring, so we should not override it.
-        if (this.transactionLabel !== undefined) {
-            return fn(this.transactionLabel);
-        }
-        this.transactionLabel = label;
         try {
-            return fn(this.transactionLabel);
+            return fn(label);
         }
         finally {
-            this.transactionLabel = undefined;
+            // Only clear the label tree when the outermost transaction has completed.
+            // Inner transactions' commits don't fire the "changed" event, so the label tree
+            // must remain intact until the outermost commit reads it.
+            if (this.transaction.size === 0) {
+                this.labelTreeNode = undefined;
+                this.mostRecentlyClosedLabelNode = undefined;
+            }
         }
     }
     get removedRoots() {
@@ -296,7 +372,7 @@ class TreeCheckout {
                         if (viewUpdate !== undefined) {
                             this.applyChange(viewUpdate, newHead.revision);
                         }
-                        if (!this.transaction.isInProgress()) {
+                        if (this.transaction.size === 0) {
                             // The changes in a transaction squash commit have already applied to the checkout and are known to be valid, so we can validate the squash commit automatically.
                             this.validateCommit(newHead);
                         }
@@ -347,7 +423,8 @@ class TreeCheckout {
             revision,
         };
         const decodedChange = this.changeFamily.codecs.resolve(4).decode(change, context);
-        this.applyChange(decodedChange, revision);
+        // Apply the change to the branch, but _not_ the `activeBranch` - we do not support squashing serialized commits in a transaction.
+        __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.apply((0, index_js_2.tagChange)(decodedChange, revision));
     }
     // Revision is the revision of the commit, if any, which caused this change.
     applyChange(change, revision) {
@@ -466,7 +543,7 @@ class TreeCheckout {
     }
     get editor() {
         this.checkNotDisposed();
-        return new sharedTreeEditBuilder_js_1.LocationBasedSharedTreeEditBuilder(this.editLock.editor, this.locator, this.editorOptions);
+        return this.editLock.editor;
     }
     locate(anchor) {
         this.checkNotDisposed();
@@ -477,22 +554,22 @@ class TreeCheckout {
     }
     branch() {
         this.checkNotDisposed("The parent branch has already been disposed and can no longer create new branches.");
-        this.editLock.checkUnlocked("Branching");
         // Branching after an unfinished transaction would expose the application to a state where its invariants may be violated.
-        if (this.transaction.isInProgress()) {
+        if (this.transaction.size > 0) {
             throw new internal_3.UsageError("A view cannot be forked while it has a pending transaction.");
         }
+        this.editLock.checkUnlocked("Branching");
         const anchors = new index_js_2.AnchorSet();
         const branch = __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.fork();
         const storedSchema = this.storedSchema.clone();
         const forest = this.forest.clone(storedSchema, anchors);
-        const checkout = new TreeCheckout(branch, false, this.changeFamily, storedSchema, forest, this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this.editorOptions, this._removedRoots.clone(), this.logger, this.breaker, this.disposeForksAfterTransaction);
+        const checkout = new TreeCheckout(branch, false, this.changeFamily, storedSchema, forest, this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this._removedRoots.clone(), this.logger, this.breaker, this.disposeForksAfterTransaction);
         __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("fork", checkout);
         return checkout;
     }
     switchBranch(branch) {
         // TODO: Dispose old branch, if necessary
-        (0, internal_1.assert)(!__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").isInProgress(), 0xc55 /* Cannot switch branches during a transaction */);
+        (0, internal_1.assert)(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").size === 0, 0xc55 /* Cannot switch branches during a transaction */);
         const diff = (0, index_js_2.diffHistories)(this.changeFamily.rebaser, __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.getHead(), branch.getHead(), this.mintRevisionTag);
         this.unregisterFromBranchEvents();
         __classPrivateFieldSet(this, _TreeCheckout_transaction, this.createTransactionStack(branch), "f");
@@ -506,10 +583,10 @@ class TreeCheckout {
         this.checkNotDisposed("The target of the branch rebase has been disposed and cannot be rebased.");
         checkout.checkNotDisposed("The source of the branch rebase has been disposed and cannot be rebased.");
         this.editLock.checkUnlocked("Rebasing");
-        if (this.transaction.isInProgress()) {
+        if (this.transaction.size > 0) {
             throw new internal_3.UsageError("Views cannot be rebased onto a view that has a pending transaction.");
         }
-        if (checkout.transaction.isInProgress()) {
+        if (checkout.transaction.size > 0) {
             throw new internal_3.UsageError("A view cannot be rebased while it has a pending transaction.");
         }
         (0, internal_1.assert)(!checkout.isSharedBranch, 0xa5d /* Shared branches cannot be rebased onto another branch. */);
@@ -523,10 +600,10 @@ class TreeCheckout {
         this.checkNotDisposed("The target of the branch merge has been disposed and cannot be merged.");
         checkout.checkNotDisposed("The source of the branch merge has been disposed and cannot be merged.");
         this.editLock.checkUnlocked("Merging");
-        if (this.transaction.isInProgress()) {
+        if (this.transaction.size > 0) {
             throw new internal_3.UsageError("Views cannot be merged into a view while it has a pending transaction.");
         }
-        if (checkout.transaction.isInProgress()) {
+        if (checkout.transaction.size > 0) {
             throw new internal_3.UsageError("Views with an open transaction cannot be merged into another view.");
         }
         __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.merge(__classPrivateFieldGet(checkout, _TreeCheckout_transaction, "f").activeBranch);
@@ -597,7 +674,7 @@ class TreeCheckout {
     }
     revertRevertible(revision, kind) {
         this.editLock.checkUnlocked("Reverting a commit");
-        if (this.transaction.isInProgress()) {
+        if (this.transaction.size > 0) {
             throw new internal_3.UsageError("Undo is not yet supported during transactions.");
         }
         const revertibleBranch = this.revertibleCommitBranches.get(revision);
@@ -738,10 +815,6 @@ class EditLock {
             get schema() {
                 return editor.schema;
             },
-            buildRoots(unhydrated) {
-                checkLock();
-                return editor.buildRoots(unhydrated);
-            },
             valueField(...fieldArgs) {
                 const valueField = editor.valueField(...fieldArgs);
                 return {
@@ -749,10 +822,6 @@ class EditLock {
                         checkLock();
                         valueField.set(...editArgs);
                     },
-                    attach(...editArgs) {
-                        checkLock();
-                        valueField.attach(...editArgs);
-                    },
                 };
             },
             optionalField(...fieldArgs) {
@@ -762,14 +831,6 @@ class EditLock {
                         checkLock();
                         optionalField.set(...editArgs);
                     },
-                    attach(...editArgs) {
-                        checkLock();
-                        optionalField.attach(...editArgs);
-                    },
-                    clear(...editArgs) {
-                        checkLock();
-                        optionalField.clear(...editArgs);
-                    },
                 };
             },
             sequenceField(...fieldArgs) {
@@ -779,10 +840,6 @@ class EditLock {
                         checkLock();
                         sequenceField.insert(...editArgs);
                     },
-                    attach(...editArgs) {
-                        checkLock();
-                        sequenceField.attach(...editArgs);
-                    },
                     remove(...editArgs) {
                         checkLock();
                         sequenceField.remove(...editArgs);