cranpose-core 0.0.60

Core runtime for a Jetpack Compose inspired UI framework in Rust
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
use super::*;

fn compose_single_i32_value_slot(harness: &mut SlotHarness, key: Key, value: i32) -> ValueSlotId {
    harness.begin_pass(SlotPassMode::Compose);
    let slot = harness.session(|session| {
        begin_unkeyed(session, key, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || value);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();
    slot
}

#[test]
fn payload_records_store_semantic_payload_kinds() {
    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    harness.session(|session| {
        begin_unkeyed(session, 52, None);
        let _remembered = session.remember(|| 17_i32);
        let _param_slot = session
            .value_slot_with_kind(super::PayloadKind::Param, crate::ParamState::<i32>::default);
        let _callback_slot =
            session.value_slot_with_kind(super::PayloadKind::Param, crate::CallbackHolder::new);
        let _return_slot = session.value_slot_with_kind(
            super::PayloadKind::Return,
            crate::ReturnSlot::<i32>::default,
        );
        let _effect_slot = session.remember_with_kind(
            super::PayloadKind::Effect,
            crate::DisposableEffectState::default,
        );
        let _type_named_internal_slot =
            session.value_slot_with_kind(PayloadKind::Internal, crate::ReturnSlot::<i32>::default);
        let _internal_slot = session.value_slot_with_kind(PayloadKind::Internal, || 99_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
    });
    harness.finish_pass();

    let payload_kinds = harness
        .table
        .group_payload_records_at(0)
        .iter()
        .map(|payload| payload.kind)
        .collect::<Vec<_>>();

    assert_eq!(
        payload_kinds,
        vec![
            super::PayloadKind::Remember,
            super::PayloadKind::Param,
            super::PayloadKind::Param,
            super::PayloadKind::Return,
            super::PayloadKind::Effect,
            super::PayloadKind::Internal,
            super::PayloadKind::Internal,
        ]
    );
}

#[test]
fn appended_value_slots_batch_payload_location_refresh() {
    const GROUP_KEY: Key = 53;

    let mut harness = SlotHarness::new();
    let before = harness.table.debug_stats().mutation;

    harness.begin_pass(SlotPassMode::Compose);
    let slots = harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let first = session.value_slot_with_kind(PayloadKind::Internal, || 10_i32);
        let remembered = session.remember(|| 20_i32);
        let third = session.value_slot_with_kind(PayloadKind::Internal, || 30_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        (first, remembered, third)
    });
    harness.finish_pass();

    let after = harness.table.debug_stats();
    assert_eq!(after.active_payload_anchor_count, 3);
    assert_eq!(
        after.mutation.payload_location_refresh_count - before.payload_location_refresh_count,
        1
    );
    assert_eq!(
        after.mutation.payload_location_refresh_payload_count
            - before.payload_location_refresh_payload_count,
        3
    );
    assert_eq!(after.mutation.payload_location_refresh_max_span, 3);
    assert_eq!(*harness.table.read_value::<i32>(slots.0), 10);
    assert_eq!(slots.1.with(|value| *value), 20);
    assert_eq!(*harness.table.read_value::<i32>(slots.2), 30);
}

#[test]
fn pending_payload_location_refreshes_coalesce_to_lowest_start() {
    const GROUP_KEY: Key = 56;

    let mut harness = SlotHarness::new();
    harness.begin_pass(SlotPassMode::Compose);
    harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let _first = session.value_slot_with_kind(PayloadKind::Internal, || 10_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
    });
    harness.finish_pass();

    harness.begin_pass(SlotPassMode::Compose);
    let (first, second, third) = harness.session(|session| {
        let group = begin_unkeyed(session, GROUP_KEY, None);
        let first = session.value_slot_with_kind(PayloadKind::Internal, || 0_i32);
        assert!(
            !session.state.has_pending_payload_location_refreshes(),
            "reusing an existing payload must not request a location refresh"
        );

        let second = session.value_slot_with_kind(PayloadKind::Internal, || 20_i32);
        assert_eq!(
            session
                .state
                .pending_payload_location_refresh_start(group.anchor),
            Some(1)
        );

        let third = session.value_slot_with_kind(PayloadKind::Internal, || 30_i32);
        assert_eq!(
            session
                .state
                .pending_payload_location_refresh_start(group.anchor),
            Some(1),
            "multiple payload inserts in one group must coalesce to the lowest dirty index"
        );

        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        assert!(
            !session.state.has_pending_payload_location_refreshes(),
            "finish_group_body must flush deferred payload location refreshes"
        );
        assert_eq!(*session.table.read_value::<i32>(first), 10);
        assert_eq!(*session.table.read_value::<i32>(second), 20);
        assert_eq!(*session.table.read_value::<i32>(third), 30);
        session.end_group();
        (first, second, third)
    });
    harness.finish_pass();

    assert_eq!(*harness.table.read_value::<i32>(first), 10);
    assert_eq!(*harness.table.read_value::<i32>(second), 20);
    assert_eq!(*harness.table.read_value::<i32>(third), 30);
}

#[test]
fn writer_validation_rejects_pending_payload_location_refreshes() {
    const GROUP_KEY: Key = 57;

    let mut harness = SlotHarness::new();
    harness.begin_pass(SlotPassMode::Compose);
    let slot = {
        let mut session = harness
            .table
            .write_session(&mut harness.lifecycle, &mut harness.state);
        begin_unkeyed(&mut session, GROUP_KEY, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 42_i32);
        assert!(
            session.state.has_pending_payload_location_refreshes(),
            "appending a payload should defer the range refresh until a writer boundary"
        );
        slot
    };
    assert_eq!(
        harness.state.validate(&harness.table),
        Err(SlotInvariantError::WriterPendingPayloadLocationRefreshes { count: 1 })
    );

    harness
        .state
        .flush_payload_location_refreshes(&mut harness.table);
    assert!(!harness.state.has_pending_payload_location_refreshes());
    assert_eq!(harness.state.validate(&harness.table), Ok(()));
    harness.finish_pass();

    assert_eq!(*harness.table.read_value::<i32>(slot), 42);
}

#[test]
fn payload_tail_removal_does_not_refresh_empty_suffix() {
    const GROUP_KEY: Key = 55;

    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let _first = session.value_slot_with_kind(PayloadKind::Internal, || 10_i32);
        let _second = session.value_slot_with_kind(PayloadKind::Internal, || 20_i32);
        let _third = session.value_slot_with_kind(PayloadKind::Internal, || 30_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
    });
    harness.finish_pass();

    let before = harness.table.debug_stats().mutation;

    harness.begin_pass(SlotPassMode::Compose);
    harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let _first = session.value_slot_with_kind(PayloadKind::Internal, || 0_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
    });
    harness.finish_pass();

    let after = harness.table.debug_stats().mutation;
    assert_eq!(
        after.payload_location_refresh_count - before.payload_location_refresh_count,
        0
    );
    assert_eq!(harness.table.debug_stats().active_payload_anchor_count, 1);
}

