@fluidframework/tree 2.110.0 → 2.112.0

package/lib/shared-tree/treeCheckout.js

@@ -5,10 +5,9 @@
 import { __classPrivateFieldGet, __classPrivateFieldSet, __esDecorate, __runInitializers } from "tslib";
 import { createEmitter } from "@fluid-internal/client-utils";
 import { assert, unreachableCase, fail } from "@fluidframework/core-utils/internal";
-import { isStableId } from "@fluidframework/id-compressor/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 import { FluidClientVersion, FormatValidatorNoOp, } from "../codec/index.js";
-import { CommitKind, RevertibleStatus, TreeStoredSchemaRepository, combineVisitors, makeDetachedFieldIndex, rebaseChange, rootFieldKey, tagChange, visitDelta, isAncestor, moveToDetachedField, LeafNodeStoredSchema, diffHistories, makeAnonChange, deltaFieldMapHasVisibleChanges, findCommonAncestor, } from "../core/index.js";
+import { CommitKind, RevertibleStatus, TreeStoredSchemaRepository, combineVisitors, makeDetachedFieldIndex, rebaseChange, rootFieldKey, tagChange, visitDelta, isAncestor, moveToDetachedField, LeafNodeStoredSchema, diffHistories, makeAnonChange, deltaFieldMapHasVisibleChanges, findCommonAncestor, rebaseBranch, } from "../core/index.js";
 import { allowsRepoSuperset, buildForest, createNodeIdentifierManager, defaultSchemaPolicy, fieldBatchCodecBuilder, TreeStatus, intoDelta, jsonableTreeFromCursor, } from "../feature-libraries/index.js";
 import { SquashingTransactionStack, SharedTreeBranch, TransactionResult as InternalTransactionResult, } from "../shared-tree-core/index.js";
 import { getInnerNode, getKernel, customFromCursorStored, } from "../simple-tree/index.js";
