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
//! User-side inbound entry point.
//!
//! `process_inbound_packet` owns echo dedup + name routing; the welcome
//! subtopic handler reaches the per-conv plugin factory (`welcome_mls`),
//! which lives at the User layer. App-message packets are handed off to
//! [`SessionRunner::dispatch_inbound_result`] for MLS processing and
//! per-conversation dispatch.
use std::sync::{Arc, RwLock};
use prost::Message;
use tracing::info;
use crate::{
app::{DispatchOutcome, LockExt, SessionRunner, User, UserError},
core::{
ConsensusPlugin, ConversationLifecycle, ConversationPluginsFactory, CoreError,
ProcessResult, StewardListPlugin,
},
ds::{APP_MSG_SUBTOPIC, InboundPacket, WELCOME_SUBTOPIC},
mls_crypto::{MlsService, key_package_bytes_from_json},
protos::de_mls::messages::v1::{
ConversationUpdateRequest, InviteMember, WelcomeMessage, conversation_update_request,
welcome_message,
},
};
impl<P: ConsensusPlugin, CP: ConversationPluginsFactory> User<P, CP> {
// ── Public API ───────────────────────────────────────────────────
/// Process an inbound packet. The User-level entry point owns echo
/// dedup, name-based routing, and the welcome subtopic's plug-in-
/// factory access. App-message packets are handed off to the session
/// for MLS processing and dispatch.
pub async fn process_inbound_packet(&self, packet: InboundPacket) -> Result<(), UserError> {
let conversation_name = packet.conversation_id.clone();
// Echo dedup: drop our own messages received back from pub/sub.
if packet.app_id.as_slice() == &*self.app_id {
return Ok(());
}
let entry_arc = self
.lookup_entry(&conversation_name)?
.ok_or(UserError::ConversationNotFound)?;
match packet.subtopic.as_str() {
WELCOME_SUBTOPIC => {
self.process_welcome_packet(&conversation_name, &packet.payload, &entry_arc)
.await
}
APP_MSG_SUBTOPIC => {
let result = {
let mut entry = entry_arc.write_or_err("session")?;
if entry.handle.mls().is_none() {
return Ok(());
}
entry.handle.process_inbound(&packet.payload)?
};
self.finish_dispatch(&conversation_name, &entry_arc, result)
.await
}
other => Err(UserError::Core(CoreError::InvalidSubtopic(
other.to_string(),
))),
}
}
/// User-side completion of `LeaveConversation`: drop the entry from
/// the registry, clean up the consensus scope, and broadcast removal.
/// The session-side teardown (emit `Leaving`, delete MLS state) runs
/// inside `SessionRunner::dispatch_inbound_result` /
/// [`SessionRunner::poll_freeze_status`] /
/// [`SessionRunner::check_pending_join`]; this method is the cleanup
/// callers run when those signal "registry should be removed"
/// (`DispatchOutcome::LeaveRequested` or `PendingJoinTick::Expired`).
pub async fn finalize_self_leave(&self, conversation_name: &str) -> Result<(), UserError> {
// Cancel auto-vote timers before removing the registry entry —
// `cleanup_consensus_scope` finds the runner via `lookup_entry` and
// aborts its timers. If the entry is gone first, the lookup returns
// `None` and the timers leak (still scheduled, will fire against a
// conversation we've left).
self.cleanup_consensus_scope(conversation_name).await?;
self.conversations
.write()
.map_err(|_| UserError::LockPoisoned("conversation registry"))?
.remove(conversation_name);
self.emit_lifecycle(ConversationLifecycle::Removed(
conversation_name.to_string(),
));
Ok(())
}
// ── Private ──────────────────────────────────────────────────────
/// Welcome-subtopic dispatch. Two payload kinds:
/// - `UserKeyPackage` — a peer wants to join. If we already have an MLS
/// service for this conversation and the candidate isn't a member, surface
/// it as a membership-change request.
/// - `InvitationToJoin` — try the welcome factory. If it returns
/// `Some(svc)`, attach to the runner and fire the join flow.
async fn process_welcome_packet(
&self,
conversation_name: &str,
payload: &[u8],
entry_arc: &Arc<RwLock<SessionRunner<P, CP>>>,
) -> Result<(), UserError> {
let welcome_msg = WelcomeMessage::decode(payload)?;
match welcome_msg.payload {
Some(welcome_message::Payload::UserKeyPackage(user_kp)) => {
let (key_package_bytes, identity) =
key_package_bytes_from_json(user_kp.key_package_bytes)?;
let already_member = {
let entry = entry_arc.read_or_err("session")?;
entry
.handle
.mls()
.map(|m| m.is_member(&identity))
.unwrap_or(false)
};
if already_member {
info!(
conversation = conversation_name,
identity = ?identity,
"key package skipped: already a member"
);
return Ok(());
}
info!(
conversation = conversation_name,
identity = ?identity,
"key package received"
);
let gur = ConversationUpdateRequest {
payload: Some(conversation_update_request::Payload::InviteMember(
InviteMember {
key_package_bytes,
identity,
},
)),
};
SessionRunner::handle_incoming_update_request(entry_arc, gur).await
}
Some(welcome_message::Payload::InvitationToJoin(invitation)) => {
let self_id = self.self_identity();
let already_in = {
let entry = entry_arc.read_or_err("session")?;
entry.handle.steward_list.is_steward(self_id) || entry.handle.mls().is_some()
};
if already_in {
return Ok(());
}
let svc = self
.plugins
.conversation_plugins
.welcome_mls(&invitation.mls_message_out_bytes)?;
let Some(svc) = svc else {
// Welcome wasn't for us.
return Ok(());
};
let joined_name = svc.conversation_id().to_string();
{
let mut entry = entry_arc.write_or_err("session")?;
entry.handle.attach_mls(svc);
}
info!(
conversation = conversation_name,
"joined conversation via welcome"
);
self.finish_dispatch(
conversation_name,
entry_arc,
ProcessResult::JoinedConversation(joined_name),
)
.await
}
None => Ok(()),
}
}
/// Drive the session-side dispatcher and finish lifecycle work on the
/// User side when the session signals `LeaveRequested`.
async fn finish_dispatch(
&self,
conversation_name: &str,
entry_arc: &Arc<RwLock<SessionRunner<P, CP>>>,
result: ProcessResult,
) -> Result<(), UserError> {
let outcome = SessionRunner::dispatch_inbound_result(entry_arc, result).await?;
if matches!(outcome, DispatchOutcome::LeaveRequested) {
self.finalize_self_leave(conversation_name).await?;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::sync::Mutex;
use std::time::Duration;
use crate::ds::{DeliveryService, DeliveryServiceError, OutboundPacket, SharedDeliveryService};
use crate::test_fixtures::make_user_from_private_key;
/// Transport stub: `publish` is a no-op so an outbound never reaches a
/// real network; `subscribe` is a no-op too.
#[derive(Debug)]
struct NullTransport;
impl DeliveryService for NullTransport {
type Error = DeliveryServiceError;
fn publish(&mut self, _: OutboundPacket) -> Result<(), Self::Error> {
Ok(())
}
fn subscribe(&mut self, _delivery_address: &str) -> Result<(), Self::Error> {
Ok(())
}
}
const ALICE_KEY: &str = "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80";
/// Self-leave must abort auto-vote timers — otherwise they fire
/// against a conversation we've left.
/// Self-leave must drop the pending auto-vote registry — otherwise
/// the next `tick_deadlines` would fire against a conversation
/// we've left.
#[tokio::test]
async fn finalize_self_leave_clears_pending_auto_votes() {
let transport: SharedDeliveryService = Arc::new(Mutex::new(NullTransport));
let mut user = make_user_from_private_key(ALICE_KEY, transport);
user.start_conversation("test-conv", true).await.unwrap();
let session = user
.lookup_entry("test-conv")
.unwrap()
.expect("creator session registered");
// Seed a pending auto-vote with a far-future fire-at so the
// assertion isn't sensitive to wall-clock drift.
session
.write()
.unwrap()
.register_auto_vote(42, Duration::from_secs(600), true);
assert!(
session.read().unwrap().pending_auto_votes.contains_key(&42),
"auto-vote must be registered before self-leave"
);
user.finalize_self_leave("test-conv").await.unwrap();
// Session entry is gone from the registry, so the conversation's
// pending auto-votes can no longer fire from a poll cycle on this
// user.
assert!(
user.lookup_entry("test-conv").unwrap().is_none(),
"registry entry must be evicted on self-leave"
);
}
}