revamp appservice registration to ruma's Registration type

squashed from https://gitlab.com/famedly/conduit/-/merge_requests/583

Signed-off-by: strawberry <strawberry@puppygock.gay>

src/api/appservice_server.rs

@@ -1,30 +1,35 @@
 use crate::{services, utils, Error, Result};
 use bytes::BytesMut;
-use ruma::api::{IncomingResponse, MatrixVersion, OutgoingRequest, SendAccessToken};
+use ruma::api::{
+    appservice::Registration, IncomingResponse, MatrixVersion, OutgoingRequest, SendAccessToken,
+};
 use std::{fmt::Debug, mem, time::Duration};
 use tracing::warn;
 
-#[tracing::instrument(skip(request))]
+/// Sends a request to an appservice
+///
+/// Only returns None if there is no url specified in the appservice registration file
 pub(crate) async fn send_request<T: OutgoingRequest>(
-    registration: serde_yaml::Value,
+    registration: Registration,
     request: T,
-) -> Result<T::IncomingResponse>
+) -> Option<Result<T::IncomingResponse>>
 where
     T: Debug,
 {
-    let destination = registration.get("url").unwrap().as_str().unwrap();
-    let hs_token = registration.get("hs_token").unwrap().as_str().unwrap();
+    if let Some(destination) = registration.url {
+        let hs_token = registration.hs_token.as_str();
 
         let mut http_request = request
             .try_into_http_request::<BytesMut>(
-            destination,
+                &destination,
                 SendAccessToken::IfRequired(hs_token),
                 &[MatrixVersion::V1_0],
             )
             .map_err(|e| {
                 warn!("Failed to find destination {}: {}", destination, e);
                 Error::BadServerResponse("Invalid destination")
-        })?
+            })
+            .unwrap()
             .map(|body| body.freeze());
 
         let mut parts = http_request.uri().clone().into_parts();
@@ -42,7 +47,8 @@ where
         );
         *http_request.uri_mut() = parts.try_into().expect("our manipulation is always valid");
 
-    let mut reqwest_request = reqwest::Request::try_from(http_request)?;
+        let mut reqwest_request = reqwest::Request::try_from(http_request)
+            .expect("all http requests are valid reqwest requests");
 
         *reqwest_request.timeout_mut() = Some(Duration::from_secs(120));
 
@@ -56,12 +62,10 @@ where
             Ok(r) => r,
             Err(e) => {
                 warn!(
-                "Could not send request to appservice {:?} at {}: {}",
-                registration.get("id"),
-                destination,
-                e
+                    "Could not send request to appservice {} at {}: {}",
+                    registration.id, destination, e
                 );
-            return Err(e.into());
+                return Some(Err(e.into()));
             }
         };
 
@@ -97,11 +101,14 @@ where
                 .body(body)
                 .expect("reqwest body is valid http body"),
         );
-    response.map_err(|_| {
+        Some(response.map_err(|_| {
             warn!(
                 "Appservice returned invalid response bytes {}\n{}",
                 destination, url
             );
             Error::BadServerResponse("Server returned bad response.")
-    })
+        }))
+    } else {
+        None
+    }
 }

src/api/client_server/alias.rs

