feat: Socket subscribe improvements

crowdin/src/main/java/com/crowdin/platform/data/DataManager.kt

@@ -22,6 +22,7 @@
 import com.crowdin.platform.util.FeatureFlags
 import com.crowdin.platform.util.ThreadUtils
 import com.crowdin.platform.util.getFormattedCode
+import com.google.gson.reflect.TypeToken
 import java.lang.reflect.Type
 import java.util.Locale
 
@@ -41,6 +42,8 @@
         const val SUPPORTED_LANGUAGES = "supported_languages"
         const val MANIFEST_DATA = "manifest_data"
         const val SYNC_DATA = "sync_data"
+        const val EVENT_TICKETS = "event_tickets"
+        const val EVENT_TICKETS_EXPIRATION = 1000 * 60 * 4
     }
 
     private var loadingStateListeners: ArrayList<LoadingStateListener>? = null
@@ -266,4 +269,40 @@
 
         return info
     }
+
+    @WorkerThread
+    fun getTicket(event: String): String? {
+        var ticketValue: String? = null
+        val type = object : TypeToken<MutableMap<String, TicketItem>>() {}.type
+        var ticketsMap: MutableMap<String, TicketItem>? = localRepository.getData(EVENT_TICKETS, type)
+        if (ticketsMap == null) {
+            ticketsMap = mutableMapOf()
+        }
+
+        val ticketItem = ticketsMap[event]
+        if (ticketItem == null || ticketItem.isExpired()) {
+            Log.d(CROWDIN_TAG, "Ticket expired for event: $event")
+            remoteRepository.getTicket(event)?.data?.ticket?.let {
+                ticketsMap[event] = TicketItem(it, System.currentTimeMillis() + EVENT_TICKETS_EXPIRATION)
+                localRepository.saveData(EVENT_TICKETS, ticketsMap)
+                ticketValue = it
+            }
+        } else {
+            Log.d(CROWDIN_TAG, "Ticket not expired for event: $event")
+            ticketValue = ticketItem.ticket
+        }
+
+        return ticketValue
+    }
+
+    fun clearSocketData() {
+        localRepository.saveData(EVENT_TICKETS, null)
+    }
+
+    data class TicketItem(
+        val ticket: String,
+        val expirationTime: Long,
+    ) {
+        fun isExpired(): Boolean = System.currentTimeMillis() > expirationTime
+    }
 }

crowdin/src/main/java/com/crowdin/platform/data/model/TicketRequestBody.kt

@@ -0,0 +1,10 @@
+package com.crowdin.platform.data.model
+
+internal data class TicketRequestBody(
+    val event: String,
+    val context: ContextData = ContextData(),
+)
+
+internal data class ContextData(
+    val mode: String = "translate",
+)

crowdin/src/main/java/com/crowdin/platform/data/model/TicketResponseBody.kt

@@ -0,0 +1,9 @@
+package com.crowdin.platform.data.model
+
+internal data class TicketResponseBody(
+    val data: TicketData,
+)
+
+internal data class TicketData(
+    val ticket: String,
+)

crowdin/src/main/java/com/crowdin/platform/data/remote/CrowdingRepository.kt

@@ -7,6 +7,8 @@
 import com.crowdin.platform.data.model.LanguageInfo
 import com.crowdin.platform.data.model.LanguagesInfo
 import com.crowdin.platform.data.model.ManifestData
+import com.crowdin.platform.data.model.TicketRequestBody
+import com.crowdin.platform.data.model.TicketResponseBody
 import com.crowdin.platform.data.remote.api.CrowdinApi
 import com.crowdin.platform.data.remote.api.CrowdinDistributionApi
 import com.crowdin.platform.util.ThreadUtils
@@ -94,6 +96,13 @@
         return info
     }
 
