Merge pull request #5451 from element-hq/feature/bma/spaceAnnoucement

Space annoucement

Author: bmarty

appnav/build.gradle.kts

@@ -44,6 +44,7 @@ dependencies {
 
     implementation(libs.coil)
 
+    implementation(projects.features.announcement.api)
     implementation(projects.features.ftue.api)
     implementation(projects.features.share.api)
 

appnav/src/main/kotlin/io/element/android/appnav/RootFlowNode.kt

@@ -34,6 +34,7 @@ import io.element.android.appnav.intent.ResolvedIntent
 import io.element.android.appnav.root.RootNavStateFlowFactory
 import io.element.android.appnav.root.RootPresenter
 import io.element.android.appnav.root.RootView
+import io.element.android.features.announcement.api.AnnouncementService
 import io.element.android.features.login.api.LoginParams
 import io.element.android.features.login.api.accesscontrol.AccountProviderAccessControl
 import io.element.android.features.rageshake.api.bugreport.BugReportEntryPoint
@@ -64,7 +65,9 @@ import kotlinx.coroutines.launch
 import kotlinx.parcelize.Parcelize
 import timber.log.Timber
 
-@ContributesNode(AppScope::class) @AssistedInject class RootFlowNode(
+@ContributesNode(AppScope::class)
+@AssistedInject
+class RootFlowNode(
     @Assisted val buildContext: BuildContext,
     @Assisted plugins: List<Plugin>,
     private val sessionStore: SessionStore,
@@ -79,6 +82,7 @@ import timber.log.Timber
     private val oidcActionFlow: OidcActionFlow,
     private val bugReporter: BugReporter,
     private val featureFlagService: FeatureFlagService,
+    private val announcementService: AnnouncementService,
 ) : BaseFlowNode<RootFlowNode.NavTarget>(
     backstack = BackStack(
         initialElement = NavTarget.SplashScreen,
@@ -185,6 +189,7 @@ import timber.log.Timber
                 }
             }
             BackstackView(transitionHandler = transitionHandler)
+            announcementService.Render(Modifier)
         }
     }
 

features/announcement/api/build.gradle.kts

@@ -0,0 +1,13 @@
+/*
+ * 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.
+ */
+plugins {
+    id("io.element.android-compose-library")
+}
+
+android {
+    namespace = "io.element.android.features.announcement.api"
+}

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

@@ -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,
+}

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

@@ -0,0 +1,20 @@
+/*
+ * 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
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+
+interface AnnouncementService {
+    suspend fun showAnnouncement(announcement: Announcement)
+
+    @Composable
+    fun Render(
+        modifier: Modifier,
+    )
+}

features/announcement/impl/build.gradle.kts

@@ -0,0 +1,37 @@
+import extension.setupDependencyInjection
+import extension.testCommonDependencies
+
+/*
+ * 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.
+ */
+
+plugins {
+    id("io.element.android-compose-library")
+}
+
+android {
+    namespace = "io.element.android.features.announcement.impl"
+
+    testOptions {
+        unitTests {
+            isIncludeAndroidResources = true
+        }
+    }
+}
+
+setupDependencyInjection()
+
+dependencies {
+    implementation(projects.libraries.architecture)
+    implementation(projects.libraries.designsystem)
+    implementation(projects.libraries.preferences.api)
+    implementation(projects.libraries.uiStrings)
+    api(projects.features.announcement.api)
+    implementation(libs.androidx.datastore.preferences)
+
+    testCommonDependencies(libs, true)
+    testImplementation(projects.libraries.matrix.test)
+}

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

@@ -0,0 +1,34 @@
+/*
+ * 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
+
+import androidx.compose.runtime.Composable
+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.impl.store.AnnouncementStore
+import io.element.android.libraries.architecture.Presenter
+import kotlinx.coroutines.flow.map
+
+@Inject
+class AnnouncementPresenter(
+    private val announcementStore: AnnouncementStore,
+) : Presenter<AnnouncementState> {
+    @Composable
+    override fun present(): AnnouncementState {
+        val showSpaceAnnouncement by remember {
+            announcementStore.spaceAnnouncementFlow().map {
+                it == AnnouncementStore.SpaceAnnouncement.Show
+            }
+        }.collectAsState(false)
+        return AnnouncementState(
+            showSpaceAnnouncement = showSpaceAnnouncement,
+        )
+    }
+}

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

@@ -0,0 +1,18 @@
+/*
+ * 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
+
+data class AnnouncementState(
+    val showSpaceAnnouncement: Boolean,
+)
+
+fun anAnnouncementState(
+    showSpaceAnnouncement: Boolean = false,
+) = AnnouncementState(
+    showSpaceAnnouncement = showSpaceAnnouncement,
+)

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

@@ -0,0 +1,64 @@
+/*
+ * 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
+
+import androidx.compose.animation.AnimatedVisibility
+import androidx.compose.animation.fadeIn
+import androidx.compose.animation.fadeOut
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+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.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.AnnouncementStore
+import io.element.android.libraries.architecture.Presenter
+import kotlinx.coroutines.flow.first
+
+@ContributesBinding(AppScope::class)
+@Inject
+class DefaultAnnouncementService(
+    private val announcementStore: AnnouncementStore,
+    private val announcementPresenter: Presenter<AnnouncementState>,
+    private val spaceAnnouncementPresenter: Presenter<SpaceAnnouncementState>,
+) : AnnouncementService {
+    override suspend fun showAnnouncement(announcement: Announcement) {
+        when (announcement) {
+            Announcement.Space -> showSpaceAnnouncement()
+        }
+    }
+
+    private suspend fun showSpaceAnnouncement() {
+        val currentValue = announcementStore.spaceAnnouncementFlow().first()
+        if (currentValue == AnnouncementStore.SpaceAnnouncement.NeverShown) {
+            announcementStore.setSpaceAnnouncementValue(AnnouncementStore.SpaceAnnouncement.Show)
+        }
+    }
+
+    @Composable
+    override fun Render(modifier: Modifier) {
+        val announcementState = announcementPresenter.present()
+        Box(modifier = modifier.fillMaxSize()) {
+            AnimatedVisibility(
+                visible = announcementState.showSpaceAnnouncement,
+                enter = fadeIn(),
+                exit = fadeOut(),
+            ) {
+                val spaceAnnouncementState = spaceAnnouncementPresenter.present()
+                SpaceAnnouncementView(
+                    state = spaceAnnouncementState,
+                )
+            }
+        }
+    }
+}

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

@@ -0,0 +1,28 @@
+/*
+ * 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.di
+
+import dev.zacsweers.metro.AppScope
+import dev.zacsweers.metro.BindingContainer
+import dev.zacsweers.metro.Binds
+import dev.zacsweers.metro.ContributesTo
+import io.element.android.features.announcement.impl.AnnouncementPresenter
+import io.element.android.features.announcement.impl.AnnouncementState
+import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementPresenter
+import io.element.android.features.announcement.impl.spaces.SpaceAnnouncementState
+import io.element.android.libraries.architecture.Presenter
+
+@ContributesTo(AppScope::class)
+@BindingContainer
+interface AnnouncementModule {
+    @Binds
+    fun bindAnnouncementPresenter(presenter: AnnouncementPresenter): Presenter<AnnouncementState>
+
+    @Binds
+    fun bindSpaceAnnouncementPresenter(presenter: SpaceAnnouncementPresenter): Presenter<SpaceAnnouncementState>
+}