Merge pull request #855 from ably/publisher-presence-at-subscriber

Present Publisher as offline to Subscribers on loss of connectivity on the Subscriber's side
ably · Dec 22, 2022 · 17a8a26 · 17a8a26
2 parents a75fa17 + 88067b8
commit 17a8a26
Show file tree

Hide file tree

Showing 24 changed files with 339 additions and 336 deletions.
diff --git a/common/src/main/java/com/ably/tracking/common/AblyHelpers.kt b/common/src/main/java/com/ably/tracking/common/AblyHelpers.kt
@@ -161,7 +161,7 @@ fun io.ably.lib.types.PresenceMessage.toTracking(gson: Gson): PresenceMessage? =
         PresenceMessage(
             this.action.toTracking(),
             presenceData,
-            this.clientId
+            this.memberKey(),
         )
     }
 

diff --git a/common/src/main/java/com/ably/tracking/common/AblyModels.kt b/common/src/main/java/com/ably/tracking/common/AblyModels.kt
@@ -2,7 +2,19 @@ package com.ably.tracking.common
 
 import com.ably.tracking.Resolution
 
-data class PresenceMessage(val action: PresenceAction, val data: PresenceData, val clientId: String)
+/**
+ * Encapsulates the properties of an Ably presence message which are needed by asset tracking SDKs.
+ */
+data class PresenceMessage(
+    val action: PresenceAction,
+    val data: PresenceData,
+
+    /**
+     * Combination of Ably `clientId` and `connectionId`.
+     * See: https://sdk.ably.com/builds/ably/specification/main/features/#TP3h
+     */
+    val memberKey: String,
+)
 
 enum class PresenceAction {
     PRESENT_OR_ENTER, LEAVE_OR_ABSENT, UPDATE;

diff --git a/publishing-sdk/src/main/java/com/ably/tracking/publisher/ConfigurationModels.kt b/publishing-sdk/src/main/java/com/ably/tracking/publisher/ConfigurationModels.kt
@@ -260,7 +260,7 @@ data class Trackable(
     override fun hashCode(): Int = id.hashCode()
 }
 
-data class Subscriber(val id: String, val trackable: Trackable)
+data class Subscriber(val memberKey: String, val trackable: Trackable)
 
 sealed class Proximity
 

diff --git a/publishing-sdk/src/main/java/com/ably/tracking/publisher/CorePublisher.kt b/publishing-sdk/src/main/java/com/ably/tracking/publisher/CorePublisher.kt
@@ -52,16 +52,17 @@ internal interface CorePublisher {
     val routingProfile: RoutingProfile
     val trackableStateFlows: Map<String, StateFlow<TrackableState>>
 
-    fun addSubscriber(id: String, trackable: Trackable, data: PresenceData, properties: PublisherProperties)
+    fun addSubscriber(memberKey: String, trackable: Trackable, data: PresenceData, properties: PublisherProperties)
     fun updateSubscriber(
-        id: String,
+        memberKey: String,
         trackable: Trackable,
         data: PresenceData,
         properties: PublisherProperties
     )
 
-    fun removeSubscriber(id: String, trackable: Trackable, properties: PublisherProperties)
+    fun removeSubscriber(memberKey: String, trackable: Trackable, properties: PublisherProperties)
     fun removeAllSubscribers(trackable: Trackable, properties: PublisherProperties)
+
     fun setDestination(destination: Destination, properties: PublisherProperties)
     fun removeCurrentDestination(properties: PublisherProperties)
     fun startLocationUpdates(properties: PublisherProperties)
@@ -492,8 +493,13 @@ constructor(
         }
     }
 
-    override fun addSubscriber(id: String, trackable: Trackable, data: PresenceData, properties: PublisherProperties) {
-        val subscriber = Subscriber(id, trackable)
+    override fun addSubscriber(
+        memberKey: String,
+        trackable: Trackable,
+        data: PresenceData,
+        properties: PublisherProperties
+    ) {
+        val subscriber = Subscriber(memberKey, trackable)
         if (properties.subscribers[trackable.id] == null) {
             properties.subscribers[trackable.id] = mutableSetOf()
         }
@@ -504,13 +510,13 @@ constructor(
     }
 
     override fun updateSubscriber(
-        id: String,
+        memberKey: String,
         trackable: Trackable,
         data: PresenceData,
         properties: PublisherProperties
     ) {
         properties.subscribers[trackable.id]?.let { subscribers ->
-            subscribers.find { it.id == id }?.let { subscriber ->
+            subscribers.find { it.memberKey == memberKey }?.let { subscriber ->
                 data.resolution.let { resolution ->
                     saveOrRemoveResolutionRequest(resolution, trackable, subscriber, properties)
                     resolveResolution(trackable, properties)
@@ -519,9 +525,9 @@ constructor(
         }
     }
 
-    override fun removeSubscriber(id: String, trackable: Trackable, properties: PublisherProperties) {
+    override fun removeSubscriber(memberKey: String, trackable: Trackable, properties: PublisherProperties) {
         properties.subscribers[trackable.id]?.let { subscribers ->
-            subscribers.find { it.id == id }?.let { subscriber ->
+            subscribers.find { it.memberKey == memberKey }?.let { subscriber ->
                 subscribers.remove(subscriber)
                 properties.requests[trackable.id]?.remove(subscriber)
                 hooks.subscribers?.onSubscriberRemoved(subscriber)

diff --git a/...dk/src/main/java/com/ably/tracking/publisher/workerqueue/workers/PresenceMessageWorker.kt b/...dk/src/main/java/com/ably/tracking/publisher/workerqueue/workers/PresenceMessageWorker.kt
@@ -19,7 +19,7 @@ internal class PresenceMessageWorker(
             PresenceAction.PRESENT_OR_ENTER -> {
                 if (presenceMessage.data.type == ClientTypes.SUBSCRIBER) {
                     corePublisher.addSubscriber(
-                        presenceMessage.clientId,
+                        presenceMessage.memberKey,
                         trackable,
                         presenceMessage.data,
                         properties
@@ -28,13 +28,13 @@ internal class PresenceMessageWorker(
             }
             PresenceAction.LEAVE_OR_ABSENT -> {
                 if (presenceMessage.data.type == ClientTypes.SUBSCRIBER) {
-                    corePublisher.removeSubscriber(presenceMessage.clientId, trackable, properties)
+                    corePublisher.removeSubscriber(presenceMessage.memberKey, trackable, properties)
                 }
             }
             PresenceAction.UPDATE -> {
                 if (presenceMessage.data.type == ClientTypes.SUBSCRIBER) {
                     corePublisher.updateSubscriber(
-                        presenceMessage.clientId,
+                        presenceMessage.memberKey,
                         trackable,
                         presenceMessage.data,
                         properties

diff --git a/...rc/test/java/com/ably/tracking/publisher/workerqueue/workers/PresenceMessageWorkerTest.kt b/...rc/test/java/com/ably/tracking/publisher/workerqueue/workers/PresenceMessageWorkerTest.kt
@@ -133,7 +133,7 @@ class PresenceMessageWorkerTest {
             PresenceMessage(
                 action,
                 PresenceData(if (isSubscriber) ClientTypes.SUBSCRIBER else ClientTypes.PUBLISHER),
-                "test-client-id"
+                "test-member-key"
             ),
             corePublisher
         )