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

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

* PubNub SDK v6.4.3 release.

---------

Co-authored-by: PubNub Release Bot <120067856+pubnub-release-bot@users.noreply.github.com>

Author: wkal-pubnub

.pubnub.yml

@@ -1,9 +1,9 @@
 name: java
-version: 6.4.2
+version: 6.4.3
 schema: 1
 scm: github.com/pubnub/java
 files:
-  - build/libs/pubnub-gson-6.4.2-all.jar
+  - build/libs/pubnub-gson-6.4.3-all.jar
 sdks:
   - 
       type: library
@@ -23,8 +23,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: maven 
-              package-name: pubnub-gson-6.4.2
-              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-gson/6.4.2/pubnub-gson-6.4.2.jar
+              package-name: pubnub-gson-6.4.3
+              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-gson/6.4.3/pubnub-gson-6.4.3.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -115,6 +115,11 @@ sdks:
                   is-required: Required
 
 changelog:
+  - date: 2023-11-28
+    version: v6.4.3
+    changes:
+      - type: feature
+        text: "Add `error` field to `PNFileEventResult` and set it in case of decryption failure."
   - date: 2023-11-23
     version: v6.4.2
     changes:

CHANGELOG.md

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

README.md

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

build.gradle

@@ -10,7 +10,7 @@ plugins {
 }
 group = 'com.pubnub'
 
-version = '6.4.2'
+version = '6.4.3'
 
 description = """"""
 

gradle.properties

@@ -3,7 +3,7 @@ SONATYPE_HOST=DEFAULT
 SONATYPE_AUTOMATIC_RELEASE=true
 GROUP=com.pubnub
 POM_ARTIFACT_ID=pubnub-gson
-VERSION_NAME=6.4.2
+VERSION_NAME=6.4.3
 POM_PACKAGING=jar
 
 POM_NAME=PubNub Java SDK

src/main/java/com/pubnub/api/PubNub.java

@@ -105,7 +105,7 @@ public class PubNub {
     private static final int TIMESTAMP_DIVIDER = 1000;
     private static final int MAX_SEQUENCE = 65535;
 
-    private static final String SDK_VERSION = "6.4.2";
+    private static final String SDK_VERSION = "6.4.3";
     private final ListenerManager listenerManager;
     private final StateManager stateManager;
 

src/main/java/com/pubnub/api/builder/PubNubErrorBuilder.java

@@ -756,7 +756,7 @@ public final class PubNubErrorBuilder {
 
     public static final PubNubError PNERROBJ_PNERR_CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED = PubNubError.builder()
             .errorCode(PNERR_CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED)
-            .message("Crypto is configured but message is not encrypted.")
+            .message("Message decryption failed using the current crypto configuration.")
             .build();
 
     private PubNubErrorBuilder() {

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

@@ -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;
 import lombok.Builder;
@@ -19,4 +20,5 @@ public class PNFileEventResult implements PNEvent {
     @NonNull
     private final PNDownloadableFile file;
     private final JsonElement jsonMessage;
+    private final PubNubError error;
 }

src/main/java/com/pubnub/api/workers/SubscribeMessageProcessor.java

@@ -77,7 +77,6 @@ PNEvent processIncomingPayload(SubscribeMessage message) throws PubNubException
 
         if (message.getChannel().endsWith("-pnpres")) {
             PresenceEnvelope presencePayload = mapper.convertValue(message.getPayload(), PresenceEnvelope.class);
-
             String strippedPresenceChannel = null;
             String strippedPresenceSubscription = null;
 
@@ -107,7 +106,6 @@ PNEvent processIncomingPayload(SubscribeMessage message) throws PubNubException
                     .timeout(getDelta(message.getPayload().getAsJsonObject().get("timeout")))
                     .hereNowRefresh(isHereNowRefresh != null && isHereNowRefresh.getAsBoolean())
                     .build();
-
             return pnPresenceEventResult;
         } else {
             JsonElement extractedMessage;
@@ -202,6 +200,7 @@ PNEvent processIncomingPayload(SubscribeMessage message) throws PubNubException
                         .publisher(message.getIssuingClientId())
                         .timetoken(publishMetaData.getPublishTimetoken())
                         .jsonMessage(jsonMessage)
+                        .error(error)
                         .build();
             }
         }

src/test/java/com/pubnub/api/PubNubTest.java

@@ -100,7 +100,7 @@ public void getVersionAndTimeStamp() {
         pubnub = new PubNub(pnConfiguration);
         String version = pubnub.getVersion();
         int timeStamp = pubnub.getTimestamp();
-        Assert.assertEquals("6.4.2", version);
+        Assert.assertEquals("6.4.3", version);
         Assert.assertTrue(timeStamp > 0);
     }