[ECO-5009][CHA-RL1] Room ATTACH

chat-android/build.gradle.kts

@@ -45,6 +45,7 @@ buildConfig {
 dependencies {
     api(libs.ably.android)
     implementation(libs.gson)
+    implementation(libs.coroutine.core)
 
     testImplementation(libs.junit)
     testImplementation(libs.mockk)

chat-android/src/main/java/com/ably/chat/ChatApi.kt

@@ -87,7 +87,7 @@ internal class ChatApi(private val realtimeClient: RealtimeClient, private val c
                 ErrorInfo(
                     "Metadata contains reserved 'ably-chat' key",
                     HttpStatusCodes.BadRequest,
-                    ErrorCodes.InvalidRequestBody,
+                    ErrorCodes.InvalidRequestBody.errorCode,
                 ),
             )
         }
@@ -98,7 +98,7 @@ internal class ChatApi(private val realtimeClient: RealtimeClient, private val c
                 ErrorInfo(
                     "Headers contains reserved key with reserved 'ably-chat' prefix",
                     HttpStatusCodes.BadRequest,
-                    ErrorCodes.InvalidRequestBody,
+                    ErrorCodes.InvalidRequestBody.errorCode,
                 ),
             )
         }

chat-android/src/main/java/com/ably/chat/ErrorCodes.kt

@@ -3,105 +3,106 @@ package com.ably.chat
 /**
  * Error codes for the Chat SDK.
  */
