Merge pull request #5482 from element-hq/feature/bma/improveAnnouncementService

Improve AnnouncementService.

Author: bmarty

features/announcement/api/src/main/kotlin/io/element/android/features/announcement/api/Announcement.kt

@@ -9,4 +9,5 @@ package io.element.android.features.announcement.api
 
 enum class Announcement {
     Space,
+    NewNotificationSound,
 }

features/announcement/api/src/main/kotlin/io/element/android/features/announcement/api/AnnouncementService.kt

@@ -9,10 +9,18 @@ package io.element.android.features.announcement.api
 
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
+import kotlinx.coroutines.flow.Flow
 
 interface AnnouncementService {
     suspend fun showAnnouncement(announcement: Announcement)
 
+    suspend fun onAnnouncementDismissed(announcement: Announcement)
+
+    fun announcementsToShowFlow(): Flow<List<Announcement>>
+
+    /**
+     * Use this composable to render the announcement UI in Fullscreen.
+     */
     @Composable
     fun Render(
         modifier: Modifier,

features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/AnnouncementPresenter.kt

@@ -12,6 +12,8 @@ import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.remember
 import dev.zacsweers.metro.Inject
+import io.element.android.features.announcement.api.Announcement
+import io.element.android.features.announcement.impl.store.AnnouncementStatus
 import io.element.android.features.announcement.impl.store.AnnouncementStore
 import io.element.android.libraries.architecture.Presenter
 import kotlinx.coroutines.flow.map
@@ -23,8 +25,8 @@ class AnnouncementPresenter(
     @Composable
     override fun present(): AnnouncementState {
         val showSpaceAnnouncement by remember {
-            announcementStore.spaceAnnouncementFlow().map {
-                it == AnnouncementStore.SpaceAnnouncement.Show
+            announcementStore.announcementStatusFlow(Announcement.Space).map {
+                it == AnnouncementStatus.Show
             }
         }.collectAsState(false)
         return AnnouncementState(

features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/DefaultAnnouncementService.kt

@@ -21,8 +21,11 @@ import io.element.android.features.announcement.api.Announcement
 import io.element.android.features.announcement.api.AnnouncementService
 import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementState
 import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementView
+import io.element.android.features.announcement.impl.store.AnnouncementStatus
 import io.element.android.features.announcement.impl.store.AnnouncementStore
 import io.element.android.libraries.architecture.Presenter
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.first
 
 @ContributesBinding(AppScope::class)
@@ -35,13 +38,36 @@ class DefaultAnnouncementService(
     override suspend fun showAnnouncement(announcement: Announcement) {
         when (announcement) {
             Announcement.Space -> showSpaceAnnouncement()
+            Announcement.NewNotificationSound -> {
+                announcementStore.setAnnouncementStatus(Announcement.NewNotificationSound, AnnouncementStatus.Show)
+            }
+        }
+    }
+
+    override suspend fun onAnnouncementDismissed(announcement: Announcement) {
+        announcementStore.setAnnouncementStatus(announcement, AnnouncementStatus.Shown)
+    }
+
+    override fun announcementsToShowFlow(): Flow<List<Announcement>> {
+        return combine(
+            announcementStore.announcementStatusFlow(Announcement.Space),
+            announcementStore.announcementStatusFlow(Announcement.NewNotificationSound),
+        ) { spaceAnnouncementStatus, newNotificationSoundStatus ->
+            buildList {
+                if (spaceAnnouncementStatus == AnnouncementStatus.Show) {
+                    add(Announcement.Space)
+                }
+                if (newNotificationSoundStatus == AnnouncementStatus.Show) {
+                    add(Announcement.NewNotificationSound)
+                }
+            }
         }
     }
 
     private suspend fun showSpaceAnnouncement() {
-        val currentValue = announcementStore.spaceAnnouncementFlow().first()
-        if (currentValue == AnnouncementStore.SpaceAnnouncement.NeverShown) {
-            announcementStore.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Show)
+        val currentValue = announcementStore.announcementStatusFlow(Announcement.Space).first()
+        if (currentValue == AnnouncementStatus.NeverShown) {
+            announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Show)
         }
     }
 

features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/spaces/SpaceAnnouncementPresenter.kt

@@ -10,8 +10,9 @@ package io.element.android.features.announcement.impl.spaces
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.rememberCoroutineScope
 import dev.zacsweers.metro.Inject
+import io.element.android.features.announcement.api.Announcement
+import io.element.android.features.announcement.impl.store.AnnouncementStatus
 import io.element.android.features.announcement.impl.store.AnnouncementStore
-import io.element.android.features.announcement.impl.store.AnnouncementStore.SpaceAnnouncement
 import io.element.android.libraries.architecture.Presenter
 import kotlinx.coroutines.launch
 
@@ -26,7 +27,7 @@ class SpaceAnnouncementPresenter(
         fun handleEvents(event: SpaceAnnouncementEvents) {
             when (event) {
                 SpaceAnnouncementEvents.Continue -> localCoroutineScope.launch {
-                    announcementStore.setSpaceAnnouncementValue(SpaceAnnouncement.Shown)
+                    announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Shown)
                 }
             }
         }

features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/AnnouncementStatus.kt

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.announcement.impl.store
+
+enum class AnnouncementStatus {
+    NeverShown,
+    Show,
+    Shown,
+}

features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/AnnouncementStore.kt

@@ -7,17 +7,18 @@
 
 package io.element.android.features.announcement.impl.store
 
+import io.element.android.features.announcement.api.Announcement
 import kotlinx.coroutines.flow.Flow
 
 interface AnnouncementStore {
-    suspend fun setSpaceAnnouncementValue(value: SpaceAnnouncement)
-    fun spaceAnnouncementFlow(): Flow<SpaceAnnouncement>
+    suspend fun setAnnouncementStatus(
+        announcement: Announcement,
+        status: AnnouncementStatus,
+    )
 
-    suspend fun reset()
+    fun announcementStatusFlow(
+        announcement: Announcement,
+    ): Flow<AnnouncementStatus>
 
-    enum class SpaceAnnouncement {
-        NeverShown,
-        Show,
-        Shown,
-    }
+    suspend fun reset()
 }

features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/DefaultAnnouncementStore.kt

@@ -12,11 +12,13 @@ import androidx.datastore.preferences.core.intPreferencesKey
 import dev.zacsweers.metro.AppScope
 import dev.zacsweers.metro.ContributesBinding
 import dev.zacsweers.metro.Inject
+import io.element.android.features.announcement.api.Announcement
 import io.element.android.libraries.preferences.api.store.PreferenceDataStoreFactory
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.map
 
 private val spaceAnnouncementKey = intPreferencesKey("spaceAnnouncement")
+private val newNotificationSoundKey = intPreferencesKey("newNotificationSound")
 
 @ContributesBinding(AppScope::class)
 @Inject
@@ -25,20 +27,32 @@ class DefaultAnnouncementStore(
 ) : AnnouncementStore {
     private val store = preferenceDataStoreFactory.create("elementx_announcement")
 
-    override suspend fun setSpaceAnnouncementValue(value: AnnouncementStore.SpaceAnnouncement) {
-        store.edit {
-            it[spaceAnnouncementKey] = value.ordinal
+    override suspend fun setAnnouncementStatus(announcement: Announcement, status: AnnouncementStatus) {
+        val key = announcement.toKey()
+        store.edit { prefs ->
+            prefs[key] = status.ordinal
         }
     }
 
-    override fun spaceAnnouncementFlow(): Flow<AnnouncementStore.SpaceAnnouncement> {
+    override fun announcementStatusFlow(announcement: Announcement): Flow<AnnouncementStatus> {
+        val key = announcement.toKey()
+        // For NewNotificationSound, a migration will set it to Show on application upgrade (see AppMigration08)
+        val defaultStatus = when (announcement) {
+            Announcement.Space -> AnnouncementStatus.NeverShown
+            Announcement.NewNotificationSound -> AnnouncementStatus.Shown
+        }
         return store.data.map { prefs ->
-            val ordinal = prefs[spaceAnnouncementKey] ?: AnnouncementStore.SpaceAnnouncement.NeverShown.ordinal
-            AnnouncementStore.SpaceAnnouncement.entries.getOrElse(ordinal) { AnnouncementStore.SpaceAnnouncement.NeverShown }
+            val ordinal = prefs[key] ?: defaultStatus.ordinal
+            AnnouncementStatus.entries.getOrElse(ordinal) { defaultStatus }
         }
     }
 
     override suspend fun reset() {
         store.edit { it.clear() }
     }
 }
+
+private fun Announcement.toKey() = when (this) {
+    Announcement.Space -> spaceAnnouncementKey
+    Announcement.NewNotificationSound -> newNotificationSoundKey
+}

features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/AnnouncementPresenterTest.kt

@@ -8,6 +8,8 @@
 package io.element.android.features.announcement.impl
 
 import com.google.common.truth.Truth.assertThat
+import io.element.android.features.announcement.api.Announcement
+import io.element.android.features.announcement.impl.store.AnnouncementStatus
 import io.element.android.features.announcement.impl.store.AnnouncementStore
 import io.element.android.features.announcement.impl.store.InMemoryAnnouncementStore
 import io.element.android.tests.testutils.test
@@ -33,10 +35,10 @@ class AnnouncementPresenterTest {
         presenter.test {
             val state = awaitItem()
             assertThat(state.showSpaceAnnouncement).isFalse()
-            store.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Show)
+            store.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Show)
             val updatedState = awaitItem()
             assertThat(updatedState.showSpaceAnnouncement).isTrue()
-            store.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Shown)
+            store.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Shown)
             val finalState = awaitItem()
             assertThat(finalState.showSpaceAnnouncement).isFalse()
         }

features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/DefaultAnnouncementServiceTest.kt

@@ -7,10 +7,12 @@
 
 package io.element.android.features.announcement.impl
 
+import app.cash.turbine.test
 import com.google.common.truth.Truth.assertThat
 import io.element.android.features.announcement.api.Announcement
 import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementState
 import io.element.android.features.announcement.impl.spaces.aSpaceAnnouncementState
+import io.element.android.features.announcement.impl.store.AnnouncementStatus
 import io.element.android.features.announcement.impl.store.AnnouncementStore
 import io.element.android.features.announcement.impl.store.InMemoryAnnouncementStore
 import io.element.android.libraries.architecture.Presenter
@@ -25,14 +27,49 @@ class DefaultAnnouncementServiceTest {
         val sut = createDefaultAnnouncementService(
             announcementStore = announcementStore,
         )
-        assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.NeverShown)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.NeverShown)
         sut.showAnnouncement(Announcement.Space)
-        assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.Show)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.Show)
         // Simulate user close the announcement
-        announcementStore.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Shown)
+        sut.onAnnouncementDismissed(Announcement.Space)
         // Entering again the space tab should not change the value
         sut.showAnnouncement(Announcement.Space)
-        assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.Shown)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.Shown)
+    }
+
+    @Test
+    fun `when showing NewNotificationSound announcement, announcement is set to show even if it was already shown`() = runTest {
+        val announcementStore = InMemoryAnnouncementStore()
+        val sut = createDefaultAnnouncementService(
+            announcementStore = announcementStore,
+        )
+        assertThat(announcementStore.announcementStatusFlow(Announcement.NewNotificationSound).first()).isEqualTo(AnnouncementStatus.NeverShown)
+        sut.showAnnouncement(Announcement.NewNotificationSound)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.NewNotificationSound).first()).isEqualTo(AnnouncementStatus.Show)
+        // Simulate user close the announcement
+        sut.onAnnouncementDismissed(Announcement.NewNotificationSound)
+        // Calling again showAnnouncement should set it back to Show
+        sut.showAnnouncement(Announcement.NewNotificationSound)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.NewNotificationSound).first()).isEqualTo(AnnouncementStatus.Show)
+    }
+
+    @Test
+    fun `test announcementsToShowFlow`() = runTest {
+        val announcementStore = InMemoryAnnouncementStore()
+        val sut = createDefaultAnnouncementService(
+            announcementStore = announcementStore,
+        )
+        sut.announcementsToShowFlow().test {
+            assertThat(awaitItem()).isEmpty()
+            announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Show)
+            assertThat(awaitItem()).containsExactly(Announcement.Space)
+            announcementStore.setAnnouncementStatus(Announcement.NewNotificationSound, AnnouncementStatus.Show)
+            assertThat(awaitItem()).containsExactly(Announcement.Space, Announcement.NewNotificationSound)
+            announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Shown)
+            assertThat(awaitItem()).containsExactly(Announcement.NewNotificationSound)
+            announcementStore.setAnnouncementStatus(Announcement.NewNotificationSound, AnnouncementStatus.Shown)
+            assertThat(awaitItem()).isEmpty()
+        }
     }
 
     private fun createDefaultAnnouncementService(