hypen-server 0.4.81

Rust server SDK for building Hypen applications
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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
//! Integration tests for hypen-server SDK.
//!
//! These tests exercise end-to-end flows: build module -> mount -> dispatch
//! actions -> verify state & patches.

use std::sync::{Arc, Mutex};

use hypen_server::prelude::*;
use serde::{Deserialize, Serialize};
use serde_json::json;

// ---------------------------------------------------------------------------
// Shared state types
// ---------------------------------------------------------------------------

#[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
struct CounterState {
    count: i32,
}

#[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
struct TodoState {
    items: Vec<TodoItem>,
    filter: String,
}

#[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
struct TodoItem {
    id: String,
    text: String,
    done: bool,
}

// ---------------------------------------------------------------------------
// Basic flow: build, mount, dispatch, verify state
// ---------------------------------------------------------------------------

#[test]
fn test_counter_full_lifecycle() {
    let def = ModuleBuilder::<CounterState>::new("Counter")
        .state(CounterState { count: 0 })
        .ui(r#"Column { Text("Count: @{state.count}") }"#)
        .on_action::<()>("increment", |state, _, _| {
            state.count += 1;
        })
        .on_action::<()>("decrement", |state, _, _| {
            state.count -= 1;
        })
        .build();

    let instance = ModuleInstance::new(Arc::new(def), None).unwrap();
    instance.mount();
    assert!(instance.is_mounted());

    // Increment 3 times
    for _ in 0..3 {
        instance.dispatch_action("increment", None).unwrap();
    }
    assert_eq!(instance.get_state().count, 3);

    // Decrement once
    instance.dispatch_action("decrement", None).unwrap();
    assert_eq!(instance.get_state().count, 2);

    instance.unmount();
    assert!(!instance.is_mounted());
}

// ---------------------------------------------------------------------------
// Typed payloads across multiple action types
// ---------------------------------------------------------------------------

#[test]
fn test_todo_app_flow() {
    #[derive(Deserialize)]
    struct AddItem {
        id: String,
        text: String,
    }

    #[derive(Deserialize)]
    struct ToggleItem {
        id: String,
    }

    #[derive(Deserialize)]
    struct SetFilter {
        filter: String,
    }

    let def = ModuleBuilder::<TodoState>::new("TodoApp")
        .state(TodoState {
            items: vec![],
            filter: "all".into(),
        })
        .on_action::<AddItem>("add", |state, payload, _| {
            state.items.push(TodoItem {
                id: payload.id,
                text: payload.text,
                done: false,
            });
        })
        .on_action::<ToggleItem>("toggle", |state, payload, _| {
            if let Some(item) = state.items.iter_mut().find(|i| i.id == payload.id) {
                item.done = !item.done;
            }
        })
        .on_action::<SetFilter>("setFilter", |state, payload, _| {
            state.filter = payload.filter;
        })
        .on_action::<()>("clearCompleted", |state, _, _| {
            state.items.retain(|i| !i.done);
        })
        .build();

    let instance = ModuleInstance::new(Arc::new(def), None).unwrap();
    instance.mount();

    // Add items
    instance
        .dispatch_action("add", Some(json!({"id": "1", "text": "Buy milk"})))
        .unwrap();
    instance
        .dispatch_action("add", Some(json!({"id": "2", "text": "Write tests"})))
        .unwrap();
    assert_eq!(instance.get_state().items.len(), 2);

    // Toggle item
    instance
        .dispatch_action("toggle", Some(json!({"id": "1"})))
        .unwrap();
    assert!(instance.get_state().items[0].done);
    assert!(!instance.get_state().items[1].done);

    // Set filter
    instance
        .dispatch_action("setFilter", Some(json!({"filter": "active"})))
        .unwrap();
    assert_eq!(instance.get_state().filter, "active");

    // Clear completed
    instance.dispatch_action("clearCompleted", None).unwrap();
    assert_eq!(instance.get_state().items.len(), 1);
    assert_eq!(instance.get_state().items[0].id, "2");
}

// ---------------------------------------------------------------------------
// Patch collection: verify engine emits patches on state change
// ---------------------------------------------------------------------------

#[test]
fn test_patches_emitted_on_state_change() {
    let patches: Arc<Mutex<Vec<Vec<Patch>>>> = Arc::new(Mutex::new(vec![]));
    let patches_clone = patches.clone();

    let def = ModuleBuilder::<CounterState>::new("PatchTest")
        .state(CounterState { count: 0 })
        .ui(r#"Text("@{state.count}")"#)
        .on_action::<()>("increment", |state, _, _| {
            state.count += 1;
        })
        .build();

    let instance = ModuleInstance::new(Arc::new(def), None).unwrap();

    // Register patch callback (after construction, so initial render is not captured)
    instance.on_patches(move |p| {
        patches_clone.lock().unwrap().push(p.to_vec());
    });

    instance.mount();

    // Dispatch action — this should produce patches (setProp for updated text)
    instance.dispatch_action("increment", None).unwrap();
    let after_dispatch = patches.lock().unwrap().len();
    assert!(after_dispatch > 0, "State change should produce patches");
}

// ---------------------------------------------------------------------------
// Global context: share data between modules
// ---------------------------------------------------------------------------

#[test]
fn test_global_context_shared_between_modules() {
    let ctx = Arc::new(GlobalContext::new());
    ctx.register_module_state("theme_config", json!({"theme": "dark"}));

    let def1 = ModuleBuilder::<CounterState>::new("ModuleA")
        .state(CounterState { count: 0 })
        .on_created(|_state, ctx| {
            if let Some(ctx) = ctx {
                let state = ctx.get_module_state("theme_config").unwrap();
                assert_eq!(state["theme"], "dark");
            }
        })
        .build();

    let def2 = ModuleBuilder::<CounterState>::new("ModuleB")
        .state(CounterState { count: 0 })
        .on_created(|_state, ctx| {
            if let Some(ctx) = ctx {
                assert!(ctx.has_module("theme_config"));
            }
        })
        .build();

    let inst1 = ModuleInstance::new(Arc::new(def1), Some(ctx.clone())).unwrap();
    let inst2 = ModuleInstance::new(Arc::new(def2), Some(ctx.clone())).unwrap();

    inst1.mount();
    inst2.mount();
}

// ---------------------------------------------------------------------------
// Lifecycle ordering: on_created before dispatch, on_destroyed after
// ---------------------------------------------------------------------------

#[test]
fn test_lifecycle_ordering() {
    let events: Arc<Mutex<Vec<String>>> = Arc::new(Mutex::new(vec![]));
    let e1 = events.clone();
    let e2 = events.clone();
    let e3 = events.clone();

    let def = ModuleBuilder::<CounterState>::new("LifecycleOrder")
        .state(CounterState { count: 0 })
        .on_created(move |_, _| {
            e1.lock().unwrap().push("created".into());
        })
        .on_action::<()>("act", move |state, _, _| {
            e2.lock().unwrap().push("action".into());
            state.count += 1;
        })
        .on_destroyed(move |_, _| {
            e3.lock().unwrap().push("destroyed".into());
        })
        .build();

    let instance = ModuleInstance::new(Arc::new(def), None).unwrap();
    instance.mount();
    instance.dispatch_action("act", None).unwrap();
    instance.unmount();

    let log = events.lock().unwrap();
    assert_eq!(*log, vec!["created", "action", "destroyed"]);
}

// ---------------------------------------------------------------------------
// State JSON roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_state_json_roundtrip() {
    let def = ModuleBuilder::<TodoState>::new("JsonRT")
        .state(TodoState {
            items: vec![TodoItem {
                id: "1".into(),
                text: "Test".into(),
                done: false,
            }],
            filter: "all".into(),
        })
        .build();

    let instance = ModuleInstance::new(Arc::new(def), None).unwrap();
    let json = instance.get_state_json().unwrap();

    assert_eq!(json["filter"], "all");
    assert_eq!(json["items"][0]["text"], "Test");
    assert_eq!(json["items"][0]["done"], false);
}

// ---------------------------------------------------------------------------
// Error: unknown action
// ---------------------------------------------------------------------------

#[test]
fn test_dispatch_unknown_action_returns_error() {
    let def = ModuleBuilder::<CounterState>::new("ErrTest")
        .state(CounterState { count: 0 })
        .build();

    let instance = ModuleInstance::new(Arc::new(def), None).unwrap();
    let result = instance.dispatch_action("nope", None);
    assert!(result.is_err());
}

// ---------------------------------------------------------------------------
// Router integration
// ---------------------------------------------------------------------------

#[test]
fn test_router_pattern_matching() {
    let router = HypenRouter::new();

    // Navigate and check state
    router.push("/counter");
    assert_eq!(router.current_path(), "/counter");

    // Match patterns
    let m = router.match_path("/counter", "/counter");
    assert!(m.is_some());

    let m = router.match_path("/profile/:id", "/profile/42").unwrap();
    assert_eq!(m.params["id"], "42");

    // Wildcard
    assert!(router.match_path("/api/*", "/api/users/list").is_some());
    assert!(router.match_path("/api/*", "/other").is_none());
}

// ---------------------------------------------------------------------------
// Component discovery
// ---------------------------------------------------------------------------

#[test]
fn test_component_discovery() {
    let dir = std::env::temp_dir().join("hypen_integration_test_discovery");
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();
    std::fs::write(dir.join("Header.hypen"), r#"Text("Header")"#).unwrap();
    std::fs::write(dir.join("Footer.hypen"), r#"Text("Footer")"#).unwrap();

    let mut registry = ComponentRegistry::new();
    let loaded = registry.load_dir(dir.to_str().unwrap()).unwrap();
    assert_eq!(loaded.len(), 2);
    assert!(registry.get("Header").is_some());
    assert!(registry.get("Footer").is_some());

    let _ = std::fs::remove_dir_all(&dir);
}

// ---------------------------------------------------------------------------
// HypenApp builder: full app assembly
// ---------------------------------------------------------------------------

#[test]
fn test_hypen_app_builder() {
    let counter_def = ModuleBuilder::<CounterState>::new("Counter")
        .state(CounterState { count: 0 })
        .on_action::<()>("increment", |state, _, _| {
            state.count += 1;
        })
        .build();

    let app = HypenApp::builder().route("/", counter_def).build();

    assert!(app.match_route("/").is_some());
}

// ---------------------------------------------------------------------------
// HypenApp instantiate + dispatch
// ---------------------------------------------------------------------------

#[test]
fn test_app_instantiate_and_dispatch() {
    let app = HypenApp::default();

    let def = ModuleBuilder::<CounterState>::new("Counter")
        .state(CounterState { count: 0 })
        .on_action::<()>("increment", |state, _, _| {
            state.count += 1;
        })
        .build();

    let instance = app.instantiate(Arc::new(def)).unwrap();
    instance.mount();

    instance.dispatch_action("increment", None).unwrap();
    instance.dispatch_action("increment", None).unwrap();
    assert_eq!(instance.get_state().count, 2);
}

// ---------------------------------------------------------------------------
// Multiple modules sharing global context
// ---------------------------------------------------------------------------

#[test]
fn test_multi_module_via_global_context() {
    let ctx = Arc::new(GlobalContext::new());

    let def_a = ModuleBuilder::<CounterState>::new("A")
        .state(CounterState { count: 0 })
        .on_action::<()>("increment_and_sync", |state, _, ctx| {
            state.count += 1;
            if let Some(ctx) = ctx {
                ctx.register_module_state("A", json!({"count": state.count}));
            }
        })
        .build();

    let def_b = ModuleBuilder::<CounterState>::new("B")
        .state(CounterState { count: 0 })
        .on_action::<()>("read_global", |state, _, ctx| {
            if let Some(ctx) = ctx {
                if let Some(val) = ctx.get_module_state("A") {
                    state.count = val["count"].as_i64().unwrap_or(0) as i32;
                }
            }
        })
        .build();

    let inst_a = ModuleInstance::new(Arc::new(def_a), Some(ctx.clone())).unwrap();
    let inst_b = ModuleInstance::new(Arc::new(def_b), Some(ctx.clone())).unwrap();
    inst_a.mount();
    inst_b.mount();

    // Module A increments 5 times, syncing to global each time
    for _ in 0..5 {
        inst_a.dispatch_action("increment_and_sync", None).unwrap();
    }

    // Module B reads from global
    inst_b.dispatch_action("read_global", None).unwrap();
    assert_eq!(inst_b.get_state().count, 5);
}

// ---------------------------------------------------------------------------
// UI file loading from disk
// ---------------------------------------------------------------------------

#[test]
fn test_ui_file_integration() {
    let dir = std::env::temp_dir().join("hypen_integration_ui_file");
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();

    let path = dir.join("counter.hypen");
    std::fs::write(&path, r#"Column { Text("Count: @{state.count}") }"#).unwrap();

    let def = ModuleBuilder::<CounterState>::new("FileModule")
        .state(CounterState { count: 0 })
        .ui_file(path.to_str().unwrap())
        .on_action::<()>("increment", |state, _, _| {
            state.count += 1;
        })
        .build();

    let instance = ModuleInstance::new(Arc::new(def), None).unwrap();
    instance.mount();
    instance.dispatch_action("increment", None).unwrap();
    assert_eq!(instance.get_state().count, 1);

    let _ = std::fs::remove_dir_all(&dir);
}

// ---------------------------------------------------------------------------
// Persist flag
// ---------------------------------------------------------------------------

#[test]
fn test_persist_flag_propagates() {
    let def = ModuleBuilder::<CounterState>::new("Persistent")
        .state(CounterState { count: 0 })
        .persist()
        .build();

    assert!(def.is_persistent());

    let non_persist = ModuleBuilder::<CounterState>::new("Ephemeral")
        .state(CounterState { count: 0 })
        .build();

    assert!(!non_persist.is_persistent());
}

// ---------------------------------------------------------------------------
// Event emitter
// ---------------------------------------------------------------------------

#[test]
fn test_event_emitter_cross_module() {
    let emitter = EventEmitter::new();
    let received = Arc::new(Mutex::new(vec![]));
    let r = received.clone();

    emitter.on("user:login", move |payload| {
        r.lock().unwrap().push(payload.clone());
    });

    emitter.emit("user:login", &json!({"user": "alice"}));
    emitter.emit("user:login", &json!({"user": "bob"}));

    let msgs = received.lock().unwrap();
    assert_eq!(msgs.len(), 2);
    assert_eq!(msgs[0]["user"], "alice");
    assert_eq!(msgs[1]["user"], "bob");
}

// ---------------------------------------------------------------------------
// Multi-module Grid: nested module with ForEach renders items from scoped state
// ---------------------------------------------------------------------------

#[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
struct AppState {
    current_view: String,
}

#[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
struct SearchState {
    search_query: String,
    explore_posts: Vec<ExplorePost>,
}

#[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
struct ExplorePost {
    id: String,
    image_url: String,
}

#[test]
fn test_nested_module_grid_renders_items() {
    use hypen_server::remote::{ModuleSessionConfig, RemoteSession};
    use hypen_server::discovery::ComponentRegistry;

    // Same pattern as examples/social/rust: App + Search modules,
    // Search has a Grid(@state.explorePosts) that should render Image elements.

    let app_module = Arc::new(
        HypenApp::module::<AppState>("App")
            .state(AppState {
                current_view: "search".to_string(),
            })
            .ui(r#"module App {
                Column {
                    If(condition: "@{state.currentView == 'search'}") {
                        Search()
                    }
                }
            }"#)
            .on_action::<()>("navigateToFeed", |state, _, _| {
                state.current_view = "feed".to_string();
            })
            .build(),
    );

    let search_module = Arc::new(
        HypenApp::module::<SearchState>("Search")
            .state(SearchState {
                search_query: String::new(),
                explore_posts: vec![
                    ExplorePost { id: "p1".into(), image_url: "https://img1.jpg".into() },
                    ExplorePost { id: "p2".into(), image_url: "https://img2.jpg".into() },
                    ExplorePost { id: "p3".into(), image_url: "https://img3.jpg".into() },
                ],
            })
            .build(),
    );

    // Register Search component source (same as the module's DSL)
    let mut components = ComponentRegistry::new();
    components.register("Search", r#"module Search {
        Column {
            Input(placeholder: "Search")
            Grid(@state.explorePosts, key: "id") {
                Image(src: "@{item.imageUrl}")
            }
        }
    }"#, None);

    // Create session — same API as the real server
    let session = RemoteSession::from_definition_with_state(
        app_module,
        components,
        AppState { current_view: "search".to_string() },
        vec![ModuleSessionConfig::from_definition(search_module)],
    );

    // Send hello — this triggers initial render and returns patches
    let responses = session.handle_hello(None);

    // Parse the initial tree response
    let initial_tree: serde_json::Value = responses
        .iter()
        .find_map(|r| {
            let v: serde_json::Value = serde_json::from_str(r).ok()?;
            if v["type"] == "initialTree" { Some(v) } else { None }
        })
        .expect("Should receive an initialTree response");

    let patches = initial_tree["patches"].as_array().expect("patches should be an array");
    let creates: Vec<&str> = patches
        .iter()
        .filter(|p| p["type"] == "create")
        .filter_map(|p| p["elementType"].as_str())
        .collect();

    // Grid container must be present
    assert!(
        creates.contains(&"Grid"),
        "Initial render should create a Grid element. Got: {:?}",
        creates
    );

    // 3 Image elements for the 3 explore posts
    let image_count = creates.iter().filter(|&&t| t == "Image").count();
    assert_eq!(
        image_count, 3,
        "Should create 3 Image elements. Got creates: {:?}",
        creates
    );

}

// ---------------------------------------------------------------------------
// RemoteSession: nested-module action dispatch actually runs the handler
// ---------------------------------------------------------------------------

/// Regression test for the RemoteSession action stubs: before the fix,
/// `handle_action` relied on engine-level no-op handlers and a fragile
/// pre-compute ritual, and nested-module handlers were keyed by
/// case-sensitive module names while the engine's scope map uses
/// lowercased keys. This test dispatches an action declared on a nested
/// module through the session's wire protocol and asserts that the
/// handler ran (module state advanced) and that patches were emitted.
#[test]
fn test_remote_session_dispatches_nested_module_action() {
    use hypen_server::discovery::ComponentRegistry;
    use hypen_server::remote::{ModuleSessionConfig, RemoteSession};

    #[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
    #[serde(rename_all = "camelCase")]
    struct ShellState {}

    #[derive(Clone, Default, Serialize, Deserialize, Debug, PartialEq)]
    #[serde(rename_all = "camelCase")]
    struct CounterModState {
        count: i32,
    }

    let shell = Arc::new(
        HypenApp::module::<ShellState>("Shell")
            .state(ShellState {})
            .ui(r#"module Shell {
                Column {
                    Counter()
                }
            }"#)
            .build(),
    );

    let counter = Arc::new(
        HypenApp::module::<CounterModState>("Counter")
            .state(CounterModState { count: 0 })
            .on_action::<()>("bump", |state, _, _| {
                state.count += 1;
            })
            .build(),
    );

    let mut components = ComponentRegistry::new();
    components.register(
        "Counter",
        r#"module Counter {
            Text("Count: @{state.count}")
        }"#,
        None,
    );

    let session = RemoteSession::from_definition_with_state(
        shell,
        components,
        ShellState {},
        vec![ModuleSessionConfig::from_definition(counter)],
    );

    // Initial render.
    let _ = session.handle_hello(None);

    // Dispatch the nested-module action through the wire protocol. Note
    // that the `module` field uses the original-case module name ("Counter"),
    // as clients would send it.
    let action_json = r#"{"type":"dispatchAction","module":"Counter","action":"bump"}"#;
    let responses = session.handle_message(action_json);

    // Revision must have advanced, proving the dispatch was routed and
    // the handler ran (otherwise `handle_action` would early-return
    // without bumping the revision).
    assert_eq!(
        session.revision(),
        1,
        "revision should advance after a successful nested-module dispatch"
    );

    // The session should have emitted a patch message. With a Text node
    // bound to `@{state.count}`, bumping the counter must produce at
    // least one SetText/SetProp patch.
    let has_patch_msg = responses.iter().any(|r| r.contains("\"type\":\"patch\""));
    assert!(
        has_patch_msg,
        "expected a patch message from nested-module dispatch, got: {:?}",
        responses
    );

    // Dispatch two more times for good measure — the handler must be
    // called each time, so the module state (and revision) keeps
    // advancing monotonically.
    for _ in 0..2 {
        let _ = session.handle_message(action_json);
    }
    assert_eq!(session.revision(), 3, "revision should advance per dispatch");
}