Merge pull request #248 from RocketChat/fix/add-a-reaction-on-a-message-not-working

[FIX] Add a reaction on a message not working

Author: philipbrito

common/src/main/kotlin/chat/rocket/common/model/BaseUser.kt

@@ -39,4 +39,31 @@ fun userStatusOf(status: String): UserStatus {
         "offline" -> UserStatus.Offline()
         else -> UserStatus.Unknown(status)
     }
-}
+}
+
+@FallbackSealedClass(name = "Unknown", fieldName = "rawAvatar")
+sealed class UserAvatar {
+    @Json(name = "upload")
+    class Upload : chat.rocket.common.model.UserAvatar()
+    @Json(name = "url")
+    class Url : chat.rocket.common.model.UserAvatar()
+    class Cleared : chat.rocket.common.model.UserAvatar()
+    class Unknown(val rawAvatar: String) : UserAvatar()
+
+    override fun toString(): String {
+        return when (this) {
+            is Upload -> "upload"
+            is Url -> "url"
+            else -> "cleared"
+        }
+    }
+}
+
+fun userAvatarOf(avatar: String): UserAvatar {
+    return when(avatar) {
+        "upload" -> UserAvatar.Upload()
+        "url" -> UserAvatar.Url()
+        "cleared" -> UserAvatar.Cleared()
+        else -> UserAvatar.Unknown(avatar)
+    }
+}

compat/src/main/kotlin/chat/rocket/core/compat/Server.kt

@@ -5,9 +5,13 @@ import chat.rocket.core.RocketChatClient
 import chat.rocket.core.compat.internal.callback
 import chat.rocket.core.internal.rest.serverInfo
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.InternalCoroutinesApi
 
 /**
  * Returns the current logged server information.
  * Must be used with a coroutine context (async, launch, etc)
  */
+@ExperimentalCoroutinesApi
+@InternalCoroutinesApi
 fun RocketChatClient.serverInfo(future: Callback<ServerInfo>): Call = callback(Dispatchers.IO, future) { serverInfo() }

compat/src/main/kotlin/chat/rocket/core/compat/User.kt

@@ -5,9 +5,13 @@ import chat.rocket.core.compat.internal.callback
 import chat.rocket.core.internal.rest.me
 import chat.rocket.core.model.Myself
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.InternalCoroutinesApi
 
 /**
  * Returns the current logged user information, useful to check if the Token from TokenProvider
  * is still valid. Must be used with a coroutine context (async, launch, etc)
  */
+@ExperimentalCoroutinesApi
+@InternalCoroutinesApi
 fun RocketChatClient.me(future: Callback<Myself>): Call = callback(Dispatchers.IO, future) { me() }

compat/src/main/kotlin/chat/rocket/core/compat/internal/Callback.kt

@@ -6,13 +6,16 @@ import chat.rocket.core.compat.Callback
 import kotlinx.coroutines.AbstractCoroutine
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.InternalCoroutinesApi
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.newCoroutineContext
 import kotlin.coroutines.CoroutineContext
 import kotlin.coroutines.startCoroutine
 
