feat(fc): add report user for message self defense control

Signed-off-by: Brandon McAnsh <[email protected]>

Author: bmc08gt

definitions/flipchat/protos/src/main/proto/chat/v1/flipchat_service.proto

@@ -42,6 +42,10 @@ service Chat {
     rpc SetCoverCharge(SetCoverChargeRequest) returns (SetCoverChargeResponse);
     // RemoveUser removes a user from a chat
     rpc RemoveUser(RemoveUserRequest) returns (RemoveUserResponse);
+    // ReportUser reports a user for a given message
+    //
+    // todo: might belong in a different service long-term
+    rpc ReportUser(ReportUserRequest) returns (ReportUserResponse);
 }
 message StreamChatEventsRequest {
     oneof type {
@@ -256,6 +260,17 @@ message RemoveUserResponse{
         DENIED   = 1;
     }
 }
+message ReportUserRequest{
+    common.v1.UserId user_id = 1;
+    messaging.v1.MessageId message_id = 2;
+    common.v1.Auth auth = 3;
+}
+message ReportUserResponse{
+    Result result = 1;
+    enum Result {
+        OK       = 0;
+    }
+}
 message Metadata {
     common.v1.ChatId chat_id = 1;
     // The type of chat

flipchatApp/src/main/kotlin/xyz/flipchat/app/features/chat/conversation/ConversationScreen.kt

@@ -288,6 +288,7 @@ private data class MessageActionContextSheet(val actions: List<MessageControlAct
                         is MessageControlAction.Copy -> stringResource(R.string.action_copyMessage)
                         is MessageControlAction.Delete -> stringResource(R.string.action_deleteMessage)
                         is MessageControlAction.RemoveUser -> stringResource(R.string.action_removeUser, action.name)
+                        is MessageControlAction.ReportUserForMessage -> stringResource(R.string.action_report)
                     },
                     style = CodeTheme.typography.textMedium,
                     modifier = Modifier

flipchatApp/src/main/kotlin/xyz/flipchat/app/features/chat/conversation/ConversationViewModel.kt

@@ -55,6 +55,8 @@ import kotlinx.coroutines.launch
 import kotlinx.datetime.Instant
 import timber.log.Timber
 import xyz.flipchat.chat.RoomController
+import xyz.flipchat.services.domain.model.chat.ConversationMember
+import xyz.flipchat.services.domain.model.chat.ConversationMessage
 import xyz.flipchat.services.domain.model.chat.ConversationWithMembersAndLastPointers
 import xyz.flipchat.services.user.UserManager
 import java.util.UUID
@@ -145,6 +147,7 @@ class ConversationViewModel @Inject constructor(
         data class CopyMessage(val text: String) : Event
         data class DeleteMessage(val conversationId: ID, val messageId: ID) : Event
         data class RemoveUser(val conversationId: ID, val userId: ID) : Event
+        data class ReportUser(val userId: ID, val messageId: ID) : Event
 
         data object OnUserTypingStarted : Event
         data object OnUserTypingStopped : Event
@@ -354,6 +357,20 @@ class ConversationViewModel @Inject constructor(
             }
             .launchIn(viewModelScope)
 
+        eventFlow
+            .filterIsInstance<Event.ReportUser>()
+            .map { (userId, messageId) ->
+                roomController.reportUserForMessage(userId, messageId)
+            }.onError {
+                TopBarManager.showMessage(
+                    TopBarManager.TopBarMessage(
+                        title = resources.getString(R.string.error_title_failedToReportUserForMessage),
+                        message = resources.getString(R.string.error_description_failedToReportUserForMessage)
+                    )
+                )
+            }
+            .launchIn(viewModelScope)
+
         eventFlow
             .filterIsInstance<Event.CopyMessage>()
             .map { it.text }
@@ -406,30 +423,6 @@ class ConversationViewModel @Inject constructor(
                     fallback = if (contents.isFromSelf) MessageStatus.Sent else MessageStatus.Unknown
                 )
 
-                val selfDefenseActions = mutableListOf<MessageControlAction>().apply {
-                    if (stateFlow.value.isHost) {
-//                        add(
-//                            MessageControlAction.Delete {
-//                                confirmMessageDelete(
-//                                    conversationId = message.conversationId,
-//                                    messageId = message.id
-//                                )
-//                            }
-//                        )
-                        if (member?.memberName?.isNotEmpty() == true && !contents.isFromSelf) {
-                            add(
-                                MessageControlAction.RemoveUser(member.memberName.orEmpty()) {
-                                    confirmUserRemoval(
-                                        conversationId = message.conversationId,
-                                        user = member.memberName,
-                                        userId = message.senderId
-                                    )
-                                }
-                            )
-                        }
-                    }
-                }
-
                 ChatItem.Message(
                     chatMessageId = message.id,
                     message = contents,
@@ -457,13 +450,55 @@ class ConversationViewModel @Inject constructor(
                                     )
                                 )
                             }
-                        ) + selfDefenseActions,
+                        ) + buildSelfDefenseControls(message, member, contents),
                     ),
                     key = contents.hashCode() + message.id.hashCode()
                 )
             }
         }
 