+    @WorkerThread
+    override fun getTicket(event: String): TicketResponseBody? {
+        var result: TicketResponseBody? = null
+        executeIO { result = crowdinApi?.getTicket(TicketRequestBody(event))?.execute()?.body() }
+        return result
+    }
+
     fun getLanguageInfo(sourceLanguage: String): LanguageInfo? {
         crowdinLanguages?.data?.forEach {
             val languageInfo = it.data

crowdin/src/main/java/com/crowdin/platform/data/remote/RemoteRepository.kt

@@ -5,6 +5,7 @@ import com.crowdin.platform.data.LanguageDataCallback
 import com.crowdin.platform.data.model.LanguageData
 import com.crowdin.platform.data.model.LanguagesInfo
 import com.crowdin.platform.data.model.ManifestData
+import com.crowdin.platform.data.model.TicketResponseBody
 
 /**
  * Repository of strings from network.
@@ -32,4 +33,10 @@ internal interface RemoteRepository {
      */
     @WorkerThread
     fun getSupportedLanguages(): LanguagesInfo?
+
+    /**
+     * Fetch ticket for WebSocket connection.
+     */
+    @WorkerThread
+    fun getTicket(event: String): TicketResponseBody?
 }

crowdin/src/main/java/com/crowdin/platform/data/remote/api/CrowdinApi.kt

@@ -4,6 +4,8 @@ import com.crowdin.platform.data.model.BuildTranslationRequest
 import com.crowdin.platform.data.model.FileResponse
 import com.crowdin.platform.data.model.LanguagesInfo
 import com.crowdin.platform.data.model.ListScreenshotsResponse
+import com.crowdin.platform.data.model.TicketRequestBody
+import com.crowdin.platform.data.model.TicketResponseBody
 import com.crowdin.platform.data.model.TranslationResponse
 import okhttp3.RequestBody
 import okhttp3.ResponseBody
@@ -80,4 +82,9 @@ internal interface CrowdinApi {
     fun getLanguagesInfo(
         @Query("limit") limit: Int = LANGUAGE_COUNT,
     ): Call<LanguagesInfo>
+
+    @POST("/api/v2/user/websocket-ticket")
+    fun getTicket(
+        @Body body: TicketRequestBody,
+    ): Call<TicketResponseBody>
 }

crowdin/src/main/java/com/crowdin/platform/realtimeupdate/EchoWebSocketListener.kt

@@ -4,6 +4,8 @@
 import android.os.Build
 import android.util.Log
 import android.widget.TextView
+import com.crowdin.platform.Crowdin
+import com.crowdin.platform.data.DataManager
 import com.crowdin.platform.data.getMappingValueForKey
 import com.crowdin.platform.data.model.LanguageData
 import com.crowdin.platform.data.model.TextMetaData
@@ -23,7 +25,11 @@
 import java.util.Locale
 import java.util.WeakHashMap
 
+private const val UPDATE_DRAFT = "update-draft"
+private const val TOP_SUGGESTION = "top-suggestion"
+
 internal class EchoWebSocketListener(
+    private val dataManager: DataManager,
     private var mappingData: LanguageData,
     private var distributionData: DistributionInfoResponse.DistributionData,
     private var viewTransformerManager: ViewTransformerManager,
@@ -41,7 +47,9 @@
         val user = distributionData.user
 
         saveMatchedTextViewWithMappingId(mappingData)
-        subscribeViews(webSocket, project, user)
+        ThreadUtils.runInBackgroundPool({
+            subscribeViews(webSocket, project, user)
+        }, false)
 
         viewTransformerManager.setOnViewsChangeListener(
             object : ViewsChangeListener {
@@ -80,6 +88,7 @@
         code: Int,
         reason: String,
     ) {
+        dataManager.clearSocketData()
         dataHolderMap.clear()
         webSocket.close(NORMAL_CLOSURE_STATUS, reason)
         output("Closing : $code / $reason")
@@ -123,26 +132,35 @@
         user: DistributionInfoResponse.DistributionData.UserData,
         mappingValue: String,
     ) {
-        webSocket.send(
-            SubscribeUpdateEvent(
-                project.wsHash,
-                project.id,
-                user.id,
-                languageCode,
-                mappingValue,
-            ).toString(),
-        )
+        try {
+            val updateEvent = "$UPDATE_DRAFT:${project.wsHash}:${project.id}:${user.id}:$languageCode:$mappingValue"
+            dataManager.getTicket(updateEvent)?.let {
+                webSocket.send(getSubscribeEventJson(updateEvent, it))
+            }
+        } catch (e: Exception) {
+            Log.e(Crowdin.CROWDIN_TAG, "Get ticket for update event failed", e)
+        }
 
-        webSocket.send(
-            SubscribeSuggestionEvent(
-                project.wsHash,
-                project.id,
-                languageCode,
-                mappingValue,
-            ).toString(),
-        )
+        try {
+            val suggestionEvent = "$TOP_SUGGESTION:${project.wsHash}:${project.id}:$languageCode:$mappingValue"
+            dataManager.getTicket(suggestionEvent)?.let {
+                webSocket.send(getSubscribeEventJson(suggestionEvent, it))
+            }
+        } catch (e: Exception) {
+            Log.e(Crowdin.CROWDIN_TAG, "Get ticket for suggestion event failed", e)
+        }
     }
 
+    private fun getSubscribeEventJson(
+        eventType: String,
+        ticket: String,
+    ): String =
+        "{" +
+            "\"action\":\"subscribe\", " +
+            "\"event\":\"$eventType\", " +
+            "\"ticket\": \"$ticket\"" +
+            "}"
+
     private fun handleMessage(message: String?) {
         message?.let {
             val eventResponse = parseResponse(it)

crowdin/src/main/java/com/crowdin/platform/realtimeupdate/RealTimeUpdateManager.kt

@@ -59,6 +59,7 @@
                 val languageCode = getMatchedCode(it.languages, it.customLanguages) ?: return@let
                 val listener =
                     EchoWebSocketListener(
+                        dataManager,
                         mappingData,
                         distributionData,
                         viewTransformerManager,

crowdin/src/test/java/com/crowdin/platform/EchoWebSocketListenerTest.kt

@@ -1,5 +1,6 @@
 package com.crowdin.platform
 
+import com.crowdin.platform.data.DataManager
 import com.crowdin.platform.data.model.LanguageData
 import com.crowdin.platform.data.remote.api.DistributionInfoResponse
 import com.crowdin.platform.realtimeupdate.EchoWebSocketListener
@@ -17,9 +18,11 @@ class EchoWebSocketListenerTest {
         // Given
         val mockMappingData = spy(LanguageData::class.java)
         val mockDistributionData = mock(DistributionInfoResponse.DistributionData::class.java)
+        val mockDataManager = mock(DataManager::class.java)
         val mockViewTransformerManager = spy(ViewTransformerManager::class.java)
         val echoWebSocketListener =
             EchoWebSocketListener(
+                mockDataManager,
                 mockMappingData,
                 mockDistributionData,
                 mockViewTransformerManager,
@@ -38,9 +41,11 @@ class EchoWebSocketListenerTest {
         // Given
         val mockMappingData = spy(LanguageData::class.java)
         val mockDistributionData = mock(DistributionInfoResponse.DistributionData::class.java)
+        val mockDataManager = mock(DataManager::class.java)
         val mockViewTransformerManager = spy(ViewTransformerManager::class.java)
         val echoWebSocketListener =
             EchoWebSocketListener(
+                mockDataManager,
                 mockMappingData,
                 mockDistributionData,
                 mockViewTransformerManager,