liminal-server 0.3.1

Standalone server for the liminal messaging bus
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
//! Full mapped-shape real-socket history across a same-directory cold reopen.

use std::error::Error;
use std::path::Path;

use liminal_protocol::wire::{
    AttachAttemptToken, ClientRequest, CredentialAttachRequest, DetachAttemptToken, DetachRequest,
    EnrollmentRequest, EnrollmentToken, Generation, LeaveAttemptToken, LeaveRequest, MarkerAck,
    ParticipantDelivery, ParticipantRecord, RecordAdmission, RecordAdmissionAttemptToken,
    ServerPush, ServerValue,
};

use crate::config::types::ParticipantConfig;

use super::e2e_cold_all_shapes_fixture::{
    ALL_SHAPES_CONVERSATION, ColdMember, MARKER_INTERLEAVING_CONVERSATION, ack_through,
    assert_decoded_source_census, decoded_history, expect_enrolled, expected_live_deliveries,
};
use super::e2e_tests::{SocketFixture, SocketPeer};
use super::log::StoredOperation;
use super::outbox_log::OutboxRow;
use super::tests_marker_ack_fixture::marker_fixture_config;

struct ExpectedDeliveries {
    main: Vec<ParticipantDelivery>,
    marker: Vec<ParticipantDelivery>,
}

fn enroll_main_members(
    first: &mut SocketFixture,
    second: &mut SocketPeer,
    observer: &mut SocketPeer,
    transient: &mut SocketPeer,
) -> Result<(ColdMember, ColdMember, ColdMember), Box<dyn Error>> {
    let primary = ColdMember::enrolled(&expect_enrolled(
        first.request(ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            enrollment_token: EnrollmentToken::new([0x24; 16]),
        }))?,
        "primary",
    )?);
    let actor = ColdMember::enrolled(&expect_enrolled(
        second.request(ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            enrollment_token: EnrollmentToken::new([0x25; 16]),
        }))?,
        "actor",
    )?);
    let replay_recipient = ColdMember::enrolled(&expect_enrolled(
        observer.request(ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            enrollment_token: EnrollmentToken::new([0x26; 16]),
        }))?,
        "replay recipient",
    )?);
    let retired = ColdMember::enrolled(&expect_enrolled(
        transient.request(ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            enrollment_token: EnrollmentToken::new([0x27; 16]),
        }))?,
        "transient",
    )?);
    let left = transient.request(ClientRequest::Leave(LeaveRequest {
        conversation_id: ALL_SHAPES_CONVERSATION,
        participant_id: retired.participant_id,
        capability_generation: retired.generation,
        attach_secret: retired.secret,
        leave_attempt_token: LeaveAttemptToken::new([0x28; 16]),
    }))?;
    assert!(matches!(left, ServerValue::LeaveCommitted(_)));
    Ok((primary, actor, replay_recipient))
}

fn commit_main_shapes(
    first: &mut SocketFixture,
    second: &mut SocketPeer,
    primary: ColdMember,
    mut actor: ColdMember,
) -> Result<(), Box<dyn Error>> {
    assert!(matches!(
        second.request(ClientRequest::Detach(DetachRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            participant_id: actor.participant_id,
            capability_generation: actor.generation,
            detach_attempt_token: DetachAttemptToken::new([0x29; 16]),
        }))?,
        ServerValue::DetachCommitted(_)
    ));
    let mut ordinary_attach = first.spawn_peer()?;
    let attached =
        ordinary_attach.request(ClientRequest::CredentialAttach(CredentialAttachRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            participant_id: actor.participant_id,
            capability_generation: actor.generation,
            attach_secret: actor.secret,
            attach_attempt_token: AttachAttemptToken::new([0x2A; 16]),
            accept_marker_delivery_seq: None,
        }))?;
    let ServerValue::AttachBound(attached) = attached else {
        return Err(format!("ordinary attach did not bind: {attached:?}").into());
    };
    actor.generation = attached.capability_generation();
    actor.secret = attached.attach_secret();
    let mut superseding = first.spawn_peer()?;
    let superseded =
        superseding.request(ClientRequest::CredentialAttach(CredentialAttachRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            participant_id: actor.participant_id,
            capability_generation: actor.generation,
            attach_secret: actor.secret,
            attach_attempt_token: AttachAttemptToken::new([0x2B; 16]),
            accept_marker_delivery_seq: None,
        }))?;
    let ServerValue::AttachBound(superseded) = superseded else {
        return Err(format!("superseding attach did not bind: {superseded:?}").into());
    };
    actor.generation = superseded.capability_generation();
    actor.secret = superseded.attach_secret();
    let record = first.request(ClientRequest::RecordAdmission(RecordAdmission {
        conversation_id: ALL_SHAPES_CONVERSATION,
        participant_id: primary.participant_id,
        capability_generation: primary.generation,
        record_admission_attempt_token: RecordAdmissionAttemptToken::new([0x2C; 16]),
        payload: vec![0xA5],
    }))?;
    let ServerValue::RecordCommitted(record) = record else {
        return Err(format!("all-shapes record did not commit: {record:?}").into());
    };
    let actor_left = superseding.request(ClientRequest::Leave(LeaveRequest {
        conversation_id: ALL_SHAPES_CONVERSATION,
        participant_id: actor.participant_id,
        capability_generation: actor.generation,
        attach_secret: actor.secret,
        leave_attempt_token: LeaveAttemptToken::new([0x2D; 16]),
    }))?;
    let ServerValue::LeaveCommitted(actor_left) = actor_left else {
        return Err(format!("all-shapes Leave did not commit: {actor_left:?}").into());
    };
    ack_through(
        first,
        ALL_SHAPES_CONVERSATION,
        primary,
        actor_left.left_delivery_seq(),
    )?;
    assert!(record.delivery_seq() < actor_left.left_delivery_seq());
    Ok(())
}

