1use crate::prelude::*;
66use crate::test_common::wait_for_peers;
67use citadel_io::tokio::sync::Mutex;
68use citadel_user::prelude::UserIdentifierExt;
69use futures::{Future, StreamExt};
70use std::marker::PhantomData;
71use std::pin::Pin;
72use std::sync::atomic::{AtomicBool, Ordering};
73use std::sync::Arc;
74use uuid::Uuid;
75
76pub struct BroadcastKernel<'a, F, Fut, R: Ratchet> {
82 inner_kernel: Box<dyn NetKernel<R> + 'a>,
83 shared: Arc<BroadcastShared>,
84 _pd: PhantomData<fn() -> (F, Fut)>,
85}
86
87pub struct BroadcastShared {
88 route_registers: AtomicBool,
89 register_rx:
90 citadel_io::Mutex<Option<citadel_io::tokio::sync::mpsc::UnboundedReceiver<PeerSignal>>>,
91 register_tx: citadel_io::tokio::sync::mpsc::UnboundedSender<PeerSignal>,
92}
93
94pub enum GroupInitRequestType {
102 Create {
107 local_user: UserIdentifier,
108 invite_list: Vec<UserIdentifier>,
109 group_id: Uuid,
110 accept_registrations: bool,
111 },
112 Join {
120 local_user: UserIdentifier,
121 owner: UserIdentifier,
122 group_id: Uuid,
123 do_peer_register: bool,
124 },
125}
126
127#[async_trait]
128impl<'a, F, Fut, R: Ratchet> PrefabFunctions<'a, GroupInitRequestType, R>
129 for BroadcastKernel<'a, F, Fut, R>
130where
131 F: FnOnce(GroupChannel, CitadelClientServerConnection<R>) -> Fut + Send + 'a,
132 Fut: Future<Output = Result<(), NetworkError>> + Send + 'a,
133{
134 type UserLevelInputFunction = F;
135 type SharedBundle = Arc<BroadcastShared>;
136
137 fn get_shared_bundle(&self) -> Self::SharedBundle {
138 self.shared.clone()
139 }
140
141 #[allow(unreachable_code, clippy::blocks_in_conditions)]
142 #[cfg_attr(
143 feature = "localhost-testing",
144 tracing::instrument(level = "trace", target = "citadel", skip_all, ret, err(Debug))
145 )]
146 async fn on_c2s_channel_received(
147 connect_success: CitadelClientServerConnection<R>,
148 arg: GroupInitRequestType,
149 fx: Self::UserLevelInputFunction,
150 shared: Arc<BroadcastShared>,
151 ) -> Result<(), NetworkError> {
152 let session_cid = connect_success.cid;
153 wait_for_peers().await;
154 let mut creator_only_accept_inbound_registers = false;
155
156 let mut is_owner = false;
157 let request = match arg {
158 GroupInitRequestType::Create {
159 local_user,
160 invite_list,
161 group_id,
162 accept_registrations,
163 } => {
164 is_owner = true;
165 let mut peers_registered = vec![];
167
168 for peer in &invite_list {
169 let peer = peer
170 .search_peer(session_cid, connect_success.account_manager())
171 .await?
172 .ok_or_else(|| {
173 citadel_io::error!(
174 citadel_io::ErrorCode::BroadcastCreateUserNotRegistered,
175 format!("{peer:?}"),
176 format!("{local_user:?}")
177 )
178 })?;
179
180 peers_registered.push(peer.cid)
181 }
182
183 creator_only_accept_inbound_registers = accept_registrations;
184
185 GroupBroadcast::Create {
186 initial_invitees: peers_registered,
187 options: MessageGroupOptions {
188 group_type: GroupType::Public,
189 id: group_id.as_u128(),
190 ..Default::default()
191 },
192 }
193 }
194
195 GroupInitRequestType::Join {
196 local_user,
197 owner,
198 group_id,
199 do_peer_register,
200 } => {
201 let owner_orig = owner;
203 let owner_find = owner_orig
204 .search_peer(session_cid, connect_success.account_manager())
205 .await?;
206
207 let owner = if let Some(owner) = owner_find {
208 Some(owner)
209 } else if do_peer_register {
210 let handle = connect_success
211 .propose_target(local_user.clone(), owner_orig.clone())
212 .await?;
213 let registration = handle.register_to_peer().await?;
217 if let Some(reason) = registration.refusal_reason() {
218 return Err(NetworkError::generic(format!(
219 "Cannot join the group: registering with its owner failed: {reason}"
220 )));
221 }
222 owner_orig
224 .search_peer(session_cid, connect_success.account_manager())
225 .await?
226 } else {
227 None
228 };
229
230 let owner = owner.ok_or_else(|| {
231 citadel_io::error!(
232 citadel_io::ErrorCode::BroadcastJoinUserNotRegistered,
233 format!("{owner_orig:?}"),
234 format!("{local_user:?}")
235 )
236 })?;
237
238 let expected_message_group_key = MessageGroupKey {
239 cid: owner.cid,
240 mgid: group_id.as_u128(),
241 };
242
243 crate::prefabs::client::broadcast_join::wait_for_owner_group(
244 &connect_success,
245 &local_user,
246 &owner,
247 group_id,
248 expected_message_group_key,
249 )
250 .await?;
251
252 GroupBroadcast::RequestJoin {
253 sender: local_user.get_cid(),
254 key: expected_message_group_key,
255 }
256 }
257 };
258
259 let request = NodeRequest::GroupBroadcastCommand(GroupBroadcastCommand {
260 session_cid,
261 command: request,
262 });
263
264 let subscription = &Mutex::new(Some(
265 connect_success.send_callback_subscription(request).await?,
266 ));
267
268 log::trace!(target: "citadel", "Peer {session_cid} is attempting to join group");
269 let acceptor_task = if creator_only_accept_inbound_registers {
270 shared.route_registers.store(true, Ordering::Relaxed);
271 let mut reg_rx = shared.register_rx.lock().take().unwrap();
272 let remote = connect_success.remote_ref().clone();
273 Box::pin(async move {
274 let mut subscription = subscription.lock().await.take().unwrap();
275 let mut count_registered = 0;
277 loop {
278 let post_register = citadel_io::tokio::select! {
279 reg_request = reg_rx.recv() => {
280 reg_request.ok_or_else(|| citadel_io::error!(citadel_io::ErrorCode::BroadcastStreamEndedUnexpectedly, "reg_rx"))?
281 },
282
283 reg_request2 = subscription.next() => {
284 let signal = reg_request2.ok_or_else(|| citadel_io::error!(citadel_io::ErrorCode::BroadcastStreamEndedUnexpectedly, "subscription"))?;
285 if let NodeResult::PeerEvent(PeerEvent { event: sig @ PeerSignal::PostRegister { .. }, .. }) = &signal {
286 sig.clone()
287 } else {
288 continue;
289 }
290 }
291 };
292
293 log::trace!(target: "citadel", "ACCEPTOR {session_cid} RECV reg_request: {post_register:?}");
294 if let PeerSignal::PostRegister {
295 peer_conn_type: peer_conn,
296 inviter_username: _,
297 invitee_username: _,
298 ticket_opt: _,
299 invitee_response: None,
300 } = &post_register
301 {
302 let cid = peer_conn.get_original_target_cid();
303 if cid != session_cid {
304 log::warn!(target: "citadel", "Received the wrong CID. Will not accept request");
305 continue;
306 }
307
308 let _ = responses::peer_register(post_register, true, &remote).await?;
309 if cfg!(feature = "localhost-testing") {
310 count_registered += 1;
311 if count_registered == crate::test_common::num_local_test_peers() - 1 {
312 break;
314 }
315 }
316 }
317 }
318
319 Ok::<_, NetworkError>(())
320 })
321 as Pin<
322 Box<
323 dyn futures::Future<
324 Output = Result<(), citadel_proto::prelude::NetworkError>,
325 > + Send,
326 >,
327 >
328 } else {
329 Box::pin(async move { Ok::<_, NetworkError>(()) })
330 as Pin<
331 Box<
332 dyn futures::Future<
333 Output = Result<(), citadel_proto::prelude::NetworkError>,
334 > + Send,
335 >,
336 >
337 };
338
339 let mut lock = subscription.lock().await;
340 let subscription = lock.as_mut().unwrap();
341 while let Some(event) = subscription.next().await {
342 match event.into_result()? {
343 NodeResult::PeerEvent(PeerEvent {
344 event: ref ps @ PeerSignal::PostRegister { .. },
345 ..
346 }) => {
347 shared
348 .register_tx
349 .send(ps.clone())
350 .map_err(|err| NetworkError::generic(err.to_string()))?;
351 }
352 NodeResult::GroupChannelCreated(GroupChannelCreated {
353 ticket: _,
354 channel,
355 session_cid: _,
356 }) => {
357 drop(lock);
360 return if is_owner {
361 citadel_io::tokio::try_join!(fx(channel, connect_success), acceptor_task)
362 .map(|_| ())
363 } else {
364 fx(channel, connect_success).await.map(|_| ())
365 };
366 }
367
368 NodeResult::GroupEvent(GroupEvent {
369 session_cid: _,
370 ticket: _,
371 event: GroupBroadcast::CreateResponse { key: None },
372 }) => {
373 return Err(citadel_io::error!(
374 citadel_io::ErrorCode::BroadcastCreateGroupFailed
375 ))
376 }
377
378 _ => {}
379 }
380 }
381
382 Ok(())
383 }
384
385 fn construct(kernel: Box<dyn NetKernel<R> + 'a>) -> Self {
386 let (tx, rx) = citadel_io::tokio::sync::mpsc::unbounded_channel();
387 Self {
388 shared: Arc::new(BroadcastShared {
389 route_registers: AtomicBool::new(false),
390 register_rx: citadel_io::Mutex::new(Some(rx)),
391 register_tx: tx,
392 }),
393 inner_kernel: kernel,
394 _pd: Default::default(),
395 }
396 }
397}
398
399#[async_trait]
400impl<F, Fut, R: Ratchet> NetKernel<R> for BroadcastKernel<'_, F, Fut, R> {
401 fn load_remote(&mut self, node_remote: NodeRemote<R>) -> Result<(), NetworkError> {
402 self.inner_kernel.load_remote(node_remote)
403 }
404
405 async fn on_start(&self) -> Result<(), NetworkError> {
406 self.inner_kernel.on_start().await
407 }
408
409 async fn on_node_event_received(&self, message: NodeResult<R>) -> Result<(), NetworkError> {
410 if let NodeResult::PeerEvent(PeerEvent {
411 event: ps @ PeerSignal::PostRegister { .. },
412 ..
413 }) = &message
414 {
415 if self.shared.route_registers.load(Ordering::Relaxed) {
416 return self
417 .shared
418 .register_tx
419 .send(ps.clone())
420 .map_err(|err| NetworkError::generic(err.to_string()));
421 }
422 }
423
424 self.inner_kernel.on_node_event_received(message).await
425 }
426
427 async fn on_stop(&mut self) -> Result<(), NetworkError> {
428 self.inner_kernel.on_stop().await
429 }
430}
431
432#[cfg(all(test, feature = "localhost-testing"))]
433mod tests {
434 use crate::prefabs::client::broadcast::{BroadcastKernel, GroupInitRequestType};
435 use crate::prefabs::client::peer_connection::PeerConnectionKernel;
436 use crate::prefabs::client::DefaultServerConnectionSettingsBuilder;
437 use crate::prelude::*;
438 use crate::test_common::{server_info, wait_for_peers, TestBarrier};
439 use citadel_io::tokio;
440 use futures::prelude::stream::FuturesUnordered;
441 use futures::TryStreamExt;
442 use rstest::rstest;
443 use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
444 use uuid::Uuid;
445
446 #[citadel_io::tokio::test(flavor = "multi_thread")]
447 async fn group_connect_list_members() -> Result<(), Box<dyn std::error::Error>> {
448 let peer_count = 3;
449 assert!(peer_count > 1);
450 citadel_logging::setup_log();
451 TestBarrier::setup(peer_count);
452
453 let client_success = &AtomicUsize::new(0);
454 let (server, server_addr) = server_info::<StackedRatchet>();
455
456 let client_kernels = FuturesUnordered::new();
457 let total_peers = (0..peer_count)
458 .map(|_| Uuid::new_v4())
459 .collect::<Vec<Uuid>>();
460 let group_id = Uuid::new_v4();
461
462 for idx in 0..peer_count {
463 let uuid = total_peers.get(idx).cloned().unwrap();
464
465 let request = if idx == 0 {
466 GroupInitRequestType::Create {
468 local_user: UserIdentifier::from(uuid),
469 invite_list: vec![],
470 group_id,
471 accept_registrations: true,
472 }
473 } else {
474 GroupInitRequestType::Join {
475 local_user: UserIdentifier::from(uuid),
476 owner: total_peers.first().cloned().unwrap().into(),
477 group_id,
478 do_peer_register: true,
479 }
480 };
481
482 let server_connection_settings =
483 DefaultServerConnectionSettingsBuilder::transient_with_id(server_addr, uuid)
484 .build()
485 .unwrap();
486
487 let client_kernel = BroadcastKernel::new(
488 server_connection_settings,
489 request,
490 move |channel, connection| async move {
491 wait_for_peers().await;
492 log::trace!(target: "citadel", "***GROUP PEER {}={}={} CONNECT SUCCESS***", idx, uuid, connection.conn_type.get_session_cid());
493
494 let owned_groups = connection.list_owned_groups().await.unwrap();
495
496 if idx == 0 {
497 assert_eq!(owned_groups.len(), 1);
498 } else {
499 assert_eq!(owned_groups.len(), 0);
500 }
501
502 log::trace!(target: "citadel", "Peer {idx}={} is COMPLETE!", connection.conn_type.get_session_cid());
503
504 let _ = client_success.fetch_add(1, Ordering::Relaxed);
505 wait_for_peers().await;
506 drop(channel);
507 connection.shutdown_kernel().await
508 },
509 );
510
511 let client = DefaultNodeBuilder::default().build(client_kernel).unwrap();
512
513 client_kernels.push(async move { client.await.map(|_| ()) });
514 }
515
516 let clients = Box::pin(async move { client_kernels.try_collect::<()>().await.map(|_| ()) });
517
518 let res = futures::future::try_select(server, clients).await;
519 if let Err(err) = res {
520 return match err {
521 futures::future::Either::Left(left) => Err(left.0.into_string().into()),
522 futures::future::Either::Right(right) => Err(right.0.into_string().into()),
523 };
524 }
525
526 assert_eq!(client_success.load(Ordering::Relaxed), peer_count);
527 Ok(())
528 }
529
530 #[rstest]
531 #[case(2)]
532 #[timeout(std::time::Duration::from_secs(90))]
533 #[citadel_io::tokio::test(flavor = "multi_thread")]
534 async fn test_manual_group_connect(
535 #[case] peer_count: usize,
536 ) -> Result<(), Box<dyn std::error::Error>> {
537 assert!(peer_count > 1);
542 citadel_logging::setup_log();
543 TestBarrier::setup(peer_count);
544
545 let client_success = &AtomicBool::new(false);
546 let receiver_success = &AtomicBool::new(false);
547
548 let (server, server_addr) = server_info::<StackedRatchet>();
549
550 let client_kernels = FuturesUnordered::new();
551 let total_peers = (0..peer_count)
552 .map(|_| Uuid::new_v4())
553 .collect::<Vec<Uuid>>();
554
555 for idx in 0..peer_count {
556 let uuid = total_peers.get(idx).cloned().unwrap();
557 let peers = total_peers
558 .clone()
559 .into_iter()
560 .filter(|r| r != &uuid)
561 .map(UserIdentifier::from)
562 .collect::<Vec<UserIdentifier>>();
563
564 let server_connection_settings =
565 DefaultServerConnectionSettingsBuilder::transient_with_id(server_addr, uuid)
566 .build()
567 .unwrap();
568
569 let client_kernel = PeerConnectionKernel::new(
570 server_connection_settings,
571 peers,
572 move |mut results, remote| async move {
573 let _sender = remote.conn_type.get_session_cid();
574 let mut signals = remote.get_unprocessed_signals_receiver().unwrap();
575
576 wait_for_peers().await;
577 let conn = results.recv().await.unwrap()?;
578 log::trace!(target: "citadel", "User {uuid} received {conn:?}");
579
580 if idx == 0 {
582 let _channel = remote
583 .create_group(Some(vec![conn.channel.get_peer_cid().into()]))
584 .await?;
585 log::info!(target: "citadel", "The designated node has finished creating a group");
586
587 wait_for_peers().await;
588 client_success.store(true, Ordering::Relaxed);
589 return remote.shutdown_kernel().await;
590 } else {
591 while let Some(evt) = signals.recv().await {
593 log::info!(target: "citadel", "Received unprocessed signal: {evt:?}");
594 match evt {
595 NodeResult::GroupEvent(GroupEvent {
596 session_cid: _,
597 ticket: _,
598 event:
599 GroupBroadcast::Invitation {
600 sender: _,
601 key: _key,
602 },
603 }) => {
604 let _ =
605 crate::responses::group_invite(evt, true, &remote.inner)
606 .await?;
607 }
608
609 NodeResult::GroupChannelCreated(GroupChannelCreated {
610 ticket: _,
611 channel: _chan,
612 session_cid: _,
613 }) => {
614 receiver_success.store(true, Ordering::Relaxed);
615 log::trace!(target: "citadel", "***PEER {uuid} CONNECT***");
616 wait_for_peers().await;
617 return remote.shutdown_kernel().await;
618 }
619
620 val => {
621 log::warn!(target: "citadel", "Unhandled response: {val:?}")
622 }
623 }
624 }
625 }
626
627 Err(citadel_io::error!(
628 citadel_io::ErrorCode::BroadcastStreamEndedUnexpectedly,
629 "signals_recv"
630 ))
631 },
632 );
633
634 let client = DefaultNodeBuilder::default().build(client_kernel).unwrap();
635 client_kernels.push(async move { client.await.map(|_| ()) });
636 }
637
638 let clients = Box::pin(async move { client_kernels.try_collect::<()>().await.map(|_| ()) });
639
640 if let Err(err) = futures::future::try_select(server, clients).await {
641 return match err {
642 futures::future::Either::Left(res) => Err(res.0.into_string().into()),
643 futures::future::Either::Right(res) => Err(res.0.into_string().into()),
644 };
645 }
646
647 assert!(client_success.load(Ordering::Relaxed));
648 assert!(receiver_success.load(Ordering::Relaxed));
649 Ok(())
650 }
651
652 #[citadel_io::tokio::test(flavor = "multi_thread")]
657 async fn group_command_hierarchy_superior_reads_subordinate(
658 ) -> Result<(), Box<dyn std::error::Error>> {
659 use crate::prelude::GroupBroadcastPayload;
660 use citadel_types::crypto::SecBuffer;
661 use citadel_types::proto::{
662 CommandPath, GroupHierarchyMode, MessageGroupOptions, ReadPolicy,
663 };
664 use std::collections::HashMap;
665
666 let peer_count = 2;
667 citadel_logging::setup_log();
668 TestBarrier::setup(peer_count);
669
670 let owner_read = &AtomicBool::new(false);
671 let (server, server_addr) = server_info::<StackedRatchet>();
672 let client_kernels = FuturesUnordered::new();
673 let total_peers = (0..peer_count)
674 .map(|_| Uuid::new_v4())
675 .collect::<Vec<Uuid>>();
676
677 for idx in 0..peer_count {
678 let uuid = total_peers.get(idx).cloned().unwrap();
679 let peers = total_peers
680 .clone()
681 .into_iter()
682 .filter(|r| r != &uuid)
683 .map(UserIdentifier::from)
684 .collect::<Vec<UserIdentifier>>();
685 let server_connection_settings =
686 DefaultServerConnectionSettingsBuilder::transient_with_id(server_addr, uuid)
687 .build()
688 .unwrap();
689
690 let client_kernel = PeerConnectionKernel::new(
691 server_connection_settings,
692 peers,
693 move |mut results, remote| async move {
694 let mut signals = remote.get_unprocessed_signals_receiver().unwrap();
695 wait_for_peers().await;
696 let conn = results.recv().await.unwrap()?;
697
698 if idx == 0 {
699 let sub_cid: u64 = conn.channel.get_peer_cid();
701 let mut ranks = HashMap::new();
702 let _ = ranks.insert(sub_cid, CommandPath::parse("/alpha"));
703 let options = MessageGroupOptions {
704 hierarchy: GroupHierarchyMode::CommandHierarchy {
705 read_policy: ReadPolicy::SuperiorOnly,
706 ranks,
707 },
708 ..Default::default()
709 };
710 let mut channel = remote
711 .create_group_with_options(Some(vec![sub_cid.into()]), options)
712 .await?;
713
714 loop {
716 match channel.recv().await {
717 Some(GroupBroadcastPayload::Message { payload, sender: _ }) => {
718 assert_eq!(payload.as_ref(), b"sitrep from subordinate");
719 owner_read.store(true, Ordering::Relaxed);
720 break;
721 }
722 Some(_) => continue,
723 None => break,
724 }
725 }
726 wait_for_peers().await;
727 return remote.shutdown_kernel().await;
728 }
729
730 while let Some(evt) = signals.recv().await {
732 match evt {
733 NodeResult::GroupEvent(GroupEvent {
734 event: GroupBroadcast::Invitation { .. },
735 ..
736 }) => {
737 let _ = crate::responses::group_invite(evt, true, &remote.inner)
738 .await?;
739 }
740 NodeResult::GroupChannelCreated(GroupChannelCreated {
741 channel,
742 ..
743 }) => {
744 channel
745 .send_message(SecBuffer::from(
746 b"sitrep from subordinate".to_vec(),
747 ))
748 .await?;
749 wait_for_peers().await;
750 return remote.shutdown_kernel().await;
751 }
752 _ => {}
753 }
754 }
755
756 Err(citadel_io::error!(
757 citadel_io::ErrorCode::BroadcastStreamEndedUnexpectedly,
758 "signals"
759 ))
760 },
761 );
762 let client = DefaultNodeBuilder::default().build(client_kernel).unwrap();
763 client_kernels.push(async move { client.await.map(|_| ()) });
764 }
765
766 let clients = Box::pin(async move { client_kernels.try_collect::<()>().await.map(|_| ()) });
767 if let Err(err) = futures::future::try_select(server, clients).await {
768 return match err {
769 futures::future::Either::Left(res) => Err(res.0.into_string().into()),
770 futures::future::Either::Right(res) => Err(res.0.into_string().into()),
771 };
772 }
773
774 assert!(
775 owner_read.load(Ordering::Relaxed),
776 "owner (hierarchy root) must read the subordinate's DHE message"
777 );
778 Ok(())
779 }
780}