liminal-server 0.5.3

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
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
//! Participant publication and semantic request entry points.

use std::collections::BTreeSet;
use std::sync::Arc;

use liminal_protocol::lifecycle::{
    BindingState, FrontierBinding, ObligationDebtDispatchDecision, decide_obligation_debt_dispatch,
};
use liminal_protocol::wire::{
    BindingEpoch, ClientRequest, ConnectionIncarnation, ConversationId, ObserverRecoveryHandshake,
    ParticipantId, ParticipantRecord, ServerValue,
};

use crate::server::participant::{
    ConnectionFateWorkItem, ObserverPublicationTarget, ParticipantConnectionContext,
    ParticipantConnectionConversations, ParticipantConnectionFateOutcome,
    ParticipantOfferedProgress, ParticipantPublication, ParticipantSemanticError,
    ParticipantSemanticHandler, ParticipantSemanticOutcome, ParticipantServiceFatal,
    dispatch_impact::DispatchImpactAccumulator,
};

use super::barrier::{ArmOutcome, OperationFacts};
use super::handler::ProductionParticipantHandler;
use super::outbox_log::OutboxLog;
use super::state::{ConversationAuthority, DurableAppend, StateError};

impl ProductionParticipantHandler {
    /// Runs one conversation-scoped operation with one lossless request impact
    /// accumulator under the conversation lock, then applies its tracking effect.
    fn conversation_operation_with_impact(
        &self,
        conversation_id: ConversationId,
        conversations: &mut ParticipantConnectionConversations,
        operation: impl FnOnce(
            &mut ConversationAuthority,
            &dyn DurableAppend,
            &mut DispatchImpactAccumulator,
        ) -> Result<ArmOutcome, StateError>,
    ) -> ParticipantSemanticOutcome<ServerValue> {
        let mut impact = DispatchImpactAccumulator::new();
        // Board #14's funnel, and its only exit. A Class B refusal — one the
        // frozen R-D1 register admits and the client is entitled to hear —
        // is raised deep in a transition that has no response path of its
        // own, and would otherwise collapse into
        // `ParticipantSemanticError::Internal`, then `ParticipantDispatch::Fatal`,
        // then a bare close the client is never told anything by. Here it
        // rejoins the ordinary response path, so a lawful refusal is
        // indistinguishable — in behaviour and in durable effect — from every
        // refusal on the same arm that was already correct.
        //
        // Placed in this ONE wrapper rather than per arm deliberately: the
        // analysis in docs/design/ATTACH-SILENCE-14.md is that the wire half
        // of #14 is one decision at one place plus a classification of which
        // sites may reach it, and every semantic arm routes through here.
        //
        // â›” The `Ok` retains the conversation owner instead of discarding it,
        // which is exactly why `PresentedRefusal`'s doc forbids raising one
        // after any authority has been consumed.
        let result = self.with_conversation_impact(
            conversation_id,
            &mut impact,
            |authority, appender, impact| match operation(authority, appender, impact) {
                Err(StateError::PresentedRefusal(refusal)) => {
                    Ok(ArmOutcome::respond(refusal.into_server_value()))
                }
                other => other,
            },
        );
        let result = result.map(|outcome| {
            if outcome.newly_tracked {
                conversations.track(conversation_id);
            }
            outcome.value
        });
        ParticipantSemanticOutcome::new(result, impact.finish(conversation_id))
    }

    fn conversation_operation_with_facts(
        &self,
        context: ParticipantConnectionContext,
        conversation_id: ConversationId,
        conversations: &mut ParticipantConnectionConversations,
        operation: impl FnOnce(
            &mut ConversationAuthority,
            &OperationFacts,
            &dyn DurableAppend,
            &mut DispatchImpactAccumulator,
        ) -> Result<ArmOutcome, StateError>,
    ) -> ParticipantSemanticOutcome<ServerValue> {
        let operation_facts = match self.operation_facts(context, conversation_id, conversations) {
            Ok(facts) => facts,
            Err(error) => return ParticipantSemanticOutcome::unchanged(Err(error)),
        };
        self.conversation_operation_with_impact(
            conversation_id,
            conversations,
            |authority, appender, impact| operation(authority, &operation_facts, appender, impact),
        )
    }

