Copy user-id/room-alias to clipboard on click

Make user id and room alias text in room/user view pages clickable and copy the text to the clipboard on click. Fixes #3496 Signed-off-by: Joe Groocock <[email protected]>
element-hq · Sep 23, 2024 · 21a9c39 · 21a9c39
1 parent cc1cee8
commit 21a9c39
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 10 deletions.
diff --git a/...ils/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsEvent.kt b/...ils/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsEvent.kt
@@ -11,5 +11,6 @@ sealed interface RoomDetailsEvent {
     data object LeaveRoom : RoomDetailsEvent
     data object MuteNotification : RoomDetailsEvent
     data object UnmuteNotification : RoomDetailsEvent
+    data class CopyID(val text: String) : RoomDetailsEvent
     data class SetFavorite(val isFavorite: Boolean) : RoomDetailsEvent
 }
diff --git a/...impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsPresenter.kt b/...impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsPresenter.kt
@@ -22,9 +22,12 @@ import io.element.android.features.leaveroom.api.LeaveRoomEvent
 import io.element.android.features.leaveroom.api.LeaveRoomPresenter
 import io.element.android.features.messages.api.pinned.IsPinnedMessagesFeatureEnabled
 import io.element.android.features.roomdetails.impl.members.details.RoomMemberDetailsPresenter
+import io.element.android.libraries.androidutils.clipboard.ClipboardHelper
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.core.bool.orFalse
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarMessage
 import io.element.android.libraries.featureflag.api.FeatureFlagService
 import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.matrix.api.MatrixClient
@@ -41,6 +44,7 @@ import io.element.android.libraries.matrix.ui.room.canCall
 import io.element.android.libraries.matrix.ui.room.getCurrentRoomMember
 import io.element.android.libraries.matrix.ui.room.getDirectRoomMember
 import io.element.android.libraries.matrix.ui.room.isOwnUserAdmin
+import io.element.android.libraries.ui.strings.CommonStrings
 import io.element.android.services.analytics.api.AnalyticsService
 import io.element.android.services.analyticsproviders.api.trackers.captureInteraction
 import kotlinx.collections.immutable.toPersistentList
@@ -60,6 +64,8 @@ class RoomDetailsPresenter @Inject constructor(
     private val dispatchers: CoroutineDispatchers,
     private val analyticsService: AnalyticsService,
     private val isPinnedMessagesFeatureEnabled: IsPinnedMessagesFeatureEnabled,
+    private val clipboardHelper: ClipboardHelper,
+    private val snackbarDispatcher: SnackbarDispatcher,
 ) : Presenter<RoomDetailsState> {
     @Composable
     override fun present(): RoomDetailsState {
@@ -126,6 +132,12 @@ class RoomDetailsPresenter @Inject constructor(
                         client.notificationSettingsService().unmuteRoom(room.roomId, room.isEncrypted, room.isOneToOne)
                     }
                 }
+                is RoomDetailsEvent.CopyID -> {
+                    scope.launch(dispatchers.io) {
+                        clipboardHelper.copyPlainText(event.text)
+                        snackbarDispatcher.post(SnackbarMessage(CommonStrings.common_copied_to_clipboard))
+                    }
+                }
                 is RoomDetailsEvent.SetFavorite -> scope.setFavorite(event.isFavorite)
             }
         }

diff --git a/...ails/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsView.kt b/...ails/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsView.kt
@@ -20,6 +20,7 @@ import androidx.compose.foundation.layout.height
 import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.layout.size
 import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.shape.RoundedCornerShape
 import androidx.compose.foundation.verticalScroll
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.filled.MoreVert
@@ -33,6 +34,7 @@ import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.draw.clip
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.tooling.preview.PreviewParameter
@@ -128,6 +130,9 @@ fun RoomDetailsView(
                         openAvatarPreview = { avatarUrl ->
                             openAvatarPreview(state.roomName, avatarUrl)
                         },
+                        onSubtitleClick = { subtitle ->
+                            state.eventSink(RoomDetailsEvent.CopyID(subtitle))
+                        },
                     )
                 }
                 is RoomDetailsType.Dm -> {
@@ -138,6 +143,9 @@ fun RoomDetailsView(
                         openAvatarPreview = { name, avatarUrl ->
                             openAvatarPreview(name, avatarUrl)
                         },
+                        onSubtitleClick = { subtitle ->
+                            state.eventSink(RoomDetailsEvent.CopyID(subtitle))
+                        },
                     )
                 }
             }
