[AND-257] Introduce API Model Transformer (#5568)

* Create transformers for Message and Channel

* Use transformer when mapping models

* Refactor mappers

* Fix test compilation

* Fix checkstyle

* Remove `!!` from our Mappers

* Create UserTransformer

* Use userTransformer to transform user entity

* Fix checkstyle

* Use userId when possible

* Add tests to test transformer in action

* Fix CheckStyle

* Fix

* Fix ApiCheck

* Fix

* Update CHANGELOG.md

* Fix

* Move Transformers to its own package

* Rename transformer parameters

* Fix javadoc

* Add javadoc for public methods

* Fix checkstyle

Author: JcMinarro

CHANGELOG.md

@@ -20,6 +20,7 @@
 ### ⬆️ Improved
 
 ### ✅ Added
+- Introduced `ApiModelTransformers` to allow custom transformations of API models. (#5568)[https://github.com/GetStream/stream-chat-android/pull/5568]
 
 ### ⚠️ Changed
 

stream-chat-android-client/api/stream-chat-android-client.api

@@ -235,6 +235,7 @@ public final class io/getstream/chat/android/client/ChatClient$Builder : io/gets
 	public final fun okHttpClient (Lokhttp3/OkHttpClient;)Lio/getstream/chat/android/client/ChatClient$Builder;
 	public final fun retryPolicy (Lio/getstream/result/call/retry/RetryPolicy;)Lio/getstream/chat/android/client/ChatClient$Builder;
 	public final fun uploadAttachmentsNetworkType (Lio/getstream/chat/android/models/UploadAttachmentsNetworkType;)Lio/getstream/chat/android/client/ChatClient$Builder;
+	public final fun withApiModelTransformer (Lio/getstream/chat/android/client/transformer/ApiModelTransformers;)Lio/getstream/chat/android/client/ChatClient$Builder;
 	public final fun withPlugins ([Lio/getstream/chat/android/client/plugin/factory/PluginFactory;)Lio/getstream/chat/android/client/ChatClient$Builder;
 	public final fun withRepositoryFactoryProvider (Lio/getstream/chat/android/client/persistance/repository/factory/RepositoryFactory$Provider;)Lio/getstream/chat/android/client/ChatClient$Builder;
 }
@@ -2501,12 +2502,14 @@ public final class io/getstream/chat/android/client/extensions/AttachmentExtensi
 
 public final class io/getstream/chat/android/client/extensions/ChannelExtensionKt {
 	public static final fun countUnreadMentionsForUser (Lio/getstream/chat/android/models/Channel;Lio/getstream/chat/android/models/User;)I
-	public static final fun getCurrentUserUnreadCount (Lio/getstream/chat/android/models/Channel;)I
+	public static final fun currentUserUnreadCount (Lio/getstream/chat/android/models/Channel;Ljava/lang/String;)I
+	public static synthetic fun currentUserUnreadCount$default (Lio/getstream/chat/android/models/Channel;Ljava/lang/String;ILjava/lang/Object;)I
 	public static final fun isAnonymousChannel (Lio/getstream/chat/android/models/Channel;)Z
 	public static final fun isArchive (Lio/getstream/chat/android/models/Channel;)Z
 	public static final fun isMutedFor (Lio/getstream/chat/android/models/Channel;Lio/getstream/chat/android/models/User;)Z
 	public static final fun isPinned (Lio/getstream/chat/android/models/Channel;)Z
-	public static final fun syncUnreadCountWithReads (Lio/getstream/chat/android/models/Channel;)Lio/getstream/chat/android/models/Channel;
+	public static final fun syncUnreadCountWithReads (Lio/getstream/chat/android/models/Channel;Ljava/lang/String;)Lio/getstream/chat/android/models/Channel;
+	public static synthetic fun syncUnreadCountWithReads$default (Lio/getstream/chat/android/models/Channel;Ljava/lang/String;ILjava/lang/Object;)Lio/getstream/chat/android/models/Channel;
 }
 
 public final class io/getstream/chat/android/client/extensions/FlowExtensions {
@@ -3163,6 +3166,17 @@ public abstract interface class io/getstream/chat/android/client/token/TokenProv
 	public abstract fun loadToken ()Ljava/lang/String;
 }
 
+public final class io/getstream/chat/android/client/transformer/ApiModelTransformers {
+	public fun <init> ()V
+	public fun <init> (Lio/getstream/chat/android/models/MessageTransformer;Lio/getstream/chat/android/models/MessageTransformer;Lio/getstream/chat/android/models/ChannelTransformer;Lio/getstream/chat/android/models/UserTransformer;Lio/getstream/chat/android/models/UserTransformer;)V
+	public synthetic fun <init> (Lio/getstream/chat/android/models/MessageTransformer;Lio/getstream/chat/android/models/MessageTransformer;Lio/getstream/chat/android/models/ChannelTransformer;Lio/getstream/chat/android/models/UserTransformer;Lio/getstream/chat/android/models/UserTransformer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun getIncomingChannelTransformer ()Lio/getstream/chat/android/models/ChannelTransformer;
+	public final fun getIncomingMessageTransformer ()Lio/getstream/chat/android/models/MessageTransformer;
+	public final fun getIncomingUserTransformer ()Lio/getstream/chat/android/models/UserTransformer;
+	public final fun getOutgoingMessageTransformer ()Lio/getstream/chat/android/models/MessageTransformer;
+	public final fun getOutgoingUserTransformers ()Lio/getstream/chat/android/models/UserTransformer;
+}
+
 public abstract interface class io/getstream/chat/android/client/uploader/FileTransformer {
 	public abstract fun transform (Ljava/io/File;)Ljava/io/File;
 }

stream-chat-android-client/src/debug/java/io/getstream/chat/android/client/di/ChatModule.kt

@@ -25,6 +25,7 @@ import io.getstream.chat.android.client.parser.ChatParser
 import io.getstream.chat.android.client.scope.ClientScope
 import io.getstream.chat.android.client.scope.UserScope
 import io.getstream.chat.android.client.token.TokenManager
+import io.getstream.chat.android.client.transformer.ApiModelTransformers
 import io.getstream.chat.android.client.uploader.FileTransformer
 import io.getstream.chat.android.client.uploader.FileUploader
 import okhttp3.OkHttpClient
@@ -41,6 +42,7 @@ internal class ChatModule(
     userScope: UserScope,
     config: ChatClientConfig,
     notificationsHandler: NotificationHandler,
+    apiModelTransformers: ApiModelTransformers,
     fileTransformer: FileTransformer,
     uploader: FileUploader?,
     tokenManager: TokenManager,
@@ -53,6 +55,7 @@ internal class ChatModule(
     userScope,
     config,
     notificationsHandler,
+    apiModelTransformers,
     fileTransformer,
     uploader,
     tokenManager,

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

@@ -58,7 +58,7 @@ import io.getstream.chat.android.client.api.models.identifier.SendReactionIdenti
 import io.getstream.chat.android.client.api.models.identifier.ShuffleGiphyIdentifier
 import io.getstream.chat.android.client.api.models.identifier.UpdateMessageIdentifier
 import io.getstream.chat.android.client.api.models.identifier.getNewerRepliesIdentifier
-import io.getstream.chat.android.client.api2.mapping.toDto
+import io.getstream.chat.android.client.api2.mapping.DtoMapping
 import io.getstream.chat.android.client.api2.model.dto.AttachmentDto
 import io.getstream.chat.android.client.api2.model.dto.DownstreamChannelDto
 import io.getstream.chat.android.client.api2.model.dto.DownstreamMessageDto
@@ -132,6 +132,7 @@ import io.getstream.chat.android.client.token.ConstantTokenProvider
 import io.getstream.chat.android.client.token.TokenManager
 import io.getstream.chat.android.client.token.TokenManagerImpl
 import io.getstream.chat.android.client.token.TokenProvider
+import io.getstream.chat.android.client.transformer.ApiModelTransformers
 import io.getstream.chat.android.client.uploader.FileTransformer
 import io.getstream.chat.android.client.uploader.FileUploader
 import io.getstream.chat.android.client.uploader.NoOpFileTransformer
@@ -236,6 +237,7 @@ public class ChatClient
 internal constructor(
     public val config: ChatClientConfig,
     private val api: ChatApi,
+    private val dtoMapping: DtoMapping,
     private val notifications: ChatNotifications,
     private val tokenManager: TokenManager = TokenManagerImpl(),
     private val userCredentialStorage: UserCredentialStorage,
@@ -2733,6 +2735,12 @@ internal constructor(
             set = set,
             unset = unset,
         )
+            .flatMap { users ->
+                when (val user = users.firstOrNull { it.id == id }) {
+                    null -> ErrorCall(userScope, Error.GenericError("User with id $id not found"))
+                    else -> CoroutineCall(userScope) { Result.Success(user) }
+                }
+            }
     }
 
     /**
@@ -3199,7 +3207,7 @@ internal constructor(
         params: CreateChannelParams,
     ): Call<Channel> {
         val currentUser = getCurrentUser()
-        val members = params.members.map(MemberData::toDto)
+        val members = with(dtoMapping) { params.members.map { it.toDto() } }
         val queryChannelRequest = QueryChannelRequest()
             .withData(params.extraData + mapOf(QueryChannelRequest.KEY_MEMBERS to members))
         return queryChannelInternal(
@@ -3591,6 +3599,7 @@ internal constructor(
         private var repositoryFactoryProvider: RepositoryFactory.Provider? = null
         private var uploadAttachmentsNetworkType = UploadAttachmentsNetworkType.CONNECTED
         private var fileTransformer: FileTransformer = NoOpFileTransformer
+        private var apiModelTransformers: ApiModelTransformers = ApiModelTransformers()
 
         /**
          * Sets the log level to be used by the client.
@@ -3667,6 +3676,13 @@ internal constructor(
             this.fileTransformer = fileTransformer
         }
 
+        /**
+         * Sets a custom [ApiModelTransformers] implementation that will be used by the client to transform models.
+         */
+        public fun withApiModelTransformer(apiModelTransformers: ApiModelTransformers): Builder = apply {
+            this.apiModelTransformers = apiModelTransformers
+        }
+
         /**
          * Sets a custom file uploader implementation that will be used by the client
          * to upload files and images.
@@ -3861,6 +3877,7 @@ internal constructor(
                         context = appContext,
                         notificationConfig = notificationConfig,
                     ),
+                    apiModelTransformers = apiModelTransformers,
                     fileTransformer = fileTransformer,
                     uploader = fileUploader,
                     tokenManager = tokenManager,
@@ -3887,6 +3904,7 @@ internal constructor(
             return ChatClient(
                 config,
                 module.api(),
+                module.dtoMapping,
                 module.notifications(),
                 tokenManager,
                 userCredentialStorage = userCredentialStorage ?: SharedPreferencesCredentialStorage(appContext),

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/ChatApi.kt

@@ -233,7 +233,7 @@ internal interface ChatApi {
         id: String,
         set: Map<String, Any>,
         unset: List<String>,
-    ): Call<User>
+    ): Call<List<User>>
 
     fun queryChannel(
         channelType: String,

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/internal/ExtraDataValidator.kt

@@ -83,9 +83,9 @@ internal class ExtraDataValidator(
             .withExtraDataValidation(users)
     }
 
-    override fun partialUpdateUser(id: String, set: Map<String, Any>, unset: List<String>): Call<User> {
+    override fun partialUpdateUser(id: String, set: Map<String, Any>, unset: List<String>): Call<List<User>> {
         return delegate.partialUpdateUser(id, set, unset)
-            .withExtraDataValidation(set)
+            .withExtraDataValidationOnList(set)
     }
 
     override fun addMembers(
@@ -165,6 +165,21 @@ internal class ExtraDataValidator(
         }
     }
 
+    private inline fun <reified T : CustomObject> Call<List<T>>.withExtraDataValidationOnList(
+        extraData: Map<String, Any>,
+    ): Call<List<T>> {
+        val reserved = extraData.findReserved<T>()
+        return when (reserved.isEmpty()) {
+            true -> this
+            else -> ErrorCall(
+                scope,
+                Error.GenericError(
+                    message = "'extraData' contains reserved keys: ${reserved.joinToString()}",
+                ),
+            )
+        }
+    }
+
     private fun <T : CustomObject> List<T>.findReserved(): Pair<T?, List<String>?> {
         for (obj in this) {
             val reserved = obj.findReserved()