@colyseus/schema 4.0.24 → 4.0.26

package/build/index.js

@@ -821,10 +821,25 @@
                 });
             }
             metadata[$viewFieldIndexes].push(index);
-            if (!metadata[$fieldIndexesByViewTag][tag]) {
-                metadata[$fieldIndexesByViewTag][tag] = [];
+            // Populate $fieldIndexesByViewTag: for a bitmask tag, register the field
+            // index under each individual set bit so that view.add(obj, Tag.ONE) finds
+            // fields tagged @view(Tag.ONE|Tag.TWO).
+            // Negative tags (i.e. DEFAULT_VIEW_TAG = -1) are stored as-is.
+            if (tag < 0) {
+                if (!metadata[$fieldIndexesByViewTag][tag]) {
+                    metadata[$fieldIndexesByViewTag][tag] = [];
+                }
+                metadata[$fieldIndexesByViewTag][tag].push(index);
+            }
+            else {
+                for (let bits = tag; bits > 0; bits &= bits - 1) {
+                    const bit = bits & (-bits); // isolate lowest set bit
+                    if (!metadata[$fieldIndexesByViewTag][bit]) {
+                        metadata[$fieldIndexesByViewTag][bit] = [];
+                    }
+                    metadata[$fieldIndexesByViewTag][bit].push(index);
+                }
             }
-            metadata[$fieldIndexesByViewTag][tag].push(index);
         },
         setFields(target, fields) {
             // for inheritance support
@@ -1375,7 +1390,8 @@
                 key += `-${this.root.types.schemas.get(parentConstructor)}`;
             }
             key += `-${parentIndex}`;
-            const fieldHasViewTag = Metadata.hasViewTagAtIndex(parentConstructor?.[Symbol.metadata], parentIndex);
+            const parentMetadata = parentConstructor?.[Symbol.metadata];
+            const fieldHasViewTag = Metadata.hasViewTagAtIndex(parentMetadata, parentIndex);
             this.isFiltered = parent[$changes].isFiltered // in case parent is already filtered
                 || this.root.types.parentFiltered[key]
                 || fieldHasViewTag;
