Introducing a use case to check if a message can have reply action
This commit is contained in:
Maxime NATUREL
parent
abea68557b
commit
65b949071a
@ -0,0 +1,45 @@
|
||||
/*
|
||||
* Copyright (c) 2022 New Vector Ltd
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package im.vector.app.features.home.room.detail.timeline.action
|
||||
|
||||
import org.matrix.android.sdk.api.session.events.model.EventType
|
||||
import org.matrix.android.sdk.api.session.room.model.message.MessageContent
|
||||
import org.matrix.android.sdk.api.session.room.model.message.MessageType
|
||||
import org.matrix.android.sdk.api.session.room.timeline.TimelineEvent
|
||||
import javax.inject.Inject
|
||||
|
||||
class CheckIfCanReplyEventUseCase @Inject constructor() {
|
||||
|
||||
fun execute(event: TimelineEvent, messageContent: MessageContent?, actionPermissions: ActionPermissions): Boolean {
|
||||
// Only EventType.MESSAGE, EventType.POLL_START and EventType.STATE_ROOM_BEACON_INFO event types are supported for the moment
|
||||
if (event.root.getClearType() !in EventType.STATE_ROOM_BEACON_INFO + EventType.POLL_START + EventType.MESSAGE) return false
|
||||
if (!actionPermissions.canSendMessage) return false
|
||||
return when (messageContent?.msgType) {
|
||||
MessageType.MSGTYPE_TEXT,
|
||||
MessageType.MSGTYPE_NOTICE,
|
||||
MessageType.MSGTYPE_EMOTE,
|
||||
MessageType.MSGTYPE_IMAGE,
|
||||
MessageType.MSGTYPE_VIDEO,
|
||||
MessageType.MSGTYPE_AUDIO,
|
||||
MessageType.MSGTYPE_FILE,
|
||||
MessageType.MSGTYPE_POLL_START,
|
||||
MessageType.MSGTYPE_BEACON_INFO,
|
||||
MessageType.MSGTYPE_LOCATION -> true
|
||||
else -> false
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -80,7 +80,8 @@ class MessageActionsViewModel @AssistedInject constructor(
|
||||
private val errorFormatter: ErrorFormatter,
|
||||
private val stringProvider: StringProvider,
|
||||
private val pillsPostProcessorFactory: PillsPostProcessor.Factory,
|
||||
private val vectorPreferences: VectorPreferences
|
||||
private val vectorPreferences: VectorPreferences,
|
||||
private val checkIfCanReplyEventUseCase: CheckIfCanReplyEventUseCase,
|
||||
) : VectorViewModel<MessageActionState, MessageActionsAction, EmptyViewEvents>(initialState) {
|
||||
|
||||
private val informationData = initialState.informationData
|
||||
@ -436,21 +437,7 @@ class MessageActionsViewModel @AssistedInject constructor(
|
||||
}
|
||||
|
||||
private fun canReply(event: TimelineEvent, messageContent: MessageContent?, actionPermissions: ActionPermissions): Boolean {
|
||||
// Only EventType.MESSAGE and EventType.POLL_START event types are supported for the moment
|
||||
if (event.root.getClearType() !in EventType.POLL_START + EventType.MESSAGE) return false
|
||||
if (!actionPermissions.canSendMessage) return false
|
||||
return when (messageContent?.msgType) {
|
||||
MessageType.MSGTYPE_TEXT,
|
||||
MessageType.MSGTYPE_NOTICE,
|
||||
MessageType.MSGTYPE_EMOTE,
|
||||
MessageType.MSGTYPE_IMAGE,
|
||||
MessageType.MSGTYPE_VIDEO,
|
||||
MessageType.MSGTYPE_AUDIO,
|
||||
MessageType.MSGTYPE_FILE,
|
||||
MessageType.MSGTYPE_POLL_START,
|
||||
MessageType.MSGTYPE_LOCATION -> true
|
||||
else -> false
|
||||
}
|
||||
return checkIfCanReplyEventUseCase.execute(event, messageContent, actionPermissions)
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -0,0 +1,131 @@
|
||||
/*
|
||||
* Copyright (c) 2022 New Vector Ltd
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package im.vector.app.features.home.room.detail.timeline.action
|
||||
|
||||
import io.mockk.every
|
||||
import io.mockk.mockk
|
||||
import org.amshove.kluent.shouldBeEqualTo
|
||||
import org.junit.Test
|
||||
import org.matrix.android.sdk.api.session.events.model.Event
|
||||
import org.matrix.android.sdk.api.session.events.model.EventType
|
||||
import org.matrix.android.sdk.api.session.room.model.message.MessageContent
|
||||
import org.matrix.android.sdk.api.session.room.model.message.MessageType
|
||||
import org.matrix.android.sdk.api.session.room.timeline.TimelineEvent
|
||||
|
||||
class CheckIfCanReplyEventUseCaseTest {
|
||||
|
||||
private val checkIfCanReplyEventUseCase = CheckIfCanReplyEventUseCase()
|
||||
|
||||
@Test
|
||||
fun `given sending message is not allowed when use case is executed then result is false`() {
|
||||
val event = givenAnEvent(eventType = EventType.MESSAGE)
|
||||
val messageContent = givenAMessageContent(MessageType.MSGTYPE_AUDIO)
|
||||
val actionPermissions = givenActionPermissions(canSendMessage = false)
|
||||
|
||||
val result = checkIfCanReplyEventUseCase.execute(event, messageContent, actionPermissions)
|
||||
|
||||
result shouldBeEqualTo false
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `given reply is allowed for the event type when use case is executed then result is true`() {
|
||||
val eventTypes = EventType.STATE_ROOM_BEACON_INFO + EventType.POLL_START + EventType.MESSAGE
|
||||
|
||||
eventTypes.forEach { eventType ->
|
||||
val event = givenAnEvent(eventType)
|
||||
val messageContent = givenAMessageContent(MessageType.MSGTYPE_AUDIO)
|
||||
val actionPermissions = givenActionPermissions(canSendMessage = true)
|
||||
|
||||
val result = checkIfCanReplyEventUseCase.execute(event, messageContent, actionPermissions)
|
||||
|
||||
result shouldBeEqualTo true
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `given reply is not allowed for the event type when use case is executed then result is false`() {
|
||||
val event = givenAnEvent(EventType.CALL_ANSWER)
|
||||
val messageContent = givenAMessageContent(MessageType.MSGTYPE_AUDIO)
|
||||
val actionPermissions = givenActionPermissions(canSendMessage = true)
|
||||
|
||||
val result = checkIfCanReplyEventUseCase.execute(event, messageContent, actionPermissions)
|
||||
|
||||
result shouldBeEqualTo false
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `given reply is allowed for the message type when use case is executed then result is true`() {
|
||||
val messageTypes = listOf(
|
||||
MessageType.MSGTYPE_TEXT,
|
||||
MessageType.MSGTYPE_NOTICE,
|
||||
MessageType.MSGTYPE_EMOTE,
|
||||
MessageType.MSGTYPE_IMAGE,
|
||||
MessageType.MSGTYPE_VIDEO,
|
||||
MessageType.MSGTYPE_AUDIO,
|
||||
MessageType.MSGTYPE_FILE,
|
||||
MessageType.MSGTYPE_POLL_START,
|
||||
MessageType.MSGTYPE_BEACON_INFO,
|
||||
MessageType.MSGTYPE_LOCATION
|
||||
)
|
||||
|
||||
messageTypes.forEach { messageType ->
|
||||
val event = givenAnEvent(EventType.MESSAGE)
|
||||
val messageContent = givenAMessageContent(messageType)
|
||||
val actionPermissions = givenActionPermissions(canSendMessage = true)
|
||||
|
||||
val result = checkIfCanReplyEventUseCase.execute(event, messageContent, actionPermissions)
|
||||
|
||||
result shouldBeEqualTo true
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `given reply is not allowed for the message type when use case is executed then result is false`() {
|
||||
val event = givenAnEvent(EventType.MESSAGE)
|
||||
val messageContent = givenAMessageContent(MessageType.MSGTYPE_BEACON_LOCATION_DATA)
|
||||
val actionPermissions = givenActionPermissions(canSendMessage = true)
|
||||
|
||||
val result = checkIfCanReplyEventUseCase.execute(event, messageContent, actionPermissions)
|
||||
|
||||
result shouldBeEqualTo false
|
||||
}
|
||||
|
||||
private fun givenAnEvent(eventType: String): TimelineEvent {
|
||||
val eventId = "event-id"
|
||||
return TimelineEvent(
|
||||
root = Event(
|
||||
eventId = eventId,
|
||||
type = eventType
|
||||
),
|
||||
localId = 123L,
|
||||
eventId = eventId,
|
||||
displayIndex = 1,
|
||||
ownedByThreadChunk = false,
|
||||
senderInfo = mockk()
|
||||
)
|
||||
}
|
||||
|
||||
private fun givenAMessageContent(messageType: String): MessageContent {
|
||||
return mockk<MessageContent>().also {
|
||||
every { it.msgType } returns messageType
|
||||
}
|
||||
}
|
||||
|
||||
private fun givenActionPermissions(canSendMessage: Boolean): ActionPermissions {
|
||||
return ActionPermissions(canSendMessage = canSendMessage)
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user