Splitting notifications into separate creation and displaying passes

tools/check/forbidden_strings_in_code.txt

@@ -160,7 +160,7 @@ Formatter\.formatShortFileSize===1
 # android\.text\.TextUtils
 
 ### This is not a rule, but a warning: the number of "enum class" has changed. For Json classes, it is mandatory that they have `@JsonClass(generateAdapter = false)`. If the enum is not used as a Json class, change the value in file forbidden_strings_in_code.txt
-enum class===106
+enum class===107
 
 ### Do not import temporary legacy classes
 import org.matrix.android.sdk.internal.legacy.riot===3

vector/src/main/java/im/vector/app/features/notifications/InviteNotifiableEvent.kt

@@ -29,7 +29,4 @@ data class InviteNotifiableEvent(
         val timestamp: Long,
         val soundName: String?,
         override val isRedacted: Boolean = false
-) : NotifiableEvent {
-
-    override var hasBeenDisplayed = false
-}
+) : NotifiableEvent

vector/src/main/java/im/vector/app/features/notifications/NotifiableEvent.kt

@@ -23,7 +23,6 @@ import java.io.Serializable
 sealed interface NotifiableEvent : Serializable {
     val eventId: String
     val editedEventId: String?
-    var hasBeenDisplayed: Boolean
 
     // Used to know if event should be replaced with the one coming from eventstream
     val canBeReplaced: Boolean

vector/src/main/java/im/vector/app/features/notifications/NotifiableEventProcessor.kt

@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2021 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.features.notifications
+
+import im.vector.app.features.invite.AutoAcceptInvites
+import im.vector.app.features.notifications.ProcessedEvent.Type.KEEP
+import im.vector.app.features.notifications.ProcessedEvent.Type.REMOVE
+import javax.inject.Inject
+
+private typealias ProcessedEvents = List<ProcessedEvent<NotifiableEvent>>
+
+class NotifiableEventProcessor @Inject constructor(
+        private val outdatedDetector: OutdatedEventDetector,
+        private val autoAcceptInvites: AutoAcceptInvites
+) {
+
+    fun process(queuedEvents: List<NotifiableEvent>, currentRoomId: String?, renderedEvents: ProcessedEvents): ProcessedEvents {
+        val processedEvents = queuedEvents.map {
+            val type = when (it) {
+                is InviteNotifiableEvent  -> if (autoAcceptInvites.hideInvites) REMOVE else KEEP
+                is NotifiableMessageEvent -> if (shouldIgnoreMessageEventInRoom(currentRoomId, it.roomId) || outdatedDetector.isMessageOutdated(it)) {
+                    REMOVE
+                } else KEEP
+                is SimpleNotifiableEvent  -> KEEP
+            }
+            ProcessedEvent(type, it)
+        }
+
+        val removedEventsDiff = renderedEvents.filter { renderedEvent ->
+            queuedEvents.none { it.eventId == renderedEvent.event.eventId }
+        }.map { ProcessedEvent(REMOVE, it.event) }
+
+        return removedEventsDiff + processedEvents
+    }
+
+    private fun shouldIgnoreMessageEventInRoom(currentRoomId: String?, roomId: String?): Boolean {
+        return currentRoomId != null && roomId == currentRoomId
+    }
+}

vector/src/main/java/im/vector/app/features/notifications/NotifiableMessageEvent.kt

@@ -39,8 +39,6 @@ data class NotifiableMessageEvent(
         override val isRedacted: Boolean = false
 ) : NotifiableEvent {
 
-    override var hasBeenDisplayed: Boolean = false
-
     val type: String = EventType.MESSAGE
     val description: String = body ?: ""
     val title: String = senderName ?: ""

vector/src/main/java/im/vector/app/features/notifications/NotificationDisplayer.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2021 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.features.notifications
+
+import android.app.Notification
+import android.content.Context
+import androidx.core.app.NotificationManagerCompat
+import timber.log.Timber
+import javax.inject.Inject
+
+class NotificationDisplayer @Inject constructor(context: Context) {
+
+    private val notificationManager = NotificationManagerCompat.from(context)
+
+    fun showNotificationMessage(tag: String?, id: Int, notification: Notification) {
+        notificationManager.notify(tag, id, notification)
+    }
+
+    fun cancelNotificationMessage(tag: String?, id: Int) {
+        notificationManager.cancel(tag, id)
+    }
+
+    fun cancelAllNotifications() {
+        // Keep this try catch (reported by GA)
+        try {
+            notificationManager.cancelAll()
+        } catch (e: Exception) {
+            Timber.e(e, "## cancelAllNotifications() failed")
+        }
+    }
+}