Introduce Announcement enum.

This commit is contained in:
Benoit Marty 2025-10-03 12:03:06 +02:00
parent 717932a111
commit 8eaf355301
7 changed files with 38 additions and 13 deletions

View file

@ -0,0 +1,12 @@
/*
* 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.api
enum class Announcement {
Space,
}

View file

@ -11,7 +11,7 @@ import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier import androidx.compose.ui.Modifier
interface AnnouncementService { interface AnnouncementService {
suspend fun onEnteringSpaceTab() suspend fun showAnnouncement(announcement: Announcement)
@Composable @Composable
fun Render( fun Render(

View file

@ -17,6 +17,7 @@ import androidx.compose.ui.Modifier
import dev.zacsweers.metro.AppScope import dev.zacsweers.metro.AppScope
import dev.zacsweers.metro.ContributesBinding import dev.zacsweers.metro.ContributesBinding
import dev.zacsweers.metro.Inject import dev.zacsweers.metro.Inject
import io.element.android.features.announcement.api.Announcement
import io.element.android.features.announcement.api.AnnouncementService 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.SpaceAnnouncementState
import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementView import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementView
@ -31,7 +32,13 @@ class DefaultAnnouncementService(
private val announcementPresenter: Presenter<AnnouncementState>, private val announcementPresenter: Presenter<AnnouncementState>,
private val spaceAnnouncementPresenter: Presenter<SpaceAnnouncementState>, private val spaceAnnouncementPresenter: Presenter<SpaceAnnouncementState>,
) : AnnouncementService { ) : AnnouncementService {
override suspend fun onEnteringSpaceTab() { override suspend fun showAnnouncement(announcement: Announcement) {
when (announcement) {
Announcement.Space -> showSpaceAnnouncement()
}
}
private suspend fun showSpaceAnnouncement() {
val currentValue = announcementStore.spaceAnnouncementFlow().first() val currentValue = announcementStore.spaceAnnouncementFlow().first()
if (currentValue == AnnouncementStore.SpaceAnnouncement.NeverShown) { if (currentValue == AnnouncementStore.SpaceAnnouncement.NeverShown) {
announcementStore.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Show) announcementStore.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Show)

View file

@ -8,6 +8,7 @@
package io.element.android.features.announcement.impl package io.element.android.features.announcement.impl
import com.google.common.truth.Truth.assertThat 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.SpaceAnnouncementState
import io.element.android.features.announcement.impl.spaces.aSpaceAnnouncementState import io.element.android.features.announcement.impl.spaces.aSpaceAnnouncementState
import io.element.android.features.announcement.impl.store.AnnouncementStore import io.element.android.features.announcement.impl.store.AnnouncementStore
@ -19,18 +20,18 @@ import org.junit.Test
class DefaultAnnouncementServiceTest { class DefaultAnnouncementServiceTest {
@Test @Test
fun `when entering space tab, space announcement is set to show only if it was never shown`() = runTest { fun `when showing Space announcement, space announcement is set to show only if it was never shown`() = runTest {
val announcementStore = InMemoryAnnouncementStore() val announcementStore = InMemoryAnnouncementStore()
val sut = createDefaultAnnouncementService( val sut = createDefaultAnnouncementService(
announcementStore = announcementStore, announcementStore = announcementStore,
) )
assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.NeverShown) assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.NeverShown)
sut.onEnteringSpaceTab() sut.showAnnouncement(Announcement.Space)
assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.Show) assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.Show)
// Simulate user close the announcement // Simulate user close the announcement
announcementStore.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Shown) announcementStore.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Shown)
// Entering again the space tab should not change the value // Entering again the space tab should not change the value
sut.onEnteringSpaceTab() sut.showAnnouncement(Announcement.Space)
assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.Shown) assertThat(announcementStore.spaceAnnouncementFlow().first()).isEqualTo(AnnouncementStore.SpaceAnnouncement.Shown)
} }

View file

@ -9,15 +9,16 @@ package io.element.android.features.rageshake.test.logs
import androidx.compose.runtime.Composable import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier import androidx.compose.ui.Modifier
import io.element.android.features.announcement.api.Announcement
import io.element.android.features.announcement.api.AnnouncementService import io.element.android.features.announcement.api.AnnouncementService
import io.element.android.tests.testutils.lambda.lambdaError import io.element.android.tests.testutils.lambda.lambdaError
class FakeAnnouncementService( class FakeAnnouncementService(
val onEnteringSpaceTabResult: () -> Unit = { lambdaError() }, val showAnnouncementResult: (Announcement) -> Unit = { lambdaError() },
val renderResult: (Modifier) -> Unit = { lambdaError() }, val renderResult: (Modifier) -> Unit = { lambdaError() },
) : AnnouncementService { ) : AnnouncementService {
override suspend fun onEnteringSpaceTab() { override suspend fun showAnnouncement(announcement: Announcement) {
onEnteringSpaceTabResult() showAnnouncementResult(announcement)
} }
@Composable @Composable

View file

@ -18,6 +18,7 @@ import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue import androidx.compose.runtime.setValue
import dev.zacsweers.metro.Inject import dev.zacsweers.metro.Inject
import io.element.android.features.announcement.api.Announcement
import io.element.android.features.announcement.api.AnnouncementService import io.element.android.features.announcement.api.AnnouncementService
import io.element.android.features.home.impl.roomlist.RoomListState import io.element.android.features.home.impl.roomlist.RoomListState
import io.element.android.features.home.impl.spaces.HomeSpacesState import io.element.android.features.home.impl.spaces.HomeSpacesState
@ -88,7 +89,7 @@ class HomePresenter(
when (event) { when (event) {
is HomeEvents.SelectHomeNavigationBarItem -> coroutineState.launch { is HomeEvents.SelectHomeNavigationBarItem -> coroutineState.launch {
if (event.item == HomeNavigationBarItem.Spaces) { if (event.item == HomeNavigationBarItem.Spaces) {
announcementService.onEnteringSpaceTab() announcementService.showAnnouncement(Announcement.Space)
} }
currentHomeNavigationBarItemOrdinal = event.item.ordinal currentHomeNavigationBarItemOrdinal = event.item.ordinal
} }

View file

@ -11,6 +11,7 @@ import app.cash.molecule.RecompositionMode
import app.cash.molecule.moleculeFlow import app.cash.molecule.moleculeFlow
import app.cash.turbine.test import app.cash.turbine.test
import com.google.common.truth.Truth.assertThat import com.google.common.truth.Truth.assertThat
import io.element.android.features.announcement.api.Announcement
import io.element.android.features.announcement.api.AnnouncementService import io.element.android.features.announcement.api.AnnouncementService
import io.element.android.features.home.impl.roomlist.aRoomListState import io.element.android.features.home.impl.roomlist.aRoomListState
import io.element.android.features.home.impl.spaces.HomeSpacesState import io.element.android.features.home.impl.spaces.HomeSpacesState
@ -40,6 +41,7 @@ import io.element.android.libraries.sessionstorage.test.aSessionData
import io.element.android.tests.testutils.MutablePresenter import io.element.android.tests.testutils.MutablePresenter
import io.element.android.tests.testutils.WarmUpRule import io.element.android.tests.testutils.WarmUpRule
import io.element.android.tests.testutils.lambda.lambdaRecorder import io.element.android.tests.testutils.lambda.lambdaRecorder
import io.element.android.tests.testutils.lambda.value
import io.element.android.tests.testutils.test import io.element.android.tests.testutils.test
import kotlinx.coroutines.flow.flowOf import kotlinx.coroutines.flow.flowOf
import kotlinx.coroutines.test.runTest import kotlinx.coroutines.test.runTest
@ -168,13 +170,13 @@ class HomePresenterTest {
@Test @Test
fun `present - NavigationBar change`() = runTest { fun `present - NavigationBar change`() = runTest {
val onEnteringSpaceTabResult = lambdaRecorder<Unit> { } val showAnnouncementResult = lambdaRecorder<Announcement, Unit> { }
val presenter = createHomePresenter( val presenter = createHomePresenter(
sessionStore = InMemorySessionStore( sessionStore = InMemorySessionStore(
updateUserProfileResult = { _, _, _ -> }, updateUserProfileResult = { _, _, _ -> },
), ),
announcementService = FakeAnnouncementService( announcementService = FakeAnnouncementService(
onEnteringSpaceTabResult = onEnteringSpaceTabResult, showAnnouncementResult = showAnnouncementResult,
) )
) )
moleculeFlow(RecompositionMode.Immediate) { moleculeFlow(RecompositionMode.Immediate) {
@ -185,7 +187,8 @@ class HomePresenterTest {
initialState.eventSink(HomeEvents.SelectHomeNavigationBarItem(HomeNavigationBarItem.Spaces)) initialState.eventSink(HomeEvents.SelectHomeNavigationBarItem(HomeNavigationBarItem.Spaces))
val finalState = awaitItem() val finalState = awaitItem()
assertThat(finalState.currentHomeNavigationBarItem).isEqualTo(HomeNavigationBarItem.Spaces) assertThat(finalState.currentHomeNavigationBarItem).isEqualTo(HomeNavigationBarItem.Spaces)
onEnteringSpaceTabResult.assertions().isCalledOnce() showAnnouncementResult.assertions().isCalledOnce()
.with(value(Announcement.Space))
} }
} }
@ -201,7 +204,7 @@ class HomePresenterTest {
), ),
homeSpacesPresenter = homeSpacesPresenter, homeSpacesPresenter = homeSpacesPresenter,
announcementService = FakeAnnouncementService( announcementService = FakeAnnouncementService(
onEnteringSpaceTabResult = {}, showAnnouncementResult = {},
) )
) )
presenter.test { presenter.test {