feat: message seen

This commit is contained in:
kaichaosun 2026-08-11 11:14:14 +08:00
parent 8e9e3125d3
commit 659ba28e2e
No known key found for this signature in database
GPG Key ID: 223E0F992F4F03BF
15 changed files with 515 additions and 63 deletions

View File

@ -15,6 +15,26 @@ pub struct DisplayMessage {
pub from_self: bool, pub from_self: bool,
pub content: String, pub content: String,
pub timestamp: u64, pub timestamp: u64,
/// Set for our own sends, so acknowledgements can be matched back to the
/// message. `serde(default)` keeps state written before this existed
/// loadable.
#[serde(default)]
pub message_id: Option<String>,
/// Peers known to hold this message, as short display labels.
#[serde(default)]
pub delivered_to: Vec<String>,
}
impl DisplayMessage {
fn new(from_self: bool, content: String) -> Self {
Self {
from_self,
content,
timestamp: now(),
message_id: None,
delivered_to: Vec::new(),
}
}
} }
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize)]
@ -189,11 +209,36 @@ where
let Some(session) = self.state.chats.get_mut(&chat_id) else { let Some(session) = self.state.chats.get_mut(&chat_id) else {
return; return;
}; };
session.messages.push(DisplayMessage { session.messages.push(DisplayMessage::new(
from_self: false, false,
content: String::from_utf8_lossy(&content).into_owned(), String::from_utf8_lossy(&content).into_owned(),
timestamp: now(), ));
}); }
Event::MessageAcked {
convo_id,
message_id,
acker,
} => {
let Some(session) = self.state.chats.get_mut(convo_id.as_ref()) else {
return;
};
let Some(message) = session
.messages
.iter_mut()
.find(|m| m.message_id.as_deref() == Some(message_id.as_str()))
else {
return; // sent before this session, or not ours
};
let acker = acker.map_or_else(
|| "a member".to_string(),
|s| {
let id = s.account.unwrap_or(s.local_identity);
format!("{}", &id.as_str()[..8.min(id.as_str().len())])
},
);
if !message.delivered_to.contains(&acker) {
message.delivered_to.push(acker);
}
} }
Event::MessageMissing { Event::MessageMissing {
convo_id, convo_id,
@ -231,16 +276,16 @@ where
.clone() .clone()
.ok_or_else(|| anyhow::anyhow!("No active chat. Use /connect or /switch first."))?; .ok_or_else(|| anyhow::anyhow!("No active chat. Use /connect or /switch first."))?;
self.client let message_id = self
.client
.send_message(&chat_id, content.as_bytes()) .send_message(&chat_id, content.as_bytes())
.map_err(|e| anyhow::anyhow!("{e:?}"))?; .map_err(|e| anyhow::anyhow!("{e:?}"))?;
if let Some(session) = self.state.chats.get_mut(&chat_id) { if let Some(session) = self.state.chats.get_mut(&chat_id) {
session.messages.push(DisplayMessage { let mut message = DisplayMessage::new(true, content.to_string());
from_self: true, // Kept so `MessageAcked` can find this message again.
content: content.to_string(), message.message_id = Some(message_id);
timestamp: now(), session.messages.push(message);
});
} }
self.save_state()?; self.save_state()?;
@ -248,11 +293,8 @@ where
} }
fn add_system_message(&mut self, content: &str) { fn add_system_message(&mut self, content: &str) {
self.command_output.push(DisplayMessage { self.command_output
from_self: true, .push(DisplayMessage::new(true, content.to_string()));
content: content.to_string(),
timestamp: now(),
});
} }
pub fn handle_command(&mut self, cmd: &str) -> Result<Option<String>> { pub fn handle_command(&mut self, cmd: &str) -> Result<Option<String>> {
@ -295,7 +337,8 @@ where
.client .client
.create_direct_conversation(args) .create_direct_conversation(args)
.map_err(|e| anyhow::anyhow!("{e:?}"))?; .map_err(|e| anyhow::anyhow!("{e:?}"))?;
self.client let message_id = self
.client
.send_message(&chat_id, initial.as_bytes()) .send_message(&chat_id, initial.as_bytes())
.map_err(|e| anyhow::anyhow!("{e:?}"))?; .map_err(|e| anyhow::anyhow!("{e:?}"))?;
@ -305,11 +348,9 @@ where
nickname: None, nickname: None,
messages: Vec::new(), messages: Vec::new(),
}; };
session.messages.push(DisplayMessage { let mut message = DisplayMessage::new(true, initial);
from_self: true, message.message_id = Some(message_id);
content: initial, session.messages.push(message);
timestamp: now(),
});
self.state.chats.insert(chat_id.clone(), session); self.state.chats.insert(chat_id.clone(), session);
self.set_active_chat(Some(chat_id)); self.set_active_chat(Some(chat_id));
self.save_state()?; self.save_state()?;

View File

