@fluidframework/tree 2.4.0-294316 → 2.4.0-297385

package/lib/shared-tree/treeCheckout.d.ts

@@ -8,9 +8,12 @@ import { type Anchor, type AnchorLocator, type AnchorNode, type AnchorSetRootEve
 import { type HasListeners, type IEmitter, type Listenable } from "../events/index.js";
 import { type FieldBatchCodec, type TreeCompressionStrategy } from "../feature-libraries/index.js";
 import { SharedTreeBranch } from "../shared-tree-core/index.js";
-import { type IDisposable, TransactionResult, disposeSymbol } from "../util/index.js";
+import { Breakable, TransactionResult, disposeSymbol } from "../util/index.js";
 import type { SharedTreeChange } from "./sharedTreeChangeTypes.js";
 import type { ISharedTreeEditor, SharedTreeEditBuilder } from "./sharedTreeEditBuilder.js";
+import type { IDisposable } from "@fluidframework/core-interfaces";
+import type { ImplicitFieldSchema, TreeViewConfiguration, ViewableTree } from "../simple-tree/index.js";
+import { SchematizingSimpleTreeView } from "./schematizingTreeView.js";
 /**
  * Events for {@link ITreeCheckout}.
  */
@@ -36,6 +39,52 @@ export interface CheckoutEvents {
      */
     commitApplied(data: CommitMetadata, getRevertible?: RevertibleFactory): void;
 }
+/**
+ * A "version control"-style branch of a SharedTree.
+ * @remarks Branches may be used to coordinate edits to a SharedTree, e.g. via merge and rebase operations.
+ * Changes applied to a branch of a branch only apply to that branch and are isolated from other branches.
+ * Changes may be synchronized across branches via merge and rebase operations provided on the branch object.
+ * @alpha @sealed
+ */
+export interface TreeBranch extends ViewableTree {
+    /**
+     * Spawn a new branch which is based off of the current state of this branch.
+     * Any mutations of the new branch will not apply to this branch until the new branch is merged back into this branch via `merge()`.
+     */
+    branch(): TreeBranchFork;
+    /**
+     * Apply all the new changes on the given branch to this branch.
+     * @param view - a branch which was created by a call to `branch()`.
+     * It is automatically disposed after the merge completes.
+     * @remarks All ongoing transactions (if any) in `branch` will be committed before the merge.
+     * A "commitApplied" event and a corresponding {@link Revertible} will be emitted on this branch for each new change merged from 'branch'.
+     */
+    merge(branch: TreeBranchFork): void;
+    /**
+     * Apply all the new changes on the given branch to this branch.
+     * @param branch - a branch which was created by a call to `branch()`.
+     * @param disposeMerged - whether or not to dispose `branch` after the merge completes.
+     * @remarks All ongoing transactions (if any) in `branch` will be committed before the merge.
+     */
+    merge(branch: TreeBranchFork, disposeMerged: boolean): void;
+    /**
+     * Rebase the given branch onto this branch.
+     * @param branch - a branch which was created by a call to `branch()`. It is modified by this operation.
+     */
+    rebase(branch: TreeBranchFork): void;
+}
+/**
+ * A {@link TreeBranch | branch} of a SharedTree that has merged from another branch.
+ * @remarks This branch should be disposed when it is no longer needed in order to free resources.
+ * @alpha @sealed
+ */
+export interface TreeBranchFork extends TreeBranch, IDisposable {
+    /**
+     * Rebase the changes that have been applied to this branch over all the new changes in the given branch.
+     * @param branch - Either the root branch or a branch that was created by a call to `branch()`. It is not modified by this operation.
+     */
+    rebaseOnto(branch: TreeBranch): void;
+}
 /**
  * Provides a means for interacting with a SharedTree.
  * This includes reading data from the tree and running transactions to mutate the tree.
@@ -44,7 +93,7 @@ export interface CheckoutEvents {
  * API for interacting with a {@link SharedTreeBranch}.
  * Implementations of this interface must implement the {@link branchKey} property.
  */
-export interface ITreeCheckout extends AnchorLocator {
+export interface ITreeCheckout extends AnchorLocator, ViewableTree {
     /**
      * Read and Write access for schema stored in the document.
      *
@@ -77,30 +126,10 @@ export interface ITreeCheckout extends AnchorLocator {
      * A collection of functions for managing transactions.
      */
     readonly transaction: ITransaction;
-    /**
-     * Spawn a new view which is based off of the current state of this view.
-     * Any mutations of the new view will not apply to this view until the new view is merged back into this view via `merge()`.
-     */
-    fork(): ITreeCheckoutFork;
-    /**
-     * Apply all the new changes on the given view to this view.
-     * @param view - a view which was created by a call to `fork()`.
-     * It is automatically disposed after the merge completes.
-     * @remarks All ongoing transactions (if any) in `view` will be committed before the merge.
-     */
-    merge(view: ITreeCheckoutFork): void;
-    /**
-     * Apply all the new changes on the given view to this view.
-     * @param view - a view which was created by a call to `fork()`.
-     * @param disposeView - whether or not to dispose `view` after the merge completes.
-     * @remarks All ongoing transactions (if any) in `view` will be committed before the merge.
-     */
-    merge(view: ITreeCheckoutFork, disposeView: boolean): void;
-    /**
-     * Rebase the given view onto this view.
-     * @param view - a view which was created by a call to `fork()`. It is modified by this operation.
-     */
-    rebase(view: ITreeCheckoutFork): void;
+    branch(): ITreeCheckoutFork;
+    merge(checkout: ITreeCheckoutFork): void;
+    merge(checkout: ITreeCheckoutFork, disposeMerged: boolean): void;
+    rebase(checkout: ITreeCheckoutFork): void;
     /**
      * Replaces all schema with the provided schema.
      * Can over-write preexisting schema, and removes unmentioned schema.
@@ -140,6 +169,7 @@ export declare function createTreeCheckout(idCompressor: IIdCompressor, mintRevi
     removedRoots?: DetachedFieldIndex;
     chunkCompressionStrategy?: TreeCompressionStrategy;
     logger?: ITelemetryLoggerExt;
+    breaker?: Breakable;
 }): TreeCheckout;
 /**
  * A collection of functions for managing transactions.
@@ -149,7 +179,7 @@ export declare function createTreeCheckout(idCompressor: IIdCompressor, mintRevi
  * 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#fork} and {@link ISharedTreeFork#merge}.
+ * use {@link ITreeCheckout#branch} and {@link ISharedTreeFork#merge}.
  */
 export interface ITransaction {
     /**
@@ -189,11 +219,7 @@ export interface ITransaction {
  *
  * {@link ITreeCheckout} that has forked off of the main trunk/branch.
  */
-export interface ITreeCheckoutFork extends ITreeCheckout, IDisposable {
-    /**
-     * Rebase the changes that have been applied to this view over all the new changes in the given view.
-     * @param view - Either the root view or a view that was created by a call to `fork()`. It is not modified by this operation.
-     */
+export interface ITreeCheckoutFork extends ITreeCheckout {
     rebaseOnto(view: ITreeCheckout): void;
 }
 /**
@@ -212,7 +238,7 @@ export interface RevertMetrics {
  */
 export declare class TreeCheckout implements ITreeCheckoutFork {
     readonly transaction: ITransaction;
-    private readonly branch;
+    private readonly _branch;
     private readonly changeFamily;
     readonly storedSchema: TreeStoredSchemaRepository;
     readonly forest: IEditableForest;
@@ -223,7 +249,9 @@ export declare class TreeCheckout implements ITreeCheckoutFork {
     private removedRoots;
     /** Optional logger for telemetry. */
     private readonly logger?;
-    private isDisposed;
+    private readonly breaker;
+    disposed: boolean;
+    private readonly views;
     /**
      * Set of revertibles maintained for automatic disposal
      */
@@ -243,20 +271,22 @@ export declare class TreeCheckout implements ITreeCheckoutFork {
      * @privateRemarks Exposed for testing purposes.
      */
     static readonly revertTelemetryEventName = "RevertRevertible";
-    constructor(transaction: ITransaction, branch: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>, changeFamily: ChangeFamily<SharedTreeEditBuilder, SharedTreeChange>, storedSchema: TreeStoredSchemaRepository, forest: IEditableForest, events: Listenable<CheckoutEvents> & IEmitter<CheckoutEvents> & HasListeners<CheckoutEvents>, mintRevisionTag: () => RevisionTag, revisionTagCodec: RevisionTagCodec, idCompressor: IIdCompressor, removedRoots?: DetachedFieldIndex, 
+    constructor(transaction: ITransaction, _branch: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>, changeFamily: ChangeFamily<SharedTreeEditBuilder, SharedTreeChange>, storedSchema: TreeStoredSchemaRepository, forest: IEditableForest, events: Listenable<CheckoutEvents> & IEmitter<CheckoutEvents> & HasListeners<CheckoutEvents>, mintRevisionTag: () => RevisionTag, revisionTagCodec: RevisionTagCodec, idCompressor: IIdCompressor, removedRoots?: DetachedFieldIndex, 
     /** Optional logger for telemetry. */
-    logger?: ITelemetryLoggerExt | undefined);
+    logger?: ITelemetryLoggerExt | undefined, breaker?: Breakable);
     private withCombinedVisitor;
     private checkNotDisposed;
+    viewWith<TRoot extends ImplicitFieldSchema>(config: TreeViewConfiguration<TRoot>): SchematizingSimpleTreeView<TRoot>;
     get rootEvents(): Listenable<AnchorSetRootEvents>;
     get editor(): ISharedTreeEditor;
     locate(anchor: Anchor): AnchorNode | undefined;
-    fork(): TreeCheckout;
-    rebase(view: TreeCheckout): void;
-    rebaseOnto(view: ITreeCheckout): void;
-    merge(view: TreeCheckout): void;
-    merge(view: TreeCheckout, disposeView: boolean): void;
+    branch(): TreeCheckout;
+    rebase(checkout: TreeCheckout): void;
+    rebaseOnto(checkout: ITreeCheckout): void;
+    merge(checkout: TreeCheckout): void;
+    merge(checkout: TreeCheckout, disposeMerged: boolean): void;
     updateSchema(newSchema: TreeStoredSchema): void;
+    dispose(): void;
     [disposeSymbol](): void;
     getRemovedRoots(): [string | number | undefined, number, JsonableTree][];
     /**

package/lib/shared-tree/treeCheckout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"treeCheckout.d.ts","sourceRoot":"","sources":["../../src/shared-tree/treeCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAEN,KAAK,mBAAmB,EACxB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,UAAU,EAEf,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAEjB,KAAK,cAAc,EAEnB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAGjB,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EAQjC,KAAK,iBAAiB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,UAAU,EAEf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAK5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAwB,MAAM,8BAA8B,CAAC;AACtF,OAAO,EAAE,KAAK,WAAW,EAAE,iBAAiB,EAAE,aAAa,EAAQ,MAAM,kBAAkB,CAAC;AAG5F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;OAMG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;;OAOG;IAEH;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC7E;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IACnD;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC;IACpD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;IAEnC;;;OAGG;IACH,IAAI,IAAI,iBAAiB,CAAC;IAE1B;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAErC;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,iBAAiB,EAAE,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3D;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACzE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,YAAY,EAAE,aAAa,EAC3B,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,CAAC,EAAE;IACN,MAAM,CAAC,EAAE,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;IACnE,YAAY,CAAC,EAAE,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;IACrE,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,MAAM,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,GAClC,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,wBAAwB,CAAC,EAAE,uBAAuB,CAAC;IACnD,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC7B,GACC,YAAY,CA0Cd;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,IAAI,IAAI,CAAC;IACd;;;OAGG;IACH,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC;IACnC;;OAEG;IACH,KAAK,IAAI,iBAAiB,CAAC,KAAK,CAAC;IACjC;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC;CACtB;AA0BD;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa,EAAE,WAAW;IACpE;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CAGrB;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,iBAAiB;aA8BpC,WAAW,EAAE,YAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,YAAY;aACb,YAAY,EAAE,0BAA0B;aACxC,MAAM,EAAE,eAAe;aACvB,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,GACjD,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,YAAY;IAKpB,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IA9CzB,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmC;IAE/D;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAGrC;IAEJ;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA4B;IAElE;;;OAGG;IACH,gBAAuB,wBAAwB,sBAAsB;gBAGpD,WAAW,EAAE,YAAY,EACxB,MAAM,EAAE,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,EACjE,YAAY,EAAE,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,EACpE,YAAY,EAAE,0BAA0B,EACxC,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,GACjD,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC,EACZ,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,aAAa,EACpC,YAAY,GAAE,kBAIrB;IACD,qCAAqC;IACpB,MAAM,CAAC,iCAAqB;IAsJ9C,OAAO,CAAC,mBAAmB;IAU3B,OAAO,CAAC,gBAAgB;IAIxB,IAAW,UAAU,IAAI,UAAU,CAAC,mBAAmB,CAAC,CAEvD;IAED,IAAW,MAAM,IAAI,iBAAiB,CAGrC;IAEM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK9C,IAAI,IAAI,YAAY;IAsBpB,MAAM,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAShC,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAKrC,KAAK,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAC/B,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,GAAG,IAAI;IAgBrD,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI;IAK/C,CAAC,aAAa,CAAC,IAAI,IAAI;IAOvB,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE;IAiB/E;;;OAGG;IACI,2BAA2B,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI;IAI/D,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAiDxB,OAAO,CAAC,sBAAsB;CAqB9B;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC7B,IAAI,EAAE,aAAa,EACnB,WAAW,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,iBAAiB,GAAG,IAAI,GAC5D,iBAAiB,CAMnB"}
+{"version":3,"file":"treeCheckout.d.ts","sourceRoot":"","sources":["../../src/shared-tree/treeCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAEN,KAAK,mBAAmB,EACxB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,UAAU,EAEf,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAEjB,KAAK,cAAc,EAEnB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAGjB,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EAOjC,KAAK,iBAAiB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,UAAU,EAEf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAM5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAwB,MAAM,8BAA8B,CAAC;AACtF,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,aAAa,EAAQ,MAAM,kBAAkB,CAAC;AAGrF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EACX,mBAAmB,EAEnB,qBAAqB,EACrB,YAAY,EACZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;OAMG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;;OAOG;IAEH;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC7E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC/C;;;OAGG;IACH,MAAM,IAAI,cAAc,CAAC;IAEzB;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU,EAAE,WAAW;IAC9D;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;CACrC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa,EAAE,YAAY;IACjE;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC;IACpD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;IAEnC,MAAM,IAAI,iBAAiB,CAAC;IAE5B,KAAK,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEzC,KAAK,CAAC,QAAQ,EAAE,iBAAiB,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjE,MAAM,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACzE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,YAAY,EAAE,aAAa,EAC3B,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,CAAC,EAAE;IACN,MAAM,CAAC,EAAE,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;IACnE,YAAY,CAAC,EAAE,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;IACrE,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,MAAM,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,GAClC,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,wBAAwB,CAAC,EAAE,uBAAuB,CAAC;IACnD,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,OAAO,CAAC,EAAE,SAAS,CAAC;CACpB,GACC,YAAY,CA2Cd;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,IAAI,IAAI,CAAC;IACd;;;OAGG;IACH,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC;IACnC;;OAEG;IACH,KAAK,IAAI,iBAAiB,CAAC,KAAK,CAAC;IACjC;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC;CACtB;AA0BD;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACvD,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CAGrB;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,iBAAiB;aAgCpC,WAAW,EAAE,YAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,YAAY;aACb,YAAY,EAAE,0BAA0B;aACxC,MAAM,EAAE,eAAe;aACvB,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,GACjD,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,YAAY;IAKpB,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAjDlB,QAAQ,UAAS;IAExB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA4C;IAElE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmC;IAE/D;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAGrC;IAEJ;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA4B;IAElE;;;OAGG;IACH,gBAAuB,wBAAwB,sBAAsB;gBAGpD,WAAW,EAAE,YAAY,EACxB,OAAO,EAAE,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,EAClE,YAAY,EAAE,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,EACpE,YAAY,EAAE,0BAA0B,EACxC,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,GACjD,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC,EACZ,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,aAAa,EACpC,YAAY,GAAE,kBAIrB;IACD,qCAAqC;IACpB,MAAM,CAAC,iCAAqB,EAC5B,OAAO,GAAE,SAAyC;IAiKpE,OAAO,CAAC,mBAAmB;IAU3B,OAAO,CAAC,gBAAgB;IASjB,QAAQ,CAAC,KAAK,SAAS,mBAAmB,EAChD,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAClC,0BAA0B,CAAC,KAAK,CAAC;IAcpC,IAAW,UAAU,IAAI,UAAU,CAAC,mBAAmB,CAAC,CAEvD;IAED,IAAW,MAAM,IAAI,iBAAiB,CAGrC;IAEM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK9C,MAAM,IAAI,YAAY;IAyBtB,MAAM,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAcpC,UAAU,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOzC,KAAK,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IACnC,KAAK,CAAC,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI;IAqB3D,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI;IAK/C,OAAO,IAAI,IAAI;IAIf,CAAC,aAAa,CAAC,IAAI,IAAI;IAYvB,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE;IAiB/E;;;OAGG;IACI,2BAA2B,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI;IAI/D,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAmDxB,OAAO,CAAC,sBAAsB;CAqB9B;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC7B,IAAI,EAAE,aAAa,EACnB,WAAW,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,iBAAiB,GAAG,IAAI,GAC5D,iBAAiB,CAMnB"}

package/lib/shared-tree/treeCheckout.js

@@ -5,12 +5,13 @@
 import { assert, oob } from "@fluidframework/core-utils/internal";
 import { UsageError, } from "@fluidframework/telemetry-utils/internal";
 import { noopValidator } from "../codec/index.js";
-import { AnchorSet, CommitKind, RevertibleStatus, TreeStoredSchemaRepository, combineVisitors, makeAnonChange, makeDetachedFieldIndex, rebaseChange, rootFieldKey, tagChange, visitDelta, } from "../core/index.js";
+import { AnchorSet, CommitKind, RevertibleStatus, TreeStoredSchemaRepository, combineVisitors, makeDetachedFieldIndex, rebaseChange, rootFieldKey, tagChange, visitDelta, } from "../core/index.js";
 import { createEmitter, } from "../events/index.js";
-import { buildForest, intoDelta, jsonableTreeFromCursor, makeFieldBatchCodec, } from "../feature-libraries/index.js";
+import { buildForest, createNodeKeyManager, intoDelta, jsonableTreeFromCursor, makeFieldBatchCodec, } from "../feature-libraries/index.js";
 import { SharedTreeBranch, getChangeReplaceType } from "../shared-tree-core/index.js";
-import { TransactionResult, disposeSymbol, fail } from "../util/index.js";
+import { Breakable, TransactionResult, disposeSymbol, fail } from "../util/index.js";
 import { SharedTreeChangeFamily, hasSchemaChange } from "./sharedTreeChangeFamily.js";
+import { SchematizingSimpleTreeView } from "./schematizingTreeView.js";
 /**
  * Creates a {@link TreeCheckout}.
  * @param args - an object containing optional components that will be used to build the view.
@@ -33,7 +34,7 @@ export function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCod
         }, changeFamily, () => idCompressor.generateCompressedId());
     const events = args?.events ?? createEmitter();
     const transaction = new Transaction(branch);
-    return new TreeCheckout(transaction, branch, changeFamily, schema, forest, events, mintRevisionTag, revisionTagCodec, idCompressor, args?.removedRoots, args?.logger);
+    return new TreeCheckout(transaction, branch, changeFamily, schema, forest, events, mintRevisionTag, revisionTagCodec, idCompressor, args?.removedRoots, args?.logger, args?.breaker);
 }
 class Transaction {
     constructor(branch) {
@@ -61,11 +62,11 @@ class Transaction {
  * An implementation of {@link ITreeCheckoutFork}.
  */
 export class TreeCheckout {
-    constructor(transaction, branch, changeFamily, storedSchema, forest, events, mintRevisionTag, revisionTagCodec, idCompressor, removedRoots = makeDetachedFieldIndex("repair", revisionTagCodec, idCompressor), 
+    constructor(transaction, _branch, changeFamily, storedSchema, forest, events, mintRevisionTag, revisionTagCodec, idCompressor, removedRoots = makeDetachedFieldIndex("repair", revisionTagCodec, idCompressor), 
     /** Optional logger for telemetry. */
-    logger) {
+    logger, breaker = new Breakable("TreeCheckout")) {
         this.transaction = transaction;
-        this.branch = branch;
+        this._branch = _branch;
         this.changeFamily = changeFamily;
         this.storedSchema = storedSchema;
         this.forest = forest;
@@ -75,7 +76,9 @@ export class TreeCheckout {
         this.idCompressor = idCompressor;
         this.removedRoots = removedRoots;
         this.logger = logger;
-        this.isDisposed = false;
+        this.breaker = breaker;
+        this.disposed = false;
+        this.views = new Set();
         /**
          * Set of revertibles maintained for automatic disposal
          */
@@ -91,15 +94,15 @@ export class TreeCheckout {
          */
         this.removedRootsSnapshots = [];
         // when a transaction is started, take a snapshot of the current state of removed roots
-        branch.on("transactionStarted", () => {
+        _branch.on("transactionStarted", () => {
             this.removedRootsSnapshots.push(this.removedRoots.clone());
         });
         // when a transaction is committed, the latest snapshot of removed roots can be discarded
-        branch.on("transactionCommitted", () => {
+        _branch.on("transactionCommitted", () => {
             this.removedRootsSnapshots.pop();
         });
         // after a transaction is rolled back, revert removed roots back to the latest snapshot
-        branch.on("transactionRolledBack", () => {
+        _branch.on("transactionRolledBack", () => {
             const snapshot = this.removedRootsSnapshots.pop();
             assert(snapshot !== undefined, 0x9ae /* a snapshot for removed roots does not exist */);
             this.removedRoots = snapshot;
@@ -108,7 +111,7 @@ export class TreeCheckout {
         // 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.on("beforeChange", (event) => {
+        _branch.on("beforeChange", (event) => {
             if (event.change !== undefined) {
                 const revision = event.type === "replace"
                     ? // Change events will always contain new commits
@@ -155,58 +158,67 @@ export class TreeCheckout {
                 }
             }
         });
-        branch.on("commitApplied", (data) => {
-            const commit = branch.getHead();
-            const { change, revision } = commit;
-            let withinEventContext = true;
-            const getRevertible = hasSchemaChange(change)
-                ? undefined
-                : (onRevertibleDisposed) => {
-                    if (!withinEventContext) {
-                        throw new UsageError("Cannot get a revertible outside of the context of a commitApplied event.");
-                    }
-                    if (this.revertibleCommitBranches.get(revision) !== undefined) {
-                        throw new UsageError("Cannot generate the same revertible more than once. Note that this can happen when multiple commitApplied event listeners are registered.");
+        _branch.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" && getChangeReplaceType(event) === "transactionCommit")) {
+                    for (const commit of event.newCommits) {
+                        const kind = event.type === "append" ? event.kind : CommitKind.Default;
+                        const { change, revision } = commit;
+                        const getRevertible = hasSchemaChange(change)
+                            ? undefined
+                            : (onRevertibleDisposed) => {
+                                if (!withinEventContext) {
+                                    throw new UsageError("Cannot get a revertible outside of the context of a commitApplied event.");
+                                }
+                                if (this.revertibleCommitBranches.get(revision) !== undefined) {
+                                    throw new UsageError("Cannot generate the same revertible more than once. Note that this can happen when multiple commitApplied event listeners are registered.");
+                                }
+                                const revertibleCommits = this.revertibleCommitBranches;
+                                const revertible = {
+                                    get status() {
+                                        const revertibleCommit = revertibleCommits.get(revision);
+                                        return revertibleCommit === undefined
+                                            ? RevertibleStatus.Disposed
+                                            : RevertibleStatus.Valid;
+                                    },
+                                    revert: (release = true) => {
+                                        if (revertible.status === RevertibleStatus.Disposed) {
+                                            throw new 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 === RevertibleStatus.Disposed) {
+                                            throw new 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("commitApplied", { isLocal: true, kind }, getRevertible);
+                        withinEventContext = false;
                     }
-                    const revertibleCommits = this.revertibleCommitBranches;
-                    const revertible = {
-                        get status() {
-                            const revertibleCommit = revertibleCommits.get(revision);
-                            return revertibleCommit === undefined
-                                ? RevertibleStatus.Disposed
-                                : RevertibleStatus.Valid;
-                        },
-                        revert: (release = true) => {
-                            if (revertible.status === RevertibleStatus.Disposed) {
-                                throw new UsageError("Unable to revert a revertible that has been disposed.");
-                            }
-                            const revertMetrics = this.revertRevertible(revision, data.kind);
-                            this.logger?.sendTelemetryEvent({
-                                eventName: TreeCheckout.revertTelemetryEventName,
-                                ...revertMetrics,
-                            });
-                            if (release) {
-                                revertible.dispose();
-                            }
-                        },
-                        dispose: () => {
-                            if (revertible.status === RevertibleStatus.Disposed) {
-                                throw new UsageError("Unable to dispose a revertible that has already been disposed.");
-                            }
-                            this.disposeRevertible(revertible, revision);
-                            onRevertibleDisposed?.(revertible);
-                        },
-                    };
-                    this.revertibleCommitBranches.set(revision, branch.fork());
-                    this.revertibles.add(revertible);
-                    return revertible;
-                };
-            this.events.emit("commitApplied", data, getRevertible);
-            withinEventContext = false;
+                }
+            }
         });
         // When the branch is trimmed, we can garbage collect any repair data whose latest relevant revision is one of the
         // trimmed revisions.
-        branch.on("ancestryTrimmed", (revisions) => {
+        _branch.on("ancestryTrimmed", (revisions) => {
             this.withCombinedVisitor((visitor) => {
                 revisions.forEach((revision) => {
                     // get all the roots last created or used by the revision
@@ -226,58 +238,78 @@ export class TreeCheckout {
         fn(combinedVisitor);
         combinedVisitor.free();
     }
-    checkNotDisposed() {
-        assert(!this.isDisposed, 0x911 /* Invalid operation on a disposed TreeCheckout */);
+    checkNotDisposed(usageError) {
+        if (this.disposed) {
+            if (usageError !== undefined) {
+                throw new UsageError(usageError);
+            }
+            assert(false, 0x911 /* Invalid operation on a disposed TreeCheckout */);
+        }
+    }
+    viewWith(config) {
+        const view = new SchematizingSimpleTreeView(this, config, createNodeKeyManager(this.idCompressor), this.breaker, () => {
+            this.views.delete(view);
+        });
+        this.views.add(view);
+        return view;
     }
     get rootEvents() {
         return this.forest.anchors;
     }
     get editor() {
         this.checkNotDisposed();
-        return this.branch.editor;
+        return this._branch.editor;
     }
     locate(anchor) {
         this.checkNotDisposed();
         return this.forest.anchors.locate(anchor);
     }
-    fork() {
-        this.checkNotDisposed();
+    branch() {
+        this.checkNotDisposed("The parent branch has already been disposed and can no longer create new branches.");
         const anchors = new AnchorSet();
-        const branch = this.branch.fork();
+        const branch = this._branch.fork();
         const storedSchema = this.storedSchema.clone();
         const forest = this.forest.clone(storedSchema, anchors);
         const transaction = new Transaction(branch);
-        return new TreeCheckout(transaction, branch, this.changeFamily, storedSchema, forest, createEmitter(), this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this.removedRoots.clone(), this.logger);
+        return new TreeCheckout(transaction, branch, this.changeFamily, storedSchema, forest, createEmitter(), this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this.removedRoots.clone(), this.logger, this.breaker);
     }
-    rebase(view) {
-        this.checkNotDisposed();
-        assert(!view.transaction.inProgress(), 0x9af /* A view cannot be rebased while it has a pending transaction */);
-        view.branch.rebaseOnto(this.branch);
+    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.");
+        assert(!checkout.transaction.inProgress(), 0x9af /* A view cannot be rebased while it has a pending transaction */);
+        checkout._branch.rebaseOnto(this._branch);
     }
-    rebaseOnto(view) {
-        this.checkNotDisposed();
-        view.rebase(this);
+    rebaseOnto(checkout) {
+        this.checkNotDisposed("The target of the branch rebase has been disposed and cannot be rebased.");
+        checkout.rebase(this);
     }
-    merge(view, disposeView = true) {
-        this.checkNotDisposed();
+    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.");
         assert(!this.transaction.inProgress(), 0x9b0 /* Views cannot be merged into a view while it has a pending transaction */);
-        while (view.transaction.inProgress()) {
-            view.transaction.commit();
+        while (checkout.transaction.inProgress()) {
+            checkout.transaction.commit();
         }
-        this.branch.merge(view.branch);
-        if (disposeView) {
-            view[disposeSymbol]();
+        this._branch.merge(checkout._branch);
+        if (disposeMerged) {
+            checkout[disposeSymbol]();
         }
     }
     updateSchema(newSchema) {
         this.checkNotDisposed();
         this.editor.schema.setStoredSchema(this.storedSchema.clone(), newSchema);
     }
+    dispose() {
+        this[disposeSymbol]();
+    }
     [disposeSymbol]() {
-        this.checkNotDisposed();
-        this.isDisposed = true;
+        this.checkNotDisposed("The branch has already been disposed and cannot be disposed again.");
+        this.disposed = true;
         this.purgeRevertibles();
-        this.branch.dispose();
+        this._branch.dispose();
+        for (const view of this.views) {
+            view.dispose();
+        }
     }
     getRemovedRoots() {
         this.assertNoUntrackedRoots();
@@ -313,19 +345,20 @@ export class TreeCheckout {
         this.revertibles.delete(revertible);
     }
     revertRevertible(revision, kind) {
-        if (this.branch.isTransacting()) {
+        if (this._branch.isTransacting()) {
             throw new UsageError("Undo is not yet supported during transactions.");
         }
         const revertibleBranch = this.revertibleCommitBranches.get(revision);
         assert(revertibleBranch !== undefined, 0x7cc /* expected to find a revertible commit */);
         const commitToRevert = revertibleBranch.getHead();
-        let change = makeAnonChange(this.changeFamily.rebaser.invert(tagChange(commitToRevert.change, revision), false));
-        const headCommit = this.branch.getHead();
+        const revisionForInvert = this.mintRevisionTag();
+        let change = tagChange(this.changeFamily.rebaser.invert(commitToRevert, false, revisionForInvert), revisionForInvert);
+        const headCommit = this._branch.getHead();
         // Rebase the inverted change onto any commits that occurred after the undoable commits.
         if (commitToRevert !== headCommit) {
-            change = makeAnonChange(rebaseChange(this.changeFamily.rebaser, change, commitToRevert, headCommit, this.mintRevisionTag).change);
+            change = tagChange(rebaseChange(this.changeFamily.rebaser, change, commitToRevert, headCommit, this.mintRevisionTag).change, revisionForInvert);
         }
-        this.branch.apply(change.change, this.mintRevisionTag(), kind === CommitKind.Default || kind === CommitKind.Redo
+        this._branch.apply(change, kind === CommitKind.Default || kind === CommitKind.Redo
             ? CommitKind.Undo
             : CommitKind.Redo);
         // Derive some stats about the reversion to return to the caller.