Add heartbeat error limit (#275)

* Add heartbeat error limit

In case of any problems we should not quit immediately heartbeat calls.
The interval is chosen so it's possible to call heartbeat 3 times
during one presence interval, therefore we should keep trying at least
few more times

* PubNub SDK v6.3.5 release.

---------

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

Author: kleewho

.pubnub.yml

@@ -1,9 +1,9 @@
 name: java
-version: 6.3.4
+version: 6.3.5
 schema: 1
 scm: github.com/pubnub/java
 files:
-  - build/libs/pubnub-gson-6.3.4-all.jar
+  - build/libs/pubnub-gson-6.3.5-all.jar
 sdks:
   - 
       type: library
@@ -23,8 +23,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: GitHub
-              package-name: pubnub-gson-6.3.4
-              location: https://github.com/pubnub/java/releases/download/v6.3.4/pubnub-gson-6.3.4-all.jar
+              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
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -135,8 +135,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: maven 
-              package-name: pubnub-gson-6.3.4
-              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-gson/6.3.4/pubnub-gson-6.3.4.jar
+              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
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -234,6 +234,11 @@ sdks:
                   is-required: Required
 
 changelog:
+  - date: 2023-05-18
+    version: v6.3.5
+    changes:
+      - type: bug
+        text: "In case of error retry heartbeat call limited number of times."
   - date: 2023-03-06
     version: v6.3.4
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v6.3.5
+May 18 2023
+
+#### Fixed
+- In case of error retry heartbeat call limited number of times.
+
 ## v6.3.4
 March 06 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.4</version>
+       <version>6.3.5</version>
      </dependency>
      ```
 
    * for Gradle, add the following dependency in your `gradle.build`:
      ```groovy
-     implementation 'com.pubnub:pubnub-gson:6.3.4'
+     implementation 'com.pubnub:pubnub-gson:6.3.5'
      ```
 
 2. Configure your keys:

build.gradle

@@ -10,7 +10,7 @@ plugins {
 }
 group = 'com.pubnub'
 
-version = '6.3.4'
+version = '6.3.5'
 
 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.4
+VERSION_NAME=6.3.5
 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.3.4";
+    private static final String SDK_VERSION = "6.3.5";
     private final ListenerManager listenerManager;
     private final StateManager stateManager;
 

src/main/java/com/pubnub/api/managers/SubscriptionManager.java

@@ -23,6 +23,7 @@
 import java.util.Timer;
 import java.util.TimerTask;
 import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.atomic.AtomicInteger;
 
 import static com.pubnub.api.managers.StateManager.ChannelFilter.WITHOUT_TEMPORARY_UNAVAILABLE;
 import static com.pubnub.api.managers.StateManager.MILLIS_IN_SECOND;
@@ -33,8 +34,12 @@ public class SubscriptionManager {
 
     private static final int HEARTBEAT_INTERVAL_MULTIPLIER = 1000;
 
+    private static final int MAX_HEARTBEAT_RETRIES = 5;
+
     private volatile boolean connected;
 
+    private final AtomicInteger heartbeatRetries = new AtomicInteger(0);
+
     PubNub pubnub;
     private final TelemetryManager telemetryManager;
     private final TokenManager tokenManager;
@@ -232,6 +237,7 @@ private void stopHeartbeatTimer() {
             heartbeatCall.silentCancel();
             heartbeatCall = null;
         }
+        heartbeatRetries.set(0);
     }
 
     private synchronized void cancelDelayedLoopIterationForTemporaryUnavailableChannels() {
@@ -452,15 +458,17 @@ public void onResponse(Boolean result, @NotNull PNStatus status) {
                         pubnub.getConfiguration().getHeartbeatNotificationOptions();
 
                 if (status.isError()) {
+                    if (heartbeatRetries.getAndIncrement() >= MAX_HEARTBEAT_RETRIES) {
+                        stopHeartbeatTimer();
+                    }
+
                     if (heartbeatVerbosity == PNHeartbeatNotificationOptions.ALL
                             || heartbeatVerbosity == PNHeartbeatNotificationOptions.FAILURES) {
                         listenerManager.announce(status);
                     }
 
-                    // stop the heartbeating logic since an error happened.
-                    stopHeartbeatTimer();
-
                 } else {
+                    heartbeatRetries.set(0);
                     if (heartbeatVerbosity == PNHeartbeatNotificationOptions.ALL) {
                         listenerManager.announce(status);
                     }

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.3.4", version);
+        Assert.assertEquals("6.3.5", version);
         Assert.assertTrue(timeStamp > 0);
     }