feat: Add delivery_events flag to Config

Added a `deliveryEventsEnabled` flag to the `Config` model. This allows disabling message delivery events on a per-channel basis. Delivery receipts will not be stored or sent if this flag is disabled in the channel configuration.

Author: andremion

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/ConfigDto.kt

@@ -26,6 +26,7 @@ internal data class ConfigDto(
     val name: String?,
     val typing_events: Boolean,
     val read_events: Boolean,
+    val delivery_events: Boolean?,
     val connect_events: Boolean,
     val search: Boolean,
     val reactions: Boolean,

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/receipts/MessageReceiptManager.kt

@@ -112,6 +112,10 @@ internal class MessageReceiptManager(
     }
 
     private fun getUndeliveredMessage(channel: Channel): Message? {
+        if (!channel.config.deliveryEventsEnabled) {
+            logger.w { "[getUndeliveredMessage] Delivery events disabled for channel ${channel.cid}" }
+            return null
+        }
         val currentUser = getCurrentUser() ?: run {
             logger.w { "[getUndeliveredMessage] Cannot get undelivered message: current user is null" }
             return null

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/EventChatJsonProvider.kt

@@ -691,6 +691,7 @@ private fun createConfigJsonString() =
           "name": "team",
           "typing_events": true,
           "read_events": true,
+          "delivery_events": true,
           "connect_events": true,
           "search": true,
           "reactions": true,

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/Mother.kt

@@ -481,6 +481,7 @@ internal object Mother {
         name: String? = randomString(),
         typing_events: Boolean = randomBoolean(),
         read_events: Boolean = randomBoolean(),
+        delivery_events: Boolean = randomBoolean(),
         connect_events: Boolean = randomBoolean(),
         search: Boolean = randomBoolean(),
         reactions: Boolean = randomBoolean(),
@@ -507,6 +508,7 @@ internal object Mother {
         name = name,
         typing_events = typing_events,
         read_events = read_events,
+        delivery_events = delivery_events,
         connect_events = connect_events,
         search = search,
         reactions = reactions,

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/parser2/testdata/ChannelDtoTestData.kt

@@ -38,6 +38,7 @@ internal object ChannelDtoTestData {
           "name" : "config1",
           "typing_events": true,
           "read_events": true,
+          "delivery_events": true,
           "connect_events": true,
           "search": false,
           "reactions": true,
@@ -74,6 +75,7 @@ internal object ChannelDtoTestData {
         name = "config1",
         typing_events = true,
         read_events = true,
+        delivery_events = true,
         connect_events = true,
         search = false,
         reactions = true,

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/receipts/MessageReceiptManagerTest.kt

@@ -24,6 +24,7 @@ import io.getstream.chat.android.models.Message
 import io.getstream.chat.android.models.User
 import io.getstream.chat.android.randomChannel
 import io.getstream.chat.android.randomChannelUserRead
+import io.getstream.chat.android.randomConfig
 import io.getstream.chat.android.randomDate
 import io.getstream.chat.android.randomMessage
 import io.getstream.chat.android.randomMessageList
@@ -197,6 +198,17 @@ internal class MessageReceiptManagerTest {
         fixture.verifyUpsertMessageReceiptsCalled(receipts = receipts)
     }
 
+    @Test
+    fun `should skip storing channel delivery receipts when delivery events are disabled`() = runTest {
+        val channel = randomChannel(config = randomConfig(deliveryEventsEnabled = false))
+        val fixture = Fixture()
+        val sut = fixture.get()
+
+        sut.markChannelsAsDelivered(channels = listOf(channel))
+
+        fixture.verifyUpsertMessageReceiptsCalled(never())
+    }
+
     @Test
     fun `should skip storing channel delivery receipts when current user is null`() = runTest {
         val channel = randomChannel()

stream-chat-android-core/api/stream-chat-android-core.api

@@ -686,8 +686,8 @@ public final class io/getstream/chat/android/models/Command {
 
 public final class io/getstream/chat/android/models/Config {
 	public fun <init> ()V
-	public fun <init> (Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZ)V
-	public synthetic fun <init> (Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZ)V
+	public synthetic fun <init> (Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Ljava/util/Date;
 	public final fun component10 ()Z
 	public final fun component11 ()Z
@@ -696,25 +696,26 @@ public final class io/getstream/chat/android/models/Config {
 	public final fun component14 ()Z
 	public final fun component15 ()Z
 	public final fun component16 ()Z
-	public final fun component17 ()Ljava/lang/String;
-	public final fun component18 ()I
-	public final fun component19 ()Ljava/lang/String;
+	public final fun component17 ()Z
+	public final fun component18 ()Ljava/lang/String;
+	public final fun component19 ()I
 	public final fun component2 ()Ljava/util/Date;
 	public final fun component20 ()Ljava/lang/String;
 	public final fun component21 ()Ljava/lang/String;
-	public final fun component22 ()Ljava/util/List;
-	public final fun component23 ()Z
+	public final fun component22 ()Ljava/lang/String;
+	public final fun component23 ()Ljava/util/List;
 	public final fun component24 ()Z
 	public final fun component25 ()Z
+	public final fun component26 ()Z
 	public final fun component3 ()Ljava/lang/String;
 	public final fun component4 ()Z
 	public final fun component5 ()Z
 	public final fun component6 ()Z
 	public final fun component7 ()Z
 	public final fun component8 ()Z
 	public final fun component9 ()Z
-	public final fun copy (Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZ)Lio/getstream/chat/android/models/Config;
-	public static synthetic fun copy$default (Lio/getstream/chat/android/models/Config;Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZILjava/lang/Object;)Lio/getstream/chat/android/models/Config;
+	public final fun copy (Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZ)Lio/getstream/chat/android/models/Config;
+	public static synthetic fun copy$default (Lio/getstream/chat/android/models/Config;Ljava/util/Date;Ljava/util/Date;Ljava/lang/String;ZZZZZZZZZZZZZZLjava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ZZZILjava/lang/Object;)Lio/getstream/chat/android/models/Config;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getAutomod ()Ljava/lang/String;
 	public final fun getAutomodBehavior ()Ljava/lang/String;
@@ -723,6 +724,7 @@ public final class io/getstream/chat/android/models/Config {
 	public final fun getConnectEventsEnabled ()Z
 	public final fun getCreatedAt ()Ljava/util/Date;
 	public final fun getCustomEventsEnabled ()Z
+	public final fun getDeliveryEventsEnabled ()Z
 	public final fun getMarkMessagesPending ()Z
 	public final fun getMaxMessageLength ()I
 	public final fun getMessageRemindersEnabled ()Z

stream-chat-android-core/src/main/java/io/getstream/chat/android/models/Config.kt

@@ -50,6 +50,11 @@ public data class Config(
      */
     val readEventsEnabled: Boolean = true,
 
+    /**
+     *  Determines if events are fired for message deliveries. Enabled by default.
+     */
+    val deliveryEventsEnabled: Boolean = true,
+
     /**
      * Determines if events are fired for connecting and disconnecting to a chat. Enabled by default.
      */

stream-chat-android-core/src/testFixtures/kotlin/io/getstream/chat/android/Mother.kt

@@ -526,6 +526,7 @@ public fun randomConfig(
     name: String = randomString(),
     typingEventsEnabled: Boolean = randomBoolean(),
     readEventsEnabled: Boolean = randomBoolean(),
+    deliveryEventsEnabled: Boolean = randomBoolean(),
     connectEventsEnabled: Boolean = randomBoolean(),
     searchEnabled: Boolean = randomBoolean(),
     isReactionsEnabled: Boolean = randomBoolean(),
@@ -548,6 +549,7 @@ public fun randomConfig(
     name = name,
     typingEventsEnabled = typingEventsEnabled,
     readEventsEnabled = readEventsEnabled,
+    deliveryEventsEnabled = deliveryEventsEnabled,
     connectEventsEnabled = connectEventsEnabled,
     searchEnabled = searchEnabled,
     isReactionsEnabled = isReactionsEnabled,