liminal-server 0.4.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
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
use std::error::Error;
use std::sync::Arc;

use liminal::durability::{bridge::block_on, open_ephemeral};
use liminal_protocol::lifecycle::BindingState;
use liminal_protocol::lifecycle::test_support_external::executable_recovered_attach;
use liminal_protocol::wire::{
    AttachAttemptToken, BindingEpoch, ClientRequest, ConnectionIncarnation,
    CredentialAttachRequest, DeliverySeq, DetachAttemptToken, DetachRequest, EnrollmentRequest,
    EnrollmentToken, Generation, ParticipantId, ServerValue,
};

use crate::server::participant::{
    ConnectionFateClass, ConnectionFateWorkItem, ParticipantConnectionConversations,
    ParticipantSemanticHandler,
};

use super::ProductionParticipantHandler;
use super::log::{
    DecodedStoredOperation, OperationLog, OperationLogError, StoredDetached, StoredDetachedCause,
    StoredDetachedSource, StoredOperation, StoredOrdinaryTerminalSource,
    StoredRecoveredPresentation, StoredSpecificFateIntent, StoredTerminalDisposition,
};
use super::state::{DurableAppend, PendingBindingFate};
use super::tests::{dispatch_tracked, test_participant_config};

struct FixtureAppender<'a> {
    log: &'a OperationLog,
}

impl DurableAppend for FixtureAppender<'_> {
    fn append(
        &self,
        operation: &StoredOperation,
        expected_sequence: u64,
    ) -> Result<(), OperationLogError> {
        block_on(self.log.append(operation, expected_sequence))?
    }
}

#[derive(Clone, Copy)]
struct OrdinaryCompletionExpectation {
    conversation_id: u64,
    participant_id: ParticipantId,
    attached_epoch: BindingEpoch,
    attached_source_sequence: u64,
    died_source_sequence: u64,
    observer_before: DeliverySeq,
}

#[derive(Clone, Copy)]
struct RecoveredCompletionExpectation {
    conversation_id: u64,
    participant_id: ParticipantId,
    attached_source_sequence: u64,
    died_source_sequence: u64,
    recovered_source_sequence: u64,
    prior_binding_epoch: BindingEpoch,
    marker_delivery_seq: DeliverySeq,
    observer_before: DeliverySeq,
}

#[test]
fn ordinary_completion_uses_protocol_floor_and_exact_production_caller()
-> Result<(), Box<dyn Error>> {
    run_ordinary_completion()
}

#[test]
fn ordinary_source_flush_precedes_observer_advance_and_cold_repair() -> Result<(), Box<dyn Error>> {
    run_ordinary_completion()
}

fn run_ordinary_completion() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(open_ephemeral(1)?);
    let handler = ProductionParticipantHandler::new(store, test_participant_config())?;
    let connection_incarnation = ConnectionIncarnation::new(89, 7);
    let conversation_id = 59;
    let mut conversations = ParticipantConnectionConversations::default();
    let enrolled = dispatch_tracked(
        &handler,
        connection_incarnation,
        &mut conversations,
        ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id,
            enrollment_token: EnrollmentToken::new([61; 16]),
        }),
    )?;
    let ServerValue::EnrollBound(receipt) = enrolled else {
        return Err(format!("enrollment did not bind: {enrolled:?}").into());
    };
    let attached = dispatch_tracked(
        &handler,
        connection_incarnation,
        &mut conversations,
        ClientRequest::CredentialAttach(CredentialAttachRequest {
            conversation_id,
            participant_id: receipt.participant_id(),
            capability_generation: Generation::ONE,
            attach_secret: receipt.attach_secret(),
            attach_attempt_token: AttachAttemptToken::new([67; 16]),
            accept_marker_delivery_seq: None,
        }),
    )?;
    let ServerValue::AttachBound(attached) = attached else {
        return Err(format!("ordinary attach did not bind: {attached:?}").into());
    };

    let cell = handler.cell(conversation_id)?;
    let owner = cell
        .lock()
        .map_err(|_| "fate completion owner lock was poisoned")?;
    let authority = owner
        .as_ref()
        .ok_or("fate completion owner was unavailable")?;
    let attached_source_sequence = authority
        .next_log_sequence
        .checked_sub(1)
        .ok_or("attached source sequence underflow")?;
    let died_source_sequence = authority.next_log_sequence;
    let observer_before = authority.observer_progress;
    let slot = authority
        .slots
        .get(&receipt.participant_id())
        .ok_or("ordinary attached participant slot is absent")?;
    assert!(
        matches!(slot.binding, BindingState::Bound(active) if active.binding_epoch == attached.origin_binding_epoch())
    );
    assert!(slot.binding_fate.is_some());
    drop(owner);

    handler.handle_connection_fate(ConnectionFateWorkItem {
        open_sequence: 23,
        connection_incarnation,
        class: ConnectionFateClass::ConnectionLost,
        tracked_conversations: conversations.tracked_conversations(),
    })?;

    assert_ordinary_completion(
        &handler,
        OrdinaryCompletionExpectation {
            conversation_id,
            participant_id: receipt.participant_id(),
            attached_epoch: attached.origin_binding_epoch(),
            attached_source_sequence,
            died_source_sequence,
            observer_before,
        },
    )
}

