Merge pull request #3995 from element-hq/feature/fga/requests_to_join_list

feat(knock_requests_list) : implement design

Author: ganfra

features/knockrequests/api/build.gradle.kts

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.features.knockrequests.api"
+}
+
+dependencies {
+    implementation(projects.libraries.architecture)
+    implementation(projects.libraries.matrix.api)
+}

features/knockrequests/api/src/main/kotlin/io/element/android/features/knockrequests/api/list/KnockRequestsListEntryPoint.kt

@@ -0,0 +1,12 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.features.knockrequests.api.list
+
+import io.element.android.libraries.architecture.SimpleFeatureEntryPoint
+
+interface KnockRequestsListEntryPoint : SimpleFeatureEntryPoint

features/knockrequests/impl/build.gradle.kts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+import extension.setupAnvil
+
+plugins {
+    id("io.element.android-compose-library")
+    id("kotlin-parcelize")
+}
+
+android {
+    namespace = "io.element.android.features.knockrequests.impl"
+}
+
+setupAnvil()
+
+dependencies {
+    api(projects.features.knockrequests.api)
+    implementation(projects.libraries.core)
+    implementation(projects.libraries.architecture)
+    implementation(projects.libraries.matrix.api)
+    implementation(projects.libraries.matrixui)
+    implementation(projects.libraries.uiStrings)
+    implementation(projects.libraries.designsystem)
+
+    testImplementation(libs.test.junit)
+    testImplementation(libs.coroutines.test)
+    testImplementation(libs.molecule.runtime)
+    testImplementation(libs.test.truth)
+    testImplementation(libs.test.turbine)
+    testImplementation(projects.libraries.matrix.test)
+}

features/knockrequests/impl/src/main/kotlin/io/element/android/features/knockrequests/impl/KnockRequest.kt

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.features.knockrequests.impl
+
+import io.element.android.libraries.designsystem.components.avatar.AvatarData
+import io.element.android.libraries.designsystem.components.avatar.AvatarSize
+import io.element.android.libraries.matrix.api.core.UserId
+
+data class KnockRequest(
+    val userId: UserId,
+    val displayName: String?,
+    val avatarUrl: String?,
+    val reason: String?,
+    val formattedDate: String?,
+)
+
+fun KnockRequest.getAvatarData(size: AvatarSize) = AvatarData(
+    id = userId.value,
+    name = displayName,
+    url = avatarUrl,
+    size = size,
+)
+
+fun KnockRequest.getBestName(): String {
+    return displayName?.takeIf { it.isNotEmpty() } ?: userId.value
+}

features/knockrequests/impl/src/main/kotlin/io/element/android/features/knockrequests/impl/list/DefaultKnockRequestsListEntryPoint.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.features.knockrequests.impl.list
+
+import com.bumble.appyx.core.modality.BuildContext
+import com.bumble.appyx.core.node.Node
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.features.knockrequests.api.list.KnockRequestsListEntryPoint
+import io.element.android.libraries.architecture.createNode
+import io.element.android.libraries.di.AppScope
+import javax.inject.Inject
+
+@ContributesBinding(AppScope::class)
+class DefaultKnockRequestsListEntryPoint @Inject constructor() : KnockRequestsListEntryPoint {
+    override fun createNode(parentNode: Node, buildContext: BuildContext): Node {
+        return parentNode.createNode<KnockRequestsListNode>(buildContext)
+    }
+}

features/knockrequests/impl/src/main/kotlin/io/element/android/features/knockrequests/impl/list/KnockRequestsListEvents.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.features.knockrequests.impl.list
+
+import io.element.android.features.knockrequests.impl.KnockRequest
+
+sealed interface KnockRequestsListEvents {
+    data class Accept(val knockRequest: KnockRequest) : KnockRequestsListEvents
+    data class Decline(val knockRequest: KnockRequest) : KnockRequestsListEvents
+    data class DeclineAndBan(val knockRequest: KnockRequest) : KnockRequestsListEvents
+    data object AcceptAll : KnockRequestsListEvents
+    data object DismissCurrentAction : KnockRequestsListEvents
+}

features/knockrequests/impl/src/main/kotlin/io/element/android/features/knockrequests/impl/list/KnockRequestsListNode.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.features.knockrequests.impl.list
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import com.bumble.appyx.core.modality.BuildContext
+import com.bumble.appyx.core.node.Node
+import com.bumble.appyx.core.plugin.Plugin
+import dagger.assisted.Assisted
+import dagger.assisted.AssistedInject
+import io.element.android.anvilannotations.ContributesNode
+import io.element.android.libraries.di.RoomScope
+
+@ContributesNode(RoomScope::class)
+class KnockRequestsListNode @AssistedInject constructor(
+    @Assisted buildContext: BuildContext,
+    @Assisted plugins: List<Plugin>,
+    private val presenter: KnockRequestsListPresenter,
+) : Node(buildContext, plugins = plugins) {
+    @Composable
+    override fun View(modifier: Modifier) {
+        val state = presenter.present()
+        KnockRequestsListView(
+            state = state,
+            onBackClick = ::navigateUp,
+            modifier = modifier
+        )
+    }
+}

