@fluidframework/tree 2.61.0 → 2.62.0

package/lib/shared-tree-core/editManager.d.ts

@@ -4,8 +4,8 @@
  */
 import type { SessionId } from "@fluidframework/id-compressor";
 import { type ChangeFamily, type ChangeFamilyEditor, type GraphCommit, type RevisionTag } from "../core/index.js";
-import { SharedTreeBranch } from "./branch.js";
-import type { SeqNumber, SequencedCommit, SummarySessionBranch } from "./editManagerFormat.js";
+import { SharedTreeBranch, type BranchId } from "./branch.js";
+import type { SeqNumber, SequencedCommit, SummarySessionBranch } from "./editManagerFormatCommons.js";
 import { type ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 export declare const minimumPossibleSequenceNumber: SeqNumber;
 /**
@@ -16,32 +16,13 @@ export declare class EditManager<TEditor extends ChangeFamilyEditor, TChangeset,
     readonly changeFamily: TChangeFamily;
     readonly localSessionId: SessionId;
     private readonly mintRevisionTag;
+    private readonly onSharedBranchCreated?;
     private readonly _events;
-    /** The "trunk" branch. The trunk represents the list of received sequenced changes. */
-    private readonly trunk;
+    private readonly sharedBranches;
     /**
-     * Records extra data associated with commits in the {@link trunk}.
-     * This does not include an entry for the {@link trunkBase}.
-     */
-    private readonly trunkMetadata;
-    /**
-     * 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.
-     */
-    private readonly sequenceMap;
-    /**
-     * 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.
-     */
-    private readonly peerLocalBranches;
-    /**
-     * This branch holds the changes made by this client which have not yet been confirmed as sequenced changes.
-     */
-    readonly localBranch: SharedTreeBranch<TEditor, TChangeset>;
-    /**
-     * 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.
@@ -61,17 +42,16 @@ export declare class EditManager<TEditor extends ChangeFamilyEditor, TChangeset,
      * Each time trunk eviction occurs, the most recent evicted commit becomes the new `trunkBase`.
      */
     private trunkBase;
-    /**
-     * 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.
-     */
-    private readonly localCommits;
     private readonly telemetryEventBatcher;
     /**
      * @param changeFamily - the change family of changes on the trunk and local branch
      * @param localSessionId - the id of the local session that will be used for local commits
+     * @param mintRevisionTag - a function which generates globally unique revision tags
+     * @param onSharedBranchCreated - called when a new shared branch is created. This is not called for the main branch.
      */
-    constructor(changeFamily: TChangeFamily, localSessionId: SessionId, mintRevisionTag: () => RevisionTag, logger?: ITelemetryLoggerExt);
+    constructor(changeFamily: TChangeFamily, localSessionId: SessionId, mintRevisionTag: () => RevisionTag, onSharedBranchCreated?: ((branchId: BranchId) => void) | undefined, logger?: ITelemetryLoggerExt);
+    getLocalBranch(branchId: BranchId): SharedTreeBranch<TEditor, TChangeset>;
+    private getSharedBranch;
     /**
      * Make the given branch known to the `EditManager`. The `EditManager` will ensure that all registered
      * branches remain usable even as the minimum sequence number advances.
@@ -85,19 +65,9 @@ export declare class EditManager<TEditor extends ChangeFamilyEditor, TChangeset,
     private trackBranch;
     private untrackBranch;
     /**
-     * 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.
-     */
-    private fastForwardNextLocalCommit;
-    /**
-     * 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.
+     * Return the sequenced number of the latest sequenced change.
      */
-    getSequenceNumber(trunkCommit: GraphCommit<TChangeset>): SeqNumber | undefined;
+    getLatestSequenceNumber(): SeqNumber | undefined;
     /**
      * Advances the minimum sequence number, and removes all commits from the trunk which lie outside the collaboration window,
      * if they are not retained by revertibles or local branches.
@@ -105,21 +75,19 @@ export declare class EditManager<TEditor extends ChangeFamilyEditor, TChangeset,
      *
      * @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: SeqNumber, trimTrunk?: boolean): void;
+    advanceMinimumSequenceNumber(minimumSequenceNumber: SeqNumber, trimHistory?: boolean): void;
     /**
      * 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.
      */
-    private trimTrunk;
+    private trimHistory;
     isEmpty(): boolean;
     getSummaryData(): SummaryData<TChangeset>;
     loadSummaryData(data: SummaryData<TChangeset>): void;
-    private getCommitSequenceId;
-    getTrunkChanges(): readonly TChangeset[];
-    getTrunkCommits(): readonly GraphCommit<TChangeset>[];
-    getTrunkHead(): GraphCommit<TChangeset>;
-    getLocalChanges(): readonly TChangeset[];
-    getLocalCommits(): readonly GraphCommit<TChangeset>[];
+    getTrunkHead(branchId: BranchId): GraphCommit<TChangeset>;
+    getTrunkChanges(branchId: BranchId): TChangeset[];
+    getTrunkCommits(branchId: BranchId): GraphCommit<TChangeset>[];
+    getLocalCommits(branchId: BranchId): readonly GraphCommit<TChangeset>[];
     /**
      * Gets the length of the longest branch maintained by this `EditManager`.
      * This may be the length of a peer branch or the local branch.
@@ -129,6 +97,13 @@ export declare class EditManager<TEditor extends ChangeFamilyEditor, TChangeset,
      * have length zero.
      */
     getLongestBranchLength(): number;
+    sequenceBranchCreation(sessionId: SessionId, referenceSequenceNumber: SeqNumber, branchId: BranchId): void;
+    addNewBranch(branchId: BranchId): void;
+    getSharedBranchIds(): BranchId[];
+    removeBranch(branchId: BranchId): void;
+    private createAndAddSharedBranch;
+    private addSharedBranch;
+    private createSharedBranch;
     /**
      * Add a bunch of sequenced changes. A bunch is a group of sequenced commits that have the following properties:
      * - They are not interleaved with messages from other DDSes in the container.
@@ -138,23 +113,23 @@ export declare class EditManager<TEditor extends ChangeFamilyEditor, TChangeset,
      *   - They are all based on the same reference sequence number.
      *   - They are not interleaved with messages from other clients.
      */
-    addSequencedChanges(newCommits: readonly GraphCommit<TChangeset>[], sessionId: SessionId, sequenceNumber: SeqNumber, referenceSequenceNumber: SeqNumber): void;
-    findLocalCommit(revision: RevisionTag): [commit: GraphCommit<TChangeset>, commitsAfter: GraphCommit<TChangeset>[]];
-    private pushCommitToTrunk;
-    private pushGraphCommitToTrunk;
-    /**
-     * Finds the most recent trunk commit that was sequenced at or before the given point.
-     * @param searchBy - the sequence number or the sequence id to search for
-     * @remarks Fails if there is no eligible commit.
-     * @returns the closest commit and its sequence id
-     */
-    private getClosestTrunkCommit;
-    private getBatch;
+    addSequencedChanges(newCommits: readonly GraphCommit<TChangeset>[], sessionId: SessionId, sequenceNumber: SeqNumber, referenceSequenceNumber: SeqNumber, branchId: BranchId): void;
+    findLocalCommit(branchId: BranchId, revision: RevisionTag): [commit: GraphCommit<TChangeset>, commitsAfter: GraphCommit<TChangeset>[]];
 }
 /**
  * The in-memory data that summaries contain
  */
 export interface SummaryData<TChangeset> {
+    readonly originator?: SessionId;
+    readonly main: SharedBranchSummaryData<TChangeset>;
+    readonly branches?: ReadonlyMap<BranchId, SharedBranchSummaryData<TChangeset>>;
+}
+export interface SharedBranchSummaryData<TChangeset> {
+    readonly id?: BranchId;
+    readonly name?: string;
+    readonly session?: SessionId;
+    readonly author?: string;
+    readonly base?: RevisionTag;
     readonly trunk: readonly SequencedCommit<TChangeset>[];
     readonly peerLocalBranches: ReadonlyMap<SessionId, SummarySessionBranch<TChangeset>>;
 }

