Skip to content

Migrate the message reaction lists to the generated ReactionResponse model #6682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gpunto wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Migrate the message reaction lists to the generated ReactionResponse model #6682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions ...droid-client/src/main/java/io/getstream/chat/android/client/api2/mapping/DomainMapping.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,17 +304,13 @@ internal class DomainMapping(
html = html,
i18n = i18n,
id = id,
latestReactions = latest_reactions.toDomain(
messageId = id,
),
latestReactions = latest_reactions.toReactions(messageId = id),
mentionedUsers = mentioned_users.map { it.toDomain() },
mentionedHere = mentioned_here ?: false,
mentionedChannel = mentioned_channel ?: false,
mentionedGroups = mentioned_groups.map { it.toDomain() },
mentionedRoles = mentioned_roles,
ownReactions = own_reactions.toDomain(
messageId = id,
),
ownReactions = own_reactions.toReactions(messageId = id),
parentId = parent_id,
pinExpires = pin_expires,
pinned = pinned,
Expand Down Expand Up @@ -386,18 +382,13 @@ internal class DomainMapping(
)

/**
* Map a list of [DownstreamReactionDto] to a list of [Reaction].
* They are filtered by [messageId] and mapped to domain model.
*
* @param messageId the message id
* Maps the reactions of one message, dropping any the response attributes to another message.
*/
@StreamHandsOff(
reason = "Backend response is including wrong reactions for the message, so we need to filter them manually.",
)
private fun List<DownstreamReactionDto>.toDomain(
messageId: String,
): List<Reaction> =
filter { it.message_id == messageId }
private fun List<ReactionResponse>.toReactions(messageId: String): List<Reaction> =
filter { it.messageId == messageId }
.map { it.toDomain() }

