beamdb 0.15.0

BEAM — distributed graph database syncing over WebSocket, WebRTC, and multicast. Successor to rod.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
//! WASM test suite for BEAM browser bindings.
//!
//! Run with:
//!   CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER=wasm-bindgen-test-runner \
//!     cargo test --target wasm32-unknown-unknown --lib
//!
//! These tests compile to WASM and run inside Node.js, which provides
//! a native `WebSocket` client — the same API the browser uses.
//! A BEAM relay server is spawned as a subprocess for integration tests.

#![cfg(test)]

use wasm_bindgen::{JsCast, prelude::*};
use wasm_bindgen_test::*;

wasm_bindgen_test_configure!(run_in_node_experimental);

// ─── Helpers ───

/// Await a JS expression that evaluates to a Promise.
async fn eval_promise(js: &str) -> JsValue {
    let promise = js_sys::eval(js)
        .expect("eval failed")
        .dyn_into::<js_sys::Promise>()
        .expect("eval did not return a Promise");
    wasm_bindgen_futures::JsFuture::from(promise)
        .await
        .expect("promise rejected")
}

/// Sleep for `ms` milliseconds (lets the actor system process).
async fn sleep(ms: u64) {
    eval_promise(&format!("new Promise(r => setTimeout(r, {}))", ms)).await;
}

// ─── T2: Relay lifecycle helper ───

/// Spawn a BEAM relay on `port`. Returns a handle that kills the
/// process when dropped.
///
/// Uses dynamic `import('node:child_process')` — the ESM-compatible
/// way to access Node built-ins (wasm-bindgen-test-runner runs in
/// module mode, so `require()` is not available).
struct Relay {
    port: u16,
    proc: JsValue,
}

impl Relay {
    async fn start(port: u16) -> Self {
        let proc = eval_promise(&format!(
            r#"
            import('node:child_process').then(cp => {{
                const child = cp.spawn('target/debug/beam', [
                    'start', '--port', '{port}',
                    '--memory-storage', 'true', '--redb-storage', 'false',
                    '--allow-public-space', 'true'
                ], {{
                    cwd: '/home/guan/src/beam',
                    stdio: ['ignore', 'pipe', 'pipe']
                }});
                child.stdout.on('data', d => process.stderr.write('[relay] ' + d));
                child.stderr.on('data', d => process.stderr.write('[relay] ' + d));
                return child;
            }})
            "#
        ))
        .await;

        // Wait for the TCP port to accept connections.
        eval_promise(&format!(
            r#"
            new Promise((resolve, reject) => {{
                import('node:net').then(net => {{
                    const deadline = Date.now() + 10000;
                    const tryConnect = () => {{
                        const sock = net.connect({port}, '127.0.0.1');
                        sock.on('connect', () => {{ sock.destroy(); resolve(); }});
                        sock.on('error', () => {{
                            if (Date.now() > deadline) reject(new Error('relay did not start'));
                            else setTimeout(tryConnect, 50);
                        }});
                    }};
                    tryConnect();
                }});
            }})
            "#
        ))
        .await;

        Self { port, proc }
    }
}

impl Drop for Relay {
    fn drop(&mut self) {
        // Best-effort kill — relay process should clean up on SIGTERM.
        let f = js_sys::Function::new_with_args("p", "if (p && p.kill) p.kill('SIGTERM');");
        let _ = f.call1(&JsValue::UNDEFINED, &self.proc);
    }
}

// ─── T1: Smoke test ───

#[wasm_bindgen_test]
fn smoke_test() {
    assert_eq!(2 + 2, 4);
}

// ─── T3: Local put/get (no relay) ───

#[wasm_bindgen_test(async)]
async fn local_put_get_roundtrip() {
    use crate::wasm::Beam;

    let mut beam = Beam::new();
    beam.put("chat.001", "hello world");
    sleep(100).await;

    let result = wasm_bindgen_futures::JsFuture::from(beam.get("chat.001"))
        .await
        .expect("get should resolve");

    assert_eq!(result.as_string(), Some("hello world".to_string()));
    beam.stop();
}

// ─── T4: Connect to relay ───

#[wasm_bindgen_test(async)]
async fn relay_connect() {
    use crate::wasm::Beam;

    let _relay = Relay::start(4960).await;

    let mut beam = Beam::new();
    beam.connect("ws://127.0.0.1:4960");
    sleep(500).await; // WebSocket handshake + Hi exchange

    // If we got here without panicking, the connection succeeded.
    beam.stop();
}

