Add error field to file result and set on decrypt error (#161)

* Add error field to file result and set on decrypt error

* PubNub SDK v7.7.4 release.

---------

Co-authored-by: PubNub Release Bot <[email protected]>

Author: wkal-pubnub

.pubnub.yml

@@ -1,9 +1,9 @@
 name: kotlin
-version: 7.7.3
+version: 7.7.4
 schema: 1
 scm: github.com/pubnub/kotlin
 files:
-  - build/libs/pubnub-kotlin-7.7.3-all.jar
+  - build/libs/pubnub-kotlin-7.7.4-all.jar
 sdks:
   - 
       type: library
@@ -23,8 +23,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: maven
-              package-name: pubnub-kotlin-7.7.3
-              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-kotlin/7.7.3/pubnub-kotlin-7.7.3.jar
+              package-name: pubnub-kotlin-7.7.4
+              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-kotlin/7.7.4/pubnub-kotlin-7.7.4.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -114,6 +114,11 @@ sdks:
                   license-url: https://www.apache.org/licenses/LICENSE-2.0.txt
                   is-required: Required
 changelog:
+  - date: 2023-11-28
+    version: v7.7.4
+    changes:
+      - type: feature
+        text: "Add `error` field to `PNFileEventResult` and set it in case of decryption failure."
   - date: 2023-11-23
     version: v7.7.3
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v7.7.4
+November 28 2023
+
+#### Added
+- Add `error` field to `PNFileEventResult` and set it in case of decryption failure.
+
 ## v7.7.3
 November 23 2023
 

README.md

@@ -20,13 +20,13 @@ You will need the publish and subscribe keys to authenticate your app. Get your
      <dependency>
         <groupId>com.pubnub</groupId>
         <artifactId>pubnub-kotlin</artifactId>
-        <version>7.7.3</version>
+        <version>7.7.4</version>
      </dependency>
      ```
 
    * for Gradle, add the following dependency in your `gradle.build`:
      ```groovy
-     implementation 'com.pubnub:pubnub-kotlin:7.7.3'
+     implementation 'com.pubnub:pubnub-kotlin:7.7.4'
      ```
 
 2. Configure your keys:

gradle.properties

@@ -21,7 +21,7 @@ SONATYPE_HOST=DEFAULT
 SONATYPE_AUTOMATIC_RELEASE=true
 GROUP=com.pubnub
 POM_ARTIFACT_ID=pubnub-kotlin
-VERSION_NAME=7.7.3
+VERSION_NAME=7.7.4
 POM_PACKAGING=jar
 
 POM_NAME=PubNub Kotlin SDK

src/main/kotlin/com/pubnub/api/PubNub.kt

@@ -106,7 +106,7 @@ class PubNub internal constructor(
 
     companion object {
         private const val TIMESTAMP_DIVIDER = 1000
-        private const val SDK_VERSION = "7.7.3"
+        private const val SDK_VERSION = "7.7.4"
         private const val MAX_SEQUENCE = 65535
 
         /**

src/main/kotlin/com/pubnub/api/PubNubError.kt

@@ -228,7 +228,7 @@ enum class PubNubError(private val code: Int, val message: String) {
 
     CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED(
         177,
-        "Crypto is configured but message is not encrypted."
+        "Message decryption failed using the current crypto configuration."
     ),
 
     ;

src/main/kotlin/com/pubnub/api/models/consumer/pubsub/files/PNFileEventResult.kt

@@ -1,6 +1,7 @@
 package com.pubnub.api.models.consumer.pubsub.files
 
 import com.google.gson.JsonElement
+import com.pubnub.api.PubNubError
 import com.pubnub.api.models.consumer.files.PNDownloadableFile
 import com.pubnub.api.models.consumer.pubsub.PNEvent
 
@@ -10,5 +11,6 @@ data class PNFileEventResult(
     val publisher: String?,
     val message: Any?,
     val file: PNDownloadableFile,
-    val jsonMessage: JsonElement
+    val jsonMessage: JsonElement,
+    val error: PubNubError? = null
 ) : PNEvent

src/main/kotlin/com/pubnub/api/workers/SubscribeMessageProcessor.kt

@@ -153,7 +153,8 @@ internal class SubscribeMessageProcessor(
                         publisher = message.issuingClientId,
                         timetoken = result.timetoken,
                         jsonMessage = fileUploadNotification.message?.let { pubnub.mapper.toJsonTree(it) }
-                            ?: JsonNull.INSTANCE
+                            ?: JsonNull.INSTANCE,
+                        error = error
                     )
                 }
 

src/test/kotlin/com/pubnub/api/legacy/PubNubTest.kt

@@ -71,7 +71,7 @@ class PubNubTest : BaseTest() {
     fun getVersionAndTimeStamp() {
         val version = pubnub.version
         val timeStamp = pubnub.timestamp()
-        assertEquals("7.7.3", version)
+        assertEquals("7.7.4", version)
         assertTrue(timeStamp > 0)
     }
 }

src/test/kotlin/com/pubnub/api/workers/SubscribeMessageProcessorTest.kt

@@ -8,6 +8,7 @@ import com.google.gson.JsonObject
 import com.google.gson.JsonPrimitive
 import com.pubnub.api.PNConfiguration
 import com.pubnub.api.PubNub
+import com.pubnub.api.PubNubError
 import com.pubnub.api.PubNubException
 import com.pubnub.api.UserId
 import com.pubnub.api.crypto.CryptoModule
@@ -81,6 +82,26 @@ class SubscribeMessageProcessorTest(
         assertThat((result as PNFileEventResult).jsonMessage, iz(messageJson))
     }
 
+    @Test
+    fun testProcessFileUnencryptedWithCrypto() {
+        val gson = Gson()
+        val configuration = config()
+        configuration.cryptoModule = CryptoModule.createAesCbcCryptoModule("enigma", false)
+
+        val messageProcessor = messageProcessor(configuration)
+
+        val result = messageProcessor.processIncomingPayload(
+            gson.fromJson(
+                fileMessage(messageJson.toString()),
+                SubscribeMessage::class.java
+            )
+        )
+
+        assertThat(result, isA(PNFileEventResult::class.java))
+        assertThat((result as PNFileEventResult).jsonMessage, iz(messageJson))
+        assertThat((result as PNFileEventResult).error, iz(PubNubError.CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED))
+    }
+
     @Test
     fun testProcessMessageEncryptedWithCrypto() {
         // given

src/test/kotlin/com/pubnub/extension/JsonElementTest.kt

@@ -5,6 +5,7 @@ import com.google.gson.JsonArray
 import com.google.gson.JsonElement
 import com.google.gson.JsonObject
 import com.google.gson.JsonPrimitive
+import com.pubnub.api.PubNubError
 import com.pubnub.api.crypto.CryptoModule
 import com.pubnub.api.managers.MapperManager
 import org.junit.jupiter.api.Assertions.assertEquals
@@ -94,7 +95,7 @@ class JsonElementTest {
 
         // then
         assertEquals(objectUnderTest, jsonElement)
-        assertEquals("Crypto is configured but message is not encrypted.", errorMessage?.message)
+        assertEquals(PubNubError.CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED, errorMessage)
     }
 
     @ParameterizedTest
@@ -137,7 +138,7 @@ class JsonElementTest {
 
         // then
         assertEquals(objectUnderTest, jsonElement)
-        assertEquals("Crypto is configured but message is not encrypted.", errorMessage?.message)
+        assertEquals(PubNubError.CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED, errorMessage)
     }
 
     @ParameterizedTest