Added possibility to set state using heartbeat endpoint. (#277)

* Added possibility to set state using heartbeat endpoint.
* PubNub SDK v6.3.6 release.

Author: marcin-cebo

.pubnub.yml

@@ -1,9 +1,9 @@
 name: java
-version: 6.3.5
+version: 6.3.6
 schema: 1
 scm: github.com/pubnub/java
 files:
-  - build/libs/pubnub-gson-6.3.5-all.jar
+  - build/libs/pubnub-gson-6.3.6-all.jar
 sdks:
   - 
       type: library
@@ -23,8 +23,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: GitHub
-              package-name: pubnub-gson-6.3.5
-              location: https://github.com/pubnub/java/releases/download/v6.3.5/pubnub-gson-6.3.5-all.jar
+              package-name: pubnub-gson-6.3.6
+              location: https://github.com/pubnub/java/releases/download/v6.3.6/pubnub-gson-6.3.6-all.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -135,8 +135,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: maven 
-              package-name: pubnub-gson-6.3.5
-              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-gson/6.3.5/pubnub-gson-6.3.5.jar
+              package-name: pubnub-gson-6.3.6
+              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-gson/6.3.6/pubnub-gson-6.3.6.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -234,6 +234,11 @@ sdks:
                   is-required: Required
 
 changelog:
+  - date: 2023-06-19
+    version: v6.3.6
+    changes:
+      - type: feature
+        text: "Added possibility to set state using heartbeat endpoint. ."
   - date: 2023-05-18
     version: v6.3.5
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v6.3.6
+June 19 2023
+
+#### Added
+- Added possibility to set state using heartbeat endpoint. .
+
 ## v6.3.5
 May 18 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.3.5</version>
+       <version>6.3.6</version>
      </dependency>
      ```
 
    * for Gradle, add the following dependency in your `gradle.build`:
      ```groovy
-     implementation 'com.pubnub:pubnub-gson:6.3.5'
+     implementation 'com.pubnub:pubnub-gson:6.3.6'
      ```
 
 2. Configure your keys:

build.gradle

@@ -10,7 +10,7 @@ plugins {
 }
 group = 'com.pubnub'
 
-version = '6.3.5'
+version = '6.3.6'
 
 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.3.5
+VERSION_NAME=6.3.6
 POM_PACKAGING=jar
 
 POM_NAME=PubNub Java SDK

src/integrationTest/java/com/pubnub/api/integration/PresenceIntegrationTests.java

@@ -22,6 +22,7 @@
 import org.awaitility.Durations;
 import org.hamcrest.core.IsEqual;
 import org.jetbrains.annotations.NotNull;
+import org.junit.Ignore;
 import org.junit.Test;
 
 import java.util.ArrayList;
@@ -38,6 +39,8 @@
 
 public class PresenceIntegrationTests extends BaseIntegrationTest {
 
+    private static final String STATE_CHANGE_EVENT = "state-change";
+
     @Test
     public void testWhereNow() {
         final AtomicBoolean success = new AtomicBoolean();
@@ -206,6 +209,101 @@ public void testHereNow() {
         listen(success);
     }
 
+    @Ignore("For now server doesn't emit state-change event on Heartbeat as default. To do this you need to set presence_heartbeat_state_change_event flag on keys. " +
+            "Server plans to generate state-change event as default. Once server change is on Prod modify it by replacing Thread.sleep(10000) with Awaitility.await()")
+    @Test
+    public void should_setState_withHeartbeat() throws InterruptedException {
+//        enableHeartbeatLoop(2);
+        boolean WITH_HEARTBEAT_TRUE = true;
+        final AtomicInteger hits = new AtomicInteger();
+        final int expectedHits = 2;
+
+        final JsonObject expectedStatePayload = generatePayload();
+        final String expectedChannel = RandomGenerator.get();
+
+        pubNub.addListener(new SubscribeCallback() {
+            @Override
+            public void file(@NotNull PubNub pubnub, @NotNull PNFileEventResult pnFileEventResult) {
+
+            }
+
+            @Override
+            public void status(@NotNull PubNub pubnub, @NotNull PNStatus status) {
+                System.out.println("---" + status.getCategory());
+            }
+
+            @Override
+            public void message(@NotNull PubNub pubnub, @NotNull PNMessageResult message) {
+
+            }
+
+            @Override
+            public void presence(@NotNull PubNub pubnub, @NotNull PNPresenceEventResult presence) {
+                System.out.println("---" + presence.getEvent());
+                if (presence.getEvent().equals(STATE_CHANGE_EVENT)
+                        && presence.getChannel().equals(expectedChannel)
+                        && presence.getUuid().equals(pubNub.getConfiguration().getUserId().getValue())) {
+                    assertEquals(expectedStatePayload, presence.getState());
+                    hits.incrementAndGet();
+                }
+            }
+
+            @Override
+            public void signal(@NotNull PubNub pubNub, @NotNull PNSignalResult pnSignalResult) {
+
+            }
+
+            @Override
+            public void uuid(@NotNull final PubNub pubnub, @NotNull final PNUUIDMetadataResult pnUUIDMetadataResult) {
+
+            }
+
+            @Override
+            public void channel(@NotNull final PubNub pubnub, @NotNull final PNChannelMetadataResult pnChannelMetadataResult) {
+
+            }
+
+            @Override
+            public void membership(@NotNull final PubNub pubnub, @NotNull final PNMembershipResult pnMembershipResult) {
+
+            }
+
+            @Override
+            public void messageAction(@NotNull PubNub pubnub, @NotNull PNMessageActionResult pnActionResult) {
+
+            }
+        });
+
+        subscribeToChannel(pubNub, expectedChannel);
+
+        pubNub.setPresenceState()
+                .channels(Collections.singletonList(expectedChannel))
+                .state(expectedStatePayload)
+                .withHeartbeat(WITH_HEARTBEAT_TRUE)
+                .async((result, status) -> {
+                    assertFalse(status.isError());
+                    assert result != null;
+                    assertEquals(expectedStatePayload, result.getState());
+                });
+
+//        Awaitility.await().atMost(Durations.FIVE_SECONDS).untilAtomic(hits, IsEqual.equalTo(1));
+        Thread.sleep(1000);
+
+        pubNub.getPresenceState()
+                .channels(Collections.singletonList(expectedChannel))
+                .async((result, status) -> {
+                    assertFalse(status.isError());
+                    assert result != null;
+                    assertEquals(expectedStatePayload.get("text"), result.getStateByUUID().get(expectedChannel).getAsJsonObject().get("text"));
+                    assertEquals(expectedStatePayload.get("info"), result.getStateByUUID().get(expectedChannel).getAsJsonObject().get("info"));
+                    assertEquals(expectedStatePayload.get("uncd"), result.getStateByUUID().get(expectedChannel).getAsJsonObject().get("uncd"));
+                    hits.incrementAndGet();
+                });
+
+//        Awaitility.await().atMost(Durations.FIVE_SECONDS).untilAtomic(hits, IsEqual.equalTo(expectedHits));
+        Thread.sleep(1000);
+    }
+
     @Test
     public void testPresenceState() {
         final AtomicInteger hits = new AtomicInteger();
@@ -232,7 +330,7 @@ public void message(@NotNull PubNub pubnub, @NotNull PNMessageResult message) {
 
             @Override
             public void presence(@NotNull PubNub pubnub, @NotNull PNPresenceEventResult presence) {
-                if (presence.getEvent().equals("state-change")
+                if (presence.getEvent().equals(STATE_CHANGE_EVENT)
                         && presence.getChannel().equals(expectedChannel)
                         && presence.getUuid().equals(pubNub.getConfiguration().getUserId().getValue())) {
                     assertEquals(expectedStatePayload, presence.getState());
@@ -458,4 +556,8 @@ public void messageAction(@NotNull PubNub pubnub, @NotNull PNMessageActionResult
                 .atMost(20, TimeUnit.SECONDS)
                 .until(() -> subscribeSuccess.get() && heartbeatCallsCount.get() > 2);
     }
+
+    private void enableHeartbeatLoop(int interval) {
+        pubNub.getConfiguration().setPresenceTimeoutWithCustomInterval(20, interval);
+    }
 }

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.3.5";
+    private static final String SDK_VERSION = "6.3.6";
     private final ListenerManager listenerManager;
     private final StateManager stateManager;
 

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

@@ -366,6 +366,16 @@ public final class PubNubErrorBuilder {
      */
     public static final int PNERR_SPACEID_NULL_OR_EMPTY = 171;
 
+    /**
+     * State must be a JSON object.
+     */
+    public static final int PNERR_STATE_MUST_BE_JSON_OBJECT = 172;
+
+    /**
+     * UserId can't be different from UserId in configuration when flag withHeartbeat is set to true.
+     */
+    public static final int PNERR_USERID_CAN_NOT_BE_DIFFERENT = 173;
+
     // Error Objects
     public static final PubNubError PNERROBJ_TIMEOUT = PubNubError.builder()
             .errorCode(PNERR_TIMEOUT)
@@ -549,6 +559,11 @@ public final class PubNubErrorBuilder {
             .message("State Missing.")
             .build();
 
+    public static final PubNubError PNERROBJ_STATE_MUST_BE_JSON_OBJECT = PubNubError.builder()
+            .errorCode(PNERR_STATE_MUST_BE_JSON_OBJECT)
+            .message("State must be a JSON object.")
+            .build();
+
     public static final PubNubError PNERROBJ_MESSAGE_MISSING = PubNubError.builder()
             .errorCode(PNERR_MESSAGE_MISSING)
             .message("Message Missing.")
@@ -730,6 +745,11 @@ public final class PubNubErrorBuilder {
             .message("SpaceId can't be null nor empty.")
             .build();
 
+    public static final PubNubError PNERROBJ_USERID_CAN_NOT_BE_DIFFERENT_FROM_IN_CONFIGURATION_WHEN_WITHHEARTBEAT_TRUE = PubNubError.builder()
+            .errorCode(PNERR_USERID_CAN_NOT_BE_DIFFERENT)
+            .message("UserId can't be different from UserId in configuration when flag withHeartbeat is set to true.")
+            .build();
+
     private PubNubErrorBuilder() {
 
     }

src/main/java/com/pubnub/api/endpoints/presence/Heartbeat.java

@@ -1,5 +1,6 @@
 package com.pubnub.api.endpoints.presence;
 
+import com.google.gson.JsonElement;
 import com.pubnub.api.PubNub;
 import com.pubnub.api.PubNubException;
 import com.pubnub.api.PubNubUtil;
@@ -20,7 +21,7 @@
 import java.util.Map;
 
 @Accessors(chain = true, fluent = true)
-public class Heartbeat extends Endpoint<Envelope, Boolean> {
+public class Heartbeat extends Endpoint<Envelope<JsonElement>, Boolean> {
 
     @Setter
     private List<String> channels;
@@ -56,7 +57,7 @@ protected void validateParams() throws PubNubException {
     }
 
     @Override
-    protected Call<Envelope> doWork(Map<String, String> params) throws PubNubException {
+    protected Call<Envelope<JsonElement>> doWork(Map<String, String> params) throws PubNubException {
         params.put("heartbeat", String.valueOf(this.getPubnub().getConfiguration().getPresenceTimeout()));
 
         if (channelGroups.size() > 0) {
@@ -83,7 +84,7 @@ protected Call<Envelope> doWork(Map<String, String> params) throws PubNubExcepti
     }
 
     @Override
-    protected Boolean createResponse(Response<Envelope> input) throws PubNubException {
+    protected Boolean createResponse(Response<Envelope<JsonElement>> input) throws PubNubException {
         return true;
     }