@fluidframework/tree 2.80.0 → 2.81.0

package/dist/shared-tree/treeCheckout.js

@@ -17,18 +17,19 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _TreeCheckout_events, _TreeCheckout_transaction, _TreeCheckout_validatedCommits;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TreeCheckout = exports.createTreeCheckout = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
 const client_utils_1 = require("@fluid-internal/client-utils");
-const internal_2 = require("@fluidframework/telemetry-utils/internal");
+const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/id-compressor/internal");
+const internal_3 = require("@fluidframework/telemetry-utils/internal");
 const index_js_1 = require("../codec/index.js");
 const index_js_2 = require("../core/index.js");
 const index_js_3 = require("../feature-libraries/index.js");
 const index_js_4 = require("../shared-tree-core/index.js");
-const index_js_5 = require("../util/index.js");
-const sharedTreeChangeFamily_js_1 = require("./sharedTreeChangeFamily.js");
-const index_js_6 = require("../simple-tree/index.js");
+const index_js_5 = require("../simple-tree/index.js");
+const index_js_6 = require("../util/index.js");
 const schematizingTreeView_js_1 = require("./schematizingTreeView.js");
-const internal_3 = require("@fluidframework/id-compressor/internal");
+const sharedTreeChangeEnricher_js_1 = require("./sharedTreeChangeEnricher.js");
+const sharedTreeChangeFamily_js_1 = require("./sharedTreeChangeFamily.js");
 /**
  * Creates a {@link TreeCheckout}.
  * @param args - an object containing optional components that will be used to build the view.
@@ -37,7 +38,7 @@ const internal_3 = require("@fluidframework/id-compressor/internal");
  * and functionality required to implement {@link ITreeCheckout}.
  */
 function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, args) {
-    const breaker = args?.breaker ?? new index_js_5.Breakable("TreeCheckout");
+    const breaker = args?.breaker ?? new index_js_6.Breakable("TreeCheckout");
     const schema = args?.schema ?? new index_js_2.TreeStoredSchemaRepository();
     const forest = args?.forest ?? (0, index_js_3.buildForest)(breaker, schema);
     const defaultCodecOptions = {
@@ -65,7 +66,7 @@ class 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 = (0, index_js_2.makeDetachedFieldIndex)("repair", revisionTagCodec, idCompressor), 
     /** Optional logger for telemetry. */
-    logger, breaker = new index_js_5.Breakable("TreeCheckout"), disposeForksAfterTransaction = true) {
+    logger, breaker = new index_js_6.Breakable("TreeCheckout"), disposeForksAfterTransaction = true) {
         this.isSharedBranch = isSharedBranch;
         this.changeFamily = changeFamily;
         this.storedSchema = storedSchema;
@@ -104,10 +105,10 @@ class TreeCheckout {
                         ? undefined
                         : (onRevertibleDisposed) => {
                             if (!withinEventContext) {
-                                throw new internal_2.UsageError("Cannot get a revertible outside of the context of a changed event.");
+                                throw new internal_3.UsageError("Cannot get a revertible outside of the context of a changed event.");
                             }
                             if (this.revertibleCommitBranches.get(revision) !== undefined) {
-                                throw new internal_2.UsageError("Cannot generate the same revertible more than once. Note that this can happen when multiple changed event listeners are registered.");
+                                throw new internal_3.UsageError("Cannot generate the same revertible more than once. Note that this can happen when multiple changed event listeners are registered.");
                             }
                             const revertible = this.createRevertible(revision, kind, this, onRevertibleDisposed);
                             this.revertibleCommitBranches.set(revision, __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.fork(commit));
@@ -135,6 +136,7 @@ class TreeCheckout {
                                 change: encodedChange,
                             };
                         },
+                        getRevertible: (onDisposed) => getRevertible?.(onDisposed),
                     };
                     __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("changed", metadata, getRevertible);
                     withinEventContext = false;
@@ -157,14 +159,16 @@ class TreeCheckout {
             __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("afterBatch");
             this.editLock.unlock();
             if (event.type === "append") {
-                event.newCommits.forEach((commit) => this.validateCommit(commit));
+                for (const commit of event.newCommits) {
+                    this.validateCommit(commit);
+                }
             }
         };
         this.onAncestryTrimmed = (revisions) => {
             // When the branch is trimmed, we can garbage collect any repair data whose latest relevant revision is one of the
             // trimmed revisions.
             this.withCombinedVisitor((visitor) => {
-                revisions.forEach((revision) => {
+                for (const revision of revisions) {
                     // get all the roots last created or used by the revision
                     const roots = this._removedRoots.getRootsLastTouchedByRevision(revision);
                     // get the detached field for the root and delete it from the removed roots
@@ -172,7 +176,7 @@ class TreeCheckout {
                         visitor.destroy(this._removedRoots.toFieldKey(root), 1);
                     }
                     this._removedRoots.deleteRootsLastTouchedByRevision(revision);
-                });
+                }
             });
         };
         /**
@@ -189,6 +193,14 @@ class TreeCheckout {
         // #region Commit Validation
         /** Used to maintain the contract of {@link onCommitValid}(). */
         _TreeCheckout_validatedCommits.set(this, new WeakMap());
+        // #endregion Commit Validation
+        // #region Enrichment
+        /**
+         * Statistics about enrichment operations performed by this checkout.
+         * Used for testing. May be used for telemetry in the future.
+         * The performance cost of maintaining this information is negligible.
+         */
+        this.enrichmentStats = { batches: 0, diffs: 0, commitsEnriched: 0, refreshers: 0, forks: 0, applied: 0 };
         __classPrivateFieldSet(this, _TreeCheckout_transaction, this.createTransactionStack(branch), "f");
         this.editLock = new EditLock(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEditor);
         this.registerForBranchEvents();
@@ -259,11 +271,11 @@ class TreeCheckout {
      */
     applySerializedChange(serializedChange) {
         if (!isSerializedChange(serializedChange)) {
-            throw new internal_2.UsageError(`Cannot apply change. Invalid serialized change format.`);
+            throw new internal_3.UsageError(`Cannot apply change. Invalid serialized change format.`);
         }
         const { revision, originatorId, change } = serializedChange;
         if (originatorId !== this.idCompressor.localSessionId) {
-            throw new internal_2.UsageError(`Cannot apply change. A serialized changed must be applied to the same SharedTree as it was created from.`);
+            throw new internal_3.UsageError(`Cannot apply change. A serialized changed must be applied to the same SharedTree as it was created from.`);
         }
         const context = {
             idCompressor: this.idCompressor,
@@ -316,7 +328,7 @@ class TreeCheckout {
         this.breaker.use();
         if (this.disposed) {
             if (usageError !== undefined) {
-                throw new internal_2.UsageError(usageError);
+                throw new internal_3.UsageError(usageError);
             }
             (0, internal_1.assert)(false, 0x911 /* Invalid operation on a disposed TreeCheckout */);
         }
@@ -342,7 +354,7 @@ class TreeCheckout {
             },
             revert: (release = true) => {
                 if (revertible.status === index_js_2.RevertibleStatus.Disposed) {
-                    throw new internal_2.UsageError("Unable to revert a revertible that has been disposed.");
+                    throw new internal_3.UsageError("Unable to revert a revertible that has been disposed.");
                 }
                 const revertMetrics = checkout.revertRevertible(revision, kind);
                 checkout.logger?.sendTelemetryEvent({
@@ -358,19 +370,19 @@ class TreeCheckout {
                 const targetCheckout = (0, schematizingTreeView_js_1.getCheckout)(targetBranch);
                 const revertibleBranch = this.revertibleCommitBranches.get(revision);
                 if (revertibleBranch === undefined) {
-                    throw new internal_2.UsageError("Unable to clone a revertible that has been disposed.");
+                    throw new internal_3.UsageError("Unable to clone a revertible that has been disposed.");
                 }
                 const commitToRevert = revertibleBranch.getHead();
                 const activeBranchHead = __classPrivateFieldGet(targetCheckout, _TreeCheckout_transaction, "f").activeBranch.getHead();
                 if ((0, index_js_2.isAncestor)(commitToRevert, activeBranchHead, true) === false) {
-                    throw new internal_2.UsageError("Cannot clone revertible for a commit that is not present on the given branch.");
+                    throw new internal_3.UsageError("Cannot clone revertible for a commit that is not present on the given branch.");
                 }
                 targetCheckout.revertibleCommitBranches.set(revision, revertibleBranch.fork());
                 return this.createRevertible(revision, kind, targetCheckout, onRevertibleDisposed);
             },
             dispose: () => {
                 if (revertible.status === index_js_2.RevertibleStatus.Disposed) {
-                    throw new internal_2.UsageError("Unable to dispose a revertible that has already been disposed.");
+                    throw new internal_3.UsageError("Unable to dispose a revertible that has already been disposed.");
                 }
                 checkout.disposeRevertible(revertible, revision);
                 onRevertibleDisposed?.(revertible);
@@ -403,7 +415,7 @@ class TreeCheckout {
         this.checkNotDisposed("The parent branch has already been disposed and can no longer create new branches.");
         // Branching after an unfinished transaction would expose the application to a state where its invariants may be violated.
         if (this.transaction.isInProgress()) {
-            throw new internal_2.UsageError("A view cannot be forked while it has a pending transaction.");
+            throw new internal_3.UsageError("A view cannot be forked while it has a pending transaction.");
         }
         this.editLock.checkUnlocked("Branching");
         const anchors = new index_js_2.AnchorSet();
@@ -431,10 +443,10 @@ class TreeCheckout {
         checkout.checkNotDisposed("The source of the branch rebase has been disposed and cannot be rebased.");
         this.editLock.checkUnlocked("Rebasing");
         if (this.transaction.isInProgress()) {
-            throw new internal_2.UsageError("Views cannot be rebased onto a view that has a pending transaction.");
+            throw new internal_3.UsageError("Views cannot be rebased onto a view that has a pending transaction.");
         }
         if (checkout.transaction.isInProgress()) {
-            throw new internal_2.UsageError("A view cannot be rebased while it has a pending transaction.");
+            throw new internal_3.UsageError("A view cannot be rebased while it has a pending transaction.");
         }
         (0, internal_1.assert)(!checkout.isSharedBranch, 0xa5d /* Shared branches cannot be rebased onto another branch. */);
         __classPrivateFieldGet(checkout, _TreeCheckout_transaction, "f").activeBranch.rebaseOnto(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch);
@@ -448,15 +460,15 @@ class TreeCheckout {
         checkout.checkNotDisposed("The source of the branch merge has been disposed and cannot be merged.");
         this.editLock.checkUnlocked("Merging");
         if (this.transaction.isInProgress()) {
-            throw new internal_2.UsageError("Views cannot be merged into a view while it has a pending transaction.");
+            throw new internal_3.UsageError("Views cannot be merged into a view while it has a pending transaction.");
         }
         if (checkout.transaction.isInProgress()) {
-            throw new internal_2.UsageError("Views with an open transaction cannot be merged into another view.");
+            throw new internal_3.UsageError("Views with an open transaction cannot be merged into another view.");
         }
         __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.merge(__classPrivateFieldGet(checkout, _TreeCheckout_transaction, "f").activeBranch);
         if (disposeMerged && !checkout.isSharedBranch) {
             // Dispose the merged checkout unless it is a shared branch.
-            checkout[index_js_5.disposeSymbol]();
+            checkout[index_js_6.disposeSymbol]();
         }
     }
     updateSchema(newSchema, allowNonSupersetSchema) {
@@ -468,9 +480,9 @@ class TreeCheckout {
     }
     dispose() {
         this.editLock.checkUnlocked("Disposing a view");
-        this[index_js_5.disposeSymbol]();
+        this[index_js_6.disposeSymbol]();
     }
-    [(_TreeCheckout_events = new WeakMap(), _TreeCheckout_transaction = new WeakMap(), _TreeCheckout_validatedCommits = new WeakMap(), index_js_5.disposeSymbol)]() {
+    [(_TreeCheckout_events = new WeakMap(), _TreeCheckout_transaction = new WeakMap(), _TreeCheckout_validatedCommits = new WeakMap(), index_js_6.disposeSymbol)]() {
         this.checkNotDisposed("The branch has already been disposed and cannot be disposed again.");
         this.disposed = true;
         __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.dispose();
@@ -522,7 +534,7 @@ class TreeCheckout {
     revertRevertible(revision, kind) {
         this.editLock.checkUnlocked("Reverting a commit");
         if (this.transaction.isInProgress()) {
-            throw new internal_2.UsageError("Undo is not yet supported during transactions.");
+            throw new internal_3.UsageError("Undo is not yet supported during transactions.");
         }
         const revertibleBranch = this.revertibleCommitBranches.get(revision);
         (0, internal_1.assert)(revertibleBranch !== undefined, 0x7cc /* expected to find a revertible commit */);
@@ -584,7 +596,7 @@ class TreeCheckout {
      * Otherwise, the function is registered to be called later and this function returns `false`.
      */
     onCommitValid(commit, fn) {
-        const validated = (0, index_js_5.getOrCreate)(__classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f"), commit, () => []);
+        const validated = (0, index_js_6.getOrCreate)(__classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f"), commit, () => []);
         if (validated === true) {
             fn(commit);
             return true;
@@ -594,12 +606,52 @@ class TreeCheckout {
     }
     /** Mark the given commit as "validated" according to the contract of {@link onCommitValid}(). */
     validateCommit(commit) {
-        const validated = (0, index_js_5.getOrCreate)(__classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f"), commit, () => []);
+        const validated = (0, index_js_6.getOrCreate)(__classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f"), commit, () => []);
         if (validated !== true) {
-            validated.forEach((fn) => fn(commit));
+            for (const fn of validated) {
+                fn(commit);
+            }
             __classPrivateFieldGet(this, _TreeCheckout_validatedCommits, "f").set(commit, true);
         }
     }
+    resetEnrichmentStats() {
+        this.enrichmentStats.batches = 0;
+        this.enrichmentStats.diffs = 0;
+        this.enrichmentStats.commitsEnriched = 0;
+        this.enrichmentStats.refreshers = 0;
+        this.enrichmentStats.forks = 0;
+        this.enrichmentStats.applied = 0;
+    }
+    getEnrichmentStats() {
+        return { ...this.enrichmentStats };
+    }
+    enrich(context, changes) {
+        if (!(0, index_js_6.hasSome)(changes)) {
+            return [];
+        }
+        this.enrichmentStats.batches += 1;
+        const enricher = new sharedTreeChangeEnricher_js_1.SharedTreeChangeEnricher(this.forest, this._removedRoots, this.storedSchema, this.idCompressor, () => (this.enrichmentStats.commitsEnriched += 1), () => (this.enrichmentStats.refreshers += 1), () => (this.enrichmentStats.forks += 1), () => (this.enrichmentStats.applied += 1));
+        // This `lastCommitApplied` may be on the main branch or on a transaction branch.
+        // In either case, it is crucial that the state of the forest & detached field index reflects all changes up to and including this commit.
+        const lastCommitApplied = __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.getHead();
+        if (context !== lastCommitApplied) {
+            enricher.enqueueChange(() => {
+                this.enrichmentStats.diffs += 1;
+                const diff = (0, index_js_2.diffHistories)(this.changeFamily.rebaser, lastCommitApplied, context, this.mintRevisionTag);
+                return (0, index_js_2.makeAnonChange)(diff);
+            });
+        }
+        const enriched = [];
+        for (const change of changes) {
+            enriched.push(enricher.enrich(change.change));
+            enricher.enqueueChange(change);
+        }
+        enricher[index_js_6.disposeSymbol]();
+        return enriched;
+    }
+    get mainBranch() {
+        return __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch;
+    }
 }
 exports.TreeCheckout = TreeCheckout;
 /**
@@ -692,7 +744,7 @@ class EditLock {
             // These type assertions ensure that the event name strings used here match the actual event names
             const nodeChanged = "nodeChanged";
             const treeChanged = "treeChanged";
-            throw new internal_2.UsageError(`${action} is forbidden during a ${nodeChanged} or ${treeChanged} event`);
+            throw new internal_3.UsageError(`${action} is forbidden during a ${nodeChanged} or ${treeChanged} event`);
         }
     }
     /**
@@ -721,14 +773,18 @@ function trackForksForDisposal(checkout) {
     let disposed = false;
     return () => {
         (0, internal_1.assert)(!disposed, 0xaa9 /* Forks may only be disposed once */);
-        forks.forEach((fork) => fork.dispose());
-        onDisposeUnSubscribes.forEach((unsubscribe) => unsubscribe());
+        for (const fork of forks) {
+            fork.dispose();
+        }
+        for (const unsubscribe of onDisposeUnSubscribes) {
+            unsubscribe();
+        }
         onForkUnSubscribe();
         disposed = true;
     };
 }
 function verboseFromCursor(reader, schema) {
-    const fields = (0, index_js_6.customFromCursorStored)(reader, schema, verboseFromCursor);
+    const fields = (0, index_js_5.customFromCursorStored)(reader, schema, verboseFromCursor);
     const nodeSchema = schema.get(reader.type) ?? (0, internal_1.fail)(0xac9 /* missing schema for type in cursor */);
     if (nodeSchema instanceof index_js_2.LeafNodeStoredSchema) {
         return fields;
@@ -746,7 +802,7 @@ function isSerializedChange(value) {
     return (change.version === 1 &&
         (change.revision === "root" || typeof change.revision === "number") &&
         typeof change.originatorId === "string" &&
-        (0, internal_3.isStableId)(change.originatorId) &&
+        (0, internal_2.isStableId)(change.originatorId) &&
         change.change !== undefined);
 }
 //# sourceMappingURL=treeCheckout.js.map