macltok

public

Star0

Fork 0

Watch0

75 commits 3 branches 0 tags 0 releases3.0 MiB

Commit `5b585cd970fd`

tarball

atagen <boss@atagen.co>2026-10-25 10:27 UTC

1 file changed+62-3

notifications: make keyword rules highlight

The sdk builds keyword content rules with only notify and a default sound, so a keyword never highlighted and the mentions inbox could not tell it from ordinary noise. add_notification_keyword now sets the actions Element uses for loud keywords through the push rule actions endpoint, and upgrades an existing rule for the pattern that lacks the highlight, which keeps the change out of the sdk fork.

Modified file: src/engine/commands.rs+62 additions−3 deletions@@ -4,10 +4,14 @@ use futures_util::FutureExt;
 use matrix_sdk::encryption::verification::VerificationRequest;
 use matrix_sdk::{
     Client,
-    notification_settings::{IsEncrypted, IsOneToOne, RoomNotificationMode as SdkMode},
+    notification_settings::{
+        IsEncrypted, IsOneToOne, NotificationSettings, RoomNotificationMode as SdkMode,
+    },
     ruma::{
         OwnedDeviceId, OwnedEventId, OwnedMxcUri, RoomId, TransactionId,
-        api::client::receipt::create_receipt::v3::ReceiptType, events::receipt::ReceiptThread,
+        api::client::{push::set_pushrule_actions, receipt::create_receipt::v3::ReceiptType},
+        events::receipt::ReceiptThread,
+        push::{Action, HighlightTweakValue, RuleKind, SoundTweakValue, Tweak},
     },
     send_queue::{LocalEchoContent, SendHandle},
 };
@@ -134,7 +138,12 @@ async fn notification(client: &Client, command: NotificationCommand) -> Result<(
                 )
                 .await
         }
-        NotificationCommand::AddKeyword(keyword) => settings.add_keyword(keyword).await,
+        NotificationCommand::AddKeyword(keyword) => {
+            match settings.add_keyword(keyword.clone()).await {
+                Ok(()) => return highlight_keyword(client, &settings, &keyword).await,
+                Err(error) => Err(error),
+            }
+        }
         NotificationCommand::RemoveKeyword(keyword) => settings.remove_keyword(&keyword).await,
     }
     .map_err(|source| {
@@ -146,6 +155,56 @@ async fn notification(client: &Client, command: NotificationCommand) -> Result<(
     })
 }
 
+/// sdk keyword rules carry only notify and a sound, while Element's loud keywords also
+/// highlight, which is what lets the inbox keep them as mentions
+async fn highlight_keyword(
+    client: &Client,
+    settings: &NotificationSettings,
+    keyword: &str,
+) -> Result<(), Error> {
+    let ruleset = settings.ruleset().await;
+    for rule in ruleset
+        .content
+        .iter()
+        .filter(|rule| !rule.default && rule.pattern == keyword)
+        .filter(|rule| !rule.actions.iter().any(Action::is_highlight))
+    {
+        client
+            .send(set_pushrule_actions::v3::Request::new(
+                RuleKind::Content,
+                rule.rule_id.clone(),
+                keyword_actions(&rule.actions),
+            ))
+            .await
+            .map_err(|source| {
+                Error::from_sdk("highlighting a notification keyword failed", source.into())
+            })?;
+    }
+    Ok(())
+}
+
+fn keyword_actions(existing: &[Action]) -> Vec<Action> {
+    let mut actions: Vec<_> = existing
+        .iter()
+        .filter(|action| !matches!(action, Action::SetTweak(Tweak::Highlight(_))))
+        .cloned()
+        .collect();
+    if !actions
+        .iter()
+        .any(|action| matches!(action, Action::Notify))
+    {
+        actions.insert(0, Action::Notify);
+    }
+    if !actions
+        .iter()
+        .any(|action| matches!(action, Action::SetTweak(Tweak::Sound(_))))
+    {
+        actions.push(Action::SetTweak(Tweak::Sound(SoundTweakValue::Default)));
+    }
+    actions.push(Action::SetTweak(Tweak::Highlight(HighlightTweakValue::Yes)));
+    actions
+}
+
 const fn sdk_mode(mode: RoomNotificationMode) -> SdkMode {
     match mode {
         RoomNotificationMode::AllMessages => SdkMode::AllMessages,

macltok

Commit 5b585cd970fd

Commit `5b585cd970fd`