Merge pull request #3203 from element-hq/feature/bma/clearNotificationWhenMarkAsRead

Clear existing notification when a room is marked as read

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/TestData.kt

@@ -48,6 +48,7 @@ val A_SPACE_ID = SpaceId("!aSpaceId:domain")
 val A_SPACE_ID_2 = SpaceId("!aSpaceId2:domain")
 val A_ROOM_ID = RoomId("!aRoomId:domain")
 val A_ROOM_ID_2 = RoomId("!aRoomId2:domain")
+val A_ROOM_ID_3 = RoomId("!aRoomId3:domain")
 val A_THREAD_ID = ThreadId("\$aThreadId")
 val A_THREAD_ID_2 = ThreadId("\$aThreadId2")
 val AN_EVENT_ID = EventId("\$anEventId")

libraries/push/api/src/main/kotlin/io/element/android/libraries/push/api/notifications/NotificationCleaner.kt

@@ -20,7 +20,7 @@ import io.element.android.libraries.matrix.api.core.EventId
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.SessionId
 
-interface NotificationDrawerManager {
+interface NotificationCleaner {
     fun clearAllMessagesEvents(sessionId: SessionId)
     fun clearMessagesForRoom(sessionId: SessionId, roomId: RoomId)
     fun clearEvent(sessionId: SessionId, eventId: EventId)

libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/di/PushBindsModule.kt

@@ -1,33 +0,0 @@
-/*
- * Copyright (c) 2023 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 io.element.android.libraries.push.impl.di
-
-import com.squareup.anvil.annotations.ContributesTo
-import dagger.Binds
-import dagger.Module
-import io.element.android.libraries.di.AppScope
-import io.element.android.libraries.push.api.notifications.NotificationDrawerManager
-import io.element.android.libraries.push.impl.notifications.DefaultNotificationDrawerManager
-
-@Module
-@ContributesTo(AppScope::class)
-abstract class PushBindsModule {
-    @Binds
-    abstract fun bindNotificationDrawerManager(
-        defaultNotificationDrawerManager: DefaultNotificationDrawerManager
-    ): NotificationDrawerManager
-}

libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/notifications/DefaultNotificationDrawerManager.kt

@@ -18,6 +18,7 @@ package io.element.android.libraries.push.impl.notifications
 
 import androidx.annotation.VisibleForTesting
 import androidx.core.app.NotificationManagerCompat
+import com.squareup.anvil.annotations.ContributesBinding
 import io.element.android.libraries.core.data.tryOrNull
 import io.element.android.libraries.core.log.logger.LoggerTag
 import io.element.android.libraries.di.AppScope
@@ -30,7 +31,7 @@ import io.element.android.libraries.matrix.api.core.SessionId
 import io.element.android.libraries.matrix.api.core.ThreadId
 import io.element.android.libraries.matrix.api.user.MatrixUser
 import io.element.android.libraries.matrix.ui.media.ImageLoaderHolder
-import io.element.android.libraries.push.api.notifications.NotificationDrawerManager
+import io.element.android.libraries.push.api.notifications.NotificationCleaner
 import io.element.android.libraries.push.api.notifications.NotificationIdProvider
 import io.element.android.libraries.push.impl.notifications.model.NotifiableEvent
 import io.element.android.libraries.push.impl.notifications.model.shouldIgnoreEventInRoom
@@ -46,11 +47,12 @@ import javax.inject.Inject
 private val loggerTag = LoggerTag("DefaultNotificationDrawerManager", LoggerTag.NotificationLoggerTag)
 
 /**
- * The NotificationDrawerManager receives notification events as they arrive (from event stream or fcm) and
+ * This class receives notification events as they arrive from the PushHandler calling [onNotifiableEventReceived] and
  * organise them in order to display them in the notification drawer.
  * Events can be grouped into the same notification, old (already read) events can be removed to do some cleaning.
  */
 @SingleIn(AppScope::class)
+@ContributesBinding(AppScope::class)
 class DefaultNotificationDrawerManager @Inject constructor(
     private val notificationManager: NotificationManagerCompat,
     private val notificationRenderer: NotificationRenderer,
@@ -59,7 +61,7 @@ class DefaultNotificationDrawerManager @Inject constructor(
     private val matrixClientProvider: MatrixClientProvider,
     private val imageLoaderHolder: ImageLoaderHolder,
     private val activeNotificationsProvider: ActiveNotificationsProvider,
-) : NotificationDrawerManager {
+) : NotificationCleaner {
     private var appNavigationStateObserver: Job? = null
 
     // TODO EAx add a setting per user for this

libraries/push/impl/src/main/kotlin/io/element/android/libraries/push/impl/notifications/NotificationBroadcastReceiverHandler.kt

@@ -28,7 +28,7 @@ import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.api.timeline.ReceiptType
 import io.element.android.libraries.preferences.api.store.SessionPreferencesStoreFactory
-import io.element.android.libraries.push.api.notifications.NotificationDrawerManager
+import io.element.android.libraries.push.api.notifications.NotificationCleaner
 import io.element.android.libraries.push.impl.R
 import io.element.android.libraries.push.impl.notifications.model.NotifiableMessageEvent
 import io.element.android.libraries.push.impl.push.OnNotifiableEventReceived
@@ -47,7 +47,7 @@ class NotificationBroadcastReceiverHandler @Inject constructor(
     private val appCoroutineScope: CoroutineScope,
     private val matrixClientProvider: MatrixClientProvider,
     private val sessionPreferencesStore: SessionPreferencesStoreFactory,
-    private val notificationDrawerManager: NotificationDrawerManager,
+    private val notificationCleaner: NotificationCleaner,
     private val actionIds: NotificationActionIds,
     private val systemClock: SystemClock,
     private val onNotifiableEventReceived: OnNotifiableEventReceived,
@@ -66,26 +66,26 @@ class NotificationBroadcastReceiverHandler @Inject constructor(
                 handleSmartReply(sessionId, roomId, threadId, intent)
             }
             actionIds.dismissRoom -> if (roomId != null) {
-                notificationDrawerManager.clearMessagesForRoom(sessionId, roomId)
+                notificationCleaner.clearMessagesForRoom(sessionId, roomId)
             }
             actionIds.dismissSummary ->
-                notificationDrawerManager.clearAllMessagesEvents(sessionId)
+                notificationCleaner.clearAllMessagesEvents(sessionId)
             actionIds.dismissInvite -> if (roomId != null) {
-                notificationDrawerManager.clearMembershipNotificationForRoom(sessionId, roomId)
+                notificationCleaner.clearMembershipNotificationForRoom(sessionId, roomId)
             }
             actionIds.dismissEvent -> if (eventId != null) {
-                notificationDrawerManager.clearEvent(sessionId, eventId)
+                notificationCleaner.clearEvent(sessionId, eventId)
             }
             actionIds.markRoomRead -> if (roomId != null) {
-                notificationDrawerManager.clearMessagesForRoom(sessionId, roomId)
+                notificationCleaner.clearMessagesForRoom(sessionId, roomId)
                 handleMarkAsRead(sessionId, roomId)
             }
             actionIds.join -> if (roomId != null) {
-                notificationDrawerManager.clearMembershipNotificationForRoom(sessionId, roomId)
+                notificationCleaner.clearMembershipNotificationForRoom(sessionId, roomId)
                 handleJoinRoom(sessionId, roomId)
             }
             actionIds.reject -> if (roomId != null) {
-                notificationDrawerManager.clearMembershipNotificationForRoom(sessionId, roomId)
+                notificationCleaner.clearMembershipNotificationForRoom(sessionId, roomId)
                 handleRejectRoom(sessionId, roomId)
             }
         }

libraries/push/impl/src/test/kotlin/io/element/android/libraries/push/impl/notifications/NotificationBroadcastReceiverHandlerTest.kt

@@ -40,11 +40,11 @@ import io.element.android.libraries.preferences.api.store.SessionPreferencesStor
 import io.element.android.libraries.preferences.api.store.SessionPreferencesStoreFactory
 import io.element.android.libraries.preferences.test.FakeSessionPreferencesStoreFactory
 import io.element.android.libraries.preferences.test.InMemorySessionPreferencesStore
-import io.element.android.libraries.push.api.notifications.NotificationDrawerManager
+import io.element.android.libraries.push.api.notifications.NotificationCleaner
 import io.element.android.libraries.push.impl.notifications.model.NotifiableEvent
 import io.element.android.libraries.push.impl.push.FakeOnNotifiableEventReceived
 import io.element.android.libraries.push.impl.push.OnNotifiableEventReceived
-import io.element.android.libraries.push.test.notifications.FakeNotificationDrawerManager
+import io.element.android.libraries.push.test.notifications.FakeNotificationCleaner
 import io.element.android.services.toolbox.api.strings.StringProvider
 import io.element.android.services.toolbox.api.systemclock.SystemClock
 import io.element.android.services.toolbox.test.strings.FakeStringProvider
@@ -90,11 +90,11 @@ class NotificationBroadcastReceiverHandlerTest {
     @Test
     fun `Test dismiss room`() = runTest {
         val clearMessagesForRoomLambda = lambdaRecorder<SessionId, RoomId, Unit> { _, _ -> }
-        val notificationDrawerManager = FakeNotificationDrawerManager(
+        val fakeNotificationCleaner = FakeNotificationCleaner(
             clearMessagesForRoomLambda = clearMessagesForRoomLambda,
         )
         val sut = createNotificationBroadcastReceiverHandler(
-            notificationDrawerManager = notificationDrawerManager
+            notificationCleaner = fakeNotificationCleaner
         )
         sut.onReceive(
             createIntent(
@@ -111,11 +111,11 @@ class NotificationBroadcastReceiverHandlerTest {
     @Test
     fun `Test dismiss summary`() = runTest {
         val clearAllMessagesEventsLambda = lambdaRecorder<SessionId, Unit> { _ -> }
-        val notificationDrawerManager = FakeNotificationDrawerManager(
+        val fakeNotificationCleaner = FakeNotificationCleaner(
             clearAllMessagesEventsLambda = clearAllMessagesEventsLambda,
         )
         val sut = createNotificationBroadcastReceiverHandler(
-            notificationDrawerManager = notificationDrawerManager
+            notificationCleaner = fakeNotificationCleaner
         )
         sut.onReceive(
             createIntent(
@@ -140,11 +140,11 @@ class NotificationBroadcastReceiverHandlerTest {
     @Test
     fun `Test dismiss Invite`() = runTest {
         val clearMembershipNotificationForRoomLambda = lambdaRecorder<SessionId, RoomId, Unit> { _, _ -> }
-        val notificationDrawerManager = FakeNotificationDrawerManager(
+        val fakeNotificationCleaner = FakeNotificationCleaner(
             clearMembershipNotificationForRoomLambda = clearMembershipNotificationForRoomLambda,
         )
         val sut = createNotificationBroadcastReceiverHandler(
-            notificationDrawerManager = notificationDrawerManager
+            notificationCleaner = fakeNotificationCleaner
         )
         sut.onReceive(
             createIntent(
@@ -170,11 +170,11 @@ class NotificationBroadcastReceiverHandlerTest {
     @Test
     fun `Test dismiss Event`() = runTest {
         val clearEventLambda = lambdaRecorder<SessionId, EventId, Unit> { _, _ -> }
-        val notificationDrawerManager = FakeNotificationDrawerManager(
+        val fakeNotificationCleaner = FakeNotificationCleaner(
             clearEventLambda = clearEventLambda,
         )
         val sut = createNotificationBroadcastReceiverHandler(
-            notificationDrawerManager = notificationDrawerManager
+            notificationCleaner = fakeNotificationCleaner
         )
         sut.onReceive(
             createIntent(
@@ -227,13 +227,13 @@ class NotificationBroadcastReceiverHandlerTest {
         )
         val clearMessagesForRoomLambda = lambdaRecorder<SessionId, RoomId, Unit> { _, _ -> }
         val matrixRoom = FakeMatrixRoom()
-        val notificationDrawerManager = FakeNotificationDrawerManager(
+        val fakeNotificationCleaner = FakeNotificationCleaner(
             clearMessagesForRoomLambda = clearMessagesForRoomLambda,
         )
         val sut = createNotificationBroadcastReceiverHandler(
             sessionPreferencesStore = sessionPreferencesStore,
             matrixRoom = matrixRoom,
-            notificationDrawerManager = notificationDrawerManager
+            notificationCleaner = fakeNotificationCleaner
         )
         sut.onReceive(
             createIntent(
@@ -262,12 +262,12 @@ class NotificationBroadcastReceiverHandlerTest {
     fun `Test join room`() = runTest {
         val joinRoom = lambdaRecorder<RoomId, Result<Unit>> { _ -> Result.success(Unit) }
         val clearMembershipNotificationForRoomLambda = lambdaRecorder<SessionId, RoomId, Unit> { _, _ -> }
-        val notificationDrawerManager = FakeNotificationDrawerManager(
+        val fakeNotificationCleaner = FakeNotificationCleaner(
             clearMembershipNotificationForRoomLambda = clearMembershipNotificationForRoomLambda,
         )
         val sut = createNotificationBroadcastReceiverHandler(
             joinRoom = joinRoom,
-            notificationDrawerManager = notificationDrawerManager,
+            notificationCleaner = fakeNotificationCleaner,
         )
         sut.onReceive(
             createIntent(
@@ -301,12 +301,12 @@ class NotificationBroadcastReceiverHandlerTest {
             leaveRoomLambda = leaveRoom
         }
         val clearMembershipNotificationForRoomLambda = lambdaRecorder<SessionId, RoomId, Unit> { _, _ -> }
-        val notificationDrawerManager = FakeNotificationDrawerManager(
+        val fakeNotificationCleaner = FakeNotificationCleaner(
             clearMembershipNotificationForRoomLambda = clearMembershipNotificationForRoomLambda,
         )
         val sut = createNotificationBroadcastReceiverHandler(
             matrixRoom = matrixRoom,
-            notificationDrawerManager = notificationDrawerManager
+            notificationCleaner = fakeNotificationCleaner
         )
         sut.onReceive(
             createIntent(
@@ -447,7 +447,7 @@ class NotificationBroadcastReceiverHandlerTest {
             joinRoomLambda = joinRoom
         },
         sessionPreferencesStore: SessionPreferencesStoreFactory = FakeSessionPreferencesStoreFactory(),
-        notificationDrawerManager: NotificationDrawerManager = FakeNotificationDrawerManager(),
+        notificationCleaner: NotificationCleaner = FakeNotificationCleaner(),
         systemClock: SystemClock = FakeSystemClock(),
         onNotifiableEventReceived: OnNotifiableEventReceived = FakeOnNotifiableEventReceived(),
         stringProvider: StringProvider = FakeStringProvider(),
@@ -463,7 +463,7 @@ class NotificationBroadcastReceiverHandlerTest {
                 }
             },
             sessionPreferencesStore = sessionPreferencesStore,
-            notificationDrawerManager = notificationDrawerManager,
+            notificationCleaner = notificationCleaner,
             actionIds = actionIds,
             systemClock = systemClock,
             onNotifiableEventReceived = onNotifiableEventReceived,

libraries/push/test/src/main/kotlin/io/element/android/libraries/push/test/notifications/FakeNotificationCleaner.kt

@@ -19,16 +19,16 @@ package io.element.android.libraries.push.test.notifications
 import io.element.android.libraries.matrix.api.core.EventId
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.SessionId
-import io.element.android.libraries.push.api.notifications.NotificationDrawerManager
+import io.element.android.libraries.push.api.notifications.NotificationCleaner
 import io.element.android.tests.testutils.lambda.lambdaError
 
-class FakeNotificationDrawerManager(
+class FakeNotificationCleaner(
     private val clearAllMessagesEventsLambda: (SessionId) -> Unit = { lambdaError() },
     private val clearMessagesForRoomLambda: (SessionId, RoomId) -> Unit = { _, _ -> lambdaError() },
     private val clearEventLambda: (SessionId, EventId) -> Unit = { _, _ -> lambdaError() },
     private val clearMembershipNotificationForSessionLambda: (SessionId) -> Unit = { lambdaError() },
     private val clearMembershipNotificationForRoomLambda: (SessionId, RoomId) -> Unit = { _, _ -> lambdaError() }
-) : NotificationDrawerManager {
+) : NotificationCleaner {
     override fun clearAllMessagesEvents(sessionId: SessionId) {
         clearAllMessagesEventsLambda(sessionId)
     }