fret-runtime 0.1.0

Runtime abstractions and scheduling surfaces for host integration in Fret.
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
use std::collections::HashMap;
use std::sync::Arc;

use fret_core::AppWindowId;

use super::*;
use crate::WhenExpr;
use crate::{
    CommandId, CommandScope, GlobalsHost, InputContext, WindowCommandAvailabilityService,
    WindowInputContextService,
};
use std::any::{Any, TypeId};

#[derive(Default)]
struct TestGlobalsHost {
    globals: HashMap<TypeId, Box<dyn Any>>,
}

impl GlobalsHost for TestGlobalsHost {
    fn set_global<T: Any>(&mut self, value: T) {
        self.globals.insert(TypeId::of::<T>(), Box::new(value));
    }

    fn global<T: Any>(&self) -> Option<&T> {
        self.globals
            .get(&TypeId::of::<T>())
            .and_then(|value| value.downcast_ref::<T>())
    }

    fn with_global_mut<T: Any, R>(
        &mut self,
        init: impl FnOnce() -> T,
        f: impl FnOnce(&mut T, &mut Self) -> R,
    ) -> R {
        let type_id = TypeId::of::<T>();
        let mut value = match self.globals.remove(&type_id) {
            Some(value) => *value
                .downcast::<T>()
                .expect("TestGlobalsHost stored wrong type"),
            None => init(),
        };

        let out = f(&mut value, self);
        self.globals.insert(type_id, Box::new(value));
        out
    }
}

#[test]
fn base_snapshot_is_visible_when_no_stack_overrides_exist() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let base_ctx = InputContext {
        focus_is_text_input: true,
        ..Default::default()
    };
    svc.set_base_snapshot(
        window,
        WindowCommandGatingSnapshot::new(base_ctx, HashMap::new()),
    );

    assert!(
        svc.base_snapshot(window)
            .is_some_and(|s| s.input_ctx().focus_is_text_input),
        "expected base snapshot getter to return the stored base snapshot"
    );
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().focus_is_text_input),
        "expected snapshot() to fall back to base snapshot"
    );
}

#[test]
fn snapshot_prefers_stack_top_and_falls_back_to_base() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let base_ctx = InputContext {
        focus_is_text_input: true,
        ..Default::default()
    };
    svc.set_base_snapshot(
        window,
        WindowCommandGatingSnapshot::new(base_ctx, HashMap::new()),
    );
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().focus_is_text_input),
        "expected base snapshot to be visible"
    );

    let overlay_ctx = InputContext {
        ui_has_modal: true,
        focus_is_text_input: false,
        ..Default::default()
    };
    let handle = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(overlay_ctx, HashMap::new()),
    );
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().ui_has_modal && !s.input_ctx().focus_is_text_input),
        "expected stack top snapshot to win"
    );

    svc.pop_snapshot(handle).expect("remove pushed snapshot");
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().focus_is_text_input && !s.input_ctx().ui_has_modal),
        "expected fallback to base snapshot after popping"
    );

    svc.clear_base_snapshot(window);
    assert!(
        svc.snapshot(window).is_none(),
        "expected window to be cleared"
    );
}

#[test]
fn action_availability_disables_widget_scope_commands_only() {
    let command = CommandId::new("test.widget");

    let mut availability: HashMap<CommandId, bool> = HashMap::new();
    availability.insert(command.clone(), false);

    let snapshot = WindowCommandGatingSnapshot::new(InputContext::default(), HashMap::new())
        .with_action_availability(Some(Arc::new(availability)));

    assert!(
        !snapshot.is_enabled_for_meta(&command, CommandScope::Widget, None),
        "expected widget-scope command to be disabled by action availability"
    );
    assert!(
        snapshot.is_enabled_for_meta(&command, CommandScope::Window, None),
        "expected non-widget scopes to ignore action availability"
    );
}