@@ -327,6 +335,7 @@ private fun RoomHeaderSection(
     roomAlias: RoomAlias?,
     heroes: ImmutableList<MatrixUser>,
     openAvatarPreview: (url: String) -> Unit,
+    onSubtitleClick: (String) -> Unit,
 ) {
     Column(
         modifier = Modifier
@@ -343,7 +352,11 @@ private fun RoomHeaderSection(
                 .clickable(enabled = avatarUrl != null) { openAvatarPreview(avatarUrl!!) }
                 .testTag(TestTags.roomDetailAvatar)
         )
-        TitleAndSubtitle(title = roomName, subtitle = roomAlias?.value)
+        TitleAndSubtitle(
+            title = roomName,
+            subtitle = roomAlias?.value,
+            onSubtitleClick = onSubtitleClick,
+        )
     }
 }
 
@@ -353,6 +366,7 @@ private fun DmHeaderSection(
     otherMember: RoomMember,
     roomName: String,
     openAvatarPreview: (name: String, url: String) -> Unit,
+    onSubtitleClick: (String) -> Unit,
     modifier: Modifier = Modifier
 ) {
     Column(
@@ -370,6 +384,7 @@ private fun DmHeaderSection(
         TitleAndSubtitle(
             title = roomName,
             subtitle = otherMember.userId.value,
+            onSubtitleClick = onSubtitleClick,
         )
     }
 }
@@ -378,6 +393,7 @@ private fun DmHeaderSection(
 private fun ColumnScope.TitleAndSubtitle(
     title: String,
     subtitle: String?,
+    onSubtitleClick: (String) -> Unit,
 ) {
     Spacer(modifier = Modifier.height(24.dp))
     Text(
@@ -388,6 +404,10 @@ private fun ColumnScope.TitleAndSubtitle(
     if (subtitle != null) {
         Spacer(modifier = Modifier.height(6.dp))
         Text(
+            modifier = Modifier
+                .clip(RoundedCornerShape(4.dp))
+                .clickable { onSubtitleClick(subtitle) }
+                .padding(horizontal = 4.dp),
             text = subtitle,
             style = ElementTheme.typography.fontBodyLgRegular,
             color = MaterialTheme.colorScheme.secondary,

diff --git a/.../impl/src/main/kotlin/io/element/android/features/roomdetails/impl/di/RoomMemberModule.kt b/.../impl/src/main/kotlin/io/element/android/features/roomdetails/impl/di/RoomMemberModule.kt
@@ -12,6 +12,9 @@ import dagger.Module
 import dagger.Provides
 import io.element.android.features.createroom.api.StartDMAction
 import io.element.android.features.roomdetails.impl.members.details.RoomMemberDetailsPresenter
+import io.element.android.libraries.androidutils.clipboard.ClipboardHelper
+import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.di.RoomScope
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.UserId
@@ -25,10 +28,13 @@ object RoomMemberModule {
         matrixClient: MatrixClient,
         room: MatrixRoom,
         startDMAction: StartDMAction,
+        dispatchers: CoroutineDispatchers,
+        clipboardHelper: ClipboardHelper,
+        snackbarDispatcher: SnackbarDispatcher,
     ): RoomMemberDetailsPresenter.Factory {
         return object : RoomMemberDetailsPresenter.Factory {
             override fun create(roomMemberId: UserId): RoomMemberDetailsPresenter {
-                return RoomMemberDetailsPresenter(roomMemberId, matrixClient, room, startDMAction)
+                return RoomMemberDetailsPresenter(roomMemberId, matrixClient, room, startDMAction, dispatchers, clipboardHelper, snackbarDispatcher)
             }
         }
     }

diff --git a/...o/element/android/features/roomdetails/impl/members/details/RoomMemberDetailsPresenter.kt b/...o/element/android/features/roomdetails/impl/members/details/RoomMemberDetailsPresenter.kt
@@ -23,16 +23,21 @@ import io.element.android.features.userprofile.shared.UserProfileEvents
 import io.element.android.features.userprofile.shared.UserProfilePresenterHelper
 import io.element.android.features.userprofile.shared.UserProfileState
 import io.element.android.features.userprofile.shared.UserProfileState.ConfirmationDialog
+import io.element.android.libraries.androidutils.clipboard.ClipboardHelper
 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.core.bool.orFalse
+import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarMessage
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.user.MatrixUser
 import io.element.android.libraries.matrix.ui.room.getRoomMemberAsState
+import io.element.android.libraries.ui.strings.CommonStrings
 import kotlinx.coroutines.flow.distinctUntilChanged
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
@@ -44,6 +49,9 @@ class RoomMemberDetailsPresenter @AssistedInject constructor(
     private val client: MatrixClient,
     private val room: MatrixRoom,
     private val startDMAction: StartDMAction,
+    private val dispatchers: CoroutineDispatchers,
+    private val clipboardHelper: ClipboardHelper,
+    private val snackbarDispatcher: SnackbarDispatcher,
 ) : Presenter<UserProfileState> {
     interface Factory {
         fun create(roomMemberId: UserId): RoomMemberDetailsPresenter
@@ -112,6 +120,12 @@ class RoomMemberDetailsPresenter @AssistedInject constructor(
                 UserProfileEvents.ClearStartDMState -> {
                     startDmActionState.value = AsyncAction.Uninitialized
                 }
+                is UserProfileEvents.CopyID -> {
+                    coroutineScope.launch(dispatchers.io) {
+                        clipboardHelper.copyPlainText(event.text)
+                        snackbarDispatcher.post(SnackbarMessage(CommonStrings.common_copied_to_clipboard))
+                    }
+                }
             }
         }
 

diff --git a/.../impl/src/test/kotlin/io/element/android/features/roomdetails/RoomDetailsPresenterTest.kt b/.../impl/src/test/kotlin/io/element/android/features/roomdetails/RoomDetailsPresenterTest.kt
@@ -25,7 +25,9 @@ import io.element.android.features.roomdetails.impl.RoomDetailsType
 import io.element.android.features.roomdetails.impl.RoomTopicState
 import io.element.android.features.roomdetails.impl.members.aRoomMember
 import io.element.android.features.roomdetails.impl.members.details.RoomMemberDetailsPresenter
+import io.element.android.libraries.androidutils.clipboard.FakeClipboardHelper
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.featureflag.test.FakeFeatureFlagService
 import io.element.android.libraries.matrix.api.core.UserId
@@ -74,11 +76,13 @@ class RoomDetailsPresenterTest {
         notificationSettingsService: FakeNotificationSettingsService = FakeNotificationSettingsService(),
         analyticsService: AnalyticsService = FakeAnalyticsService(),
         isPinnedMessagesFeatureEnabled: Boolean = true,
+        clipboardHelper: FakeClipboardHelper = FakeClipboardHelper(),
+        snackbarDispatcher: SnackbarDispatcher = SnackbarDispatcher(),
     ): RoomDetailsPresenter {
         val matrixClient = FakeMatrixClient(notificationSettingsService = notificationSettingsService)
         val roomMemberDetailsPresenterFactory = object : RoomMemberDetailsPresenter.Factory {
             override fun create(roomMemberId: UserId): RoomMemberDetailsPresenter {
-                return RoomMemberDetailsPresenter(roomMemberId, matrixClient, room, FakeStartDMAction())
+                return RoomMemberDetailsPresenter(roomMemberId, matrixClient, room, FakeStartDMAction(), dispatchers, clipboardHelper, snackbarDispatcher)
             }
         }
         val featureFlagService = FakeFeatureFlagService(
@@ -94,6 +98,8 @@ class RoomDetailsPresenterTest {
             dispatchers = dispatchers,
             isPinnedMessagesFeatureEnabled = { isPinnedMessagesFeatureEnabled },
             analyticsService = analyticsService,
+            clipboardHelper = clipboardHelper,
+            snackbarDispatcher = snackbarDispatcher,
         )
     }
 

diff --git a/...io/element/android/features/roomdetails/members/details/RoomMemberDetailsPresenterTest.kt b/...io/element/android/features/roomdetails/members/details/RoomMemberDetailsPresenterTest.kt
@@ -19,8 +19,10 @@ import io.element.android.features.roomdetails.impl.members.aRoomMember
 import io.element.android.features.roomdetails.impl.members.details.RoomMemberDetailsPresenter
 import io.element.android.features.userprofile.shared.UserProfileEvents
 import io.element.android.features.userprofile.shared.UserProfileState
+import io.element.android.libraries.androidutils.clipboard.FakeClipboardHelper
 import io.element.android.libraries.architecture.AsyncAction
 import io.element.android.libraries.architecture.AsyncData
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.room.MatrixRoom
@@ -31,8 +33,10 @@ import io.element.android.libraries.matrix.test.A_THROWABLE
 import io.element.android.libraries.matrix.test.FakeMatrixClient
 import io.element.android.libraries.matrix.ui.components.aMatrixUser
 import io.element.android.tests.testutils.WarmUpRule
+import io.element.android.tests.testutils.testCoroutineDispatchers
 import kotlinx.collections.immutable.persistentListOf
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.TestScope
 import kotlinx.coroutines.test.runTest
 import org.junit.Rule
 import org.junit.Test
@@ -54,7 +58,7 @@ class RoomMemberDetailsPresenterTest {
         }
         val presenter = createRoomMemberDetailsPresenter(
             room = room,
-            roomMemberId = roomMember.userId
+            roomMemberId = roomMember.userId,
         )
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
@@ -332,17 +336,22 @@ class RoomMemberDetailsPresenterTest {
         return awaitItem()
     }
 
-    private fun createRoomMemberDetailsPresenter(
+    private fun TestScope.createRoomMemberDetailsPresenter(
         room: MatrixRoom,
         client: MatrixClient = FakeMatrixClient(),
         roomMemberId: UserId = UserId("@alice:server.org"),
-        startDMAction: StartDMAction = FakeStartDMAction()
+        startDMAction: StartDMAction = FakeStartDMAction(),
+        clipboardHelper: FakeClipboardHelper = FakeClipboardHelper(),
+        snackbarDispatcher: SnackbarDispatcher = SnackbarDispatcher(),
     ): RoomMemberDetailsPresenter {
         return RoomMemberDetailsPresenter(
             roomMemberId = roomMemberId,
             client = client,
             room = room,
-            startDMAction = startDMAction
+            startDMAction = startDMAction,
+            dispatchers = testCoroutineDispatchers(),
+            clipboardHelper = clipboardHelper,
+            snackbarDispatcher = snackbarDispatcher,
         )
     }
 }
diff --git a/...impl/src/main/kotlin/io/element/android/features/userprofile/impl/di/UserProfileModule.kt b/...impl/src/main/kotlin/io/element/android/features/userprofile/impl/di/UserProfileModule.kt
@@ -12,6 +12,9 @@ import dagger.Module
 import dagger.Provides
 import io.element.android.features.createroom.api.StartDMAction
 import io.element.android.features.userprofile.impl.root.UserProfilePresenter
+import io.element.android.libraries.androidutils.clipboard.ClipboardHelper
+import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.di.SessionScope
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.UserId
@@ -23,10 +26,13 @@ object UserProfileModule {
     fun provideUserProfilePresenterFactory(
         matrixClient: MatrixClient,
         startDMAction: StartDMAction,
+        dispatchers: CoroutineDispatchers,
+        clipboardHelper: ClipboardHelper,
+        snackbarDispatcher: SnackbarDispatcher,
     ): UserProfilePresenter.Factory {
         return object : UserProfilePresenter.Factory {
             override fun create(userId: UserId): UserProfilePresenter {
-                return UserProfilePresenter(userId, matrixClient, startDMAction)
+                return UserProfilePresenter(userId, matrixClient, startDMAction, dispatchers, clipboardHelper, snackbarDispatcher)
             }
         }
     }

diff --git a/...src/main/kotlin/io/element/android/features/userprofile/impl/root/UserProfilePresenter.kt b/...src/main/kotlin/io/element/android/features/userprofile/impl/root/UserProfilePresenter.kt
@@ -22,14 +22,19 @@ import io.element.android.features.userprofile.shared.UserProfileEvents
 import io.element.android.features.userprofile.shared.UserProfilePresenterHelper
 import io.element.android.features.userprofile.shared.UserProfileState
 import io.element.android.features.userprofile.shared.UserProfileState.ConfirmationDialog
+import io.element.android.libraries.androidutils.clipboard.ClipboardHelper
 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.core.bool.orFalse
+import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
+import io.element.android.libraries.designsystem.utils.snackbar.SnackbarMessage
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.user.MatrixUser
+import io.element.android.libraries.ui.strings.CommonStrings
 import kotlinx.coroutines.flow.distinctUntilChanged
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
@@ -40,6 +45,9 @@ class UserProfilePresenter @AssistedInject constructor(
     @Assisted private val userId: UserId,
     private val client: MatrixClient,
     private val startDMAction: StartDMAction,
+    private val dispatchers: CoroutineDispatchers,
+    private val clipboardHelper: ClipboardHelper,
+    private val snackbarDispatcher: SnackbarDispatcher,
 ) : Presenter<UserProfileState> {
     interface Factory {
         fun create(userId: UserId): UserProfilePresenter
@@ -100,6 +108,12 @@ class UserProfilePresenter @AssistedInject constructor(
                 UserProfileEvents.ClearStartDMState -> {
                     startDmActionState.value = AsyncAction.Uninitialized
                 }
+                is UserProfileEvents.CopyID -> {
+                    coroutineScope.launch(dispatchers.io) {
+                        clipboardHelper.copyPlainText(event.text)
+                        snackbarDispatcher.post(SnackbarMessage(CommonStrings.common_copied_to_clipboard))
+                    }
+                }
             }
         }
 

diff --git a/...hared/src/main/kotlin/io/element/android/features/userprofile/shared/UserProfileEvents.kt b/...hared/src/main/kotlin/io/element/android/features/userprofile/shared/UserProfileEvents.kt
@@ -14,4 +14,5 @@ sealed interface UserProfileEvents {
     data class UnblockUser(val needsConfirmation: Boolean = false) : UserProfileEvents
     data object ClearBlockUserError : UserProfileEvents
     data object ClearConfirmationDialog : UserProfileEvents
+    data class CopyID(val text: String) : UserProfileEvents
 }