// ─── T5: Put reaches relay (local echo + relay forwarding) ───

#[wasm_bindgen_test(async)]
async fn relay_put_echo() {
    use crate::wasm::Beam;

    let _relay = Relay::start(4961).await;

    let mut beam = Beam::new();
    beam.connect("ws://127.0.0.1:4961");
    sleep(500).await;

    // Put should not panic, and the value should be locally readable.
    beam.put("chat.relay_test", "relay payload");
    sleep(300).await;

    let result = wasm_bindgen_futures::JsFuture::from(beam.get("chat.relay_test"))
        .await
        .expect("get should resolve");

    assert_eq!(result.as_string(), Some("relay payload".to_string()));
    beam.stop();
}

// ─── T6: Two clients cross-talk via relay ───
//
// This is the killer test. If it passes, WASM cross-window delivery
// works and we can merge to master + NPM publish.
//
// IGNORED: `web_sys::WebSocket` callbacks (onopen/onmessage/onerror) do not
// fire in the Node.js wasm-bindgen-test runner. The WebSocket object is
// created without error, but the Node.js event loop in the test harness
// does not pump browser WebSocket events. These tests require a real browser
// environment (e.g. headless Chrome via karma/wasm-pack test --chrome) or a
// Node.js WebSocket polyfill that bridges to the `ws` npm package.
// See: https://github.com/rustwasm/wasm-bindgen/issues/1003

#[wasm_bindgen_test(async)]
#[ignore = "requires browser WebSocket API — web_sys::WebSocket events don't fire in Node.js test runner"]
async fn two_clients_cross_talk() {
    use crate::wasm::Beam;

    let _relay = Relay::start(4970).await;

    // Two independent BEAM nodes, both connecting to the same relay.
    let mut client1 = Beam::new();
    client1.connect("ws://127.0.0.1:4970");

    let mut client2 = Beam::new();
    client2.connect("ws://127.0.0.1:4970");

    sleep(1000).await; // Both WebSockets open + Hi exchanged

    // Register a callback on client2 that stores received values globally.
    js_sys::eval(
        r#"
        globalThis.__received = [];
        globalThis.__on_msg = function(val) {
            globalThis.__received.push(val);
        };
        "#,
    )
    .unwrap();

    let callback = js_sys::eval("globalThis.__on_msg")
        .unwrap()
        .dyn_into::<js_sys::Function>()
        .unwrap();

    client2.on("chat", callback);
    sleep(200).await; // Subscription registered

    // Client 1 sends a message.
    client1.put("chat.42", "cross-talk!");
    sleep(1000).await; // Propagate through relay

    client1.stop();
    client2.stop();

    // Check what client2 received.
    let received = js_sys::eval("JSON.stringify(globalThis.__received)")
        .unwrap()
        .as_string()
        .unwrap_or_default();

    // The callback should have fired with "cross-talk!".
    assert!(
        received.contains("cross-talk"),
        "client2 should have received 'cross-talk!' but got: {}",
        received
    );
}

// ─── T6b: Bidirectional cross-talk ───
//
// Both clients send AND receive. This is what the browser chat example needs.

#[wasm_bindgen_test(async)]
#[ignore = "requires browser WebSocket API — web_sys::WebSocket events don't fire in Node.js test runner"]
async fn bidirectional_cross_talk() {
    use crate::wasm::Beam;

    let _relay = Relay::start(4980).await;

    let mut client1 = Beam::new();
    client1.connect("ws://127.0.0.1:4980");

    let mut client2 = Beam::new();
    client2.connect("ws://127.0.0.1:4980");

    sleep(1000).await;

    // Separate receive buffers per client.
    js_sys::eval(
        r#"
        globalThis.__c1_received = [];
        globalThis.__c2_received = [];
        globalThis.__c1_cb = v => globalThis.__c1_received.push(v);
        globalThis.__c2_cb = v => globalThis.__c2_received.push(v);
        "#,
    )
    .unwrap();

    let c1_cb = js_sys::eval("globalThis.__c1_cb")
        .unwrap()
        .dyn_into::<js_sys::Function>()
        .unwrap();
    let c2_cb = js_sys::eval("globalThis.__c2_cb")
        .unwrap()
        .dyn_into::<js_sys::Function>()
        .unwrap();

    client1.on("chat", c1_cb);
    client2.on("chat", c2_cb);
    sleep(200).await;

    // Direction 1: client1 → client2
    client1.put("chat.001", "from_client_1");
    sleep(500).await;

    // Direction 2: client2 → client1
    client2.put("chat.002", "from_client_2");
    sleep(500).await;

    client1.stop();
    client2.stop();

    let c1 = js_sys::eval("JSON.stringify(globalThis.__c1_received)")
        .unwrap()
        .as_string()
        .unwrap_or_default();
    let c2 = js_sys::eval("JSON.stringify(globalThis.__c2_received)")
        .unwrap()
        .as_string()
        .unwrap_or_default();

    // client2 should have received "from_client_1"
    assert!(
        c2.contains("from_client_1"),
        "client2 should have received 'from_client_1' but got: {}",
        c2
    );

    // client1 should have received "from_client_2"
    assert!(
        c1.contains("from_client_2"),
        "client1 should have received 'from_client_2' but got: {}",
        c1
    );
}

