@fluidframework/tree 2.117.0 → 3.0.0

package/dist/feature-libraries/modular-schema/modularChangeFamily.js

@@ -4,7 +4,11 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeFieldId = exports.getParentFieldId = exports.ModularEditBuilder = exports.rebaseRevisionMetadataFromInfo = exports.intoDelta = exports.updateRefreshers = exports.relevantRemovedRoots = exports.ModularChangeFamily = void 0;
+exports.ModularEditBuilder = exports.ModularChangeFamily = void 0;
+exports.relevantRemovedRoots = relevantRemovedRoots;
+exports.updateRefreshers = updateRefreshers;
+exports.intoDelta = intoDelta;
+exports.rebaseRevisionMetadataFromInfo = rebaseRevisionMetadataFromInfo;
 const internal_1 = require("@fluidframework/core-utils/internal");
 const internal_2 = require("@fluidframework/telemetry-utils/internal");
 const sorted_btree_es6_1 = require("@tylerbu/sorted-btree-es6");
@@ -19,11 +23,16 @@ const modularChangeTypes_js_1 = require("./modularChangeTypes.js");
 const modularChangeUtils_js_1 = require("./modularChangeUtils.js");
 const invert_js_1 = require("./invert.js");
 const prune_js_1 = require("./prune.js");