#[test]
fn recovered_completion_uses_protocol_floor_and_exact_production_caller()
-> Result<(), Box<dyn Error>> {
    run_recovered_completion()
}

#[test]
fn recovered_source_flush_precedes_observer_advance_and_cold_repair() -> Result<(), Box<dyn Error>>
{
    run_recovered_completion()
}

#[test]
fn pending_detached_restart_restores_disconnect_or_shutdown_without_refinish()
-> Result<(), Box<dyn Error>> {
    let recovered = executable_recovered_attach()?;
    let conversation_id = recovered.member.conversation_id();
    let participant_id = recovered.member.participant_id();
    let connection_incarnation = recovered.recovered_binding_epoch.connection_incarnation;
    let store = Arc::new(open_ephemeral(1)?);
    let handler = ProductionParticipantHandler::new(store, test_participant_config())?;
    let mut conversations = ParticipantConnectionConversations::default();
    let enrolled = dispatch_tracked(
        &handler,
        connection_incarnation,
        &mut conversations,
        ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id,
            enrollment_token: EnrollmentToken::new([73; 16]),
        }),
    )?;
    let ServerValue::EnrollBound(receipt) = enrolled else {
        return Err(format!("pending Detached fixture did not enroll: {enrolled:?}").into());
    };
    assert_eq!(receipt.participant_id(), participant_id);

    let cell = handler.cell(conversation_id)?;
    let mut owner = cell
        .lock()
        .map_err(|_| "pending Detached owner lock was poisoned")?;
    let authority = owner
        .as_mut()
        .ok_or("pending Detached owner was unavailable")?;
    authority.replace_frontier_for_test(recovered.owner)?;
    authority.next_seq = recovered.next_terminal_sequence;
    authority.next_order = recovered.next_terminal_order;
    let slot = authority
        .slots
        .get_mut(&participant_id)
        .ok_or("pending Detached participant slot is absent")?;
    slot.member = recovered.member;
    slot.binding = recovered.binding;
    slot.cell = recovered.detach_cell;
    slot.binding_fate = Some(PendingBindingFate {
        attached_source_sequence: authority
            .next_log_sequence
            .checked_sub(1)
            .ok_or("pending Detached attached source underflow")?,
        token: recovered.fate_token,
    });
    let request = DetachRequest {
        conversation_id,
        participant_id,
        capability_generation: recovered.recovered_binding_epoch.capability_generation,
        detach_attempt_token: DetachAttemptToken::new([79; 16]),
    };
    let sequence = authority.next_log_sequence;
    let terminal_order = authority.next_order;
    let observer_baseline = authority.observer_progress;
    let row = StoredDetached {
        participant_id,
        binding_epoch: recovered.recovered_binding_epoch.into(),
        cause: StoredDetachedCause::CleanDeregister,
        terminal_order,
        disposition: StoredTerminalDisposition::Pending,
        source: StoredDetachedSource::ExplicitRequestPending {
            request: (&request).into(),
            secret_verified: true,
            verifier: super::facts::detach_request_verifier(&request),
            receiving_epoch: recovered.recovered_binding_epoch.into(),
            observer_baseline,
        },
    };
    authority.replay_explicit_pending_detached(&row, sequence)?;
    let restored = &authority.slots[&participant_id];
    assert!(matches!(
        restored.binding,
        BindingState::PendingFinalization(_)
    ));
    assert!(matches!(
        restored.cell,
        liminal_protocol::lifecycle::DetachCell::Pending(_)
    ));
    assert_eq!(authority.observer_progress, observer_baseline);
    assert_eq!(
        authority.next_log_sequence,
        sequence.checked_add(1).ok_or("log overflow")?
    );
    assert_eq!(
        authority.next_order,
        terminal_order.checked_add(1).ok_or("order overflow")?
    );
    drop(owner);
    Ok(())
}

