plain schema(): fix auto-initializing child schemas if they don't require initialize() arguments

Author: endel

package.json

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

src/annotations.ts

@@ -597,8 +597,12 @@ export function schema<
 
                 } else if (value['type'] !== undefined && Schema.is(value['type'])) {
                     // Direct Schema type: Type → new Type()
-                    // TODO: should we auto-initialize Schema instances, in case their initialize() method is not defined?
-                    // defaultValues[fieldName] = new value['type']();
+                    if (!value['type'].prototype.initialize || value['type'].prototype.initialize.length === 0) {
+                        // only auto-initialize Schema instances if:
+                        // - they don't have an initialize method
+                        // - or initialize method doesn't accept any parameters
+                        defaultValues[fieldName] = new value['type']();
+                    }
                 }
             } else {
                 defaultValues[fieldName] = value['default'];
@@ -608,8 +612,12 @@ export function schema<
         } else if (typeof (value) === "function") {
             if (Schema.is(value)) {
                 // Direct Schema type: Type → new Type()
-                // TODO: should we auto-initialize Schema instances, in case their initialize() method is not defined?
-                // defaultValues[fieldName] = new value();
+                if (!value.prototype.initialize || value.prototype.initialize.length === 0) {
+                    // only auto-initialize Schema instances if:
+                    // - they don't have an initialize method
+                    // - or initialize method doesn't accept any parameters
+                    defaultValues[fieldName] = new value();
+                }
                 fields[fieldName] = getNormalizedType(value);
             } else {
                 methods[fieldName] = value;

test/Definition.test.ts

@@ -307,8 +307,8 @@ describe("Definition Tests", () => {
             });
 
             const state = new State();
-            assert.ok(state.entity1 === undefined);
-            assert.ok(state.entity2 === undefined);
+            assert.ok(state.entity1 instanceof Entity);
+            assert.ok(state.entity2 instanceof Entity);
 
             assert.ok(state.map instanceof MapSchema);
             assert.strictEqual(state.map.size, 0);
@@ -320,6 +320,8 @@ 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);
@@ -675,7 +677,7 @@ describe("Definition Tests", () => {
             });
         });
 
-        it("should exclude parent props from initialize method", () => {
+        it("should exclude parent props from initialize method (1)", () => {
             const StatSchema = schema({
                 value: 'number',
                 initialize(value: number) {
@@ -710,6 +712,28 @@ describe("Definition Tests", () => {
             assert.strictEqual(entity.stats.get('hp')?.value, 500);
         });
 
+        it("should exclude parent props from encode method (2)", () => {
+            const AnotherRandomSchema = schema({
+                value: { type: 'string', default: 'world', },
+            });
+
+            const RandomSchema = schema({
+                value: { type: 'string', default: 'hello', },
+                anotherRandom: AnotherRandomSchema,
+            });
+
+            const StatSchema = schema({
+                value: 'number',
+                random: RandomSchema,
+                initialize(value: number) {
+                    this.value = value;
+                },
+            });
+
+            const entity = new StatSchema(5);
+            console.log(entity.random.value, entity.random.anotherRandom.value);
+        })
+
     });
 
 });