fn fill_marker_history(
    first: &mut SocketFixture,
    second: &mut SocketPeer,
    transient: &mut SocketPeer,
) -> Result<(ColdMember, ColdMember, u64), Box<dyn Error>> {
    let marker_a = ColdMember::enrolled(&expect_enrolled(
        first.request(ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id: MARKER_INTERLEAVING_CONVERSATION,
            enrollment_token: EnrollmentToken::new([0x31; 16]),
        }))?,
        "marker A",
    )?);
    let marker_b = ColdMember::enrolled(&expect_enrolled(
        second.request(ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id: MARKER_INTERLEAVING_CONVERSATION,
            enrollment_token: EnrollmentToken::new([0x32; 16]),
        }))?,
        "marker B",
    )?);
    let marker_c = ColdMember::enrolled(&expect_enrolled(
        transient.request(ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id: MARKER_INTERLEAVING_CONVERSATION,
            enrollment_token: EnrollmentToken::new([0x33; 16]),
        }))?,
        "marker C",
    )?);
    ack_through(first, MARKER_INTERLEAVING_CONVERSATION, marker_a, 3)?;
    ack_through(second, MARKER_INTERLEAVING_CONVERSATION, marker_b, 3)?;
    let marker_c_left = transient.request(ClientRequest::Leave(LeaveRequest {
        conversation_id: MARKER_INTERLEAVING_CONVERSATION,
        participant_id: marker_c.participant_id,
        capability_generation: marker_c.generation,
        attach_secret: marker_c.secret,
        leave_attempt_token: LeaveAttemptToken::new([0x34; 16]),
    }))?;
    let ServerValue::LeaveCommitted(marker_c_left) = marker_c_left else {
        return Err(format!("marker C Leave did not commit: {marker_c_left:?}").into());
    };
    ack_through(
        first,
        MARKER_INTERLEAVING_CONVERSATION,
        marker_a,
        marker_c_left.left_delivery_seq(),
    )?;
    ack_through(
        second,
        MARKER_INTERLEAVING_CONVERSATION,
        marker_b,
        marker_c_left.left_delivery_seq(),
    )?;
    let mut latest_record = 0_u64;
    for token in [0x35, 0x36, 0x37, 0x38] {
        let outcome = first.request(ClientRequest::RecordAdmission(RecordAdmission {
            conversation_id: MARKER_INTERLEAVING_CONVERSATION,
            participant_id: marker_a.participant_id,
            capability_generation: marker_a.generation,
            record_admission_attempt_token: RecordAdmissionAttemptToken::new([token; 16]),
            payload: vec![token],
        }))?;
        let ServerValue::RecordCommitted(committed) = outcome else {
            return Err(format!("marker-driving record {token:#x} failed: {outcome:?}").into());
        };
        latest_record = committed.delivery_seq();
        if token != 0x38 {
            ack_through(
                second,
                MARKER_INTERLEAVING_CONVERSATION,
                marker_b,
                latest_record,
            )?;
        }
    }
    Ok((marker_a, marker_b, latest_record))
}

