Perform Url decoding for channels history calls (#47)

* Perform Url decoding for channels history calls * Bump pubnub-kotlin * Review feedback + make urlDecode internal
pubnub · Jul 30, 2024 · 64ca6d8 · 64ca6d8
1 parent a04dc28
commit 64ca6d8
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 13 deletions.
diff --git a/.github/workflows/release/chat-maven-build.sh b/.github/workflows/release/chat-maven-build.sh
@@ -1,2 +1,2 @@
 echo "Build Chat SDK module artifacts"
-./gradlew jar
+./gradlew jar --no-configuration-cache
diff --git a/.github/workflows/release/chat-maven-publish.sh b/.github/workflows/release/chat-maven-publish.sh
@@ -1 +1 @@
-./gradlew publishToSonatype closeSonatypeStagingRepository
+./gradlew publishToSonatype closeSonatypeStagingRepository --no-configuration-cache
diff --git a/.github/workflows/release/pre-github-pages-publish.sh b/.github/workflows/release/pre-github-pages-publish.sh
@@ -1 +1 @@
-./gradlew :dokkaGfmMultiModule
+./gradlew :dokkaGfmMultiModule --no-configuration-cache
diff --git a/pubnub-chat-impl/src/commonMain/kotlin/com/pubnub/chat/internal/ChatImpl.kt b/pubnub-chat-impl/src/commonMain/kotlin/com/pubnub/chat/internal/ChatImpl.kt
@@ -58,6 +58,7 @@ import com.pubnub.chat.internal.serialization.PNDataEncoder
 import com.pubnub.chat.internal.timer.PlatformTimer
 import com.pubnub.chat.internal.timer.PlatformTimer.Companion.runPeriodically
 import com.pubnub.chat.internal.timer.PlatformTimer.Companion.runWithDelay
+import com.pubnub.chat.internal.util.channelsUrlDecoded
 import com.pubnub.chat.internal.util.getPhraseToLookFor
 import com.pubnub.chat.internal.utils.cyrb53a
 import com.pubnub.chat.membership.MembershipsResponse
@@ -858,7 +859,7 @@ class ChatImpl(
             includeMessageActions = false,
             includeMessageType = true
         ).then { pnFetchMessagesResult: PNFetchMessagesResult ->
-            val pnFetchMessageItems: List<PNFetchMessageItem> = pnFetchMessagesResult.channels[channelId] ?: emptyList()
+            val pnFetchMessageItems: List<PNFetchMessageItem> = pnFetchMessagesResult.channelsUrlDecoded[channelId] ?: emptyList()
             val events: Set<Event<EventContent>> =
                 pnFetchMessageItems.map { pnFetchMessageItem: PNFetchMessageItem ->
                     EventImpl.fromDTO(chat = this, channelId = channelId, pnFetchMessageItem = pnFetchMessageItem)
@@ -922,9 +923,7 @@ class ChatImpl(
         channelId: String,
         pnFetchMessagesResult: PNFetchMessagesResult
     ): Long {
-        // todo in TS there is encodeURIComponent(channelId) do we need this?
-        // created CLEN-2183 for PubNub SDK
-        val relevantLastMessage: List<PNFetchMessageItem>? = pnFetchMessagesResult.channels[channelId]
+        val relevantLastMessage: List<PNFetchMessageItem>? = pnFetchMessagesResult.channelsUrlDecoded[channelId]
         return relevantLastMessage?.firstOrNull()?.timetoken ?: 0
     }
 

diff --git a/pubnub-chat-impl/src/commonMain/kotlin/com/pubnub/chat/internal/channel/BaseChannel.kt b/pubnub-chat-impl/src/commonMain/kotlin/com/pubnub/chat/internal/channel/BaseChannel.kt
@@ -51,6 +51,7 @@ import com.pubnub.chat.internal.message.MessageImpl
 import com.pubnub.chat.internal.restrictions.RestrictionImpl
 import com.pubnub.chat.internal.serialization.PNDataEncoder
 import com.pubnub.chat.internal.timer.PlatformTimer.Companion.runWithDelay
+import com.pubnub.chat.internal.util.channelsUrlDecoded
 import com.pubnub.chat.internal.util.getPhraseToLookFor
 import com.pubnub.chat.internal.utils.ExponentialRateLimiter
 import com.pubnub.chat.internal.uuidFilterString
@@ -691,10 +692,10 @@ abstract class BaseChannel<C : Channel, M : Message>(
                 includeMeta = true
             ).then { pnFetchMessagesResult: PNFetchMessagesResult ->
                 HistoryResponse(
-                    messages = pnFetchMessagesResult.channels[channelId]?.map { messageItem: PNFetchMessageItem ->
+                    messages = pnFetchMessagesResult.channelsUrlDecoded[channelId]?.map { messageItem: PNFetchMessageItem ->
                         messageFactory(chat, messageItem, channelId)
                     } ?: error("Unable to read messages"),
-                    isMore = pnFetchMessagesResult.channels[channelId]?.size == count
+                    isMore = pnFetchMessagesResult.channelsUrlDecoded[channelId]?.size == count
                 )
             }.catch {
                 Result.failure(PubNubException(FAILED_TO_RETRIEVE_HISTORY_DATA, it))

diff --git a/pubnub-chat-impl/src/commonMain/kotlin/com/pubnub/chat/internal/util/Utils.kt b/pubnub-chat-impl/src/commonMain/kotlin/com/pubnub/chat/internal/util/Utils.kt
@@ -1,5 +1,8 @@
 package com.pubnub.chat.internal.util
 
+import com.pubnub.api.models.consumer.history.PNFetchMessageItem
+import com.pubnub.api.models.consumer.history.PNFetchMessagesResult
+
 internal fun getPhraseToLookFor(text: String, separator: String): String? {
     val lastAtIndex = text.lastIndexOf(separator)
     if (lastAtIndex == -1) {
@@ -16,3 +19,7 @@ internal fun getPhraseToLookFor(text: String, separator: String): String? {
     }
     return splitWords.joinToString(" ")
 }
+
+internal expect fun urlDecode(encoded: String): String
+
+internal val PNFetchMessagesResult.channelsUrlDecoded: Map<String, List<PNFetchMessageItem>> get() = channels.mapKeys { urlDecode(it.key) }
diff --git a/pubnub-chat-impl/src/commonTest/kotlin/com/pubnub/integration/BaseChatIntegrationTest.kt b/pubnub-chat-impl/src/commonTest/kotlin/com/pubnub/integration/BaseChatIntegrationTest.kt
@@ -41,7 +41,7 @@ abstract class BaseChatIntegrationTest : BaseIntegrationTest() {
         chatPam = ChatImpl(ChatConfiguration(), pubnubPam)
         channel01 = ChannelImpl(
             chat = chat,
-            id = randomString(),
+            id = randomString() + "!_=-@",
             name = randomString(),
             custom = mapOf(randomString() to randomString()),
             description = randomString(),
@@ -51,7 +51,7 @@ abstract class BaseChatIntegrationTest : BaseIntegrationTest() {
         )
         channel02 = ChannelImpl(
             chat = chat,
-            id = randomString(),
+            id = randomString() + "!_=-@",
             name = randomString(),
             custom = mapOf(randomString() to randomString()),
             description = randomString(),
@@ -81,7 +81,7 @@ abstract class BaseChatIntegrationTest : BaseIntegrationTest() {
         )
         channelPam = ChannelImpl(
             chat = chatPam,
-            id = randomString(),
+            id = randomString() + "!_=-@",
             name = randomString(),
             custom = mapOf(randomString() to randomString()),
             description = randomString(),

diff --git a/pubnub-chat-impl/src/commonTest/kotlin/com/pubnub/kmp/utils/UtilsTest.kt b/pubnub-chat-impl/src/commonTest/kotlin/com/pubnub/kmp/utils/UtilsTest.kt
@@ -43,4 +43,12 @@ class UtilsTest {
         val result = getPhraseToLookFor(phraseWithTwoWordsAfterHash, "#")
         assertEquals("$firstWord $secondWord", result)
     }
+
+    @Test
+    fun urlDecode() {
+        val input = "a_-%3D%40.%21%24%23%25%26%5E%3B"
+        val expected = "a_-=@.!\$#%&^;"
+
+        assertEquals(expected, com.pubnub.chat.internal.util.urlDecode(input))
+    }
 }
diff --git a/pubnub-chat-impl/src/iosMain/kotlin/com/pubnub/chat/internal/util/Utils.ios.kt b/pubnub-chat-impl/src/iosMain/kotlin/com/pubnub/chat/internal/util/Utils.ios.kt
@@ -0,0 +1,5 @@
+package com.pubnub.chat.internal.util
+
+internal actual fun urlDecode(encoded: String): String {
+    TODO("Not yet implemented")
+}
diff --git a/pubnub-chat-impl/src/jsMain/kotlin/com/pubnub/chat/internal/util/Utils.js.kt b/pubnub-chat-impl/src/jsMain/kotlin/com/pubnub/chat/internal/util/Utils.js.kt
@@ -0,0 +1,5 @@
+package com.pubnub.chat.internal.util
+
+internal actual fun urlDecode(encoded: String): String = decodeURIComponent(encoded)
+
+external fun decodeURIComponent(encoded: String): String
diff --git a/pubnub-chat-impl/src/jvmMain/kotlin/com/pubnub/chat/internal/util/Utils.jvm.kt b/pubnub-chat-impl/src/jvmMain/kotlin/com/pubnub/chat/internal/util/Utils.jvm.kt
@@ -0,0 +1,5 @@
+package com.pubnub.chat.internal.util
+
+import java.net.URLDecoder
+
+internal actual fun urlDecode(encoded: String): String = URLDecoder.decode(encoded, Charsets.UTF_8.name())
diff --git a/pubnub-kotlin b/pubnub-kotlin
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		./gradlew publishToSonatype closeSonatypeStagingRepository
		./gradlew publishToSonatype closeSonatypeStagingRepository --no-configuration-cache
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		./gradlew :dokkaGfmMultiModule
		./gradlew :dokkaGfmMultiModule --no-configuration-cache
+19 −4		.pubnub.yml
+18 −0		CHANGELOG.md
+2 −2		README.md
+1 −1		gradle.properties
+12 −0		...core/pubnub-core-api/src/commonMain/kotlin/com/pubnub/api/models/consumer/push/payload/PushPayloadHelper.kt
+4 −1		...ub-core/pubnub-core-impl/src/main/kotlin/com/pubnub/internal/endpoints/remoteaction/RetryingRemoteAction.kt
+1 −1		pubnub-core/pubnub-core-impl/src/test/kotlin/com/pubnub/api/legacy/PubNubCoreTest.kt
+2 −0		...b-core/pubnub-core-impl/src/test/kotlin/com/pubnub/api/legacy/endpoints/push/PushPayloadHelperHelperTest.kt
+7 −0		...e/pubnub-core-impl/src/test/kotlin/com/pubnub/api/legacy/endpoints/remoteaction/RetryingRemoteActionTest.kt
+11 −1		pubnub-gson/pubnub-gson-impl/src/main/java/com/pubnub/internal/endpoints/presence/SetStateImpl.java
+1 −2		pubnub-kotlin/pubnub-kotlin-api/src/iosMain/kotlin/com/pubnub/api/endpoints/files/SendFile.ios.kt
+2 −1		pubnub-kotlin/pubnub-kotlin-api/src/iosMain/kotlin/com/pubnub/kmp/abstractions.ios.kt
+3 −0		...b-kotlin/pubnub-kotlin-impl/src/integrationTest/kotlin/com/pubnub/api/integration/ObjectsIntegrationTest.kt