@colyseus/schema 2.0.35 → 2.0.37

package/lib/v2_bench.js

@@ -0,0 +1,141 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+// globalThis.interval = setInterval(() => {}, 1000);
+// class Item extends Schema {
+//     @type("string") name: string;
+// }
+// class RootState extends Schema {
+//     @type([Item]) items = new ArraySchema<Item>();
+// }
+// const state = new RootState();
+// state.items.push(new Item().assign({ name: "hello" }));
+// console.log("Encoded:", state.encode());
+class Vec3 extends index_1.Schema {
+}
+__decorate([
+    (0, index_1.type)("number"),
+    __metadata("design:type", Number)
+], Vec3.prototype, "x", void 0);
+__decorate([
+    (0, index_1.type)("number"),
+    __metadata("design:type", Number)
+], Vec3.prototype, "y", void 0);
+__decorate([
+    (0, index_1.type)("number"),
+    __metadata("design:type", Number)
+], Vec3.prototype, "z", void 0);
+class Base extends index_1.Schema {
+}
+class Entity extends index_1.Schema {
+    constructor() {
+        super(...arguments);
+        this.position = new Vec3().assign({ x: 0, y: 0, z: 0 });
+    }
+}
+__decorate([
+    (0, index_1.type)(Vec3),
+    __metadata("design:type", Object)
+], Entity.prototype, "position", void 0);
+class Player extends Entity {
+    constructor() {
+        super(...arguments);
+        this.rotation = new Vec3().assign({ x: 0, y: 0, z: 0 });
+        this.secret = "private info only for this player";
+    }
+}
+__decorate([
+    (0, index_1.type)(Vec3),
+    __metadata("design:type", Object)
+], Player.prototype, "rotation", void 0);
+__decorate([
+    (0, index_1.type)("string"),
+    __metadata("design:type", String)
+], Player.prototype, "secret", void 0);
+class State extends index_1.Schema {
+    constructor() {
+        super(...arguments);
+        // @type({ map: Base }) players = new MapSchema<Entity>();
+        this.num = 0;
+        this.str = "Hello world!";
+        // @type(Entity) entity = new Player().assign({
+        //     position: new Vec3().assign({ x: 1, y: 2, z: 3 }),
+        //     rotation: new Vec3().assign({ x: 4, y: 5, z: 6 }),
+        // });
+        this.entities = new index_1.MapSchema();
+    }
+}
+__decorate([
+    (0, index_1.type)("number"),
+    __metadata("design:type", Number)
+], State.prototype, "num", void 0);
+__decorate([
+    (0, index_1.type)("string"),
+    __metadata("design:type", Object)
+], State.prototype, "str", void 0);
+__decorate([
+    (0, index_1.type)({ map: Entity }),
+    __metadata("design:type", Object)
+], State.prototype, "entities", void 0);
+const state = new State();
+state.entities.set("one", new Player().assign({
+    position: new Vec3().assign({ x: 1, y: 2, z: 3 }),
+    rotation: new Vec3().assign({ x: 1, y: 2, z: 3 }),
+}));
+state.entities.set("two", new Player().assign({
+    position: new Vec3().assign({ x: 4, y: 5, z: 6 }),
+    rotation: new Vec3().assign({ x: 7, y: 8, z: 9 }),
+}));
+let encoded = state.encode();
+console.log(`(${encoded.length})`, encoded);
+globalThis.perform = function () {
+    for (let i = 0; i < 500000; i++) {
+        state.encodeAll();
+    }
+};
+function logTime(label, callback) {
+    const time = Date.now();
+    for (let i = 0; i < 500000; i++) {
+        callback();
+    }
+    console.log(`${label}:`, Date.now() - time);
+}
+logTime("encode time", () => state.encodeAll());
+const decoded = new State();
+logTime("decode time", () => decoded.decode(encoded));
+// const time = Date.now();
+// console.profile();
+// for (let i = 0; i < 300000; i++) {
+//   state.encodeAll();
+// }
+// console.profileEnd();
+// console.log("encode time:", Date.now() - time);
+// const decoded = Reflection.decode(Reflection.encode(state));
+// decoded.decode(encoded);
+//
+// console.log(decoded.toJSON());
+//
+// const rotation = state.entity.rotation;
+// rotation.x = 100;
+//
+// encoded = state.encode();
+// console.log({encoded});
+//
+// decoded.decode(encoded);
+// console.log(decoded.toJSON());
+// const time = Date.now();
+// for (let i = 0; i < 300000; i++) {
+//   const state = new State();
+//   state.encode();
+// }
+// console.log("encode time:", Date.now() - time);
+//# sourceMappingURL=v2_bench.js.map

