feat(push): add experimental support for MSC3768 (in-app-only notifications)

Signed-off-by: Johannes Marbach <[email protected]>

Author: Johennes

Cargo.lock

@@ -26,6 +26,7 @@ crate-type = [
 [features]
 default = ["bundled-sqlite", "unstable-msc4274"]
 bundled-sqlite = ["matrix-sdk/bundled-sqlite"]
+unstable-msc3768 = ["matrix-sdk-ui/unstable-msc3768"]
 unstable-msc4274 = ["matrix-sdk-ui/unstable-msc4274"]
 # Required when targeting a Javascript environment, like Wasm in a browser.
 js = ["matrix-sdk-ui/js"]

bindings/matrix-sdk-ffi/Cargo.toml

@@ -322,8 +322,12 @@ impl TryFrom<Tweak> for SdkTweak {
 #[derive(Clone, uniffi::Enum)]
 /// Enum representing the push notification actions for a rule.
 pub enum Action {
-    /// Causes matching events to generate a notification.
+    /// Causes matching events to generate a notification (both in-app and
+    /// remote / push).
     Notify,
+    /// Causes matching events to generate an in-app notification but no remote
+    /// / push notification.
+    NotifyInApp,
     /// Sets an entry in the 'tweaks' dictionary sent to the push gateway.
     SetTweak { value: Tweak },
 }
@@ -334,6 +338,7 @@ impl TryFrom<SdkAction> for Action {
     fn try_from(value: SdkAction) -> Result<Self, Self::Error> {
         Ok(match value {
             SdkAction::Notify => Self::Notify,
+            SdkAction::NotifyInApp => Self::NotifyInApp,
             SdkAction::SetTweak(tweak) => Self::SetTweak {
                 value: tweak.try_into().map_err(|e| format!("Failed to convert tweak: {e}"))?,
             },
@@ -348,6 +353,7 @@ impl TryFrom<Action> for SdkAction {
     fn try_from(value: Action) -> Result<Self, Self::Error> {
         Ok(match value {
             Action::Notify => Self::Notify,
+            Action::NotifyInApp => Self::NotifyInApp,
             Action::SetTweak { value } => Self::SetTweak(
                 value.try_into().map_err(|e| format!("Failed to convert tweak: {e}"))?,
             ),

bindings/matrix-sdk-ffi/src/notification_settings.rs

@@ -19,6 +19,9 @@ rustls-tls = ["matrix-sdk/rustls-tls"]
 js = ["matrix-sdk/js"]
 uniffi = ["dep:uniffi", "matrix-sdk/uniffi", "matrix-sdk-base/uniffi"]
 
+# Add support for in-app only notifications
+unstable-msc3768 = ["matrix-sdk/unstable-msc3768"]
+
 # Add support for encrypted extensible events.
 unstable-msc3956 = ["ruma/unstable-msc3956"]
 
@@ -58,6 +61,7 @@ tracing = { workspace = true, features = ["attributes"] }
 unicode-normalization.workspace = true
 uniffi = { workspace = true, optional = true }
 
+cfg-if = "1.0.0"
 emojis = "0.6.4"
 unicode-segmentation = "1.12.0"
 

crates/matrix-sdk-ui/Cargo.toml

@@ -18,6 +18,7 @@ use std::{
     time::Duration,
 };
 
+use cfg_if::cfg_if;
 use futures_util::{StreamExt as _, pin_mut};
 use matrix_sdk::{
     Client, ClientBuildError, SlidingSyncList, SlidingSyncMode, room::Room, sleep::sleep,
@@ -677,7 +678,7 @@ impl NotificationClient {
 
             let should_notify = push_actions
                 .as_ref()
-                .is_some_and(|actions| actions.iter().any(|a| a.should_notify()));
+                .is_some_and(|actions| actions.iter().any(should_action_notify_remote));
 
             if !should_notify {
                 // The event has been filtered out by the user's push rules.
@@ -749,7 +750,7 @@ impl NotificationClient {
         }
 
         if let Some(actions) = timeline_event.push_actions()
-            && !actions.iter().any(|a| a.should_notify())
+            && !actions.iter().any(should_action_notify_remote)
         {
             return Ok(NotificationStatus::EventFilteredOut);
         }
@@ -771,6 +772,17 @@ impl NotificationClient {
     }
 }
 
+fn should_action_notify_remote(action: &Action) -> bool {
+    cfg_if! {
+        if #[cfg(feature = "unstable-msc3768")] {
+            action.should_notify_remote()
+        } else {
+            // Before MSC3768 only combined remote/local notifications existed
+            action.should_notify()
+        }
+    }
+}
+
 fn is_event_encrypted(event_type: TimelineEventType) -> bool {
     let is_still_encrypted = matches!(event_type, TimelineEventType::RoomEncrypted);
 

crates/matrix-sdk-ui/src/notification_client.rs

@@ -59,6 +59,9 @@ experimental-widgets = ["dep:uuid", "experimental-send-custom-to-device"]
 
 docsrs = ["e2e-encryption", "sqlite", "indexeddb", "sso-login", "qrcode"]
 
+# Add support for in-app only notifications
+unstable-msc3768 = ["ruma/unstable-msc3768"]
+
 # Add support for inline media galleries via msgtypes
 unstable-msc4274 = ["ruma/unstable-msc4274", "matrix-sdk-base/unstable-msc4274"]
 

crates/matrix-sdk/Cargo.toml

@@ -14,9 +14,9 @@ use crate::NotificationSettingsError;
 #[derive(Clone, Debug)]
 pub(crate) enum Command {
     /// Set a new `Room` push rule
-    SetRoomPushRule { room_id: OwnedRoomId, notify: bool },
+    SetRoomPushRule { room_id: OwnedRoomId, notify: Notify },
     /// Set a new `Override` push rule matching a `RoomId`
-    SetOverridePushRule { rule_id: String, room_id: OwnedRoomId, notify: bool },
+    SetOverridePushRule { rule_id: String, room_id: OwnedRoomId, notify: Notify },
     /// Set a new push rule for a keyword.
     SetKeywordPushRule { keyword: String },
     /// Set whether a push rule is enabled
@@ -29,21 +29,13 @@ pub(crate) enum Command {
     SetCustomPushRule { rule: NewPushRule },
 }
 
-fn get_notify_actions(notify: bool) -> Vec<Action> {
-    if notify {
-        vec![Action::Notify, Action::SetTweak(Tweak::Sound("default".into()))]
-    } else {
-        vec![]
-    }
-}
-
 impl Command {
     /// Tries to create a push rule corresponding to this command
     pub(crate) fn to_push_rule(&self) -> Result<NewPushRule, NotificationSettingsError> {
         match self {
             Self::SetRoomPushRule { room_id, notify } => {
                 // `Room` push rule for this `room_id`
-                let new_rule = NewSimplePushRule::new(room_id.clone(), get_notify_actions(*notify));
+                let new_rule = NewSimplePushRule::new(room_id.clone(), notify.get_actions());
                 Ok(NewPushRule::Room(new_rule))
             }
 
@@ -55,7 +47,7 @@ impl Command {
                         key: "room_id".to_owned(),
                         pattern: room_id.to_string(),
                     }],
-                    get_notify_actions(*notify),
+                    notify.get_actions(),
                 );
                 Ok(NewPushRule::Override(new_rule))
             }
@@ -65,7 +57,7 @@ impl Command {
                 let new_rule = NewPatternedPushRule::new(
                     keyword.clone(),
                     keyword.clone(),
-                    get_notify_actions(true),
+                    Notify::All.get_actions(),
                 );
                 Ok(NewPushRule::Content(new_rule))
             }
@@ -80,3 +72,28 @@ impl Command {
         }
     }
 }
+
+/// Enum describing if and how to deliver a notification.
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub(crate) enum Notify {
+    /// Generate a notification both in-app and remote / push.
+    All,
+
+    /// Only generate an in-app notification but no remote / push notification.
+    #[cfg(feature = "unstable-msc3768")]
+    InAppOnly,
+
+    /// Don't notify at all.
+    None
+}
+
+impl Notify {
+    fn get_actions(&self) -> Vec<Action> {
+        match self {
+            Self::All => vec![Action::Notify, Action::SetTweak(Tweak::Sound("default".into()))],
+            #[cfg(feature = "unstable-msc3768")]
+            Self::InAppOnly => vec![Action::NotifyInApp],
+            Self::None => vec![]
+        }
+    }
+}

crates/matrix-sdk/src/notification_settings/command.rs

@@ -40,8 +40,7 @@ mod rules;
 pub use matrix_sdk_base::notification_settings::RoomNotificationMode;
 
 use crate::{
-    config::RequestConfig, error::NotificationSettingsError, event_handler::EventHandlerDropGuard,
-    Client, Result,
+    config::RequestConfig, error::NotificationSettingsError, event_handler::EventHandlerDropGuard, notification_settings::command::Notify, Client, Result
 };
 
 /// Whether or not a room is encrypted
@@ -320,15 +319,15 @@ impl NotificationSettings {
         let (new_rule_kind, notify) = match mode {
             RoomNotificationMode::AllMessages => {
                 // insert a `Room` rule which notifies
-                (RuleKind::Room, true)
+                (RuleKind::Room, Notify::All)
             }
             RoomNotificationMode::MentionsAndKeywordsOnly => {
                 // insert a `Room` rule which doesn't notify
-                (RuleKind::Room, false)
+                (RuleKind::Room, Notify::None)
             }
             RoomNotificationMode::Mute => {
                 // insert an `Override` rule which doesn't notify
-                (RuleKind::Override, false)
+                (RuleKind::Override, Notify::None)
             }
         };
 

crates/matrix-sdk/src/notification_settings/mod.rs

@@ -7,7 +7,7 @@ use ruma::{
 };
 
 use super::command::Command;
-use crate::NotificationSettingsError;
+use crate::{notification_settings::command::Notify, NotificationSettingsError};
 
 /// A `RuleCommand` allows to generate a list of `Command` needed to modify a
 /// `Ruleset`
@@ -27,7 +27,7 @@ impl RuleCommands {
         &mut self,
         kind: RuleKind,
         room_id: &RoomId,
-        notify: bool,
+        notify: Notify,
     ) -> Result<(), NotificationSettingsError> {
         let command = match kind {
             RuleKind::Room => Command::SetRoomPushRule { room_id: room_id.to_owned(), notify },
@@ -210,7 +210,7 @@ mod tests {
     };
 
     use super::RuleCommands;
-    use crate::{error::NotificationSettingsError, notification_settings::command::Command};
+    use crate::{error::NotificationSettingsError, notification_settings::command::{Command, Notify}};
 
     fn get_server_default_ruleset() -> Ruleset {
         let user_id = UserId::parse("@user:matrix.org").unwrap();
@@ -225,7 +225,7 @@ mod tests {
     async fn test_insert_rule_room() {
         let room_id = get_test_room_id();
         let mut rule_commands = RuleCommands::new(get_server_default_ruleset());
-        rule_commands.insert_rule(RuleKind::Room, &room_id, true).unwrap();
+        rule_commands.insert_rule(RuleKind::Room, &room_id, Notify::All).unwrap();
 
         // A rule must have been inserted in the ruleset.
         assert!(rule_commands.rules.get(RuleKind::Room, &room_id).is_some());
@@ -235,7 +235,7 @@ mod tests {
         assert_matches!(&rule_commands.commands[0],
             Command::SetRoomPushRule { room_id: command_room_id, notify } => {
                 assert_eq!(command_room_id, &room_id);
-                assert!(notify);
+                assert_eq!(&Notify::All, notify);
             }
         );
     }
@@ -244,7 +244,7 @@ mod tests {
     async fn test_insert_rule_override() {
         let room_id = get_test_room_id();
         let mut rule_commands = RuleCommands::new(get_server_default_ruleset());
-        rule_commands.insert_rule(RuleKind::Override, &room_id, true).unwrap();
+        rule_commands.insert_rule(RuleKind::Override, &room_id, Notify::All).unwrap();
 
         // A rule must have been inserted in the ruleset.
         assert!(rule_commands.rules.get(RuleKind::Override, &room_id).is_some());
@@ -255,7 +255,7 @@ mod tests {
             Command::SetOverridePushRule {room_id: command_room_id, rule_id, notify } => {
                 assert_eq!(command_room_id, &room_id);
                 assert_eq!(rule_id, room_id.as_str());
-                assert!(notify);
+                assert_eq!(&Notify::All, notify);
             }
         );
     }
@@ -266,17 +266,17 @@ mod tests {
         let mut rule_commands = RuleCommands::new(get_server_default_ruleset());
 
         assert_matches!(
-            rule_commands.insert_rule(RuleKind::Underride, &room_id, true),
+            rule_commands.insert_rule(RuleKind::Underride, &room_id, Notify::All),
             Err(NotificationSettingsError::InvalidParameter(_)) => {}
         );
 
         assert_matches!(
-            rule_commands.insert_rule(RuleKind::Content, &room_id, true),
+            rule_commands.insert_rule(RuleKind::Content, &room_id, Notify::All),
             Err(NotificationSettingsError::InvalidParameter(_)) => {}
         );
 
         assert_matches!(
-            rule_commands.insert_rule(RuleKind::Sender, &room_id, true),
+            rule_commands.insert_rule(RuleKind::Sender, &room_id, Notify::All),
             Err(NotificationSettingsError::InvalidParameter(_)) => {}
         );
     }

crates/matrix-sdk/src/notification_settings/rule_commands.rs

@@ -330,8 +330,7 @@ pub(crate) mod tests {
     use crate::{
         error::NotificationSettingsError,
         notification_settings::{
-            rules::{self, Rules},
-            IsEncrypted, IsOneToOne, RoomNotificationMode,
+            command::Notify, rules::{self, Rules}, IsEncrypted, IsOneToOne, RoomNotificationMode
         },
     };
 
@@ -614,7 +613,7 @@ pub(crate) mod tests {
 
         // Build a `RuleCommands` inserting a rule
         let mut rules_commands = RuleCommands::new(rules.ruleset.clone());
-        rules_commands.insert_rule(RuleKind::Override, &room_id, false).unwrap();
+        rules_commands.insert_rule(RuleKind::Override, &room_id, Notify::None).unwrap();
 
         rules.apply(rules_commands);