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

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

Author: Johennes

Cargo.lock

@@ -59,7 +59,7 @@ proptest = { version = "1.6.0", default-features = false, features = ["std"] }
 rand = "0.8.5"
 reqwest = { version = "0.12.12", default-features = false }
 rmp-serde = "1.3.0"
-ruma = { git = "https://github.com/ruma/ruma", rev = "de19ebaf71af620eb17abaefd92e43153f9d041d", features = [
+ruma = { git = "https://github.com/ruma/ruma", rev = "dd7b085424930c34323a60ef360194c27a61459c", features = [
     "client-api-c",
     "compat-upload-signatures",
     "compat-arbitrary-length-ids",
@@ -77,7 +77,7 @@ ruma = { git = "https://github.com/ruma/ruma", rev = "de19ebaf71af620eb17abaefd9
     "unstable-msc4278",
     "unstable-msc4286",
 ] }
-ruma-common = { git = "https://github.com/ruma/ruma", rev = "de19ebaf71af620eb17abaefd92e43153f9d041d" }
+ruma-common = { git = "https://github.com/ruma/ruma", rev = "dd7b085424930c34323a60ef360194c27a61459c" }
 sentry = "0.36.0"
 sentry-tracing = "0.36.0"
 serde = { version = "1.0.217", features = ["rc"] }

Cargo.toml

@@ -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 = ["ruma/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);