package/lib/shared-tree-core/editManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"editManager.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/editManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAG/D,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,WAAW,EAMhB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,gBAAgB,EAA+C,MAAM,aAAa,CAAC;AAC5F,OAAO,KAAK,EAEX,SAAS,EAET,eAAe,EACf,oBAAoB,EACpB,MAAM,wBAAwB,CAAC;AAQhC,OAAO,EAEN,KAAK,mBAAmB,EACxB,MAAM,0CAA0C,CAAC;AAElD,eAAO,MAAM,6BAA6B,EAAE,SAA0C,CAAC;AAkBvF;;;GAGG;AAEH,qBAAa,WAAW,CACvB,OAAO,SAAS,kBAAkB,EAClC,UAAU,EACV,aAAa,SAAS,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC;aAgFtC,YAAY,EAAE,aAAa;aAC3B,cAAc,EAAE,SAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAhFjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyC;IAEjE,uFAAuF;IACvF,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwC;IAE9D;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAG1B;IACJ;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAG1B;IAEF;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CACvB;IAEX;;OAEG;IACH,SAAgB,WAAW,EAAE,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEnE;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAGK;IAEnC;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB,CAAiC;IAE9D;;;;;OAKG;IACH,OAAO,CAAC,SAAS,CAA0B;IAE3C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiC;IAE9D,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAEzB;IAEb;;;OAGG;gBAEc,YAAY,EAAE,aAAa,EAC3B,cAAc,EAAE,SAAS,EACxB,eAAe,EAAE,MAAM,WAAW,EACnD,MAAM,CAAC,EAAE,mBAAmB;IAsD7B;;;;;;;;OAQG;IACH,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,aAAa;IAcrB;;;;;;;;OAQG;IACH,OAAO,CAAC,0BAA0B;IAyClC;;OAEG;IACI,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,SAAS,GAAG,SAAS;IAIrF;;;;;;OAMG;IACI,4BAA4B,CAClC,qBAAqB,EAAE,SAAS,EAChC,SAAS,UAAO,GACd,IAAI;IAgBP;;;OAGG;IACH,OAAO,CAAC,SAAS;IAyGV,OAAO,IAAI,OAAO;IASlB,cAAc,IAAI,WAAW,CAAC,UAAU,CAAC;IAkFzC,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,IAAI;IAiD3D,OAAO,CAAC,mBAAmB;IAYpB,eAAe,IAAI,SAAS,UAAU,EAAE;IAIxC,eAAe,IAAI,SAAS,WAAW,CAAC,UAAU,CAAC,EAAE;IAIrD,YAAY,IAAI,WAAW,CAAC,UAAU,CAAC;IAIvC,eAAe,IAAI,SAAS,UAAU,EAAE;IAIxC,eAAe,IAAI,SAAS,WAAW,CAAC,UAAU,CAAC,EAAE;IAI5D;;;;;;;OAOG;IACI,sBAAsB,IAAI,MAAM;IAcvC;;;;;;;;OAQG;IAEI,mBAAmB,CACzB,UAAU,EAAE,SAAS,WAAW,CAAC,UAAU,CAAC,EAAE,EAC9C,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,SAAS,EACzB,uBAAuB,EAAE,SAAS,GAChC,IAAI;IAwFA,eAAe,CACrB,QAAQ,EAAE,WAAW,GACnB,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;IAU7E,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,sBAAsB;IAW9B;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAqB7B,OAAO,CAAC,QAAQ;CAUhB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,UAAU;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;IACvD,QAAQ,CAAC,iBAAiB,EAAE,WAAW,CAAC,SAAS,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;CACrF"}
+{"version":3,"file":"editManager.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/editManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAG/D,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,WAAW,EAMhB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACN,gBAAgB,EAGhB,KAAK,QAAQ,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAEX,SAAS,EAET,eAAe,EACf,oBAAoB,EACpB,MAAM,+BAA+B,CAAC;AAQvC,OAAO,EAEN,KAAK,mBAAmB,EACxB,MAAM,0CAA0C,CAAC;AAGlD,eAAO,MAAM,6BAA6B,EAAE,SAA0C,CAAC;AAkBvF;;;GAGG;AAEH,qBAAa,WAAW,CACvB,OAAO,SAAS,kBAAkB,EAClC,UAAU,EACV,aAAa,SAAS,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC;aA8CtC,YAAY,EAAE,aAAa;aAC3B,cAAc,EAAE,SAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IA/CxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyC;IAEjE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0D;IAEzF;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAGK;IAEnC;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB,CAAiC;IAE9D;;;;;OAKG;IACH,OAAO,CAAC,SAAS,CAA0B;IAE3C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAEzB;IAEb;;;;;OAKG;gBAEc,YAAY,EAAE,aAAa,EAC3B,cAAc,EAAE,SAAS,EACxB,eAAe,EAAE,MAAM,WAAW,EAClC,qBAAqB,CAAC,cAAa,QAAQ,KAAK,IAAI,aAAA,EACrE,MAAM,CAAC,EAAE,mBAAmB;IA6BtB,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC;IAIhF,OAAO,CAAC,eAAe;IAIvB;;;;;;;;OAQG;IACH,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,aAAa;IAerB;;OAEG;IACI,uBAAuB,IAAI,SAAS,GAAG,SAAS;IAcvD;;;;;;OAMG;IACI,4BAA4B,CAClC,qBAAqB,EAAE,SAAS,EAChC,WAAW,UAAO,GAChB,IAAI;IAgBP;;;OAGG;IACH,OAAO,CAAC,WAAW;IA8EZ,OAAO,IAAI,OAAO;IAUlB,cAAc,IAAI,WAAW,CAAC,UAAU,CAAC;IA0BzC,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,IAAI;IA0BpD,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC;IAIzD,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU,EAAE;IAIjD,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,EAAE;IAI9D,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,WAAW,CAAC,UAAU,CAAC,EAAE;IAK9E;;;;;;;OAOG;IACI,sBAAsB,IAAI,MAAM;IAQhC,sBAAsB,CAC5B,SAAS,EAAE,SAAS,EACpB,uBAAuB,EAAE,SAAS,EAClC,QAAQ,EAAE,QAAQ,GAChB,IAAI;IAWA,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAUtC,kBAAkB,IAAI,QAAQ,EAAE;IAIhC,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAM7C,OAAO,CAAC,wBAAwB;IAWhC,OAAO,CAAC,eAAe;IAqBvB,OAAO,CAAC,kBAAkB;IAsB1B;;;;;;;;OAQG;IAEI,mBAAmB,CACzB,UAAU,EAAE,SAAS,WAAW,CAAC,UAAU,CAAC,EAAE,EAC9C,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,SAAS,EACzB,uBAAuB,EAAE,SAAS,EAClC,QAAQ,EAAE,QAAQ,GAChB,IAAI;IAsDA,eAAe,CACrB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,WAAW,GACnB,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;CAS7E;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,UAAU;IACtC,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACnD,QAAQ,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,QAAQ,EAAE,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC;CAC/E;AAED,MAAM,WAAW,uBAAuB,CAAC,UAAU;IAClD,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,SAAS,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;IACvD,QAAQ,CAAC,iBAAiB,EAAE,WAAW,CAAC,SAAS,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;CACrF"}