@fluidframework/tree 2.61.0 → 2.62.0-356644

package/lib/shared-tree-core/editManager.js

@@ -7,7 +7,7 @@ import { createEmitter } from "@fluid-internal/client-utils";
 import { BTree } from "@tylerbu/sorted-btree-es6";
 import { findAncestor, findCommonAncestor, mintCommit, tagChange, } from "../core/index.js";
 import { brand, getOrCreate, mapIterable } from "../util/index.js";
-import { SharedTreeBranch, onForkTransitive } from "./branch.js";
+import { SharedTreeBranch, onForkTransitive, } from "./branch.js";
 import { getUpperBoundOfPreviousSequenceId, equalSequenceIds, maxSequenceId, minSequenceId, sequenceIdComparator, } from "./sequenceIdUtils.js";
 import { TelemetryEventBatcher, } from "@fluidframework/telemetry-utils/internal";
 export const minimumPossibleSequenceNumber = brand(Number.MIN_SAFE_INTEGER);
@@ -40,25 +40,11 @@ export class EditManager {
         this.localSessionId = localSessionId;
         this.mintRevisionTag = mintRevisionTag;
         this._events = createEmitter();
+        this.sharedBranches = new Map();
         /**
-         * Records extra data associated with commits in the {@link trunk}.
-         * This does not include an entry for the {@link trunkBase}.
-         */
-        this.trunkMetadata = new Map();
-        /**
-         * A map from a sequence id to the commit in the {@link trunk} which has that sequence id.
-         * This also includes an entry for the {@link trunkBase} which always has the lowest key in the map.
-         */
-        this.sequenceMap = new BTree(undefined, sequenceIdComparator);
-        /**
-         * Branches are maintained to represent the local change list that the issuing client had
-         * at the time of submitting the latest known edit on the branch.
-         * This means the head commit of each branch is always in its original (non-rebased) form.
-         */
-        this.peerLocalBranches = new Map();
-        /**
-         * Tracks where on the trunk all registered branches are based. Each key is the sequence id of a commit on
-         * the trunk, and the value is the set of all branches who have that commit as their common ancestor with the trunk.
+         * Tracks where on the trunk of the main branch all registered branches are based.
+         * Each key is the sequence id of a commit on the trunk,
+         * and the value is the set of all branches who have that commit as their common ancestor with the trunk.
          *
          * @remarks
          * This does not include the local branch.
@@ -71,39 +57,28 @@ export class EditManager {
          * @remarks If there are more than one commit with the same sequence number we assume this refers to the last commit in the batch.
          */
         this.minimumSequenceNumber = minimumPossibleSequenceNumber;
-        /**
-         * The list of commits (from oldest to most recent) that are on the local branch but not on the trunk.
-         * When a local commit is sequenced, the first commit in this list shifted onto the tip of the trunk.
-         */
-        this.localCommits = [];
         this.trunkBase = {
             revision: rootRevision,
             change: changeFamily.rebaser.compose([]),
         };
-        this.sequenceMap.set(minimumPossibleSequenceId, this.trunkBase);
         if (logger !== undefined) {
             this.telemetryEventBatcher = new TelemetryEventBatcher({
                 eventName: "rebaseProcessing",
                 category: "performance",
             }, logger, maxRebaseStatsAggregationCount);
         }
-        this.trunk = new SharedTreeBranch(this.trunkBase, changeFamily, mintRevisionTag, this._events, this.telemetryEventBatcher);
-        this.localBranch = new SharedTreeBranch(this.trunk.getHead(), changeFamily, mintRevisionTag, this._events, this.telemetryEventBatcher);
-        this.localBranch.events.on("afterChange", (event) => {
-            if (event.type === "append") {
-                for (const commit of event.newCommits) {
-                    this.localCommits.push(commit);
-                }
-            }
-            else {
-                this.localCommits.length = 0;
-                findCommonAncestor([this.localBranch.getHead(), this.localCommits], this.trunk.getHead());
-            }
-        });
+        const mainTrunk = new SharedTreeBranch(this.trunkBase, changeFamily, mintRevisionTag, this._events, this.telemetryEventBatcher);
+        const mainBranch = this.createSharedBranch("main", undefined, undefined, mainTrunk);
         // Track all forks of the local branch for purposes of trunk eviction. Unlike the local branch, they have
         // an unknown lifetime and rebase frequency, so we can not make any assumptions about which trunk commits
         // they require and therefore we monitor them explicitly.
-        onForkTransitive(this.localBranch, (fork) => this.registerBranch(fork));
+        onForkTransitive(mainBranch.localBranch, (fork) => this.registerBranch(fork));
+    }
+    getLocalBranch(branchId) {
+        return this.getSharedBranch(branchId).localBranch;
+    }
+    getSharedBranch(branchId) {
+        return this.sharedBranches.get(branchId) ?? fail("Branch does not exist");
     }
     /**
      * Make the given branch known to the `EditManager`. The `EditManager` will ensure that all registered
@@ -125,30 +100,32 @@ export class EditManager {
         const offAfterRebase = branch.events.on("afterChange", (args) => {
             if (args.type === "rebase") {
                 this.trackBranch(branch);
-                this.trimTrunk();
+                this.trimHistory();
             }
         });
         // When the branch is disposed, update our branch set and trim the trunk
         const offDispose = branch.events.on("dispose", () => {
             this.untrackBranch(branch);
-            this.trimTrunk();
+            this.trimHistory();
             offBeforeRebase();
             offAfterRebase();
             offDispose();
         });
     }
     trackBranch(b) {
-        const trunkCommit = findCommonAncestor(this.trunk.getHead(), b.getHead()) ??
-            fail(0xad2 /* Expected branch to be related to trunk */);
-        const sequenceId = this.getCommitSequenceId(trunkCommit);
+        const main = this.getSharedBranch("main");
+        const trunkCommit = findCommonAncestor(main.trunk.getHead(), b.getHead()) ??
+            fail(0xad2 /* Expected branch to be related to main */);
+        const sequenceId = main.getCommitSequenceId(trunkCommit.revision);
         const branches = getOrCreate(this.trunkBranches, sequenceId, () => new Set());
         assert(!branches.has(b), 0x670 /* Branch was registered more than once */);
         branches.add(b);
     }
     untrackBranch(b) {
-        const trunkCommit = findCommonAncestor(this.trunk.getHead(), b.getHead()) ??
-            fail(0xad3 /* Expected branch to be related to trunk */);
-        const sequenceId = this.getCommitSequenceId(trunkCommit);
+        const main = this.getSharedBranch("main");
+        const trunkCommit = findCommonAncestor(main.trunk.getHead(), b.getHead()) ??
+            fail(0xad3 /* Expected branch to be related to main */);
+        const sequenceId = main.getCommitSequenceId(trunkCommit.revision);
         const branches = this.trunkBranches.get(sequenceId) ?? fail(0xad4 /* Expected branch to be tracked */);
         assert(branches.delete(b), 0x671 /* Expected branch to be tracked */);
         if (branches.size === 0) {
@@ -156,54 +133,17 @@ export class EditManager {
         }
     }
     /**
-     * Promote the oldest un-sequenced commit on the local branch to the head of the trunk.
-     * @param sequenceId - The sequence id of the new trunk commit
-     * @remarks This method is a performance optimization for the scenario where this client receives its own change back after sequencing.
-     * The normal (not optimized) process in this case would be to apply the new sequenced commit to the trunk and then rebase the local branch over the trunk.
-     * The first commit will be "the same" (as in, it will have the same revision) as the commit that was just sequenced, so the rebase will be a no-op.
-     * Because the rebase is a no-op, we can skip it entirely and simply remove the commit from the local branch and append it to the trunk.
-     * Avoiding the overhead of the rebase process, even when it's a no-op, has real measured performance benefits and is worth the added complexity here.
+     * Return the sequenced number of the latest sequenced change.
      */
-    fastForwardNextLocalCommit(sequenceId) {
-        // First, push the local commit to the trunk.
-        // We are mutating our `localCommits` cache here, but there is no need to actually change the `localBranch` itself because it will simply catch up later if/when it next rebases.
-        const firstLocalCommit = this.localCommits.shift();
-        assert(firstLocalCommit !== undefined, 0x6b5 /* Received a sequenced change from the local session despite having no local changes */);
-        const previousSequenceId = this.getCommitSequenceId(this.trunk.getHead());
-        this.pushGraphCommitToTrunk(sequenceId, firstLocalCommit, this.localSessionId);
-        // Next, we need to update the sequence IDs that our local branches (user's branches, not peer branches) are associated with.
-        // In particular, if a local branch is based on the previous trunk head (the branch's first ancestor in the trunk is the commit that was the head before we pushed the new commit)
-        // and also branches off of the local branch (it has an ancestor that is part of the local branch), it needs to have its sequence number advanced to be that of the new trunk head.
-        // Intuitively, this makes sense because:
-        // 1. The trunk's head just advanced forward by some (sequence) amount.
-        // 2. The local branch is always rebased to be branching off of the head of the trunk (not literally in this case, because of the optimization, but in effect).
-        // 3. Therefore, the entire local branch just advanced forward by some (sequence) amount, and any commits downstream of it which track the sequence numbers of their base commits on the trunk should also advance.
-        // This update is not necessarily required for all local branches, since some may have fallen behind the local branch and are based on older trunk commits (such branches do not need updating).
-        const currentBranches = this.trunkBranches.get(previousSequenceId);
-        if (currentBranches !== undefined) {
-            const newBranches = getOrCreate(this.trunkBranches, sequenceId, () => new Set());
-            for (const branch of currentBranches) {
-                // Check every branch associated with the old sequence ID and advance it if it is based on the local branch (specifically, on the local branch as it was before we pushed its first commit to the trunk).
-                // We validate this by checking if the branch's head is a descendant of the local commit that we just pushed.
-                if (findAncestor(branch.getHead(), (c) => c === firstLocalCommit) !== undefined) {
-                    newBranches.add(branch);
-                    currentBranches.delete(branch);
-                }
-            }
-            // Clean up our trunk branches map by removing any empty sets.
-            if (currentBranches.size === 0) {
-                this.trunkBranches.delete(previousSequenceId);
-            }
-            if (newBranches.size === 0) {
-                this.trunkBranches.delete(sequenceId);
+    getLatestSequenceNumber() {
+        let maxSequenceNumber;
+        for (const branch of this.sharedBranches.values()) {
+            const branchMax = branch.getCommitSequenceId(branch.trunk.getHead().revision).sequenceNumber;
+            if (maxSequenceNumber === undefined || maxSequenceNumber < branchMax) {
+                maxSequenceNumber = branchMax;
             }
         }
-    }
-    /**
-     * Return the sequence number at which the given commit was sequenced on the trunk, or undefined if the commit is not part of the trunk.
-     */
-    getSequenceNumber(trunkCommit) {
-        return this.trunkMetadata.get(trunkCommit.revision)?.sequenceId.sequenceNumber;
+        return maxSequenceNumber;
     }
     /**
      * Advances the minimum sequence number, and removes all commits from the trunk which lie outside the collaboration window,
@@ -212,21 +152,21 @@ export class EditManager {
      *
      * @remarks If there are more than one commit with the same sequence number we assume this refers to the last commit in the batch.
      */
-    advanceMinimumSequenceNumber(minimumSequenceNumber, trimTrunk = true) {
+    advanceMinimumSequenceNumber(minimumSequenceNumber, trimHistory = true) {
         if (minimumSequenceNumber === this.minimumSequenceNumber) {
             return;
         }
         assert(minimumSequenceNumber > this.minimumSequenceNumber, 0x476 /* number must be larger or equal to current minimumSequenceNumber. */);
         this.minimumSequenceNumber = minimumSequenceNumber;
-        if (trimTrunk) {
-            this.trimTrunk();
+        if (trimHistory) {
+            this.trimHistory();
         }
     }
     /**
      * Examines the latest known minimum sequence number and the trunk bases of any registered branches to determine
      * if any commits on the trunk are unreferenced and unneeded for future computation; those found are evicted from the trunk.
      */
-    trimTrunk() {
+    trimHistory() {
         /** The sequence id of the most recent commit on the trunk that will be trimmed */
         let trunkTailSequenceId = {
             sequenceNumber: this.minimumSequenceNumber,
@@ -240,118 +180,72 @@ export class EditManager {
             const sequenceIdBeforeMinimumBranchBase = getUpperBoundOfPreviousSequenceId(minimumBranchBaseSequenceId);
             trunkTailSequenceId = minSequenceId(trunkTailSequenceId, sequenceIdBeforeMinimumBranchBase);
         }
-        const [sequenceId, latestEvicted] = this.getClosestTrunkCommit(maxSequenceId(trunkTailSequenceId, this.sequenceMap.minKey() ?? minimumPossibleSequenceId));
+        const mainBranch = this.getSharedBranch("main");
+        const [sequenceId, latestEvicted] = mainBranch.getClosestTrunkCommit(maxSequenceId(trunkTailSequenceId, mainBranch.sequenceIdToCommit.minKey() ?? minimumPossibleSequenceId));
         // Don't do any work if the commit found by the search is already the tail of the trunk
-        if (latestEvicted !== this.trunkBase) {
-            // The minimum sequence number informs us that all peer branches are at least caught up to the tail commit,
-            // so rebase them accordingly. This is necessary to prevent peer branches from referencing any evicted commits.
-            for (const [, branch] of this.peerLocalBranches) {
-                branch.rebaseOnto(this.trunk, latestEvicted);
-            }
-            // This mutation is a performance hack. If commits are truly immutable, then changing the trunk's tail requires
-            // regenerating the entire commit graph. Instead, we can simply chop off the tail like this if we're certain
-            // that there are no outstanding references to any of the commits being removed (other than the references via
-            // the trunk). The peer branches have been rebased to the head of the trunk, the local branch is already rebased
-            // to the head of the trunk, and all other branches are tracked by `trunkBranches` and known to be ahead of or at
-            // `newTrunkBase`. Therefore, no branches should have unique references to any of the commits being evicted here.
-            // We mutate the most recent of the evicted commits to become the new trunk base. That way, any other commits that
-            // have parent pointers to the latest evicted commit will stay linked, even though that it is no longer part of the trunk.
-            const newTrunkBase = latestEvicted;
-            // The metadata for new trunk base revision needs to be deleted before modifying it.
-            this.trunkMetadata.delete(newTrunkBase.revision);
-            // collect the revisions that will be trimmed to send as part of the branch trimmed event
-            const trimmedRevisions = getPathFromBase(newTrunkBase, this.trunkBase).map((c) => c.revision);
-            // Dropping the parent field removes (transitively) all references to the evicted commits so they can be garbage collected.
-            delete newTrunkBase.parent;
-            this.trunkBase = newTrunkBase;
-            // Update any state that is derived from trunk commits
-            this.sequenceMap.editRange(minimumPossibleSequenceId, sequenceId, true, (s, commit) => {
-                // Cleanup look-aside data for each evicted commit
-                this.trunkMetadata.delete(commit.revision);
-                // Delete all evicted commits from `sequenceMap` except for the latest one, which is the new `trunkBase`
-                if (equalSequenceIds(s, sequenceId)) {
-                    assert(commit === newTrunkBase, 0x729 /* Expected last evicted commit to be new trunk base */);
-                }
-                else {
-                    Reflect.defineProperty(commit, "change", {
-                        get: () => assert(false, 0xa5e /* Should not access 'change' property of an evicted commit */),
-                    });
-                    Reflect.defineProperty(commit, "revision", {
-                        get: () => assert(false, 0xa5f /* Should not access 'revision' property of an evicted commit */),
-                    });
-                    Reflect.defineProperty(commit, "parent", {
-                        get: () => assert(false, 0xa60 /* Should not access 'parent' property of an evicted commit */),
-                    });
-                    return { delete: true };
-                }
+        if (latestEvicted === this.trunkBase) {
+            return;
+        }
+        // This mutation is a performance hack. If commits are truly immutable, then changing the trunk's tail requires
+        // regenerating the entire commit graph. Instead, we can simply chop off the tail like this if we're certain
+        // that there are no outstanding references to any of the commits being removed (other than the references via
+        // the trunk). The peer branches have been rebased to the head of the trunk, the local branch is already rebased
+        // to the head of the trunk, and all other branches are tracked by `trunkBranches` and known to be ahead of or at
+        // `newTrunkBase`. Therefore, no branches should have unique references to any of the commits being evicted here.
+        // We mutate the most recent of the evicted commits to become the new trunk base. That way, any other commits that
+        // have parent pointers to the latest evicted commit will stay linked, even though that it is no longer part of the trunk.
+        const newTrunkBase = latestEvicted;
+        // collect the revisions that will be trimmed to send as part of the branch trimmed event
+        const trimmedCommits = getPathFromBase(newTrunkBase, this.trunkBase);
+        const trimmedRevisions = trimmedCommits.map((c) => c.revision);
+        // The minimum sequence number informs us that all peer branches are at least caught up to the tail commit,
+        // so rebase them accordingly. This is necessary to prevent peer branches from referencing any evicted commits.
+        mainBranch.trimHistory(latestEvicted, sequenceId);
+        // Only the last trimmed commit, which is the new trunk base, should remain accessible.
+        for (const commit of trimmedCommits.slice(0, -1)) {
+            Reflect.defineProperty(commit, "change", {
+                get: () => assert(false, 0xa5e /* Should not access 'change' property of an evicted commit */),
+            });
+            Reflect.defineProperty(commit, "revision", {
+                get: () => assert(false, 0xa5f /* Should not access 'revision' property of an evicted commit */),
+            });
+            Reflect.defineProperty(commit, "parent", {
+                get: () => assert(false, 0xa60 /* Should not access 'parent' property of an evicted commit */),
             });
-            const trunkSize = getPathFromBase(this.trunk.getHead(), this.trunkBase).length;
-            assert(this.sequenceMap.size === trunkSize + 1, 0x744 /* The size of the sequenceMap must have one element more than the trunk */);
-            assert(this.trunkMetadata.size === trunkSize, 0x745 /* The size of the trunkMetadata must be the same as the trunk */);
-            this._events.emit("ancestryTrimmed", trimmedRevisions);
         }
+        // Dropping the parent field removes (transitively) all references to the evicted commits so they can be garbage collected.
+        delete newTrunkBase.parent;
+        this.trunkBase = newTrunkBase;
+        this._events.emit("ancestryTrimmed", trimmedRevisions);
     }
     isEmpty() {
-        return (this.trunk.getHead() === this.trunkBase &&
-            this.peerLocalBranches.size === 0 &&
-            this.localBranch.getHead() === this.trunk.getHead() &&
-            this.minimumSequenceNumber === minimumPossibleSequenceNumber);
+        for (const branch of this.sharedBranches.values()) {
+            if (!branch.isEmpty(this.trunkBase)) {
+                return false;
+            }
+        }
+        return this.minimumSequenceNumber === minimumPossibleSequenceNumber;
     }
     getSummaryData() {
-        // The assert below is acceptable at present because summarization only ever occurs on a client with no
-        // local/in-flight changes.
-        // In the future we may wish to relax this constraint. For that to work, the current implementation of
-        // `EditManager` would have to be amended in one of two ways:
-        // A) Changes made by the local session should be represented by a branch in `EditManager.branches`.
-        // B) The contents of such a branch should be computed on demand based on the trunk.
-        // Note that option (A) would be a simple change to `addSequencedChanges` whereas (B) would likely require
-        // rebasing trunk changes over the inverse of trunk changes.
-        assert(this.localBranch.getHead() === this.trunk.getHead(), 0x428 /* Clients with local changes cannot be used to generate summaries */);
         // Trimming the trunk before serializing ensures that the trunk data in the summary is as minimal as possible.
-        this.trimTrunk();
-        let oldestCommitInCollabWindow = this.getClosestTrunkCommit(this.minimumSequenceNumber)[1];
-        assert(oldestCommitInCollabWindow.parent !== undefined ||
-            oldestCommitInCollabWindow === this.trunkBase, 0x8c7 /* Expected oldest commit in collab window to have a parent or be the trunk base */);
-        // Path construction is exclusive, so we need to use the parent of the oldest commit in the window if it exists
-        oldestCommitInCollabWindow =
-            oldestCommitInCollabWindow.parent ?? oldestCommitInCollabWindow;
-        const trunk = getPathFromBase(this.trunk.getHead(), oldestCommitInCollabWindow).map((c) => {
-            assert(c !== this.trunkBase, 0xa61 /* Serialized trunk should not include the trunk base */);
-            const metadata = this.trunkMetadata.get(c.revision) ??
-                fail(0xad5 /* Expected metadata for trunk commit */);
-            const commit = {
-                change: c.change,
-                revision: c.revision,
-                sequenceNumber: metadata.sequenceId.sequenceNumber,
-                sessionId: metadata.sessionId,
-            };
-            if (metadata.sequenceId.indexInBatch !== undefined) {
-                commit.indexInBatch = metadata.sequenceId.indexInBatch;
+        this.trimHistory();
+        const minSeqNumberToSummarize = {
+            sequenceNumber: brand(this.minimumSequenceNumber + 1),
+        };
+        let minBaseSeqId = minSeqNumberToSummarize;
+        const mainBranch = this.getSharedBranch("main");
+        const branches = new Map();
+        for (const [branchId, branch] of this.sharedBranches) {
+            if (branchId !== "main") {
+                const branchSummary = branch.getSummaryData(minSeqNumberToSummarize, this.trunkBase.revision);
+                branches.set(branchId, branchSummary);
+                assert(branchSummary.base !== undefined, "Branch summary must have a base");
+                const baseSequenceId = mainBranch.getCommitSequenceId(branchSummary.base);
+                minBaseSeqId = minSequenceId(minBaseSeqId, baseSequenceId);
             }
-            return commit;
-        });
-        const peerLocalBranches = new Map(mapIterable(this.peerLocalBranches.entries(), ([sessionId, branch]) => {
-            const branchPath = [];
-            const ancestor = findCommonAncestor([branch.getHead(), branchPath], this.trunk.getHead()) ??
-                fail(0xad6 /* Expected branch to be based on trunk */);
-            const base = ancestor === this.trunkBase ? rootRevision : ancestor.revision;
-            return [
-                sessionId,
-                {
-                    base,
-                    commits: branchPath.map((c) => {
-                        assert(c !== this.trunkBase, 0xa62 /* Serialized branch should not include the trunk base */);
-                        const commit = {
-                            change: c.change,
-                            revision: c.revision,
-                            sessionId,
-                        };
-                        return commit;
-                    }),
-                },
-            ];
-        }));
-        return { trunk, peerLocalBranches };
+        }
+        const mainSummary = mainBranch.getSummaryData(minBaseSeqId, this.trunkBase.revision);
+        return { main: mainSummary, branches, originator: this.localSessionId };
     }
     loadSummaryData(data) {
         assert(this.isEmpty(), 0x68a /* Attempted to load from summary after edit manager was already mutated */);
@@ -359,53 +253,30 @@ export class EditManager {
         // when hydrating the peer branches below
         const trunkRevisionCache = new Map();
         trunkRevisionCache.set(this.trunkBase.revision, this.trunkBase);
-        this.trunk.setHead(data.trunk.reduce((base, c) => {
-            const sequenceId = c.indexInBatch === undefined
-                ? {
-                    sequenceNumber: c.sequenceNumber,
-                }
-                : {
-                    sequenceNumber: c.sequenceNumber,
-                    indexInBatch: c.indexInBatch,
-                };
-            const commit = mintCommit(base, c);
-            this.sequenceMap.set(sequenceId, commit);
-            this.trunkMetadata.set(c.revision, {
-                sequenceId,
-                sessionId: c.sessionId,
-            });
-            trunkRevisionCache.set(c.revision, commit);
-            return commit;
-        }, this.trunkBase));
-        this.localBranch.setHead(this.trunk.getHead());
-        for (const [sessionId, branch] of data.peerLocalBranches) {
-            const commit = trunkRevisionCache.get(branch.base) ??
-                fail(0xad7 /* Expected summary branch to be based off of a revision in the trunk */);
-            this.peerLocalBranches.set(sessionId, new SharedTreeBranch(branch.commits.reduce(mintCommit, commit), this.changeFamily, this.mintRevisionTag));
-        }
-    }
-    getCommitSequenceId(trunkCommitOrTrunkBase) {
-        const id = this.trunkMetadata.get(trunkCommitOrTrunkBase.revision)?.sequenceId;
-        if (id === undefined) {
-            assert(trunkCommitOrTrunkBase === this.trunkBase, 0xa63 /* Commit must be either be on the trunk or be the trunk base */);
-            return minimumPossibleSequenceId;
+        const mainBranch = this.sharedBranches.get("main") ?? fail("Main branch must exist");
+        mainBranch.loadSummaryData(data.main, trunkRevisionCache);
+        if (data.branches !== undefined) {
+            for (const [branchId, branchData] of data.branches) {
+                const branch = this.createSharedBranch(branchId, branchData.session, mainBranch, mainBranch.trunk.fork());
+                branch.loadSummaryData(branchData, trunkRevisionCache);
+            }
         }
-        return id;
     }
-    getTrunkChanges() {
-        return this.getTrunkCommits().map((c) => c.change);
+    getTrunkHead(branchId) {
+        return this.getSharedBranch(branchId).trunk.getHead();
     }
-    getTrunkCommits() {
-        return getPathFromBase(this.trunk.getHead(), this.trunkBase);
+    getTrunkChanges(branchId) {
+        return this.getTrunkCommits(branchId).map((c) => c.change);
     }
-    getTrunkHead() {
-        return this.trunk.getHead();
+    getTrunkCommits(branchId) {
+        return getPathFromBase(this.getTrunkHead(branchId), this.trunkBase);
     }
-    getLocalChanges() {
-        return this.getLocalCommits().map((c) => c.change);
+    getLocalChanges(branchId) {
+        return this.getLocalCommits(branchId).map((c) => c.change);
     }
-    getLocalCommits() {
-        return this.localCommits;
+    getLocalCommits(branchId) {
+        const branch = this.getSharedBranch(branchId);
+        return branch.getLocalCommits();
     }
     /**
      * Gets the length of the longest branch maintained by this `EditManager`.
@@ -417,15 +288,36 @@ export class EditManager {
      */
     getLongestBranchLength() {
         let max = 0;
-        const trunkHead = this.trunk.getHead();
-        for (const branch of this.peerLocalBranches.values()) {
-            const branchPath = getPathFromBase(branch.getHead(), trunkHead);
-            if (branchPath.length > max) {
-                max = branchPath.length;
-            }
+        for (const branch of this.sharedBranches.values()) {
+            max = Math.max(max, branch.getLongestBranchLength());
         }
-        const localPath = getPathFromBase(this.localBranch.getHead(), trunkHead);
-        return Math.max(max, localPath.length);
+        return max;
+    }
+    sequenceBranchCreation(sessionId, referenceSequenceNumber, branchId) {
+        if (sessionId === this.localSessionId) {
+            assert(this.sharedBranches.has(branchId), "Expected branch to already exist");
+            return;
+        }
+        const mainBranch = this.getSharedBranch("main");
+        const branchTrunk = mainBranch.rebasePeer(sessionId, referenceSequenceNumber).fork();
+        const sharedBranch = this.createSharedBranch(branchId, sessionId, mainBranch, branchTrunk);
+        this.registerBranch(sharedBranch.localBranch);
+        onForkTransitive(sharedBranch.localBranch, (fork) => this.registerBranch(fork));
+    }
+    addBranch(branchId) {
+        const main = this.getSharedBranch("main") ?? fail("Main branch must exist");
+        this.createSharedBranch(branchId, this.localSessionId, main, this.getLocalBranch("main").fork());
+    }
+    removeBranch(branchId) {
+        assert(branchId !== "main", "Cannot remove main branch");
+        const hadBranch = this.sharedBranches.delete(branchId);
+        assert(hadBranch, "Expected branch to exist");
+    }
+    createSharedBranch(branchId, sessionId, parent, branch) {
+        const sharedBranch = new SharedBranch(parent, branch, branchId, sessionId, minimumPossibleSequenceId, this.changeFamily, this.mintRevisionTag, this._events, this.telemetryEventBatcher);
+        assert(!this.sharedBranches.has(branchId), "A branch with this ID already exists");
+        this.sharedBranches.set(branchId, sharedBranch);
+        return sharedBranch;
     }
     /* eslint-disable jsdoc/check-indentation */
     /**
@@ -438,34 +330,118 @@ export class EditManager {
      *   - They are not interleaved with messages from other clients.
      */
     /* eslint-enable jsdoc/check-indentation */
-    addSequencedChanges(newCommits, sessionId, sequenceNumber, referenceSequenceNumber) {
+    addSequencedChanges(newCommits, sessionId, sequenceNumber, referenceSequenceNumber, branchId = "main") {
         assert(newCommits.length > 0, 0xad8 /* Expected at least one sequenced change */);
         assert(sequenceNumber > this.minimumSequenceNumber, 0x713 /* Expected change sequence number to exceed the last known minimum sequence number */);
-        assert(sequenceNumber >= // This is ">=", not ">" because changes in the same batch will have the same sequence number
-            (this.sequenceMap.maxKey()?.sequenceNumber ?? minimumPossibleSequenceNumber), 0xa64 /* Attempted to sequence change with an outdated sequence number */);
-        // Returns the sequence id for the next commit to be processed in the bunch. Since all the commits have the
-        // same sequence number, only the index in the batch needs to be incremented.
-        const getNextSequenceId = (sequenceId) => {
-            return {
-                sequenceNumber: sequenceId.sequenceNumber,
-                indexInBatch: (sequenceId.indexInBatch ?? 0) + 1,
-            };
+        const branch = this.getSharedBranch(branchId);
+        const onSequenceLocalCommit = (commit, sequenceId, previousSequenceId) => {
+            // Next, we need to update the sequence IDs that our local branches (user's branches, not peer branches) are associated with.
+            // In particular, if a local branch is based on the previous trunk head (the branch's first ancestor in the trunk is the commit that was the head before we pushed the new commit)
+            // and also branches off of the local branch (it has an ancestor that is part of the local branch), it needs to have its sequence number advanced to be that of the new trunk head.
+            // Intuitively, this makes sense because:
+            // 1. The trunk's head just advanced forward by some (sequence) amount.
+            // 2. The local branch is always rebased to be branching off of the head of the trunk (not literally in this case, because of the optimization, but in effect).
+            // 3. Therefore, the entire local branch just advanced forward by some (sequence) amount, and any commits downstream of it which track the sequence numbers of their base commits on the trunk should also advance.
+            // This update is not necessarily required for all local branches, since some may have fallen behind the local branch and are based on older trunk commits (such branches do not need updating).
+            const currentBranches = this.trunkBranches.get(previousSequenceId);
+            if (currentBranches !== undefined) {
+                const newBranches = getOrCreate(this.trunkBranches, sequenceId, () => new Set());
+                for (const forkedBranch of currentBranches) {
+                    // Check every branch associated with the old sequence ID and advance it if it is based on the local branch (specifically, on the local branch as it was before we pushed its first commit to the trunk).
+                    // We validate this by checking if the branch's head is a descendant of the local commit that we just pushed.
+                    if (findAncestor(forkedBranch.getHead(), (c) => c === commit) !== undefined) {
+                        newBranches.add(forkedBranch);
+                        currentBranches.delete(forkedBranch);
+                    }
+                }
+                // Clean up our trunk branches map by removing any empty sets.
+                if (currentBranches.size === 0) {
+                    this.trunkBranches.delete(previousSequenceId);
+                }
+                if (newBranches.size === 0) {
+                    this.trunkBranches.delete(sequenceId);
+                }
+            }
         };
-        const commitsSequenceNumber = this.getBatch(sequenceNumber);
+        const areLocalCommits = sessionId === this.localSessionId;
+        branch.addSequencedChanges(newCommits, sessionId, sequenceNumber, areLocalCommits, referenceSequenceNumber, onSequenceLocalCommit);
+    }
+    findLocalCommit(branchId, revision) {
+        const commits = [];
+        const commit = findAncestor([this.getSharedBranch(branchId).localBranch.getHead(), commits], (c) => c.revision === revision);
+        assert(commit !== undefined, 0x599 /* Expected local branch to contain revision */);
+        return [commit, commits];
+    }
+}
+/**
+ * Gets the path from the base of a branch to its head.
+ */
+function getPathFromBase(branchHead, baseBranchHead) {
+    const path = [];
+    assert(findCommonAncestor([branchHead, path], baseBranchHead) !== undefined, 0x573 /* Expected branches to be related */);
+    return path;
+}
+class SharedBranch {
+    constructor(parentBranch, trunk, id, sessionId, baseCommitSequenceId, changeFamily, mintRevisionTag, branchTrimmer, telemetryEventBatcher) {
+        this.parentBranch = parentBranch;
+        this.trunk = trunk;
+        this.id = id;
+        this.sessionId = sessionId;
+        this.changeFamily = changeFamily;
+        this.mintRevisionTag = mintRevisionTag;
+        /**
+         * Branches are maintained to represent the local change list that the issuing client had
+         * at the time of submitting the latest known edit on the branch.
+         * This means the head commit of each branch is always in its original (non-rebased) form.
+         */
+        this.peerLocalBranches = new Map();
+        /**
+         * A map from a sequence id to the commit which has that sequence id.
+         * This also includes an entry for the {@link trunkBase} which always has the lowest key in the map.
+         */
+        this.sequenceIdToCommit = new BTree(undefined, sequenceIdComparator);
+        /**
+         * The list of commits (from oldest to most recent) that are on the local branch but not on the trunk.
+         * When a local commit is sequenced, the first commit in this list shifted onto the tip of the trunk.
+         */
+        this.localCommits = [];
+        /**
+         * Records extra data associated with sequenced commits.
+         * This does not include an entry for the {@link trunkBase}.
+         */
+        this.commitMetadata = new Map();
+        this.localBranch = new SharedTreeBranch(this.trunk.getHead(), changeFamily, mintRevisionTag, branchTrimmer, telemetryEventBatcher);
+        this.sequenceIdToCommit.set(baseCommitSequenceId, this.trunk.getHead());
+        this.localBranch.events.on("afterChange", (event) => {
+            if (event.type === "append") {
+                for (const commit of event.newCommits) {
+                    this.localCommits.push(commit);
+                }
+            }
+            else {
+                this.localCommits.length = 0;
+                findCommonAncestor([this.localBranch.getHead(), this.localCommits], this.trunk.getHead());
+            }
+        });
+    }
+    addSequencedChanges(newCommits, sessionId, sequenceNumber, areLocalCommits, referenceSequenceNumber, onSequenceLocalCommit) {
+        assert(sequenceNumber >= // This is ">=", not ">" because changes in the same batch will have the same sequence number
+            (this.sequenceIdToCommit.maxKey()?.sequenceNumber ?? minimumPossibleSequenceNumber), 0xa64 /* Attempted to sequence change with an outdated sequence number */);
+        const batchSize = this.getBatchSize(sequenceNumber);
         // The sequence id for the next commit to be processed in the bunch.
-        let nextSequenceId = commitsSequenceNumber.length === 0
+        let nextSequenceId = batchSize === 0
             ? {
                 sequenceNumber,
             }
             : {
                 sequenceNumber,
-                indexInBatch: commitsSequenceNumber.length,
+                indexInBatch: batchSize,
             };
         // Local changes, i.e., changes from this client are applied by fast forwarding the local branch commit onto
         // the trunk.
-        if (sessionId === this.localSessionId) {
+        if (areLocalCommits) {
             for (const _ of newCommits) {
-                this.fastForwardNextLocalCommit(nextSequenceId);
+                this.sequenceLocalCommit(nextSequenceId, sessionId, onSequenceLocalCommit);
                 nextSequenceId = getNextSequenceId(nextSequenceId);
             }
             return;
@@ -475,9 +451,7 @@ export class EditManager {
         // Get the revision that the remote change is based on and rebase that peer local branch over the part of the
         // trunk up to the base revision. This will be a no-op if the sending client has not advanced since the last
         // time we received an edit from it
-        const [, baseRevisionInTrunk] = this.getClosestTrunkCommit(referenceSequenceNumber);
-        const peerLocalBranch = getOrCreate(this.peerLocalBranches, sessionId, () => new SharedTreeBranch(baseRevisionInTrunk, this.changeFamily, this.mintRevisionTag));
-        peerLocalBranch.rebaseOnto(this.trunk, baseRevisionInTrunk);
+        const peerLocalBranch = this.rebasePeer(sessionId, referenceSequenceNumber);
         // Step 2 - Append the changes to the peer branch and rebase the changes to the tip of the trunk.
         if (peerLocalBranch.getHead() === this.trunk.getHead()) {
             // If the peer local branch is fully caught up and empty (no changes relative to the trunk) after being
@@ -498,8 +472,8 @@ export class EditManager {
                 // If the merge resulted in any changes to the trunk, update the sequence map and trunk metadata
                 // with the rebased commits.
                 for (const sourceCommit of result.sourceCommits) {
-                    this.sequenceMap.set(nextSequenceId, sourceCommit);
-                    this.trunkMetadata.set(sourceCommit.revision, {
+                    this.sequenceIdToCommit.set(nextSequenceId, sourceCommit);
+                    this.commitMetadata.set(sourceCommit.revision, {
                         sequenceId: nextSequenceId,
                         sessionId,
                     });
@@ -510,21 +484,85 @@ export class EditManager {
         // Step 3 - Rebase the local branch over the updated trunk.
         this.localBranch.rebaseOnto(this.trunk);
     }
-    findLocalCommit(revision) {
-        const commits = [];
-        const commit = findAncestor([this.localBranch.getHead(), commits], (c) => c.revision === revision);
-        assert(commit !== undefined, 0x599 /* Expected local branch to contain revision */);
-        return [commit, commits];
+    isEmpty(baseCommit) {
+        return (this.trunk.getHead() === baseCommit &&
+            this.peerLocalBranches.size === 0 &&
+            this.localBranch.getHead() === this.trunk.getHead());
     }
-    pushCommitToTrunk(sequenceId, commit) {
-        const mintedCommit = mintCommit(this.trunk.getHead(), commit);
-        this.pushGraphCommitToTrunk(sequenceId, mintedCommit, commit.sessionId);
+    rebasePeer(sessionId, referenceSequenceNumber) {
+        const [, baseRevisionInTrunk] = this.getClosestTrunkCommit(referenceSequenceNumber);
+        const peerLocalBranch = getOrCreate(this.peerLocalBranches, sessionId, () => new SharedTreeBranch(baseRevisionInTrunk, this.changeFamily, this.mintRevisionTag));
+        peerLocalBranch.rebaseOnto(this.trunk, baseRevisionInTrunk);
+        return peerLocalBranch;
     }
-    pushGraphCommitToTrunk(sequenceId, graphCommit, sessionId) {
-        this.trunk.setHead(graphCommit);
+    getPeerBranchOrTrunk(sessionId) {
+        return this.peerLocalBranches.get(sessionId) ?? this.trunk;
+    }
+    /**
+     * Gets the length of the longest branch maintained by this `SharedBranch`.
+     * This may be the length of a peer branch or the local branch.
+     *
+     * @remarks
+     * The length is counted from the lowest common ancestor with the trunk such that a fully sequenced branch would
+     * have length zero.
+     */
+    getLongestBranchLength() {
+        let max = 0;
         const trunkHead = this.trunk.getHead();
-        this.sequenceMap.set(sequenceId, trunkHead);
-        this.trunkMetadata.set(trunkHead.revision, { sequenceId, sessionId });
+        for (const branch of this.peerLocalBranches.values()) {
+            const branchPath = getPathFromBase(branch.getHead(), trunkHead);
+            if (branchPath.length > max) {
+                max = branchPath.length;
+            }
+        }
+        const localPath = getPathFromBase(this.localBranch.getHead(), trunkHead);
+        return Math.max(max, localPath.length);
+    }
+    trimHistory(newBase, sequenceId) {
+        this.rebasePeers(newBase);
+        this.sequenceIdToCommit.editRange(minimumPossibleSequenceId, sequenceId, true, (s, commit) => {
+            // Cleanup look-aside data for each evicted commit
+            this.commitMetadata.delete(commit.revision);
+            // Delete all evicted commits from `sequenceMap` except for the latest one, which is the new `trunkBase`
+            if (equalSequenceIds(s, sequenceId)) {
+                assert(commit === newBase, 0x729 /* Expected last evicted commit to be new trunk base */);
+            }
+            else {
+                return { delete: true };
+            }
+        });
+        const trunkSize = getPathFromBase(this.trunk.getHead(), newBase).length;
+        assert(this.sequenceIdToCommit.size === trunkSize + 1, 0x744 /* The size of the sequenceMap must have one element more than the trunk */);
+        assert(this.commitMetadata.size === trunkSize, 0x745 /* The size of the trunkMetadata must be the same as the trunk */);
+    }
+    rebasePeers(commit) {
+        for (const [, branch] of this.peerLocalBranches) {
+            branch.rebaseOnto(this.trunk, commit);
+        }
+        // The metadata for new trunk base revision needs to be deleted before modifying it.
+        this.commitMetadata.delete(commit.revision);
+    }
+    getLocalCommits() {
+        return this.localCommits;
+    }
+    /**
+     * Promote the oldest un-sequenced commit on the local branch to the head of the trunk.
+     * @param sequenceId - The sequence id of the new trunk commit
+     * @remarks This method is a performance optimization for the scenario where this client receives its own change back after sequencing.
+     * The normal (not optimized) process in this case would be to apply the new sequenced commit to the trunk and then rebase the local branch over the trunk.
+     * The first commit will be "the same" (as in, it will have the same revision) as the commit that was just sequenced, so the rebase will be a no-op.
+     * Because the rebase is a no-op, we can skip it entirely and simply remove the commit from the local branch and append it to the trunk.
+     * Avoiding the overhead of the rebase process, even when it's a no-op, has real measured performance benefits and is worth the added complexity here.
+     */
+    sequenceLocalCommit(sequenceId, sessionId, onSequenceLocalCommit) {
+        // First, push the local commit to the trunk.
+        // We are mutating our `localCommits` cache here,but there is no need to actually change the `localBranch` itself because it will simply catch up later if/when it next rebases.
+        const firstLocalCommit = this.localCommits.shift();
+        assert(firstLocalCommit !== undefined, 0x6b5 /* Received a sequenced change from the local session despite having no local changes */);
+        const prevSequenceId = this.getCommitSequenceId(this.trunk.getHead().revision);
+        this.pushGraphCommitToTrunk(sequenceId, firstLocalCommit, sessionId);
+        onSequenceLocalCommit(firstLocalCommit, sequenceId, prevSequenceId);
+        return firstLocalCommit;
     }
     getClosestTrunkCommit(searchBy) {
         const sequenceId = typeof searchBy === "number"
@@ -536,26 +574,135 @@ export class EditManager {
                 indexInBatch: Number.POSITIVE_INFINITY,
             }
             : searchBy;
-        const commit = this.sequenceMap.getPairOrNextLower(sequenceId);
+        const commit = this.sequenceIdToCommit.getPairOrNextLower(sequenceId);
         assert(commit !== undefined, 0x746 /* sequence id has been evicted */);
         return commit;
     }
-    getBatch(sequenceNumber) {
+    pushGraphCommitToTrunk(sequenceId, graphCommit, sessionId) {
+        this.trunk.setHead(graphCommit);
+        this.registerSequencedCommit(sequenceId, sessionId, graphCommit);
+    }
+    pushCommitToTrunk(sequenceId, commit) {
+        const mintedCommit = mintCommit(this.trunk.getHead(), commit);
+        this.pushGraphCommitToTrunk(sequenceId, mintedCommit, commit.sessionId);
+    }
+    registerSequencedCommit(sequenceId, sessionId, commit) {
+        this.sequenceIdToCommit.set(sequenceId, commit);
+        this.commitMetadata.set(commit.revision, { sequenceId, sessionId });
+    }
+    getCommitSequenceId(commitRevision) {
+        const id = this.commitMetadata.get(commitRevision)?.sequenceId;
+        if (id === undefined) {
+            return minimumPossibleSequenceId;
+        }
+        return id;
+    }
+    // TODO: Document that this is to handle receiving separate commits with the same sequence ID,
+    // as a batch of changes are not guaranteed to be processed as one bunch.
+    getBatchSize(sequenceNumber) {
         const startSequenceId = {
             sequenceNumber,
         };
         const endSequenceId = {
             sequenceNumber: brand(sequenceNumber + 1),
         };
-        return this.sequenceMap.getRange(startSequenceId, endSequenceId, false);
+        return this.sequenceIdToCommit.getRange(startSequenceId, endSequenceId, false).length;
+    }
+    getSummaryData(minSeqNumberToSummarize, trunkBaseRevision) {
+        // The assert below is acceptable at present because summarization only ever occurs on a client with no
+        // local/in-flight changes.
+        // In the future we may wish to relax this constraint. For that to work, the current implementation of
+        // `EditManager` would have to be amended in one of two ways:
+        // A) Changes made by the local session should be represented by a branch in `EditManager.branches`.
+        // B) The contents of such a branch should be computed on demand based on the trunk.
+        // Note that option (A) would be a simple change to `addSequencedChanges` whereas (B) would likely require
+        // rebasing trunk changes over the inverse of trunk changes.
+        assert(this.localBranch.getHead() === this.trunk.getHead(), "Clients with local changes cannot be used to generate summaries");
+        let parentHead;
+        if (this.parentBranch === undefined) {
+            const oldestCommitInCollabWindow = this.getClosestTrunkCommit(minSeqNumberToSummarize)[1];
+            // Path construction is exclusive, so we need to use the parent of the oldest commit in the window if it exists
+            parentHead = oldestCommitInCollabWindow.parent ?? oldestCommitInCollabWindow;
+        }
+        else {
+            parentHead = this.parentBranch.trunk.getHead();
+        }
+        const childBranchTrunkCommits = [];
+        const forkPointFromMainTrunk = findCommonAncestor([this.trunk.getHead(), childBranchTrunkCommits], parentHead);
+        assert(forkPointFromMainTrunk !== undefined, "Expected child branch to be based on main branch");
+        const trunk = childBranchTrunkCommits.map((c) => {
+            const metadata = this.commitMetadata.get(c.revision) ??
+                fail(0xad5 /* Expected metadata for trunk commit */);
+            const commit = {
+                change: c.change,
+                revision: c.revision,
+                sequenceNumber: metadata.sequenceId.sequenceNumber,
+                sessionId: metadata.sessionId,
+            };
+            if (metadata.sequenceId.indexInBatch !== undefined) {
+                commit.indexInBatch = metadata.sequenceId.indexInBatch;
+            }
+            return commit;
+        });
+        const peerLocalBranches = new Map(mapIterable(this.peerLocalBranches.entries(), ([sessionId, branch]) => {
+            const branchPath = [];
+            const ancestor = findCommonAncestor([branch.getHead(), branchPath], this.trunk.getHead()) ??
+                fail(0xad6 /* Expected branch to be based on trunk */);
+            const base = ancestor.revision === trunkBaseRevision ? rootRevision : ancestor.revision;
+            return [
+                sessionId,
+                {
+                    base,
+                    commits: branchPath.map((c) => {
+                        const commit = {
+                            change: c.change,
+                            revision: c.revision,
+                            sessionId,
+                        };
+                        return commit;
+                    }),
+                },
+            ];
+        }));
+        const trunkBase = this.parentBranch === undefined ? undefined : forkPointFromMainTrunk.revision;
+        return { trunk, peerLocalBranches, base: trunkBase, id: this.id, session: this.sessionId };
+    }
+    loadSummaryData(data, trunkRevisionCache) {
+        assert((this.parentBranch === undefined) === (data.base === undefined), "Expected branch base to match presence of parent branch");
+        const parentTrunkBase = trunkRevisionCache.get(data.base ?? rootRevision) ??
+            fail("Expected base revision to be in trunk cache");
+        this.trunk.setHead(data.trunk.reduce((base, c) => {
+            const sequenceId = c.indexInBatch === undefined
+                ? {
+                    sequenceNumber: c.sequenceNumber,
+                }
+                : {
+                    sequenceNumber: c.sequenceNumber,
+                    indexInBatch: c.indexInBatch,
+                };
+            const commit = mintCommit(base, c);
+            this.sequenceIdToCommit.set(sequenceId, commit);
+            this.commitMetadata.set(c.revision, {
+                sequenceId,
+                sessionId: c.sessionId,
+            });
+            trunkRevisionCache.set(c.revision, commit);
+            return commit;
+        }, parentTrunkBase));
+        this.localBranch.setHead(this.trunk.getHead());
+        for (const [sessionId, branch] of data.peerLocalBranches) {
+            const commit = trunkRevisionCache.get(branch.base) ??
+                fail(0xad7 /* Expected summary branch to be based off of a revision in the trunk */);
+            this.peerLocalBranches.set(sessionId, new SharedTreeBranch(branch.commits.reduce(mintCommit, commit), this.changeFamily, this.mintRevisionTag));
+        }
     }
 }
-/**
- * Gets the path from the base of a branch to its head.
- */
-function getPathFromBase(branchHead, baseBranchHead) {
-    const path = [];
-    assert(findCommonAncestor([branchHead, path], baseBranchHead) !== undefined, 0x573 /* Expected branches to be related */);
-    return path;
+// Returns the sequence id for the next commit to be processed in the bunch. Since all the commits have the
+// same sequence number, only the index in the batch needs to be incremented.
+function getNextSequenceId(sequenceId) {
+    return {
+        sequenceNumber: sequenceId.sequenceNumber,
+        indexInBatch: (sequenceId.indexInBatch ?? 0) + 1,
+    };
 }
 //# sourceMappingURL=editManager.js.map