FF to enable filtering notifications by push rules (#1412)

* filtering notification by push rules

* changelog

* Apply suggestions from code review

Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>

---------

Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>

ElementX/Sources/Application/AppSettings.swift

@@ -190,6 +190,10 @@ final class AppSettings {
     @UserPreference(key: UserDefaultsKeys.pusherProfileTag, storageType: .userDefaults(store))
     var pusherProfileTag: String?
 
+    /// Allows notifications to be filtered based on the push context of the room
+    @UserPreference(key: SharedUserDefaultsKeys.filterNotificationsByPushRulesEnabled, defaultValue: false, storageType: .userDefaults(store))
+    var filterNotificationsByPushRulesEnabled
+        
     // MARK: - Other
     
     let permalinkBaseURL: URL = "https://matrix.to"

ElementX/Sources/Other/SharedUserDefaultsKeys.swift

@@ -15,5 +15,5 @@
 //
 
 enum SharedUserDefaultsKeys: String {
-    case isEncryptionSyncEnabled
+    case filterNotificationsByPushRulesEnabled
 }

ElementX/Sources/Screens/Settings/DeveloperOptionsScreen/DeveloperOptionsScreenModels.swift

@@ -49,6 +49,7 @@ protocol DeveloperOptionsProtocol: AnyObject {
     var notificationSettingsEnabled: Bool { get set }
     var swiftUITimelineEnabled: Bool { get set }
     var pollsInTimelineEnabled: Bool { get set }
+    var filterNotificationsByPushRulesEnabled: Bool { get set }
 }
 
 extension AppSettings: DeveloperOptionsProtocol { }

ElementX/Sources/Screens/Settings/DeveloperOptionsScreen/View/DeveloperOptionsScreen.swift

@@ -42,6 +42,10 @@ struct DeveloperOptionsScreen: View {
                 Toggle(isOn: $context.notificationSettingsEnabled) {
                     Text("Show notification settings")
                 }
+
+                Toggle(isOn: $context.filterNotificationsByPushRulesEnabled) {
+                    Text("Filter notifications by push rules")
+                }
             }
 
             Section("Room creation") {

NSE/Sources/NotificationServiceExtension.swift

@@ -71,7 +71,7 @@ class NotificationServiceExtension: UNNotificationServiceExtension {
         MXLog.info("\(tag) run with roomId: \(roomId), eventId: \(eventId)")
 
         do {
-            let userSession = try NSEUserSession(credentials: credentials)
+            let userSession = try NSEUserSession(credentials: credentials, filterByPushRulesEnabled: settings.filterNotificationsByPushRulesEnabled)
             self.userSession = userSession
             guard let itemProxy = await userSession.notificationItemProxy(roomID: roomId, eventID: eventId) else {
                 MXLog.info("\(tag) no notification for the event, discard")

NSE/Sources/Other/NSESettings.swift

@@ -21,4 +21,8 @@ final class NSESettings {
 
     /// UserDefaults to be used on reads and writes.
     private static var store: UserDefaults! = UserDefaults(suiteName: suiteName)
+
+    /// Allows notifications to be filtered based on the push context of the room
+    @UserPreference(key: SharedUserDefaultsKeys.filterNotificationsByPushRulesEnabled, defaultValue: false, storageType: .userDefaults(store))
+    var filterNotificationsByPushRulesEnabled
 }

NSE/Sources/Other/NSEUserSession.swift

@@ -25,7 +25,7 @@ final class NSEUserSession {
                                                                                imageCache: .onlyOnDisk,
                                                                                backgroundTaskService: nil)
 
-    init(credentials: KeychainCredentials) throws {
+    init(credentials: KeychainCredentials, filterByPushRulesEnabled: Bool) throws {
         userID = credentials.userID
         baseClient = try ClientBuilder()
             .basePath(path: URL.sessionsBaseDirectory.path)
@@ -34,10 +34,15 @@ final class NSEUserSession {
 
         try baseClient.restoreSession(session: credentials.restorationToken.session)
 
-        notificationClient = try baseClient
+        var notificationClientBuilder = try baseClient
             .notificationClient()
             .retryDecryption(withCrossProcessLock: true)
-            .finish()
+
+        if filterByPushRulesEnabled {
+            notificationClientBuilder = notificationClientBuilder.filterByPushRules()
+        }
+
+        notificationClient = notificationClientBuilder.finish()
     }
 
     func notificationItemProxy(roomID: String, eventID: String) async -> NotificationItemProxyProtocol? {

changelog.d/1172.bugfix

@@ -0,0 +1 @@
+Added an FF to enable push rules filtering. Also invitation notifications will now be always displayed reliably.