@@ -16,6 +15,8 @@ import { Breakable, breakingMethod, disposeSymbol, getOrCreate, hasSome, throwIf
 import { SchematizingSimpleTreeView } from "./schematizingTreeView.js";
 import { SharedTreeChangeEnricher } from "./sharedTreeChangeEnricher.js";
 import { SharedTreeChangeFamily, hasSchemaChange } from "./sharedTreeChangeFamily.js";
+import { extractTransactionChangeProcessor } from "./transactionPostProcessor.js";
+import { SerializedChange } from "./serializedChange.js";
 /**
  * Yields all defined (non-`undefined`) labels from a {@link LabelTree}, depth-first.
  */
@@ -65,7 +66,7 @@ function buildLabelsSet(labelTreeNode) {
  * and functionality required to implement {@link ITreeCheckout}.
  */
 export function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, args) {
-    const breaker = args?.breaker ?? new Breakable("TreeCheckout");
+    const breaker = args?.breaker ?? new Breakable("TreeCheckout", args?.logger);
     const schema = args?.schema ?? new TreeStoredSchemaRepository();
     const forest = args?.forest ?? buildForest(breaker, schema);
     const defaultCodecOptions = {
@@ -103,7 +104,7 @@ function getCheckout(context) {
  * @param constraintsOnRevert - If true, use {@link ISharedTreeEditor.addNodeExistsConstraintOnRevert}.
  * @param constraints - The constraints to add to the transaction.
  *
- * @see {@link RunTransactionParams.preconditions}.
+ * @see {@link RunTransactionParamsAlpha.preconditions}.
  */
 export function addConstraintsToTransaction(checkout, constraintsOnRevert, constraints = []) {
     for (const constraint of constraints) {
@@ -176,7 +177,7 @@ let TreeCheckout = (() => {
             /** True if and only if this checkout is for a branch which is persisted and shared with other clients. */
             isSharedBranch, changeFamily, storedSchema, forest, mintRevisionTag, revisionTagCodec, idCompressor, _removedRoots = makeDetachedFieldIndex("repair", revisionTagCodec, idCompressor), 
             /** Optional logger for telemetry. */
-            logger, breaker = new Breakable("TreeCheckout")) {
+            logger, breaker = new Breakable("TreeCheckout", logger), disposeForksAfterTransaction = true) {
                 this.isSharedBranch = (__runInitializers(this, _instanceExtraInitializers), isSharedBranch);
                 this.changeFamily = changeFamily;
                 this.storedSchema = storedSchema;
@@ -187,12 +188,13 @@ let TreeCheckout = (() => {
                 this._removedRoots = _removedRoots;
                 this.logger = logger;
                 this.breaker = breaker;
+                this.disposeForksAfterTransaction = disposeForksAfterTransaction;
                 this.disposed = false;
                 this.views = new Set();
                 /**
-                 * Set of revertibles maintained for automatic disposal
+                 * Revertibles maintained for automatic disposal
                  */
-                this.revertibles = new Set();
+                this.revertibles = new Map();
                 /**
                  * Each branch's head commit corresponds to a revertible commit.
                  * Maintaining a whole branch ensures the commit graph is not pruned in a way that would prevent the commit from
@@ -225,7 +227,7 @@ let TreeCheckout = (() => {
                                     }
                                     const revertible = this.createRevertible(revision, kind, this, onRevertibleDisposed, commitLabelTree);
                                     this.revertibleCommitBranches.set(revision, __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.fork(commit));
-                                    this.revertibles.add(revertible);
+                                    this.revertibles.set(revision, revertible);
                                     return revertible;
                                 };
                             let withinEventContext = true;
@@ -233,20 +235,8 @@ let TreeCheckout = (() => {
                                 kind,
                                 isLocal: true,
                                 getChange: () => {
-                                    const context = {
-                                        idCompressor: this.idCompressor,
-                                        originatorId: this.idCompressor.localSessionId,
-                                        revision,
-                                        isSummary: false,
-                                    };
-                                    const encodedChange = this.changeFamily.codecs.resolve(4).encode(change, context);
                                     assert(commit.parent !== undefined, 0xca4 /* Expected applied commit to be parented */);
-                                    return {
-                                        version: 1,
-                                        revision,
-                                        originatorId: this.idCompressor.localSessionId,
-                                        change: encodedChange,
-                                    };
+                                    return SerializedChange.V1.encode(this.idCompressor, this.changeFamily, change, revision);
                                 },
                                 getRevertible: (onDisposed) => getRevertible?.(onDisposed),
                                 label: this.labelTreeNode?.label,
@@ -258,6 +248,12 @@ let TreeCheckout = (() => {
                             withinEventContext = false;
                         }
                     }
+                    else if (event.type === "remove") {
+                        // Commits that are rolled back should no longer be revertible
+                        for (const commit of event.removedCommits) {
+                            this.revertibles.get(commit.revision)?.dispose();
+                        }
+                    }
                     else if (this.isRemoteChangeEvent(event)) {
                         // TODO: figure out how to plumb through commit kind info for remote changes
                         this.emitChangedLocked(() => {
@@ -521,22 +517,9 @@ let TreeCheckout = (() => {
              * Applies the given serialized change (as was produced via a `"changed"` event of another checkout) to this checkout.
              */
             applySerializedChange(serializedChange) {
-                if (!isSerializedChange(serializedChange)) {
-                    throw new UsageError(`Cannot apply change. Invalid serialized change format.`);
-                }
-                const { revision, originatorId, change } = serializedChange;
-                if (originatorId !== this.idCompressor.localSessionId) {
-                    throw new UsageError(`Cannot apply change. A serialized changed must be applied to the same SharedTree as it was created from.`);
-                }
-                const context = {
-                    idCompressor: this.idCompressor,
-                    originatorId: this.idCompressor.localSessionId,
-                    revision,
-                    isSummary: false,
-                };
-                const decodedChange = this.changeFamily.codecs.resolve(4).decode(change, context);
+                const change = SerializedChange.V1.decode(this.idCompressor, this.changeFamily, serializedChange);
                 // Apply the change to the branch, but _not_ the `activeBranch` - we do not support squashing serialized commits in a transaction.
-                __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.apply(tagChange(decodedChange, revision));
+                __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.apply(change);
             }
             // #region TreeBranchAlpha
             applyChange(change) {
@@ -573,7 +556,9 @@ let TreeCheckout = (() => {
                     throw new UsageError("An asynchronous transaction cannot be started while another transaction is already in progress.");
                 }
                 this.pushLabelFrame(params?.label);
-                this.transaction.start();
+                this.transaction.start({
+                    postProcessor: extractTransactionChangeProcessor(params?.postProcessor),
+                });
                 addConstraintsToTransaction(this, false, params?.preconditions);
             }
             unmountTransaction(transactionCallbackStatus, params) {
@@ -698,7 +683,7 @@ let TreeCheckout = (() => {
                         if (revertible.status === RevertibleStatus.Disposed) {
                             throw new UsageError("Unable to dispose a revertible that has already been disposed.");
                         }
-                        checkout.disposeRevertible(revertible, revision);
+                        checkout.disposeRevertible(revision);
                         onRevertibleDisposed?.(revertible);
                     },
                 };
@@ -733,7 +718,7 @@ let TreeCheckout = (() => {
                 }
                 const branch = __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.fork();
                 const storedSchema = this.storedSchema.clone();
-                const forkBreaker = new Breakable("TreeCheckout");
+                const forkBreaker = new Breakable("TreeCheckout", this.logger);
                 const forest = this.forest.clone(storedSchema, forkBreaker);
                 const checkout = new _a(branch, false, this.changeFamily, storedSchema, forest, this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this._removedRoots.clone(), this.logger, forkBreaker);
                 __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("fork", checkout);
@@ -780,6 +765,15 @@ let TreeCheckout = (() => {
                 }
                 return targetPath.length > 0;
             }
+            computeNetChangeIfRebasedOnto(branch) {
+                const branchCheckout = getCheckout(branch);
+                const rebased = rebaseBranch(this.mintRevisionTag, this.changeFamily.rebaser, __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.getHead(), __classPrivateFieldGet(branchCheckout, _TreeCheckout_transaction, "f").branch.getHead());
+                if (rebased.sourceChange === undefined) {
+                    return undefined;
+                }
+                const revision = this.mintRevisionTag();
+                return SerializedChange.V1.encode(this.idCompressor, this.changeFamily, rebased.sourceChange, revision, undefined);
+            }
             merge(branch, disposeMerged = true) {
                 const checkout = getCheckout(branch);
                 this.checkNotDisposed("The target branch of the merge has been disposed and cannot be merged.");
@@ -848,14 +842,14 @@ let TreeCheckout = (() => {
                 __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("afterBatch");
             }
             purgeRevertibles() {
-                for (const revertible of this.revertibles) {
+                for (const revertible of this.revertibles.values()) {
                     revertible.dispose();
                 }
             }
-            disposeRevertible(revertible, revision) {
+            disposeRevertible(revision) {
                 this.revertibleCommitBranches.get(revision)?.dispose();
                 this.revertibleCommitBranches.delete(revision);
-                this.revertibles.delete(revertible);
+                this.revertibles.delete(revision);
             }
             revertRevertible(revision, kind, labelTree) {
                 this.editLock.checkUnlocked("Reverting a commit");
@@ -1118,17 +1112,6 @@ function verboseFromCursor(reader, schema) {
         fields: fields,
     };
 }
-function isSerializedChange(value) {
-    if (typeof value !== "object" || value === null) {
-        return false;
-    }
-    const change = value;
-    return (change.version === 1 &&
-        (change.revision === "root" || typeof change.revision === "number") &&
-        typeof change.originatorId === "string" &&
-        isStableId(change.originatorId) &&
-        change.change !== undefined);
-}
 /**
  * Enumerates through a shared tree change, looking for schema change and field changes that result in visible changes to the tree (e.g. an insert, move, delete).
  * This function also considers changes to detached roots to be visible changes, but not renames of roots or builds of new roots.