From ce6212b1615325b3289bba5a65e066eb5febd33e Mon Sep 17 00:00:00 2001 From: Jason Volk Date: Wed, 27 Aug 2025 06:22:49 +0000 Subject: [PATCH] Add room_version argument and reorg convert_outgoing_federation_event. Signed-off-by: Jason Volk --- src/api/client/membership/knock.rs | 8 +-- src/api/server/backfill.rs | 4 +- src/api/server/event.rs | 4 +- src/api/server/event_auth.rs | 6 +-- src/api/server/get_missing_events.rs | 4 +- src/api/server/invite.rs | 4 +- src/api/server/send_join.rs | 8 +-- src/api/server/state.rs | 8 +-- src/core/matrix/pdu.rs | 1 + src/core/matrix/pdu/format.rs | 39 +++++++++++++++ src/service/federation/format.rs | 44 ++++++++++++++++ src/service/federation/mod.rs | 1 + src/service/membership/invite.rs | 4 +- src/service/membership/join.rs | 8 +-- src/service/membership/leave.rs | 4 +- src/service/sending/sender.rs | 75 +++------------------------- 16 files changed, 122 insertions(+), 100 deletions(-) create mode 100644 src/core/matrix/pdu/format.rs create mode 100644 src/service/federation/format.rs diff --git a/src/api/client/membership/knock.rs b/src/api/client/membership/knock.rs index c981988d..6d6b8a59 100644 --- a/src/api/client/membership/knock.rs +++ b/src/api/client/membership/knock.rs @@ -253,8 +253,8 @@ async fn knock_room_helper_local( room_id: room_id.to_owned(), event_id: event_id.clone(), pdu: services - .sending - .convert_to_outgoing_federation_event(knock_event.clone()) + .federation + .format_pdu_into(knock_event.clone(), Some(&room_version_id)) .await, }; @@ -387,8 +387,8 @@ async fn knock_room_helper_remote( room_id: room_id.to_owned(), event_id: event_id.clone(), pdu: services - .sending - .convert_to_outgoing_federation_event(knock_event.clone()) + .federation + .format_pdu_into(knock_event.clone(), Some(&room_version_id)) .await, }; diff --git a/src/api/server/backfill.rs b/src/api/server/backfill.rs index 684fdfe8..6f38f19e 100644 --- a/src/api/server/backfill.rs +++ b/src/api/server/backfill.rs @@ -78,8 +78,8 @@ pub(crate) async fn get_backfill_route( }) .and_then(|pdu| { services - .sending - .convert_to_outgoing_federation_event(pdu) + .federation + .format_pdu_into(pdu, None) .map(Ok) }) .try_collect() diff --git a/src/api/server/event.rs b/src/api/server/event.rs index a1a575c0..ab2b9931 100644 --- a/src/api/server/event.rs +++ b/src/api/server/event.rs @@ -41,8 +41,8 @@ pub(crate) async fn get_event_route( origin: services.globals.server_name().to_owned(), origin_server_ts: MilliSecondsSinceUnixEpoch::now(), pdu: services - .sending - .convert_to_outgoing_federation_event(event) + .federation + .format_pdu_into(event, None) .await, }) } diff --git a/src/api/server/event_auth.rs b/src/api/server/event_auth.rs index d47f2d50..b4be7f60 100644 --- a/src/api/server/event_auth.rs +++ b/src/api/server/event_auth.rs @@ -48,11 +48,7 @@ pub(crate) async fn get_event_authorization_route( .event_ids_iter(room_id, once(body.event_id.borrow())) .ready_filter_map(Result::ok) .filter_map(async |id| services.timeline.get_pdu_json(&id).await.ok()) - .then(|pdu| { - services - .sending - .convert_to_outgoing_federation_event(pdu) - }) + .then(|pdu| services.federation.format_pdu_into(pdu, None)) .collect() .await; diff --git a/src/api/server/get_missing_events.rs b/src/api/server/get_missing_events.rs index 0e9d9008..6640ea4f 100644 --- a/src/api/server/get_missing_events.rs +++ b/src/api/server/get_missing_events.rs @@ -77,8 +77,8 @@ pub(crate) async fn get_missing_events_route( let prev_events = pdu.prev_events.iter().map(ToOwned::to_owned); let event = services - .sending - .convert_to_outgoing_federation_event(event) + .federation + .format_pdu_into(event, None) .await; queued_events.extend(prev_events); diff --git a/src/api/server/invite.rs b/src/api/server/invite.rs index 15adbd8f..7a0365ab 100644 --- a/src/api/server/invite.rs +++ b/src/api/server/invite.rs @@ -178,8 +178,8 @@ pub(crate) async fn create_invite_route( Ok(create_invite::v2::Response { event: services - .sending - .convert_to_outgoing_federation_event(signed_event) + .federation + .format_pdu_into(signed_event, Some(&body.room_version)) .await, }) } diff --git a/src/api/server/send_join.rs b/src/api/server/send_join.rs index 5de1272c..0ed79023 100644 --- a/src/api/server/send_join.rs +++ b/src/api/server/send_join.rs @@ -218,8 +218,8 @@ async fn create_join_event( .broad_and_then(|event_id| services.timeline.get_pdu_json(event_id)) .broad_and_then(|pdu| { services - .sending - .convert_to_outgoing_federation_event(pdu) + .federation + .format_pdu_into(pdu, Some(&room_version_id)) .map(Ok) }) .try_collect() @@ -233,8 +233,8 @@ async fn create_join_event( .broad_and_then(async |event_id| services.timeline.get_pdu_json(&event_id).await) .broad_and_then(|pdu| { services - .sending - .convert_to_outgoing_federation_event(pdu) + .federation + .format_pdu_into(pdu, Some(&room_version_id)) .map(Ok) }) .try_collect() diff --git a/src/api/server/state.rs b/src/api/server/state.rs index 94b7ccd0..7e417365 100644 --- a/src/api/server/state.rs +++ b/src/api/server/state.rs @@ -43,8 +43,8 @@ pub(crate) async fn get_room_state_route( .and_then(|id| services.timeline.get_pdu_json(id)) .and_then(|pdu| { services - .sending - .convert_to_outgoing_federation_event(pdu) + .federation + .format_pdu_into(pdu, None) .map(Ok) }) .try_collect() @@ -56,8 +56,8 @@ pub(crate) async fn get_room_state_route( .and_then(async |id| services.timeline.get_pdu_json(&id).await) .and_then(|pdu| { services - .sending - .convert_to_outgoing_federation_event(pdu) + .federation + .format_pdu_into(pdu, None) .map(Ok) }) .try_collect() diff --git a/src/core/matrix/pdu.rs b/src/core/matrix/pdu.rs index 3c5bcf6b..615eca80 100644 --- a/src/core/matrix/pdu.rs +++ b/src/core/matrix/pdu.rs @@ -1,5 +1,6 @@ mod builder; mod count; +pub mod format; mod hashes; mod id; mod raw_id; diff --git a/src/core/matrix/pdu/format.rs b/src/core/matrix/pdu/format.rs new file mode 100644 index 00000000..5c92002c --- /dev/null +++ b/src/core/matrix/pdu/format.rs @@ -0,0 +1,39 @@ +use ruma::{CanonicalJsonObject, CanonicalJsonValue, RoomVersionId}; + +use crate::{is_equal_to, matrix::room_version}; + +pub fn into_outgoing_federation( + mut pdu_json: CanonicalJsonObject, + room_version: &RoomVersionId, +) -> CanonicalJsonObject { + if let Some(unsigned) = pdu_json + .get_mut("unsigned") + .and_then(|val| val.as_object_mut()) + { + unsigned.remove("transaction_id"); + } + + let Ok(room_rules) = room_version::rules(room_version) else { + pdu_json.remove("event_id"); + return pdu_json; + }; + + if !room_rules.event_format.require_event_id { + pdu_json.remove("event_id"); + } + + if !room_rules + .event_format + .require_room_create_room_id + { + if pdu_json + .get("type") + .and_then(CanonicalJsonValue::as_str) + .is_some_and(is_equal_to!("m.room.create")) + { + pdu_json.remove("room_id"); + } + } + + pdu_json +} diff --git a/src/service/federation/format.rs b/src/service/federation/format.rs new file mode 100644 index 00000000..45cee589 --- /dev/null +++ b/src/service/federation/format.rs @@ -0,0 +1,44 @@ +use futures::future::OptionFuture; +use ruma::{CanonicalJsonObject, CanonicalJsonValue, RoomId, RoomVersionId}; +use serde_json::value::{RawValue as RawJsonValue, to_raw_value}; +use tuwunel_core::{ + implement, + matrix::pdu, + utils::{future::TryExtExt, result::FlatOk}, +}; + +/// This does not return a full `Pdu` it is only to satisfy ruma's types. +#[implement(super::Service)] +pub async fn format_pdu_into( + &self, + mut pdu_json: CanonicalJsonObject, + room_version: Option<&RoomVersionId>, +) -> Box { + let room_id = pdu_json + .get("room_id") + .and_then(CanonicalJsonValue::as_str) + .map(RoomId::parse) + .flat_ok(); + + let query_room_version: OptionFuture<_> = room_id + .and_then(|room_id| { + room_version + .is_none() + .then(|| self.services.state.get_room_version(room_id)) + .map(TryExtExt::ok) + }) + .into(); + + if let Some(room_version) = query_room_version + .await + .flatten() + .as_ref() + .or(room_version) + { + pdu_json = pdu::format::into_outgoing_federation(pdu_json, room_version); + } else { + pdu_json.remove("event_id"); + } + + to_raw_value(&pdu_json).expect("CanonicalJson is valid serde_json::Value") +} diff --git a/src/service/federation/mod.rs b/src/service/federation/mod.rs index 74b8de2b..2ede4b82 100644 --- a/src/service/federation/mod.rs +++ b/src/service/federation/mod.rs @@ -1,4 +1,5 @@ mod execute; +mod format; use std::sync::Arc; diff --git a/src/service/membership/invite.rs b/src/service/membership/invite.rs index 2c8c3485..cade9b16 100644 --- a/src/service/membership/invite.rs +++ b/src/service/membership/invite.rs @@ -90,8 +90,8 @@ async fn remote_invite( room_version: room_version_id.clone(), event: self .services - .sending - .convert_to_outgoing_federation_event(pdu_json.clone()) + .federation + .format_pdu_into(pdu_json.clone(), Some(&room_version_id)) .await, invite_room_state: invite_room_state .into_iter() diff --git a/src/service/membership/join.rs b/src/service/membership/join.rs index 2e8a2aac..bb1f7b2d 100644 --- a/src/service/membership/join.rs +++ b/src/service/membership/join.rs @@ -253,8 +253,8 @@ pub async fn join_remote( omit_members: false, pdu: self .services - .sending - .convert_to_outgoing_federation_event(join_event.clone()) + .federation + .format_pdu_into(join_event.clone(), Some(&room_version_id)) .await, }; @@ -742,8 +742,8 @@ pub async fn join_local( omit_members: false, pdu: self .services - .sending - .convert_to_outgoing_federation_event(join_event.clone()) + .federation + .format_pdu_into(join_event.clone(), Some(&room_version_id)) .await, }, ) diff --git a/src/service/membership/leave.rs b/src/service/membership/leave.rs index d8c2da6e..5138476f 100644 --- a/src/service/membership/leave.rs +++ b/src/service/membership/leave.rs @@ -329,8 +329,8 @@ pub async fn remote_leave(&self, user_id: &UserId, room_id: &RoomId) -> Result { event_id, pdu: self .services - .sending - .convert_to_outgoing_federation_event(leave_event.clone()) + .federation + .format_pdu_into(leave_event.clone(), Some(&room_version_id)) .await, }, ) diff --git a/src/service/sending/sender.rs b/src/service/sending/sender.rs index dc23ef7a..ada0a857 100644 --- a/src/service/sending/sender.rs +++ b/src/service/sending/sender.rs @@ -16,8 +16,8 @@ use futures::{ stream::FuturesUnordered, }; use ruma::{ - CanonicalJsonObject, CanonicalJsonValue, MilliSecondsSinceUnixEpoch, OwnedRoomId, - OwnedServerName, OwnedUserId, RoomId, ServerName, UInt, + MilliSecondsSinceUnixEpoch, OwnedRoomId, OwnedServerName, OwnedUserId, RoomId, ServerName, + UInt, api::{ appservice::event::push_events::v1::EphemeralData, federation::transactions::{ @@ -37,10 +37,8 @@ use ruma::{ serde::Raw, uint, }; -use serde_json::value::{RawValue as RawJsonValue, to_raw_value}; use tuwunel_core::{ - Error, Event, Result, debug, err, error, implement, is_equal_to, - matrix::room_version, + Error, Event, Result, debug, err, error, result::LogErr, trace, utils::{ @@ -883,7 +881,11 @@ impl Service { .get_pdu_json_from_id(pdu_id) .ok() }) - .wide_then(|pdu| self.convert_to_outgoing_federation_event(pdu)) + .wide_then(|pdu| { + self.services + .federation + .format_pdu_into(pdu, None) + }) .collect() .await; @@ -937,64 +939,3 @@ impl Service { } } } - -/// This does not return a full `Pdu` it is only to satisfy ruma's types. -#[implement(Service)] -pub async fn convert_to_outgoing_federation_event( - &self, - mut pdu_json: CanonicalJsonObject, -) -> Box { - self.strip_outgoing_federation_event(&mut pdu_json) - .await; - - to_raw_value(&pdu_json).expect("CanonicalJson is valid serde_json::Value") -} - -#[implement(Service)] -async fn strip_outgoing_federation_event(&self, pdu_json: &mut CanonicalJsonObject) { - if let Some(unsigned) = pdu_json - .get_mut("unsigned") - .and_then(|val| val.as_object_mut()) - { - unsigned.remove("transaction_id"); - } - - let Some(room_id) = pdu_json - .get("room_id") - .and_then(CanonicalJsonValue::as_str) - .map(RoomId::parse) - .transpose() - .ok() - .flatten() - else { - return; - }; - - let Ok(room_rules) = self - .services - .state - .get_room_version(room_id) - .await - .and_then(|ref ver| room_version::rules(ver)) - else { - pdu_json.remove("event_id"); - return; - }; - - if !room_rules.event_format.require_event_id { - pdu_json.remove("event_id"); - } - - if !room_rules - .event_format - .require_room_create_room_id - { - if pdu_json - .get("type") - .and_then(CanonicalJsonValue::as_str) - .is_some_and(is_equal_to!("m.room.create")) - { - pdu_json.remove("room_id"); - } - } -}