@fluidframework/tree 2.10.0 → 2.12.0

package/dist/shared-tree/treeCheckout.js

@@ -3,16 +3,28 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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 __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.runSynchronous = exports.TreeCheckout = exports.createTreeCheckout = void 0;
+exports.TreeCheckout = exports.createTreeCheckout = void 0;
 const internal_1 = require("@fluidframework/core-utils/internal");
+const client_utils_1 = require("@fluid-internal/client-utils");
 const internal_2 = require("@fluidframework/telemetry-utils/internal");
 const index_js_1 = require("../codec/index.js");
 const index_js_2 = require("../core/index.js");
-const index_js_3 = require("../events/index.js");
-const index_js_4 = require("../feature-libraries/index.js");
-const index_js_5 = require("../shared-tree-core/index.js");
-const index_js_6 = require("../util/index.js");
+const index_js_3 = require("../feature-libraries/index.js");
+const index_js_4 = require("../shared-tree-core/index.js");
+const index_js_5 = require("../util/index.js");
 const sharedTreeChangeFamily_js_1 = require("./sharedTreeChangeFamily.js");
 const schematizingTreeView_js_1 = require("./schematizingTreeView.js");
 /**
@@ -23,61 +35,34 @@ const schematizingTreeView_js_1 = require("./schematizingTreeView.js");
  * and functionality required to implement {@link ITreeCheckout}.
  */
 function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, args) {
-    const forest = args?.forest ?? (0, index_js_4.buildForest)();
+    const forest = args?.forest ?? (0, index_js_3.buildForest)();
     const schema = args?.schema ?? new index_js_2.TreeStoredSchemaRepository();
     const defaultCodecOptions = { jsonValidator: index_js_1.noopValidator };
     const defaultFieldBatchVersion = 1;
     const changeFamily = args?.changeFamily ??
         new sharedTreeChangeFamily_js_1.SharedTreeChangeFamily(revisionTagCodec, args?.fieldBatchCodec ??
-            (0, index_js_4.makeFieldBatchCodec)(defaultCodecOptions, defaultFieldBatchVersion), { jsonValidator: index_js_1.noopValidator }, args?.chunkCompressionStrategy, idCompressor);
+            (0, index_js_3.makeFieldBatchCodec)(defaultCodecOptions, defaultFieldBatchVersion), { jsonValidator: index_js_1.noopValidator }, args?.chunkCompressionStrategy, idCompressor);
     const branch = args?.branch ??
