wip(workspace-details): Move workspace accent color to workspace vCard

Author: RemiBardon

.zed/settings.json

@@ -10,6 +10,9 @@
     },
     "Markdown": {
       "wrap_guides": [96]
+    },
+    "Gherkin": {
+      "format_on_save": "off"
     }
   },
   "language_overrides": {

Cargo.lock

@@ -76,7 +76,7 @@ rustls = { version = "0.23", default-features = false }
 # `prose-xmpp` and its dependencies.
 # NOTE: See <https://github.com/prose-im/prose-core-client/blob/master/Cargo.toml>
 #   for up-to-date versions (make sure to switch to the appropriate tag).
-prose-xmpp = { git = "https://github.com/prose-im/prose-core-client.git", tag = "0.1.101", default-features = false }
+prose-xmpp = { git = "https://github.com/prose-im/prose-core-client.git", branch = "vcard4-private-properties", default-features = false }
 jid = { version = "0.11", default-features = false }
 minidom = { version = "0.16", default-features = false }
 xmpp-parsers = { version = "0.21", default-features = false }

Cargo.toml

@@ -8,10 +8,10 @@ use std::sync::Arc;
 use axum::{http::HeaderValue, Json};
 use serde::{Deserialize, Serialize};
 use service::{
-    init::{InitService, InitWorkspaceError, WorkspaceCreateForm},
+    init::{InitService, InitWorkspaceError},
     secrets::SecretsStore,
     server_config::ServerConfig,
-    workspace::WorkspaceServiceError,
+    workspace::{Workspace, WorkspaceServiceError},
     xmpp::XmppServiceInner,
     AppConfig,
 };
@@ -98,8 +98,7 @@ impl CustomErrorCode for InitWorkspaceError {
         match self {
             Self::WorkspaceAlreadyInitialized => ErrorCode::WORKSPACE_ALREADY_INITIALIZED,
             Self::XmppAccountNotInitialized => ErrorCode::SERVER_CONFIG_NOT_INITIALIZED,
-            Self::CouldNotSetWorkspaceName(err) => err.code(),
-            Self::DbErr(err) => err.code(),
+            Self::CouldNotSetWorkspaceVCard(err) => err.code(),
         }
     }
 }