features/knockrequests/impl/src/main/kotlin/io/element/android/features/knockrequests/impl/list/KnockRequestsListPresenter.kt

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.features.knockrequests.impl.list
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.collectAsState
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import io.element.android.libraries.architecture.AsyncAction
+import io.element.android.libraries.architecture.AsyncData
+import io.element.android.libraries.architecture.Presenter
+import io.element.android.libraries.matrix.api.room.MatrixRoom
+import io.element.android.libraries.matrix.ui.room.canBanAsState
+import io.element.android.libraries.matrix.ui.room.canInviteAsState
+import io.element.android.libraries.matrix.ui.room.canKickAsState
+import kotlinx.collections.immutable.persistentListOf
+import javax.inject.Inject
+
+class KnockRequestsListPresenter @Inject constructor(
+    private val room: MatrixRoom,
+) : Presenter<KnockRequestsListState> {
+    @Composable
+    override fun present(): KnockRequestsListState {
+        val currentAction = remember { mutableStateOf<KnockRequestsCurrentAction>(KnockRequestsCurrentAction.None) }
+        val syncUpdateFlow = room.syncUpdateFlow.collectAsState()
+        val canBan by room.canBanAsState(syncUpdateFlow.value)
+        val canDecline by room.canKickAsState(syncUpdateFlow.value)
+        val canAccept by room.canInviteAsState(syncUpdateFlow.value)
+
+        fun handleEvents(event: KnockRequestsListEvents) {
+            when (event) {
+                KnockRequestsListEvents.AcceptAll -> {
+                    currentAction.value = KnockRequestsCurrentAction.AcceptAll(AsyncAction.Uninitialized)
+                }
+                is KnockRequestsListEvents.Accept -> {
+                    currentAction.value = KnockRequestsCurrentAction.Accept(event.knockRequest, AsyncAction.Uninitialized)
+                }
+                is KnockRequestsListEvents.Decline -> {
+                    currentAction.value = KnockRequestsCurrentAction.Decline(event.knockRequest, AsyncAction.Uninitialized)
+                }
+                is KnockRequestsListEvents.DeclineAndBan -> {
+                    currentAction.value = KnockRequestsCurrentAction.DeclineAndBan(event.knockRequest, AsyncAction.Uninitialized)
+                }
+                KnockRequestsListEvents.DismissCurrentAction -> {
+                    currentAction.value = KnockRequestsCurrentAction.None
+                }
+            }
+        }
+
+        LaunchedEffect(currentAction) {
+            when (currentAction.value) {
+                is KnockRequestsCurrentAction.Accept -> {
+                    // Accept the knock request
+                }
+                is KnockRequestsCurrentAction.Decline -> {
+                    // Decline the knock request
+                }
+                is KnockRequestsCurrentAction.DeclineAndBan -> {
+                    // Decline and ban the user
+                }
+                is KnockRequestsCurrentAction.AcceptAll -> {
+                    // Accept all knock requests
+                }
+                KnockRequestsCurrentAction.None -> Unit
+            }
+        }
+
+        return KnockRequestsListState(
+            knockRequests = AsyncData.Success(persistentListOf()),
+            currentAction = currentAction.value,
+            canAccept = canAccept,
+            canDecline = canDecline,
+            canBan = canBan,
+            eventSink = ::handleEvents
+        )
+    }
+}

features/knockrequests/impl/src/main/kotlin/io/element/android/features/knockrequests/impl/list/KnockRequestsListState.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.features.knockrequests.impl.list
+
+import androidx.compose.runtime.Immutable
+import io.element.android.features.knockrequests.impl.KnockRequest
+import io.element.android.libraries.architecture.AsyncAction
+import io.element.android.libraries.architecture.AsyncData
+import kotlinx.collections.immutable.ImmutableList
+
+data class KnockRequestsListState(
+    val knockRequests: AsyncData<ImmutableList<KnockRequest>>,
+    val currentAction: KnockRequestsCurrentAction,
+    val canAccept: Boolean,
+    val canDecline: Boolean,
+    val canBan: Boolean,
+    val eventSink: (KnockRequestsListEvents) -> Unit,
+) {
+    val canAcceptAll = knockRequests is AsyncData.Success && knockRequests.data.size > 1
+}
+
+@Immutable
+sealed interface KnockRequestsCurrentAction {
+    data object None : KnockRequestsCurrentAction
+    data class Accept(val knockRequest: KnockRequest, val async: AsyncAction<Unit>) : KnockRequestsCurrentAction
+    data class Decline(val knockRequest: KnockRequest, val async: AsyncAction<Unit>) : KnockRequestsCurrentAction
+    data class DeclineAndBan(val knockRequest: KnockRequest, val async: AsyncAction<Unit>) : KnockRequestsCurrentAction
+    data class AcceptAll(val async: AsyncAction<Unit>) : KnockRequestsCurrentAction
+}