-        new index_js_5.SharedTreeBranch({
+        new index_js_4.SharedTreeBranch({
             change: changeFamily.rebaser.compose([]),
             revision: "root",
         }, changeFamily, () => idCompressor.generateCompressedId());
-    const events = args?.events ?? (0, index_js_3.createEmitter)();
-    const transaction = new Transaction(branch);
-    return new TreeCheckout(transaction, 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;
-class Transaction {
-    constructor(branch) {
-        this.branch = branch;
-    }
-    start() {
-        this.branch.startTransaction();
-        this.branch.editor.enterTransaction();
-    }
-    commit() {
-        this.branch.commitTransaction();
-        this.branch.editor.exitTransaction();
-        return index_js_6.TransactionResult.Commit;
-    }
-    abort() {
-        this.branch.abortTransaction();
-        this.branch.editor.exitTransaction();
-        return index_js_6.TransactionResult.Abort;
-    }
-    inProgress() {
-        return this.branch.isTransacting();
-    }
-}
 /**
  * An implementation of {@link ITreeCheckoutFork}.
  */
 class TreeCheckout {
-    constructor(transaction, _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_6.Breakable("TreeCheckout")) {
-        this.transaction = transaction;
-        this._branch = _branch;
+    logger, breaker = new index_js_5.Breakable("TreeCheckout")) {
         this.isBranch = isBranch;
         this.changeFamily = changeFamily;
         this.storedSchema = storedSchema;
         this.forest = forest;
-        this.events = events;
         this.mintRevisionTag = mintRevisionTag;
         this.revisionTagCodec = revisionTagCodec;
         this.idCompressor = idCompressor;
@@ -96,39 +81,18 @@ class TreeCheckout {
          * being reverted.
          */
         this.revertibleCommitBranches = new Map();
-        /**
-         * copies of the removed roots used as snapshots for reverting to previous state when transactions are aborted
-         */
-        this.removedRootsSnapshots = [];
-        // when a transaction is started, take a snapshot of the current state of removed roots
-        _branch.events.on("transactionStarted", () => {
-            this.removedRootsSnapshots.push(this.removedRoots.clone());
-        });
-        // when a transaction is committed, the latest snapshot of removed roots can be discarded
-        _branch.events.on("transactionCommitted", () => {
-            this.removedRootsSnapshots.pop();
-        });
-        // after a transaction is rolled back, revert removed roots back to the latest snapshot
-        _branch.events.on("transactionRolledBack", () => {
-            const snapshot = this.removedRootsSnapshots.pop();
-            (0, internal_1.assert)(snapshot !== undefined, 0x9ae /* a snapshot for removed roots does not exist */);
-            this.removedRoots = snapshot;
-        });
-        // 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) {
-                const revision = event.type === "replace"
-                    ? // Change events will always contain new commits
-                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                        event.newCommits[event.newCommits.length - 1].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") {
-                        const delta = (0, index_js_4.intoDelta)((0, index_js_2.tagChange)(change.innerChange, revision));
+                        const delta = (0, index_js_3.intoDelta)((0, index_js_2.tagChange)(change.innerChange, revision));
                         this.withCombinedVisitor((visitor) => {
                             (0, index_js_2.visitDelta)(delta, visitor, this.removedRoots, revision);
                         });
@@ -149,89 +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_6.fail)("Unknown Shared Tree change type.");
+                        (0, index_js_5.fail)("Unknown Shared Tree change type.");
                     }
                 }
-                this.events.emit("afterBatch");
             }
-            if (event.type === "replace" && (0, index_js_5.getChangeReplaceType)(event) === "transactionCommit") {
-                const firstCommit = event.newCommits[0] ?? (0, internal_1.oob)();
-                const transactionRevision = firstCommit.revision;
-                for (const transactionStep of event.removedCommits) {
-                    this.removedRoots.updateMajor(transactionStep.revision, transactionRevision);
-                }
+            __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("afterBatch");
+            if (event.type === "append") {
+                event.newCommits.forEach((commit) => this.validateCommit(commit));
             }
-        });
-        _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 (!_branch.isTransacting()) {
-                if (event.type === "append" ||
-                    (event.type === "replace" && (0, index_js_5.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 revertibleCommits = this.revertibleCommitBranches;
-                                const revertible = {
-                                    get status() {
-                                        const revertibleCommit = revertibleCommits.get(revision);
-                                        return revertibleCommit === undefined
-                                            ? index_js_2.RevertibleStatus.Disposed
-                                            : index_js_2.RevertibleStatus.Valid;
-                                    },
-                                    revert: (release = true) => {
-                                        if (revertible.status === index_js_2.RevertibleStatus.Disposed) {
-                                            throw new internal_2.UsageError("Unable to revert a revertible that has been disposed.");
-                                        }
-                                        const revertMetrics = this.revertRevertible(revision, kind);
-                                        this.logger?.sendTelemetryEvent({
-                                            eventName: TreeCheckout.revertTelemetryEventName,
-                                            ...revertMetrics,
-                                        });
-                                        if (release) {
-                                            revertible.dispose();
-                                        }
-                                    },
-                                    dispose: () => {
-                                        if (revertible.status === index_js_2.RevertibleStatus.Disposed) {
-                                            throw new internal_2.UsageError("Unable to dispose a revertible that has already been disposed.");
-                                        }
-                                        this.disposeRevertible(revertible, revision);
-                                        onRevertibleDisposed?.(revertible);
-                                    },
-                                };
-                                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 });
-                }
-            }
-        });
-        // 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
@@ -243,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();
@@ -259,8 +242,61 @@ class TreeCheckout {
             (0, internal_1.assert)(false, 0x911 /* Invalid operation on a disposed TreeCheckout */);
         }
     }