private fun DownstreamMessageDto.lastUpdateTime(): Date = listOfNotNull(
Expand Down
5 changes: 3 additions & 2 deletions ...droid-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/MessageDtos.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import io.getstream.chat.android.core.internal.StreamHandsOff
import io.getstream.chat.android.network.models.Attachment
import io.getstream.chat.android.network.models.PollResponseData
import io.getstream.chat.android.network.models.ReactionResponse
import java.util.Date

/**
Expand All @@ -41,13 +42,13 @@
val html: String,
val i18n: Map<String, String> = emptyMap(),
val id: String,
val latest_reactions: List<DownstreamReactionDto>,
val latest_reactions: List<ReactionResponse>,

Check warning on line 45 in stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/MessageDtos.kt

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Rename this parameter to match the regular expression ^`?[_a-z][a-zA-Z0-9]*`?$ 


See more on https://sonarcloud.io/project/issues?id=GetStream_stream-chat-android&issues=AaBs18hTyWo4wePY0BpL&open=AaBs18hTyWo4wePY0BpL&pullRequest=6682
val mentioned_users: List<DownstreamUserDto>,
val mentioned_here: Boolean? = null,
val mentioned_channel: Boolean? = null,
val mentioned_groups: List<DownstreamUserGroupDto> = emptyList(),
val mentioned_roles: List<String> = emptyList(),
val own_reactions: List<DownstreamReactionDto>,
val own_reactions: List<ReactionResponse>,

Check warning on line 51 in stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/MessageDtos.kt

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Rename this parameter to match the regular expression ^`?[_a-z][a-zA-Z0-9]*`?$ 


See more on https://sonarcloud.io/project/issues?id=GetStream_stream-chat-android&issues=AaBs18hTyWo4wePY0BpM&open=AaBs18hTyWo4wePY0BpM&pullRequest=6682
val parent_id: String?,
val pin_expires: Date?,
val pinned: Boolean = false,
Expand Down
23 changes: 21 additions & 2 deletions ...at-android-client/src/test/java/io/getstream/chat/android/client/EventChatJsonProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,6 +814,7 @@ private fun createUserJsonString() =
{
"id": "bender",
"role": "user",
"language": "en",
"created_at": "2020-06-29T06:14:28.000Z",
"updated_at": "2020-06-29T06:14:28.000Z",
"last_active": "2020-06-29T06:14:28.000Z",
Expand Down Expand Up @@ -878,16 +879,34 @@ private fun createMessageAttachmentJsonString() =
}
""".trimIndent()

@Language("JSON")
private fun createReactionUserJsonString() =
"""
{
"id": "bender",
"role": "user",
"language": "en",
"created_at": "2020-06-29T06:14:28.000Z",
"updated_at": "2020-06-29T06:14:28.000Z",
"last_active": "2020-06-29T06:14:28.000Z",
"banned": false,
"online": true,
"image": "https://api.adorable.io/avatars/285/bender.png",
"name": "Bender"
}
""".trimIndent()

@Language("JSON")
private fun createMessageReactionJsonString() =
"""
{
"message_id": "09afcd85-9dbb-4da8-8d85-5a6b4268d755",
"type": "like",
"score": 1,
"user": ${createUserJsonString()},
"user": ${createReactionUserJsonString()},
"user_id": "bender",
"created_at": "2020-06-29T06:14:28.000Z"
"created_at": "2020-06-29T06:14:28.000Z",
"updated_at": "2020-06-29T06:14:28.000Z"
}
""".trimIndent()

Expand Down
4 changes: 2 additions & 2 deletions stream-chat-android-client/src/test/java/io/getstream/chat/android/client/Mother.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,13 +303,13 @@ internal object Mother {
html: String = randomString(),
i18n: Map<String, String> = emptyMap(),
id: String = randomString(),
latest_reactions: List<DownstreamReactionDto> = emptyList(),
latest_reactions: List<ReactionResponse> = emptyList(),
mentioned_users: List<DownstreamUserDto> = emptyList(),
mentioned_here: Boolean? = null,
mentioned_channel: Boolean? = null,
mentioned_groups: List<DownstreamUserGroupDto> = emptyList(),
mentioned_roles: List<String> = emptyList(),
own_reactions: List<DownstreamReactionDto> = emptyList(),
own_reactions: List<ReactionResponse> = emptyList(),
parent_id: String? = randomString(),
pin_expires: Date? = randomDateOrNull(),
pinned: Boolean = randomBoolean(),
Expand Down
21 changes: 20 additions & 1 deletion ...at-android-client/src/test/java/io/getstream/chat/android/client/parser/EventArguments.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ internal object EventArguments {
private val user = User(
id = "bender",
role = "user",
language = "en",
invisible = false,
banned = false,
online = true,
Expand Down Expand Up @@ -267,13 +268,31 @@ internal object EventArguments {
mimeType = "image/png",
)

/**
* A reaction embedded in a message is parsed by the generated model, so its user is the shape the
* wire sends for anyone but the connected user: no unread counts, devices, mutes or `invisible`.
*/
private val reactionUser = User(
id = "bender",
role = "user",
language = "en",
banned = false,
online = true,
createdAt = date,
updatedAt = date,
lastActive = date,
name = "Bender",
image = "https://api.adorable.io/avatars/285/bender.png",
)

private val messageReaction = Reaction(
messageId = "09afcd85-9dbb-4da8-8d85-5a6b4268d755",
type = "like",
score = 1,
user = user,
user = reactionUser,
userId = "bender",
createdAt = date,
updatedAt = date,
)

private val message = Message(
Expand Down
4 changes: 2 additions & 2 deletions ...ent/src/test/java/io/getstream/chat/android/client/parser2/testdata/MessageDtoTestData.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ internal object MessageDtoTestData {
"html": "html",
"i18n": {},
"id": "8584452-6d711169-0224-41c2-b9aa-1adbe624521b",
"latest_reactions": [${ReactionDtoTestData.downstreamJsonWithoutExtraData}],
"latest_reactions": [${ReactionDtoTestData.reactionResponseJson}],
"mentioned_users": [${UserDtoTestData.downstreamJsonWithoutExtraData}],
"mentioned_here": true,
"mentioned_channel": true,
Expand Down Expand Up @@ -158,7 +158,7 @@ internal object MessageDtoTestData {
last_reaction_at = Date(1591787071588),
),
),
latest_reactions = listOf(ReactionDtoTestData.downstreamReactionWithoutExtraData),
latest_reactions = listOf(ReactionDtoTestData.reactionResponse),
own_reactions = emptyList(),
show_in_channel = false,
mentioned_users = listOf(UserDtoTestData.downstreamUserWithoutExtraData),
Expand Down
36 changes: 27 additions & 9 deletions ...client/src/test/java/io/getstream/chat/android/client/parser2/testdata/MessageTestData.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ internal object MessageTestData {
"type": "like",
"score": 1,
"user_id": "user-2",
"user": {"id": "user-2", "role": "user", "banned": false, "online": true},
"user": {"id": "user-2", "role": "user", "banned": false, "online": true, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-01T00:00:00.000Z", "language": "en"},
"created_at": "2020-01-01T01:00:00.000Z",
"updated_at": "2020-01-01T01:00:00.000Z"
}
Expand All @@ -72,7 +72,7 @@ internal object MessageTestData {
"type": "love",
"score": 1,
"user_id": "user-1",
"user": {"id": "user-1", "role": "user", "banned": false, "online": true},
"user": {"id": "user-1", "role": "user", "banned": false, "online": true, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-01T00:00:00.000Z", "language": "en"},
"created_at": "2020-01-01T00:30:00.000Z",
"updated_at": "2020-01-01T00:30:00.000Z"
}
Expand Down Expand Up @@ -867,7 +867,7 @@ internal object MessageTestData {
"type": "like",
"score": 1,
"user_id": "user-2",
"user": {"id": "user-2", "role": "user", "banned": false, "online": true},
"user": {"id": "user-2", "role": "user", "banned": false, "online": true, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-01T00:00:00.000Z", "language": "en"},
"created_at": "2020-01-01T01:00:00.000Z",
"updated_at": "2020-01-01T01:00:00.000Z"
},
Expand All @@ -876,7 +876,7 @@ internal object MessageTestData {
"type": "love",
"score": 1,
"user_id": "user-3",
"user": {"id": "user-3", "role": "user", "banned": false, "online": true},
"user": {"id": "user-3", "role": "user", "banned": false, "online": true, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-01T00:00:00.000Z", "language": "en"},
"created_at": "2020-01-01T01:01:00.000Z",
"updated_at": "2020-01-01T01:01:00.000Z"
},
Expand All @@ -885,7 +885,7 @@ internal object MessageTestData {
"type": "haha",
"score": 1,
"user_id": "user-4",
"user": {"id": "user-4", "role": "user", "banned": false, "online": true},
"user": {"id": "user-4", "role": "user", "banned": false, "online": true, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-01T00:00:00.000Z", "language": "en"},
"created_at": "2020-01-01T01:02:00.000Z",
"updated_at": "2020-01-01T01:02:00.000Z"
}
Expand All @@ -896,7 +896,7 @@ internal object MessageTestData {
"type": "love",
"score": 1,
"user_id": "user-1",
"user": {"id": "user-1", "role": "user", "banned": false, "online": true},
"user": {"id": "user-1", "role": "user", "banned": false, "online": true, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-01T00:00:00.000Z", "language": "en"},
"created_at": "2020-01-01T00:30:00.000Z",
"updated_at": "2020-01-01T00:30:00.000Z"
},
Expand All @@ -905,7 +905,7 @@ internal object MessageTestData {
"type": "wow",
"score": 1,
"user_id": "user-1",
"user": {"id": "user-1", "role": "user", "banned": false, "online": true},
"user": {"id": "user-1", "role": "user", "banned": false, "online": true, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-01T00:00:00.000Z", "language": "en"},
"created_at": "2020-01-01T00:31:00.000Z",
"updated_at": "2020-01-01T00:31:00.000Z"
}
Expand Down Expand Up @@ -936,7 +936,16 @@ internal object MessageTestData {
type = "like",
score = 1,
userId = "user-2",
user = User(id = "user-2", role = "user", invisible = null, banned = false, online = true),
user = User(
id = "user-2",
role = "user",
invisible = null,
banned = false,
online = true,
language = "en",
createdAt = Date(1577836800000L),
updatedAt = Date(1577836800000L),
),
createdAt = Date(1577840400000L),
updatedAt = Date(1577840400000L),
),
Expand All @@ -947,7 +956,16 @@ internal object MessageTestData {
type = "love",
score = 1,
userId = "user-1",
user = User(id = "user-1", role = "user", invisible = null, banned = false, online = true),
user = User(
id = "user-1",
role = "user",
invisible = null,
banned = false,
online = true,
language = "en",
createdAt = Date(1577836800000L),
updatedAt = Date(1577836800000L),
),
createdAt = Date(1577838600000L),
updatedAt = Date(1577838600000L),
),
Expand Down
27 changes: 27 additions & 0 deletions ...nt/src/test/java/io/getstream/chat/android/client/parser2/testdata/ReactionDtoTestData.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package io.getstream.chat.android.client.parser2.testdata

import io.getstream.chat.android.client.api2.model.dto.DownstreamReactionDto
import io.getstream.chat.android.network.models.ReactionRequest
import io.getstream.chat.android.network.models.ReactionResponse
import org.intellij.lang.annotations.Language
import java.util.Date

Expand Down Expand Up @@ -78,6 +79,32 @@ internal object ReactionDtoTestData {
extraData = emptyMap(),
)

/**
* The wire always sends both timestamps and a full user for a reaction, so the generated model
* declares them non-null.
*/
@Language("JSON")
val reactionResponseJson =
"""{
"message_id": "8584452-6d711169-0224-41c2-b9aa-1adbe624521b",
"score": 0,
"type": "like",
"user": ${UserDtoTestData.userResponseJson},
"user_id": "",
"created_at": "2020-06-10T11:04:31.000Z",
"updated_at": "2020-06-10T11:04:31.588Z"
}""".withoutWhitespace()

val reactionResponse = ReactionResponse(
messageId = "8584452-6d711169-0224-41c2-b9aa-1adbe624521b",
type = "like",
score = 0,
user = UserDtoTestData.userResponse,
userId = "",
createdAt = Date(1591787071000),
updatedAt = Date(1591787071588),
)

@Language("JSON")
val upstreamJsonWithoutExtraData =
"""{
Expand Down
Loading