Partial updates for membership information (#267)

pubnub · Aug 8, 2024 · 6919320 · 6919320
1 parent f5d37b8
commit 6919320
Show file tree

Hide file tree

Showing 18 changed files with 143 additions and 49 deletions.
diff --git a/...-core-impl/src/main/kotlin/com/pubnub/internal/models/consumer/objects/member/PNMember.kt b/...-core-impl/src/main/kotlin/com/pubnub/internal/models/consumer/objects/member/PNMember.kt
@@ -1,13 +1,14 @@
 package com.pubnub.internal.models.consumer.objects.member
 
 import com.pubnub.api.models.consumer.objects.uuid.PNUUIDMetadata
+import com.pubnub.api.utils.PatchValue
 
 data class PNMember(
-    val uuid: PNUUIDMetadata?,
-    val custom: Map<String, Any>? = null,
+    val uuid: PNUUIDMetadata,
+    val custom: PatchValue<Map<String, Any>?>? = null,
     val updated: String,
     val eTag: String,
-    val status: String?,
+    val status: PatchValue<String?>? = null,
 ) {
     data class Partial(
         val uuidId: String,

diff --git a/...main/kotlin/com/pubnub/internal/models/consumer/objects/membership/PNChannelMembership.kt b/...main/kotlin/com/pubnub/internal/models/consumer/objects/membership/PNChannelMembership.kt
@@ -1,13 +1,14 @@
 package com.pubnub.internal.models.consumer.objects.membership
 
 import com.pubnub.api.models.consumer.objects.channel.PNChannelMetadata
+import com.pubnub.api.utils.PatchValue
 
 data class PNChannelMembership(
     val channel: PNChannelMetadata,
-    val custom: Map<String, Any?>?,
+    val custom: PatchValue<Map<String, Any?>?>? = null,
     val updated: String,
     val eTag: String,
-    val status: String?,
+    val status: PatchValue<String?>? = null,
 ) {
     data class Partial(
         val channelId: String,

diff --git a/.../src/main/kotlin/com/pubnub/internal/models/consumer/objects/uuid/PNUUIDMetadataResult.kt b/.../src/main/kotlin/com/pubnub/internal/models/consumer/objects/uuid/PNUUIDMetadataResult.kt
@@ -4,5 +4,5 @@ import com.pubnub.api.models.consumer.objects.uuid.PNUUIDMetadata
 
 data class PNUUIDMetadataResult(
     val status: Int,
-    val data: PNUUIDMetadata?,
+    val data: PNUUIDMetadata,
 )
diff --git a/...src/main/kotlin/com/pubnub/internal/models/consumer/pubsub/objects/PNObjectEventResult.kt b/...src/main/kotlin/com/pubnub/internal/models/consumer/pubsub/objects/PNObjectEventResult.kt
@@ -7,6 +7,7 @@ import com.pubnub.api.models.consumer.objects.channel.PNChannelMetadata
 import com.pubnub.api.models.consumer.objects.uuid.PNUUIDMetadata
 import com.pubnub.api.models.consumer.pubsub.BasePubSubResult
 import com.pubnub.api.models.consumer.pubsub.PubSubResult
+import com.pubnub.api.utils.PatchValue
 import com.pubnub.internal.utils.PolymorphicDeserializer
 import com.pubnub.internal.utils.UnwrapSingleField
 
@@ -95,10 +96,10 @@ data class PNSetMembershipEvent(
     val channel: String,
     @JsonAdapter(UnwrapSingleField::class)
     val uuid: String,
-    val custom: Map<String, Any?>?,
+    val custom: PatchValue<Map<String, Any?>?>?,
     val eTag: String,
     val updated: String,
-    val status: String?,
+    val status: PatchValue<String?>?,
 )
 
 data class PNDeleteMembershipEvent(

diff --git a/...ub-core/pubnub-core-impl/src/test/kotlin/com/pubnub/contract/membership/step/WhenSteps.kt b/...ub-core/pubnub-core-impl/src/test/kotlin/com/pubnub/contract/membership/step/WhenSteps.kt
@@ -43,9 +43,9 @@ class WhenSteps(
         val channels =
             membershipState.memberships.map {
                 PNChannelMembership.Partial(
-                    channelId = it.channel!!.id,
-                    custom = it.custom,
-                    status = it.status,
+                    channelId = it.channel.id,
+                    custom = it.custom?.value,
+                    status = it.status?.value,
                 )
             }
 
@@ -63,9 +63,9 @@ class WhenSteps(
         val channels =
             membershipState.memberships.map {
                 PNChannelMembership.Partial(
-                    channelId = it.channel!!.id,
-                    custom = it.custom,
-                    status = it.status,
+                    channelId = it.channel.id,
+                    custom = it.custom?.value,
+                    status = it.status?.value,
                 )
             }
 
@@ -79,7 +79,7 @@ class WhenSteps(
 
     @When("I remove the membership")
     fun i_remove_the_membership() {
-        val channels = membershipState.memberships.map { it.channel!!.id }
+        val channels = membershipState.memberships.map { it.channel.id }
         world.pubnub.pubNubCore.removeMemberships(
             uuid = membershipState.uuid(),
             channels = channels,
@@ -91,7 +91,7 @@ class WhenSteps(
 
     @When("I remove the membership for current user")
     fun i_remove_the_membership_for_current_user() {
-        val channels = membershipState.memberships.map { it.channel!!.id }
+        val channels = membershipState.memberships.map { it.channel.id }
         world.pubnub.pubNubCore.removeMemberships(
             channels = channels,
         ).sync().let {
@@ -105,12 +105,12 @@ class WhenSteps(
         val channelsToSet =
             membershipState.memberships.map {
                 PNChannelMembership.Partial(
-                    channelId = it.channel!!.id,
-                    custom = it.custom,
-                    status = it.status,
+                    channelId = it.channel.id,
+                    custom = it.custom?.value,
+                    status = it.status?.value,
                 )
             }
-        val channelsToRemove = membershipState.membershipsToRemove.map { it.channel!!.id }
+        val channelsToRemove = membershipState.membershipsToRemove.map { it.channel.id }
         world.pubnub.pubNubCore.manageMemberships(
             channelsToSet = channelsToSet,
             channelsToRemove = channelsToRemove,

diff --git a/...b-gson-api/src/main/java/com/pubnub/api/models/consumer/objects_api/member/PNMembers.java b/...b-gson-api/src/main/java/com/pubnub/api/models/consumer/objects_api/member/PNMembers.java
@@ -36,10 +36,10 @@ public static PNMembers from(@Nullable PNMember member) {
         }
         return new PNMembers()
                 .setUuid(PNUUIDMetadata.from(member.getUuid()))
-                .setCustom(member.getCustom())
+                .setCustom(member.getCustom() != null ? member.getCustom().getValue() : null)
                 .setUpdated(member.getUpdated())
                 .setETag(member.getETag())
-                .setStatus(member.getStatus());
+                .setStatus(member.getStatus() != null ? member.getStatus().getValue() : null);
     }
 
     public static List<PNMembers> from(Collection<PNMember> members) {

diff --git a/...api/src/main/java/com/pubnub/api/models/consumer/objects_api/membership/PNMembership.java b/...api/src/main/java/com/pubnub/api/models/consumer/objects_api/membership/PNMembership.java
@@ -39,11 +39,11 @@ public static PNMembership from(@Nullable PNChannelMembership data) {
         }
         PNChannelMetadata metadata = PNChannelMetadata.from(data.getChannel());
         PNMembership newData = new PNMembership(metadata);
-        newData.setCustom(data.getCustom());
+        newData.setCustom(data.getCustom() != null ? data.getCustom().getValue() : null);
 //        newData.setUuid(data.get) //TODO where to get this? does it even exist in server responses?
         newData.setUpdated(data.getUpdated());
         newData.setETag(data.getETag());
-        newData.setStatus(data.getStatus());
+        newData.setStatus(data.getStatus() != null ? data.getStatus().getValue() : null);
         return newData;
     }
 }
diff --git a/...nub-gson-impl/src/main/java/com/pubnub/internal/v2/callbacks/DelegatingEventListener.java b/...nub-gson-impl/src/main/java/com/pubnub/internal/v2/callbacks/DelegatingEventListener.java
@@ -164,8 +164,8 @@ static PNMembershipResult getSetMembershipResult(@NotNull PNObjectEventResult ob
                 new PNChannelMetadata(data.getChannel(), null)
         );
         membership.setUuid(data.getUuid());
-        membership.setCustom(data.getCustom());
-        membership.setStatus(data.getStatus());
+        membership.setCustom(data.getCustom() != null ? data.getCustom().getValue() : null);
+        membership.setStatus(data.getStatus() != null ? data.getStatus().getValue() : null);
         membership.setUpdated(data.getUpdated());
         membership.setETag(data.getETag());
         return new PNMembershipResult(

diff --git a/...gson-impl/src/test/kotlin/com/pubnub/internal/v2/callbacks/DelegatingEventListenerTest.kt b/...gson-impl/src/test/kotlin/com/pubnub/internal/v2/callbacks/DelegatingEventListenerTest.kt
@@ -294,7 +294,7 @@ internal class DelegatingEventListenerTest {
 
     @Test
     fun getSetMembershipResult() {
-        val metadata = PNSetMembershipEvent(channel, uuid, custom, eTag, updated, status)
+        val metadata = PNSetMembershipEvent(channel, uuid, PatchValue.of(custom), eTag, updated, PatchValue.of(status))
         val message = PNSetMembershipEventMessage(source, version, event, type, metadata)
         val objectEvent = PNObjectEventResult(BasePubSubResult(channel, subscription, timetoken, userMetadata, publisher), message)
 

diff --git a/...otlin-api/src/commonMain/kotlin/com/pubnub/api/models/consumer/objects/member/PNMember.kt b/...otlin-api/src/commonMain/kotlin/com/pubnub/api/models/consumer/objects/member/PNMember.kt
@@ -1,14 +1,15 @@
 package com.pubnub.api.models.consumer.objects.member
 
 import com.pubnub.api.models.consumer.objects.uuid.PNUUIDMetadata
+import com.pubnub.api.utils.PatchValue
 import com.pubnub.kmp.CustomObject
 
 data class PNMember(
-    val uuid: PNUUIDMetadata?,
-    val custom: Map<String, Any?>? = null,
+    val uuid: PNUUIDMetadata,
+    val custom: PatchValue<Map<String, Any?>?>? = null,
     val updated: String,
     val eTag: String,
-    val status: String?,
+    val status: PatchValue<String?>?,
 ) {
     data class Partial(
         val uuidId: String,
@@ -17,4 +18,15 @@ data class PNMember(
     ) : MemberInput {
         override val uuid: String = uuidId
     }
+
+    // let's not make this public for now, but keep the implementation around in case it's needed
+    private operator fun plus(update: PNMember): PNMember {
+        return PNMember(
+            uuid + update.uuid,
+            update.custom ?: custom,
+            update.updated,
+            update.eTag,
+            update.status ?: status
+        )
+    }
 }
diff --git a/...ommonMain/kotlin/com/pubnub/api/models/consumer/objects/membership/PNChannelMembership.kt b/...ommonMain/kotlin/com/pubnub/api/models/consumer/objects/membership/PNChannelMembership.kt
@@ -1,14 +1,16 @@
 package com.pubnub.api.models.consumer.objects.membership
 
 import com.pubnub.api.models.consumer.objects.channel.PNChannelMetadata
+import com.pubnub.api.models.consumer.pubsub.objects.PNSetMembershipEvent
+import com.pubnub.api.utils.PatchValue
 import com.pubnub.kmp.CustomObject
 
 data class PNChannelMembership(
     val channel: PNChannelMetadata,
-    val custom: Map<String, Any?>?,
+    val custom: PatchValue<Map<String, Any?>?>? = null,
     val updated: String,
     val eTag: String,
-    val status: String?,
+    val status: PatchValue<String?>? = null,
 ) {
     data class Partial(
         val channelId: String,
@@ -17,4 +19,28 @@ data class PNChannelMembership(
     ) : ChannelMembershipInput {
         override val channel: String = channelId
     }
+
+    // let's not make this public for now, but keep the implementation around in case it's needed
+    private operator fun plus(update: PNChannelMembership): PNChannelMembership {
+        return PNChannelMembership(
+            channel + update.channel,
+            update.custom ?: custom,
+            update.updated,
+            update.eTag,
+            update.status ?: status
+        )
+    }
+
+    /**
+     * Merge information from this `PNChannelMembership` with new data from `update`, returning a new `PNChannelMembership` instance.
+     */
+    operator fun plus(update: PNSetMembershipEvent): PNChannelMembership {
+        return PNChannelMembership(
+            channel,
+            update.custom ?: custom,
+            update.updated,
+            update.eTag,
+            update.status ?: status
+        )
+    }
 }
diff --git a/...src/commonMain/kotlin/com/pubnub/api/models/consumer/objects/uuid/PNUUIDMetadataResult.kt b/...src/commonMain/kotlin/com/pubnub/api/models/consumer/objects/uuid/PNUUIDMetadataResult.kt
@@ -2,5 +2,5 @@ package com.pubnub.api.models.consumer.objects.uuid
 
 data class PNUUIDMetadataResult(
     val status: Int,
-    val data: PNUUIDMetadata?,
+    val data: PNUUIDMetadata,
 )
diff --git a/...rc/commonMain/kotlin/com/pubnub/api/models/consumer/pubsub/objects/PNObjectEventResult.kt b/...rc/commonMain/kotlin/com/pubnub/api/models/consumer/pubsub/objects/PNObjectEventResult.kt
@@ -4,6 +4,7 @@ import com.pubnub.api.models.consumer.objects.channel.PNChannelMetadata
 import com.pubnub.api.models.consumer.objects.uuid.PNUUIDMetadata
 import com.pubnub.api.models.consumer.pubsub.BasePubSubResult
 import com.pubnub.api.models.consumer.pubsub.PubSubResult
+import com.pubnub.api.utils.PatchValue
 
 data class PNObjectEventResult(
     private val result: BasePubSubResult,
@@ -68,10 +69,10 @@ data class PNDeleteUUIDMetadataEventMessage(
 data class PNSetMembershipEvent(
     val channel: String,
     val uuid: String,
-    val custom: Map<String, Any?>?,
+    val custom: PatchValue<Map<String, Any?>?>?,
     val eTag: String,
     val updated: String,
-    val status: String?,
+    val status: PatchValue<String?>?,
 )
 
 data class PNDeleteMembershipEvent(

diff --git a/...nTest/kotlin/com/pubnub/api/models/consumer/objects/membership/PNChannelMembershipTest.kt b/...nTest/kotlin/com/pubnub/api/models/consumer/objects/membership/PNChannelMembershipTest.kt
@@ -0,0 +1,39 @@
+package com.pubnub.api.models.consumer.objects.membership
+
+import com.pubnub.api.models.consumer.objects.channel.PNChannelMetadata
+import com.pubnub.api.models.consumer.pubsub.objects.PNSetMembershipEvent
+import com.pubnub.api.utils.PatchValue
+import com.pubnub.test.randomString
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class PNChannelMembershipTest {
+    @Test
+    fun plus() {
+        val originalMembership = PNChannelMembership(
+            PNChannelMetadata(randomString()),
+            custom = PatchValue.of(mapOf(randomString() to randomString())),
+            updated = randomString(),
+            eTag = randomString(),
+            status = null
+        )
+
+        val updateMembership = PNSetMembershipEvent(
+            originalMembership.channel.id,
+            randomString(),
+            custom = null,
+            updated = randomString(),
+            eTag = randomString(),
+            status = PatchValue.of(randomString())
+        )
+        val expectedMembership = originalMembership.copy(
+            updated = updateMembership.updated,
+            eTag = updateMembership.eTag,
+            status = updateMembership.status
+        )
+
+        val actualMembership = originalMembership + updateMembership
+
+        assertEquals(expectedMembership, actualMembership)
+    }
+}
diff --git a/...kotlin/pubnub-kotlin-api/src/commonTest/kotlin/com/pubnub/test/integration/MembersTest.kt b/...kotlin/pubnub-kotlin-api/src/commonTest/kotlin/com/pubnub/test/integration/MembersTest.kt
@@ -35,8 +35,8 @@ class MembersTest : BaseIntegrationTest() {
         ).await()
 
         // then
-        val pnChannelDetails = result.data.single { it.uuid?.id == pubnub.configuration.userId.value }
-        assertEquals(customData, pnChannelDetails.custom)
+        val pnChannelDetails = result.data.single { it.uuid.id == pubnub.configuration.userId.value }
+        assertEquals(customData, pnChannelDetails.custom?.value)
     }
 
     @Test
@@ -50,8 +50,8 @@ class MembersTest : BaseIntegrationTest() {
         ).await()
 
         // then
-        val pnChannelDetails = result.data.single { it.uuid?.id == pubnub.configuration.userId.value }
-        assertEquals(status, pnChannelDetails.status)
+        val pnChannelDetails = result.data.single { it.uuid.id == pubnub.configuration.userId.value }
+        assertEquals(status, pnChannelDetails.status?.value)
     }
 
     @Test
@@ -71,7 +71,7 @@ class MembersTest : BaseIntegrationTest() {
             yield()
             val result = pubnub.getMemberships(pubnub.configuration.userId.value, page = next).await()
             next = result.next
-            assertFalse { result.data.any { it.channel?.id == channel } }
+            assertFalse { result.data.any { it.channel.id == channel } }
             if (next == null || result.data.isEmpty()) {
                 break
             }

diff --git a/...in/pubnub-kotlin-api/src/commonTest/kotlin/com/pubnub/test/integration/MembershipsTest.kt b/...in/pubnub-kotlin-api/src/commonTest/kotlin/com/pubnub/test/integration/MembershipsTest.kt
@@ -36,9 +36,9 @@ class MembershipsTest : BaseIntegrationTest() {
         ).await()
 
         // then
-        val pnChannelDetails = result.data.single { it.channel?.id == channel }
-        assertEquals(channel, pnChannelDetails.channel?.id)
-        assertEquals(customData, pnChannelDetails.custom)
+        val pnChannelDetails = result.data.single { it.channel.id == channel }
+        assertEquals(channel, pnChannelDetails.channel.id)
+        assertEquals(customData, pnChannelDetails.custom?.value)
     }
 
     @Test
@@ -60,7 +60,7 @@ class MembershipsTest : BaseIntegrationTest() {
             message as PNSetMembershipEventMessage
             assertEquals(channel, message.data.channel)
             assertEquals(pubnub.configuration.userId.value, message.data.uuid)
-            assertEquals(customData, message.data.custom)
+            assertEquals(customData, message.data.custom?.value)
         }
     }
 
@@ -79,7 +79,7 @@ class MembershipsTest : BaseIntegrationTest() {
         while (true) {
             val result = pubnub.getChannelMembers(channel, page = next).await()
             next = result.next
-            assertFalse { result.data.any { it.uuid?.id == pubnub.configuration.userId.value } }
+            assertFalse { result.data.any { it.uuid.id == pubnub.configuration.userId.value } }
             if (next == null || result.data.isEmpty()) {
                 break
             }