@couch-kit/display 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @couch-kit/display
 
+## 0.4.0
+
+### Minor Changes
+
+- [#164](https://github.com/faluciano/react-native-couch-kit/pull/164) [`a157126`](https://github.com/faluciano/react-native-couch-kit/commit/a157126424e4d73dcc7185118d5be0db6719792e) Thanks [@faluciano](https://github.com/faluciano)! - Send a projected state update as one relay frame instead of one per player
+
+  A game with a `project` function sends every player their own view, which meant
+  one WebSocket frame per player for every state change. Relays bill and
+  rate-limit per inbound frame, so a four-player table paid four messages for one
+  update and spent four of the display's 30-per-second budget.
+
+  `GameRuntimeTransport` gains an optional `sendMany(entries)`. When a transport
+  implements it, the runtime hands over the whole projected batch at once;
+  transports that do not — the LAN WebSocket path — keep receiving one `send` per
+  connection and are unaffected.
+
+  `RelayDisplayHost` implements it with a new `DATA_MULTI` envelope carrying a
+  peer-id-to-payload map, which the relay unpacks into ordinary `DATA` frames.
+  Phones need no update — nothing on the client side can tell a batched update
+  from a unicast one. If the combined frame would exceed the relay's 256KB
+  ceiling, the display falls back to individual frames rather than send something
+  the relay would drop.
+
+  Relays must be updated before displays: both bundled implementations
+  (`services/relay`, `services/relay-worker`) understand `DATA_MULTI`, and an
+  older relay answers it with `MALFORMED`. The type is host-only — a phone sending
+  it is rejected, so it cannot be used to reach another phone directly.
+
+### Patch Changes
+
+- Updated dependencies [[`a157126`](https://github.com/faluciano/react-native-couch-kit/commit/a157126424e4d73dcc7185118d5be0db6719792e), [`a157126`](https://github.com/faluciano/react-native-couch-kit/commit/a157126424e4d73dcc7185118d5be0db6719792e)]:
+  - @couch-kit/runtime@0.3.0
+  - @couch-kit/client@0.14.0
+  - @couch-kit/core@0.10.0
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/index.js

@@ -39,7 +39,8 @@ class RelayDisplayHost {
     this.ws.onerror = (event) => this.runtime.handleError(event instanceof Error ? event : new Error("Relay socket error"));
     const transport = {
       send: (connectionId, message) => this.sendEnvelope(message, connectionId),
-      broadcast: (message) => this.sendEnvelope(message)
+      broadcast: (message) => this.sendEnvelope(message),
+      sendMany: (entries) => this.sendMultiEnvelope(entries)
     };
     this.runtime.setTransport(transport);
   }
@@ -54,6 +55,24 @@ class RelayDisplayHost {
     this.runtime.stop();
     this.ws.close();
   }
+  sendMultiEnvelope(entries) {
+    const payloads = {};
+    for (const { connectionId, message } of entries) {
+      payloads[connectionId] = JSON.stringify(message);
+    }
+    const frame = JSON.stringify({
+      type: RelayMessageTypes.DATA_MULTI,
+      roomId: this.assignedRoomId ?? undefined,
+      payloads
+    });
+    if (frameByteLength(frame) > DEFAULT_MAX_MESSAGE_BYTES) {
+      for (const { connectionId, message } of entries) {
+        this.sendEnvelope(message, connectionId);
+      }
+      return;
+    }
+    this.ws.send(frame);
+  }
   sendEnvelope(message, to) {
     const envelope = {
       type: RelayMessageTypes.DATA,

package/lib/relay-display-host.d.ts

@@ -68,6 +68,21 @@ export declare class RelayDisplayHost<S extends IGameState, A extends IAction> {
     dispatch: (action: A) => void;
     /** Tear down the runtime and relay socket. */
     stop(): void;
+    /**
+     * Sends per-connection messages as one `DATA_MULTI` frame, which the relay
+     * unpacks into an ordinary `DATA` frame per phone.
+     *
+     * A projected game re-sends every player's view on every state change, so on
+     * a four-player table this is the difference between one billed relay message
+     * and four — and between one and four against the relay's per-connection rate
+     * limit, which the display shares across all its fan-out.
+     *
+     * Falls back to individual sends if the combined frame would exceed the
+     * relay's message ceiling: N views in one envelope is N times the bytes, and
+     * a frame the relay rejects delivers nothing to anyone. Splitting costs
+     * messages; being dropped costs the game.
+     */
+    private sendMultiEnvelope;
     private sendEnvelope;
     private handleRelayMessage;
 }

package/lib/relay-display-host.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"relay-display-host.d.ts","sourceRoot":"","sources":["../src/relay-display-host.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,qBAAqB,EAE3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AAOxE;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,CAC9E,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAY;IAC/B,+EAA+E;IAC/E,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAA6B;IACzD,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAE3C,YAAY,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAwCjD;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED,wCAAwC;IACxC,QAAQ,QAAO,CAAC,CAA4B;IAE5C,gFAAgF;IAChF,SAAS,aAAc,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CACb;IAEnC,8CAA8C;IAC9C,QAAQ,WAAY,CAAC,KAAG,IAAI,CAAkC;IAE9D,8CAA8C;IAC9C,IAAI,IAAI,IAAI,CAIX;IAED,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,kBAAkB;CA2C3B"}
+{"version":3,"file":"relay-display-host.d.ts","sourceRoot":"","sources":["../src/relay-display-host.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,qBAAqB,EAE3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AAOxE;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CACtC,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,OAAO,CACjB,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAY;IAC/B,+EAA+E;IAC/E,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAA6B;IACzD,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAE3C,YAAY,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAwCjD;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED,wCAAwC;IACxC,QAAQ,QAAO,CAAC,CAA4B;IAE5C,gFAAgF;IAChF,SAAS,aAAc,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CACb;IAEnC,8CAA8C;IAC9C,QAAQ,WAAY,CAAC,KAAG,IAAI,CAAkC;IAE9D,8CAA8C;IAC9C,IAAI,IAAI,IAAI,CAIX;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,kBAAkB;CA2C3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@couch-kit/display",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -51,9 +51,9 @@
     "clean": "rm -rf dist lib"
   },
   "dependencies": {
-    "@couch-kit/client": "0.13.0",
-    "@couch-kit/core": "0.9.3",
-    "@couch-kit/runtime": "0.2.0"
+    "@couch-kit/client": "0.14.0",
+    "@couch-kit/core": "0.10.0",
+    "@couch-kit/runtime": "0.3.0"
   },
   "devDependencies": {
     "typescript": "^7.0.0"

package/src/relay-display-host.ts

@@ -2,6 +2,7 @@ import {
   GameHostRuntime,
   frameByteLength,
   DEFAULT_MAX_MESSAGE_BYTES,
+  type AddressedMessage,
   type GameHostRuntimeConfig,
   type GameRuntimeTransport,
 } from "@couch-kit/runtime";
@@ -19,8 +20,10 @@ import {
  * object used by the RN-TV host) and the shared relay coordinates; the display
  * host owns the authoritative runtime and the relay socket.
  */
-export interface RelayDisplayHostOptions<S extends IGameState, A extends IAction>
-  extends GameHostRuntimeConfig<S, A> {
+export interface RelayDisplayHostOptions<
+  S extends IGameState,
+  A extends IAction,
+> extends GameHostRuntimeConfig<S, A> {
   /** WebSocket URL of the shared relay server. */
   url: string;
   /**
@@ -103,9 +106,9 @@ export class RelayDisplayHost<S extends IGameState, A extends IAction> {
       );
 
     const transport: GameRuntimeTransport = {
-      send: (connectionId, message) =>
-        this.sendEnvelope(message, connectionId),
+      send: (connectionId, message) => this.sendEnvelope(message, connectionId),
       broadcast: (message) => this.sendEnvelope(message),
+      sendMany: (entries) => this.sendMultiEnvelope(entries),
     };
     this.runtime.setTransport(transport);
   }
@@ -136,6 +139,42 @@ export class RelayDisplayHost<S extends IGameState, A extends IAction> {
     this.ws.close();
   }
 
+  /**
+   * Sends per-connection messages as one `DATA_MULTI` frame, which the relay
+   * unpacks into an ordinary `DATA` frame per phone.
+   *
+   * A projected game re-sends every player's view on every state change, so on
+   * a four-player table this is the difference between one billed relay message
+   * and four — and between one and four against the relay's per-connection rate
+   * limit, which the display shares across all its fan-out.
+   *
+   * Falls back to individual sends if the combined frame would exceed the
+   * relay's message ceiling: N views in one envelope is N times the bytes, and
+   * a frame the relay rejects delivers nothing to anyone. Splitting costs
+   * messages; being dropped costs the game.
+   */
+  private sendMultiEnvelope(entries: readonly AddressedMessage[]): void {
+    const payloads: Record<string, string> = {};
+    for (const { connectionId, message } of entries) {
+      payloads[connectionId] = JSON.stringify(message);
+    }
+
+    const frame = JSON.stringify({
+      type: RelayMessageTypes.DATA_MULTI,
+      roomId: this.assignedRoomId ?? undefined,
+      payloads,
+    });
+
+    if (frameByteLength(frame) > DEFAULT_MAX_MESSAGE_BYTES) {
+      for (const { connectionId, message } of entries) {
+        this.sendEnvelope(message, connectionId);
+      }
+      return;
+    }
+
+    this.ws.send(frame);
+  }
+
   private sendEnvelope(message: HostMessage, to?: string): void {
     const envelope: Record<string, unknown> = {
       type: RelayMessageTypes.DATA,