#[test]
fn when_expr_can_gate_by_key_contexts_in_snapshot() {
    let command = CommandId::new("test.key_contexts");
    let when = WhenExpr::parse("keyctx.workspace.tabs").unwrap();

    let snapshot = WindowCommandGatingSnapshot::new(InputContext::default(), HashMap::new())
        .with_key_contexts(vec![Arc::<str>::from("workspace.tabs")]);
    assert!(
        snapshot.is_enabled_for_meta(&command, CommandScope::App, Some(&when)),
        "expected the command to be enabled when the required key context is active"
    );

    let snapshot = WindowCommandGatingSnapshot::new(InputContext::default(), HashMap::new());
    assert!(
        !snapshot.is_enabled_for_meta(&command, CommandScope::App, Some(&when)),
        "expected the command to be disabled when the key context is missing"
    );
}

#[test]
fn snapshot_for_window_overlays_authoritative_command_availability_over_stale_input_context() {
    let mut host = TestGlobalsHost::default();
    let window = AppWindowId::default();
    let command = CommandId::new("test.router.back");
    let when = WhenExpr::parse("router.can_back").unwrap();

    host.with_global_mut(WindowInputContextService::default, |svc, _host| {
        svc.set_snapshot(
            window,
            InputContext {
                router_can_back: false,
                ..Default::default()
            },
        );
    });
    host.with_global_mut(WindowCommandAvailabilityService::default, |svc, _host| {
        svc.set_router_availability(window, true, false);
    });

    let snapshot =
        snapshot_for_window_with_input_ctx_fallback(&host, window, InputContext::default());
    assert!(
        snapshot.is_enabled_for_meta(&command, CommandScope::App, Some(&when)),
        "expected gating snapshot to read authoritative router availability even when the published input context snapshot is stale"
    );
}

#[test]
fn set_snapshot_does_not_override_stack_top() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let outer_ctx = InputContext {
        focus_is_text_input: true,
        ..Default::default()
    };
    let token = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(outer_ctx, HashMap::new()),
    );

    let base_ctx = InputContext {
        ui_has_modal: true,
        ..Default::default()
    };
    svc.set_snapshot(
        window,
        WindowCommandGatingSnapshot::new(base_ctx, HashMap::new()),
    );

    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().focus_is_text_input && !s.input_ctx().ui_has_modal),
        "expected stack top to remain effective after set_snapshot"
    );

    svc.pop_snapshot(token).expect("remove pushed snapshot");
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().ui_has_modal && !s.input_ctx().focus_is_text_input),
        "expected base snapshot to become effective after popping stack"
    );
}

#[test]
fn pushed_snapshots_can_be_removed_out_of_order() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let outer_ctx = InputContext {
        ui_has_modal: true,
        ..Default::default()
    };
    let outer = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(outer_ctx, HashMap::new()),
    );

    let inner_ctx = InputContext {
        dispatch_phase: crate::InputDispatchPhase::Capture,
        ..Default::default()
    };
    let inner = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(inner_ctx, HashMap::new()),
    );

    assert_eq!(
        svc.snapshot(window)
            .expect("snapshot")
            .input_ctx()
            .dispatch_phase,
        crate::InputDispatchPhase::Capture
    );

    svc.pop_snapshot(outer).expect("remove outer");
    assert_eq!(
        svc.snapshot(window)
            .expect("snapshot")
            .input_ctx()
            .dispatch_phase,
        crate::InputDispatchPhase::Capture,
        "expected inner snapshot to remain effective"
    );

    svc.pop_snapshot(inner).expect("remove inner");
    assert!(
        svc.snapshot(window).is_none(),
        "expected all snapshots removed"
    );
}
#[test]
fn clearing_base_snapshot_does_not_remove_active_overlay_snapshot() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let base_ctx = InputContext {
        focus_is_text_input: true,
        ..Default::default()
    };
    svc.set_base_snapshot(
        window,
        WindowCommandGatingSnapshot::new(base_ctx, HashMap::new()),
    );

    let overlay_ctx = InputContext {
        ui_has_modal: true,
        ..Default::default()
    };
    let handle = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(overlay_ctx, HashMap::new()),
    );

    svc.clear_base_snapshot(window);
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().ui_has_modal && !s.input_ctx().focus_is_text_input),
        "expected overlay snapshot to remain effective after clearing base"
    );

    svc.pop_snapshot(handle).expect("remove pushed snapshot");
    assert!(
        svc.snapshot(window).is_none(),
        "expected window to be cleared after removing the last overlay snapshot"
    );
}

