meerkat-mob 0.8.17

Multi-agent orchestration runtime for Meerkat
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
//! Durable cleanup for ordinary placed `SubmitWork(TurnCompleted)` calls.
//!
//! The caller promise is deliberately absent from this worker.  MobMachine
//! custody survives caller drop, timeout, and controller restart; the sole
//! member-event pump owns terminal folding and ACK confirmation.  The one
//! alternate terminal authority is the authenticated, exact
//! `CancelTrackedMemberInput::Terminal` receipt, whose wire contract carries
//! the retained host record verbatim.

use std::collections::{BTreeMap, BTreeSet};
use std::sync::Arc;

use futures::stream::{FuturesUnordered, StreamExt};
use meerkat_core::time_compat::{Duration, Instant};

use crate::error::MobError;
use crate::event::{MemberRef, PlacedCompletionClosureEvent};
use crate::ids::{AgentIdentity, MobId};
use crate::machines::mob_machine as mob_dsl;
#[cfg(target_arch = "wasm32")]
use crate::tokio;

use super::handle::MobHandle;
use super::provisioner::MobProvisioner;

const SCAN_INTERVAL: Duration = Duration::from_millis(100);
const MAX_SCAN_INTERVAL: Duration = Duration::from_secs(5);
const MAX_CONCURRENT_HOSTS: usize = 8;

#[derive(Debug)]
struct RetryState {
    delay: Duration,
    next_attempt: Instant,
}

#[cfg(test)]
mod tests {
    use super::{MAX_CONCURRENT_HOSTS, mob_dsl, project_placed_completion_scan};

    #[test]
    fn cleanup_host_window_is_bounded() {
        assert_eq!(MAX_CONCURRENT_HOSTS, 8);
    }

    #[test]
    fn scan_projection_returns_both_custody_families() {
        let cancel_requested = mob_dsl::PlacedCompletionObligation {
            agent_identity: mob_dsl::AgentIdentity("cancel-worker".to_string()),
            dispatch_sequence: 1,
            ..Default::default()
        };
        let resolved = mob_dsl::PlacedCompletionObligation {
            agent_identity: mob_dsl::AgentIdentity("resolved-worker".to_string()),
            dispatch_sequence: 2,
            ..Default::default()
        };
        let mut state = mob_dsl::MobMachineState::default();
        state
            .cancel_requested_placed_completion_outcomes
            .insert(cancel_requested.clone());
        state
            .resolved_placed_completion_outcomes
            .insert(resolved.clone());

        let projection = project_placed_completion_scan(&state);
        assert_eq!(projection.cancel_requested, vec![cancel_requested]);
        assert_eq!(projection.resolved, vec![resolved]);
    }
}

impl RetryState {
    fn due(&self, now: Instant) -> bool {
        now >= self.next_attempt
    }

    fn record_attempt(&mut self, now: Instant) {
        self.next_attempt = now + self.delay;
        self.delay = (self.delay * 2).min(MAX_SCAN_INTERVAL);
    }
}