fn finish_marker_history(
    first: &mut SocketFixture,
    second: &mut SocketPeer,
    marker_a: ColdMember,
    marker_b: ColdMember,
    latest_record: u64,
) -> Result<(), Box<dyn Error>> {
    first.open_publication_replay()?;
    let mut marker_wake = first.spawn_peer()?;
    let _ = marker_wake.request(ClientRequest::RecordAdmission(RecordAdmission {
        conversation_id: MARKER_INTERLEAVING_CONVERSATION,
        participant_id: u64::MAX,
        capability_generation: Generation::ONE,
        record_admission_attempt_token: RecordAdmissionAttemptToken::new([0x3C; 16]),
        payload: Vec::new(),
    }))?;
    let ServerPush::ParticipantDelivery(marker_on_a) = first.read_push()? else {
        return Err("marker A did not receive the generated marker".into());
    };
    let ServerPush::ParticipantDelivery(marker_on_b) = second.read_push()? else {
        return Err("marker B did not receive the generated marker".into());
    };
    assert_eq!(marker_on_a, marker_on_b);
    let ServerPush::ParticipantDelivery(last_on_b) = second.read_push()? else {
        return Err("marker B did not receive the post-marker ordinary record".into());
    };
    assert_eq!(last_on_b.delivery_seq, latest_record);
    let ParticipantRecord::HistoryCompacted {
        affected_participant_id,
        ..
    } = marker_on_a.record
    else {
        return Err(format!("generated delivery was not a marker: {marker_on_a:?}").into());
    };
    let marker_ack = MarkerAck {
        conversation_id: MARKER_INTERLEAVING_CONVERSATION,
        participant_id: affected_participant_id,
        capability_generation: Generation::ONE,
        marker_delivery_seq: marker_on_a.delivery_seq,
    };
    let marker_ack_outcome = if affected_participant_id == marker_a.participant_id {
        first.request(ClientRequest::MarkerAck(marker_ack))?
    } else if affected_participant_id == marker_b.participant_id {
        second.request(ClientRequest::MarkerAck(marker_ack))?
    } else {
        return Err("generated marker targeted neither live fixture member".into());
    };
    assert!(matches!(
        marker_ack_outcome,
        ServerValue::MarkerAckCommitted(_)
    ));
    ack_through(
        second,
        MARKER_INTERLEAVING_CONVERSATION,
        marker_b,
        latest_record,
    )?;
    first.block_publication_replay()?;
    let post_marker = second.request(ClientRequest::RecordAdmission(RecordAdmission {
        conversation_id: MARKER_INTERLEAVING_CONVERSATION,
        participant_id: marker_b.participant_id,
        capability_generation: marker_b.generation,
        record_admission_attempt_token: RecordAdmissionAttemptToken::new([0x39; 16]),
        payload: vec![0xFF],
    }))?;
    assert!(matches!(post_marker, ServerValue::RecordCommitted(_)));
    Ok(())
}

fn decoded_expectations(
    data_dir: &Path,
    replay_recipient: ColdMember,
    marker_a: ColdMember,
) -> Result<ExpectedDeliveries, Box<dyn Error>> {
    let (main_base, main_extension) = decoded_history(data_dir, ALL_SHAPES_CONVERSATION)?;
    let (marker_base, marker_extension) =
        decoded_history(data_dir, MARKER_INTERLEAVING_CONVERSATION)?;
    assert_decoded_source_census(&main_base, &main_extension)?;
    assert_decoded_source_census(&marker_base, &marker_extension)?;
    assert!(main_base.iter().any(|(sequence, row)| {
        *sequence == 0 && matches!(row, StoredOperation::Genesis { .. })
    }));
    assert!(main_base.iter().any(|(sequence, row)| {
        *sequence == 1 && matches!(row, StoredOperation::Enrolled { .. })
    }));
    assert!(main_base.iter().any(|(_, row)| matches!(
        row,
        StoredOperation::Attached { allocation, .. }
            if allocation.superseded_terminal_seq.is_none()
    )));
    assert!(main_base.iter().any(|(_, row)| matches!(
        row,
        StoredOperation::Attached { allocation, .. }
            if allocation.superseded_terminal_seq.is_some()
    )));
    assert!(
        marker_base
            .iter()
            .any(|(_, row)| matches!(row, StoredOperation::MarkerDrained { .. }))
    );
    let marker_ack_position = marker_extension
        .iter()
        .position(|(_, row)| matches!(row, OutboxRow::MarkerAckCommitted(_)))
        .ok_or("decoded MarkerAckCommitted interleaving was absent")?;
    assert!(
        marker_extension[..marker_ack_position]
            .iter()
            .any(|(_, row)| matches!(row, OutboxRow::Produced(_)))
    );
    assert!(
        marker_extension[marker_ack_position + 1..]
            .iter()
            .any(|(_, row)| matches!(row, OutboxRow::Produced(_)))
    );
    let main = expected_live_deliveries(
        ALL_SHAPES_CONVERSATION,
        replay_recipient.participant_id,
        &main_extension,
    );
    let marker = expected_live_deliveries(
        MARKER_INTERLEAVING_CONVERSATION,
        marker_a.participant_id,
        &marker_extension,
    );
    assert!(!main.is_empty());
    assert!(!marker.is_empty());
    Ok(ExpectedDeliveries { main, marker })
}