    fn handle_request_with_impact(
        &self,
        context: ParticipantConnectionContext,
        conversations: &mut ParticipantConnectionConversations,
        request: ClientRequest,
    ) -> ParticipantSemanticOutcome<ServerValue> {
        if let Err(error) = self.ensure_service_live() {
            return ParticipantSemanticOutcome::unchanged(Err(error));
        }
        match request {
            ClientRequest::Enrollment(request) => self.conversation_operation_with_facts(
                context,
                request.conversation_id,
                conversations,
                |authority, operation_facts, appender, impact| {
                    authority.apply_enrollment_with_impact(
                        &request,
                        operation_facts,
                        &self.capacity,
                        &self.config,
                        appender,
                        impact,
                    )
                },
            ),
            ClientRequest::CredentialAttach(request) => self.conversation_operation_with_facts(
                context,
                request.conversation_id,
                conversations,
                |authority, operation_facts, appender, impact| {
                    authority.apply_credential_attach_with_impact(
                        &request,
                        operation_facts,
                        &self.capacity,
                        self.store.clone(),
                        appender,
                        impact,
                    )
                },
            ),
            ClientRequest::Detach(request) => self.conversation_operation_with_facts(
                context,
                request.conversation_id,
                conversations,
                |authority, operation_facts, appender, impact| {
                    authority.apply_detach_with_impact(&request, operation_facts, appender, impact)
                },
            ),
            ClientRequest::ParticipantAck(request) => self.conversation_operation_with_facts(
                context,
                request.conversation_id,
                conversations,
                |authority, operation_facts, appender, impact| {
                    authority.apply_ack_with_impact(&request, operation_facts, appender, impact)
                },
            ),
            ClientRequest::MarkerAck(request) => {
                let outbox_log = OutboxLog::new(Arc::clone(&self.store), request.conversation_id);
                self.conversation_operation_with_facts(
                    context,
                    request.conversation_id,
                    conversations,
                    |authority, operation_facts, _appender, impact| {
                        authority.apply_marker_ack_with_impact(
                            &request,
                            operation_facts,
                            &outbox_log,
                            impact,
                        )
                    },
                )
            }
            ClientRequest::Leave(request) => self.conversation_operation_with_facts(
                context,
                request.conversation_id,
                conversations,
                |authority, operation_facts, appender, impact| {
                    authority.apply_leave_with_impact(&request, operation_facts, appender, impact)
                },
            ),
            ClientRequest::RecordAdmission(request) => self.conversation_operation_with_facts(
                context,
                request.conversation_id,
                conversations,
                |authority, operation_facts, appender, impact| {
                    authority.apply_record_admission_with_impact(
                        &request,
                        operation_facts,
                        &self.config,
                        appender,
                        impact,
                    )
                },
            ),
            ClientRequest::ObserverRecovery(request) => ParticipantSemanticOutcome::unchanged(
                self.apply_observer_recovery(context, conversations, &request, None),
            ),
        }
    }
}

impl ParticipantSemanticHandler for ProductionParticipantHandler {
    fn service_fatal(&self) -> Result<Option<ParticipantServiceFatal>, ParticipantSemanticError> {
        self.current_service_fatal()
    }

    fn latch_connection_fate_intent_incomplete(
        &self,
        open_sequence: u64,
        conversation_id: ConversationId,
    ) -> Result<ParticipantServiceFatal, ParticipantSemanticError> {
        self.latch_connection_fate_fatal(open_sequence, conversation_id)
    }

    fn handle_connection_fate(
        &self,
        work_item: ConnectionFateWorkItem,
    ) -> Result<(), ParticipantSemanticError> {
        self.apply_connection_fate_with_impacts(&work_item)
            .into_result()
    }

    fn handle_connection_fate_with_impact(
        &self,
        work_item: ConnectionFateWorkItem,
    ) -> ParticipantConnectionFateOutcome {
        self.apply_connection_fate_with_impacts(&work_item)
    }

    fn repair_unclean_server_restart(
        &self,
        current_server_incarnation: u64,
    ) -> Result<(), ParticipantSemanticError> {
        self.ensure_service_live()?;
        for conversation_id in self.registered_conversation_ids()? {
            self.with_conversation_fate_source(
                conversation_id,
                None,
                |authority, appender, impact| {
                    if impact.is_some() {
                        return Err(StateError::invariant(
                            "startup connection-fate repair gained a dispatch impact owner",
                        ));
                    }
                    let transaction = authority
                        .prepare_unclean_server_restart_transaction(current_server_incarnation)?;
                    transaction.complete(authority, appender)
                },
            )?;
        }
        Ok(())
    }

    fn connection_has_bound_participant(
        &self,
        connection_incarnation: ConnectionIncarnation,
        conversations: &[ConversationId],
    ) -> Result<bool, ParticipantSemanticError> {
        self.ensure_service_live()?;
        for conversation_id in conversations {
            let cell = self.cell(*conversation_id)?;
            let owner = cell
                .lock()
                .map_err(|_| publication_owner_poisoned(*conversation_id))?;
            let Some(authority) = owner.as_ref() else {
                drop(owner);
                continue;
            };
            let bound = authority.slots.values().any(|slot| {
                matches!(
                    slot.binding,
                    BindingState::Bound(active)
                        if active.binding_epoch.connection_incarnation == connection_incarnation
                )
            });
            drop(owner);
            if bound {
                return Ok(true);
            }
        }
        Ok(false)
    }