#[test]
fn setting_base_snapshot_does_not_override_stack_top() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let overlay_ctx = InputContext {
        ui_has_modal: true,
        focus_is_text_input: false,
        ..Default::default()
    };
    let handle = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(overlay_ctx, HashMap::new()),
    );

    let base_ctx = InputContext {
        ui_has_modal: false,
        focus_is_text_input: true,
        ..Default::default()
    };
    svc.set_base_snapshot(
        window,
        WindowCommandGatingSnapshot::new(base_ctx, HashMap::new()),
    );

    assert!(
        svc.snapshot(window)
            .is_some_and(|s| { s.input_ctx().ui_has_modal && !s.input_ctx().focus_is_text_input }),
        "expected stack top snapshot to remain effective after set_snapshot"
    );

    svc.pop_snapshot(handle).expect("remove pushed snapshot");
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| !s.input_ctx().ui_has_modal && s.input_ctx().focus_is_text_input),
        "expected base snapshot to take effect after popping the overlay"
    );
}

#[test]
fn updating_pushed_snapshot_only_affects_that_entry() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let outer_ctx = InputContext {
        ui_has_modal: true,
        ..Default::default()
    };
    let outer = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(outer_ctx, HashMap::new()),
    );

    let inner_ctx = InputContext {
        dispatch_phase: crate::InputDispatchPhase::Capture,
        ..Default::default()
    };
    let inner = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(inner_ctx, HashMap::new()),
    );

    let updated_outer_ctx = InputContext {
        dispatch_phase: crate::InputDispatchPhase::Preview,
        ..Default::default()
    };
    assert!(
        svc.update_pushed_snapshot(
            outer,
            WindowCommandGatingSnapshot::new(updated_outer_ctx, HashMap::new())
        ),
        "expected update to succeed"
    );

    assert_eq!(
        svc.snapshot(window)
            .expect("snapshot")
            .input_ctx()
            .dispatch_phase,
        crate::InputDispatchPhase::Capture,
        "expected inner snapshot to remain effective"
    );

    svc.pop_snapshot(inner).expect("remove inner");
    assert_eq!(
        svc.snapshot(window)
            .expect("snapshot")
            .input_ctx()
            .dispatch_phase,
        crate::InputDispatchPhase::Preview,
        "expected updated outer snapshot to become effective after popping inner"
    );
}

#[test]
fn removing_inner_snapshot_restores_outer_snapshot() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let outer_ctx = InputContext {
        ui_has_modal: true,
        ..Default::default()
    };
    let outer = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(outer_ctx, HashMap::new()),
    );

    let inner_ctx = InputContext {
        dispatch_phase: crate::InputDispatchPhase::Capture,
        ..Default::default()
    };
    let inner = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(inner_ctx, HashMap::new()),
    );

    svc.pop_snapshot(inner).expect("remove inner");
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().ui_has_modal),
        "expected outer snapshot to become effective after popping inner"
    );

    svc.pop_snapshot(outer).expect("remove outer");
    assert!(
        svc.snapshot(window).is_none(),
        "expected all snapshots removed"
    );
}

#[test]
fn clear_snapshot_only_clears_base_not_pushed_overrides() {
    let window = AppWindowId::default();
    let mut svc = WindowCommandGatingService::default();

    let base_ctx = InputContext {
        focus_is_text_input: true,
        ..Default::default()
    };
    svc.set_base_snapshot(
        window,
        WindowCommandGatingSnapshot::new(base_ctx, HashMap::new()),
    );

    let overlay_ctx = InputContext {
        ui_has_modal: true,
        ..Default::default()
    };
    let handle = svc.push_snapshot(
        window,
        WindowCommandGatingSnapshot::new(overlay_ctx, HashMap::new()),
    );

    svc.clear_base_snapshot(window);
    assert!(
        svc.snapshot(window)
            .is_some_and(|s| s.input_ctx().ui_has_modal),
        "expected pushed override to remain after clearing base snapshot"
    );

    svc.pop_snapshot(handle).expect("remove pushed snapshot");
    assert!(
        svc.snapshot(window).is_none(),
        "expected window to be cleared after removing last pushed override and base"
    );
}