fn replay_expected_deliveries(
    data_dir: &Path,
    config: ParticipantConfig,
    replay_recipient: ColdMember,
    marker_a: ColdMember,
    expected: ExpectedDeliveries,
) -> Result<(), Box<dyn Error>> {
    let mut reopened = SocketFixture::start_replay_gated_with_config(data_dir, config)?;
    let main_attach =
        reopened.request(ClientRequest::CredentialAttach(CredentialAttachRequest {
            conversation_id: ALL_SHAPES_CONVERSATION,
            participant_id: replay_recipient.participant_id,
            capability_generation: replay_recipient.generation,
            attach_secret: replay_recipient.secret,
            attach_attempt_token: AttachAttemptToken::new([0x3A; 16]),
            accept_marker_delivery_seq: None,
        }))?;
    assert!(matches!(main_attach, ServerValue::AttachBound(_)));
    let mut marker_replay = reopened.spawn_peer()?;
    let marker_attach =
        marker_replay.request(ClientRequest::CredentialAttach(CredentialAttachRequest {
            conversation_id: MARKER_INTERLEAVING_CONVERSATION,
            participant_id: marker_a.participant_id,
            capability_generation: marker_a.generation,
            attach_secret: marker_a.secret,
            attach_attempt_token: AttachAttemptToken::new([0x3B; 16]),
            accept_marker_delivery_seq: None,
        }))?;
    assert!(matches!(marker_attach, ServerValue::AttachBound(_)));
    assert!(reopened.blocked_publication_scans()? > 0);
    reopened.open_publication_replay()?;
    let mut replay_wake = reopened.spawn_peer()?;
    let _ = replay_wake.request(ClientRequest::RecordAdmission(RecordAdmission {
        conversation_id: ALL_SHAPES_CONVERSATION,
        participant_id: u64::MAX,
        capability_generation: Generation::ONE,
        record_admission_attempt_token: RecordAdmissionAttemptToken::new([0x3D; 16]),
        payload: Vec::new(),
    }))?;
    for (index, expected_delivery) in expected.main.into_iter().enumerate() {
        let delivered = reopened.read_push().map_err(|error| {
            format!(
                "main cold replay stopped before decoded obligation {index} at sequence {}: {error}",
                expected_delivery.delivery_seq
            )
        })?;
        assert_eq!(
            delivered,
            ServerPush::ParticipantDelivery(expected_delivery)
        );
    }
    let _ = marker_replay.request(ClientRequest::RecordAdmission(RecordAdmission {
        conversation_id: MARKER_INTERLEAVING_CONVERSATION,
        participant_id: u64::MAX,
        capability_generation: Generation::ONE,
        record_admission_attempt_token: RecordAdmissionAttemptToken::new([0x3E; 16]),
        payload: Vec::new(),
    }))?;
    for (index, expected_delivery) in expected.marker.into_iter().enumerate() {
        let delivered = marker_replay.read_push().map_err(|error| {
            format!(
                "marker cold replay stopped before decoded obligation {index} at sequence {}: {error}",
                expected_delivery.delivery_seq
            )
        })?;
        assert_eq!(
            delivered,
            ServerPush::ParticipantDelivery(expected_delivery)
        );
    }
    reopened.stop();
    Ok(())
}

#[test]
fn cold_reopen_reconciles_and_replays_all_record_shapes() -> Result<(), Box<dyn Error>> {
    let home = tempfile::tempdir()?;
    let data_dir = home.path().join("durability");
    let config = marker_fixture_config();
    let mut first = SocketFixture::start_replay_gated_with_config(&data_dir, config)?;
    let mut second = first.spawn_peer()?;
    let mut observer = first.spawn_peer()?;
    let mut transient = first.spawn_peer()?;

    let (primary, actor, replay_recipient) =
        enroll_main_members(&mut first, &mut second, &mut observer, &mut transient)?;
    commit_main_shapes(&mut first, &mut second, primary, actor)?;
    let (marker_a, marker_b, latest_record) =
        fill_marker_history(&mut first, &mut second, &mut transient)?;
    finish_marker_history(&mut first, &mut second, marker_a, marker_b, latest_record)?;

    drop(second);
    drop(observer);
    drop(transient);
    first.stop();

    let expected = decoded_expectations(&data_dir, replay_recipient, marker_a)?;
    replay_expected_deliveries(&data_dir, config, replay_recipient, marker_a, expected)
}