+    private fun buildSelfDefenseControls(
+        message: ConversationMessage,
+        member: ConversationMember?,
+        contents: MessageContent
+    ): List<MessageControlAction> {
+        return mutableListOf<MessageControlAction>().apply {
+            if (stateFlow.value.isHost) {
+//                        add(
+//                            MessageControlAction.Delete {
+//                                confirmMessageDelete(
+//                                    conversationId = message.conversationId,
+//                                    messageId = message.id
+//                                )
+//                            }
+//                        )
+                if (member?.memberName?.isNotEmpty() == true && !contents.isFromSelf) {
+                    add(
+                        MessageControlAction.RemoveUser(member.memberName.orEmpty()) {
+                            confirmUserRemoval(
+                                conversationId = message.conversationId,
+                                user = member.memberName,
+                                userId = message.senderId,
+                            )
+                        }
+                    )
+                }
+            }
+
+            if (!contents.isFromSelf) {
+                add(
+                    MessageControlAction.ReportUserForMessage(member?.memberName.orEmpty()) {
+                        confirmUserReport(
+                            user = member?.memberName,
+                            userId = message.senderId,
+                            messageId = message.id
+                        )
+                    }
+                )
+            }
+        }.toList()
+    }
+
     private fun confirmMessageDelete(conversationId: ID, messageId: ID) {
         BottomBarManager.showMessage(
             BottomBarManager.BottomBarMessage(
@@ -494,6 +529,22 @@ class ConversationViewModel @Inject constructor(
         )
     }
 
+    private fun confirmUserReport(user: String?, userId: ID, messageId: ID) {
+        BottomBarManager.showMessage(
+            BottomBarManager.BottomBarMessage(
+                title = resources.getString(R.string.title_reportUserForMessage, user ?: "User"),
+                subtitle = resources.getString(R.string.subtitle_reportUserForMessage),
+                positiveText = resources.getString(R.string.action_report),
+                negativeText = "",
+                tertiaryText = resources.getString(R.string.action_cancel),
+                onPositive = { dispatchEvent(Event.ReportUser(userId, messageId)) },
+                onNegative = { },
+                type = BottomBarManager.BottomBarMessageType.DESTRUCTIVE,
+                showScrim = true,
+            )
+        )
+    }
+
     override fun onCleared() {
         super.onCleared()
         roomController.closeMessageStream()
@@ -574,6 +625,7 @@ class ConversationViewModel @Inject constructor(
                 is Event.DeleteMessage,
                 is Event.CopyMessage,
                 is Event.RemoveUser,
+                is Event.ReportUser,
                 is Event.ReopenStream,
                 is Event.CloseStream,
                 is Event.SendMessage -> { state -> state }

flipchatApp/src/main/res/values/strings.xml

@@ -38,11 +38,13 @@
     <string name="error_description_failedToLeaveRoom">You were unable to leave the room at this time. Please try again later.</string>
 
     <string name="error_title_failedToDeleteMessage">Something Went Wrong</string>
-    <string name="error_description_failedToDeleteMessage">This message could not be deleted. Please check your network connection and try again</string>
+    <string name="error_description_failedToDeleteMessage">This message could not be deleted. Please check your network connection and try again.</string>
 
     <string name="error_title_failedToRemoveUser">Something Went Wrong</string>
     <string name="error_description_failedToRemoveUser">This user could not be removed. Please check your network connection and try again</string>
 
+    <string name="error_title_failedToReportUserForMessage">Something Went Wrong</string>
+    <string name="error_description_failedToReportUserForMessage">This user\'s message could not be reported. Please check your network connection and try again</string>
 
     <string name="prompt_title_revealIdentity">Reveal your identity?</string>
     <string name="prompt_subtitle_revealIdentity">%1$s will be able to see that you are %2$s.</string>
@@ -73,11 +75,16 @@
     <string name="subtitle_removeUserFromRoom">They will be able to rejoin after waiting an hour, but will have to pay the cover charge again.</string>
     <string name="action_remove">Remove</string>
 
+    <string name="title_reportUserForMessage">Report %1$s?</string>
+    <string name="subtitle_reportUserForMessage">This message will be forwarded to Flipchat. This contact will not be notified.</string>
+    <string name="action_report">Report</string>
+
     <string name="permissions_description_push_messages">Receive push notifications when people message you.</string>
 
     <string name="action_copyMessage">Copy</string>
     <string name="action_deleteMessage">Delete</string>
     <string name="action_removeUser">Remove %1$s</string>
+    <string name="action_reportUser">Report %1$s</string>
 
     <string name="title_roomCardHostedBy">Hosted by %1$s</string>
     <string name="title_roomCardJoinCost">Cover Charge: ⬢ %1$d Kin</string>

services/flipchat/chat/src/main/kotlin/xyz/flipchat/services/internal/network/api/ChatApi.kt

@@ -17,6 +17,7 @@ import xyz.flipchat.services.domain.model.query.QueryOptions
 import xyz.flipchat.services.internal.annotations.ChatManagedChannel
 import xyz.flipchat.services.internal.network.extensions.toChatId
 import xyz.flipchat.services.internal.network.extensions.toIntentId
+import xyz.flipchat.services.internal.network.extensions.toMessageId
 import xyz.flipchat.services.internal.network.extensions.toPaymentAmount
 import xyz.flipchat.services.internal.network.extensions.toProto
 import xyz.flipchat.services.internal.network.extensions.toUserId
@@ -200,6 +201,23 @@ class ChatApi @Inject constructor(
             .flowOn(Dispatchers.IO)
     }
 
+    // ReportUser reports a user for a given message
+    fun reportUser(
+        owner: KeyPair,
+        userId: ID,
+        messageId: ID,
+    ): Flow<FlipchatService.ReportUserResponse> {
+        val request = FlipchatService.ReportUserRequest.newBuilder()
+            .setUserId(userId.toUserId())
+            .setMessageId(messageId.toMessageId())
+            .apply { setAuth(authenticate(owner)) }
+            .build()
+
+        return api::reportUser
+            .callAsCancellableFlow(request)
+            .flowOn(Dispatchers.IO)
+    }
+
     // StreamChatEvents streams all chat events for the requesting user.
     //
     // Chat events will include any update to a chat, including:

services/flipchat/chat/src/main/kotlin/xyz/flipchat/services/internal/network/repository/chat/ChatRepository.kt

@@ -34,4 +34,5 @@ interface ChatRepository {
 
     // Self Defense Room Controls
     suspend fun removeUser(conversationId: ID, userId: ID): Result<Unit>
+    suspend fun reportUserForMessage(userId: ID, messageId: ID): Result<Unit>
 }

services/flipchat/chat/src/main/kotlin/xyz/flipchat/services/internal/network/repository/chat/RealChatRepository.kt

@@ -206,4 +206,13 @@ internal class RealChatRepository @Inject constructor(
         return service.removeUser(owner, conversationId, userId)
             .onFailure { ErrorUtils.handleError(it) }
     }
+
+    override suspend fun reportUserForMessage(
+        userId: ID,
+        messageId: ID
+    ): Result<Unit> {
+        val owner = userManager.keyPair ?: return Result.failure(IllegalStateException("No ed25519 signature found for owner"))
+        return service.reportUser(owner, userId, messageId)
+            .onFailure { ErrorUtils.handleError(it) }
+    }
 }

services/flipchat/chat/src/main/kotlin/xyz/flipchat/services/internal/network/service/ChatService.kt

@@ -346,6 +346,38 @@ internal class ChatService @Inject constructor(
         }
     }
 
+    suspend fun reportUser(
+        owner: KeyPair,
+        userId: ID,
+        messageId: ID
+    ): Result<Unit> {
+        return try {
+            networkOracle.managedRequest(api.reportUser(owner, userId, messageId))
+                .map { response ->
+                    when (response.result) {
+                        FlipchatService.ReportUserResponse.Result.OK -> {
+                            Result.success(Unit)
+                        }
+
+                        FlipchatService.ReportUserResponse.Result.UNRECOGNIZED -> {
+                            val error = ReportUserError.Unrecognized()
+                            Timber.e(t = error)
+                            Result.failure(error)
+                        }
+
+                        else -> {
+                            val error = ReportUserError.Other()
+                            Timber.e(t = error)
+                            Result.failure(error)
+                        }
+                    }
+                }.first()
+        } catch (e: Exception) {
+            val error = ReportUserError.Other(cause = e)
+            Result.failure(error)
+        }
+    }
+
     fun openChatStream(
         scope: CoroutineScope,
         owner: KeyPair,
@@ -507,4 +539,9 @@ internal class ChatService @Inject constructor(
         class Denied : RemoveUserError()
         data class Other(override val cause: Throwable? = null) : RemoveUserError()
     }
+
+    sealed class ReportUserError : Throwable() {
+        class Unrecognized : RemoveUserError()
+        data class Other(override val cause: Throwable? = null) : RemoveUserError()
+    }
 }

services/flipchat/sdk/src/main/kotlin/xyz/flipchat/chat/RoomController.kt

@@ -192,6 +192,13 @@ class RoomController @Inject constructor(
             }
     }
 
+    suspend fun reportUserForMessage(
+        userId: ID,
+        messageId: ID,
+    ): Result<Unit> {
+        return chatRepository.reportUserForMessage(userId, messageId)
+    }
+
     suspend fun setCoverCharge(
         conversationId: ID,
         amount: KinAmount

ui/components/src/main/kotlin/com/getcode/ui/components/chat/messagecontents/MessageTextContent.kt

@@ -20,7 +20,6 @@ import androidx.compose.ui.draw.drawWithContent
 import androidx.compose.ui.graphics.Shape
 import androidx.compose.ui.platform.LocalDensity
 import androidx.compose.ui.text.TextStyle
-import androidx.compose.ui.text.font.FontWeight
 import androidx.compose.ui.text.rememberTextMeasurer
 import androidx.compose.ui.unit.dp
 import com.getcode.model.chat.MessageStatus
@@ -37,6 +36,7 @@ sealed interface MessageControlAction {
     data class Copy(override val onSelect: () -> Unit): MessageControlAction
     data class Delete(override val onSelect: () -> Unit): MessageControlAction
     data class RemoveUser(val name: String, override val onSelect: () -> Unit): MessageControlAction
+    data class ReportUserForMessage(val name: String, override val onSelect: () -> Unit): MessageControlAction
 }
 
 data class MessageControls(