StateView: fix view.remove() to recursively delete visible child schema instances

Author: endel

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/schema",
-  "version": "3.0.38",
+  "version": "3.0.39",
   "description": "Binary state serializer with delta encoding for games",
   "bin": {
     "schema-codegen": "bin/schema-codegen",

src/encoder/StateView.ts

@@ -238,9 +238,7 @@ export class StateView {
                 changes[changeTree.parentIndex] = OPERATION.DELETE;
 
                 // Remove child schema from visible set
-                changeTree.forEachChild((childChangeTree) => {
-                    this.visible.delete(childChangeTree);
-                });
+                this._recursiveDeleteVisibleChangeTree(changeTree);
 
             } else {
                 // delete all "tagged" properties.
@@ -319,4 +317,11 @@ export class StateView {
 
         return isVisible;
     }
+
+    protected _recursiveDeleteVisibleChangeTree(changeTree: ChangeTree) {
+        changeTree.forEachChild((childChangeTree) => {
+            this.visible.delete(childChangeTree);
+            this._recursiveDeleteVisibleChangeTree(childChangeTree);
+        });
+    }
 }

test/StateView.test.ts

@@ -1123,7 +1123,7 @@ describe("StateView", () => {
             assert.deepStrictEqual(client.state.items.get("1").toJSON(), item1.toJSON());
         });
 
-        it("view.remove() should remove nested items", () => {
+        it("view.remove() should remove nested items (1 level)", () => {
             class Coordinates extends Schema {
                 @type("number") x: number;
                 @type("number") y: number;
@@ -1157,6 +1157,41 @@ describe("StateView", () => {
                 encodeAllMultiple(encoder, state, [client1]));
         });
 
+        it("view.remove() should remove nested items (2 levels)", () => {
+            class Tag extends Schema {
+                @type("string") name: string;
+            }
+            class Coordinates extends Schema {
+                @type("number") x: number;
+                @type("number") y: number;
+                @type(Tag) tag: Tag;
+            }
+            class Diamond extends Schema {
+                @type(Coordinates) position: Coordinates;
+            }
+            class State extends Schema {
+                @view() @type({ map: Diamond }) diamonds = new MapSchema<Diamond>();
+            }
+
+            const state = new State();
+            const encoder = getEncoder(state);
+
+            const diamond = new Diamond().assign({
+                position: new Coordinates().assign({ x: 10, y: 20, tag: new Tag().assign({ name: "tag1" }) })
+            });
+            state.diamonds.set("one", diamond);
+
+            const client1 = createClientWithView(state);
+            client1.view.add(diamond);
+            encodeMultiple(encoder, state, [client1]);
+
+            client1.view.remove(diamond);
+            encodeMultiple(encoder, state, [client1]);
+
+            assert.doesNotThrow(() =>
+                encodeAllMultiple(encoder, state, [client1]));
+        });
+
     });
 
     describe("ArraySchema", () => {