// ============================================================================
// WASM Benchmarks (T7)
// ============================================================================
// These use performance.now() for high-resolution timing in the browser/Node.
// Run with: wasm-pack test --node -- --features wasm-bench

// ============================================================================
// WASM Benchmarks (T7)
// ============================================================================
// Uses `web_time::Instant` — the same cross-platform timer used throughout
// the codebase. Works in both Node.js and browser. No feature gate needed.

#[wasm_bindgen_test]
fn wasm_bench_parse_throughput() {
    let json =
        r##"{"#":"bench/test","put":{"bench/test":{"msg":"hello world","time":1234567890.123}}}"##;
    let iterations = 10_000;
    let start = web_time::Instant::now();
    for _ in 0..iterations {
        let _: serde_json::Value = serde_json::from_str(json).unwrap();
    }
    let elapsed = start.elapsed();
    let per_op_ns = elapsed.as_nanos() as f64 / iterations as f64;
    console_log!(
        "WASM parse small JSON: {:.0} ns/op ({:.0} ops/sec)",
        per_op_ns,
        1_000_000_000.0 / per_op_ns
    );
}

#[wasm_bindgen_test]
fn wasm_bench_serialize_throughput() {
    let obj = serde_json::json!({
        "#": "bench/test",
        "put": {
            "bench/test": {
                "msg": "hello world",
                "time": 1234567890.123
            }
        }
    });
    let iterations = 10_000;
    let start = web_time::Instant::now();
    for _ in 0..iterations {
        let _ = obj.to_string();
    }
    let elapsed = start.elapsed();
    let per_op_ns = elapsed.as_nanos() as f64 / iterations as f64;
    console_log!(
        "WASM serialize small JSON: {:.0} ns/op ({:.0} ops/sec)",
        per_op_ns,
        1_000_000_000.0 / per_op_ns
    );
}

#[wasm_bindgen_test]
fn wasm_bench_get_parse_throughput() {
    let json = r##"{"#":"bench/test","get":{"#":"bench/test"}}"##;
    let iterations = 10_000;
    let start = web_time::Instant::now();
    for _ in 0..iterations {
        let _: serde_json::Value = serde_json::from_str(json).unwrap();
    }
    let elapsed = start.elapsed();
    let per_op_ns = elapsed.as_nanos() as f64 / iterations as f64;
    console_log!(
        "WASM parse Get: {:.0} ns/op ({:.0} ops/sec)",
        per_op_ns,
        1_000_000_000.0 / per_op_ns
    );
}

// ============================================================================
// WASM Relay Throughput Benchmarks (T12-T13)
// ============================================================================
// Measures relay TPS from a WASM client. Ground truth comes from the
// relay's `/metrics` HTTP endpoint (same approach as the native bench).
// The relay binary must be pre-built: `cargo build --bin beam`.

/// Fetch the relay's metrics snapshot as a JSON object.
/// Fetch the relay's metrics snapshot as a JSON object.
///
/// The relay serves HTTP (including `/metrics`) on `port + 1`,
/// while the WebSocket server runs on `port`. We query the HTTP port.
async fn fetch_metrics(ws_port: u16) -> JsValue {
    let http_port = ws_port + 1;
    eval_promise(&format!(
        r#"
        fetch("http://127.0.0.1:{http_port}/metrics")
            .then(r => r.json())
        "#
    ))
    .await
}

/// Extract a u64 field from a JS object by key.
fn get_u64(obj: &JsValue, key: &str) -> u64 {
    let val = js_sys::Reflect::get(obj, &js_sys::JsString::from(key)).expect("field missing");
    val.as_f64().unwrap_or(0.0) as u64
}