impl Default for RetryState {
    fn default() -> Self {
        Self {
            delay: SCAN_INTERVAL,
            next_attempt: Instant::now(),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum AttemptOutcome {
    /// The exact machine custody row disappeared before the attempt ran.
    Gone,
    /// The pump was poked, but no synchronous semantic transition occurred.
    Poked,
    /// CancelTrackedInput produced and committed an exact terminal transition.
    Progress,
}

struct ScanSummary {
    live: usize,
    progress: usize,
    next_retry_after: Option<Duration>,
}

/// Small owned scan input projected under one machine-state watch borrow.
///
/// §12.3 compatibility contract: this projection returns owned work rows,
/// never `&state`, never a full-state clone, and never a state-exposing
/// closure, so it stays compatible with the durable-jobs execution-activity
/// projection family expected to join it on `MobHandle`.
pub(super) struct PlacedCompletionScanProjection {
    pub(super) cancel_requested: Vec<mob_dsl::PlacedCompletionObligation>,
    pub(super) resolved: Vec<mob_dsl::PlacedCompletionObligation>,
}

/// Pure projection over the actor-published machine state: both completion
/// custody families this reconciler adopts.
pub(super) fn project_placed_completion_scan(
    state: &mob_dsl::MobMachineState,
) -> PlacedCompletionScanProjection {
    PlacedCompletionScanProjection {
        cancel_requested: state
            .cancel_requested_placed_completion_outcomes
            .iter()
            .cloned()
            .collect(),
        resolved: state
            .resolved_placed_completion_outcomes
            .iter()
            .cloned()
            .collect(),
    }
}

pub(crate) fn obligation_event(
    obligation: &mob_dsl::PlacedCompletionObligation,
) -> Result<crate::event::PlacedCompletionObligationEvent, MobError> {
    let parsed = uuid::Uuid::parse_str(&obligation.input_id.0)
        .map_err(|_| MobError::Internal("placed completion input_id is not a UUID".to_string()))?;
    if parsed.is_nil() || parsed.to_string() != obligation.input_id.0 {
        return Err(MobError::Internal(
            "placed completion input_id must be a canonical non-nil UUID".to_string(),
        ));
    }
    Ok(crate::event::PlacedCompletionObligationEvent {
        agent_identity: AgentIdentity::from(obligation.agent_identity.0.as_str()),
        host_id: obligation.host_id.0.clone(),
        host_binding_generation: obligation.host_binding_generation,
        member_session_id: obligation.member_session_id.0.clone(),
        generation: crate::ids::Generation::new(obligation.generation.0),
        fence_token: crate::ids::FenceToken::new(obligation.fence_token.0),
        dispatch_sequence: obligation.dispatch_sequence,
        input_id: obligation.input_id.0.clone(),
    })
}

pub(crate) fn obligation_from_event(
    event: &crate::event::PlacedCompletionObligationEvent,
) -> Result<mob_dsl::PlacedCompletionObligation, MobError> {
    let parsed = uuid::Uuid::parse_str(&event.input_id).map_err(|_| {
        MobError::InvalidPlacedInteractionId {
            interaction_id: event.input_id.clone(),
        }
    })?;
    if parsed.is_nil() || parsed.to_string() != event.input_id || event.dispatch_sequence == 0 {
        return Err(MobError::InvalidPlacedInteractionId {
            interaction_id: event.input_id.clone(),
        });
    }
    Ok(mob_dsl::PlacedCompletionObligation {
        agent_identity: mob_dsl::AgentIdentity::from_domain(&event.agent_identity),
        host_id: mob_dsl::HostId(event.host_id.clone()),
        host_binding_generation: event.host_binding_generation,
        member_session_id: mob_dsl::SessionId(event.member_session_id.clone()),
        generation: mob_dsl::Generation(event.generation.get()),
        fence_token: mob_dsl::FenceToken(event.fence_token.get()),
        dispatch_sequence: event.dispatch_sequence,
        input_id: mob_dsl::InputId(event.input_id.clone()),
    })
}

fn exact_route_is_current(
    state: &mob_dsl::MobMachineState,
    obligation: &mob_dsl::PlacedCompletionObligation,
) -> bool {
    let identity = &obligation.agent_identity;
    let host = &obligation.host_id;
    state.member_placement.get(identity) == Some(host)
        && state
            .current_placed_spawn_host_binding_generations
            .get(identity)
            == Some(&obligation.host_binding_generation)
        && state.host_binding_generations.get(host) == Some(&obligation.host_binding_generation)
        && state.member_session_bindings.get(identity) == Some(&obligation.member_session_id)
        && state.identity_runtime_generations.get(identity) == Some(&obligation.generation)
        && state.identity_runtime_fence_tokens.get(identity) == Some(&obligation.fence_token)
        && state.host_durable_sessions.get(host) == Some(&true)
        && state.host_tracked_input_cancel.get(host) == Some(&true)
        && state
            .host_protocol_min
            .get(host)
            .is_some_and(|minimum| *minimum <= 4)
        && state
            .host_protocol_max
            .get(host)
            .is_some_and(|maximum| *maximum >= 4)
}

fn expected_member(
    mob_id: &MobId,
    obligation: &mob_dsl::PlacedCompletionObligation,
) -> super::bridge_protocol::BridgeMemberIncarnation {
    super::bridge_protocol::BridgeMemberIncarnation {
        mob_id: mob_id.to_string(),
        agent_identity: obligation.agent_identity.0.clone(),
        host_id: obligation.host_id.0.clone(),
        binding_generation: obligation.host_binding_generation,
        member_session_id: obligation.member_session_id.0.clone(),
        generation: obligation.generation.0,
        fence_token: obligation.fence_token.0,
    }
}

/// Actor-lifetime adopter for completion cleanup custody.
pub(crate) struct PlacedCompletionReconciler {
    mob_id: MobId,
    handle: MobHandle,
    provisioner: Arc<dyn MobProvisioner>,
}

impl PlacedCompletionReconciler {
    pub(crate) async fn run_owned(
        mob_id: MobId,
        handle: MobHandle,
        provisioner: Arc<dyn MobProvisioner>,
    ) {
        Self {
            mob_id,
            handle,
            provisioner,
        }
        .run()
        .await;
    }

    async fn run(self) {
        let actor_closed = self.handle.command_tx.clone();
        // Wake source: the actor publishes the machine-state watch on EVERY
        // applied input, and both custody families this scan adopts
        // (cancel-requested / resolved outcomes) are pure machine sets, so
        // watch wakes are a superset of work arrival. Host receipts fold back
        // through handle commands -> actor inputs -> publish.
        let mut machine_changes = Some(self.handle.machine_state_changes());
        let mut delay = SCAN_INTERVAL;
        let mut retry = BTreeMap::<mob_dsl::PlacedCompletionObligation, RetryState>::new();
        let mut row_cursor = BTreeMap::<mob_dsl::HostId, u64>::new();
        let mut host_cursor = 0usize;
        // Unconditional first scan: the watch does not fire for the value
        // present at subscribe time, and custody recovered during resume
        // exists at spawn with no subsequent publish.
        let mut deadline = super::ReconcileScanDeadline::first_scan(Instant::now(), SCAN_INTERVAL);
        loop {
            tokio::select! {
                () = actor_closed.closed() => break,
                () = super::wait_for_machine_state_change(&mut machine_changes) => {
                    deadline.pull_earlier(Instant::now(), SCAN_INTERVAL);
                    continue;
                }
                () = tokio::time::sleep(deadline.sleep_duration(Instant::now())) => {},
            }
            match self
                .scan_once(&mut retry, &mut row_cursor, &mut host_cursor)
                .await
            {
                Ok(summary) if summary.live == 0 => {
                    // Quiescent: the machine-state watch owns the wake for
                    // any new custody row; the safety tick only bounds drift
                    // from signals the watch cannot observe.
                    delay = super::RECONCILE_SAFETY_INTERVAL;
                }
                Ok(summary) if summary.progress > 0 => delay = SCAN_INTERVAL,
                Ok(summary) => {
                    delay = summary
                        .next_retry_after
                        .unwrap_or(MAX_SCAN_INTERVAL)
                        .clamp(SCAN_INTERVAL, MAX_SCAN_INTERVAL);
                }
                Err(error) => {
                    tracing::debug!(
                        mob_id = %self.mob_id,
                        error = %error,
                        "placed completion cleanup remains pending"
                    );
                    delay = (delay * 2).min(MAX_SCAN_INTERVAL);
                }
            }
            deadline.rearm(Instant::now(), delay);
        }
    }

    async fn scan_once(
        &self,
        retry: &mut BTreeMap<mob_dsl::PlacedCompletionObligation, RetryState>,
        row_cursor: &mut BTreeMap<mob_dsl::HostId, u64>,
        host_cursor: &mut usize,
    ) -> Result<ScanSummary, MobError> {
        // One borrow-scoped projection instead of cloning the whole
        // (potentially restore-scale) machine state per scan.
        let PlacedCompletionScanProjection {
            cancel_requested: pending,
            resolved,
        } = self
            .handle
            .project_placed_completion_scan_from_current_machine_state();

        let live = pending
            .iter()
            .chain(&resolved)
            .cloned()
            .collect::<BTreeSet<_>>();
        retry.retain(|obligation, _| live.contains(obligation));
        for obligation in &live {
            retry.entry(obligation.clone()).or_default();
        }

        // Every host contributes at most one due row per round. The per-host
        // sequence cursor prevents one permanently blackholed low sequence
        // from monopolizing its siblings, while the global cursor rotates the
        // first host admitted to the bounded concurrency window.
        let mut by_host =
            BTreeMap::<mob_dsl::HostId, Vec<mob_dsl::PlacedCompletionObligation>>::new();
        for obligation in live.iter().cloned() {
            by_host
                .entry(obligation.host_id.clone())
                .or_default()
                .push(obligation);
        }
        for obligations in by_host.values_mut() {
            obligations.sort_by_key(|obligation| obligation.dispatch_sequence);
        }
        row_cursor.retain(|host, _| by_host.contains_key(host));

        let now = Instant::now();
        let mut hosts = by_host.keys().cloned().collect::<Vec<_>>();
        let mut rotation = 0usize;
        if !hosts.is_empty() {
            rotation = *host_cursor % hosts.len();
            hosts.rotate_left(rotation);
        }
        let mut selected = Vec::new();
        let mut last_selected_offset = None;
        for (host_offset, host) in hosts.iter().enumerate() {
            let Some(obligations) = by_host.get(host) else {
                continue;
            };
            let previous = row_cursor.get(host).copied().unwrap_or(0);
            let due = obligations
                .iter()
                .filter(|obligation| retry.get(*obligation).is_some_and(|retry| retry.due(now)))
                .find(|obligation| obligation.dispatch_sequence > previous)
                .or_else(|| {
                    obligations.iter().find(|obligation| {
                        retry.get(*obligation).is_some_and(|retry| retry.due(now))
                    })
                });
            let Some(obligation) = due.cloned() else {
                continue;
            };
            let Some(retry_state) = retry.get_mut(&obligation) else {
                continue;
            };
            retry_state.record_attempt(now);
            row_cursor.insert(host.clone(), obligation.dispatch_sequence);
            selected.push(obligation);
            last_selected_offset = Some(host_offset);
            if selected.len() == MAX_CONCURRENT_HOSTS {
                break;
            }
        }
        if !hosts.is_empty() {
            // Advance past the last host actually admitted, including any
            // skipped not-due hosts. Advancing by one would overlap most of a
            // full window and make a high-index healthy host wait behind each
            // blackholed timeout almost serially.
            *host_cursor =
                super::actor::advance_rotating_cursor(hosts.len(), rotation, last_selected_offset);
        }

        let mut attempts = FuturesUnordered::new();
        for obligation in selected {
            attempts.push(async move {
                let result = self.reconcile_once(&obligation).await;
                (obligation, result)
            });
        }
        let mut progress = 0usize;
        while let Some((obligation, result)) = attempts.next().await {
            match result {
                Ok(AttemptOutcome::Progress) => {
                    progress += 1;
                    retry.remove(&obligation);
                }
                Ok(AttemptOutcome::Gone) => {
                    retry.remove(&obligation);
                }
                Ok(AttemptOutcome::Poked) => {}
                Err(error) => {
                    tracing::debug!(
                        host_id = %obligation.host_id.0,
                        agent_identity = %obligation.agent_identity.0,
                        input_id = %obligation.input_id.0,
                        error = %error,
                        "placed completion reconciliation remains pending and will retry"
                    );
                }
            }
        }

        let now = Instant::now();
        let next_retry_after = retry
            .values()
            .map(|state| state.next_attempt.saturating_duration_since(now))
            .min();
        Ok(ScanSummary {
            live: live.len(),
            progress,
            next_retry_after,
        })
    }

    async fn reconcile_once(
        &self,
        obligation: &mob_dsl::PlacedCompletionObligation,
    ) -> Result<AttemptOutcome, MobError> {
        // Watch-borrow discipline: the guard stays inside this sync block and
        // never crosses an await; the same published value answers all three
        // gates, exactly as the historical full-state clone did.
        let (pending_cancel, resolved, route_current) = {
            let state = self.handle.machine_state_watch_rx.borrow();
            (
                state
                    .cancel_requested_placed_completion_outcomes
                    .contains(obligation),
                state
                    .resolved_placed_completion_outcomes
                    .contains(obligation),
                exact_route_is_current(&state, obligation),
            )
        };
        if !pending_cancel && !resolved {
            return Ok(AttemptOutcome::Gone);
        }
        if !route_current {
            return Err(MobError::Internal(format!(
                "placed completion '{}' retains machine custody without its exact current route",
                obligation.input_id.0
            )));
        }
        let identity = AgentIdentity::from(obligation.agent_identity.0.as_str());
        self.handle.ensure_pump_for_obligation(&identity).await?;
        if resolved {
            // The one sequential pump owns ACK resend and confirmation. A
            // successful ensure is a poke, not semantic progress; backoff is
            // retained until the watch state proves ACK or release disposal.
            return Ok(AttemptOutcome::Poked);
        }
        let Some(entry) = self.handle.roster.read().await.get(&identity).cloned() else {
            return Err(MobError::Internal(format!(
                "placed completion '{}' retains machine custody without a roster entry",
                obligation.input_id.0
            )));
        };
        if entry.generation.get() != obligation.generation.0
            || entry.fence_token.get() != obligation.fence_token.0
        {
            return Err(MobError::Internal(format!(
                "placed completion '{}' roster incarnation is stale",
                obligation.input_id.0
            )));
        }
        let member_ref = match &entry.member_ref {
            MemberRef::BackendPeer {
                session_id: Some(session_id),
                ..
            } if session_id.to_string() != obligation.member_session_id.0 => {
                return Err(MobError::Internal(format!(
                    "placed completion '{}' roster route targets a stale member session",
                    obligation.input_id.0
                )));
            }
            MemberRef::BackendPeer { .. } => entry.member_ref.clone(),
            MemberRef::Session { .. } => {
                return Err(MobError::Internal(
                    "placed completion custody has a local session route".to_string(),
                ));
            }
        };
        let response = self
            .provisioner
            .cancel_tracked_placed_input(
                &member_ref,
                &expected_member(&self.mob_id, obligation),
                &obligation.input_id.0,
            )
            .await?;
        let event = obligation_event(obligation)?;
        match response.outcome {
            super::bridge_protocol::BridgeTrackedInputCancelOutcome::NoEffect => {
                self.handle
                    .close_placed_completion_outcome(
                        event,
                        PlacedCompletionClosureEvent::HostNoEffect,
                    )
                    .await?;
            }
            super::bridge_protocol::BridgeTrackedInputCancelOutcome::Cancelled => {
                self.handle
                    .close_placed_completion_outcome(
                        event,
                        PlacedCompletionClosureEvent::HostCancelled,
                    )
                    .await?;
            }
            super::bridge_protocol::BridgeTrackedInputCancelOutcome::Terminal { record } => {
                // The bridge validator authenticated the exact residency,
                // input id, generation, and fence.  Persist machine Resolve
                // before the pump is allowed to resolve a waiter or queue ACK.
                self.handle
                    .resolve_placed_completion_outcome(event, record)
                    .await?;
            }
            _ => {
                return Err(MobError::Internal(
                    "member host returned an unsupported tracked-input cancellation outcome"
                        .to_string(),
                ));
            }
        }
        Ok(AttemptOutcome::Progress)
    }
}