+@ExperimentalCoroutinesApi
+@InternalCoroutinesApi
 @JvmOverloads
 fun <T> callback(
     context: CoroutineContext = Dispatchers.Default,
@@ -26,7 +29,7 @@ fun <T> callback(
     return Call(job)
 }
 
-@UseExperimental(InternalCoroutinesApi::class)
+@InternalCoroutinesApi
 private class CallbackCoroutine<in T>(
     parentContext: CoroutineContext,
     private val callback: Callback<T>

core/src/main/kotlin/chat/rocket/core/RocketChatClient.kt

@@ -11,14 +11,14 @@ import chat.rocket.common.util.NoOpLogger
 import chat.rocket.common.util.PlatformLogger
 import chat.rocket.common.util.RealLogger
 import chat.rocket.common.util.ifNull
-import chat.rocket.core.internal.RestResult
-import chat.rocket.core.internal.RestMultiResult
-import chat.rocket.core.internal.SettingsAdapter
 import chat.rocket.core.internal.AttachmentAdapterFactory
-import chat.rocket.core.internal.RoomListAdapterFactory
 import chat.rocket.core.internal.CoreJsonAdapterFactory
 import chat.rocket.core.internal.MessageListAdapterFactory
 import chat.rocket.core.internal.ReactionsAdapter
+import chat.rocket.core.internal.RestMultiResult
+import chat.rocket.core.internal.RestResult
+import chat.rocket.core.internal.RoomListAdapterFactory
+import chat.rocket.core.internal.SettingsAdapter
 import chat.rocket.core.internal.model.Subscription
 import chat.rocket.core.internal.realtime.socket.Socket
 import chat.rocket.core.internal.realtime.socket.model.State
@@ -55,13 +55,13 @@ class RocketChatClient private constructor(
         .add(AttachmentAdapterFactory(logger))
         .add(RoomListAdapterFactory(logger))
         .add(MessageListAdapterFactory(logger))
+        .add(ReactionsAdapter())
         .add(MetaJsonAdapter.ADAPTER_FACTORY)
         .add(java.lang.Long::class.java, ISO8601Date::class.java, TimestampAdapter(CalendarISO8601Converter()))
         .add(Long::class.java, ISO8601Date::class.java, TimestampAdapter(CalendarISO8601Converter()))
         // XXX - MAKE SURE TO KEEP CommonJsonAdapterFactory and CoreJsonAdapterFactory as the latest Adapters...
         .add(CommonJsonAdapterFactory.INSTANCE)
         .add(CoreJsonAdapterFactory.INSTANCE)
-        .add(ReactionsAdapter())
         .build()
 
     internal lateinit var restUrl: HttpUrl

core/src/main/kotlin/chat/rocket/core/internal/ReactionsAdapter.kt

@@ -57,8 +57,13 @@ class ReactionsAdapter : JsonAdapter<Reactions>() {
             reader.endObject()
             reactions.set(shortname, usernameList, nameList)
         }
-        reader.endObject()
-        reader.endObject()
+
+        if (reader.peek() == JsonReader.Token.END_OBJECT) {
+            reader.endObject()
+        }
+        if (reader.peek() == JsonReader.Token.END_OBJECT) {
+            reader.endObject()
+        }
         return reactions
     }
 

core/src/main/kotlin/chat/rocket/core/internal/model/Subscription.kt

@@ -12,11 +12,12 @@ import se.ansman.kotshi.JsonSerializable
 @JsonSerializable
 data class Subscription(
     @Json(name = "rid") val roomId: String,
+    @Json(name = "prid") val parentId: String?, // Not empty if it is a discussion
     @Json(name = "_id") override val id: String,
     @Json(name = "t") override val type: RoomType,
     @Json(name = "u") override val user: SimpleUser?,
-    val name: String?,
-    @Json(name = "fname") override val fullName: String?,
+    val name: String?, // Name of the subscription
+    @Json(name = "fname") override val fullName: String?, // Full name of the user, in the case of using the full user name setting (UI_Use_Real_Name)
     @Json(name = "ro") override val readonly: Boolean? = false,
     @Json(name = "ts") @ISO8601Date val timestamp: Long?,
     @Json(name = "ls") @ISO8601Date val lastSeen: Long?,

core/src/main/kotlin/chat/rocket/core/internal/realtime/socket/Login.kt

@@ -6,7 +6,9 @@ import chat.rocket.core.internal.realtime.socket.model.State
 import chat.rocket.core.internal.model.TypedResponse
 import chat.rocket.core.internal.realtime.message.loginMethod
 import com.squareup.moshi.Types
+import kotlinx.coroutines.ObsoleteCoroutinesApi
 
+@ObsoleteCoroutinesApi
 fun Socket.login(token: Token?) {
     token?.let { authToken ->
         socket?.let {
@@ -16,6 +18,7 @@ fun Socket.login(token: Token?) {
     }
 }
 
+@ObsoleteCoroutinesApi
 internal fun Socket.processLoginResult(text: String) {
     val type = Types.newParameterizedType(TypedResponse::class.java, SocketToken::class.java)
     val adapter = moshi.adapter<TypedResponse<SocketToken>>(type)

core/src/main/kotlin/chat/rocket/core/internal/realtime/socket/Socket.kt

@@ -17,9 +17,12 @@ import chat.rocket.core.model.Room
 import com.squareup.moshi.JsonAdapter
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.Job
+import kotlinx.coroutines.ObsoleteCoroutinesApi
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.channels.SendChannel
+import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.isActive
 import kotlinx.coroutines.launch
@@ -35,6 +38,7 @@ import kotlin.coroutines.CoroutineContext
 
 const val PING_INTERVAL = 15000L
 
+@ObsoleteCoroutinesApi
 class Socket(
     internal val client: RocketChatClient,
     internal val roomsChannel: SendChannel<StreamMessage<Room>>,
@@ -71,6 +75,7 @@ class Socket(
 
     internal val subscriptionsMap = HashMap<String, (Boolean, String) -> Unit>()
 
+    @ObsoleteCoroutinesApi
     private val connectionContext = newSingleThreadContext("connection-context")
     private val reconnectionStrategy = ReconnectionStrategy()
     private var reconnectJob: Job? = null
@@ -84,6 +89,7 @@ class Socket(
         socketMessageAdapter = moshi.adapter(SocketMessage::class.java)
     }
 
+    @ObsoleteCoroutinesApi
     internal fun connect(resetCounter: Boolean = false) {
         selfDisconnect = false
         // reset id counter
@@ -101,6 +107,7 @@ class Socket(
         socket = httpClient.newWebSocket(request, this)
     }
 
+    @ObsoleteCoroutinesApi
     internal fun disconnect() {
         when (currentState) {
             State.Disconnected() -> return
@@ -116,6 +123,7 @@ class Socket(
         }
     }
 
+    @ObsoleteCoroutinesApi
     private fun startReconnection() {
         // Ignore  self disconnection
         if (selfDisconnect) {
@@ -142,10 +150,11 @@ class Socket(
         }
     }
 
+    @ObsoleteCoroutinesApi
     private suspend fun delayReconnection(reconnectInterval: Int) {
         val seconds = reconnectInterval / 1000
         withContext(connectionContext) {
-            for (second in 0..(seconds - 1)) {
+            for (second in 0 until seconds) {
                 if (!coroutineContext.isActive) {
                     logger.debug { "Reconnect job inactive, ignoring" }
                     return@withContext
@@ -158,6 +167,7 @@ class Socket(
         }
     }
 
+    @ExperimentalCoroutinesApi
     private fun processIncomingMessage(text: String) {
         messagesProcessed++
         logger.debug {
@@ -175,7 +185,7 @@ class Socket(
             return
         }
 
-        reschedulePing(message.type)
+        reschedulePing()
 
         when (currentState) {
             is State.Connecting -> {
@@ -193,6 +203,7 @@ class Socket(
         }
     }
 
+    @ObsoleteCoroutinesApi
     private fun processConnectionMessage(message: SocketMessage) {
         when (message.type) {
             MessageType.CONNECTED -> {
@@ -205,6 +216,8 @@ class Socket(
         }
     }
 
+    @ObsoleteCoroutinesApi
+    @ExperimentalCoroutinesApi
     private fun processAuthenticationResponse(message: SocketMessage, text: String) {
         when (message.type) {
             MessageType.ADDED, MessageType.UPDATED -> {
@@ -224,6 +237,7 @@ class Socket(
         }
     }
 
+    @ExperimentalCoroutinesApi
     private fun processMessage(message: SocketMessage, text: String) {
         when (message.type) {
             MessageType.PING -> {
@@ -245,7 +259,7 @@ class Socket(
         socket?.send(message)
     }
 
-    private fun reschedulePing(type: MessageType) {
+    private fun reschedulePing() {
         logger.debug { "Rescheduling ping in $PING_INTERVAL milliseconds" }
 
         timeoutJob?.cancel()
@@ -266,20 +280,23 @@ class Socket(
     private suspend fun schedulePingTimeout() {
         val timeout = (PING_INTERVAL * 1.5).toLong()
         logger.debug { "Scheduling ping timeout in $timeout milliseconds" }
-        timeoutJob = launch(parentJob) {
-            delay(timeout)
-            if (!isActive) return@launch
-            when (currentState) {
-                is State.Disconnected,
-                is State.Disconnecting -> logger.warn { "Pong not received, but already disconnected" }
-                else -> {
-                    logger.warn { "Pong not received" }
-                    socket?.cancel()
+        timeoutJob = coroutineScope {
+            launch(parentJob) {
+                delay(timeout)
+                if (!isActive) return@launch
+                when (currentState) {
+                    is State.Disconnected,
+                    is State.Disconnecting -> logger.warn { "Pong not received, but already disconnected" }
+                    else -> {
+                        logger.warn { "Pong not received" }
+                        socket?.cancel()
+                    }
                 }
             }
         }
     }
 
+    @ObsoleteCoroutinesApi
     internal fun setState(newState: State) {
         if (newState != currentState) {
             logger.debug { "Setting state to: $newState - oldState: $currentState, channels: ${statusChannelList.size}" }
@@ -288,6 +305,7 @@ class Socket(
         }
     }
 
+    @ObsoleteCoroutinesApi
     private fun sendState(state: State) {
         launch(connectionContext) {
             for (channel in statusChannelList) {
@@ -306,6 +324,7 @@ class Socket(
         parentJob.cancel()
     }
 
+    @ExperimentalCoroutinesApi
     override fun onOpen(webSocket: WebSocket, response: Response?) {
         readJob = launch {
             for (message in processingChannel!!) {
@@ -316,6 +335,7 @@ class Socket(
         send(CONNECT_MESSAGE)
     }
 
+    @ObsoleteCoroutinesApi
     override fun onFailure(webSocket: WebSocket, throwable: Throwable?, response: Response?) {
         logger.warn { "Socket.onFailure(). THROWABLE MESSAGE: ${throwable?.message} -  RESPONSE MESSAGE: ${response?.message()}" }
         throwable?.printStackTrace()
@@ -324,18 +344,21 @@ class Socket(
         startReconnection()
     }
 
+    @ObsoleteCoroutinesApi
     override fun onClosing(webSocket: WebSocket, code: Int, reason: String?) {
         logger.warn { "Socket.onClosing() called. Received CODE = $code - Received REASON = $reason" }
         setState(State.Disconnecting())
         startReconnection()
     }
+    @ObsoleteCoroutinesApi
     override fun onClosed(webSocket: WebSocket, code: Int, reason: String?) {
         logger.warn { "Socket.onClosed() called. Received CODE = $code - Received REASON = $reason" }
         setState(State.Disconnected())
         close()
         startReconnection()
     }
 
+    @ExperimentalCoroutinesApi
     override fun onMessage(webSocket: WebSocket, text: String?) {
         logger.warn { "Socket.onMessage(). Received TEXT = $text for processing channel = $processingChannel" }
         text?.let {
@@ -357,6 +380,8 @@ class Socket(
     }
 }
 
+@ObsoleteCoroutinesApi
 fun RocketChatClient.connect(resetCounter: Boolean = false) = socket.connect(resetCounter)
 
+@ObsoleteCoroutinesApi
 fun RocketChatClient.disconnect() = socket.disconnect()