    fn publication_conversation_limit(&self) -> u64 {
        self.config.max_semantic_conversations_per_connection
    }

    fn ready_connection_incarnations(
        &self,
        conversation_id: ConversationId,
    ) -> Result<Vec<ConnectionIncarnation>, ParticipantSemanticError> {
        self.ensure_service_live()?;
        let cell = self.cell(conversation_id)?;
        let owner = cell
            .lock()
            .map_err(|_| publication_owner_poisoned(conversation_id))?;
        let Some(authority) = owner.as_ref() else {
            return Ok(Vec::new());
        };
        let Some(outbox) = authority.outbox.as_ref() else {
            return Err(publication_owner_missing(conversation_id));
        };
        let mut incarnations = BTreeSet::new();
        for participant_id in outbox.live_recipients() {
            let Some(slot) = authority.slots.get(&participant_id) else {
                continue;
            };
            if let BindingState::Bound(active) = &slot.binding {
                incarnations.insert(active.binding_epoch.connection_incarnation);
            }
        }
        let incarnations = incarnations.into_iter().collect();
        drop(owner);
        Ok(incarnations)
    }

    fn next_publication(
        &self,
        connection_incarnation: ConnectionIncarnation,
        conversation_id: ConversationId,
        offered: Option<ParticipantOfferedProgress>,
    ) -> Result<Option<ParticipantPublication>, ParticipantSemanticError> {
        self.ensure_service_live()?;
        #[cfg(test)]
        self.obligation_dispatch_work
            .selector_calls
            .fetch_add(1, std::sync::atomic::Ordering::SeqCst);
        let cell = self.cell(conversation_id)?;
        #[cfg(test)]
        self.obligation_dispatch_work
            .authority_lock_acquisitions
            .fetch_add(1, std::sync::atomic::Ordering::SeqCst);
        let owner = cell
            .lock()
            .map_err(|_| publication_owner_poisoned(conversation_id))?;
        let Some(authority) = owner.as_ref() else {
            return Ok(None);
        };
        let bound = authority.slots.iter().find_map(|(participant_id, slot)| {
            let BindingState::Bound(active) = &slot.binding else {
                return None;
            };
            (active.binding_epoch.connection_incarnation == connection_incarnation)
                .then_some((*participant_id, active.binding_epoch))
        });
        let Some((participant_id, binding_epoch)) = bound else {
            return Ok(None);
        };
        let Some(outbox) = authority.outbox.as_ref() else {
            return Err(publication_owner_missing(conversation_id));
        };
        let Some(dispatch_state) = authority.obligation_debt_dispatch() else {
            return Err(publication_owner_missing(conversation_id));
        };
        let Some((FrontierBinding::Bound(protocol_epoch), protocol_cursor)) =
            dispatch_state.frontier_participant(participant_id)
        else {
            return Err(dispatch_invariant(
                "current binding is absent from protocol authority",
            ));
        };
        if protocol_epoch != binding_epoch {
            return Err(dispatch_invariant(
                "server binding differs from protocol authority",
            ));
        }
        let offered_cursor = offered
            .filter(|progress| progress.binding_epoch == binding_epoch)
            .map(|progress| progress.through_seq);
        let dispatch_after = outbox
            .dispatch_after(participant_id, protocol_cursor, offered_cursor)
            .map_err(|error| {
                dispatch_invariant(format!("cursor reconciliation failed: {error}"))
            })?;
        let decision = decide_obligation_debt_dispatch(
            dispatch_state,
            participant_id,
            binding_epoch,
            dispatch_after,
            |participant_id, binding_epoch, dispatch_after| {
                #[cfg(test)]
                self.obligation_dispatch_work
                    .outbox_delivery_probes
                    .fetch_add(1, std::sync::atomic::Ordering::SeqCst);
                outbox
                    .delivery_after(participant_id, dispatch_after)
                    .map(|delivery| {
                        #[cfg(test)]
                        self.obligation_dispatch_work
                            .publication_allocations
                            .fetch_add(1, std::sync::atomic::Ordering::SeqCst);
                        (
                            delivery.delivery_seq,
                            ParticipantPublication {
                                participant_id,
                                binding_epoch,
                                delivery,
                            },
                        )
                    })
            },
        );
        let publication = match decision {
            ObligationDebtDispatchDecision::Permit(publication) => Some(publication),
            ObligationDebtDispatchDecision::Defer(_) => None,
            ObligationDebtDispatchDecision::Invariant(invariant) => {
                return Err(ParticipantSemanticError::Internal {
                    message: format!("obligation-debt dispatch invariant: {invariant:?}"),
                });
            }
        };
        drop(owner);
        Ok(publication)
    }