#[test]
fn payload_kind_updates_when_same_type_slot_changes_semantics() {
    const GROUP_KEY: Key = 54;

    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let first_slot = harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let slot = session.value_slot_with_kind(super::PayloadKind::Param, || 7_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();
    assert_eq!(
        harness.table.group_payload_record_at(0, 0).kind,
        super::PayloadKind::Param
    );

    harness.begin_pass(SlotPassMode::Compose);
    let second_slot = harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let slot = session.value_slot_with_kind(super::PayloadKind::Return, || 9_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();

    assert_eq!(first_slot, second_slot);
    assert_eq!(
        harness.table.group_payload_record_at(0, 0).kind,
        super::PayloadKind::Return
    );
    assert_eq!(*harness.table.read_value::<i32>(second_slot), 7);
}

#[test]
fn second_identical_composition_reuses_group_and_value() {
    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let first_slot = harness.session(|session| {
        begin_unkeyed(session, 11, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 10_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();
    harness.table.write_value(first_slot, 99_i32);

    harness.begin_pass(SlotPassMode::Compose);
    let (kind, second_slot) = harness.session(|session| {
        let started = begin_unkeyed(session, 11, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 0_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        (started.kind, slot)
    });
    harness.finish_pass();

    assert_eq!(kind, GroupStartKind::Reused);
    assert_eq!(second_slot, first_slot);
    assert_eq!(*harness.table.read_value::<i32>(second_slot), 99);
}

#[test]
fn read_value_mut_updates_existing_slot_in_place() {
    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let slot = harness.session(|session| {
        begin_unkeyed(session, 12, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 5_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();

    *harness.table.read_value_mut::<i32>(slot) = 77;

    assert_eq!(*harness.table.read_value::<i32>(slot), 77);
}

#[test]
fn same_table_value_slot_read_write_respects_storage_identity() {
    let mut harness = SlotHarness::new();

    let slot = compose_single_i32_value_slot(&mut harness, 17, 21);

    assert_eq!(slot.storage_id(), harness.table.storage_id());
    assert_eq!(*harness.table.read_value::<i32>(slot), 21);
    harness.table.write_value(slot, 34_i32);
    assert_eq!(*harness.table.read_value::<i32>(slot), 34);
}

#[test]
#[should_panic(expected = "value slot belongs to a different slot table")]
fn cross_table_value_slot_read_panics_before_anchor_resolution() {
    let mut first = SlotHarness::new();
    let first_slot = compose_single_i32_value_slot(&mut first, 18, 55);

    let mut second = SlotHarness::new();
    let second_slot = compose_single_i32_value_slot(&mut second, 20, 89);

    assert_eq!(first_slot.anchor(), second_slot.anchor());
    assert_ne!(first_slot.storage_id(), second_slot.storage_id());
    let _ = second.table.read_value::<i32>(first_slot);
}

#[test]
fn cross_table_value_slot_write_does_not_alias_matching_anchor() {
    let mut first = SlotHarness::new();
    let first_slot = compose_single_i32_value_slot(&mut first, 21, 55);

    let mut second = SlotHarness::new();
    let second_slot = compose_single_i32_value_slot(&mut second, 22, 89);

    assert_eq!(first_slot.anchor(), second_slot.anchor());
    assert_ne!(first_slot.storage_id(), second_slot.storage_id());
    let cross_table_write = panic::catch_unwind(AssertUnwindSafe(|| {
        second.table.write_value(first_slot, 144_i32);
    }));
    assert!(
        cross_table_write.is_err(),
        "cross-table value-slot writes must fail before touching matching anchors"
    );
    assert_eq!(*first.table.read_value::<i32>(first_slot), 55);
    assert_eq!(*second.table.read_value::<i32>(second_slot), 89);
}

#[test]
fn read_value_type_mismatch_panics_consistently() {
    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let slot = harness.session(|session| {
        begin_unkeyed(session, 15, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 5_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();

    let mismatch_read = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
        let _ = harness.table.read_value::<u32>(slot);
    }));
    assert!(
        mismatch_read.is_err(),
        "typed value-slot reads must fail on a type mismatch"
    );
}

#[test]
fn value_slot_type_replacement_advances_generation() {
    const GROUP_KEY: Key = 16;

    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let old_slot = harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 5_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();

    harness.begin_pass(SlotPassMode::Compose);
    let replacement_slot = harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 7_u32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();

    assert_eq!(replacement_slot.anchor().id(), old_slot.anchor().id());
    assert_ne!(
        replacement_slot.anchor().generation(),
        old_slot.anchor().generation()
    );
    assert_eq!(*harness.table.read_value::<u32>(replacement_slot), 7);

    let stale_read = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
        let _ = harness.table.read_value::<i32>(old_slot);
    }));
    assert!(
        stale_read.is_err(),
        "replaced value slot handles must fail instead of reading the replacement"
    );
}

#[test]
fn disposed_value_slot_handle_does_not_alias_new_slot() {
    const OLD_KEY: Key = 13;
    const NEW_KEY: Key = 14;

    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let old_slot = harness.session(|session| {
        begin_unkeyed(session, OLD_KEY, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 5_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();

    harness.begin_pass(SlotPassMode::Compose);
    harness.finish_pass();
    assert!(harness.table.groups.is_empty());
    harness.table.compact_payload_anchor_registry_storage(None);

    harness.begin_pass(SlotPassMode::Compose);
    let new_slot = harness.session(|session| {
        begin_unkeyed(session, NEW_KEY, None);
        let slot = session.value_slot_with_kind(PayloadKind::Internal, || 77_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        slot
    });
    harness.finish_pass();

    assert_eq!(new_slot.anchor().id(), old_slot.anchor().id());
    assert_ne!(
        new_slot.anchor().generation(),
        old_slot.anchor().generation()
    );
    assert_eq!(*harness.table.read_value::<i32>(new_slot), 77);

    let stale_read = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
        let _ = harness.table.read_value::<i32>(old_slot);
    }));
    assert!(
        stale_read.is_err(),
        "disposed value slot handles must fail cleanly instead of aliasing a new slot"
    );
}

#[test]
fn removed_payload_tail_invalidates_value_slot_handle() {
    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let (first_slot, removed_slot) = harness.session(|session| {
        begin_unkeyed(session, 19, None);
        let first_slot = session.value_slot_with_kind(PayloadKind::Internal, || 1_i32);
        let removed_slot = session.value_slot_with_kind(PayloadKind::Internal, || 2_i32);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        (first_slot, removed_slot)
    });
    harness.finish_pass();

    let owner = harness.table.groups[0].anchor;
    let removed_range = harness.table.group_payload_subrange_at(0, 1, 2);
    let removed = harness.table.remove_payload_range(owner, removed_range);
    assert_eq!(removed.len(), 1);

    assert_eq!(*harness.table.read_value::<i32>(first_slot), 1);
    let removed_read = panic::catch_unwind(AssertUnwindSafe(|| {
        let _ = harness.table.read_value::<i32>(removed_slot);
    }));
    assert!(
        removed_read.is_err(),
        "removed payload tail handles must fail cleanly after invalidation"
    );
    assert_eq!(harness.table.validate(), Ok(()));
}

#[test]
fn recomposition_removes_tail_payloads_and_nodes_together() {
    const GROUP_KEY: Key = 59;
    const FIRST_NODE: NodeId = 590;
    const SECOND_NODE: NodeId = 591;

    let mut harness = SlotHarness::new();

    harness.begin_pass(SlotPassMode::Compose);
    let (first_slot, removed_slot) = harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let first_slot = session.value_slot_with_kind(PayloadKind::Internal, || 1_i32);
        let removed_slot = session.value_slot_with_kind(PayloadKind::Internal, || 2_i32);
        session.record_node_with_parent(FIRST_NODE, 1, None);
        session.record_node_with_parent(SECOND_NODE, 1, None);
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        assert!(result.direct_nodes.is_empty());
        session.end_group();
        (first_slot, removed_slot)
    });
    harness.finish_pass();

    harness.begin_pass(SlotPassMode::Compose);
    let direct_nodes = harness.session(|session| {
        begin_unkeyed(session, GROUP_KEY, None);
        let first_slot_after = session.value_slot_with_kind(PayloadKind::Internal, || 0_i32);
        assert_eq!(first_slot_after, first_slot);
        let recorded = session.record_node_with_parent(FIRST_NODE, 1, None);
        assert_eq!(
            recorded,
            NodeSlotUpdate::Reused {
                id: FIRST_NODE,
                generation: 1,
            },
        );
        let result = session.finish_group_body();
        assert!(result.detached_children.is_empty());
        session.end_group();
        result.direct_nodes
    });
    harness.finish_pass();

    assert_eq!(direct_nodes, vec![SECOND_NODE]);
    assert_eq!(harness.table.group_payload_len_at(0), 1);
    assert_eq!(harness.table.group_node_len_at(0), 1);
    assert_eq!(*harness.table.read_value::<i32>(first_slot), 1);
    let removed_read = panic::catch_unwind(AssertUnwindSafe(|| {
        let _ = harness.table.read_value::<i32>(removed_slot);
    }));
    assert!(
        removed_read.is_err(),
        "tail payload removal must invalidate the removed value slot"
    );
    assert_eq!(harness.table.group_node_record_at(0, 0).id, FIRST_NODE);
    assert_eq!(harness.table.validate(), Ok(()));
}