+    /**
+     * Creates a {@link RevertibleAlpha} object that can undo a specific change in the tree's history.
+     * Revision must exist in the given {@link TreeCheckout}'s branch.
+     *
+     * @param revision - The revision tag identifying the change to be made revertible.
+     * @param kind - The {@link CommitKind} that produced this revertible (e.g., Default, Undo, Redo).
+     * @param checkout - The {@link TreeCheckout} instance this revertible belongs to.
+     * @param onRevertibleDisposed - Callback function that will be called when the revertible is disposed.
+     * @returns - {@link RevertibleAlpha}
+     */
+    createRevertible(revision, kind, checkout, onRevertibleDisposed) {
+        const commitBranches = checkout.revertibleCommitBranches;
+        const revertible = {
+            get status() {
+                const revertibleCommit = commitBranches.get(revision);
+                return revertibleCommit === undefined
+                    ? index_js_2.RevertibleStatus.Disposed
+                    : index_js_2.RevertibleStatus.Valid;
+            },
+            revert: (release = true) => {
+                if (revertible.status === index_js_2.RevertibleStatus.Disposed) {
+                    throw new internal_2.UsageError("Unable to revert a revertible that has been disposed.");
+                }
+                const revertMetrics = checkout.revertRevertible(revision, kind);
+                checkout.logger?.sendTelemetryEvent({
+                    eventName: TreeCheckout.revertTelemetryEventName,
+                    ...revertMetrics,
+                });
+                if (release) {
+                    revertible.dispose();
+                }
+            },
+            clone: (forkedBranch) => {
+                if (forkedBranch === undefined) {
+                    return this.createRevertible(revision, kind, checkout, onRevertibleDisposed);
+                }
+                // TODO:#23442: When a revertible is cloned for a forked branch, optimize to create a fork of a revertible branch once per revision NOT once per revision per checkout.
+                const forkedCheckout = (0, schematizingTreeView_js_1.getCheckout)(forkedBranch);
+                const revertibleBranch = this.revertibleCommitBranches.get(revision);
+                (0, internal_1.assert)(revertibleBranch !== undefined, 0xa82 /* change to revert does not exist on the given forked branch */);
+                forkedCheckout.revertibleCommitBranches.set(revision, revertibleBranch.fork());
+                return this.createRevertible(revision, kind, forkedCheckout, onRevertibleDisposed);
+            },
+            dispose: () => {
+                if (revertible.status === index_js_2.RevertibleStatus.Disposed) {
+                    throw new internal_2.UsageError("Unable to dispose a revertible that has already been disposed.");
+                }
+                checkout.disposeRevertible(revertible, revision);
+                onRevertibleDisposed?.(revertible);
+            },
+        };
+        return revertible;
+    }
     viewWith(config) {
-        const view = new schematizingTreeView_js_1.SchematizingSimpleTreeView(this, config, (0, index_js_4.createNodeKeyManager)(this.idCompressor), this.breaker, () => {
+        const view = new schematizingTreeView_js_1.SchematizingSimpleTreeView(this, config, (0, index_js_3.createNodeKeyManager)(this.idCompressor), this.breaker, () => {
             this.views.delete(view);
         });
         this.views.add(view);
@@ -271,27 +307,31 @@ class TreeCheckout {
     }
     get editor() {
         this.checkNotDisposed();
-        return this._branch.editor;
+        return __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEditor;
     }
     locate(anchor) {
         this.checkNotDisposed();
         return this.forest.anchors.locate(anchor);
     }
+    get transaction() {
+        return __classPrivateFieldGet(this, _TreeCheckout_transaction, "f");
+    }
     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 transaction = new Transaction(branch);
-        return new TreeCheckout(transaction, branch, true, this.changeFamily, storedSchema, forest, (0, index_js_3.createEmitter)(), this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this.removedRoots.clone(), this.logger, this.breaker);
+        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) {
         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.");
-        (0, internal_1.assert)(!checkout.transaction.inProgress(), 0x9af /* A view cannot be rebased while it has a pending transaction */);
+        (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.");
@@ -300,14 +340,14 @@ class TreeCheckout {
     merge(checkout, disposeMerged = true) {
         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.");
-        (0, internal_1.assert)(!this.transaction.inProgress(), 0x9b0 /* Views cannot be merged into a view while it has a pending transaction */);
-        while (checkout.transaction.inProgress()) {
+        (0, internal_1.assert)(!this.transaction.isInProgress(), 0x9b0 /* Views cannot be merged into a view while it has a pending transaction */);
+        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_6.disposeSymbol]();
+            checkout[index_js_5.disposeSymbol]();
         }
     }
     updateSchema(newSchema) {
@@ -315,16 +355,18 @@ class TreeCheckout {
         this.editor.schema.setStoredSchema(this.storedSchema.clone(), newSchema);
     }
     dispose() {
-        this[index_js_6.disposeSymbol]();
+        this[index_js_5.disposeSymbol]();
     }
-    [index_js_6.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();
         }
+        __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("dispose");
     }
     getRemovedRoots() {
         this.assertNoUntrackedRoots();
@@ -333,7 +375,7 @@ class TreeCheckout {
         for (const { id, root } of this.removedRoots.entries()) {
             const parentField = this.removedRoots.toFieldKey(root);
             this.forest.moveCursorToPath({ parent: undefined, parentField, parentIndex: 0 }, cursor);
-            const tree = (0, index_js_4.jsonableTreeFromCursor)(cursor);
+            const tree = (0, index_js_3.jsonableTreeFromCursor)(cursor);
             // This method is used for tree consistency comparison.
             const { major, minor } = id;
             const finalizedMajor = major !== undefined ? this.revisionTagCodec.encode(major) : major;
@@ -343,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) {
@@ -360,7 +407,7 @@ class TreeCheckout {
         this.revertibles.delete(revertible);
     }
     revertRevertible(revision, kind) {
-        if (this._branch.isTransacting()) {
+        if (this.transaction.isInProgress()) {
             throw new internal_2.UsageError("Undo is not yet supported during transactions.");
         }
         const revertibleBranch = this.revertibleCommitBranches.get(revision);
@@ -368,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.
@@ -407,13 +454,37 @@ class TreeCheckout {
      */
     isRemoteChangeEvent(event) {
         return (
-        // remote changes are only ever applied to the main branch
+        // Remote changes are only ever applied to the main branch
         !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 this means any replaces that are not
-            // transaction commits are remote changes
-            event.type === "replace" &&
-            (0, index_js_5.getChangeReplaceType)(event) !== "transactionCommit");
+            // 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 === "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;
@@ -422,20 +493,4 @@ exports.TreeCheckout = TreeCheckout;
  * @privateRemarks Exposed for testing purposes.
  */
 TreeCheckout.revertTelemetryEventName = "RevertRevertible";
-/**
- * Run a synchronous transaction on the given shared tree view.
- * This is a convenience helper around the {@link SharedTreeFork#transaction} APIs.
- * @param view - the view on which to run the transaction
- * @param transaction - the transaction function. This will be executed immediately. It is passed `view` as an argument for convenience.
- * If this function returns an `Abort` result then the transaction will be aborted. Otherwise, it will be committed.
- * @returns whether or not the transaction was committed or aborted
- */
-function runSynchronous(view, transaction) {
-    view.transaction.start();
-    const result = transaction(view);
-    return result === index_js_6.TransactionResult.Abort
-        ? view.transaction.abort()
-        : view.transaction.commit();
-}
-exports.runSynchronous = runSynchronous;
 //# sourceMappingURL=treeCheckout.js.map