@pylonsync/realtime 0.22.11 → 0.22.12

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.22.11",
+  "version": "0.22.12",
   "description": "Pylon realtime shard client pieces with no framework: the wire protocol, codecs, and the entity replication decoder and table.",
   "type": "module",
   "main": "./src/index.ts",

package/src/wire.fixtures.json

@@ -0,0 +1,255 @@
+{
+  "frames": [
+    {
+      "ack": 0,
+      "codec": 0,
+      "frame": "0100000000000000000100000000000000007b22666c6f617473223a5b302e352c2d312e352c312e323334353637383930313233343536372c31652b3330305d2c22696e7473223a5b302c312c3132372c3132382c3235352c3235362c36353533352c36353533362c343239343936373239352c343239343936373239362c2d312c2d33322c2d33332c2d3132382c2d3132392c2d33323736382c2d33323736392c2d323134373438333634382c2d323134373438333634392c393030373139393235343734303939315d2c226e6573746564223a7b2261223a7b2262223a7b2263223a5b312c5b322c5b335d5d5d7d7d7d2c226e6f7468696e67223a6e756c6c2c22706c6179657273223a5b7b22616c697665223a747275652c226870223a3130302c226964223a227031222c2278223a31322e352c2279223a2d332e32357d2c7b22616c697665223a66616c73652c226870223a302c226964223a227032222c2278223a302e302c2279223a31652d377d5d2c22737472696e6773223a5b22222c2261222c22c3a920c3bc20e4b8ade69687222c226120737472696e672074686174206973206c6f6e676572207468616e207468697274792d6f6e652062797465732c20736f206974206e656564732073747238225d2c227469636b5f72617465223a32307d",
+      "kind": 1,
+      "payload": {
+        "floats": [
+          0.5,
+          -1.5,
+          1.2345678901234567,
+          1e+300
+        ],
+        "ints": [
+          0,
+          1,
+          127,
+          128,
+          255,
+          256,
+          65535,
+          65536,
+          4294967295,
+          4294967296,
+          -1,
+          -32,
+          -33,
+          -128,
+          -129,
+          -32768,
+          -32769,
+          -2147483648,
+          -2147483649,
+          9007199254740991
+        ],
+        "nested": {
+          "a": {
+            "b": {
+              "c": [
+                1,
+                [
+                  2,
+                  [
+                    3
+                  ]
+                ]
+              ]
+            }
+          }
+        },
+        "nothing": null,
+        "players": [
+          {
+            "alive": true,
+            "hp": 100,
+            "id": "p1",
+            "x": 12.5,
+            "y": -3.25
+          },
+          {
+            "alive": false,
+            "hp": 0,
+            "id": "p2",
+            "x": 0.0,
+            "y": 1e-7
+          }
+        ],
+        "strings": [
+          "",
+          "a",
+          "é ü 中文",
+          "a string that is longer than thirty-one bytes, so it needs str8"
+        ],
+        "tick_rate": 20
+      },
+      "tick": 1
+    },
+    {
+      "ack": 3,
+      "codec": 1,
+      "frame": "01010000000000000007000000000000000387a6666c6f61747394cb3fe0000000000000cbbff8000000000000cb3ff3c0ca428c59fbcb7e37e43c8800759ca4696e7473dc001400017fcc80ccffcd0100cdffffce00010000ceffffffffcf0000000100000000ffe0d0dfd080d1ff7fd18000d2ffff7fffd280000000d3ffffffff7fffffffcf001fffffffffffffa66e657374656481a16181a16281a163920192029103a76e6f7468696e67c0a7706c61796572739285a5616c697665c3a2687064a26964a27031a178cb4029000000000000a179cbc00a00000000000085a5616c697665c2a2687000a26964a27032a178cb0000000000000000a179cb3e7ad7f29abcaf48a7737472696e677394a0a161acc3a920c3bc20e4b8ade69687d93f6120737472696e672074686174206973206c6f6e676572207468616e207468697274792d6f6e652062797465732c20736f206974206e656564732073747238a97469636b5f7261746514",
+      "kind": 1,
+      "payload": {
+        "floats": [
+          0.5,
+          -1.5,
+          1.2345678901234567,
+          1e+300
+        ],
+        "ints": [
+          0,
+          1,
+          127,
+          128,
+          255,
+          256,
+          65535,
+          65536,
+          4294967295,
+          4294967296,
+          -1,
+          -32,
+          -33,
+          -128,
+          -129,
+          -32768,
+          -32769,
+          -2147483648,
+          -2147483649,
+          9007199254740991
+        ],
+        "nested": {
+          "a": {
+            "b": {
+              "c": [
+                1,
+                [
+                  2,
+                  [
+                    3
+                  ]
+                ]
+              ]
+            }
+          }
+        },
+        "nothing": null,
+        "players": [
+          {
+            "alive": true,
+            "hp": 100,
+            "id": "p1",
+            "x": 12.5,
+            "y": -3.25
+          },
+          {
+            "alive": false,
+            "hp": 0,
+            "id": "p2",
+            "x": 0.0,
+            "y": 1e-7
+          }
+        ],
+        "strings": [
+          "",
+          "a",
+          "é ü 中文",
+          "a string that is longer than thirty-one bytes, so it needs str8"
+        ],
+        "tick_rate": 20
+      },
+      "tick": 7
+    },
+    {
+      "ack": 9007199254740990,
+      "codec": 0,
+      "frame": "0100001fffffffffffff001ffffffffffffe7b7d",
+      "kind": 1,
+      "payload": {},
+      "tick": 9007199254740991
+    },
+    {
+      "ack": 41,
+      "codec": 0,
+      "frame": "0200000000000000000800000000000000297b22636c69656e745f736571223a34322c22636f6465223a22726174655f6c696d69746564222c226d657373616765223a22746f6f206d616e7920696e70757473227d",
+      "kind": 2,
+      "payload": {
+        "client_seq": 42,
+        "code": "rate_limited",
+        "message": "too many inputs"
+      },
+      "tick": 8
+    },
+    {
+      "ack": 41,
+      "codec": 1,
+      "frame": "02010000000000000008000000000000002983aa636c69656e745f736571c0a4636f6465a7696e76616c6964a76d657373616765b4696e70757420646964206e6f74206465636f6465",
+      "kind": 2,
+      "payload": {
+        "client_seq": null,
+        "code": "invalid",
+        "message": "input did not decode"
+      },
+      "tick": 8
+    },
+    {
+      "ack": 41,
+      "codec": 0,
+      "frame": "0400000000000000000900000000000000297b227368617264223a227a6f6e652d32222c227469636b6574223a2276312e65794a6c654841694f6a46392e736967227d",
+      "kind": 4,
+      "payload": {
+        "shard": "zone-2",
+        "ticket": "v1.eyJleHAiOjF9.sig"
+      },
+      "tick": 9
+    }
+  ],
+  "headerLength": 18,
+  "inputs": [
+    {
+      "client_seq": 1,
+      "input": "join",
+      "json": "{\"input\":\"join\",\"client_seq\":1}",
+      "msgpack": "82a5696e707574a46a6f696eaa636c69656e745f73657101"
+    },
+    {
+      "client_seq": 2,
+      "input": {
+        "move_to": {
+          "x": 120.5,
+          "y": 64.0
+        }
+      },
+      "json": "{\"input\":{\"move_to\":{\"x\":120.5,\"y\":64.0}},\"client_seq\":2}",
+      "msgpack": "82a5696e70757481a76d6f76655f746f82a178cb405e200000000000a179cb4050000000000000aa636c69656e745f73657102"
+    },
+    {
+      "client_seq": 300,
+      "input": {
+        "drive": {
+          "air": false,
+          "pos": [
+            20,
+            0,
+            -20
+          ],
+          "speed": 20.25
+        }
+      },
+      "json": "{\"input\":{\"drive\":{\"air\":false,\"pos\":[20,0,-20],\"speed\":20.25}},\"client_seq\":300}",
+      "msgpack": "82a5696e70757481a5647269766583a3616972c2a3706f73931400eca57370656564cb4034400000000000aa636c69656e745f736571cd012c"
+    },
+    {
+      "client_seq": 70000,
+      "input": [
+        1,
+        -1,
+        70000,
+        "x",
+        null,
+        true
+      ],
+      "json": "{\"input\":[1,-1,70000,\"x\",null,true],\"client_seq\":70000}",
+      "msgpack": "82a5696e7075749601ffce00011170a178c0c3aa636c69656e745f736571ce00011170"
+    },
+    {
+      "client_seq": 4294967296,
+      "input": {},
+      "json": "{\"input\":{},\"client_seq\":4294967296}",
+      "msgpack": "82a5696e70757480aa636c69656e745f736571cf0000000100000000"
+    }
+  ],
+  "version": 2
+}