/// Run a WASM relay throughput benchmark: send `count` puts through a
/// real relay and measure messages/sec from the relay's own counters.
async fn run_wasm_relay_throughput(port: u16, count: usize) {
    use crate::wasm::Beam;

    let _relay = Relay::start(port).await;

    let mut beam = Beam::new();
    beam.connect(&format!("ws://127.0.0.1:{port}"));
    sleep(500).await;

    // Baseline metrics from the relay (ground truth).
    let before = fetch_metrics(port).await;

    // Send `count` puts (fire-and-forget). Each targets a unique key
    // to avoid dedup — we want every message to flow through the relay.
    let start = web_time::Instant::now();
    for i in 0..count {
        let key = format!("bench/{}", i);
        beam.put(&key, &format!("msg_{}", i));
    }
    let send_elapsed = start.elapsed();

    // Wait for relay counters to stabilize (no new messages for 500ms).
    let stabilize_deadline = web_time::Instant::now() + web_time::Duration::from_secs(30);
    let mut last_relayed = get_u64(&before, "messages_relayed");
    loop {
        sleep(500).await;
        let snap = fetch_metrics(port).await;
        let now_relayed = get_u64(&snap, "messages_relayed");
        if now_relayed == last_relayed {
            break;
        }
        last_relayed = now_relayed;
        if web_time::Instant::now() > stabilize_deadline {
            break;
        }
    }

    let total_elapsed = start.elapsed();
    let after = fetch_metrics(port).await;

    // Compute deltas from relay's ground-truth counters.
    let relayed = get_u64(&after, "messages_relayed") - get_u64(&before, "messages_relayed");
    let ws_sent = get_u64(&after, "ws_messages_sent") - get_u64(&before, "ws_messages_sent");
    let ws_recv =
        get_u64(&after, "ws_messages_received") - get_u64(&before, "ws_messages_received");
    let parsed = get_u64(&after, "messages_parsed") - get_u64(&before, "messages_parsed");
    let dropped_dup =
        get_u64(&after, "messages_dropped_dup") - get_u64(&before, "messages_dropped_dup");
    let fanout =
        get_u64(&after, "subscriber_fanout_total") - get_u64(&before, "subscriber_fanout_total");
    let serialized =
        get_u64(&after, "serialization_calls") - get_u64(&before, "serialization_calls");

    let throughput = if total_elapsed.as_secs_f64() > 0.0 {
        relayed as f64 / total_elapsed.as_secs_f64()
    } else {
        0.0
    };
    let send_rate = if send_elapsed.as_secs_f64() > 0.0 {
        count as f64 / send_elapsed.as_secs_f64()
    } else {
        0.0
    };

    console_log!(
        "\n============================================================\n  \
         WASM RELAY THROUGHPUT BENCHMARK\n  \
         Messages: {} (fire-and-forget puts)\n  \
         Send phase: {:.3}s ({:.0} puts/sec)\n  \
         Total elapsed: {:.3}s\n  \
         --- Relay Hot-Path Counters ---\n  \
         ws_messages_received: {}\n  \
         messages_parsed:      {}\n  \
         messages_dropped_dup: {}\n  \
         messages_relayed:     {}\n  \
         subscriber_fanout:    {}\n  \
         serialization_calls:  {}\n  \
         ws_messages_sent:     {}\n  \
         Throughput:       {:.0} msgs/sec (relayed)\n  \
         Fanout ratio:     {:.1}\n  \
         Dedup rate:       {:.1}%\n\
         ============================================================\n",
        count,
        send_elapsed.as_secs_f64(),
        send_rate,
        total_elapsed.as_secs_f64(),
        ws_recv,
        parsed,
        dropped_dup,
        relayed,
        fanout,
        serialized,
        ws_sent,
        throughput,
        if relayed > 0 {
            fanout as f64 / relayed as f64
        } else {
            0.0
        },
        if parsed > 0 {
            100.0 * dropped_dup as f64 / parsed as f64
        } else {
            0.0
        },
    );

    assert!(relayed > 0, "relay should have processed messages");
    beam.stop();
}

#[wasm_bindgen_test(async)]
#[ignore = "requires browser WebSocket API — web_sys::WebSocket events don't fire in Node.js test runner"]
async fn wasm_relay_throughput_1k() {
    run_wasm_relay_throughput(4971, 1_000).await;
}

#[wasm_bindgen_test(async)]
#[ignore = "requires browser WebSocket API — web_sys::WebSocket events don't fire in Node.js test runner"]
async fn wasm_relay_throughput_5k() {
    run_wasm_relay_throughput(4972, 5_000).await;
}