-object ErrorCodes {
+enum class ErrorCodes(val errorCode: Int) {
+
     /**
      * The messages feature failed to attach.
      */
-    const val MessagesAttachmentFailed = 102_001
+    MessagesAttachmentFailed(102_001),
 
     /**
      * The presence feature failed to attach.
      */
-    const val PresenceAttachmentFailed = 102_002
+    PresenceAttachmentFailed(102_002),
 
     /**
      * The reactions feature failed to attach.
      */
-    const val ReactionsAttachmentFailed = 102_003
+    ReactionsAttachmentFailed(102_003),
 
     /**
      * The occupancy feature failed to attach.
      */
-    const val OccupancyAttachmentFailed = 102_004
+    OccupancyAttachmentFailed(102_004),
 
     /**
      * The typing feature failed to attach.
      */
-    const val TypingAttachmentFailed = 102_005
-    // 102006 - 102049 reserved for future use for attachment errors
+    TypingAttachmentFailed(102_005),
+    // 102_006 - 102_049 reserved for future use for attachment errors
 
     /**
      * The messages feature failed to detach.
      */
-    const val MessagesDetachmentFailed = 102_050
+    MessagesDetachmentFailed(102_050),
 
     /**
      * The presence feature failed to detach.
      */
-    const val PresenceDetachmentFailed = 102_051
+    PresenceDetachmentFailed(102_051),
 
     /**
      * The reactions feature failed to detach.
      */
-    const val ReactionsDetachmentFailed = 102_052
+    ReactionsDetachmentFailed(102_052),
 
     /**
      * The occupancy feature failed to detach.
      */
-    const val OccupancyDetachmentFailed = 102_053
+    OccupancyDetachmentFailed(102_053),
 
     /**
      * The typing feature failed to detach.
      */
-    const val TypingDetachmentFailed = 102_054
-    // 102055 - 102099 reserved for future use for detachment errors
+    TypingDetachmentFailed(102_054),
+    // 102_055 - 102_099 reserved for future use for detachment errors
 
     /**
      * The room has experienced a discontinuity.
      */
-    const val RoomDiscontinuity = 102_100
+    RoomDiscontinuity(102_100),
 
     // Unable to perform operation;
 
     /**
      * Cannot perform operation because the room is in a failed state.
      */
-    const val RoomInFailedState = 102_101
+    RoomInFailedState(102_101),
 
     /**
      * Cannot perform operation because the room is in a releasing state.
      */
-    const val RoomIsReleasing = 102_102
+    RoomIsReleasing(102_102),
 
     /**
      * Cannot perform operation because the room is in a released state.
      */
-    const val RoomIsReleased = 102_103
+    RoomIsReleased(102_103),
 
     /**
      * Cannot perform operation because the previous operation failed.
      */
-    const val PreviousOperationFailed = 102_104
+    PreviousOperationFailed(102_104),
 
     /**
      * An unknown error has happened in the room lifecycle.
      */
-    const val RoomLifecycleError = 102_105
+    RoomLifecycleError(102_105),
 
     /**
      * The request cannot be understood
      */
-    const val BadRequest = 40_000
+    BadRequest(40_000),
 
     /**
      * Invalid request body
      */
-    const val InvalidRequestBody = 40_001
+    InvalidRequestBody(40_001),
 
     /**
      * Internal error
      */
-    const val InternalError = 50_000
+    InternalError(50_000),
 }
 
 /**

chat-android/src/main/java/com/ably/chat/Messages.kt

@@ -5,13 +5,13 @@ package com.ably.chat
 import com.ably.chat.QueryOptions.MessageOrder.NewestFirst
 import com.google.gson.JsonObject
 import io.ably.lib.realtime.AblyRealtime
-import io.ably.lib.realtime.Channel
 import io.ably.lib.realtime.ChannelState
 import io.ably.lib.realtime.ChannelStateListener
 import io.ably.lib.types.AblyException
 import io.ably.lib.types.ErrorInfo
+import io.ably.lib.realtime.Channel as AblyRealtimeChannel
 
-typealias PubSubMessageListener = Channel.MessageListener
+typealias PubSubMessageListener = AblyRealtimeChannel.MessageListener
 typealias PubSubMessage = io.ably.lib.types.Message
 
 /**
@@ -26,7 +26,7 @@ interface Messages : EmitsDiscontinuities {
      *
      * @returns the realtime channel
      */
-    val channel: Channel
+    val channel: AblyRealtimeChannel
 
     /**
      * Subscribe to new messages in this chat room.
@@ -207,7 +207,7 @@ internal class DefaultMessagesSubscription(
                 ErrorInfo(
                     "The `end` parameter is specified and is more recent than the subscription point timeserial",
                     HttpStatusCodes.BadRequest,
-                    ErrorCodes.BadRequest,
+                    ErrorCodes.BadRequest.errorCode,
                 ),
             )
         }
@@ -225,7 +225,7 @@ internal class DefaultMessages(
     private val roomId: String,
     realtimeChannels: AblyRealtime.Channels,
     private val chatApi: ChatApi,
-) : Messages {
+) : Messages, ContributesToRoomLifecycle, ResolvedContributor {
 
     private var listeners: Map<Messages.Listener, DeferredValue<String>> = emptyMap()
 
@@ -239,7 +239,13 @@ internal class DefaultMessages(
      */
     private val messagesChannelName = "$roomId::\$chat::\$chatMessages"
 
-    override val channel: Channel = realtimeChannels.get(messagesChannelName, ChatChannelOptions())
+    override val channel = realtimeChannels.get(messagesChannelName, ChatChannelOptions())
+
+    override val contributor: ContributesToRoomLifecycle = this
+
+    override val attachmentErrorCode: ErrorCodes = ErrorCodes.MessagesAttachmentFailed
+
+    override val detachmentErrorCode: ErrorCodes = ErrorCodes.MessagesDetachmentFailed
 
     init {
         channelStateListener = ChannelStateListener {
@@ -253,7 +259,7 @@ internal class DefaultMessages(
         addListener(listener, deferredChannelSerial)
         val messageListener = PubSubMessageListener {
             val pubSubMessage = it ?: throw AblyException.fromErrorInfo(
-                ErrorInfo("Got empty pubsub channel message", HttpStatusCodes.BadRequest, ErrorCodes.BadRequest),
+                ErrorInfo("Got empty pubsub channel message", HttpStatusCodes.BadRequest, ErrorCodes.BadRequest.errorCode),
             )
             val data = parsePubSubMessageData(pubSubMessage.data)
             val chatMessage = Message(
@@ -284,7 +290,7 @@ internal class DefaultMessages(
                     ErrorInfo(
                         "This messages subscription instance was already unsubscribed",
                         HttpStatusCodes.BadRequest,
-                        ErrorCodes.BadRequest,
+                        ErrorCodes.BadRequest.errorCode,
                     ),
                 )
             },
@@ -323,14 +329,22 @@ internal class DefaultMessages(
     private fun requireChannelSerial(): String {
         return channel.properties.channelSerial
             ?: throw AblyException.fromErrorInfo(
-                ErrorInfo("Channel has been attached, but channelSerial is not defined", HttpStatusCodes.BadRequest, ErrorCodes.BadRequest),
+                ErrorInfo(
+                    "Channel has been attached, but channelSerial is not defined",
+                    HttpStatusCodes.BadRequest,
+                    ErrorCodes.BadRequest.errorCode,
+                ),
             )
     }
 
     private fun requireAttachSerial(): String {
         return channel.properties.attachSerial
             ?: throw AblyException.fromErrorInfo(
-                ErrorInfo("Channel has been attached, but attachSerial is not defined", HttpStatusCodes.BadRequest, ErrorCodes.BadRequest),
+                ErrorInfo(
+                    "Channel has been attached, but attachSerial is not defined",
+                    HttpStatusCodes.BadRequest,
+                    ErrorCodes.BadRequest.errorCode,
+                ),
             )
     }
 

chat-android/src/main/java/com/ably/chat/Occupancy.kt

@@ -2,7 +2,7 @@
 
 package com.ably.chat
 
-import io.ably.lib.realtime.Channel
+import io.ably.lib.realtime.Channel as AblyRealtimeChannel
 
 /**
  * This interface is used to interact with occupancy in a chat room: subscribing to occupancy updates and
@@ -16,7 +16,7 @@ interface Occupancy : EmitsDiscontinuities {
      *
      * @returns The underlying Ably channel for occupancy events.
      */
-    val channel: Channel
+    val channel: AblyRealtimeChannel
 
     /**
      * Subscribe a given listener to occupancy updates of the chat room.
@@ -61,9 +61,15 @@ data class OccupancyEvent(
 
 internal class DefaultOccupancy(
     private val messages: Messages,
-) : Occupancy {
-    override val channel: Channel
-        get() = messages.channel
+) : Occupancy, ContributesToRoomLifecycle, ResolvedContributor {
+
+    override val channel = messages.channel
+
+    override val contributor: ContributesToRoomLifecycle = this
+
+    override val attachmentErrorCode: ErrorCodes = ErrorCodes.OccupancyAttachmentFailed
+
+    override val detachmentErrorCode: ErrorCodes = ErrorCodes.OccupancyDetachmentFailed
 
     override fun subscribe(listener: Occupancy.Listener): Subscription {
         TODO("Not yet implemented")

chat-android/src/main/java/com/ably/chat/Presence.kt

@@ -3,8 +3,8 @@
 package com.ably.chat
 
 import android.text.PrecomputedText.Params
-import io.ably.lib.realtime.Channel
 import io.ably.lib.types.PresenceMessage
+import io.ably.lib.realtime.Channel as AblyRealtimeChannel
 
 typealias PresenceData = Any
 
@@ -19,7 +19,7 @@ interface Presence : EmitsDiscontinuities {
      * Get the underlying Ably realtime channel used for presence in this chat room.
      * @returns The realtime channel.
      */
-    val channel: Channel
+    val channel: AblyRealtimeChannel
 
     /**
      * Method to get list of the current online users and returns the latest presence messages associated to it.
@@ -131,10 +131,15 @@ data class PresenceEvent(
 
 internal class DefaultPresence(
     private val messages: Messages,
-) : Presence {
+) : Presence, ContributesToRoomLifecycle, ResolvedContributor {
 
-    override val channel: Channel
-        get() = messages.channel
+    override val channel = messages.channel
+
+    override val contributor: ContributesToRoomLifecycle = this
+
+    override val attachmentErrorCode: ErrorCodes = ErrorCodes.PresenceAttachmentFailed
+
+    override val detachmentErrorCode: ErrorCodes = ErrorCodes.PresenceDetachmentFailed
 
     override suspend fun get(params: List<Params>): List<PresenceMember> {
         TODO("Not yet implemented")