@@ -1384,9 +1400,22 @@
             // when it's available, we need to enqueue the "changes" changeset into the "filteredChanges" changeset.
             //
             if (this.isFiltered) {
+                //
+                // Children of a `@view(N)` collection (non-default tag) inherit
+                // visibility from their parent, so items pushed/set after the
+                // initial `view.add(state, N)` show up automatically.
+                //
+                // Default-tag `@view()` collections deliberately keep per-item
+                // gating — `view.add(item)` is required to opt each one in.
+                //
+                // The `parentMetadata[parentIndex].tag` access is safe inside
+                // this branch: the OR's short-circuit means we only reach it
+                // when `fieldHasViewTag` is true, which guarantees the metadata
+                // entry and its `tag` property exist.
+                //
                 this.isVisibilitySharedWithParent = (parentChangeTree.isFiltered &&
                     typeof (refType) !== "string" &&
-                    !fieldHasViewTag);
+                    (!fieldHasViewTag || (parentIsCollection && parentMetadata[parentIndex].tag !== DEFAULT_VIEW_TAG)));
                 if (!this.filteredChanges) {
                     this.filteredChanges = createChangeSet();
                     this.allFilteredChanges = createChangeSet();
@@ -1666,17 +1695,25 @@
             if (previousValue) {
                 let previousRefId = previousValue[$refId];
                 if (previousRefId !== undefined && refId !== previousRefId) {
+                    // Collection field replaced by a different instance.
                     //
-                    // enqueue onRemove if structure has been replaced.
-                    //
+                    // Don't decrement children here: GC (`garbageCollectDeletedRefs`)
+                    // removes them once the previous collection's refId hits zero.
+                    // Doing it here too would double-decrement a *shared* child and
+                    // drop it while still referenced ("refId not found").
+                    if ((operation & exports.OPERATION.DELETE) !== exports.OPERATION.DELETE) {
+                        // Replacement not tagged DELETE (e.g. pending ADD not upgraded
+                        // to DELETE_AND_ADD), so the previous refId wasn't decremented
+                        // above. Release it here, else it never gets GC'd (leak).
+                        $root.removeRef(previousRefId);
+                    }
+                    // enqueue onRemove callbacks for the previous collection's children.
                     const entries = previousValue.entries();
                     let iter;
                     while ((iter = entries.next()) && !iter.done) {
                         const [key, value] = iter.value;
-                        // if value is a schema, remove its reference
                         if (typeof (value) === "object") {
                             previousRefId = value[$refId];
-                            $root.removeRef(previousRefId);
                         }
                         allChanges.push({
                             ref: previousValue,
@@ -3754,9 +3791,10 @@
                 return view.isChangeTreeVisible(ref[$changes]);
             }
             else {
-                // view pass: custom tag
+                // view pass: custom tag (bitmask)
+                // tag is the field's stored bitmask; view.tags stores the accumulated bitmask of tags used in view.add().
                 const tags = view.tags?.get(ref[$changes]);
-                return tags && tags.has(tag);
+                return tags != null && (tag & tags) !== 0;
             }
         }
         // allow inherited classes to have a constructor
@@ -5570,7 +5608,7 @@
          * List of ChangeTree's that are invisible to this view
          */
         invisible = new WeakSet();
-        tags; // TODO: use bit manipulation instead of Set<number> ()
+        tags; // bitmask of tags used to add each ChangeTree
         /**
          * Manual "ADD" operations for changes per ChangeTree, specific to this view.
          * (This is used to force encoding a property, even if it was not changed)
@@ -5658,9 +5696,16 @@
             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;
+                    metadata[index].tag !== undefined) {
+                    const fieldTag = metadata[index].tag;
+                    // DEFAULT_VIEW_TAG fields are visible to all clients.
+                    // Custom-tagged fields are only visible when bits overlap,
+                    // and never to default-tag clients.
+                    const tagMatch = fieldTag === DEFAULT_VIEW_TAG ||
+                        (tag !== DEFAULT_VIEW_TAG && (fieldTag & tag) !== 0);
+                    if (!tagMatch) {
+                        return;
+                    }
                 }
                 if (this.add(change.ref, tag, false)) {
                     isChildAdded = true;
@@ -5671,15 +5716,9 @@
                 if (!this.tags) {
                     this.tags = new WeakMap();
                 }
-                let tags;
-                if (!this.tags.has(changeTree)) {
-                    tags = new Set();
-                    this.tags.set(changeTree, tags);
-                }
-                else {
-                    tags = this.tags.get(changeTree);
-                }
-                tags.add(tag);
+                // Add tag bits into the bitmask stored for this ChangeTree.
+                const currentMask = this.tags.get(changeTree) ?? 0;
+                this.tags.set(changeTree, currentMask | tag);
                 // Ref: add tagged properties
                 metadata?.[$fieldIndexesByViewTag]?.[tag]?.forEach((index) => {
                     if (changeTree.getChange(index) !== exports.OPERATION.DELETE) {
@@ -5703,7 +5742,7 @@
                     if (op !== exports.OPERATION.DELETE &&
                         (isInvisible || // if "invisible", include all
                             tagAtIndex === undefined || // "all change" with no tag
-                            tagAtIndex === tag // tagged property
+                            (tagAtIndex === DEFAULT_VIEW_TAG || (tag !== DEFAULT_VIEW_TAG && (tagAtIndex & tag) !== 0)) // tagged property
                         )) {
                         changes[index] = op;
                         isChildAdded = true; // FIXME: assign only once
@@ -5729,18 +5768,16 @@
             // add parent's tag properties
             if (changeTree.getChange(parentIndex) !== exports.OPERATION.DELETE) {
                 const changes = this.touchChanges(changeTree.ref[$refId]);
-                if (!this.tags) {
-                    this.tags = new WeakMap();
-                }
-                let tags;
-                if (!this.tags.has(changeTree)) {
-                    tags = new Set();
-                    this.tags.set(changeTree, tags);
-                }
-                else {
-                    tags = this.tags.get(changeTree);
+                // Only accumulate positive (custom) tags in the bitmask.
+                // DEFAULT_VIEW_TAG = -1 has all bits set and must not be OR'd in,
+                // as it would make every custom-tagged field appear visible.
+                if (tag !== DEFAULT_VIEW_TAG) {
+                    if (!this.tags) {
+                        this.tags = new WeakMap();
+                    }
+                    const currentMask = this.tags.has(changeTree) ? this.tags.get(changeTree) : 0;
+                    this.tags.set(changeTree, currentMask | tag);
                 }
-                tags.add(tag);
                 changes[parentIndex] = exports.OPERATION.ADD;
             }
         }
@@ -5810,18 +5847,19 @@
             }
             // remove tag
             if (this.tags && this.tags.has(changeTree)) {
-                const tags = this.tags.get(changeTree);
                 if (tag === undefined) {
                     // delete all tags
                     this.tags.delete(changeTree);
                 }
                 else {
-                    // delete specific tag
-                    tags.delete(tag);
-                    // if tag set is empty, delete it entirely
-                    if (tags.size === 0) {
+                    // clear the tag's bits from the bitmask
+                    const newMask = this.tags.get(changeTree) & ~tag;
+                    if (newMask === 0) {
                         this.tags.delete(changeTree);
                     }
+                    else {
+                        this.tags.set(changeTree, newMask);
+                    }
                 }
             }
             return this;
@@ -5831,7 +5869,7 @@
         }
         hasTag(ob, tag = DEFAULT_VIEW_TAG) {
             const tags = this.tags?.get(ob[$changes]);
-            return tags?.has(tag) ?? false;
+            return tags != null && (tags & tag) !== 0;
         }
         clear() {
             if (!this.iterable) {

package/build/index.mjs

@@ -815,10 +815,25 @@ const Metadata = {
             });
         }
         metadata[$viewFieldIndexes].push(index);
-        if (!metadata[$fieldIndexesByViewTag][tag]) {
-            metadata[$fieldIndexesByViewTag][tag] = [];
+        // Populate $fieldIndexesByViewTag: for a bitmask tag, register the field
+        // index under each individual set bit so that view.add(obj, Tag.ONE) finds
+        // fields tagged @view(Tag.ONE|Tag.TWO).
+        // Negative tags (i.e. DEFAULT_VIEW_TAG = -1) are stored as-is.
+        if (tag < 0) {
+            if (!metadata[$fieldIndexesByViewTag][tag]) {
+                metadata[$fieldIndexesByViewTag][tag] = [];
+            }
+            metadata[$fieldIndexesByViewTag][tag].push(index);
+        }
+        else {
+            for (let bits = tag; bits > 0; bits &= bits - 1) {
+                const bit = bits & (-bits); // isolate lowest set bit
+                if (!metadata[$fieldIndexesByViewTag][bit]) {
+                    metadata[$fieldIndexesByViewTag][bit] = [];
+                }
+                metadata[$fieldIndexesByViewTag][bit].push(index);
+            }
         }
-        metadata[$fieldIndexesByViewTag][tag].push(index);
     },
     setFields(target, fields) {
         // for inheritance support
@@ -1369,7 +1384,8 @@ class ChangeTree {
             key += `-${this.root.types.schemas.get(parentConstructor)}`;
         }
         key += `-${parentIndex}`;
-        const fieldHasViewTag = Metadata.hasViewTagAtIndex(parentConstructor?.[Symbol.metadata], parentIndex);
+        const parentMetadata = parentConstructor?.[Symbol.metadata];
+        const fieldHasViewTag = Metadata.hasViewTagAtIndex(parentMetadata, parentIndex);
         this.isFiltered = parent[$changes].isFiltered // in case parent is already filtered
             || this.root.types.parentFiltered[key]
             || fieldHasViewTag;
@@ -1378,9 +1394,22 @@ class ChangeTree {
         // when it's available, we need to enqueue the "changes" changeset into the "filteredChanges" changeset.
         //
         if (this.isFiltered) {
+            //
+            // Children of a `@view(N)` collection (non-default tag) inherit
+            // visibility from their parent, so items pushed/set after the
+            // initial `view.add(state, N)` show up automatically.
+            //
+            // Default-tag `@view()` collections deliberately keep per-item
+            // gating — `view.add(item)` is required to opt each one in.
+            //
+            // The `parentMetadata[parentIndex].tag` access is safe inside
+            // this branch: the OR's short-circuit means we only reach it
+            // when `fieldHasViewTag` is true, which guarantees the metadata
+            // entry and its `tag` property exist.
+            //
             this.isVisibilitySharedWithParent = (parentChangeTree.isFiltered &&
                 typeof (refType) !== "string" &&
-                !fieldHasViewTag);
+                (!fieldHasViewTag || (parentIsCollection && parentMetadata[parentIndex].tag !== DEFAULT_VIEW_TAG)));
             if (!this.filteredChanges) {
                 this.filteredChanges = createChangeSet();
                 this.allFilteredChanges = createChangeSet();
@@ -1660,17 +1689,25 @@ function decodeValue(decoder, operation, ref, index, type, bytes, it, allChanges
         if (previousValue) {
             let previousRefId = previousValue[$refId];
             if (previousRefId !== undefined && refId !== previousRefId) {
+                // Collection field replaced by a different instance.
                 //
-                // enqueue onRemove if structure has been replaced.
-                //
+                // Don't decrement children here: GC (`garbageCollectDeletedRefs`)
+                // removes them once the previous collection's refId hits zero.
+                // Doing it here too would double-decrement a *shared* child and
+                // drop it while still referenced ("refId not found").
+                if ((operation & OPERATION.DELETE) !== OPERATION.DELETE) {
+                    // Replacement not tagged DELETE (e.g. pending ADD not upgraded
+                    // to DELETE_AND_ADD), so the previous refId wasn't decremented
+                    // above. Release it here, else it never gets GC'd (leak).
+                    $root.removeRef(previousRefId);
+                }
+                // enqueue onRemove callbacks for the previous collection's children.
                 const entries = previousValue.entries();
                 let iter;
                 while ((iter = entries.next()) && !iter.done) {
                     const [key, value] = iter.value;
-                    // if value is a schema, remove its reference
                     if (typeof (value) === "object") {
                         previousRefId = value[$refId];
-                        $root.removeRef(previousRefId);
                     }
                     allChanges.push({
                         ref: previousValue,
@@ -3748,9 +3785,10 @@ class Schema {
             return view.isChangeTreeVisible(ref[$changes]);
         }
         else {
-            // view pass: custom tag
+            // view pass: custom tag (bitmask)
+            // tag is the field's stored bitmask; view.tags stores the accumulated bitmask of tags used in view.add().
             const tags = view.tags?.get(ref[$changes]);
-            return tags && tags.has(tag);
+            return tags != null && (tag & tags) !== 0;
         }
     }
     // allow inherited classes to have a constructor
@@ -5564,7 +5602,7 @@ class StateView {
      * List of ChangeTree's that are invisible to this view
      */
     invisible = new WeakSet();
-    tags; // TODO: use bit manipulation instead of Set<number> ()
+    tags; // bitmask of tags used to add each ChangeTree
     /**
      * Manual "ADD" operations for changes per ChangeTree, specific to this view.
      * (This is used to force encoding a property, even if it was not changed)
@@ -5652,9 +5690,16 @@ class StateView {
         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;
+                metadata[index].tag !== undefined) {
+                const fieldTag = metadata[index].tag;
+                // DEFAULT_VIEW_TAG fields are visible to all clients.
+                // Custom-tagged fields are only visible when bits overlap,
+                // and never to default-tag clients.
+                const tagMatch = fieldTag === DEFAULT_VIEW_TAG ||
+                    (tag !== DEFAULT_VIEW_TAG && (fieldTag & tag) !== 0);
+                if (!tagMatch) {
+                    return;
+                }
             }
             if (this.add(change.ref, tag, false)) {
                 isChildAdded = true;
@@ -5665,15 +5710,9 @@ class StateView {
             if (!this.tags) {
                 this.tags = new WeakMap();
             }
-            let tags;
-            if (!this.tags.has(changeTree)) {
-                tags = new Set();
-                this.tags.set(changeTree, tags);
-            }
-            else {
-                tags = this.tags.get(changeTree);
-            }
-            tags.add(tag);
+            // Add tag bits into the bitmask stored for this ChangeTree.
+            const currentMask = this.tags.get(changeTree) ?? 0;
+            this.tags.set(changeTree, currentMask | tag);
             // Ref: add tagged properties
             metadata?.[$fieldIndexesByViewTag]?.[tag]?.forEach((index) => {
                 if (changeTree.getChange(index) !== OPERATION.DELETE) {
@@ -5697,7 +5736,7 @@ class StateView {
                 if (op !== OPERATION.DELETE &&
                     (isInvisible || // if "invisible", include all
                         tagAtIndex === undefined || // "all change" with no tag
-                        tagAtIndex === tag // tagged property
+                        (tagAtIndex === DEFAULT_VIEW_TAG || (tag !== DEFAULT_VIEW_TAG && (tagAtIndex & tag) !== 0)) // tagged property
                     )) {
                     changes[index] = op;
                     isChildAdded = true; // FIXME: assign only once
@@ -5723,18 +5762,16 @@ class StateView {
         // add parent's tag properties
         if (changeTree.getChange(parentIndex) !== OPERATION.DELETE) {
             const changes = this.touchChanges(changeTree.ref[$refId]);
-            if (!this.tags) {
-                this.tags = new WeakMap();
-            }
-            let tags;
-            if (!this.tags.has(changeTree)) {
-                tags = new Set();
-                this.tags.set(changeTree, tags);
-            }
-            else {
-                tags = this.tags.get(changeTree);
+            // Only accumulate positive (custom) tags in the bitmask.
+            // DEFAULT_VIEW_TAG = -1 has all bits set and must not be OR'd in,
+            // as it would make every custom-tagged field appear visible.
+            if (tag !== DEFAULT_VIEW_TAG) {
+                if (!this.tags) {
+                    this.tags = new WeakMap();
+                }
+                const currentMask = this.tags.has(changeTree) ? this.tags.get(changeTree) : 0;
+                this.tags.set(changeTree, currentMask | tag);
             }
-            tags.add(tag);
             changes[parentIndex] = OPERATION.ADD;
         }
     }
@@ -5804,18 +5841,19 @@ class StateView {
         }
         // remove tag
         if (this.tags && this.tags.has(changeTree)) {
-            const tags = this.tags.get(changeTree);
             if (tag === undefined) {
                 // delete all tags
                 this.tags.delete(changeTree);
             }
             else {
-                // delete specific tag
-                tags.delete(tag);
-                // if tag set is empty, delete it entirely
-                if (tags.size === 0) {
+                // clear the tag's bits from the bitmask
+                const newMask = this.tags.get(changeTree) & ~tag;
+                if (newMask === 0) {
                     this.tags.delete(changeTree);
                 }
+                else {
+                    this.tags.set(changeTree, newMask);
+                }
             }
         }
         return this;
@@ -5825,7 +5863,7 @@ class StateView {
     }
     hasTag(ob, tag = DEFAULT_VIEW_TAG) {
         const tags = this.tags?.get(ob[$changes]);
-        return tags?.has(tag) ?? false;
+        return tags != null && (tags & tag) !== 0;
     }
     clear() {
         if (!this.iterable) {