@ -156,6 +156,18 @@ where
remaining = tail; remaining = tail;
} }
// Delivery receipts for our own sends: the peers whose later
// messages showed they hold this one.
if !msg.delivered_to.is_empty() {
items.push(ListItem::new(Line::from(vec![
Span::raw(indent.clone()),
Span::styled(
format!("↳ delivered to {}", msg.delivered_to.join(", ")),
Style::default().fg(Color::DarkGray),
),
])));
}
items items
}) })
.collect(); .collect();

View File

@ -9,12 +9,19 @@
//! - assign a deterministic message ID + Lamport timestamp to outbound msgs //! - assign a deterministic message ID + Lamport timestamp to outbound msgs
//! - attach a bounded causal-history frontier to each outbound message //! - attach a bounded causal-history frontier to each outbound message
//! - on receive, detect referenced-but-unseen message IDs (gaps) //! - on receive, detect referenced-but-unseen message IDs (gaps)
//! - on receive, detect references to *our own* messages (acknowledgements)
//! //!
//! Out of scope here: bloom-filter acknowledgements, //! Out of scope here: bloom-filter acknowledgements,
//! resend / outgoing buffer, incoming reorder buffer, Store-based recovery. //! resend / outgoing buffer, incoming reorder buffer, Store-based recovery.
//! This is detection only — an out-of-order message is still delivered to //! This is detection only — an out-of-order message is still delivered to
//! the application, but the gap it implies is reported. //! the application, but the gap it implies is reported.
//! //!
//! The same references also show who received our messages: a peer that names
//! one of ours must have had it. Nothing is sent back — the acknowledgement
//! rides on whatever the peer says next — so a silent peer never acknowledges,
//! and neither does one that speaks after our message has dropped out of its
//! [`CAUSAL_HISTORY_LEN`]-entry frontier.
//!
//! State is in-memory and session-scoped, matching the crate's current //! State is in-memory and session-scoped, matching the crate's current
//! in-memory MLS state. //! in-memory MLS state.
@ -72,6 +79,21 @@ pub struct MissingMessage {
pub frontier: Frontier, pub frontier: Frontier,
} }
/// A peer acknowledging one of our messages: it named that message in the
/// causal history of a message it sent, so it held ours at the time.
///
/// Evidence of *delivery to a peer's client*, not of a human reading it.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MessageAck {
pub conversation_id: String,
/// The message of ours the peer acknowledged.
pub message_id: String,
/// The acknowledging peer's `sender_id`, verbatim off the wire —
/// self-asserted like [`Frontier::sender_id`], not bound to the MLS
/// identity that sent the payload.
pub acker_id: String,
}
/// Per-conversation causal state. /// Per-conversation causal state.
#[derive(Debug, Default)] #[derive(Debug, Default)]
struct ConvoState { struct ConvoState {
@ -84,6 +106,11 @@ struct ConvoState {
frontiers: VecDeque<Frontier>, frontiers: VecDeque<Frontier>,
/// Missing IDs already reported, so a gap is surfaced exactly once. /// Missing IDs already reported, so a gap is surfaced exactly once.
reported_missing: HashSet<Frontier>, reported_missing: HashSet<Frontier>,
/// IDs of messages we authored: a reference to one is an acknowledgement.
own: HashSet<String>,
/// Which peers have acknowledged each of our messages, so each is
/// surfaced exactly once.
acked_by: HashMap<String, HashSet<String>>,
} }
impl ConvoState { impl ConvoState {
@ -102,6 +129,9 @@ struct Inner {
convos: HashMap<String, ConvoState>, convos: HashMap<String, ConvoState>,
/// Detected gaps, drained by the client (future #97 event bus). /// Detected gaps, drained by the client (future #97 event bus).
missing: Vec<MissingMessage>, missing: Vec<MissingMessage>,
/// Detected acknowledgements of our own messages, drained alongside
/// `missing`.
acked: Vec<MessageAck>,
} }
/// Session-scoped causal-history store shared by every `GroupV1Convo` /// Session-scoped causal-history store shared by every `GroupV1Convo`
@ -143,7 +173,9 @@ impl CausalHistoryStore {
.collect(); .collect();
// Our own message joins the seen-set so it appears in our future // Our own message joins the seen-set so it appears in our future
// causal history (and, later, so we can ack peers' references to it). // causal history, and the own-set so a peer referencing it back is
// recognised as acknowledging this send.
state.own.insert(message_id.clone());
state.record_seen(frontier); state.record_seen(frontier);
ReliablePayload { ReliablePayload {
@ -166,7 +198,11 @@ impl CausalHistoryStore {
payload: &ReliablePayload, payload: &ReliablePayload,
) -> Vec<MissingMessage> { ) -> Vec<MissingMessage> {
let mut inner = self.inner.borrow_mut(); let mut inner = self.inner.borrow_mut();
let Inner { convos, missing } = &mut *inner; let Inner {
convos,
missing,
acked,
} = &mut *inner;
let state = convos.entry(conversation_id.to_owned()).or_default(); let state = convos.entry(conversation_id.to_owned()).or_default();
// Lamport merge: the next local send will be strictly greater than // Lamport merge: the next local send will be strictly greater than
@ -175,6 +211,23 @@ impl CausalHistoryStore {
let mut detected = Vec::new(); let mut detected = Vec::new();
for entry in &payload.causal_history { for entry in &payload.causal_history {
// The sender named one of ours, so it has it. Reported once per
// peer per message, and never for the message's own author.
if state.own.contains(&entry.message_id)
&& payload.sender_id != entry.sender_id
&& state
.acked_by
.entry(entry.message_id.clone())
.or_default()
.insert(payload.sender_id.clone())
{
acked.push(MessageAck {
conversation_id: conversation_id.to_owned(),
message_id: entry.message_id.clone(),
acker_id: payload.sender_id.clone(),
});
}
let frontier = Frontier::new(entry.sender_id.clone(), entry.message_id.clone()); let frontier = Frontier::new(entry.sender_id.clone(), entry.message_id.clone());
if !state.seen.contains(&frontier) && state.reported_missing.insert(frontier.clone()) { if !state.seen.contains(&frontier) && state.reported_missing.insert(frontier.clone()) {
let m = MissingMessage { let m = MissingMessage {
@ -201,6 +254,11 @@ impl CausalHistoryStore {
pub fn take_missing(&self) -> Vec<MissingMessage> { pub fn take_missing(&self) -> Vec<MissingMessage> {
std::mem::take(&mut self.inner.borrow_mut().missing) std::mem::take(&mut self.inner.borrow_mut().missing)
} }
/// Drain all acknowledgements of our own messages detected so far.
pub fn take_acks(&self) -> Vec<MessageAck> {
std::mem::take(&mut self.inner.borrow_mut().acked)
}
} }
/// Deterministic, collision-resistant message ID. /// Deterministic, collision-resistant message ID.
@ -293,6 +351,87 @@ mod tests {
assert_eq!(missing[0].frontier.sender_id(), "alice"); assert_eq!(missing[0].frontier.sender_id(), "alice");
} }
/// Bob replies after receiving Alice's message, so his causal history
/// names it — that reference is the acknowledgement.
#[test]
fn a_peer_referencing_our_message_acknowledges_it() {
let alice = CausalHistoryStore::new();
let bob = CausalHistoryStore::new();
let a1 = payload(&alice, "c", "alice", b"hello");
bob.on_receive("c", &a1);
let b1 = payload(&bob, "c", "bob", b"hi back");
alice.on_receive("c", &b1);
assert_eq!(
alice.take_acks(),
vec![MessageAck {
conversation_id: "c".to_owned(),
message_id: a1.message_id.clone(),
acker_id: "bob".to_owned(),
}]
);
// Draining clears the report.
assert!(alice.take_acks().is_empty());
}
/// Every member that replies acknowledges separately, which is what lets an
/// application list the peers that hold a message.
#[test]
fn each_peer_acknowledges_separately() {
let alice = CausalHistoryStore::new();
let bob = CausalHistoryStore::new();
let carol = CausalHistoryStore::new();
let a1 = payload(&alice, "c", "alice", b"hello all");
bob.on_receive("c", &a1);
carol.on_receive("c", &a1);
alice.on_receive("c", &payload(&bob, "c", "bob", b"bob here"));
alice.on_receive("c", &payload(&carol, "c", "carol", b"carol here"));
let ackers: Vec<String> = alice
.take_acks()
.into_iter()
.filter(|a| a.message_id == a1.message_id)
.map(|a| a.acker_id)
.collect();
assert_eq!(ackers, vec!["bob".to_owned(), "carol".to_owned()]);
}
/// Bob keeps naming the message in later sends; the application is told
/// once.
#[test]
fn a_peer_acknowledges_a_message_only_once() {
let alice = CausalHistoryStore::new();
let bob = CausalHistoryStore::new();
let a1 = payload(&alice, "c", "alice", b"hello");
bob.on_receive("c", &a1);
alice.on_receive("c", &payload(&bob, "c", "bob", b"first reply"));
alice.take_acks();
alice.on_receive("c", &payload(&bob, "c", "bob", b"second reply"));
assert!(
alice.take_acks().is_empty(),
"a peer's acknowledgement of one message is reported once"
);
}
/// Carol's reply names Bob's message, not ours — nothing for us to report.
#[test]
fn a_reference_to_someone_elses_message_is_not_our_acknowledgement() {
let alice = CausalHistoryStore::new();
let bob = CausalHistoryStore::new();
let carol = CausalHistoryStore::new();
let b1 = payload(&bob, "c", "bob", b"bob speaks");
carol.on_receive("c", &b1);
// Alice observes Carol's reply, which references Bob's message only.
alice.on_receive("c", &payload(&carol, "c", "carol", b"carol replies"));
assert!(alice.take_acks().is_empty());
}
#[test] #[test]
fn a_gap_is_reported_only_once() { fn a_gap_is_reported_only_once() {
let sender = CausalHistoryStore::new(); let sender = CausalHistoryStore::new();

View File

@ -16,10 +16,19 @@ use shared_traits::IdentIdRef;
pub type ConversationId = String; pub type ConversationId = String;
pub type ConversationIdRef<'a> = &'a str; pub type ConversationIdRef<'a> = &'a str;
/// Identifies one message within a conversation, as carried by the
/// causal-history envelope. Handed back by a send so a caller can match later
/// observations — acknowledgements, gaps — to the message that produced them.
pub type MessageId = String;
/// Behaviour shared by every conversation kind. /// Behaviour shared by every conversation kind.
pub(crate) trait Convo<S: ExternalServices>: Identified + Send { pub(crate) trait Convo<S: ExternalServices>: Identified + Send {
fn send_content(&mut self, cx: &mut ServiceContext<S>, content: &[u8]) /// Encrypt and publish `content`, returning the id assigned to it.
-> Result<(), ChatError>; fn send_content(
&mut self,
cx: &mut ServiceContext<S>,
content: &[u8],
) -> Result<MessageId, ChatError>;
/// Decrypts and processes an incoming encrypted frame. /// Decrypts and processes an incoming encrypted frame.
/// ///

View File

@ -43,7 +43,7 @@ where
&mut self, &mut self,
cx: &mut ServiceContext<S>, cx: &mut ServiceContext<S>,
content: &[u8], content: &[u8],
) -> Result<(), super::ChatError> { ) -> Result<super::MessageId, super::ChatError> {
self.inner_group.send_content(cx, content) self.inner_group.send_content(cx, content)
} }

View File

@ -12,7 +12,7 @@ use shared_traits::IdentIdRef;
use std::collections::VecDeque; use std::collections::VecDeque;
use tracing::debug; use tracing::debug;
use crate::conversation::ConversationIdRef; use crate::conversation::{ConversationIdRef, MessageId};
use crate::inbox_v2::MlsProvider; use crate::inbox_v2::MlsProvider;
use crate::service_context::{ExternalServices, ServiceContext}; use crate::service_context::{ExternalServices, ServiceContext};
@ -164,7 +164,7 @@ impl GroupV1Convo {
&mut self, &mut self,
content: &[u8], content: &[u8],
cx: &mut ServiceContext<S>, cx: &mut ServiceContext<S>,
) -> Result<(), ChatError> { ) -> Result<MessageId, ChatError> {
let sender_id = cx.mls_identity.id().as_str(); let sender_id = cx.mls_identity.id().as_str();
let reliable = cx.causal.on_send(&self.convo_id, sender_id, content); let reliable = cx.causal.on_send(&self.convo_id, sender_id, content);
let wire = reliable.encode_to_vec(); let wire = reliable.encode_to_vec();
@ -175,7 +175,8 @@ impl GroupV1Convo {
.unwrap(); .unwrap();
let msg_bytes = mls_message_out.to_bytes().unwrap(); let msg_bytes = mls_message_out.to_bytes().unwrap();
self.send_payload(cx, msg_bytes) self.send_payload(cx, msg_bytes)?;
Ok(reliable.message_id)
} }
// Publish outboubound payloads to the DeliveryService // Publish outboubound payloads to the DeliveryService
@ -220,7 +221,7 @@ impl<S: ExternalServices> Convo<S> for GroupV1Convo {
&mut self, &mut self,
cx: &mut ServiceContext<S>, cx: &mut ServiceContext<S>,
content: &[u8], content: &[u8],
) -> Result<(), ChatError> { ) -> Result<MessageId, ChatError> {
self.send_message(content, cx) self.send_message(content, cx)
} }

View File

@ -32,7 +32,7 @@ use std::time::{Duration, SystemTime, UNIX_EPOCH};
use tracing::{info, instrument}; use tracing::{info, instrument};
use crate::IdentityProvider; use crate::IdentityProvider;
use crate::conversation::{ConversationIdRef, ExternalServices, ServiceContext}; use crate::conversation::{ConversationIdRef, ExternalServices, MessageId, ServiceContext};
use crate::{ use crate::{
ConvoOutcome, DeliveryService, RegistrationService, ConvoOutcome, DeliveryService, RegistrationService,
conversation::{ChatError, Convo, GroupConvo, Identified}, conversation::{ChatError, Convo, GroupConvo, Identified},
@ -289,26 +289,23 @@ where
&mut self, &mut self,
service_ctx: &mut super::ServiceContext<S>, service_ctx: &mut super::ServiceContext<S>,
content: &[u8], content: &[u8],
) -> Result<(), ChatError> { ) -> Result<MessageId, ChatError> {
// The causal-history envelope rides inside the de-mls ciphertext, so // The causal-history envelope rides inside the de-mls ciphertext, so
// the reference graph stays invisible to relays — same placement as // the reference graph stays invisible to relays — same placement as
// GroupV1, which wraps the content before `create_message`. // GroupV1, which wraps the content before `create_message`.
let wire = service_ctx let reliable = service_ctx.causal.on_send(
.causal &self.convo_id,
.on_send( service_ctx.mls_identity.id().as_str(),
&self.convo_id, content,
service_ctx.mls_identity.id().as_str(), );
content,
)
.encode_to_vec();
self.conversation.send_message( self.conversation.send_message(
&service_ctx.mls_provider, &service_ctx.mls_provider,
&service_ctx.mls_identity, &service_ctx.mls_identity,
wire, reliable.encode_to_vec(),
)?; )?;
self.after_op(service_ctx)?; self.after_op(service_ctx)?;
Ok(()) Ok(reliable.message_id)
} }
#[instrument(name = "groupv2.handle_frame", skip_all, fields(user_id = %service_ctx.mls_identity.display_name()))] #[instrument(name = "groupv2.handle_frame", skip_all, fields(user_id = %service_ctx.mls_identity.display_name()))]

View File

@ -1,6 +1,6 @@
use crate::causal_history::{CausalHistoryStore, MissingMessage}; use crate::causal_history::{CausalHistoryStore, MessageAck, MissingMessage};
use crate::conversation::{ use crate::conversation::{
ConversationIdRef, DirectV1Convo, GroupV1Convo, GroupV2Convo, Identified, ConversationIdRef, DirectV1Convo, GroupV1Convo, GroupV2Convo, Identified, MessageId,
}; };
use crate::service_context::{ExternalServices, ServiceContext}; use crate::service_context::{ExternalServices, ServiceContext};
use crate::types::ConvoMetadata; use crate::types::ConvoMetadata;
@ -329,8 +329,16 @@ impl<'a, S: ExternalServices + 'static> Core<S> {
self.services.causal.take_missing() self.services.causal.take_missing()
} }
/// Encrypt and publish `content` to an existing conversation. /// Drain the acknowledgements observed since the last call: peers that
pub fn send_content(&mut self, convo_id: &str, content: &[u8]) -> Result<(), ChatError> { /// referenced one of our messages, and so demonstrably hold it.
pub fn take_acks(&self) -> Vec<MessageAck> {
self.services.causal.take_acks()
}
/// Encrypt and publish `content` to an existing conversation, returning the
/// id assigned to the message so later acknowledgements can be matched to
/// it.
pub fn send_content(&mut self, convo_id: &str, content: &[u8]) -> Result<MessageId, ChatError> {
if self.cached_convos.contains_key(convo_id) { if self.cached_convos.contains_key(convo_id) {
let convo = self let convo = self
.cached_convos .cached_convos
@ -508,7 +516,7 @@ impl<S: ExternalServices> Convo<S> for ConvoTypeOwned<S> {
&mut self, &mut self,
cx: &mut ServiceContext<S>, cx: &mut ServiceContext<S>,
content: &[u8], content: &[u8],
) -> Result<(), ChatError> { ) -> Result<MessageId, ChatError> {
match self { match self {
ConvoTypeOwned::Group(group_convo) => group_convo.send_content(cx, content), ConvoTypeOwned::Group(group_convo) => group_convo.send_content(cx, content),
ConvoTypeOwned::Direct(convo) => convo.send_content(cx, content), ConvoTypeOwned::Direct(convo) => convo.send_content(cx, content),

View File

@ -10,10 +10,10 @@ mod service_traits;
mod types; mod types;
mod utils; mod utils;
pub use causal_history::{Frontier, MissingMessage}; pub use causal_history::{Frontier, MessageAck, MissingMessage};
pub use chat_sqlite::ChatStorage; pub use chat_sqlite::ChatStorage;
pub use chat_sqlite::StorageConfig; pub use chat_sqlite::StorageConfig;
pub use conversation::GroupV2Clock; pub use conversation::{GroupV2Clock, MessageId};
pub use core::{ConversationId, Core}; pub use core::{ConversationId, Core};
/// Timing/policy for GroupV2 conversations (de-mls's per-conversation config). /// Timing/policy for GroupV2 conversations (de-mls's per-conversation config).
/// Defaults to the de-mls library defaults; inject via /// Defaults to the de-mls library defaults; inject via

View File

@ -0,0 +1,79 @@
//! End-to-end acknowledgement detection on GroupV2.
//!
//! Saro sends a message; Raya and Pax reply. Each reply carries Saro's message
//! in its causal history, so Saro learns both peers hold it — without either
//! sending anything back on purpose.
use integration_tests_core::TestHarness;
use libchat::MessageAck;
#[test]
fn replies_acknowledge_the_message_they_were_sent_after() {
let mut harness = TestHarness::<3>::new(|_, _| {});
let participants = &[&harness.raya().addr(), &harness.pax().addr()];
let convo_id = harness
.saro()
.create_group_convo_v2(participants, "", "")
.expect("saro create group");
harness.process_until_label("peers join", |h| {
h.raya().convo_count() == 1 && h.pax().convo_count() == 1
});
let message_id = harness
.saro()
.send_content(&convo_id, b"anyone there?")
.expect("saro send");
harness.process_until_label("peers get the message", |h| {
h.raya().check(&convo_id, b"anyone there?") && h.pax().check(&convo_id, b"anyone there?")
});
assert!(
harness.saro().take_acks().is_empty(),
"holding a message is only observable once the peer sends"
);
// Each reply names Saro's message in its causal history.
harness
.raya()
.send_content(&convo_id, b"raya here")
.expect("raya reply");
harness
.pax()
.send_content(&convo_id, b"pax here")
.expect("pax reply");
harness.process_until_label("saro gets both replies", |h| {
h.saro().check(&convo_id, b"raya here") && h.saro().check(&convo_id, b"pax here")
});
let acks: Vec<MessageAck> = harness.saro().take_acks();
let mut ackers: Vec<&str> = acks
.iter()
.filter(|a| a.conversation_id == convo_id && a.message_id == message_id)
.map(|a| a.acker_id.as_str())
.collect();
ackers.sort_unstable();
assert_eq!(
ackers,
vec!["pax", "raya"],
"both peers that replied should be reported as holding the message"
);
// Draining clears the reports, and neither peer acknowledges twice.
assert!(harness.saro().take_acks().is_empty());
harness
.raya()
.send_content(&convo_id, b"raya again")
.expect("raya second reply");
harness.process_until_label("saro gets the second reply", |h| {
h.saro().check(&convo_id, b"raya again")
});
assert!(
harness
.saro()
.take_acks()
.iter()
.all(|a| a.message_id != message_id),
"a peer acknowledges one message only once"
);
}

View File

@ -7,7 +7,8 @@ use crossbeam_channel::{Receiver, Sender, select};
use crypto::Ed25519VerifyingKey; use crypto::Ed25519VerifyingKey;
use libchat::{ use libchat::{
ConversationId, ConvoMetadata, ConvoOutcome, Core, DeliveryService, GroupV2Config, IdentId, ConversationId, ConvoMetadata, ConvoOutcome, Core, DeliveryService, GroupV2Config, IdentId,
IdentIdRef, InboxOutcome, MissingMessage, PayloadOutcome, RegistrationService, IdentIdRef, InboxOutcome, MessageAck, MessageId, MissingMessage, PayloadOutcome,
RegistrationService,
}; };
use logos_account::{AccountDirectory, resolve_device_ids}; use logos_account::{AccountDirectory, resolve_device_ids};
use parking_lot::Mutex; use parking_lot::Mutex;
@ -275,7 +276,14 @@ where
/// Encrypt and send `content` to an existing conversation. The core /// Encrypt and send `content` to an existing conversation. The core
/// publishes the outbound envelope. /// publishes the outbound envelope.
pub fn send_message(&mut self, convo_id: &str, content: &[u8]) -> Result<(), ClientError> { ///
/// Returns the message's id, which later [`Event::MessageAcked`] events
/// carry — hold onto it to show which peers have the message.
pub fn send_message(
&mut self,
convo_id: &str,
content: &[u8],
) -> Result<MessageId, ClientError> {
self.core self.core
.lock() .lock()
.send_content(convo_id, content) .send_content(convo_id, content)
@ -356,6 +364,7 @@ fn worker_loop<T, R, S: ChatStore + 'static>(
}] }]
} }
}; };
events.extend(ack_events(core.take_acks(), &directory));
events.extend(missing_events(core.take_missing_messages(), &directory)); events.extend(missing_events(core.take_missing_messages(), &directory));
events events
}; };
@ -379,6 +388,7 @@ fn worker_loop<T, R, S: ChatStore + 'static>(
Vec::new() Vec::new()
} }
}; };
events.extend(ack_events(core.take_acks(), &directory));
events.extend(missing_events(core.take_missing_messages(), &directory)); events.extend(missing_events(core.take_missing_messages(), &directory));
events events
}; };
@ -405,6 +415,21 @@ fn events_from_inbound(result: PayloadOutcome, directory: &impl AccountDirectory
} }
} }
/// Map the acknowledgements the core observed while processing one payload onto
/// [`Event::MessageAcked`], one per peer per message.
///
/// Drained from the same place as [`missing_events`]: the causal history of the
/// message just processed is what carried the acknowledgement.
fn ack_events(acks: Vec<MessageAck>, directory: &impl AccountDirectory) -> Vec<Event> {
acks.into_iter()
.map(|a| Event::MessageAcked {
convo_id: Arc::from(a.conversation_id),
message_id: a.message_id,
acker: sender_hint(directory, &a.acker_id),
})
.collect()
}
/// Map the causal-history gaps the core detected while processing one payload /// Map the causal-history gaps the core detected while processing one payload
/// onto [`Event::MessageMissing`]. /// onto [`Event::MessageMissing`].
/// ///
@ -423,12 +448,13 @@ fn missing_events(missing: Vec<MissingMessage>, directory: &impl AccountDirector
.collect() .collect()
} }
/// Resolve the author a peer named for a message we never saw. /// Resolve a participant a causal-history observation named — the author of a
/// message we never saw, or the peer acknowledging one of ours.
/// ///
/// Same credential decoding as a delivered message's sender, but the claim /// Same credential decoding as a delivered message's sender, but the claim is
/// itself is unauthenticated — the message it describes never arrived — so an /// self-asserted rather than authenticated, so an unconfirmable account yields
/// unconfirmable account yields the device alone rather than dropping the /// the device alone rather than dropping the observation. `None` when the value
/// report. `None` when the hint is not a credential at all. /// is not a credential at all.
fn sender_hint(directory: &impl AccountDirectory, encoded: &str) -> Option<MessageSender> { fn sender_hint(directory: &impl AccountDirectory, encoded: &str) -> Option<MessageSender> {
let (device, claim) = parse_credential(directory, encoded.as_bytes()).ok()?; let (device, claim) = parse_credential(directory, encoded.as_bytes()).ok()?;
Some(MessageSender { Some(MessageSender {
@ -643,11 +669,11 @@ mod sender_check_tests {
use logos_account::{DeviceSet, SignedDeviceBundle}; use logos_account::{DeviceSet, SignedDeviceBundle};
use super::{ use super::{
Event, GroupMember, MessageSender, SenderError, decode_sender, dedup_members, member_key, Event, GroupMember, MessageSender, SenderError, ack_events, decode_sender, dedup_members,
missing_events, roster_member, member_key, missing_events, roster_member,
}; };
use crate::delegate::DelegateCredential; use crate::delegate::DelegateCredential;
use libchat::{Frontier, MissingMessage}; use libchat::{Frontier, MessageAck, MissingMessage};
/// In-test account → device directory. Holds device id sets keyed by the hex /// In-test account → device directory. Holds device id sets keyed by the hex
/// account key, and can be made to fail to simulate a directory outage. /// account key, and can be made to fail to simulate a directory outage.
@ -1041,4 +1067,47 @@ mod sender_check_tests {
assert_eq!(message_id, "msg-id"); assert_eq!(message_id, "msg-id");
assert_eq!(sender, None); assert_eq!(sender, None);
} }
/// One acknowledgement per peer per message, each naming the peer an
/// application would list against the message.
#[test]
fn acks_name_the_peers_that_hold_the_message() {
let account = key();
let device = key();
let dir = FakeDir::with_devices(&account, &[&device]);
let acker = DelegateCredential::associated(&device, &hex::encode(account.as_ref()));
let events = ack_events(
vec![MessageAck {
conversation_id: "convo".to_owned(),
message_id: "msg-id".to_owned(),
acker_id: hex_cred(acker),
}],
&dir,
);
match <[Event; 1]>::try_from(events)
.expect("one ack produces one event")
.into_iter()
.next()
.unwrap()
{
Event::MessageAcked {
convo_id,
message_id,
acker,
} => {
assert_eq!(&*convo_id, "convo");
assert_eq!(message_id, "msg-id");
assert_eq!(
acker,
Some(MessageSender {
account: Some(local_id(&account)),
local_identity: local_id(&device),
})
);
}
other => panic!("expected MessageAcked, got {other:?}"),
}
}
} }

View File

@ -38,6 +38,23 @@ pub enum Event {
content: Vec<u8>, content: Vec<u8>,
sender: MessageSender, sender: MessageSender,
}, },
/// A peer acknowledged a message this client sent: it referenced that
/// message in the causal history of a message of its own, so it held ours
/// when it sent. `message_id` is the id the send returned.
///
/// Evidence of delivery to the peer's client, not of a human reading it.
/// The acknowledgement is passive — nothing is sent back on purpose — so a
/// peer that never sends never acknowledges, and an application should
/// treat the absence of one as "not confirmed" rather than "not delivered".
///
/// `acker` is resolved from the peer's self-asserted `sender_id` and is
/// **not authenticated**; see [`Self::MessageMissing`]'s `sender_hint`.
/// `None` when it could not be resolved to a device.
MessageAcked {
convo_id: Arc<str>,
message_id: String,
acker: Option<MessageSender>,
},
/// A message this client never received, revealed by the causal history of /// A message this client never received, revealed by the causal history of
/// one that did arrive. Detection only — nothing is fetched or replayed, /// one that did arrive. Detection only — nothing is fetched or replayed,
/// and the gap is reported once. /// and the gap is reported once.

View File

@ -15,7 +15,8 @@ pub use event::{Event, MessageSender};
// Re-export types callers need to interact with ChatClient. // Re-export types callers need to interact with ChatClient.
pub use libchat::{ pub use libchat::{
AddressedEnvelope, ChatStore, ConversationClass, ConversationId, ConvoMetadata, AddressedEnvelope, ChatStore, ConversationClass, ConversationId, ConvoMetadata,
DeliveryService, GroupV2Config, IdentityProvider, RegistrationService, StorageConfig, DeliveryService, GroupV2Config, IdentityProvider, MessageId, RegistrationService,
StorageConfig,
}; };
// The directory trait bounds ChatClient's registry parameter, so callers // The directory trait bounds ChatClient's registry parameter, so callers
// writing code generic over ChatClient need it too. // writing code generic over ChatClient need it too.

View File

@ -479,3 +479,63 @@ fn group_metadata_defaults_to_empty() {
assert_eq!(meta.name, ""); assert_eq!(meta.name, "");
assert_eq!(meta.desc, ""); assert_eq!(meta.desc, "");
} }
/// The peers that hold a sent message surface as `MessageAcked` events keyed by
/// the id the send returned — what an application needs to show ackers against
/// a message. The acknowledgement is passive: Raya and Pax only send ordinary
/// replies, never a receipt.
#[test]
fn a_sent_message_is_acknowledged_by_the_peers_that_reply() {
let bus = MessageBus::default();
let reg = EphemeralRegistry::new();
let (mut saro, saro_events, saro_addr) = create_test_client(bus.clone(), reg.clone());
let (mut raya, raya_events, raya_addr) = create_test_client(bus.clone(), reg.clone());
let (mut pax, pax_events, pax_addr) = create_test_client(bus.clone(), reg.clone());
let convo_id = saro
.create_group_conversation(&[&raya_addr, &pax_addr], unnamed_group())
.expect("saro create group");
wait_for_group_started(&raya_events, "raya ConversationStarted");
wait_for_group_started(&pax_events, "pax ConversationStarted");
wait_for_members(&mut saro, &convo_id, &[&saro_addr, &raya_addr, &pax_addr]);
let message_id = saro
.send_message(&convo_id, b"anyone there?")
.expect("saro send");
wait_for_message(&raya_events, b"anyone there?");
wait_for_message(&pax_events, b"anyone there?");
// Ordinary replies; their causal history carries the acknowledgement.
raya.send_message(&convo_id, b"raya here")
.expect("raya reply");
pax.send_message(&convo_id, b"pax here").expect("pax reply");
let mut ackers = Vec::new();
while ackers.len() < 2 {
let acker = wait_for_event(
&saro_events,
"saro MessageAcked",
Duration::from_secs(10),
|e| match e {
Event::MessageAcked {
convo_id: id,
message_id: acked,
acker,
} if **id == *convo_id && *acked == message_id => Some(
acker
.as_ref()
.and_then(|a| a.account.as_ref())
.map(|a| a.as_str().to_string()),
),
_ => None,
},
);
ackers.push(acker.expect("the acker's account should be directory-verified"));
}
ackers.sort();
let mut expected = vec![raya_addr.clone(), pax_addr.clone()];
expected.sort();
assert_eq!(ackers, expected, "both replying peers should be listed");
}

View File

@ -54,6 +54,25 @@ where
f(event).unwrap_or_else(|other| panic!("expected {label}, got {other:?}")) f(event).unwrap_or_else(|other| panic!("expected {label}, got {other:?}"))
} }
/// [`expect_event`] for a back-and-forth exchange, skipping acknowledgements.
///
/// Each reply acknowledges the message it was sent after, so `MessageAcked`
/// lands at points a test driving one direction at a time does not control.
fn expect_event_ignoring_acks<F, T>(events: &Receiver<Event>, label: &str, mut f: F) -> T
where
F: FnMut(Event) -> Result<T, Event>,
{
loop {
let event = events
.recv_timeout(Duration::from_secs(5))
.unwrap_or_else(|_| panic!("timed out waiting for {label}"));
if matches!(event, Event::MessageAcked { .. }) {
continue;
}
return f(event).unwrap_or_else(|other| panic!("expected {label}, got {other:?}"));
}
}
#[test] #[test]
fn direct_v1_integration() { fn direct_v1_integration() {
let bus = MessageBus::default(); let bus = MessageBus::default();
@ -255,7 +274,7 @@ fn saro_raya_message_exchange() {
for i in 0u8..5 { for i in 0u8..5 {
let msg = format!("msg {i}"); let msg = format!("msg {i}");
saro.send_message(&saro_convo_id, msg.as_bytes()).unwrap(); saro.send_message(&saro_convo_id, msg.as_bytes()).unwrap();
expect_event( expect_event_ignoring_acks(
&raya_events, &raya_events,
&format!("MessageReceived(msg {i})"), &format!("MessageReceived(msg {i})"),
|e| match e { |e| match e {
@ -269,7 +288,7 @@ fn saro_raya_message_exchange() {
let reply = format!("reply {i}"); let reply = format!("reply {i}");
raya.send_message(&raya_convo_id, reply.as_bytes()).unwrap(); raya.send_message(&raya_convo_id, reply.as_bytes()).unwrap();
expect_event( expect_event_ignoring_acks(
&saro_events, &saro_events,
&format!("MessageReceived(reply {i})"), &format!("MessageReceived(reply {i})"),
|e| match e { |e| match e {