Extract AnnouncementStatus to its own file.

bmarty · bmarty · commit e31cc9b28b3e · 2025-10-08T11:30:49.000+02:00
diff --git a/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/AnnouncementPresenter.kt b/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/AnnouncementPresenter.kt
@@ -13,6 +13,7 @@ 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
@@ -25,7 +26,7 @@ class AnnouncementPresenter(
     override fun present(): AnnouncementState {
         val showSpaceAnnouncement by remember {
             announcementStore.announcementStatusFlow(Announcement.Space).map {
-                it == AnnouncementStore.AnnouncementStatus.Show
+                it == AnnouncementStatus.Show
             }
         }.collectAsState(false)
         return AnnouncementState(
diff --git a/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/DefaultAnnouncementService.kt b/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/DefaultAnnouncementService.kt
@@ -21,6 +21,7 @@ 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
@@ -38,13 +39,13 @@ class DefaultAnnouncementService(
         when (announcement) {
             Announcement.Space -> showSpaceAnnouncement()
             Announcement.NewNotificationSound -> {
-                announcementStore.setAnnouncementStatus(Announcement.NewNotificationSound, AnnouncementStore.AnnouncementStatus.Show)
+                announcementStore.setAnnouncementStatus(Announcement.NewNotificationSound, AnnouncementStatus.Show)
             }
         }
     }
 
     override suspend fun onAnnouncementDismissed(announcement: Announcement) {
-        announcementStore.setAnnouncementStatus(announcement, AnnouncementStore.AnnouncementStatus.Shown)
+        announcementStore.setAnnouncementStatus(announcement, AnnouncementStatus.Shown)
     }
 
     override fun announcementsToShowFlow(): Flow<List<Announcement>> {
@@ -53,10 +54,10 @@ class DefaultAnnouncementService(
             announcementStore.announcementStatusFlow(Announcement.NewNotificationSound),
         ) { spaceAnnouncementStatus, newNotificationSoundStatus ->
             buildList {
-                if (spaceAnnouncementStatus == AnnouncementStore.AnnouncementStatus.Show) {
+                if (spaceAnnouncementStatus == AnnouncementStatus.Show) {
                     add(Announcement.Space)
                 }
-                if (newNotificationSoundStatus == AnnouncementStore.AnnouncementStatus.Show) {
+                if (newNotificationSoundStatus == AnnouncementStatus.Show) {
                     add(Announcement.NewNotificationSound)
                 }
             }
@@ -65,8 +66,8 @@ class DefaultAnnouncementService(
 
     private suspend fun showSpaceAnnouncement() {
         val currentValue = announcementStore.announcementStatusFlow(Announcement.Space).first()
-        if (currentValue == AnnouncementStore.AnnouncementStatus.NeverShown) {
-            announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStore.AnnouncementStatus.Show)
+        if (currentValue == AnnouncementStatus.NeverShown) {
+            announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Show)
         }
     }
 
diff --git a/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/spaces/SpaceAnnouncementPresenter.kt b/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/spaces/SpaceAnnouncementPresenter.kt
@@ -11,8 +11,8 @@ 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.AnnouncementStatus
 import io.element.android.libraries.architecture.Presenter
 import kotlinx.coroutines.launch
 
diff --git a/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/AnnouncementStatus.kt b/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,
+}
diff --git a/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/AnnouncementStore.kt b/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/AnnouncementStore.kt
@@ -21,10 +21,4 @@ interface AnnouncementStore {
     ): Flow<AnnouncementStatus>
 
     suspend fun reset()
-
-    enum class AnnouncementStatus {
-        NeverShown,
-        Show,
-        Shown,
-    }
 }
diff --git a/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/DefaultAnnouncementStore.kt b/features/announcement/impl/src/main/kotlin/io/element/android/features/announcement/impl/store/DefaultAnnouncementStore.kt
@@ -27,23 +27,23 @@ class DefaultAnnouncementStore(
 ) : AnnouncementStore {
     private val store = preferenceDataStoreFactory.create("elementx_announcement")
 
-    override suspend fun setAnnouncementStatus(announcement: Announcement, status: AnnouncementStore.AnnouncementStatus) {
+    override suspend fun setAnnouncementStatus(announcement: Announcement, status: AnnouncementStatus) {
         val key = announcement.toKey()
         store.edit { prefs ->
             prefs[key] = status.ordinal
         }
     }
 
-    override fun announcementStatusFlow(announcement: Announcement): Flow<AnnouncementStore.AnnouncementStatus> {
+    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 -> AnnouncementStore.AnnouncementStatus.NeverShown
-            Announcement.NewNotificationSound -> AnnouncementStore.AnnouncementStatus.Shown
+            Announcement.Space -> AnnouncementStatus.NeverShown
+            Announcement.NewNotificationSound -> AnnouncementStatus.Shown
         }
         return store.data.map { prefs ->
             val ordinal = prefs[key] ?: defaultStatus.ordinal
-            AnnouncementStore.AnnouncementStatus.entries.getOrElse(ordinal) { defaultStatus }
+            AnnouncementStatus.entries.getOrElse(ordinal) { defaultStatus }
         }
     }
 
diff --git a/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/AnnouncementPresenterTest.kt b/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/AnnouncementPresenterTest.kt
@@ -9,6 +9,7 @@ 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
@@ -34,10 +35,10 @@ class AnnouncementPresenterTest {
         presenter.test {
             val state = awaitItem()
             assertThat(state.showSpaceAnnouncement).isFalse()
-            store.setAnnouncementStatus(Announcement.Space, AnnouncementStore.AnnouncementStatus.Show)
+            store.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Show)
             val updatedState = awaitItem()
             assertThat(updatedState.showSpaceAnnouncement).isTrue()
-            store.setAnnouncementStatus(Announcement.Space, AnnouncementStore.AnnouncementStatus.Shown)
+            store.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Shown)
             val finalState = awaitItem()
             assertThat(finalState.showSpaceAnnouncement).isFalse()
         }
diff --git a/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/DefaultAnnouncementServiceTest.kt b/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/DefaultAnnouncementServiceTest.kt
@@ -11,6 +11,7 @@ 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 +26,14 @@ class DefaultAnnouncementServiceTest {
         val sut = createDefaultAnnouncementService(
             announcementStore = announcementStore,
         )
-        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStore.AnnouncementStatus.NeverShown)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.NeverShown)
         sut.showAnnouncement(Announcement.Space)
-        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStore.AnnouncementStatus.Show)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.Show)
         // Simulate user close the announcement
         sut.onAnnouncementDismissed(Announcement.Space)
         // Entering again the space tab should not change the value
         sut.showAnnouncement(Announcement.Space)
-        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStore.AnnouncementStatus.Shown)
+        assertThat(announcementStore.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.Shown)
     }
 
     private fun createDefaultAnnouncementService(
diff --git a/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/spaces/SpaceAnnouncementPresenterTest.kt b/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/spaces/SpaceAnnouncementPresenterTest.kt
@@ -9,6 +9,7 @@ package io.element.android.features.announcement.impl.spaces
 
 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
@@ -24,10 +25,10 @@ class SpaceAnnouncementPresenterTest {
             announcementStore = store,
         )
         presenter.test {
-            assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStore.AnnouncementStatus.NeverShown)
+            assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.NeverShown)
             val state = awaitItem()
             state.eventSink(SpaceAnnouncementEvents.Continue)
