#![allow(clippy::or_fun_call, clippy::expect_fun_call)] use std::{ cell::RefCell, collections::{BTreeMap, BTreeSet}, convert::TryFrom, time::UNIX_EPOCH, }; use maplit::btreemap; use ruma::{ events::{ room::{ join_rules::JoinRule, member::{MemberEventContent, MembershipState}, }, EventType, }, identifiers::{EventId, RoomId, RoomVersionId, UserId}, }; use serde_json::{json, Value as JsonValue}; use state_res::{ResolutionResult, StateEvent, StateMap, StateResolution, StateStore}; use tracing_subscriber as tracer; use std::sync::Once; static LOGGER: Once = Once::new(); static mut SERVER_TIMESTAMP: i32 = 0; fn event_id(id: &str) -> EventId { if id.contains('$') { return EventId::try_from(id).unwrap(); } EventId::try_from(format!("${}:foo", id)).unwrap() } fn alice() -> UserId { UserId::try_from("@alice:foo").unwrap() } fn bob() -> UserId { UserId::try_from("@bob:foo").unwrap() } fn charlie() -> UserId { UserId::try_from("@charlie:foo").unwrap() } fn ella() -> UserId { UserId::try_from("@ella:foo").unwrap() } fn zera() -> UserId { UserId::try_from("@zera:foo").unwrap() } fn room_id() -> RoomId { RoomId::try_from("!test:foo").unwrap() } fn member_content_ban() -> JsonValue { serde_json::to_value(MemberEventContent { membership: MembershipState::Ban, displayname: None, avatar_url: None, is_direct: None, third_party_invite: None, }) .unwrap() } fn member_content_join() -> JsonValue { serde_json::to_value(MemberEventContent { membership: MembershipState::Join, displayname: None, avatar_url: None, is_direct: None, third_party_invite: None, }) .unwrap() } fn to_pdu_event( id: &str, sender: UserId, ev_type: EventType, state_key: Option<&str>, content: JsonValue, auth_events: &[S], prev_events: &[S], ) -> StateEvent where S: AsRef, { let ts = unsafe { let ts = SERVER_TIMESTAMP; // increment the "origin_server_ts" value SERVER_TIMESTAMP += 1; ts }; let id = if id.contains('$') { id.to_string() } else { format!("${}:foo", id) }; let auth_events = auth_events .iter() .map(AsRef::as_ref) .map(event_id) .collect::>(); let prev_events = prev_events .iter() .map(AsRef::as_ref) .map(event_id) .collect::>(); let json = if let Some(state_key) = state_key { json!({ "auth_events": auth_events, "prev_events": prev_events, "event_id": id, "sender": sender, "type": ev_type, "state_key": state_key, "content": content, "origin_server_ts": ts, "room_id": room_id(), "origin": "foo", "depth": 0, "hashes": { "sha256": "hello" }, "signatures": {}, }) } else { json!({ "auth_events": auth_events, "prev_events": prev_events, "event_id": id, "sender": sender, "type": ev_type, "content": content, "origin_server_ts": ts, "room_id": room_id(), "origin": "foo", "depth": 0, "hashes": { "sha256": "hello" }, "signatures": {}, }) }; serde_json::from_value(json).unwrap() } fn to_init_pdu_event( id: &str, sender: UserId, ev_type: EventType, state_key: Option<&str>, content: JsonValue, ) -> StateEvent { let ts = unsafe { let ts = SERVER_TIMESTAMP; // increment the "origin_server_ts" value SERVER_TIMESTAMP += 1; ts }; let id = if id.contains('$') { id.to_string() } else { format!("${}:foo", id) }; let json = if let Some(state_key) = state_key { json!({ "auth_events": [], "prev_events": [], "event_id": id, "sender": sender, "type": ev_type, "state_key": state_key, "content": content, "origin_server_ts": ts, "room_id": room_id(), "origin": "foo", "depth": 0, "hashes": { "sha256": "hello" }, "signatures": {}, }) } else { json!({ "auth_events": [], "prev_events": [], "event_id": id, "sender": sender, "type": ev_type, "content": content, "origin_server_ts": ts, "room_id": room_id(), "origin": "foo", "depth": 0, "hashes": { "sha256": "hello" }, "signatures": {}, }) }; serde_json::from_value(json).unwrap() } // all graphs start with these input events #[allow(non_snake_case)] fn INITIAL_EVENTS() -> BTreeMap { vec![ to_init_pdu_event( "CREATE", alice(), EventType::RoomCreate, Some(""), json!({ "creator": alice() }), ), to_init_pdu_event( "IMA", alice(), EventType::RoomMember, Some(alice().to_string().as_str()), member_content_join(), ), to_init_pdu_event( "IPOWER", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice().to_string(): 100}}), ), to_init_pdu_event( "IJR", alice(), EventType::RoomJoinRules, Some(""), json!({ "join_rule": JoinRule::Public }), ), to_init_pdu_event( "IMB", bob(), EventType::RoomMember, Some(bob().to_string().as_str()), member_content_join(), ), to_init_pdu_event( "IMC", charlie(), EventType::RoomMember, Some(charlie().to_string().as_str()), member_content_join(), ), to_init_pdu_event( "IMZ", zera(), EventType::RoomMember, Some(zera().to_string().as_str()), member_content_join(), ), to_init_pdu_event("START", zera(), EventType::RoomMessage, None, json!({})), to_init_pdu_event("END", zera(), EventType::RoomMessage, None, json!({})), ] .into_iter() .map(|ev| (ev.event_id().unwrap().clone(), ev)) .collect() } #[allow(non_snake_case)] fn INITIAL_EDGES() -> Vec { vec![ "START", "IMZ", "IMC", "IMB", "IJR", "IPOWER", "IMA", "CREATE", ] .into_iter() .map(event_id) .collect::>() } fn do_check(events: &[StateEvent], edges: Vec>, expected_state_ids: Vec) { // to activate logging use `RUST_LOG=debug cargo t one_test_only` let _ = LOGGER.call_once(|| { tracer::fmt() .with_env_filter(tracer::EnvFilter::from_default_env()) .init() }); let mut resolver = StateResolution::default(); let store = TestStore(RefCell::new( INITIAL_EVENTS() .values() .chain(events) .map(|ev| (ev.event_id().unwrap().clone(), ev.clone())) .collect(), )); // This will be lexi_topo_sorted for resolution let mut graph = BTreeMap::new(); // this is the same as in `resolve` event_id -> StateEvent let mut fake_event_map = BTreeMap::new(); // create the DB of events that led up to this point // TODO maybe clean up some of these clones it is just tests but... for ev in INITIAL_EVENTS().values().chain(events) { graph.insert(ev.event_id().unwrap().clone(), vec![]); fake_event_map.insert(ev.event_id().unwrap().clone(), ev.clone()); } for pair in INITIAL_EDGES().windows(2) { if let [a, b] = &pair { graph.entry(a.clone()).or_insert(vec![]).push(b.clone()); } } for edge_list in edges { for pair in edge_list.windows(2) { if let [a, b] = &pair { graph.entry(a.clone()).or_insert(vec![]).push(b.clone()); } } } // event_id -> StateEvent let mut event_map: BTreeMap = BTreeMap::new(); // event_id -> StateMap let mut state_at_event: BTreeMap> = BTreeMap::new(); // resolve the current state and add it to the state_at_event map then continue // on in "time" for node in resolver.lexicographical_topological_sort(&graph, |id| (0, UNIX_EPOCH, Some(id.clone()))) { let fake_event = fake_event_map.get(&node).unwrap(); let event_id = fake_event.event_id().unwrap(); let prev_events = graph.get(&node).unwrap(); let state_before: StateMap = if prev_events.is_empty() { BTreeMap::new() } else if prev_events.len() == 1 { state_at_event.get(&prev_events[0]).unwrap().clone() } else { let state_sets = prev_events .iter() .filter_map(|k| state_at_event.get(k)) .cloned() .collect::>(); tracing::warn!( "{:#?}", state_sets .iter() .map(|map| map .iter() .map(|((ty, key), id)| format!("(({}{}), {})", ty, key, id)) .collect::>()) .collect::>() ); let resolved = resolver.resolve( &room_id(), &RoomVersionId::version_1(), &state_sets, Some(event_map.clone()), &store, ); match resolved { Ok(ResolutionResult::Resolved(state)) => state, Ok(ResolutionResult::Conflicted(state)) => panic!( "conflicted: {:?}", state .iter() .map(|map| map .iter() .map(|(key, id)| (key, id.to_string())) .collect::>()) .collect::>() ), Err(e) => panic!("resolution for {} failed: {}", node, e), } }; let mut state_after = state_before.clone(); if fake_event.state_key().is_some() { let ty = fake_event.kind().clone(); // we know there is a state_key unwrap OK let key = fake_event.state_key().unwrap().clone(); state_after.insert((ty, key), event_id.clone()); } let auth_types = state_res::auth_types_for_event(fake_event); let mut auth_events = vec![]; for key in auth_types { if state_before.contains_key(&key) { auth_events.push(state_before[&key].clone()) } } // TODO The event is just remade, adding the auth_events and prev_events here // UPDATE: the `to_pdu_event` was split into `init` and the fn below, could be better let e = fake_event; let ev_id = e.event_id().unwrap(); let event = to_pdu_event( &e.event_id().unwrap().to_string(), e.sender().clone(), e.kind(), e.state_key().as_deref(), e.content().clone(), &auth_events, prev_events, ); // we have to update our store, an actual user of this lib would // be giving us state from a DB. // // TODO // TODO we need to convert the `StateResolution::resolve` to use the event_map // because the user of this crate cannot update their DB's state. *store.0.borrow_mut().get_mut(ev_id).unwrap() = event.clone(); state_at_event.insert(node, state_after); event_map.insert(event_id.clone(), event); } let mut expected_state = BTreeMap::new(); for node in expected_state_ids { let ev = event_map.get(&node).expect(&format!( "{} not found in {:?}", node.to_string(), event_map .keys() .map(ToString::to_string) .collect::>(), )); let key = (ev.kind(), ev.state_key().unwrap()); expected_state.insert(key, node); } let start_state = state_at_event.get(&event_id("$START:foo")).unwrap(); let end_state = state_at_event .get(&event_id("$END:foo")) .unwrap() .iter() .filter(|(k, v)| expected_state.contains_key(k) || start_state.get(k) != Some(*v)) .map(|(k, v)| (k.clone(), v.clone())) .collect::>(); assert_eq!(expected_state, end_state); } #[test] fn ban_vs_power_level() { let events = &[ to_init_pdu_event( "PA", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), to_init_pdu_event( "MA", alice(), EventType::RoomMember, Some(alice().to_string().as_str()), member_content_join(), ), to_init_pdu_event( "MB", alice(), EventType::RoomMember, Some(bob().to_string().as_str()), member_content_ban(), ), to_init_pdu_event( "PB", bob(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), ]; let edges = vec![ vec!["END", "MB", "MA", "PA", "START"], vec!["END", "PB", "PA"], ] .into_iter() .map(|list| list.into_iter().map(event_id).collect::>()) .collect::>(); let expected_state_ids = vec!["PA", "MA", "MB"] .into_iter() .map(event_id) .collect::>(); do_check(events, edges, expected_state_ids) } #[test] fn topic_basic() { let events = &[ to_init_pdu_event("T1", alice(), EventType::RoomTopic, Some(""), json!({})), to_init_pdu_event( "PA1", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), to_init_pdu_event("T2", alice(), EventType::RoomTopic, Some(""), json!({})), to_init_pdu_event( "PA2", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 0}}), ), to_init_pdu_event( "PB", bob(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), to_init_pdu_event("T3", bob(), EventType::RoomTopic, Some(""), json!({})), ]; let edges = vec![ vec!["END", "PA2", "T2", "PA1", "T1", "START"], vec!["END", "T3", "PB", "PA1"], ] .into_iter() .map(|list| list.into_iter().map(event_id).collect::>()) .collect::>(); let expected_state_ids = vec!["PA2", "T2"] .into_iter() .map(event_id) .collect::>(); do_check(events, edges, expected_state_ids) } #[test] fn topic_reset() { let events = &[ to_init_pdu_event("T1", alice(), EventType::RoomTopic, Some(""), json!({})), to_init_pdu_event( "PA", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), to_init_pdu_event("T2", bob(), EventType::RoomTopic, Some(""), json!({})), to_init_pdu_event( "MB", alice(), EventType::RoomMember, Some(bob().to_string().as_str()), member_content_ban(), ), ]; let edges = vec![ vec!["END", "MB", "T2", "PA", "T1", "START"], vec!["END", "T1"], ] .into_iter() .map(|list| list.into_iter().map(event_id).collect::>()) .collect::>(); let expected_state_ids = vec!["T1", "MB", "PA"] .into_iter() .map(event_id) .collect::>(); do_check(events, edges, expected_state_ids) } #[test] fn join_rule_evasion() { let events = &[ to_init_pdu_event( "JR", alice(), EventType::RoomJoinRules, Some(""), json!({ "join_rule": JoinRule::Private }), ), to_init_pdu_event( "ME", ella(), EventType::RoomMember, Some(ella().to_string().as_str()), member_content_join(), ), ]; let edges = vec![vec!["END", "JR", "START"], vec!["END", "ME", "START"]] .into_iter() .map(|list| list.into_iter().map(event_id).collect::>()) .collect::>(); let expected_state_ids = vec![event_id("JR")]; do_check(events, edges, expected_state_ids) } #[test] fn offtopic_power_level() { let events = &[ to_init_pdu_event( "PA", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), to_init_pdu_event( "PB", bob(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50, charlie(): 50}}), ), to_init_pdu_event( "PC", charlie(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50, charlie(): 0}}), ), ]; let edges = vec![vec!["END", "PC", "PB", "PA", "START"], vec!["END", "PA"]] .into_iter() .map(|list| list.into_iter().map(event_id).collect::>()) .collect::>(); let expected_state_ids = vec!["PC"].into_iter().map(event_id).collect::>(); do_check(events, edges, expected_state_ids) } #[test] fn topic_setting() { let events = &[ to_init_pdu_event("T1", alice(), EventType::RoomTopic, Some(""), json!({})), to_init_pdu_event( "PA1", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), to_init_pdu_event("T2", alice(), EventType::RoomTopic, Some(""), json!({})), to_init_pdu_event( "PA2", alice(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 0}}), ), to_init_pdu_event( "PB", bob(), EventType::RoomPowerLevels, Some(""), json!({"users": {alice(): 100, bob(): 50}}), ), to_init_pdu_event("T3", bob(), EventType::RoomTopic, Some(""), json!({})), to_init_pdu_event("MZ1", zera(), EventType::RoomMessage, None, json!({})), to_init_pdu_event("T4", alice(), EventType::RoomTopic, Some(""), json!({})), ]; let edges = vec![ vec!["END", "T4", "MZ1", "PA2", "T2", "PA1", "T1", "START"], vec!["END", "MZ1", "T3", "PB", "PA1"], ] .into_iter() .map(|list| list.into_iter().map(event_id).collect::>()) .collect::>(); let expected_state_ids = vec!["T4", "PA2"] .into_iter() .map(event_id) .collect::>(); do_check(events, edges, expected_state_ids) } #[test] fn test_event_map_none() { let mut resolver = StateResolution::default(); let store = TestStore(RefCell::new(btreemap! {})); // build up the DAG let (state_at_bob, state_at_charlie, expected) = store.set_up(); let resolved = match resolver.resolve( &room_id(), &RoomVersionId::version_2(), &[state_at_bob, state_at_charlie], None, &store, ) { Ok(ResolutionResult::Resolved(state)) => state, Err(e) => panic!("{}", e), _ => panic!("conflicted state left"), }; assert_eq!(expected, resolved) } #[test] fn test_lexicographical_sort() { let mut resolver = StateResolution::default(); let graph = btreemap! { event_id("l") => vec![event_id("o")], event_id("m") => vec![event_id("n"), event_id("o")], event_id("n") => vec![event_id("o")], event_id("o") => vec![], // "o" has zero outgoing edges but 4 incoming edges event_id("p") => vec![event_id("o")], }; let res = resolver.lexicographical_topological_sort(&graph, |id| (0, UNIX_EPOCH, Some(id.clone()))); assert_eq!( vec!["o", "l", "n", "m", "p"], res.iter() .map(ToString::to_string) .map(|s| s.replace("$", "").replace(":foo", "")) .collect::>() ) } // A StateStore implementation for testing // // /// The test state store. pub struct TestStore(RefCell>); #[allow(unused)] impl StateStore for TestStore { fn get_events(&self, events: &[EventId]) -> Result, String> { Ok(self .0 .borrow() .iter() .filter(|e| events.contains(e.0)) .map(|(_, s)| s) .cloned() .collect()) } fn get_event(&self, event_id: &EventId) -> Result { self.0 .borrow() .get(event_id) .cloned() .ok_or(format!("{} not found", event_id.to_string())) } fn auth_event_ids( &self, room_id: &RoomId, event_ids: &[EventId], ) -> Result, String> { let mut result = vec![]; let mut stack = event_ids.to_vec(); // DFS for auth event chain while !stack.is_empty() { let ev_id = stack.pop().unwrap(); if result.contains(&ev_id) { continue; } result.push(ev_id.clone()); let event = self.get_event(&ev_id).unwrap(); stack.extend(event.auth_events()); } Ok(result) } fn auth_chain_diff( &self, room_id: &RoomId, event_ids: Vec>, ) -> Result, String> { use itertools::Itertools; let mut chains = vec![]; for ids in event_ids { // TODO state store `auth_event_ids` returns self in the event ids list // when an event returns `auth_event_ids` self is not contained let chain = self .auth_event_ids(room_id, &ids)? .into_iter() .collect::>(); chains.push(chain); } if let Some(chain) = chains.first() { let rest = chains.iter().skip(1).flatten().cloned().collect(); let common = chain.intersection(&rest).collect::>(); Ok(chains .iter() .flatten() .filter(|id| !common.contains(&id)) .cloned() .collect::>() .into_iter() .collect()) } else { Ok(vec![]) } } } impl TestStore { pub fn set_up(&self) -> (StateMap, StateMap, StateMap) { // to activate logging use `RUST_LOG=debug cargo t one_test_only` let _ = LOGGER.call_once(|| { tracer::fmt() .with_env_filter(tracer::EnvFilter::from_default_env()) .init() }); let create_event = to_pdu_event::( "CREATE", alice(), EventType::RoomCreate, Some(""), json!({ "creator": alice() }), &[], &[], ); let cre = create_event.event_id().unwrap().clone(); self.0 .borrow_mut() .insert(cre.clone(), create_event.clone()); let alice_mem = to_pdu_event( "IMA", alice(), EventType::RoomMember, Some(alice().to_string().as_str()), member_content_join(), &[cre.clone()], &[cre.clone()], ); self.0 .borrow_mut() .insert(alice_mem.event_id().unwrap().clone(), alice_mem.clone()); let join_rules = to_pdu_event( "IJR", alice(), EventType::RoomJoinRules, Some(""), json!({ "join_rule": JoinRule::Public }), &[cre.clone(), alice_mem.event_id().unwrap().clone()], &[alice_mem.event_id().unwrap().clone()], ); self.0 .borrow_mut() .insert(join_rules.event_id().unwrap().clone(), join_rules.clone()); // Bob and Charlie join at the same time, so there is a fork // this will be represented in the state_sets when we resolve let bob_mem = to_pdu_event( "IMB", bob(), EventType::RoomMember, Some(bob().to_string().as_str()), member_content_join(), &[cre.clone(), join_rules.event_id().unwrap().clone()], &[join_rules.event_id().unwrap().clone()], ); self.0 .borrow_mut() .insert(bob_mem.event_id().unwrap().clone(), bob_mem.clone()); let charlie_mem = to_pdu_event( "IMC", charlie(), EventType::RoomMember, Some(charlie().to_string().as_str()), member_content_join(), &[cre, join_rules.event_id().unwrap().clone()], &[join_rules.event_id().unwrap().clone()], ); self.0 .borrow_mut() .insert(charlie_mem.event_id().unwrap().clone(), charlie_mem.clone()); let state_at_bob = [&create_event, &alice_mem, &join_rules, &bob_mem] .iter() .map(|e| { ( (e.kind(), e.state_key().unwrap()), e.event_id().unwrap().clone(), ) }) .collect::>(); let state_at_charlie = [&create_event, &alice_mem, &join_rules, &charlie_mem] .iter() .map(|e| { ( (e.kind(), e.state_key().unwrap()), e.event_id().unwrap().clone(), ) }) .collect::>(); let expected = [ &create_event, &alice_mem, &join_rules, &bob_mem, &charlie_mem, ] .iter() .map(|e| { ( (e.kind(), e.state_key().unwrap()), e.event_id().unwrap().clone(), ) }) .collect::>(); (state_at_bob, state_at_charlie, expected) } }