package/lib/v2_bench.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v2_bench.js","sourceRoot":"","sources":["../src/v2_bench.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAA2E;AAE3E,qDAAqD;AAErD,8BAA8B;AAC9B,oCAAoC;AACpC,IAAI;AAEJ,mCAAmC;AACnC,qDAAqD;AACrD,IAAI;AACJ,iCAAiC;AACjC,0DAA0D;AAE1D,2CAA2C;AAE3C,MAAM,IAAK,SAAQ,cAAM;CAIxB;AAHmB;IAAf,IAAA,YAAI,EAAC,QAAQ,CAAC;;+BAAW;AACV;IAAf,IAAA,YAAI,EAAC,QAAQ,CAAC;;+BAAW;AACV;IAAf,IAAA,YAAI,EAAC,QAAQ,CAAC;;+BAAW;AAG9B,MAAM,IAAK,SAAQ,cAAM;CAAG;AAE5B,MAAM,MAAO,SAAQ,cAAM;IAA3B;;QACgB,aAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;CAAA;AADe;IAAX,IAAA,YAAI,EAAC,IAAI,CAAC;;wCAAoD;AAGnE,MAAM,MAAO,SAAQ,MAAM;IAA3B;;QACgB,aAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAC/C,WAAM,GAAW,mCAAmC,CAAC;IACzE,CAAC;CAAA;AAFe;IAAX,IAAA,YAAI,EAAC,IAAI,CAAC;;wCAAoD;AAC/C;IAAf,IAAA,YAAI,EAAC,QAAQ,CAAC;;sCAAsD;AAGzE,MAAM,KAAM,SAAQ,cAAM;IAA1B;;QACI,0DAA0D;QAC1C,QAAG,GAAW,CAAC,CAAC;QAChB,QAAG,GAAG,cAAc,CAAC;QACrC,+CAA+C;QAC/C,yDAAyD;QACzD,yDAAyD;QACzD,MAAM;QACiB,aAAQ,GAAG,IAAI,iBAAS,EAAE,CAAC;IACtD,CAAC;CAAA;AAPmB;IAAf,IAAA,YAAI,EAAC,QAAQ,CAAC;;kCAAiB;AAChB;IAAf,IAAA,YAAI,EAAC,QAAQ,CAAC;;kCAAsB;AAKd;IAAtB,IAAA,YAAI,EAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;;uCAA4B;AAGtD,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;AAE1B,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,MAAM,EAAE,CAAC,MAAM,CAAC;IAC5C,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACjD,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;CAClD,CAAC,CAAC,CAAC;AAEJ,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,MAAM,EAAE,CAAC,MAAM,CAAC;IAC5C,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACjD,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;CAClD,CAAC,CAAC,CAAC;AAEJ,IAAI,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;AAC7B,OAAO,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC;AAE5C,UAAU,CAAC,OAAO,GAAG;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9B,KAAK,CAAC,SAAS,EAAE,CAAC;IACtB,CAAC;AACL,CAAC,CAAA;AAED,SAAS,OAAO,CAAC,KAAa,EAAE,QAAkB;IAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9B,QAAQ,EAAE,CAAC;IACf,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AAChD,CAAC;AACD,OAAO,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;AAEhD,MAAM,OAAO,GAAG,IAAI,KAAK,EAAE,CAAC;AAC5B,OAAO,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AAEtD,2BAA2B;AAC3B,qBAAqB;AACrB,qCAAqC;AACrC,uBAAuB;AACvB,IAAI;AACJ,wBAAwB;AACxB,kDAAkD;AAElD,+DAA+D;AAC/D,2BAA2B;AAC3B,EAAE;AACF,iCAAiC;AACjC,EAAE;AACF,0CAA0C;AAC1C,oBAAoB;AACpB,EAAE;AACF,4BAA4B;AAC5B,0BAA0B;AAC1B,EAAE;AACF,2BAA2B;AAC3B,iCAAiC;AAEjC,2BAA2B;AAC3B,qCAAqC;AACrC,+BAA+B;AAC/B,oBAAoB;AACpB,IAAI;AACJ,kDAAkD","sourcesContent":["import { Schema, type, MapSchema, ArraySchema, Reflection } from \"./index\";\n\n// globalThis.interval = setInterval(() => {}, 1000);\n\n// class Item extends Schema {\n//     @type(\"string\") name: string;\n// }\n\n// class RootState extends Schema {\n//     @type([Item]) items = new ArraySchema<Item>();\n// }\n// const state = new RootState();\n// state.items.push(new Item().assign({ name: \"hello\" }));\n\n// console.log(\"Encoded:\", state.encode());\n\nclass Vec3 extends Schema {\n    @type(\"number\") x: number;\n    @type(\"number\") y: number;\n    @type(\"number\") z: number;\n}\n\nclass Base extends Schema {}\n\nclass Entity extends Schema {\n    @type(Vec3) position = new Vec3().assign({ x: 0, y: 0, z: 0 });\n}\n\nclass Player extends Entity {\n    @type(Vec3) rotation = new Vec3().assign({ x: 0, y: 0, z: 0 });\n    @type(\"string\") secret: string = \"private info only for this player\";\n}\n\nclass State extends Schema {\n    // @type({ map: Base }) players = new MapSchema<Entity>();\n    @type(\"number\") num: number = 0;\n    @type(\"string\") str = \"Hello world!\";\n    // @type(Entity) entity = new Player().assign({\n    //     position: new Vec3().assign({ x: 1, y: 2, z: 3 }),\n    //     rotation: new Vec3().assign({ x: 4, y: 5, z: 6 }),\n    // });\n    @type({ map: Entity }) entities = new MapSchema();\n}\n\nconst state = new State();\n\nstate.entities.set(\"one\", new Player().assign({\n  position: new Vec3().assign({ x: 1, y: 2, z: 3 }),\n  rotation: new Vec3().assign({ x: 1, y: 2, z: 3 }),\n}));\n\nstate.entities.set(\"two\", new Player().assign({\n  position: new Vec3().assign({ x: 4, y: 5, z: 6 }),\n  rotation: new Vec3().assign({ x: 7, y: 8, z: 9 }),\n}));\n\nlet encoded = state.encode();\nconsole.log(`(${encoded.length})`, encoded);\n\nglobalThis.perform = function() {\n    for (let i = 0; i < 500000; i++) {\n        state.encodeAll();\n    }\n}\n\nfunction logTime(label: string, callback: Function) {\n    const time = Date.now();\n    for (let i = 0; i < 500000; i++) {\n        callback();\n    }\n    console.log(`${label}:`, Date.now() - time);\n}\nlogTime(\"encode time\", () => state.encodeAll());\n\nconst decoded = new State();\nlogTime(\"decode time\", () => decoded.decode(encoded));\n\n// const time = Date.now();\n// console.profile();\n// for (let i = 0; i < 300000; i++) {\n//   state.encodeAll();\n// }\n// console.profileEnd();\n// console.log(\"encode time:\", Date.now() - time);\n\n// const decoded = Reflection.decode(Reflection.encode(state));\n// decoded.decode(encoded);\n//\n// console.log(decoded.toJSON());\n//\n// const rotation = state.entity.rotation;\n// rotation.x = 100;\n//\n// encoded = state.encode();\n// console.log({encoded});\n//\n// decoded.decode(encoded);\n// console.log(decoded.toJSON());\n\n// const time = Date.now();\n// for (let i = 0; i < 300000; i++) {\n//   const state = new State();\n//   state.encode();\n// }\n// console.log(\"encode time:\", Date.now() - time);\n\n"]}