+const filterEdits_js_1 = require("./filterEdits.js");
 /**
  * Implementation of ChangeFamily which delegates work in a given field to the appropriate FieldKind
  * as determined by the schema.
  */
 class ModularChangeFamily {
+    codecs;
+    codecOptions;
+    static emptyChange = (0, modularChangeUtils_js_1.makeModularChangeset)();
+    fieldKinds;
     constructor(fieldKinds, codecs, codecOptions) {
         this.codecs = codecs;
         this.codecOptions = codecOptions;
@@ -200,7 +209,7 @@ class ModularChangeFamily {
      */
     composeAffectedFields(table, change, areBaseFields, affectedFields, composedFields, composedNodes, genId, metadata) {
         for (const fieldIdKey of affectedFields.keys()) {
-            const fieldId = normalizeFieldId(fieldIdFromFieldIdKey(fieldIdKey), change.nodeAliases);
+            const fieldId = (0, modularChangeUtils_js_1.normalizeFieldId)(fieldIdFromFieldIdKey(fieldIdKey), change.nodeAliases);
             const fieldChange = fieldChangeFromId(change.fieldChanges, change.nodeChanges, fieldId);
             if (table.fieldToContext.has(fieldChange) ||
                 table.newFieldToBaseField.has(fieldChange)) {
@@ -371,7 +380,7 @@ class ModularChangeFamily {
         }
         (0, modularChangeUtils_js_1.updateConstraintsForFields)(rebasedFields, fieldChangeHandler_js_1.NodeAttachState.Attached, constraintState, rebasedNodes, this.fieldKinds);
         const rebased = (0, modularChangeUtils_js_1.makeModularChangeset)({
-            fieldChanges: (0, prune_js_1.pruneFieldMap)(rebasedFields, rebasedNodes, this.fieldKinds),
+            fieldChanges: rebasedFields,
             nodeChanges: rebasedNodes,
             nodeToParent: crossFieldTable.rebasedNodeToParent,
             nodeAliases: change.nodeAliases,
@@ -385,7 +394,7 @@ class ModularChangeFamily {
             destroys: change.destroys,
             refreshers: change.refreshers,
         });
-        return rebased;
+        return (0, prune_js_1.pruneChangeset)(rebased, this.fieldKinds);
     }
     // This performs a first pass on all fields which have both new and base changes.
     // TODO: Can we also handle additional passes in this method?
@@ -407,7 +416,7 @@ class ModularChangeFamily {
         for (const [revision, localId, fieldKey] of crossFieldTable.affectedBaseFields.keys()) {
             const baseNodeId = localId === undefined
                 ? undefined
-                : normalizeNodeId({ revision, localId }, baseChange.nodeAliases);
+                : (0, modularChangeUtils_js_1.normalizeNodeId)({ revision, localId }, baseChange.nodeAliases);
             const baseFieldChange = fieldMapFromNodeId(baseChange.fieldChanges, baseChange.nodeChanges, baseNodeId).get(fieldKey);
             (0, internal_1.assert)(baseFieldChange !== undefined, 0x9c2 /* Cross field key registered for empty field */);
             if (crossFieldTable.baseFieldToContext.has(baseFieldChange)) {
@@ -499,7 +508,7 @@ class ModularChangeFamily {
         };
         (0, changeAtomIdBTree_js_1.setInChangeAtomIdMap)(rebasedNodes, nodeId, newNode);
         (0, changeAtomIdBTree_js_1.setInChangeAtomIdMap)(table.baseToRebasedNodeId, nodeId, nodeId);
-        const parentFieldId = getParentFieldId(table.baseChange, nodeId);
+        const parentFieldId = (0, modularChangeUtils_js_1.getParentFieldId)(table.baseChange, nodeId);
         this.attachRebasedNode(rebasedFields, rebasedNodes, table, nodeId, parentFieldId, idAllocator, metadata);
     }
     attachRebasedNode(rebasedFields, rebasedNodes, table, baseNodeId, parentFieldIdBase, idAllocator, metadata) {
@@ -600,7 +609,7 @@ class ModularChangeFamily {
     changeRevision(change, replacer) {
         const updatedFields = this.replaceFieldMapRevisions(change.fieldChanges, replacer);
         const updatedNodes = replaceIdMapRevisions(change.nodeChanges, replacer, (nodeChangeset) => this.replaceNodeChangesetRevisions(nodeChangeset, replacer));
-        const updatedNodeToParent = replaceIdMapRevisions(change.nodeToParent, replacer, (fieldId) => replaceFieldIdRevision(normalizeFieldId(fieldId, change.nodeAliases), replacer));
+        const updatedNodeToParent = replaceIdMapRevisions(change.nodeToParent, replacer, (fieldId) => replaceFieldIdRevision((0, modularChangeUtils_js_1.normalizeFieldId)(fieldId, change.nodeAliases), replacer));
         const updated = {
             ...change,
             fieldChanges: updatedFields,
@@ -644,42 +653,6 @@ class ModularChangeFamily {
         const emptyChange = (0, modularChangeUtils_js_1.getChangeHandler)(this.fieldKinds, fieldKind).createEmpty();
         return { fieldKind, change: (0, index_js_3.brand)(emptyChange) };
     }
-    validateChangeset(change) {
-        let numNodes = this.validateFieldChanges(change, change.fieldChanges, undefined);
-        for (const [[revision, localId], node] of change.nodeChanges.entries()) {
-            if (node.fieldChanges === undefined) {
-                continue;
-            }
-            const nodeId = { revision, localId };
-            const numChildren = this.validateFieldChanges(change, node.fieldChanges, nodeId);
-            numNodes += numChildren;
-        }
-        (0, internal_1.assert)(numNodes === change.nodeChanges.size, 0xa4d /* Node table contains unparented nodes */);
-    }
-    /**
-     * Asserts that each child and cross field key in each field has a correct entry in
-     * `nodeToParent` or `crossFieldKeyTable`.
-     * @returns the number of children found.
-     */
-    validateFieldChanges(change, fieldChanges, nodeParent) {
-        let numChildren = 0;
-        for (const [field, fieldChange] of fieldChanges.entries()) {
-            const fieldId = { nodeId: nodeParent, field };
-            const handler = (0, modularChangeUtils_js_1.getChangeHandler)(this.fieldKinds, fieldChange.fieldKind);
-            for (const [child, _index] of handler.getNestedChanges(fieldChange.change)) {
-                const parentFieldId = getParentFieldId(change, child);
-                (0, internal_1.assert)(areEqualFieldIds(parentFieldId, fieldId), 0xa4e /* Inconsistent node parentage */);
-                numChildren += 1;
-            }
-            for (const keyRange of handler.getCrossFieldKeys(fieldChange.change)) {
-                const fields = getFieldsForCrossFieldKey(change, keyRange.key, keyRange.count);
-                (0, internal_1.assert)(fields.length === 1 &&
-                    fields[0] !== undefined &&
-                    areEqualFieldIds(fields[0], fieldId), 0xa4f /* Inconsistent cross field keys */);
-            }
-        }
-        return numChildren;
-    }
     getEffectiveChange(change) {
         if ((0, modularChangeUtils_js_1.hasConflicts)(change)) {
             return this.muteChange(change);
@@ -715,25 +688,21 @@ class ModularChangeFamily {
         return {
             fieldKind: change.fieldKind,
             change: (0, index_js_3.brand)(handler.rebaser.filterEdits(change.change, {
-                filterDetach: removeAllEditsFilter,
-                filterAttach: removeAllEditsFilter,
+                filterDetach: filterEdits_js_1.removeAllDetachesFilter,
+                filterAttach: filterEdits_js_1.removeAllAttachesFilter,
                 preserveOtherEdits: false,
             })),
         };
     }
 }
 exports.ModularChangeFamily = ModularChangeFamily;
-ModularChangeFamily.emptyChange = (0, modularChangeUtils_js_1.makeModularChangeset)();
-function removeAllEditsFilter(_id, count, _endpointId) {
-    return { value: fieldChangeHandler_js_1.EditFilterStatus.Remove, length: count };
-}
 function replaceCrossFieldKeyTableRevisions(table, replacer, nodeAliases) {
     const updated = (0, modularChangeTypes_js_1.newCrossFieldKeyTable)();
     for (const entry of table.entries()) {
         const key = entry.start;
         const updatedKey = replacer.getUpdatedAtomId(key, entry.length);
         const field = entry.value;
-        const normalizedFieldId = normalizeFieldId(field, nodeAliases);
+        const normalizedFieldId = (0, modularChangeUtils_js_1.normalizeFieldId)(field, nodeAliases);
         const updatedNodeId = normalizedFieldId.nodeId === undefined
             ? undefined
             : replacer.getUpdatedAtomId(normalizedFieldId.nodeId);
@@ -807,7 +776,6 @@ function composeBuildsDestroysAndRefreshers(change1, change2) {
 function* relevantRemovedRoots(change, fieldKinds) {
     yield* relevantRemovedRootsFromFields(change.fieldChanges, change.nodeChanges, fieldKinds);
 }
-exports.relevantRemovedRoots = relevantRemovedRoots;
 function* relevantRemovedRootsFromNode(node, nodeChanges, fieldKinds) {
     const nodeChangeset = (0, modularChangeUtils_js_1.nodeChangeFromId)(nodeChanges, node);
     if (nodeChangeset.fieldChanges !== undefined) {
@@ -870,7 +838,6 @@ function updateRefreshers(change, getDetachedNode, removedRoots, requireRefreshe
         refreshers,
     });
 }
-exports.updateRefreshers = updateRefreshers;
 /**
  * Converts a change into the delta format.
  *
@@ -914,7 +881,6 @@ function intoDelta(taggedChange, fieldKinds) {
     }
     return rootDelta;
 }
-exports.intoDelta = intoDelta;
 function copyDetachedNodes(detachedNodes) {
     const copiedDetachedNodes = [];
     for (const [[major, minor], chunk] of detachedNodes.entries()) {
@@ -983,7 +949,6 @@ function rebaseRevisionMetadataFromInfo(revInfos, revisionToRebase, baseRevision
         getBaseRevisions,
     };
 }
-exports.rebaseRevisionMetadataFromInfo = rebaseRevisionMetadataFromInfo;
 function newComposeTable(baseChange, newChange, composedNodeToParent) {
     return {
         ...(0, modularChangeUtils_js_1.newCrossFieldTable)(),
@@ -1002,19 +967,20 @@ function newComposeTable(baseChange, newChange, composedNodeToParent) {
     };
 }
 class RebaseManager extends modularChangeUtils_js_1.CrossFieldManagerI {
+    fieldId;
     constructor(table, currentField, fieldId, allowInval = true) {
         super(table, currentField, allowInval);
         this.fieldId = fieldId;
     }
     set(target, revision, id, count, newValue, invalidateDependents) {
         if (invalidateDependents && this.allowInval) {
-            const newFieldIds = getFieldsForCrossFieldKey(this.table.newChange, {
+            const newFieldIds = (0, modularChangeUtils_js_1.getFieldsForCrossFieldKey)(this.table.newChange, {
                 target,
                 revision,
                 localId: id,
             }, count);
             (0, internal_1.assert)(newFieldIds.length === 0, 0x9c6 /* TODO: Modifying a cross-field key from the new changeset is currently unsupported */);
-            const baseFieldIds = getFieldsForCrossFieldKey(this.table.baseChange, {
+            const baseFieldIds = (0, modularChangeUtils_js_1.getFieldsForCrossFieldKey)(this.table.baseChange, {
                 target,
                 revision,
                 localId: id,
@@ -1038,13 +1004,14 @@ class RebaseManager extends modularChangeUtils_js_1.CrossFieldManagerI {
 }
 // TODO: Deduplicate this with RebaseTable
 class ComposeManager extends modularChangeUtils_js_1.CrossFieldManagerI {
+    fieldId;
     constructor(table, currentField, fieldId, allowInval = true) {
         super(table, currentField, allowInval);
         this.fieldId = fieldId;
     }
     set(target, revision, id, count, newValue, invalidateDependents) {
         if (invalidateDependents && this.allowInval) {
-            const newFieldIds = getFieldsForCrossFieldKey(this.table.newChange, {
+            const newFieldIds = (0, modularChangeUtils_js_1.getFieldsForCrossFieldKey)(this.table.newChange, {
                 target,
                 revision,
                 localId: id,
@@ -1055,7 +1022,7 @@ class ComposeManager extends modularChangeUtils_js_1.CrossFieldManagerI {
                 }
             }
             else {
-                const baseFieldIds = getFieldsForCrossFieldKey(this.table.baseChange, {
+                const baseFieldIds = (0, modularChangeUtils_js_1.getFieldsForCrossFieldKey)(this.table.baseChange, {
                     target,
                     revision,
                     localId: id,
@@ -1079,11 +1046,15 @@ class ComposeManager extends modularChangeUtils_js_1.CrossFieldManagerI {
     }
 }
 class ModularEditBuilder extends index_js_2.EditBuilder {
+    rebaser;
+    fieldKinds;
+    transactionDepth = 0;
+    idAllocator;
+    codecOptions;
     constructor(rebaser, fieldKinds, changeReceiver, codecOptions) {
         super(changeReceiver);
         this.rebaser = rebaser;
         this.fieldKinds = fieldKinds;
-        this.transactionDepth = 0;
         this.idAllocator = (0, index_js_3.idAllocatorFromMaxId)();
         this.codecOptions = codecOptions;
     }
@@ -1340,41 +1311,6 @@ function replaceFieldIdRevision(fieldId, replacer) {
         nodeId: replacer.getUpdatedAtomId(fieldId.nodeId),
     };
 }
-function getParentFieldId(changeset, nodeId) {
-    const parentId = (0, changeAtomIdBTree_js_1.getFromChangeAtomIdMap)(changeset.nodeToParent, nodeId);
-    (0, internal_1.assert)(parentId !== undefined, 0x9cb /* Parent field should be defined */);
-    return normalizeFieldId(parentId, changeset.nodeAliases);
-}
-exports.getParentFieldId = getParentFieldId;
-function getFieldsForCrossFieldKey(changeset, key, count) {
-    const fieldIds = [];
-    for (const { value: fieldId } of changeset.crossFieldKeys.getAll(key, count)) {
-        if (fieldId !== undefined) {
-            fieldIds.push(normalizeFieldId(fieldId, changeset.nodeAliases));
-        }
-    }
-    return fieldIds;
-}
-// This is only exported for use in test utilities.
-function normalizeFieldId(fieldId, nodeAliases) {
-    return fieldId.nodeId === undefined
-        ? fieldId
-        : { ...fieldId, nodeId: normalizeNodeId(fieldId.nodeId, nodeAliases) };
-}
-exports.normalizeFieldId = normalizeFieldId;
-/**
- * @returns The canonical form of nodeId, according to nodeAliases
- */
-function normalizeNodeId(nodeId, nodeAliases) {
-    let currentId = nodeId;
-    while (true) {
-        const dealiased = (0, changeAtomIdBTree_js_1.getFromChangeAtomIdMap)(nodeAliases, currentId);
-        if (dealiased === undefined) {
-            return currentId;
-        }
-        currentId = dealiased;
-    }
-}
 /**
  * A rebaseChild callback for fields with no new changes.
  * Asserts that there are no new changes and returns undefined.
@@ -1383,9 +1319,6 @@ function noNewChangesRebaseChild(child, _baseChild, _stateChange) {
     (0, internal_1.assert)(child === undefined, 0x9c3 /* There should be no new changes in this field */);
     return undefined;
 }
-function areEqualFieldIds(a, b) {
-    return (0, index_js_2.areEqualChangeAtomIdOpts)(a.nodeId, b.nodeId) && a.field === b.field;
-}
 function newFieldIdKeyBTree() {
     return (0, index_js_3.newTupleBTree)(compareFieldIdKeys);
 }