-            assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStore.AnnouncementStatus.Shown)
+            assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.Shown)
         }
     }
 }
diff --git a/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/store/InMemoryAnnouncementStore.kt b/features/announcement/impl/src/test/kotlin/io/element/android/features/announcement/impl/store/InMemoryAnnouncementStore.kt
@@ -13,23 +13,23 @@ import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.asStateFlow
 
 class InMemoryAnnouncementStore(
-    initialSpaceAnnouncementStatus: AnnouncementStore.AnnouncementStatus = AnnouncementStore.AnnouncementStatus.NeverShown,
-    initialNewNotificationSoundAnnouncementStatus: AnnouncementStore.AnnouncementStatus = AnnouncementStore.AnnouncementStatus.NeverShown,
+    initialSpaceAnnouncementStatus: AnnouncementStatus = AnnouncementStatus.NeverShown,
+    initialNewNotificationSoundAnnouncementStatus: AnnouncementStatus = AnnouncementStatus.NeverShown,
 ) : AnnouncementStore {
     private val spaceAnnouncement = MutableStateFlow(initialSpaceAnnouncementStatus)
     private val newNotificationSoundAnnouncement = MutableStateFlow(initialNewNotificationSoundAnnouncementStatus)
 
-    override suspend fun setAnnouncementStatus(announcement: Announcement, status: AnnouncementStore.AnnouncementStatus) {
+    override suspend fun setAnnouncementStatus(announcement: Announcement, status: AnnouncementStatus) {
         announcement.toMutableStateFlow().value = status
     }
 
-    override fun announcementStatusFlow(announcement: Announcement): Flow<AnnouncementStore.AnnouncementStatus> {
+    override fun announcementStatusFlow(announcement: Announcement): Flow<AnnouncementStatus> {
         return announcement.toMutableStateFlow().asStateFlow()
     }
 
     override suspend fun reset() {
-        spaceAnnouncement.value = AnnouncementStore.AnnouncementStatus.NeverShown
-        newNotificationSoundAnnouncement.value = AnnouncementStore.AnnouncementStatus.NeverShown
+        spaceAnnouncement.value = AnnouncementStatus.NeverShown
+        newNotificationSoundAnnouncement.value = AnnouncementStatus.NeverShown
     }
 
     private fun Announcement.toMutableStateFlow() = when (this) {

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import io.element.android.features.announcement.api.Announcement`
`21`	`21`	`import io.element.android.features.announcement.api.AnnouncementService`
`22`	`22`	`import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementState`
`23`	`23`	`import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementView`
	`24`	`+import io.element.android.features.announcement.impl.store.AnnouncementStatus`
`24`	`25`	`import io.element.android.features.announcement.impl.store.AnnouncementStore`
`25`	`26`	`import io.element.android.libraries.architecture.Presenter`
`26`	`27`	`import kotlinx.coroutines.flow.Flow`
`@@ -38,13 +39,13 @@ class DefaultAnnouncementService(`
`38`	`39`	`when (announcement) {`
`39`	`40`	`Announcement.Space -> showSpaceAnnouncement()`
`40`	`41`	`Announcement.NewNotificationSound -> {`
`41`		`- announcementStore.setAnnouncementStatus(Announcement.NewNotificationSound, AnnouncementStore.AnnouncementStatus.Show)`
	`42`	`+ announcementStore.setAnnouncementStatus(Announcement.NewNotificationSound, AnnouncementStatus.Show)`
`42`	`43`	`}`
`43`	`44`	`}`
`44`	`45`	`}`
`45`	`46`
`46`	`47`	`override suspend fun onAnnouncementDismissed(announcement: Announcement) {`
`47`		`- announcementStore.setAnnouncementStatus(announcement, AnnouncementStore.AnnouncementStatus.Shown)`
	`48`	`+ announcementStore.setAnnouncementStatus(announcement, AnnouncementStatus.Shown)`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`override fun announcementsToShowFlow(): Flow<List<Announcement>> {`
`@@ -53,10 +54,10 @@ class DefaultAnnouncementService(`
`53`	`54`	`announcementStore.announcementStatusFlow(Announcement.NewNotificationSound),`
`54`	`55`	`) { spaceAnnouncementStatus, newNotificationSoundStatus ->`
`55`	`56`	`buildList {`
`56`		`- if (spaceAnnouncementStatus == AnnouncementStore.AnnouncementStatus.Show) {`
	`57`	`+ if (spaceAnnouncementStatus == AnnouncementStatus.Show) {`
`57`	`58`	`add(Announcement.Space)`
`58`	`59`	`}`
`59`		`- if (newNotificationSoundStatus == AnnouncementStore.AnnouncementStatus.Show) {`
	`60`	`+ if (newNotificationSoundStatus == AnnouncementStatus.Show) {`
`60`	`61`	`add(Announcement.NewNotificationSound)`
`61`	`62`	`}`
`62`	`63`	`}`
`@@ -65,8 +66,8 @@ class DefaultAnnouncementService(`
`65`	`66`
`66`	`67`	`private suspend fun showSpaceAnnouncement() {`
`67`	`68`	`val currentValue = announcementStore.announcementStatusFlow(Announcement.Space).first()`
`68`		`- if (currentValue == AnnouncementStore.AnnouncementStatus.NeverShown) {`
`69`		`- announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStore.AnnouncementStatus.Show)`
	`69`	`+ if (currentValue == AnnouncementStatus.NeverShown) {`
	`70`	`+ announcementStore.setAnnouncementStatus(Announcement.Space, AnnouncementStatus.Show)`
`70`	`71`	`}`
`71`	`72`	`}`
`72`	`73`
Original file line number	Diff line number	Diff line change
`@@ -27,23 +27,23 @@ class DefaultAnnouncementStore(`
`27`	`27`	`) : AnnouncementStore {`
`28`	`28`	`private val store = preferenceDataStoreFactory.create("elementx_announcement")`
`29`	`29`
`30`		`- override suspend fun setAnnouncementStatus(announcement: Announcement, status: AnnouncementStore.AnnouncementStatus) {`
	`30`	`+ override suspend fun setAnnouncementStatus(announcement: Announcement, status: AnnouncementStatus) {`
`31`	`31`	`val key = announcement.toKey()`
`32`	`32`	`store.edit { prefs ->`
`33`	`33`	`prefs[key] = status.ordinal`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`
`37`		`- override fun announcementStatusFlow(announcement: Announcement): Flow<AnnouncementStore.AnnouncementStatus> {`
	`37`	`+ override fun announcementStatusFlow(announcement: Announcement): Flow<AnnouncementStatus> {`
`38`	`38`	`val key = announcement.toKey()`
`39`	`39`	`// For NewNotificationSound, a migration will set it to Show on application upgrade (see AppMigration08)`
`40`	`40`	`val defaultStatus = when (announcement) {`
`41`		`- Announcement.Space -> AnnouncementStore.AnnouncementStatus.NeverShown`
`42`		`- Announcement.NewNotificationSound -> AnnouncementStore.AnnouncementStatus.Shown`
	`41`	`+ Announcement.Space -> AnnouncementStatus.NeverShown`
	`42`	`+ Announcement.NewNotificationSound -> AnnouncementStatus.Shown`
`43`	`43`	`}`
`44`	`44`	`return store.data.map { prefs ->`
`45`	`45`	`val ordinal = prefs[key] ?: defaultStatus.ordinal`
`46`		`- AnnouncementStore.AnnouncementStatus.entries.getOrElse(ordinal) { defaultStatus }`
	`46`	`+ AnnouncementStatus.entries.getOrElse(ordinal) { defaultStatus }`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ package io.element.android.features.announcement.impl.spaces`
`9`	`9`
`10`	`10`	`import com.google.common.truth.Truth.assertThat`
`11`	`11`	`import io.element.android.features.announcement.api.Announcement`
	`12`	`+import io.element.android.features.announcement.impl.store.AnnouncementStatus`
`12`	`13`	`import io.element.android.features.announcement.impl.store.AnnouncementStore`
`13`	`14`	`import io.element.android.features.announcement.impl.store.InMemoryAnnouncementStore`
`14`	`15`	`import io.element.android.tests.testutils.test`
`@@ -24,10 +25,10 @@ class SpaceAnnouncementPresenterTest {`
`24`	`25`	`announcementStore = store,`
`25`	`26`	`)`
`26`	`27`	`presenter.test {`
`27`		`- assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStore.AnnouncementStatus.NeverShown)`
	`28`	`+ assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.NeverShown)`
`28`	`29`	`val state = awaitItem()`
`29`	`30`	`state.eventSink(SpaceAnnouncementEvents.Continue)`
`30`		`- assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStore.AnnouncementStatus.Shown)`
	`31`	`+ assertThat(store.announcementStatusFlow(Announcement.Space).first()).isEqualTo(AnnouncementStatus.Shown)`
`31`	`32`	`}`
`32`	`33`	`}`
`33`	`34`	`}`