pub(super) fn run_recovered_completion() -> Result<(), Box<dyn Error>> {
    let recovered = executable_recovered_attach()?;
    let conversation_id = recovered.member.conversation_id();
    let participant_id = recovered.member.participant_id();
    let connection_incarnation = recovered.recovered_binding_epoch.connection_incarnation;
    let store = Arc::new(open_ephemeral(1)?);
    let handler = ProductionParticipantHandler::new(store, test_participant_config())?;
    let mut conversations = ParticipantConnectionConversations::default();
    let enrolled = dispatch_tracked(
        &handler,
        connection_incarnation,
        &mut conversations,
        ClientRequest::Enrollment(EnrollmentRequest {
            conversation_id,
            enrollment_token: EnrollmentToken::new([71; 16]),
        }),
    )?;
    let ServerValue::EnrollBound(receipt) = enrolled else {
        return Err(format!("recovered fixture enrollment did not bind: {enrolled:?}").into());
    };
    assert_eq!(receipt.participant_id(), participant_id);

    let cell = handler.cell(conversation_id)?;
    let mut owner = cell
        .lock()
        .map_err(|_| "recovered completion owner lock was poisoned")?;
    let authority = owner
        .as_mut()
        .ok_or("recovered completion owner was unavailable")?;
    let attached_source_sequence = authority
        .next_log_sequence
        .checked_sub(1)
        .ok_or("recovered attached source sequence underflow")?;
    let died_source_sequence = authority.next_log_sequence;
    let recovered_source_sequence = died_source_sequence
        .checked_add(1)
        .ok_or("recovered source sequence overflow")?;
    let observer_before = authority.observer_progress;
    authority.replace_frontier_for_test(recovered.owner)?;
    authority.next_seq = recovered.next_terminal_sequence;
    authority.next_order = recovered.next_terminal_order;
    let slot = authority
        .slots
        .get_mut(&participant_id)
        .ok_or("recovered participant slot is absent")?;
    slot.member = recovered.member;
    slot.binding = recovered.binding;
    slot.cell = recovered.detach_cell;
    slot.binding_fate = Some(PendingBindingFate {
        attached_source_sequence,
        token: recovered.fate_token,
    });
    assert!(
        matches!(slot.binding, BindingState::Bound(active) if active.binding_epoch == recovered.recovered_binding_epoch)
    );
    let work_item = ConnectionFateWorkItem {
        open_sequence: 29,
        connection_incarnation,
        class: ConnectionFateClass::ConnectionLost,
        tracked_conversations: conversations.tracked_conversations(),
    };
    let log = OperationLog::new(Arc::clone(&handler.store), conversation_id);
    let appender = FixtureAppender { log: &log };
    let transaction = authority.prepare_connection_fate_transaction(&work_item);
    transaction.complete(authority, &appender)?;
    drop(owner);
    assert_recovered_completion(
        &handler,
        &log,
        RecoveredCompletionExpectation {
            conversation_id,
            participant_id,
            attached_source_sequence,
            died_source_sequence,
            recovered_source_sequence,
            prior_binding_epoch: recovered.prior_binding_epoch,
            marker_delivery_seq: recovered.marker_delivery_seq,
            observer_before,
        },
    )
}

fn assert_recovered_completion(
    handler: &ProductionParticipantHandler,
    log: &OperationLog,
    expected: RecoveredCompletionExpectation,
) -> Result<(), Box<dyn Error>> {
    let Some(died) = block_on(log.read_at(expected.died_source_sequence))?? else {
        return Err("recovered Died source row is absent".into());
    };
    let DecodedStoredOperation::V3(StoredOperation::Died { row: died }) = died.operation else {
        return Err("recovered fixture expected Died source row".into());
    };
    assert!(matches!(
        died.specific_fate_intent,
        Some(StoredSpecificFateIntent::Recovered {
            attached_source_sequence: source,
            prior_binding_epoch,
            marker_delivery_seq,
        }) if source == expected.attached_source_sequence
            && prior_binding_epoch.to_epoch()? == expected.prior_binding_epoch
            && marker_delivery_seq == expected.marker_delivery_seq
    ));
    let Some(specific) = block_on(log.read_at(expected.recovered_source_sequence))?? else {
        return Err("Recovered completion row is absent".into());
    };
    let DecodedStoredOperation::V3(StoredOperation::Recovered { row, event }) = specific.operation
    else {
        return Err("recovered fixture expected Recovered completion row".into());
    };
    assert_eq!(row.participant_id, expected.participant_id);
    assert_eq!(row.died_source_sequence, expected.died_source_sequence);
    assert_eq!(
        row.fenced_attached_source_sequence,
        expected.attached_source_sequence
    );
    assert_eq!(
        row.prior_binding_epoch.to_epoch()?,
        expected.prior_binding_epoch
    );
    assert_eq!(row.marker_delivery_seq, expected.marker_delivery_seq);
    assert_eq!(
        row.presentation,
        StoredRecoveredPresentation::RecoveredOwnsAndReservesFinalizer
    );
    assert!(row.resulting_floor > expected.observer_before);
    let decoded_event = liminal_protocol::lifecycle::ConversationEvent::decode_canonical(&event)
        .map_err(|error| format!("Recovered canonical event failed to decode: {error:?}"))?;
    assert_eq!(decoded_event.conversation_id(), expected.conversation_id);
    let cell = handler.cell(expected.conversation_id)?;
    let owner = cell
        .lock()
        .map_err(|_| "recovered completion owner lock was poisoned after completion")?;
    let authority = owner
        .as_ref()
        .ok_or("recovered completion owner was unavailable after completion")?;
    let frontier = authority
        .frontier()
        .ok_or("recovered completion did not reinstall its frontier owner")?;
    assert_eq!(
        frontier.frontiers().retained_floor(),
        u128::from(row.resulting_floor)
    );
    assert!(
        authority.slots[&expected.participant_id]
            .binding_fate
            .is_none()
    );
    drop(owner);
    Ok(())
}

