@fluidframework/tree 2.11.0 → 2.12.0

package/dist/shared-tree/treeCheckout.js

@@ -8,7 +8,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _TreeCheckout_transaction;
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _TreeCheckout_events, _TreeCheckout_transaction, _TreeCheckout_validatedCommits;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TreeCheckout = exports.createTreeCheckout = void 0;
 const internal_1 = require("@fluidframework/core-utils/internal");
@@ -41,25 +47,22 @@ function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, arg
             change: changeFamily.rebaser.compose([]),
             revision: "root",
         }, changeFamily, () => idCompressor.generateCompressedId());
-    const events = args?.events ?? (0, client_utils_1.createEmitter)();
-    return new TreeCheckout(branch, false, changeFamily, schema, forest, events, mintRevisionTag, revisionTagCodec, idCompressor, args?.removedRoots, args?.logger, args?.breaker);
+    return new TreeCheckout(branch, false, changeFamily, schema, forest, mintRevisionTag, revisionTagCodec, idCompressor, args?.removedRoots, args?.logger, args?.breaker);
 }
 exports.createTreeCheckout = createTreeCheckout;
 /**
  * An implementation of {@link ITreeCheckoutFork}.
  */
 class TreeCheckout {
-    constructor(_branch, 
+    constructor(branch, 
     /** True if and only if this checkout is for a forked branch and not the "main branch" of the tree. */
-    isBranch, changeFamily, storedSchema, forest, events, mintRevisionTag, revisionTagCodec, idCompressor, removedRoots = (0, index_js_2.makeDetachedFieldIndex)("repair", revisionTagCodec, idCompressor), 
+    isBranch, changeFamily, storedSchema, forest, mintRevisionTag, revisionTagCodec, idCompressor, removedRoots = (0, index_js_2.makeDetachedFieldIndex)("repair", revisionTagCodec, idCompressor), 
     /** Optional logger for telemetry. */
     logger, breaker = new index_js_5.Breakable("TreeCheckout")) {
-        this._branch = _branch;
         this.isBranch = isBranch;
         this.changeFamily = changeFamily;
         this.storedSchema = storedSchema;
         this.forest = forest;
-        this.events = events;
         this.mintRevisionTag = mintRevisionTag;
         this.revisionTagCodec = revisionTagCodec;
         this.idCompressor = idCompressor;
@@ -78,69 +81,14 @@ class TreeCheckout {
          * being reverted.
          */
         this.revertibleCommitBranches = new Map();
-        /**
-         * The {@link Transactor} for this checkout.
-         * @remarks In the context of a checkout, transactions allow edits to be batched into atomic units.
-         * Edits made during a transaction will update the local state of the tree immediately, but will be squashed into a single edit when the transaction is committed.
-         * If the transaction is aborted, the local state will be reset to what it was before the transaction began.
-         * Transactions may nest, meaning that a transaction may be started while a transaction is already ongoing.
-         *
-         * To avoid updating observers of the view state with intermediate results during a transaction,
-         * use {@link ITreeCheckout#branch} and {@link ISharedTreeFork#merge}.
-         */
-        _TreeCheckout_transaction.set(this, new index_js_4.TransactionStack(() => {
-            // Keep track of the commit that each transaction was on when it started
-            // TODO:#8603: This may need to be computed differently if we allow rebasing during a transaction.
-            const startCommit = this._branch.getHead();
-            // Keep track of all the forks created during the transaction so that we can dispose them when the transaction ends.
-            // This is a policy decision that we think is useful for the user, but it is not necessary for correctness.
-            const forks = new Set();
-            const onDisposeUnSubscribes = [];
-            const onForkUnSubscribe = (0, index_js_4.onForkTransitive)(this, (fork) => {
-                forks.add(fork);
-                onDisposeUnSubscribes.push(fork.events.on("dispose", () => forks.delete(fork)));
-            });
-            // When each transaction is started, take a snapshot of the current state of removed roots
-            const removedRoots = this.removedRoots.clone();
-            this._branch.editor.enterTransaction();
-            return (result) => {
-                this._branch.editor.exitTransaction();
-                switch (result) {
-                    case index_js_4.TransactionResult.Abort:
-                        this._branch.removeAfter(startCommit);
-                        // If a transaction is rolled back, revert removed roots back to the latest snapshot
-                        this.removedRoots = removedRoots;
-                        break;
-                    case index_js_4.TransactionResult.Commit: {
-                        const removedCommits = this._branch.squashAfter(startCommit);
-                        const transactionRevision = this._branch.getHead().revision;
-                        for (const transactionStep of removedCommits) {
-                            this.removedRoots.updateMajor(transactionStep.revision, transactionRevision);
-                        }
-                        break;
-                    }
-                    default:
-                        (0, internal_1.unreachableCase)(result);
-                }
-                forks.forEach((fork) => fork.dispose());
-                onDisposeUnSubscribes.forEach((unsubscribe) => unsubscribe());
-                onForkUnSubscribe();
-            };
-        }));
-        // We subscribe to `beforeChange` rather than `afterChange` here because it's possible that the change is invalid WRT our forest.
-        // For example, a bug in the editor might produce a malformed change object and thus applying the change to the forest will throw an error.
-        // In such a case we will crash here, preventing the change from being added to the commit graph, and preventing `afterChange` from firing.
-        // One important consequence of this is that we will not submit the op containing the invalid change, since op submissions happens in response to `afterChange`.
-        _branch.events.on("beforeChange", (event) => {
+        _TreeCheckout_events.set(this, (0, client_utils_1.createEmitter)());
+        this.events = __classPrivateFieldGet(this, _TreeCheckout_events, "f");
+        this.onAfterChange = (event) => {
+            __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("beforeBatch", event);
             if (event.change !== undefined) {
-                let revision;
-                if (event.type === "replace") {
-                    (0, internal_1.assert)((0, index_js_5.hasSome)(event.newCommits), 0xa81 /* Expected new commit for non no-op change event */);
-                    revision = (0, index_js_5.getLast)(event.newCommits).revision;
-                }
-                else {
-                    revision = event.change.revision;
-                }
+                const revision = event.type === "rebase"
+                    ? __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.getHead().revision
+                    : event.change.revision;
                 // Conflicts due to schema will be empty and thus are not applied.
                 for (const change of event.change.change.changes) {
                     if (change.type === "data") {
@@ -165,54 +113,21 @@ class TreeCheckout {
                         // They will however be rebased over the rollback of the schema change. This rebasing will
                         // ensure that these data changes are muted if they would render some trees invalid under the
                         // original (reinstated) schema.
-                        storedSchema.apply(change.innerChange.schema.new);
+                        this.storedSchema.apply(change.innerChange.schema.new);
                     }
                     else {
                         (0, index_js_5.fail)("Unknown Shared Tree change type.");
                     }
                 }
-                this.events.emit("afterBatch");
             }
-        });
-        _branch.events.on("afterChange", (event) => {
-            // The following logic allows revertibles to be generated for the change.
-            // Currently only appends (including merges) and transaction commits are supported.
-            if (!this.transaction.isInProgress()) {
-                if (event.type === "append" ||
-                    (event.type === "replace" && (0, index_js_4.getChangeReplaceType)(event) === "transactionCommit")) {
-                    // TODO:#20949: When the SharedTree is detached, these commits will already have been garbage collected.
-                    //       Figure out a way to generate revertibles before the commits are garbage collected.
-                    for (const commit of event.newCommits) {
-                        const kind = event.type === "append" ? event.kind : index_js_2.CommitKind.Default;
-                        const { change, revision } = commit;
-                        const getRevertible = (0, sharedTreeChangeFamily_js_1.hasSchemaChange)(change)
-                            ? undefined
-                            : (onRevertibleDisposed) => {
-                                if (!withinEventContext) {
-                                    throw new internal_2.UsageError("Cannot get a revertible outside of the context of a changed event.");
-                                }
-                                if (this.revertibleCommitBranches.get(revision) !== undefined) {
-                                    throw new internal_2.UsageError("Cannot generate the same revertible more than once. Note that this can happen when multiple changed event listeners are registered.");
-                                }
-                                const revertible = this.createRevertible(revision, kind, this, onRevertibleDisposed);
-                                this.revertibleCommitBranches.set(revision, _branch.fork(commit));
-                                this.revertibles.add(revertible);
-                                return revertible;
-                            };
-                        let withinEventContext = true;
-                        this.events.emit("changed", { isLocal: true, kind }, getRevertible);
-                        withinEventContext = false;
-                    }
-                }
-                else if (this.isRemoteChangeEvent(event)) {
-                    // TODO: figure out how to plumb through commit kind info for remote changes
-                    this.events.emit("changed", { isLocal: false, kind: index_js_2.CommitKind.Default });
-                }
+            __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("afterBatch");
+            if (event.type === "append") {
+                event.newCommits.forEach((commit) => this.validateCommit(commit));
             }
-        });
-        // When the branch is trimmed, we can garbage collect any repair data whose latest relevant revision is one of the
-        // trimmed revisions.
-        _branch.events.on("ancestryTrimmed", (revisions) => {
+        };
+        this.onAncestryTrimmed = (revisions) => {
+            // When the branch is trimmed, we can garbage collect any repair data whose latest relevant revision is one of the
+            // trimmed revisions.
             this.withCombinedVisitor((visitor) => {
                 revisions.forEach((revision) => {
                     // get all the roots last created or used by the revision
@@ -224,7 +139,94 @@ class TreeCheckout {
                     this.removedRoots.deleteRootsLastTouchedByRevision(revision);
                 });
             });
+        };
+        /**
+         * The {@link Transactor} for this checkout.
+         * @remarks In the context of a checkout, transactions allow edits to be batched into atomic units.
+         * Edits made during a transaction will update the local state of the tree immediately, but will be squashed into a single edit when the transaction is committed.
+         * If the transaction is aborted, the local state will be reset to what it was before the transaction began.
+         * Transactions may nest, meaning that a transaction may be started while a transaction is already ongoing.
+         *
+         * To avoid updating observers of the view state with intermediate results during a transaction,
+         * use {@link ITreeCheckout#branch} and {@link ISharedTreeFork#merge}.
+         */
+        _TreeCheckout_transaction.set(this, void 0);
+        // #region Commit Validation
+        /** Used to maintain the contract of {@link onCommitValid}(). */
+        _TreeCheckout_validatedCommits.set(this, new WeakMap());
+        __classPrivateFieldSet(this, _TreeCheckout_transaction, new index_js_4.SquashingTransactionStack(branch, (commits) => {
+            const revision = this.mintRevisionTag();
+            for (const transactionStep of commits) {
+                this.removedRoots.updateMajor(transactionStep.revision, revision);
+            }
+            const squashedChange = this.changeFamily.rebaser.compose(commits);
+            const change = this.changeFamily.rebaser.changeRevision(squashedChange, revision);
+            return (0, index_js_2.tagChange)(change, revision);
+        }, () => {
+            // Keep track of all the forks created during the transaction so that we can dispose them when the transaction ends.
+            // This is a policy decision that we think is useful for the user, but it is not necessary for correctness.
+            const forks = new Set();
+            const onDisposeUnSubscribes = [];
+            const onForkUnSubscribe = (0, index_js_4.onForkTransitive)(this, (fork) => {
+                forks.add(fork);
+                onDisposeUnSubscribes.push(fork.events.on("dispose", () => forks.delete(fork)));
+            });
+            // When each transaction is started, take a snapshot of the current state of removed roots
+            const removedRootsSnapshot = this.removedRoots.clone();
+            return (result) => {
+                switch (result) {
+                    case index_js_4.TransactionResult.Abort:
+                        this.removedRoots = removedRootsSnapshot;
+                        break;
+                    case index_js_4.TransactionResult.Commit:
+                        if (!this.transaction.isInProgress()) {
+                            // 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(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.getHead());
+                        }
+                        break;
+                    default:
+                        (0, internal_1.unreachableCase)(result);
+                }
+                forks.forEach((fork) => fork.dispose());
+                onDisposeUnSubscribes.forEach((unsubscribe) => unsubscribe());
+                onForkUnSubscribe();
+            };
+        }), "f");
+        branch.events.on("afterChange", (event) => {
+            // The following logic allows revertibles to be generated for the change.
+            // Currently only appends (including merges and transaction commits) are supported.
+            if (event.type === "append") {
+                // TODO:#20949: When the SharedTree is detached, these commits will already have been garbage collected.
+                //       Figure out a way to generate revertibles before the commits are garbage collected.
+                for (const commit of event.newCommits) {
+                    const kind = event.type === "append" ? event.kind : index_js_2.CommitKind.Default;
+                    const { change, revision } = commit;
+                    const getRevertible = (0, sharedTreeChangeFamily_js_1.hasSchemaChange)(change)
+                        ? undefined
+                        : (onRevertibleDisposed) => {
+                            if (!withinEventContext) {
+                                throw new internal_2.UsageError("Cannot get a revertible outside of the context of a changed event.");
+                            }
+                            if (this.revertibleCommitBranches.get(revision) !== undefined) {
+                                throw new internal_2.UsageError("Cannot generate the same revertible more than once. Note that this can happen when multiple changed event listeners are registered.");
+                            }
+                            const revertible = this.createRevertible(revision, kind, this, onRevertibleDisposed);
+                            this.revertibleCommitBranches.set(revision, __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.fork(commit));
+                            this.revertibles.add(revertible);
+                            return revertible;
+                        };
+                    let withinEventContext = true;
+                    __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("changed", { isLocal: true, kind }, getRevertible);
+                    withinEventContext = false;
+                }
+            }
+            else if (this.isRemoteChangeEvent(event)) {
+                // TODO: figure out how to plumb through commit kind info for remote changes
+                __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("changed", { isLocal: false, kind: index_js_2.CommitKind.Default });
+            }
         });
+        __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEvents.on("afterChange", this.onAfterChange);
+        __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEvents.on("ancestryTrimmed", this.onAncestryTrimmed);
     }
     withCombinedVisitor(fn) {
         const anchorVisitor = this.forest.anchors.acquireVisitor();
@@ -305,7 +307,7 @@ class TreeCheckout {
     }
     get editor() {
         this.checkNotDisposed();
-        return this._branch.editor;
+        return __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEditor;
     }
     locate(anchor) {
         this.checkNotDisposed();
@@ -317,11 +319,11 @@ class TreeCheckout {
     branch() {
         this.checkNotDisposed("The parent branch has already been disposed and can no longer create new branches.");
         const anchors = new index_js_2.AnchorSet();
-        const branch = this._branch.fork();
+        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, true, this.changeFamily, storedSchema, forest, (0, client_utils_1.createEmitter)(), this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this.removedRoots.clone(), this.logger, this.breaker);
-        this.events.emit("fork", checkout);
+        const checkout = new TreeCheckout(branch, true, this.changeFamily, storedSchema, forest, this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this.removedRoots.clone(), this.logger, this.breaker);
+        __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("fork", checkout);
         return checkout;
     }
     rebase(checkout) {
@@ -329,7 +331,7 @@ class TreeCheckout {
         checkout.checkNotDisposed("The source of the branch rebase has been disposed and cannot be rebased.");
         (0, internal_1.assert)(!checkout.transaction.isInProgress(), 0x9af /* A view cannot be rebased while it has a pending transaction */);
         (0, internal_1.assert)(checkout.isBranch, 0xa5d /* The main branch cannot be rebased onto another branch. */);
-        checkout._branch.rebaseOnto(this._branch);
+        __classPrivateFieldGet(checkout, _TreeCheckout_transaction, "f").activeBranch.rebaseOnto(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch);
     }
     rebaseOnto(checkout) {
         this.checkNotDisposed("The target of the branch rebase has been disposed and cannot be rebased.");
@@ -342,7 +344,7 @@ class TreeCheckout {
         while (checkout.transaction.isInProgress()) {
             checkout.transaction.commit();
         }
-        this._branch.merge(checkout._branch);
+        __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.merge(__classPrivateFieldGet(checkout, _TreeCheckout_transaction, "f").activeBranch);
         if (disposeMerged && checkout.isBranch) {
             // Dispose the merged checkout unless it is the main branch.
             checkout[index_js_5.disposeSymbol]();
@@ -355,16 +357,16 @@ class TreeCheckout {
     dispose() {
         this[index_js_5.disposeSymbol]();
     }
-    [(_TreeCheckout_transaction = new WeakMap(), index_js_5.disposeSymbol)]() {
+    [(_TreeCheckout_events = new WeakMap(), _TreeCheckout_transaction = new WeakMap(), _TreeCheckout_validatedCommits = new WeakMap(), index_js_5.disposeSymbol)]() {
         this.checkNotDisposed("The branch has already been disposed and cannot be disposed again.");
         this.disposed = true;
+        __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.dispose();
         __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").dispose();
         this.purgeRevertibles();
-        this._branch.dispose();
         for (const view of this.views) {
             view.dispose();
         }
-        this.events.emit("dispose");
+        __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("dispose");
     }
     getRemovedRoots() {
         this.assertNoUntrackedRoots();
@@ -383,11 +385,16 @@ class TreeCheckout {
         return trees;
     }
     /**
-     * This sets the tip revision as the latest relevant revision for any removed roots that are loaded from a summary.
-     * This needs to be called right after loading {@link this.removedRoots} from a summary to allow loaded data to be garbage collected.
+     * This must be called on the root/main checkout after loading from a summary.
+     * @remarks This pattern is necessary because the EditManager skips the normal process of applying commits to branches when loading a summary.
+     * Instead, it simply {@link SharedTreeBranch#setHead | mutates} the branches directly which does not propagate the typical events throughout the rest of the system.
      */
-    setTipRevisionForLoadedData(revision) {
-        this.removedRoots.setRevisionsForLoadedData(revision);
+    load() {
+        // Set the tip revision as the latest relevant revision for any removed roots that are loaded from a summary - this allows them to be garbage collected later.
+        // When a load happens, the head of the trunk and the head of the local/main branch must be the same (this is enforced by SharedTree).
+        this.removedRoots.setRevisionsForLoadedData(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.getHead().revision);
+        // The content of the checkout (e.g. the forest) has (maybe) changed, so fire an afterBatch event.
+        __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("afterBatch");
     }
     purgeRevertibles() {
         for (const revertible of this.revertibles) {
@@ -408,12 +415,12 @@ class TreeCheckout {
         const commitToRevert = revertibleBranch.getHead();
         const revisionForInvert = this.mintRevisionTag();
         let change = (0, index_js_2.tagChange)(this.changeFamily.rebaser.invert(commitToRevert, false, revisionForInvert), revisionForInvert);
-        const headCommit = this._branch.getHead();
+        const headCommit = __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.getHead();
         // Rebase the inverted change onto any commits that occurred after the undoable commits.
         if (commitToRevert !== headCommit) {
             change = (0, index_js_2.tagChange)((0, index_js_2.rebaseChange)(this.changeFamily.rebaser, change, commitToRevert, headCommit, this.mintRevisionTag).change, revisionForInvert);
         }
-        this._branch.apply(change, kind === index_js_2.CommitKind.Default || kind === index_js_2.CommitKind.Redo
+        __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.apply(change, kind === index_js_2.CommitKind.Default || kind === index_js_2.CommitKind.Redo
             ? index_js_2.CommitKind.Undo
             : index_js_2.CommitKind.Redo);
         // Derive some stats about the reversion to return to the caller.
@@ -451,8 +458,33 @@ class TreeCheckout {
         !this.isBranch &&
             // Remote changes are applied to the main branch by rebasing it onto the trunk.
             // No other rebases are allowed on the main branch, so we can use this to detect remote changes.
-            event.type === "replace" &&
-            (0, index_js_4.getChangeReplaceType)(event) === "rebase");
+            event.type === "rebase");
+    }
+    /**
+     * Registers a function to be called when the given commit is validated.
+     * @remarks A commit is validated by the checkout after it has been applied to the checkout's state (e.g. it has an effect on the forest).
+     * If the commit applies successfully (i.e. it does not raise any unexpected errors), the commit is considered valid and the registered function is called.
+     * If the commit does not apply successfully (because it causes an unexpected error), the function is not called (and the checkout will left in an error state).
+     *
+     * If the commit has already been validated when this function is called, the function is called immediately and this function returns `true`.
+     * Otherwise, the function is registered to be called later and this function returns `false`.
+     */
+    onCommitValid(commit, fn) {
+        const validated = (0, index_js_5.getOrCreate)(__classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f"), commit, () => []);
+        if (validated === true) {
+            fn(commit);
+            return true;
+        }
+        validated.push(fn);
+        return false;
+    }
+    /** Mark the given commit as "validated" according to the contract of {@link onCommitValid}(). */
+    validateCommit(commit) {
+        const validated = (0, index_js_5.getOrCreate)(__classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f"), commit, () => []);
+        if (validated !== true) {
+            validated.forEach((fn) => fn(commit));
+            __classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f").set(commit, true);
+        }
     }
 }
 exports.TreeCheckout = TreeCheckout;