@@ -157,20 +157,16 @@ pub(crate) async fn get_alias_helper(
         None => {
             for (_id, registration) in services().appservice.all()? {
                 let aliases = registration
-                    .get("namespaces")
-                    .and_then(|ns| ns.get("aliases"))
-                    .and_then(|aliases| aliases.as_sequence())
-                    .map_or_else(Vec::new, |aliases| {
-                        aliases
+                    .namespaces
+                    .aliases
                     .iter()
-                            .filter_map(|aliases| Regex::new(aliases.get("regex")?.as_str()?).ok())
-                            .collect::<Vec<_>>()
-                    });
+                    .filter_map(|alias| Regex::new(alias.regex.as_str()).ok())
+                    .collect::<Vec<_>>();
 
                 if aliases
                     .iter()
                     .any(|aliases| aliases.is_match(room_alias.as_str()))
-                    && services()
+                    && if let Some(opt_result) = services()
                         .sending
                         .send_appservice_request(
                             registration,
@@ -179,7 +175,11 @@ pub(crate) async fn get_alias_helper(
                             },
                         )
                         .await
-                        .is_ok()
+                    {
+                        opt_result.is_ok()
+                    } else {
+                        false
+                    }
                 {
                     room_id = Some(
                         services()

src/api/ruma_wrapper/axum.rs

@@ -81,12 +81,9 @@ where
         let mut json_body = serde_json::from_slice::<CanonicalJsonValue>(&body).ok();
 
         let appservices = services().appservice.all().unwrap();
-        let appservice_registration = appservices.iter().find(|(_id, registration)| {
-            registration
-                .get("as_token")
-                .and_then(|as_token| as_token.as_str())
-                .map_or(false, |as_token| token == Some(as_token))
-        });
+        let appservice_registration = appservices
+            .iter()
+            .find(|(_id, registration)| Some(registration.as_token.as_str()) == token);
 
         let (sender_user, sender_device, sender_servername, from_appservice) =
             if let Some((_id, registration)) = appservice_registration {
@@ -95,11 +92,7 @@ where
                         let user_id = query_params.user_id.map_or_else(
                             || {
                                 UserId::parse_with_server_name(
-                                    registration
-                                        .get("sender_localpart")
-                                        .unwrap()
-                                        .as_str()
-                                        .unwrap(),
+                                    registration.sender_localpart.as_str(),
                                     services().globals.server_name(),
                                 )
                                 .unwrap()

src/database/key_value/appservice.rs

@@ -1,10 +1,11 @@
+use ruma::api::appservice::Registration;
+
 use crate::{database::KeyValueDatabase, service, utils, Error, Result};
 
 impl service::appservice::Data for KeyValueDatabase {
     /// Registers an appservice and returns the ID to the caller
-    fn register_appservice(&self, yaml: serde_yaml::Value) -> Result<String> {
-        // TODO: Rumaify
-        let id = yaml.get("id").unwrap().as_str().unwrap();
+    fn register_appservice(&self, yaml: Registration) -> Result<String> {
+        let id = yaml.id.as_str();
         self.id_appserviceregistrations.insert(
             id.as_bytes(),
             serde_yaml::to_string(&yaml).unwrap().as_bytes(),
@@ -32,7 +33,7 @@ impl service::appservice::Data for KeyValueDatabase {
         Ok(())
     }
 
-    fn get_registration(&self, id: &str) -> Result<Option<serde_yaml::Value>> {
+    fn get_registration(&self, id: &str) -> Result<Option<Registration>> {
         self.cached_registrations
             .read()
             .unwrap()
@@ -64,7 +65,7 @@ impl service::appservice::Data for KeyValueDatabase {
         )))
     }
 
-    fn all(&self) -> Result<Vec<(String, serde_yaml::Value)>> {
+    fn all(&self) -> Result<Vec<(String, Registration)>> {
         self.iter_ids()?
             .filter_map(|id| id.ok())
             .map(move |id| {

src/database/key_value/rooms/state_cache.rs

@@ -2,6 +2,7 @@ use std::{collections::HashSet, sync::Arc};
 
 use regex::Regex;
 use ruma::{
+    api::appservice::Registration,
     events::{AnyStrippedStateEvent, AnySyncStateEvent},
     serde::Raw,
     OwnedRoomId, OwnedServerName, OwnedUserId, RoomId, ServerName, UserId,
@@ -193,7 +194,7 @@ impl service::rooms::state_cache::Data for KeyValueDatabase {
     fn appservice_in_room(
         &self,
         room_id: &RoomId,
-        appservice: &(String, serde_yaml::Value),
+        appservice: &(String, Registration),
     ) -> Result<bool> {
         let maybe = self
             .appservice_in_room_cache
@@ -205,24 +206,19 @@ impl service::rooms::state_cache::Data for KeyValueDatabase {
 
         if let Some(b) = maybe {
             Ok(b)
-        } else if let Some(namespaces) = appservice.1.get("namespaces") {
+        } else {
+            let namespaces = &appservice.1.namespaces;
             let users = namespaces
-                .get("users")
-                .and_then(|users| users.as_sequence())
-                .map_or_else(Vec::new, |users| {
-                    users
+                .users
                 .iter()
-                        .filter_map(|users| Regex::new(users.get("regex")?.as_str()?).ok())
-                        .collect::<Vec<_>>()
-                });
+                .filter_map(|users| Regex::new(users.regex.as_str()).ok())
+                .collect::<Vec<_>>();
 
-            let bridge_user_id = appservice
-                .1
-                .get("sender_localpart")
-                .and_then(|string| string.as_str())
-                .and_then(|string| {
-                    UserId::parse_with_server_name(string, services().globals.server_name()).ok()
-                });
+            let bridge_user_id = UserId::parse_with_server_name(
+                appservice.1.sender_localpart.as_str(),
+                services().globals.server_name(),
+            )
+            .ok();
 
             let in_room = bridge_user_id
                 .map_or(false, |id| self.is_joined(&id, room_id).unwrap_or(false))
@@ -240,8 +236,6 @@ impl service::rooms::state_cache::Data for KeyValueDatabase {
                 .insert(appservice.0.clone(), in_room);
 
             Ok(in_room)
-        } else {
-            Ok(false)
         }
     }
 

src/database/mod.rs

@@ -11,6 +11,7 @@ use directories::ProjectDirs;
 use lru_cache::LruCache;
 use rand::thread_rng;
 use ruma::{
+    api::appservice::Registration,
     events::{
         push_rules::{PushRulesEvent, PushRulesEventContent},
         room::message::RoomMessageEventContent,
@@ -163,7 +164,7 @@ pub struct KeyValueDatabase {
     //pub pusher: pusher::PushData,
     pub(super) senderkey_pusher: Arc<dyn KvTree>,
 
-    pub(super) cached_registrations: Arc<RwLock<HashMap<String, serde_yaml::Value>>>,
+    pub(super) cached_registrations: Arc<RwLock<HashMap<String, Registration>>>,
     pub(super) pdu_cache: Mutex<LruCache<OwnedEventId, Arc<PduEvent>>>,
     pub(super) shorteventid_cache: Mutex<LruCache<u64, Arc<EventId>>>,
     pub(super) auth_chain_cache: Mutex<LruCache<Vec<u64>, Arc<HashSet<u64>>>>,

src/service/admin/mod.rs

@@ -10,7 +10,7 @@ use std::fmt::Write;
 use clap::{Parser, Subcommand};
 use regex::Regex;
 use ruma::{
-    api::client::error::ErrorKind,
+    api::{appservice::Registration, client::error::ErrorKind},
     events::{
         relation::InReplyTo,
         room::{
@@ -472,7 +472,7 @@ impl Service {
                     {
                         let appservice_config = body[1..body.len() - 1].join("\n");
                         let parsed_config =
-                            serde_yaml::from_str::<serde_yaml::Value>(&appservice_config);
+                            serde_yaml::from_str::<Registration>(&appservice_config);
                         match parsed_config {
                             Ok(yaml) => match services().appservice.register_appservice(yaml) {
                                 Ok(id) => RoomMessageEventContent::text_plain(format!(

src/service/appservice/data.rs

@@ -1,8 +1,10 @@
+use ruma::api::appservice::Registration;
+
 use crate::Result;
 
 pub trait Data: Send + Sync {
     /// Registers an appservice and returns the ID to the caller
-    fn register_appservice(&self, yaml: serde_yaml::Value) -> Result<String>;
+    fn register_appservice(&self, yaml: Registration) -> Result<String>;
 
     /// Remove an appservice registration
     ///
@@ -11,9 +13,9 @@ pub trait Data: Send + Sync {
     /// * `service_name` - the name you send to register the service previously
     fn unregister_appservice(&self, service_name: &str) -> Result<()>;
 
-    fn get_registration(&self, id: &str) -> Result<Option<serde_yaml::Value>>;
+    fn get_registration(&self, id: &str) -> Result<Option<Registration>>;
 
     fn iter_ids<'a>(&'a self) -> Result<Box<dyn Iterator<Item = Result<String>> + 'a>>;
 
-    fn all(&self) -> Result<Vec<(String, serde_yaml::Value)>>;
+    fn all(&self) -> Result<Vec<(String, Registration)>>;
 }

src/service/appservice/mod.rs

@@ -1,6 +1,7 @@
 mod data;
 
 pub(crate) use data::Data;
+use ruma::api::appservice::Registration;
 
 use crate::Result;
 
@@ -10,7 +11,7 @@ pub struct Service {
 
 impl Service {
     /// Registers an appservice and returns the ID to the caller
-    pub fn register_appservice(&self, yaml: serde_yaml::Value) -> Result<String> {
+    pub fn register_appservice(&self, yaml: Registration) -> Result<String> {
         self.db.register_appservice(yaml)
     }
 
@@ -23,7 +24,7 @@ impl Service {
         self.db.unregister_appservice(service_name)
     }
 
-    pub fn get_registration(&self, id: &str) -> Result<Option<serde_yaml::Value>> {
+    pub fn get_registration(&self, id: &str) -> Result<Option<Registration>> {
         self.db.get_registration(id)
     }
 
@@ -31,7 +32,7 @@ impl Service {
         self.db.iter_ids()
     }
 
-    pub fn all(&self) -> Result<Vec<(String, serde_yaml::Value)>> {
+    pub fn all(&self) -> Result<Vec<(String, Registration)>> {
         self.db.all()
     }
 }

src/service/rooms/state_cache/data.rs

@@ -2,6 +2,7 @@ use std::{collections::HashSet, sync::Arc};
 
 use crate::Result;
 use ruma::{
+    api::appservice::Registration,
     events::{AnyStrippedStateEvent, AnySyncStateEvent},
     serde::Raw,
     OwnedRoomId, OwnedServerName, OwnedUserId, RoomId, ServerName, UserId,
@@ -31,7 +32,7 @@ pub trait Data: Send + Sync {
     fn appservice_in_room(
         &self,
         room_id: &RoomId,
-        appservice: &(String, serde_yaml::Value),
+        appservice: &(String, Registration),
     ) -> Result<bool>;
 
     /// Makes a user forget a room.

src/service/rooms/state_cache/mod.rs

@@ -4,6 +4,7 @@ use std::{collections::HashSet, sync::Arc};
 pub use data::Data;
 
 use ruma::{
+    api::appservice::Registration,
     events::{
         direct::DirectEvent,
         ignored_user_list::IgnoredUserListEvent,
@@ -240,7 +241,7 @@ impl Service {
     pub fn appservice_in_room(
         &self,
         room_id: &RoomId,
-        appservice: &(String, serde_yaml::Value),
+        appservice: &(String, Registration),
     ) -> Result<bool> {
         self.db.appservice_in_room(room_id, appservice)
     }

src/service/rooms/timeline/mod.rs

@@ -621,16 +621,8 @@ impl Service {
                     .as_ref()
                     .and_then(|state_key| UserId::parse(state_key.as_str()).ok())
                 {
-                    if let Some(appservice_uid) = appservice
-                        .1
-                        .get("sender_localpart")
-                        .and_then(|string| string.as_str())
-                        .and_then(|string| {
-                            UserId::parse_with_server_name(string, services().globals.server_name())
-                                .ok()
-                        })
-                    {
-                        if state_key_uid == &appservice_uid {
+                    let appservice_uid = appservice.1.sender_localpart.as_str();
+                    if state_key_uid == appservice_uid {
                         services()
                             .sending
                             .send_pdu_appservice(appservice.0, pdu_id.clone())?;
@@ -638,30 +630,25 @@ impl Service {
                     }
                 }
             }
-            }
 
-            if let Some(namespaces) = appservice.1.get("namespaces") {
+            let namespaces = appservice.1.namespaces;
+
+            // TODO: create some helper function to change from Strings to Regexes
             let users = namespaces
-                    .get("users")
-                    .and_then(|users| users.as_sequence())
-                    .map_or_else(Vec::new, |users| {
-                        users
+                .users
                 .iter()
-                            .filter_map(|users| Regex::new(users.get("regex")?.as_str()?).ok())
-                            .collect::<Vec<_>>()
-                    });
+                .filter_map(|user| Regex::new(user.regex.as_str()).ok())
+                .collect::<Vec<_>>();
             let aliases = namespaces
-                    .get("aliases")
-                    .and_then(|aliases| aliases.as_sequence())
-                    .map_or_else(Vec::new, |aliases| {
-                        aliases
+                .aliases
                 .iter()
-                            .filter_map(|aliases| Regex::new(aliases.get("regex")?.as_str()?).ok())
-                            .collect::<Vec<_>>()
-                    });
+                .filter_map(|alias| Regex::new(alias.regex.as_str()).ok())
+                .collect::<Vec<_>>();
             let rooms = namespaces
-                    .get("rooms")
-                    .and_then(|rooms| rooms.as_sequence());
+                .rooms
+                .iter()
+                .filter_map(|room| Regex::new(room.regex.as_str()).ok())
+                .collect::<Vec<_>>();
 
             let matching_users = |users: &Regex| {
                 users.is_match(pdu.sender.as_str())
@@ -681,7 +668,9 @@ impl Service {
             };
 
             if aliases.iter().any(matching_aliases)
-                    || rooms.map_or(false, |rooms| rooms.contains(&pdu.room_id.as_str().into()))
+                || rooms
+                    .iter()
+                    .any(|namespace| namespace.is_match(pdu.room_id.as_str()))
                 || users.iter().any(matching_users)
             {
                 services()
@@ -689,7 +678,6 @@ impl Service {
                     .send_pdu_appservice(appservice.0, pdu_id.clone())?;
             }
         }
-        }
 
         Ok(pdu_id)
     }

src/service/sending/mod.rs

@@ -23,7 +23,7 @@ use base64::{engine::general_purpose, Engine as _};
 
 use ruma::{
     api::{
-        appservice,
+        appservice::{self, Registration},
         federation::{
             self,
             transactions::edu::{
@@ -520,7 +520,7 @@ impl Service {
 
                 let permit = services().sending.maximum_requests.acquire().await;
 
-                let response = appservice_server::send_request(
+                let response = match appservice_server::send_request(
                     services()
                         .appservice
                         .get_registration(id)
@@ -547,8 +547,12 @@ impl Service {
                     },
                 )
                 .await
+                {
+                    None => Ok(kind.clone()),
+                    Some(op_resp) => op_resp
                         .map(|_response| kind.clone())
-                .map_err(|e| (kind, e));
+                        .map_err(|e| (kind.clone(), e)),
+                };
 
                 drop(permit);
 
@@ -764,12 +768,14 @@ impl Service {
         response
     }
 
-    #[tracing::instrument(skip(self, registration, request))]
+    /// Sends a request to an appservice
+    ///
+    /// Only returns None if there is no url specified in the appservice registration file
     pub async fn send_appservice_request<T: OutgoingRequest>(
         &self,
-        registration: serde_yaml::Value,
+        registration: Registration,
         request: T,
-    ) -> Result<T::IncomingResponse>
+    ) -> Option<Result<T::IncomingResponse>>
     where
         T: Debug,
     {