@colyseus/schema 3.0.27 → 3.0.29

package/build/esm/index.mjs

@@ -957,6 +957,9 @@ const Metadata = {
             fields[metadata[i].name] = metadata[i].type;
         }
         return fields;
+    },
+    hasViewTagAtIndex(metadata, index) {
+        return metadata?.[$viewFieldIndexes]?.includes(index);
     }
 };
 
@@ -1173,18 +1176,6 @@ class ChangeTree {
         for (const key in changeSet.indexes) {
             newIndexes[newKey++] = changeSet.indexes[key];
         }
-        // const newIndexes = {};
-        // let newKey = 0;
-        // for (const key in changeSet.indexes) {
-        //     const index = changeSet.indexes[key];
-        //     newIndexes[newKey++] = changeSet.indexes[key];
-        //     console.log("...shiftAllChangeIndexes", { index: key, targetIndex: index, startIndex, shiftIndex });
-        //     if (index > startIndex) {
-        //         newIndexes[Number(key) + shiftIndex] = index;
-        //     } else {
-        //         newIndexes[Number(key)] = index;
-        //     }
-        // }
         changeSet.indexes = newIndexes;
         for (let i = 0; i < changeSet.operations.length; i++) {
             const index = changeSet.operations[i];
@@ -1373,25 +1364,35 @@ class ChangeTree {
         const refType = Metadata.isValidInstance(this.ref)
             ? this.ref.constructor
             : this.ref[$childType];
-        if (!Metadata.isValidInstance(parent)) {
-            const parentChangeTree = parent[$changes];
+        let parentChangeTree;
+        let parentIsCollection = !Metadata.isValidInstance(parent);
+        if (parentIsCollection) {
+            parentChangeTree = parent[$changes];
             parent = parentChangeTree.parent;
             parentIndex = parentChangeTree.parentIndex;
         }
+        else {
+            parentChangeTree = parent[$changes];
+        }
         const parentConstructor = parent.constructor;
         let key = `${this.root.types.getTypeId(refType)}`;
         if (parentConstructor) {
             key += `-${this.root.types.schemas.get(parentConstructor)}`;
         }
         key += `-${parentIndex}`;
+        const fieldHasViewTag = Metadata.hasViewTagAtIndex(parentConstructor?.[Symbol.metadata], parentIndex);
         this.isFiltered = parent[$changes].isFiltered // in case parent is already filtered
             || this.root.types.parentFiltered[key]
-            || parentConstructor?.[Symbol.metadata]?.[$viewFieldIndexes]?.includes(parentIndex);
+            || fieldHasViewTag;
         //
         // "isFiltered" may not be imedialely available during `change()` due to the instance not being attached to the root yet.
         // when it's available, we need to enqueue the "changes" changeset into the "filteredChanges" changeset.
         //
         if (this.isFiltered) {
+            this.isVisibilitySharedWithParent = (parentChangeTree.isFiltered &&
+                typeof (refType) !== "string" &&
+                !fieldHasViewTag &&
+                parentIsCollection);
             if (!this.filteredChanges) {
                 this.filteredChanges = createChangeSet();
                 this.allFilteredChanges = createChangeSet();
@@ -1522,7 +1523,7 @@ const encodeArray = function (encoder, bytes, changeTree, field, operation, it,
     // encode index
     encode.number(bytes, refOrIndex, it);
     // Do not encode value for DELETE operations
-    if (operation === OPERATION.DELETE) {
+    if (operation === OPERATION.DELETE || operation === OPERATION.DELETE_BY_REFID) {
         return;
     }
     const type = changeTree.getType(field);
@@ -1743,10 +1744,14 @@ const decodeArray = function (decoder, bytes, it, ref, allChanges) {
     else if (operation === OPERATION.ADD_BY_REFID) {
         const refId = decode.number(bytes, it);
         const itemByRefId = decoder.root.refs.get(refId);
-        // use existing index, or push new value
-        index = (itemByRefId)
-            ? ref.findIndex((value) => value === itemByRefId)
-            : ref.length;
+        // if item already exists, use existing index
+        if (itemByRefId) {
+            index = ref.findIndex((value) => value === itemByRefId);
+        }
+        // fallback to use last index
+        if (index === -1 || index === undefined) {
+            index = ref.length;
+        }
     }
     else {
         index = decode.number(bytes, it);
@@ -1849,8 +1854,7 @@ class ArraySchema {
     static [(_a$4 = $encoder, _b$4 = $decoder, $filter)](ref, index, view) {
         return (!view ||
             typeof (ref[$childType]) === "string" ||
-            // view.items.has(ref[$getByIndex](index)[$changes])
-            view.visible.has(ref['tmpItems'][index]?.[$changes]));
+            view.isChangeTreeVisible(ref['tmpItems'][index]?.[$changes]));
     }
     static is(type) {
         return (
@@ -2531,7 +2535,7 @@ class MapSchema {
     static [(_a$3 = $encoder, _b$3 = $decoder, $filter)](ref, index, view) {
         return (!view ||
             typeof (ref[$childType]) === "string" ||
-            view.visible.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
+            view.isChangeTreeVisible((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
     }
     static is(type) {
         return type['map'] !== undefined;
@@ -3148,7 +3152,7 @@ class Schema {
         }
         else if (tag === DEFAULT_VIEW_TAG) {
             // view pass: default tag
-            return view.visible.has(ref[$changes]);
+            return view.isChangeTreeVisible(ref[$changes]);
         }
         else {
             // view pass: custom tag
@@ -3361,7 +3365,7 @@ class CollectionSchema {
     static [(_a$1 = $encoder, _b$1 = $decoder, $filter)](ref, index, view) {
         return (!view ||
             typeof (ref[$childType]) === "string" ||
-            view.visible.has((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
+            view.isChangeTreeVisible((ref[$getByIndex](index) ?? ref.deletedItems[index])[$changes]));
     }
     static is(type) {
         return type['collection'] !== undefined;
@@ -3835,13 +3839,12 @@ class Encoder {
                 continue;
             }
             if (hasView) {
-                if (!view.visible.has(changeTree)) {
+                if (!view.isChangeTreeVisible(changeTree)) {
+                    // console.log("MARK AS INVISIBLE:", { ref: changeTree.ref.constructor.name, refId: changeTree.refId, raw: changeTree.ref.toJSON() });
                     view.invisible.add(changeTree);
                     continue; // skip this change tree
                 }
-                else {
-                    view.invisible.delete(changeTree); // remove from invisible list
-                }
+                view.invisible.delete(changeTree); // remove from invisible list
             }
             const changeSet = changeTree[changeSetName];
             const ref = changeTree.ref;
@@ -4975,6 +4978,25 @@ class StateView {
         // clear items array
         this.items.length = 0;
     }
+    isChangeTreeVisible(changeTree) {
+        let isVisible = this.visible.has(changeTree);
+        //
+        // TODO: avoid checking for parent visibility, most of the time it's not needed
+        // See test case: 'should not be required to manually call view.add() items to child arrays without @view() tag'
+        //
+        if (!isVisible && changeTree.isVisibilitySharedWithParent) {
+            // console.log("CHECK AGAINST PARENT...", {
+            //     ref: changeTree.ref.constructor.name,
+            //     refId: changeTree.refId,
+            //     parent: changeTree.parent.constructor.name,
+            // });
+            if (this.visible.has(changeTree.parent[$changes])) {
+                this.visible.add(changeTree);
+                isVisible = true;
+            }
+        }
+        return isVisible;
+    }
 }
 
 registerType("map", { constructor: MapSchema });