package/src/wire.test.ts

@@ -87,3 +87,45 @@ test("ack batches stay within the datagram size", () => {
   const big = encodeDatagramAckBatches(Array.from({ length: 1300 }, (_, i) => [i % 100, 1] as [number, number]), 1_000_000);
   expect(big.length).toBe(Math.ceil(1300 / MAX_ACKS_PER_MESSAGE));
 });
+
+import wireFixtures from "./wire.fixtures.json";
+
+function hexBytes(hex: string): Uint8Array {
+  const out = new Uint8Array(hex.length / 2);
+  for (let i = 0; i < out.length; i++) out[i] = parseInt(hex.slice(i * 2, i * 2 + 2), 16);
+  return out;
+}
+
+describe("the Rust encoders' frames and inputs (wire.fixtures.json)", () => {
+  test("frames parse and decode to what the server encoded", () => {
+    expect(wireFixtures.version).toBe(2);
+    expect(wireFixtures.headerLength).toBe(SHARD_HEADER_LEN);
+    for (const [i, f] of wireFixtures.frames.entries()) {
+      const bytes = hexBytes(f.frame);
+      const parsed = parseShardFrame(bytes.buffer as ArrayBuffer);
+      expect(parsed.kind, `frame ${i}`).toBe(f.kind);
+      expect(parsed.codec).toBe(f.codec);
+      expect(parsed.tick).toBe(f.tick);
+      expect(parsed.ack).toBe(f.ack);
+      expect(decodeShardPayload(parsed.codec, parsed.payload), `frame ${i}`).toEqual(f.payload);
+      if (parsed.kind === ShardFrameKind.InputRejected) {
+        const r = decodeShardRejection(parsed.codec, parsed.payload);
+        const p = f.payload as { client_seq: number | null; code: string; message: string };
+        expect(r).toEqual({ clientSeq: p.client_seq, code: p.code, message: p.message });
+      }
+    }
+  });
+
+  test("inputs encode to the bytes the server decodes", () => {
+    for (const c of wireFixtures.inputs) {
+      const packed = encodeShardInput(ShardCodec.MessagePack, c.input, c.client_seq) as Uint8Array;
+      // JSON.parse cannot tell 64.0 from 64, so a whole-number float packs
+      // as an integer here (the server reads either into an f32). Compare
+      // the decoded values; the C# client, which keeps number kinds,
+      // matches the bytes exactly.
+      expect(msgpackDecode(packed)).toEqual(msgpackDecode(hexBytes(c.msgpack)));
+      const text = encodeShardInput(ShardCodec.Json, c.input, c.client_seq) as string;
+      expect(JSON.parse(text)).toEqual(JSON.parse(c.json));
+    }
+  });
+});