    fn publication_binding_is_current(
        &self,
        conversation_id: ConversationId,
        participant_id: ParticipantId,
        binding_epoch: BindingEpoch,
    ) -> Result<bool, ParticipantSemanticError> {
        self.ensure_service_live()?;
        let cell = self.cell(conversation_id)?;
        let owner = cell
            .lock()
            .map_err(|_| publication_owner_poisoned(conversation_id))?;
        let Some(authority) = owner.as_ref() else {
            return Ok(false);
        };
        let current = authority.slots.get(&participant_id).is_some_and(|slot| {
            matches!(
                &slot.binding,
                BindingState::Bound(active) if active.binding_epoch == binding_epoch
            )
        });
        drop(owner);
        Ok(current)
    }

    fn publication_is_current(
        &self,
        publication: &ParticipantPublication,
        offered: Option<ParticipantOfferedProgress>,
    ) -> Result<bool, ParticipantSemanticError> {
        let selected = self.next_publication(
            publication.binding_epoch.connection_incarnation,
            publication.conversation_id(),
            offered,
        )?;
        Ok(selected.as_ref() == Some(publication))
    }

    fn record_publication_offer(
        &self,
        publication: &ParticipantPublication,
    ) -> Result<(), ParticipantSemanticError> {
        self.ensure_service_live()?;
        if !matches!(
            publication.delivery.record,
            ParticipantRecord::HistoryCompacted { .. }
        ) {
            return Ok(());
        }
        let conversation_id = publication.conversation_id();
        let cell = self.cell(conversation_id)?;
        let mut owner = cell
            .lock()
            .map_err(|_| publication_owner_poisoned(conversation_id))?;
        let Some(authority) = owner.as_mut() else {
            return Err(publication_owner_missing(conversation_id));
        };
        let current = authority
            .slots
            .get(&publication.participant_id)
            .is_some_and(|slot| {
                matches!(
                    &slot.binding,
                    BindingState::Bound(active)
                        if active.binding_epoch == publication.binding_epoch
                )
            });
        let obligation = authority.outbox.as_ref().is_some_and(|outbox| {
            outbox.is_marker_obligation(publication.participant_id, publication.delivery_seq())
        });
        if !current || !obligation {
            return Err(ParticipantSemanticError::Internal {
                message: format!(
                    "participant marker offer lost its exact current binding or durable obligation for conversation {conversation_id}"
                ),
            });
        }
        authority.offered_markers.insert(
            (publication.participant_id, publication.delivery_seq()),
            publication.binding_epoch,
        );
        drop(owner);
        Ok(())
    }

    fn handle_observer_recovery(
        &self,
        context: ParticipantConnectionContext,
        conversations: &mut ParticipantConnectionConversations,
        request: ObserverRecoveryHandshake,
        target: Option<ObserverPublicationTarget>,
    ) -> Result<ServerValue, ParticipantSemanticError> {
        self.ensure_service_live()?;
        self.apply_observer_recovery(context, conversations, &request, target.as_ref())
    }

    fn handle_with_impact(
        &self,
        context: ParticipantConnectionContext,
        conversations: &mut ParticipantConnectionConversations,
        request: ClientRequest,
    ) -> ParticipantSemanticOutcome<ServerValue> {
        self.handle_request_with_impact(context, conversations, request)
    }

    fn handle(
        &self,
        context: ParticipantConnectionContext,
        conversations: &mut ParticipantConnectionConversations,
        request: ClientRequest,
    ) -> Result<ServerValue, ParticipantSemanticError> {
        self.handle_request_with_impact(context, conversations, request)
            .into_result()
    }
}

fn publication_owner_poisoned(conversation_id: ConversationId) -> ParticipantSemanticError {
    ParticipantSemanticError::Internal {
        message: format!(
            "participant conversation {conversation_id} owner lock is poisoned during publication"
        ),
    }
}

fn dispatch_invariant(message: impl Into<String>) -> ParticipantSemanticError {
    ParticipantSemanticError::Internal {
        message: format!("obligation-debt dispatch invariant: {}", message.into()),
    }
}

fn publication_owner_missing(conversation_id: ConversationId) -> ParticipantSemanticError {
    ParticipantSemanticError::Internal {
        message: format!(
            "participant conversation {conversation_id} publication owner is unavailable"
        ),
    }
}