Do heartbeat and leave calls in sequence (#237)

In some circumstances we do two contradicting calls in almost
the same time. One of them is a call to heartbeat endpoint and
the other is to leave endpoint. The reason why those call could
happen in almost the same time is because heartbeat calls are done
periodically on separate thread and leave calls are happening due to
user actions. This means that sooner or later this situation will happen
and pubnub presence system will generate join event and leave event (usually
in this order), but then another timeout event when presence timeout
expires.

To prevent it from happening I've decided to limit the number of concurrent
calls to only those two endpoints to just one. This is done on the okhttp
client level. Because those two calls can be ordered only two ways we can
provide an analysis of why this change might work.

Let's first concentrate on situation when heartbeat call is already happening
and unsubscribe method is being called:

* leave call will go to the internal queue of calls of okhttp client due to
limit of concurrent calls
* unsubscribe method internally will try to cancel the heartbeat call and schedule
timer with another heartbeat call (but with different set of channels)
* heartbeat finishes (either normally, or by being cancelled), this usually
do not generate any events, but it might generate join event
* http leave call can finally proceed, which generates leave event
* because the calls have been done sequentially there's no timeout event

In case when leave call is already ongoing and the schedule heartbeat timer
is trying to make heartbeat request:

* heartbeat request goes to client's internal queue to wait on leave to be finished
* in the meantime usubscribe method internally cancels the timer and cancels the heartbeat
request before it has time to start
* leave request ends, and leave event is being generated
* there's no timeout event, and the presence didn't have chance to be extended

Author: kleewho

.pubnub.yml

@@ -1,9 +1,9 @@
 name: java
-version: 6.0.0
+version: 6.0.1
 schema: 1
 scm: github.com/pubnub/java
 files:
-  - build/libs/pubnub-gson-6.0.0-all.jar
+  - build/libs/pubnub-gson-6.0.1-all.jar
 sdks:
   - 
       type: library
@@ -23,8 +23,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: GitHub
-              package-name: pubnub-gson-6.0.0
-              location: https://github.com/pubnub/java/releases/download/v6.0.0/pubnub-gson-6.0.0-all.jar
+              package-name: pubnub-gson-6.0.1
+              location: https://github.com/pubnub/java/releases/download/v6.0.1/pubnub-gson-6.0.1-all.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -135,8 +135,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: maven 
-              package-name: pubnub-gson-6.0.0
-              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-gson/6.0.0/pubnub-gson-6.0.0.jar
+              package-name: pubnub-gson-6.0.1
+              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-gson/6.0.1/pubnub-gson-6.0.1.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -234,6 +234,11 @@ sdks:
                   is-required: Required
 
 changelog:
+  - date: 2022-05-09
+    version: v6.0.1
+    changes:
+      - type: bug
+        text: "Do heartbeat and leave calls sequentially to prevent race condition between these two calls and 'phantom' join after leave."
   - date: 2022-01-12
     version: v6.0.0
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v6.0.1
+May 09 2022
+
+#### Fixed
+- Do heartbeat and leave calls sequentially to prevent race condition between these two calls and 'phantom' join after leave.
+
 ## v6.0.0
 January 12 2022
 

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.0.0</version>
+       <version>6.0.1</version>
      </dependency>
      ```
 
    * for Gradle, add the following dependency in your `gradle.build`:
      ```groovy
-     implementation 'com.pubnub:pubnub-gson:6.0.0'
+     implementation 'com.pubnub:pubnub-gson:6.0.1'
      ```
 
 2. Configure your keys:

build.gradle

@@ -12,7 +12,7 @@ plugins {
 }
 group = 'com.pubnub'
 
-version = '6.0.0'
+version = '6.0.1'
 
 description = """"""
 

config/findbugs/excludeFilter.xml

@@ -65,4 +65,9 @@
         <Field name="updated"/>
         <Bug pattern="UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD"/>
     </Match>
+    <Match>
+        <Class name="com.pubnub.api.PubNubException"/>
+        <Field name="affectedCall"/>
+        <Bug pattern="URF_UNREAD_FIELD"/>
+    </Match>
 </FindBugsFilter>

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

@@ -104,7 +104,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.0.0";
+    private static final String SDK_VERSION = "6.0.1";
     private final ListenerManager listenerManager;
     private final StateManager stateManager;
 

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

@@ -69,7 +69,7 @@ protected Call<Envelope<JsonElement>> doWork(Map<String, String> params) {
 
         String selectedUUID = uuid != null ? uuid : this.getPubnub().getConfiguration().getUuid();
 
-        return this.getRetrofit().getPresenceService().getState(
+        return this.getRetrofit().getExtendedPresenceService().getState(
                 this.getPubnub().getConfiguration().getSubscribeKey(), channelCSV, selectedUUID, params);
     }
 

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

@@ -91,9 +91,9 @@ protected Call<Envelope<JsonElement>> doWork(Map<String, String> params) {
         }
 
         if (channels.size() > 0 || channelGroups.size() > 0) {
-            return this.getRetrofit().getPresenceService().hereNow(this.getPubnub().getConfiguration().getSubscribeKey(), channelCSV, params);
+            return this.getRetrofit().getExtendedPresenceService().hereNow(this.getPubnub().getConfiguration().getSubscribeKey(), channelCSV, params);
         } else {
-            return this.getRetrofit().getPresenceService().globalHereNow(this.getPubnub().getConfiguration().getSubscribeKey(), params);
+            return this.getRetrofit().getExtendedPresenceService().globalHereNow(this.getPubnub().getConfiguration().getSubscribeKey(), params);
         }
     }
 

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

@@ -104,7 +104,7 @@ protected Call<Envelope<JsonElement>> doWork(Map<String, String> params) throws
 
         String channelCSV = channels.size() > 0 ? PubNubUtil.joinString(channels, ",") : ",";
 
-        return this.getRetrofit().getPresenceService().setState(
+        return this.getRetrofit().getExtendedPresenceService().setState(
                 this.getPubnub().getConfiguration().getSubscribeKey(), channelCSV, selectedUUID, params);
     }
 

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

@@ -51,7 +51,7 @@ protected void validateParams() throws PubNubException {
 
     @Override
     protected Call<Envelope<WhereNowPayload>> doWork(Map<String, String> params) {
-        return this.getRetrofit().getPresenceService().whereNow(this.getPubnub().getConfiguration().getSubscribeKey(),
+        return this.getRetrofit().getExtendedPresenceService().whereNow(this.getPubnub().getConfiguration().getSubscribeKey(),
                 this.uuid != null ? this.uuid : this.getPubnub().getConfiguration().getUuid(), params);
     }
 
@@ -77,5 +77,4 @@ protected PNOperationType getOperationType() {
     protected boolean isAuthRequired() {
         return true;
     }
-
 }