@@ -110,7 +109,6 @@ impl HttpApiError for WorkspaceServiceError {
         match self {
             Self::WorkspaceNotInitialized => WorkspaceNotInitialized.code(),
             Self::XmppServiceError(err) => err.code(),
-            Self::DbErr(err) => err.code(),
         }
     }
     fn message(&self) -> String {
@@ -126,11 +124,12 @@ impl HttpApiError for WorkspaceServiceError {
 
 // BOILERPLATE
 
-impl Into<WorkspaceCreateForm> for InitWorkspaceRequest {
-    fn into(self) -> WorkspaceCreateForm {
-        WorkspaceCreateForm {
+impl Into<Workspace> for InitWorkspaceRequest {
+    fn into(self) -> Workspace {
+        Workspace {
             name: self.name,
-            accent_color: Some(self.accent_color),
+            accent_color: self.accent_color,
+            icon: None,
         }
     }
 }

crates/rest-api/src/features/init/init_workspace.rs

@@ -20,7 +20,6 @@ impl FromRequestParts<AppState> for WorkspaceService {
         let server_config = ServerConfig::from_request_parts(parts, state).await?;
 
         WorkspaceService::new(
-            Arc::new(state.db.clone()),
             Arc::new(state.xmpp_service.clone()),
             Arc::new(state.app_config.clone()),
             &server_config,

crates/rest-api/src/features/workspace_details/guards/workspace_service.rs

@@ -6,7 +6,7 @@
 use std::str::FromStr as _;
 
 use service::prose_xmpp::stanza::{vcard4 as prose_xmpp_properties, VCard4};
-use vcard4::property as vcard4_properties;
+use vcard4::property::{self as vcard4_properties, ExtensionProperty};
 
 pub fn prose_xmpp_vcard4_to_vcard4_vcard(
     VCard4 {
@@ -22,6 +22,7 @@ pub fn prose_xmpp_vcard4_to_vcard4_vcard(
         tel,
         title,
         url,
+        extensions,
     }: VCard4,
 ) -> Result<vcard4::Vcard, vcard4::Error> {
     let mut formatted_names = fn_.into_iter();
@@ -67,7 +68,17 @@ pub fn prose_xmpp_vcard4_to_vcard4_vcard(
         builder = builder.url(vcard4::Uri::from_str(&url.value)?);
     }
 
-    Ok(builder.finish())
+    let mut vcard = builder.finish();
+    for (name, value) in extensions.into_iter() {
+        vcard.extensions.push(ExtensionProperty {
+            name: name.to_ascii_uppercase(),
+            value: vcard4_properties::AnyProperty::Text(value),
+            group: Default::default(),
+            parameters: Default::default(),
+        });
+    }
+
+    Ok(vcard)
 }
 
 pub fn vcard4_vcard_to_prose_xmpp_vcard4(
@@ -84,6 +95,7 @@ pub fn vcard4_vcard_to_prose_xmpp_vcard4(
         role,
         org,
         note,
+        extensions,
         ..
     }: &vcard4::Vcard,
 ) -> Result<VCard4, vcard4::Error> {
@@ -157,6 +169,10 @@ pub fn vcard4_vcard_to_prose_xmpp_vcard4(
                 value: s.to_string(),
             })
             .collect(),
+        extensions: extensions
+            .iter()
+            .map(|p| (p.name.to_ascii_lowercase(), p.value.to_string()))
+            .collect(),
     })
 }
 

crates/rest-api/src/features/workspace_details/util/vcard4_mapping.rs

@@ -33,5 +33,5 @@ pub async fn set_workspace_accent_color_route(
     let color = workspace_service
         .set_workspace_accent_color(req.color)
         .await?;
-    Ok(Json(GetWorkspaceAccentColorResponse { color }))
+    Ok(Json(GetWorkspaceAccentColorResponse { color: Some(color) }))
 }

crates/rest-api/src/features/workspace_details/workspace_accent_color.rs

@@ -4,7 +4,7 @@
 // License: Mozilla Public License v2.0 (MPL v2.0)
 
 use prose_pod_api::features::init::*;
-use service::init::*;
+use service::workspace::Workspace;
 
 use super::prelude::*;
 
@@ -31,9 +31,10 @@ fn given_workspace_not_initialized(_world: &mut TestWorld) {
 
 #[given("the workspace has been initialized")]
 async fn given_workspace_initialized(world: &mut TestWorld) -> Result<(), Error> {
-    let form = WorkspaceCreateForm {
+    let workspace = Workspace {
         name: DEFAULT_WORKSPACE_NAME.to_string(),
         accent_color: None,
+        icon: None,
     };
 
     world
@@ -43,7 +44,7 @@ async fn given_workspace_initialized(world: &mut TestWorld) -> Result<(), Error>
             Arc::new(world.secrets_store.clone()),
             Arc::new(world.xmpp_service.clone()),
             &world.server_config().await?,
-            form,
+            workspace,
         )
         .await?;
 
@@ -118,7 +119,7 @@ async fn init_first_account(api: &TestServer, node: &JidNode, nickname: &String)
         .add_header(CONTENT_TYPE, "application/json")
         .json(&json!(InitFirstAccountRequest {
             username: node.to_owned(),
-            password: SecretString::new("test.password".to_string()).into(),
+            password: SecretString::from("test.password").into(),
             nickname: nickname.to_owned(),
         }))
         .await

crates/rest-api/tests/features/init.rs

@@ -25,7 +25,7 @@ async fn given_admin(world: &mut TestWorld, name: String) -> Result<(), Error> {
                 .create_user(
                     db,
                     &jid,
-                    &SecretString::new("password".to_owned()),
+                    &"password".into(),
                     &name,
                     &Some(MemberRole::Admin),
                 )
@@ -50,7 +50,7 @@ async fn given_not_admin(world: &mut TestWorld, name: String) -> Result<(), Erro
         .create_user(
             db,
             &jid,
-            &SecretString::new("password".to_owned()),
+            &"password".into(),
             &name,
             &Some(MemberRole::Member),
         )

crates/rest-api/tests/features/roles.rs

@@ -126,6 +126,21 @@ async fn then_workspace_icon_should_be(
     Ok(())
 }
 
+// WORKSPACE ACCENT COLOR
+
+#[given(expr = "the workspace accent color is {string}")]
+async fn given_workspace_accent_color(
+    world: &mut TestWorld,
+    accent_color: String,
+) -> Result<(), Error> {
+    world
+        .workspace_service()
+        .await
+        .set_workspace_accent_color(accent_color)
+        .await?;
+    Ok(())
+}
+
 // WORKSPACE VCARD
 
 api_call_fn!(
@@ -137,9 +152,10 @@ api_call_fn!(get_workspace_vcard, GET, "/v1/workspace", accept: "text/vcard");
 api_call_fn!(set_workspace_vcard, PUT, "/v1/workspace", content_type: "text/vcard");
 
 #[given(expr = "the workspace vCard is {string}")]
-async fn given_workspace_vcard(world: &mut TestWorld, vcard_data: String) -> Result<(), Error> {
+async fn given_workspace_vcard(world: &mut TestWorld, mut vcard_data: String) -> Result<(), Error> {
     let server_config = world.server_config().await?;
 
+    vcard_data = vcard_data.replace("\\n", "\n");
     let vcards = vcard4::parse(vcard_data).unwrap();
     let vcard = vcards.first().unwrap();
     let prose_xmpp_vcard4 = vcard4_vcard_to_prose_xmpp_vcard4(vcard).unwrap();
@@ -196,3 +212,18 @@ async fn then_workspace_vcard_should_be(
     assert_eq!(vcard.to_string(), vcard_data);
     Ok(())
 }
+
+#[then(expr = "the workspace vCard should contain {string}")]
+async fn then_workspace_vcard_should_contain(
+    world: &mut TestWorld,
+    pattern: String,
+) -> Result<(), Error> {
+    let prose_xmpp_vcard4 = world
+        .workspace_service()
+        .await
+        .get_workspace_vcard()
+        .await?;
+    let vcard = prose_xmpp_vcard4_to_vcard4_vcard(prose_xmpp_vcard4).unwrap();
+    assert!(vcard.to_string().contains(&pattern), "vcard={vcard}");
+    Ok(())
+}

crates/rest-api/tests/features/workspace_details.rs

@@ -47,7 +47,7 @@ impl MockAuthService {
     pub fn log_in_unchecked(&self, jid: &BareJid) -> Result<AuthToken, auth_service::Error> {
         let json = serde_json::to_string(&UserInfo { jid: jid.clone() }).unwrap();
         let base64 = Base64.encode(json);
-        let token = SecretString::new(base64);
+        let token = SecretString::from(base64);
 
         Ok(AuthToken(token))
     }

crates/rest-api/tests/prelude/mocks/mock_auth_service.rs

@@ -6,7 +6,6 @@
 use std::{
     collections::HashMap,
     path::Path,
-    str::FromStr as _,
     sync::{Arc, RwLock, RwLockReadGuard, RwLockWriteGuard},
 };
 
@@ -119,7 +118,6 @@ impl TestWorld {
 
     pub async fn workspace_service(&self) -> WorkspaceService {
         WorkspaceService::new(
-            Arc::new(self.db().clone()),
             Arc::new(self.xmpp_service.clone()),
             Arc::new(self.app_config.clone()),
             &self
@@ -198,7 +196,7 @@ impl TestWorld {
 impl TestWorld {
     async fn new() -> Self {
         // NOTE: Behavior tests don't need to read the environment, therefore we have to set the required variables.
-        let api_xmpp_password = SecretString::from_str("anything").unwrap();
+        let api_xmpp_password = SecretString::from("anything");
         std::env::set_var(
             "PROSE_BOOTSTRAP__PROSE_POD_API_XMPP_PASSWORD",
             &api_xmpp_password.expose_secret(),