package/package.json

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

package/src/annotations.ts

@@ -319,7 +319,7 @@ export function type (
                         );
                     }
 
-                } else if (this[fieldCached]) {
+                } else if (this[fieldCached] !== undefined) {
                     //
                     // Setting a field to `null` or `undefined` will delete it.
                     //

package/src/bench_encode.ts

@@ -0,0 +1,108 @@
+import { nanoid } from "nanoid";
+import { Schema, type, MapSchema, ArraySchema } from ".";
+// import * as benchmark from "benchmark";
+
+// const suite = new benchmark.Suite();
+
+class Attribute extends Schema {
+    @type("string") name: string;
+    @type("number") value: number;
+}
+
+class Item extends Schema {
+    @type("number") price: number;
+    @type([ Attribute ]) attributes = new ArraySchema<Attribute>();
+}
+
+class Position extends Schema {
+    @type("number") x: number;
+    @type("number") y: number;
+}
+
+class Player extends Schema {
+    @type(Position) position = new Position();
+    @type({ map: Item }) items = new MapSchema<Item>();
+}
+
+class State extends Schema {
+    @type({ map: Player }) players = new MapSchema<Player>();
+    @type("string") currentTurn;
+}
+
+const state = new State();
+
+let now = Date.now();
+
+// for (let i = 0; i < 10000; i++) {
+//     const player = new Player();
+//     state.players.set(`p-${nanoid()}`, player);
+//
+//     player.position.x = (i + 1) * 100;
+//     player.position.y = (i + 1) * 100;
+//     for (let j = 0; j < 10; j++) {
+//         const item = new Item();
+//         item.price = (i + 1) * 50;
+//         for (let k = 0; k < 5; k++) {
+//             const attr = new Attribute();
+//             attr.name = `Attribute ${k}`;
+//             attr.value = k;
+//             item.attributes.push(attr);
+//
+//         }
+//         player.items.set(`item-${j}`, item);
+//     }
+// }
+// console.log("time to make changes:", Date.now() - now);
+//
+// process.exit();
+
+
+// measure time to .encodeAll()
+
+now = Date.now();
+for (let i = 0; i < 1000; i++) {
+    state.encodeAll();
+}
+console.log(Date.now() - now);
+
+let avgTimeToEncode = 0;
+let avgTimeToMakeChanges = 0;
+const total = 100;
+
+const allEncodes = Date.now();
+for (let i = 0; i < total; i++) {
+    now = Date.now();
+    for (let j = 0; j < 50; j++) {
+        const player = new Player();
+        state.players.set(`p-${nanoid()}`, player);
+
+        player.position.x = (j + 1) * 100;
+        player.position.y = (j + 1) * 100;
+        for (let k = 0; k < 10; k++) {
+            const item = new Item();
+            item.price = (j + 1) * 50;
+            for (let l = 0; l < 5; l++) {
+                const attr = new Attribute();
+                attr.name = `Attribute ${l}`;
+                attr.value = l;
+                item.attributes.push(attr);
+            }
+            player.items.set(`item-${k}`, item);
+        }
+    }
+    const timeToMakeChanges = Date.now() - now;
+    console.log("time to make changes:", timeToMakeChanges);
+    avgTimeToMakeChanges += timeToMakeChanges;
+
+    now = Date.now();
+    state.encode();
+    const timeToEncode = Date.now() - now;
+    console.log("time to encode:", timeToEncode);
+    avgTimeToEncode += timeToEncode;
+}
+
+console.log("avg time to encode:", (avgTimeToEncode) / total);
+console.log("avg time to make changes:", (avgTimeToMakeChanges) / total);
+console.log("time for all encodes:", Date.now() - allEncodes);
+
+console.log(Array.from(state.encodeAll()).length, "bytes");

package/src/types/ArraySchema.ts

@@ -88,7 +88,7 @@ export class ArraySchema<V = any> implements Array<V>, SchemaDecoderCallbacks {
 
     protected $refId: number = 0;
 
-    [n: number]: V;
+    [n: number]: V | undefined;
 
     //
     // Decoding callbacks
@@ -163,7 +163,7 @@ export class ArraySchema<V = any> implements Array<V>, SchemaDecoderCallbacks {
         return value;
     }
 
-    at(index: number) {
+    at(index: number): V | undefined {
         //
         // FIXME: this should be O(1)
         //
@@ -395,6 +395,8 @@ export class ArraySchema<V = any> implements Array<V>, SchemaDecoderCallbacks {
      * @param thisArg An object to which the this keyword can refer in the callbackfn function.
      * If thisArg is omitted, undefined is used as the this value.
      */
+    every<S extends V>(predicate: (value: V, index: number, array: V[]) => value is S, thisArg?: any): this is S[];
+    every(callbackfn: (value: V, index: number, array: V[]) => unknown, thisArg?: any): boolean;
     every(callbackfn: (value: V, index: number, array: V[]) => unknown, thisArg?: any): boolean {
         return Array.from(this.$items.values()).every(callbackfn, thisArg);
     }