fn assert_ordinary_completion(
    handler: &ProductionParticipantHandler,
    expected: OrdinaryCompletionExpectation,
) -> Result<(), Box<dyn Error>> {
    let log = OperationLog::new(Arc::clone(&handler.store), expected.conversation_id);
    let Some(died) = block_on(log.read_at(expected.died_source_sequence))?? else {
        return Err("Died source row is absent".into());
    };
    let DecodedStoredOperation::V3(StoredOperation::Died { row: died }) = died.operation else {
        return Err("expected Died source row".into());
    };
    assert!(matches!(
        died.specific_fate_intent,
        Some(StoredSpecificFateIntent::Ordinary {
            attached_source_sequence: source
        }) if source == expected.attached_source_sequence
    ));

    let ordinary_source_sequence = expected
        .died_source_sequence
        .checked_add(1)
        .ok_or("ordinary source sequence overflow")?;
    let Some(ordinary) = block_on(log.read_at(ordinary_source_sequence))?? else {
        return Err("Ordinary completion row is absent".into());
    };
    let DecodedStoredOperation::V3(StoredOperation::Ordinary { row, event }) = ordinary.operation
    else {
        return Err("expected Ordinary completion row".into());
    };
    assert_eq!(row.participant_id, expected.participant_id);
    assert_eq!(
        row.last_dead_binding_epoch.to_epoch()?,
        expected.attached_epoch
    );
    assert_eq!(
        row.ordinary_attached_source_sequence,
        expected.attached_source_sequence
    );
    assert!(matches!(
        row.terminal_source,
        StoredOrdinaryTerminalSource::DiedCommitted {
            died_source_sequence: source
        } if source == expected.died_source_sequence
    ));
    assert!(row.resulting_floor > expected.observer_before);
    let decoded_event = liminal_protocol::lifecycle::ConversationEvent::decode_canonical(&event)
        .map_err(|error| format!("Ordinary canonical event failed to decode: {error:?}"))?;
    assert_eq!(decoded_event.conversation_id(), expected.conversation_id);

    let cell = handler.cell(expected.conversation_id)?;
    let owner = cell
        .lock()
        .map_err(|_| "fate completion owner lock was poisoned after completion")?;
    let authority = owner
        .as_ref()
        .ok_or("fate completion owner was unavailable after completion")?;
    let slot = authority
        .slots
        .get(&expected.participant_id)
        .ok_or("ordinary participant slot disappeared after completion")?;
    assert!(slot.binding_fate.is_none());
    let frontier = authority
        .frontier()
        .ok_or("measured frontier owner was not installed after completion")?;
    assert_eq!(
        frontier.frontiers().retained_floor(),
        u128::from(row.resulting_floor)
    );
    drop(owner);

    let cold =
        ProductionParticipantHandler::new(Arc::clone(&handler.store), test_participant_config())?;
    let replayed = cold.replay_and_repair(expected.conversation_id, &log)?;
    let replayed_frontier = replayed
        .frontier()
        .ok_or("cold replay omitted the measured frontier owner")?;
    assert_eq!(
        replayed_frontier.frontiers().retained_floor(),
        u128::from(row.resulting_floor)
    );
    Ok(())
}