meerkat-mob 0.5.0

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

use crate::ids::{MeerkatId, ProfileName};
use crate::roster::{Roster, RosterAddEntry, RosterEntry};
use meerkat_core::comms::TrustedPeerSpec;
use meerkat_core::types::SessionId;

mod sealed {
    pub trait Sealed {}
}

/// Sealed mutator trait for roster canonical state.
///
/// Only [`RosterAuthority`] implements this trait so that all canonical roster
/// mutations flow through a single source of truth. External helpers can take a
/// mutable reference to the authority and drive the lifecycle/wiring transitions
/// without touching the underlying projection directly.
pub(crate) trait RosterMutator: sealed::Sealed {
    fn add_member(&mut self, entry: RosterAddEntry) -> bool;
    fn mark_retiring(&mut self, meerkat_id: &MeerkatId) -> bool;
    fn remove_member(&mut self, meerkat_id: &MeerkatId) -> bool;
    fn wire_members(&mut self, a: &MeerkatId, b: &MeerkatId);
    fn wire_external_peer(
        &mut self,
        local: &MeerkatId,
        peer_name: &MeerkatId,
        spec: TrustedPeerSpec,
    );
    fn unwire_members(&mut self, a: &MeerkatId, b: &MeerkatId);
    fn unwire_external_peer(&mut self, local: &MeerkatId, peer_name: &MeerkatId);
}

/// Canonical authority for the roster projection.
///
/// This registry owns the same data that `Roster` exposes but enforces that all
/// mutations (add, retire, wire) happen through this sealed authority so that
/// higher-level actors can reason about lifecycle/wiring ordering separately.
#[derive(Debug, Clone)]
pub(crate) struct RosterAuthority {
    roster: Roster,
}

impl sealed::Sealed for RosterAuthority {}

impl RosterAuthority {
    /// Create an authority with an empty roster projection.
    pub(crate) fn new() -> Self {
        Self {
            roster: Roster::new(),
        }
    }

    /// Create an authority from an existing roster snapshot/projection.
    pub(crate) fn from_roster(roster: Roster) -> Self {
        Self { roster }
    }

    /// Snapshot the current roster for read-only surfaces.
    pub(crate) fn snapshot(&self) -> Roster {
        self.roster.clone()
    }

    pub(crate) fn get(&self, meerkat_id: &MeerkatId) -> Option<&RosterEntry> {
        self.roster.get(meerkat_id)
    }

    pub(crate) fn list(&self) -> impl Iterator<Item = &RosterEntry> {
        self.roster.list()
    }

    pub(crate) fn list_all(&self) -> impl Iterator<Item = &RosterEntry> {
        self.roster.list_all()
    }

    #[allow(dead_code)]
    pub(crate) fn list_retiring(&self) -> impl Iterator<Item = &RosterEntry> {
        self.roster.list_retiring()
    }

    pub(crate) fn by_profile(&self, profile: &ProfileName) -> impl Iterator<Item = &RosterEntry> {
        self.roster.by_profile(profile)
    }

    #[allow(dead_code)]
    pub(crate) fn find_by_label(&self, key: &str, value: &str) -> Option<&RosterEntry> {
        self.roster.find_by_label(key, value)
    }

    pub(crate) fn session_id(&self, meerkat_id: &MeerkatId) -> Option<&SessionId> {
        self.roster.session_id(meerkat_id)
    }

    /// Get a specific roster entry.
    #[allow(dead_code)]
    pub(crate) fn entry(&self, meerkat_id: &MeerkatId) -> Option<RosterEntry> {
        self.roster.get(meerkat_id).cloned()
    }

    /// List all members currently `Active`.
    #[allow(dead_code)]
    pub(crate) fn active_members(&self) -> Vec<RosterEntry> {
        self.roster.list().cloned().collect()
    }

    /// List the members that have been marked `Retiring`.
    #[allow(dead_code)]
    pub(crate) fn retiring_members(&self) -> Vec<RosterEntry> {
        self.roster.list_retiring().cloned().collect()
    }

    #[allow(dead_code)]
    pub(crate) fn debug_assert_wiring_projection_consistent(&self) {
        self.roster.debug_assert_wiring_projection_consistent();
    }

    #[allow(dead_code)]
    pub(crate) fn set_session_id(&mut self, meerkat_id: &MeerkatId, session_id: SessionId) -> bool {
        self.roster.set_session_id(meerkat_id, session_id)
    }
}

impl RosterMutator for RosterAuthority {
    fn add_member(&mut self, entry: RosterAddEntry) -> bool {
        self.roster.add(entry)
    }

    fn mark_retiring(&mut self, meerkat_id: &MeerkatId) -> bool {
        self.roster.mark_retiring(meerkat_id)
    }

    fn remove_member(&mut self, meerkat_id: &MeerkatId) -> bool {
        if self.roster.get(meerkat_id).is_some() {
            self.roster.remove(meerkat_id);
            true
        } else {
            false
        }
    }

    fn wire_members(&mut self, a: &MeerkatId, b: &MeerkatId) {
        self.roster.wire(a, b);
    }

    fn wire_external_peer(
        &mut self,
        local: &MeerkatId,
        peer_name: &MeerkatId,
        spec: TrustedPeerSpec,
    ) {
        self.roster.wire_external(local, peer_name, spec);
    }

    fn unwire_members(&mut self, a: &MeerkatId, b: &MeerkatId) {
        self.roster.unwire(a, b);
    }

    fn unwire_external_peer(&mut self, local: &MeerkatId, peer_name: &MeerkatId) {
        self.roster.unwire_external(local, peer_name);
    }
}