@colyseus/schema 3.0.43 → 3.0.44

package/build/esm/index.mjs

@@ -1086,6 +1086,7 @@ class ChangeTree {
                     // re-assigning a child of the same root, move it to the end
                     // of the changes queue so encoding order is preserved
                     //
+                    root.add(child);
                     root.moveToEndOfChanges(child);
                     return;
                 }
@@ -1423,7 +1424,7 @@ class ChangeTree {
      */
     addParent(parent, index) {
         // Check if this parent already exists in the chain
-        if (this.hasParent((p, i) => p === parent && i === index)) {
+        if (this.hasParent((p, i) => p[$changes] === parent[$changes] && i === index)) {
             return;
         }
         this.parentChain = {
@@ -1437,7 +1438,7 @@ class ChangeTree {
      * @param parent - The parent to remove
      * @returns true if parent was removed
      */
-    removeParent(parent) {
+    removeParent(parent = this.parent) {
         let current = this.parentChain;
         let previous = null;
         while (current) {
@@ -2007,7 +2008,7 @@ class ArraySchema {
                             }
                             if (previousValue !== undefined) {
                                 // remove root reference from previous value
-                                previousValue[$changes].root?.remove(previousValue[$changes]);
+                                previousValue[$changes].root?.remove(previousValue[$changes], obj);
                             }
                         }
                         else {
@@ -2164,7 +2165,7 @@ class ArraySchema {
         const changeTree = this[$changes];
         // remove children references
         changeTree.forEachChild((childChangeTree, _) => {
-            changeTree.root?.remove(childChangeTree);
+            changeTree.root?.remove(childChangeTree, this);
         });
         changeTree.discard(true);
         changeTree.operation(OPERATION.CLEAR);
@@ -2718,7 +2719,7 @@ class MapSchema {
                 operation = OPERATION.DELETE_AND_ADD;
                 // remove reference from previous value
                 if (previousValue !== undefined) {
-                    previousValue[$changes].root?.remove(previousValue[$changes]);
+                    previousValue[$changes].root?.remove(previousValue[$changes], this);
                 }
             }
         }
@@ -2755,7 +2756,7 @@ class MapSchema {
         changeTree.indexes = {};
         // remove children references
         changeTree.forEachChild((childChangeTree, _) => {
-            changeTree.root?.remove(childChangeTree);
+            changeTree.root?.remove(childChangeTree, this);
         });
         // clear previous indexes
         this.$indexes.clear();
@@ -3396,9 +3397,9 @@ class Schema {
         });
         return output;
     }
-    static debugRefIdEncodeOrder(ref) {
+    static debugRefIdEncodingOrder(ref, changeSet = 'allChanges') {
         let encodeOrder = [];
-        let current = ref[$changes].root.allChanges.next;
+        let current = ref[$changes].root[changeSet].next;
         while (current) {
             if (current.changeTree) {
                 encodeOrder.push(current.changeTree.refId);
@@ -3407,7 +3408,7 @@ class Schema {
         }
         return encodeOrder;
     }
-    static debugRefIdsDecoder(decoder) {
+    static debugRefIdsFromDecoder(decoder) {
         return this.debugRefIds(decoder.state, false, 0, decoder);
     }
     /**
@@ -3597,7 +3598,7 @@ class CollectionSchema {
         changeTree.indexes = {};
         // remove children references
         changeTree.forEachChild((childChangeTree, _) => {
-            changeTree.root?.remove(childChangeTree);
+            changeTree.root?.remove(childChangeTree, this);
         });
         // clear previous indexes
         this.$indexes.clear();
@@ -3916,10 +3917,12 @@ class Root {
             }
         }
         this.refCount[changeTree.refId] = (previousRefCount || 0) + 1;
+        // console.log("ADD", { refId: changeTree.refId, refCount: this.refCount[changeTree.refId] });
         return isNewChangeTree;
     }
-    remove(changeTree) {
+    remove(changeTree, parent) {
         const refCount = (this.refCount[changeTree.refId]) - 1;
+        // console.log("REMOVE", { refId: changeTree.refId, refCount });
         if (refCount <= 0) {
             //
             // Only remove "root" reference if it's the last reference
@@ -3938,7 +3941,7 @@ class Root {
                     if ((child.parentChain === undefined || // no parent, remove it
                         (child.parentChain && this.refCount[child.refId] > 1) // parent is still in use, but has more than one reference, remove it
                     )) {
-                        this.remove(child);
+                        this.remove(child, changeTree.ref);
                     }
                     else if (child.parentChain) {
                         // re-assigning a child of the same root, move it to the end
@@ -4419,11 +4422,7 @@ class Decoder {
                 // Trying to access a reference that haven't been decoded yet.
                 //
                 if (!nextRef) {
-                    // throw new Error(`"refId" not found: ${nextRefId}`);
-                    console.error(`"refId" not found: ${nextRefId}`, { previousRef: ref, previousRefId: this.currentRefId });
-                    console.warn("Please report this to the developers. All refIds =>");
-                    console.warn(Schema.debugRefIdsDecoder(this));
-                    this.skipCurrentStructure(bytes, it, totalBytes);
+                    throw new Error(`"refId" not found: ${nextRefId}`);
                 }
                 else {
                     ref = nextRef;
@@ -4999,11 +4998,12 @@ class StateView {
     // TODO: allow to set multiple tags at once
     add(obj, tag = DEFAULT_VIEW_TAG, checkIncludeParent = true) {
         const changeTree = obj?.[$changes];
+        const parentChangeTree = changeTree.parent;
         if (!changeTree) {
             console.warn("StateView#add(), invalid object:", obj);
-            return this;
+            return false;
         }
-        else if (!changeTree.parent &&
+        else if (!parentChangeTree &&
             changeTree.refId !== 0 // allow root object
         ) {
             /**
@@ -5025,18 +5025,31 @@ class StateView {
         // add parent ChangeTree's
         // - if it was invisible to this view
         // - if it were previously filtered out
-        if (checkIncludeParent && changeTree.parent) {
+        if (checkIncludeParent && parentChangeTree) {
             this.addParentOf(changeTree, tag);
         }
-        //
-        // TODO: when adding an item of a MapSchema, the changes may not
-        // be set (only the parent's changes are set)
-        //
         let changes = this.changes.get(changeTree.refId);
         if (changes === undefined) {
             changes = {};
+            // FIXME / OPTIMIZE: do not add if no changes are needed
             this.changes.set(changeTree.refId, changes);
         }
+        let isChildAdded = false;
+        //
+        // Add children of this ChangeTree first.
+        // If successful, we must link the current ChangeTree to the child.
+        //
+        changeTree.forEachChild((change, index) => {
+            // Do not ADD children that don't have the same tag
+            if (metadata &&
+                metadata[index].tag !== undefined &&
+                metadata[index].tag !== tag) {
+                return;
+            }
+            if (this.add(change.ref, tag, false)) {
+                isChildAdded = true;
+            }
+        });
         // set tag
         if (tag !== DEFAULT_VIEW_TAG) {
             if (!this.tags) {
@@ -5058,11 +5071,12 @@ class StateView {
                 }
             });
         }
-        else {
-            const isInvisible = this.invisible.has(changeTree);
+        else if (!changeTree.isNew || isChildAdded) {
+            // new structures will be added as part of .encode() call, no need to force it to .encodeView()
             const changeSet = (changeTree.filteredChanges !== undefined)
                 ? changeTree.allFilteredChanges
                 : changeTree.allChanges;
+            const isInvisible = this.invisible.has(changeTree);
             for (let i = 0, len = changeSet.operations.length; i < len; i++) {
                 const index = changeSet.operations[i];
                 if (index === undefined) {
@@ -5070,27 +5084,17 @@ class StateView {
                 } // skip "undefined" indexes
                 const op = changeTree.indexedOperations[index] ?? OPERATION.ADD;
                 const tagAtIndex = metadata?.[index].tag;
-                if (!changeTree.isNew && // new structures will be added as part of .encode() call, no need to force it to .encodeView()
+                if (op !== OPERATION.DELETE &&
                     (isInvisible || // if "invisible", include all
                         tagAtIndex === undefined || // "all change" with no tag
                         tagAtIndex === tag // tagged property
-                    ) &&
-                    op !== OPERATION.DELETE) {
+                    )) {
                     changes[index] = op;
+                    isChildAdded = true; // FIXME: assign only once
                 }
             }
         }
-        // Add children of this ChangeTree to this view
-        changeTree.forEachChild((change, index) => {
-            // Do not ADD children that don't have the same tag
-            if (metadata &&
-                metadata[index].tag !== undefined &&
-                metadata[index].tag !== tag) {
-                return;
-            }
-            this.add(change.ref, tag, false);
-        });
-        return this;
+        return isChildAdded;
     }
     addParentOf(childChangeTree, tag) {
         const changeTree = childChangeTree.parent[$changes];