@colyseus/schema 3.0.0-alpha.15 → 3.0.0-alpha.16

package/lib/encoding/spec.d.ts

@@ -21,5 +21,6 @@ export declare enum OPERATION {
     UNSHIFT = 12,
     REVERSE = 15,
     MOVE = 32,
-    DELETE_BY_REFID = 33
+    DELETE_BY_REFID = 33,// This operation is only used at ENCODING time. During DECODING, DELETE_BY_REFID is converted to DELETE
+    ADD_BY_REFID = 129
 }

package/lib/encoding/spec.js

@@ -26,5 +26,6 @@ var OPERATION;
     OPERATION[OPERATION["REVERSE"] = 15] = "REVERSE";
     OPERATION[OPERATION["MOVE"] = 32] = "MOVE";
     OPERATION[OPERATION["DELETE_BY_REFID"] = 33] = "DELETE_BY_REFID";
+    OPERATION[OPERATION["ADD_BY_REFID"] = 129] = "ADD_BY_REFID";
 })(OPERATION || (exports.OPERATION = OPERATION = {}));
 //# sourceMappingURL=spec.js.map

package/lib/encoding/spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../src/encoding/spec.ts"],"names":[],"mappings":";;;AAAa,QAAA,mBAAmB,GAAG,GAAG,CAAC,CAAC,4DAA4D;AACvF,QAAA,OAAO,GAAG,GAAG,CAAC;AAE3B;;GAEG;AACH,IAAY,SAsBX;AAtBD,WAAY,SAAS;IACjB,yCAAS,CAAA;IACT,+CAAW,CAAA;IACX,8CAAW,CAAA;IACX,gEAAoB,CAAA;IACpB,2DAAkB,CAAA;IAClB,+DAAoB,CAAA;IAEpB;;OAEG;IACH,4CAAU,CAAA;IAEV;;OAEG;IACH,0CAAS,CAAA;IACT,gDAAY,CAAA;IACZ,gDAAY,CAAA;IACZ,0CAAS,CAAA;IACT,gEAAoB,CAAA;AAExB,CAAC,EAtBW,SAAS,yBAAT,SAAS,QAsBpB","sourcesContent":["export const SWITCH_TO_STRUCTURE = 255; // (decoding collides with DELETE_AND_ADD + fieldIndex = 63)\nexport const TYPE_ID = 213;\n\n/**\n * Encoding Schema field operations.\n */\nexport enum OPERATION {\n    ADD = 128,            // (10000000) add new structure/primitive\n    REPLACE = 0,          // (00000001) replace structure/primitive\n    DELETE = 64,          // (01000000) delete field\n    DELETE_AND_MOVE = 96, // () add new structure/primitive\n    MOVE_AND_ADD = 160,   // () add new structure/primitive\n    DELETE_AND_ADD = 192, // (11000000) DELETE field, followed by an ADD\n\n    /**\n     * Collection operations\n     */\n    CLEAR = 10,\n\n    /**\n     * ArraySchema operations\n     */\n    PUSH = 11,\n    UNSHIFT = 12,\n    REVERSE = 15,\n    MOVE = 32,\n    DELETE_BY_REFID = 33, // This operation is only used at ENCODING time. During DECODING, DELETE_BY_REFID is converted to DELETE\n\n}\n"]}
+{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../src/encoding/spec.ts"],"names":[],"mappings":";;;AAAa,QAAA,mBAAmB,GAAG,GAAG,CAAC,CAAC,4DAA4D;AACvF,QAAA,OAAO,GAAG,GAAG,CAAC;AAE3B;;GAEG;AACH,IAAY,SAuBX;AAvBD,WAAY,SAAS;IACjB,yCAAS,CAAA;IACT,+CAAW,CAAA;IACX,8CAAW,CAAA;IACX,gEAAoB,CAAA;IACpB,2DAAkB,CAAA;IAClB,+DAAoB,CAAA;IAEpB;;OAEG;IACH,4CAAU,CAAA;IAEV;;OAEG;IACH,0CAAS,CAAA;IACT,gDAAY,CAAA;IACZ,gDAAY,CAAA;IACZ,0CAAS,CAAA;IACT,gEAAoB,CAAA;IACpB,2DAAkB,CAAA;AAEtB,CAAC,EAvBW,SAAS,yBAAT,SAAS,QAuBpB","sourcesContent":["export const SWITCH_TO_STRUCTURE = 255; // (decoding collides with DELETE_AND_ADD + fieldIndex = 63)\nexport const TYPE_ID = 213;\n\n/**\n * Encoding Schema field operations.\n */\nexport enum OPERATION {\n    ADD = 128,            // (10000000) add new structure/primitive\n    REPLACE = 0,          // (00000001) replace structure/primitive\n    DELETE = 64,          // (01000000) delete field\n    DELETE_AND_MOVE = 96, // () add new structure/primitive\n    MOVE_AND_ADD = 160,   // () add new structure/primitive\n    DELETE_AND_ADD = 192, // (11000000) DELETE field, followed by an ADD\n\n    /**\n     * Collection operations\n     */\n    CLEAR = 10,\n\n    /**\n     * ArraySchema operations\n     */\n    PUSH = 11,\n    UNSHIFT = 12,\n    REVERSE = 15,\n    MOVE = 32,\n    DELETE_BY_REFID = 33, // This operation is only used at ENCODING time. During DECODING, DELETE_BY_REFID is converted to DELETE\n    ADD_BY_REFID = 129,\n\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/schema",
-  "version": "3.0.0-alpha.15",
+  "version": "3.0.0-alpha.16",
   "description": "Binary state serializer with delta encoding for games",
   "bin": {
     "schema-codegen": "./bin/schema-codegen"
@@ -78,7 +78,7 @@
     "source-map-support": "^0.5.13",
     "ts-node": "^10.9.2",
     "tslib": "^2.1.0",
-    "tsx": "^4.7.0",
+    "tsx": "^4.15.7",
     "typescript": "^5.3.3"
   },
   "nyc": {

package/src/bench_encode.ts

@@ -0,0 +1,66 @@
+import { nanoid } from "nanoid";
+import { Schema, type, MapSchema, ArraySchema, Encoder } from ".";
+import * as benchmark from "benchmark";
+
+const suite = new benchmark.Suite();
+
+class AttributeNew extends Schema {
+    @type("string") name: string;
+    @type("number") value: number;
+}
+
+class ItemNew extends Schema {
+    @type("number") price: number;
+    @type([ AttributeNew ]) attributes = new ArraySchema<AttributeNew>();
+}
+
+class PositionNew extends Schema {
+    @type("number") x: number;
+    @type("number") y: number;
+}
+
+class PlayerNew extends Schema {
+    @type(PositionNew) position = new PositionNew();
+    @type({ map: ItemNew }) items = new MapSchema<ItemNew>();
+}
+
+class StateNew extends Schema {
+    @type({ map: PlayerNew }) players = new MapSchema<PlayerNew>();
+    @type("string") currentTurn;
+}
+
+const state = new StateNew();
+
+for (let i = 0; i < 50; i++) {
+    const player = new PlayerNew();
+    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 ItemNew();
+        item.price = (i + 1) * 50;
+        for (let k = 0; k < 5; k++) {
+            const attr = new AttributeNew();
+            attr.name = `Attribute ${k}`;
+            attr.value = k;
+            item.attributes.push(attr);
+
+        }
+        player.items.set(`item-${j}`, item);
+    }
+}
+
+
+Encoder.BUFFER_SIZE = 1024 * 128;
+const encoder = new Encoder(state);
+
+// measure time to .encodeAll()
+
+const now = Date.now();
+for (let i = 0; i < 1000; i++) {
+    encoder.encodeAll();
+}
+console.log(Date.now() - now);
+
+console.log(Array.from(encoder.encodeAll()).join(","));

package/src/decoder/DecodeOperation.ts

@@ -251,6 +251,7 @@ export const decodeKeyValueOperation: DecodeOperation = function (
         dynamicIndex = ref['getIndex'](index);
     }
 
+
     const { value, previousValue } = decodeValue(
         decoder,
         operation,
@@ -303,7 +304,10 @@ export const decodeArray: DecodeOperation = function (
     allChanges: DataChange[]
 ) {
     // "uncompressed" index + operation (array/map items)
-    const operation = bytes[it.offset++];
+    let operation = bytes[it.offset++];
+
+    let isSchemaChild: boolean;
+    let index: number;
 
     if (operation === OPERATION.CLEAR) {
         //
@@ -319,7 +323,7 @@ export const decodeArray: DecodeOperation = function (
         // TODO: refactor here, try to follow same flow as below
         const refId = decode.number(bytes, it);
         const previousValue = decoder.root.refs.get(refId);
-        const index = ref.findIndex((value) => value === previousValue);
+        index = ref.findIndex((value) => value === previousValue);
         ref[$deleteByIndex](index);
         allChanges.push({
             ref,
@@ -330,10 +334,26 @@ export const decodeArray: DecodeOperation = function (
             value: undefined,
             previousValue,
         });
+
         return;
+
+    } else if (operation === OPERATION.ADD_BY_REFID) {
+        isSchemaChild = true;
+        // operation = OPERATION.ADD;
+
+        const refId = decode.number(bytes, it);
+        const itemByRefId = decoder.root.refs.get(refId);
+
+        // use existing index, or push new value
+        index = (itemByRefId)
+            ? ref.findIndex((value) => value === itemByRefId)
+            : ref.length;
+
+    } else {
+        isSchemaChild = false;
+        index = decode.number(bytes, it);
     }
 
-    const index = decode.number(bytes, it);
     const type = ref[$childType];
 
     let dynamicIndex: number | string = index;

package/src/decoder/strategy/StateCallbacks.ts

@@ -155,17 +155,7 @@ export function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): GetCal
                 // Handle collection of items
                 //
 
-                if (change.op === OPERATION.ADD && change.previousValue === undefined) {
-                    // triger onAdd
-
-                    isTriggeringOnAdd = true;
-                    const addCallbacks = $callbacks[OPERATION.ADD];
-                    for (let i = addCallbacks?.length - 1; i >= 0; i--) {
-                        addCallbacks[i](change.value, change.dynamicIndex ?? change.field);
-                    }
-                    isTriggeringOnAdd = false;
-
-                } else if ((change.op & OPERATION.DELETE) === OPERATION.DELETE) {
+                if ((change.op & OPERATION.DELETE) === OPERATION.DELETE) {
                     //
                     // FIXME: `previousValue` should always be available.
                     //
@@ -185,6 +175,16 @@ export function getStateCallbacks<T extends Schema>(decoder: Decoder<T>): GetCal
                             addCallbacks[i](change.value, change.dynamicIndex ?? change.field);
                         }
                     }
+
+                } else if ((change.op & OPERATION.ADD) === OPERATION.ADD && change.previousValue === undefined) {
+                    // triger onAdd
+
+                    isTriggeringOnAdd = true;
+                    const addCallbacks = $callbacks[OPERATION.ADD];
+                    for (let i = addCallbacks?.length - 1; i >= 0; i--) {
+                        addCallbacks[i](change.value, change.dynamicIndex ?? change.field);
+                    }
+                    isTriggeringOnAdd = false;
                 }
 
                 // trigger onChange

package/src/encoder/EncodeOperation.ts

@@ -204,18 +204,22 @@ export const encodeArray: EncodeOperation = function (
     hasView: boolean,
 ) {
     const ref = changeTree.ref;
+    const useOperationByRefId = hasView && changeTree.isFiltered && (typeof (changeTree.getType(field)) !== "string");
 
-    if (
-        hasView &&
-        operation === OPERATION.DELETE &&
-        typeof (changeTree.getType(field)) !== "string"
-    ) {
-        // encode delete by refId (array of schemas)
-        bytes[it.offset++] = OPERATION.DELETE_BY_REFID;
-        const value =  ref['tmpItems'][field];
-        const refId = value[$changes].refId;
-        encode.number(bytes, refId, it);
-        return;
+    let refOrIndex: number;
+
+    if (useOperationByRefId) {
+        refOrIndex = ref['tmpItems'][field][$changes].refId;
+
+        if (operation === OPERATION.DELETE) {
+            operation = OPERATION.DELETE_BY_REFID;
+
+        } else if (operation === OPERATION.ADD) {
+            operation = OPERATION.ADD_BY_REFID;
+        }
+
+    } else {
+        refOrIndex = field;
     }
 
     // encode operation
@@ -227,7 +231,7 @@ export const encodeArray: EncodeOperation = function (
     }
 
     // encode index
-    encode.number(bytes, field, it);
+    encode.number(bytes, refOrIndex, it);
 
     // Do not encode value for DELETE operations
     if (operation === OPERATION.DELETE) {

package/src/encoding/spec.ts

@@ -25,5 +25,6 @@ export enum OPERATION {
     REVERSE = 15,
     MOVE = 32,
     DELETE_BY_REFID = 33, // This operation is only used at ENCODING time. During DECODING, DELETE_BY_REFID is converted to DELETE
+    ADD_BY_REFID = 129,
 
 }