plain schema({}) declaration: do not auto-initialize child Schema types

Author: endel

package.json

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

src/annotations.ts

@@ -597,7 +597,8 @@ export function schema<
 
                 } else if (value['type'] !== undefined && Schema.is(value['type'])) {
                     // Direct Schema type: Type → new Type()
-                    defaultValues[fieldName] = new value['type']();
+                    // TODO: should we auto-initialize Schema instances, in case their initialize() method is not defined?
+                    // defaultValues[fieldName] = new value['type']();
                 }
             } else {
                 defaultValues[fieldName] = value['default'];
@@ -607,7 +608,8 @@ export function schema<
         } else if (typeof (value) === "function") {
             if (Schema.is(value)) {
                 // Direct Schema type: Type → new Type()
-                defaultValues[fieldName] = new value();
+                // TODO: should we auto-initialize Schema instances, in case their initialize() method is not defined?
+                // defaultValues[fieldName] = new value();
                 fields[fieldName] = getNormalizedType(value);
             } else {
                 methods[fieldName] = value;

test/BackwardsForwardsCompatibility.test.ts

@@ -55,6 +55,7 @@ describe("backwards/forwards compatibility", () => {
             x: 10,
             y: 10,
             name: "Forward",
+            // @ts-ignore
             arrayOfStrings: new ArraySchema("one"),
         }));
 

test/Definition.test.ts

@@ -307,8 +307,8 @@ describe("Definition Tests", () => {
             });
 
             const state = new State();
-            assert.ok(state.entity1 instanceof Entity);
-            assert.ok(state.entity2 instanceof Entity);
+            assert.ok(state.entity1 === undefined);
+            assert.ok(state.entity2 === undefined);
 
             assert.ok(state.map instanceof MapSchema);
             assert.strictEqual(state.map.size, 0);
@@ -320,8 +320,6 @@ describe("Definition Tests", () => {
             assert.strictEqual(state.array2.length, 0);
 
             const state2 = new State();
-            assert.ok(state.entity1 !== state2.entity1);
-            assert.ok(state.entity2 !== state2.entity2);
             assert.ok(state.map !== state2.map);
             assert.ok(state.array1 !== state2.array1);
             assert.ok(state.array2 !== state2.array2);
@@ -656,6 +654,27 @@ describe("Definition Tests", () => {
 
         });
 
+        it("should not auto-initialize Schema instances", () => {
+            const Base = schema({
+                value: 'string',
+                initialize(value: { something: string }) {
+                    this.value = value.something;
+                },
+            });
+
+            const Child = schema({
+                world: 'string',
+                random: Base,
+                initialize(world: string) {
+                    this.world = world;
+                },
+            });
+
+            assert.doesNotThrow(() => {
+                new Child('hello');
+            });
+        });
+
     });
 
 });

test/Schema.test.ts

@@ -344,6 +344,7 @@ describe("Type: Schema", () => {
 
             assert.throws(() => {
                 class Player extends Entity {
+                    // @ts-ignore
                     @type("string") id: string;
                 }
             }, /Duplicate 'id' definition on 'Player'/);

test/StateView.test.ts

@@ -2520,7 +2520,8 @@ describe("StateView", () => {
             entity.components.push(new TagComponent());
             assert.strictEqual(entity.components[1][$changes].isFiltered, true);
 
-            entity.components.push(new ListComponent().assign({list: new ArraySchema("one", "two")}));
+            // @ts-ignore
+            entity.components.push(new ListComponent().assign({ list: new ArraySchema("one", "two") }));
             assert.strictEqual(entity.components[2][$changes].isFiltered, true);
 
             entity.component = new Component();