@playfast/reform-remote-node 0.0.2 → 0.0.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@playfast/reform-remote-node",
   "playbook": "./playbook",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "description": "Node WebSocket server adapter for reform-remote — serves a reform scene's UI over the `ws` package, one isolated runtime per connection.",
   "keywords": [
@@ -28,7 +28,7 @@
     "./*": "./src/*.ts"
   },
   "files": [
-    "dist",
+    "src",
     "README.md"
   ],
   "scripts": {

package/src/index.ts

@@ -0,0 +1,87 @@
+import type { Server } from 'node:http'
+import { type RawData, WebSocketServer } from 'ws'
+import type { Scene } from '@playfast/reform'
+import {
+  type InvokeMessage,
+  type RemoteTransport,
+  type ServerBinding,
+  type ServerMessage,
+  serve,
+} from '@playfast/reform-remote'
+
+/**
+ * @playfast/reform-remote-node — serve a reform scene's UI over WebSocket from a
+ * Node process, using the `ws` package. Each connection gets its own
+ * `serve({ scene, transport })` — its own isolated runtime — wrapped around the
+ * socket with JSON framing: the already-`_tag`-discriminated wire messages need
+ * no envelope. The Bun-native equivalent is `@playfast/reform-remote-bun`; the
+ * browser/web client is `@playfast/reform-remote-web`.
+ */
+
+export interface NodeWebSocketOptions {
+  /** The scene to run — a fresh runtime per connection. */
+  readonly scene: Scene
+  /** Listen on this port (use `0` for an ephemeral port; read it back from `wss.address()`). */
+  readonly port?: number
+  /** Attach to an existing HTTP server instead of opening a port. */
+  readonly server?: Server
+  /** Restrict upgrades to this path. */
+  readonly path?: string
+}
+
+export interface NodeWebSocketServer {
+  /** The underlying `ws` server — for reading the bound address, or further config. */
+  readonly wss: WebSocketServer
+  /** Dispose every live connection's runtime and close the server. */
+  readonly stop: () => Promise<void>
+}
+
+const parseInvoke = (data: RawData): InvokeMessage => JSON.parse(data.toString()) as InvokeMessage
+
+export const serveNodeWebSocket = (options: NodeWebSocketOptions): NodeWebSocketServer => {
+  const wss =
+    options.server !== undefined
+      ? new WebSocketServer({ server: options.server, path: options.path })
+      : new WebSocketServer({ port: options.port ?? 0, path: options.path })
+
+  // Every open connection's binding, so `stop` can tear them all down.
+  const bindings = new Set<ServerBinding>()
+
+  wss.on('connection', (socket) => {
+    const handlers = new Set<(message: InvokeMessage) => void>()
+    const transport: RemoteTransport<ServerMessage, InvokeMessage> = {
+      send: (message) => socket.send(JSON.stringify(message)),
+      onMessage: (handler) => {
+        handlers.add(handler)
+        return () => void handlers.delete(handler)
+      },
+    }
+    socket.on('message', (data) => {
+      const message = parseInvoke(data)
+      for (const handler of handlers) handler(message)
+    })
+
+    const binding = serve({ scene: options.scene, transport })
+    bindings.add(binding)
+    socket.on('close', () => {
+      bindings.delete(binding)
+      void binding.dispose()
+    })
+    // Push the first snapshot once the socket is live.
+    void binding.start()
+  })
+
+  return {
+    wss,
+    stop: async (): Promise<void> => {
+      await Promise.all([...bindings].map((binding) => binding.dispose()))
+      bindings.clear()
+      // Terminate live sockets so `wss.close` doesn't block waiting for them to
+      // drain on their own — `close` only fires its callback once all are gone.
+      for (const client of wss.clients) client.terminate()
+      await new Promise<void>((resolve, reject) =>
+        wss.close((error) => (error === undefined ? resolve() : reject(error))),
+      )
+    },
+  }
+}

package/src/server.test.ts

@@ -0,0 +1,132 @@
+import type { AddressInfo } from 'node:net'
+import { afterEach, expect, test } from 'vitest'
+import { Layer, Schema as S } from 'effect'
+import {
+  Composition,
+  Engine,
+  Event,
+  Reducer,
+  State,
+  StateGroup,
+  Ui,
+  Wire,
+  provide,
+  scene,
+  ui,
+} from '@playfast/reform'
+import type { WireNode, WireProp } from '@playfast/reform'
+import type { ServerMessage } from '@playfast/reform-remote'
+import { type NodeWebSocketServer, serveNodeWebSocket } from './index'
+
+// A self-contained counter scene (the adapter packages stay independent of the
+// core package's test fixtures, which aren't part of its public surface).
+class Count extends State.make('count', S.Number) {}
+class Counters extends StateGroup.make(Count) {}
+class Bumped extends Event.make('Bumped', S.Struct({ by: S.Number })) {}
+class Bump extends Reducer.make('Bump', { states: [Count], events: [Bumped] }) {}
+class CounterUi extends ui('Counter', {
+  props: S.Struct({ count: S.Number }),
+  events: { bump: S.Struct({ by: S.Number }) },
+}) {}
+class Counter extends Composition.make('Counter', { title: 'Counter', ui: CounterUi, states: [Count] }) {}
+
+const counterScene = () => {
+  const presentation = Layer.mergeAll(
+    provide(CounterUi, Ui.make(CounterUi, ({ count }) => `count:${count}`)),
+    StateGroup.live(Counters, { count: 0 }),
+  )
+  const app = Layer.mergeAll(
+    Composition.live(Counter, function* () {
+      const count = yield* StateGroup.select(Counters, 'count')
+      const bump = yield* Event.trigger(Bumped)
+      return (yield* CounterUi)({ count }, { bump })
+    }),
+    Reducer.live(Bump, (n, event) => n + event.by),
+  ).pipe(Layer.provideMerge(presentation), Layer.provideMerge(Engine))
+  return scene(Counter, { provide: [app] })
+}
+
+const countOf = (node: WireNode): unknown => {
+  const prop = node.props.find(
+    (candidate: WireProp): candidate is Extract<WireProp, { _tag: 'Data' }> =>
+      candidate._tag === 'Data' && candidate.name === 'count',
+  )
+  return prop?.value
+}
+
+const listening = (host: NodeWebSocketServer): Promise<number> =>
+  new Promise((resolve) =>
+    host.wss.once('listening', () => resolve((host.wss.address() as AddressInfo).port)),
+  )
+
+const nextMessage = (
+  socket: WebSocket,
+  predicate: (message: ServerMessage) => boolean,
+): Promise<ServerMessage> =>
+  new Promise((resolve) => {
+    const onMessage = (event: MessageEvent): void => {
+      const message = JSON.parse(event.data as string) as ServerMessage
+      if (!predicate(message)) return
+      socket.removeEventListener('message', onMessage)
+      resolve(message)
+    }
+    socket.addEventListener('message', onMessage)
+  })
+
+const open = new Set<{ stop: () => Promise<void> }>()
+afterEach(async () => {
+  await Promise.all([...open].map((host) => host.stop()))
+  open.clear()
+})
+
+test('a native WebSocket client receives a snapshot and drives the server back over ws', async () => {
+  const host = serveNodeWebSocket({ scene: counterScene() })
+  open.add(host)
+  const port = await listening(host)
+
+  const socket = new WebSocket(`ws://localhost:${port}`)
+  try {
+    const snapshot = await nextMessage(socket, (message) => message._tag === 'Snapshot')
+    const tree = snapshot._tag === 'Snapshot' ? snapshot.tree : []
+    expect(countOf(tree[0]!)).toBe(0)
+
+    socket.send(JSON.stringify({ _tag: 'Invoke', handle: '0:bump', payload: { by: 7 } }))
+
+    const frame = await nextMessage(socket, (message) => message._tag === 'Patches')
+    const patches = frame._tag === 'Patches' ? frame.patches : []
+    const next = Wire.apply(tree, patches)
+    expect(countOf(next[0]!)).toBe(7)
+  } finally {
+    socket.close()
+  }
+})
+
+test('each connection runs an isolated runtime', async () => {
+  const host = serveNodeWebSocket({ scene: counterScene() })
+  open.add(host)
+  const port = await listening(host)
+
+  const a = new WebSocket(`ws://localhost:${port}`)
+  const b = new WebSocket(`ws://localhost:${port}`)
+  try {
+    const snapA = await nextMessage(a, (m) => m._tag === 'Snapshot')
+    await nextMessage(b, (m) => m._tag === 'Snapshot')
+
+    a.send(JSON.stringify({ _tag: 'Invoke', handle: '0:bump', payload: { by: 4 } }))
+    const frameA = await nextMessage(a, (m) => m._tag === 'Patches')
+
+    const treeA = Wire.apply(
+      snapA._tag === 'Snapshot' ? snapA.tree : [],
+      frameA._tag === 'Patches' ? frameA.patches : [],
+    )
+    expect(countOf(treeA[0]!)).toBe(4)
+    // b's runtime never saw a's bump — a re-snapshot on a fresh socket would read 0.
+    const c = new WebSocket(`ws://localhost:${port}`)
+    const snapC = await nextMessage(c, (m) => m._tag === 'Snapshot')
+    expect(countOf((snapC._tag === 'Snapshot' ? snapC.tree : [])[0]!)).toBe(0)
+    c.close()
+  } finally {
+    a.close()
+    b.close()
+  }
+})

package/dist/index.d.ts

@@ -1,29 +0,0 @@
-import type { Server } from 'node:http';
-import { WebSocketServer } from 'ws';
-import type { Scene } from '@playfast/reform';
-/**
- * @playfast/reform-remote-node — serve a reform scene's UI over WebSocket from a
- * Node process, using the `ws` package. Each connection gets its own
- * `serve({ scene, transport })` — its own isolated runtime — wrapped around the
- * socket with JSON framing: the already-`_tag`-discriminated wire messages need
- * no envelope. The Bun-native equivalent is `@playfast/reform-remote-bun`; the
- * browser/web client is `@playfast/reform-remote-web`.
- */
-export interface NodeWebSocketOptions {
-    /** The scene to run — a fresh runtime per connection. */
-    readonly scene: Scene;
-    /** Listen on this port (use `0` for an ephemeral port; read it back from `wss.address()`). */
-    readonly port?: number;
-    /** Attach to an existing HTTP server instead of opening a port. */
-    readonly server?: Server;
-    /** Restrict upgrades to this path. */
-    readonly path?: string;
-}
-export interface NodeWebSocketServer {
-    /** The underlying `ws` server — for reading the bound address, or further config. */
-    readonly wss: WebSocketServer;
-    /** Dispose every live connection's runtime and close the server. */
-    readonly stop: () => Promise<void>;
-}
-export declare const serveNodeWebSocket: (options: NodeWebSocketOptions) => NodeWebSocketServer;
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAgB,eAAe,EAAE,MAAM,IAAI,CAAA;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAS7C;;;;;;;GAOG;AAEH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB,8FAA8F;IAC9F,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB,mEAAmE;IACnE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,sCAAsC;IACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,qFAAqF;IACrF,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAA;IAC7B,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC;AAID,eAAO,MAAM,kBAAkB,GAAI,SAAS,oBAAoB,KAAG,mBA8ClE,CAAA"}

package/dist/index.js

@@ -1,46 +0,0 @@
-import { WebSocketServer } from 'ws';
-import { serve, } from '@playfast/reform-remote';
-const parseInvoke = (data) => JSON.parse(data.toString());
-export const serveNodeWebSocket = (options) => {
-    const wss = options.server !== undefined
-        ? new WebSocketServer({ server: options.server, path: options.path })
-        : new WebSocketServer({ port: options.port ?? 0, path: options.path });
-    // Every open connection's binding, so `stop` can tear them all down.
-    const bindings = new Set();
-    wss.on('connection', (socket) => {
-        const handlers = new Set();
-        const transport = {
-            send: (message) => socket.send(JSON.stringify(message)),
-            onMessage: (handler) => {
-                handlers.add(handler);
-                return () => void handlers.delete(handler);
-            },
-        };
-        socket.on('message', (data) => {
-            const message = parseInvoke(data);
-            for (const handler of handlers)
-                handler(message);
-        });
-        const binding = serve({ scene: options.scene, transport });
-        bindings.add(binding);
-        socket.on('close', () => {
-            bindings.delete(binding);
-            void binding.dispose();
-        });
-        // Push the first snapshot once the socket is live.
-        void binding.start();
-    });
-    return {
-        wss,
-        stop: async () => {
-            await Promise.all([...bindings].map((binding) => binding.dispose()));
-            bindings.clear();
-            // Terminate live sockets so `wss.close` doesn't block waiting for them to
-            // drain on their own — `close` only fires its callback once all are gone.
-            for (const client of wss.clients)
-                client.terminate();
-            await new Promise((resolve, reject) => wss.close((error) => (error === undefined ? resolve() : reject(error))));
-        },
-    };
-};
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,eAAe,EAAE,MAAM,IAAI,CAAA;AAElD,OAAO,EAKL,KAAK,GACN,MAAM,yBAAyB,CAAA;AA6BhC,MAAM,WAAW,GAAG,CAAC,IAAa,EAAiB,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAkB,CAAA;AAElG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAA6B,EAAuB,EAAE;IACvF,MAAM,GAAG,GACP,OAAO,CAAC,MAAM,KAAK,SAAS;QAC1B,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QACrE,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IAE1E,qEAAqE;IACrE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAiB,CAAA;IAEzC,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoC,CAAA;QAC5D,MAAM,SAAS,GAAkD;YAC/D,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACvD,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBACrB,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBACrB,OAAO,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC5C,CAAC;SACF,CAAA;QACD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;YACjC,KAAK,MAAM,OAAO,IAAI,QAAQ;gBAAE,OAAO,CAAC,OAAO,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;QAC1D,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACrB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACxB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAA;QACxB,CAAC,CAAC,CAAA;QACF,mDAAmD;QACnD,KAAK,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,GAAG;QACH,IAAI,EAAE,KAAK,IAAmB,EAAE;YAC9B,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;YACpE,QAAQ,CAAC,KAAK,EAAE,CAAA;YAChB,0EAA0E;YAC1E,0EAA0E;YAC1E,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO;gBAAE,MAAM,CAAC,SAAS,EAAE,CAAA;YACpD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAC1C,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CACxE,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC,CAAA"}