Adapt the core for usage in FeedsClient (#3)

Author: aleksandar-apostolov

app/src/main/java/io/getstream/android/core/sample/client/StreamClient.kt

@@ -20,6 +20,7 @@ import io.getstream.android.core.api.authentication.StreamTokenManager
 import io.getstream.android.core.api.authentication.StreamTokenProvider
 import io.getstream.android.core.api.log.StreamLogger
 import io.getstream.android.core.api.log.StreamLoggerProvider
+import io.getstream.android.core.api.model.config.StreamClientSerializationConfig
 import io.getstream.android.core.api.model.value.StreamApiKey
 import io.getstream.android.core.api.model.value.StreamHttpClientInfoHeader
 import io.getstream.android.core.api.model.value.StreamUserId
@@ -28,6 +29,7 @@ import io.getstream.android.core.api.processing.StreamBatcher
 import io.getstream.android.core.api.processing.StreamRetryProcessor
 import io.getstream.android.core.api.processing.StreamSerialProcessingQueue
 import io.getstream.android.core.api.processing.StreamSingleFlightProcessor
+import io.getstream.android.core.api.serialization.StreamEventSerialization
 import io.getstream.android.core.api.socket.StreamConnectionIdHolder
 import io.getstream.android.core.api.socket.StreamWebSocketFactory
 import io.getstream.android.core.api.socket.listeners.StreamClientListener
@@ -103,6 +105,14 @@ fun createStreamClient(
         connectionIdHolder = connectionIdHolder,
         socketFactory = socketFactory,
         healthMonitor = healthMonitor,
+        serializationConfig =
+            StreamClientSerializationConfig.default(
+                object : StreamEventSerialization<Unit> {
+                    override fun serialize(data: Unit): Result<String> = Result.success("")
+
+                    override fun deserialize(raw: String): Result<Unit> = Result.success(Unit)
+                }
+            ),
         batcher = batcher,
     )
 }

stream-android-core/src/main/java/io/getstream/android/core/api/StreamClient.kt

@@ -18,8 +18,10 @@ package io.getstream.android.core.api
 import io.getstream.android.core.annotations.StreamCoreApi
 import io.getstream.android.core.api.authentication.StreamTokenManager
 import io.getstream.android.core.api.authentication.StreamTokenProvider
+import io.getstream.android.core.api.http.StreamOkHttpInterceptors
 import io.getstream.android.core.api.log.StreamLoggerProvider
 import io.getstream.android.core.api.model.config.StreamClientSerializationConfig
+import io.getstream.android.core.api.model.config.StreamHttpConfig
 import io.getstream.android.core.api.model.config.StreamSocketConfig
 import io.getstream.android.core.api.model.connection.StreamConnectedUser
 import io.getstream.android.core.api.model.connection.StreamConnectionState
@@ -31,7 +33,7 @@ import io.getstream.android.core.api.processing.StreamBatcher
 import io.getstream.android.core.api.processing.StreamRetryProcessor
 import io.getstream.android.core.api.processing.StreamSerialProcessingQueue
 import io.getstream.android.core.api.processing.StreamSingleFlightProcessor
-import io.getstream.android.core.api.serialization.StreamClientEventSerialization
+import io.getstream.android.core.api.serialization.StreamEventSerialization
 import io.getstream.android.core.api.socket.StreamConnectionIdHolder
 import io.getstream.android.core.api.socket.StreamWebSocket
 import io.getstream.android.core.api.socket.StreamWebSocketFactory
@@ -40,6 +42,7 @@ import io.getstream.android.core.api.socket.monitor.StreamHealthMonitor
 import io.getstream.android.core.api.subscribe.StreamSubscription
 import io.getstream.android.core.api.subscribe.StreamSubscriptionManager
 import io.getstream.android.core.internal.client.StreamClientImpl
+import io.getstream.android.core.internal.serialization.StreamCompositeEventSerializationImpl
 import io.getstream.android.core.internal.serialization.StreamCompositeMoshiJsonSerialization
 import io.getstream.android.core.internal.serialization.StreamMoshiJsonSerializationImpl
 import io.getstream.android.core.internal.serialization.moshi.StreamCoreMoshiProvider
@@ -189,6 +192,7 @@ interface StreamClient {
  * @param tokenManager The token manager.
  * @param singleFlight The single-flight processor.
  * @param serialQueue The serial processing queue.
+ * @param httpConfig The HTTP configuration.
  * @param retryProcessor The retry processor.
  * @param connectionIdHolder The connection ID holder.
  * @param socketFactory The WebSocket factory.
@@ -217,9 +221,10 @@ fun StreamClient(
     socketFactory: StreamWebSocketFactory,
     healthMonitor: StreamHealthMonitor,
     batcher: StreamBatcher<String>,
+    // Http
+    httpConfig: StreamHttpConfig? = null,
     // Serialization
-    serializationConfig: StreamClientSerializationConfig =
-        StreamClientSerializationConfig.defaults(),
+    serializationConfig: StreamClientSerializationConfig,
     // Logging
     logProvider: StreamLoggerProvider = StreamLoggerProvider.defaultAndroidLogger(),
 ): StreamClient {
@@ -248,6 +253,21 @@ fun StreamClient(
             StreamMoshiJsonSerializationImpl(StreamCoreMoshiProvider().builder {}.build()),
             serializationConfig.json,
         )
+
+    httpConfig?.apply {
+        if (automaticInterceptors) {
+            httpBuilder.apply {
+                addInterceptor(StreamOkHttpInterceptors.clientInfo(clientInfoHeader))
+                addInterceptor(StreamOkHttpInterceptors.apiKey(apiKey))
+                addInterceptor(
+                    StreamOkHttpInterceptors.auth("jwt", tokenManager, compositeSerialization)
+                )
+                addInterceptor(StreamOkHttpInterceptors.connectionId(connectionIdHolder))
+            }
+        }
+        configuredInterceptors.forEach { httpBuilder.addInterceptor(it) }
+    }
+
     return StreamClientImpl(
         userId = userId,
         scope = clientScope,
@@ -256,7 +276,6 @@ fun StreamClient(
         serialQueue = serialQueue,
         connectionIdHolder = connectionIdHolder,
         logger = clientLogger,
-        retryProcessor = retryProcessor,
         mutableConnectionState = MutableStateFlow(StreamConnectionState.Idle),
         subscriptionManager = clientSubscriptionManager,
         socketSession =
@@ -271,8 +290,12 @@ fun StreamClient(
                     ),
                 jsonSerialization = compositeSerialization,
                 eventParser =
-                    serializationConfig.eventParser
-                        ?: StreamClientEventSerialization(compositeSerialization),
+                    StreamCompositeEventSerializationImpl(
+                        internal =
+                            serializationConfig.eventParser
+                                ?: StreamEventSerialization(compositeSerialization),
+                        external = serializationConfig.productEventSerializers,
+                    ),
                 healthMonitor = healthMonitor,
                 batcher = batcher,
                 internalSocket = socket,

stream-android-core/src/main/java/io/getstream/android/core/api/http/StreamOkHttpInterceptors.kt

@@ -18,11 +18,14 @@ package io.getstream.android.core.api.http
 import io.getstream.android.core.annotations.StreamCoreApi
 import io.getstream.android.core.api.authentication.StreamTokenManager
 import io.getstream.android.core.api.model.value.StreamApiKey
+import io.getstream.android.core.api.model.value.StreamHttpClientInfoHeader
 import io.getstream.android.core.api.serialization.StreamJsonSerialization
 import io.getstream.android.core.api.socket.StreamConnectionIdHolder
 import io.getstream.android.core.internal.http.interceptor.StreamApiKeyInterceptor
 import io.getstream.android.core.internal.http.interceptor.StreamAuthInterceptor
+import io.getstream.android.core.internal.http.interceptor.StreamClientInfoInterceptor
 import io.getstream.android.core.internal.http.interceptor.StreamConnectionIdInterceptor
+import io.getstream.android.core.internal.http.interceptor.StreamEndpointErrorInterceptor
 import okhttp3.Interceptor
 
 // TODO: Think about better approach
@@ -59,6 +62,15 @@ object StreamOkHttpInterceptors {
     fun connectionId(connectionIdHolder: StreamConnectionIdHolder): Interceptor =
         StreamConnectionIdInterceptor(connectionIdHolder)
 
+    /**
+     * Creates an OkHttp interceptor that adds the client info header to the request.
+     *
+     * @param clientInfoHeader The client info header to add.
+     * @return An OkHttp interceptor.
+     */
+    fun clientInfo(clientInfoHeader: StreamHttpClientInfoHeader): Interceptor =
+        StreamClientInfoInterceptor(clientInfoHeader)
+
     /**
      * Creates an OkHttp interceptor that adds the Stream API key to the request as a query
      * parameter.
@@ -67,4 +79,14 @@ object StreamOkHttpInterceptors {
      * @return An OkHttp interceptor.
      */
     fun apiKey(apiKey: StreamApiKey): Interceptor = StreamApiKeyInterceptor(apiKey)
+
+    /**
+     * Creates an OkHttp interceptor that parses and throws
+     * [io.getstream.android.core.api.model.exceptions.StreamEndpointException] for error responses.
+     *
+     * @param jsonParser JSON parser used to decode error payloads when requests fail.
+     * @return An OkHttp interceptor.
+     */
+    fun error(jsonParser: StreamJsonSerialization): Interceptor =
+        StreamEndpointErrorInterceptor(jsonParser)
 }

stream-android-core/src/main/java/io/getstream/android/core/api/model/config/StreamClientSerializationConfig.kt

@@ -16,8 +16,9 @@
 package io.getstream.android.core.api.model.config
 
 import io.getstream.android.core.annotations.StreamCoreApi
-import io.getstream.android.core.api.serialization.StreamClientEventSerialization
+import io.getstream.android.core.api.model.event.StreamClientWsEvent
 import io.getstream.android.core.api.serialization.StreamJsonSerialization
+import io.getstream.android.core.api.serialization.StreamEventSerialization
 
 /**
  * Configuration for serialization and deserialization in the Stream client.
@@ -30,32 +31,64 @@ import io.getstream.android.core.api.serialization.StreamJsonSerialization
 data class StreamClientSerializationConfig
 private constructor(
     val json: StreamJsonSerialization? = null,
-    val eventParser: StreamClientEventSerialization? = null,
+    val eventParser: StreamEventSerialization<StreamClientWsEvent>? = null,
+    val productEventSerializers: StreamEventSerialization<*>,
+    val internalTypes: Set<String> = setOf("connection.ok", "connection.error", "health.check"),
+    val alsoExternal: Set<String> = emptySet(),
 ) {
     companion object {
         /**
          * Creates a default [StreamClientSerializationConfig]. Using the internal implementations.
          *
+         * @param productEvents The product event serializers.
+         * @param alsoExternal The event types to also parse as external.
          * @return A default [StreamClientSerializationConfig].
          */
-        fun defaults() = StreamClientSerializationConfig()
+        fun <T> default(
+            productEvents: StreamEventSerialization<T>,
+            alsoExternal: Set<String> = emptySet(),
+        ) =
+            StreamClientSerializationConfig(
+                productEventSerializers = productEvents,
+                alsoExternal = alsoExternal,
+            )
 
         /**
          * Creates a [StreamClientSerializationConfig] with the given JSON serialization.
          *
          * @param serialization The JSON serialization implementation.
+         * @param productEvents The product event serializers.
+         * @param alsoExternal The event types to also parse as external.
          * @return A [StreamClientSerializationConfig] with the given JSON serialization.
          */
-        fun json(serialization: StreamJsonSerialization) =
-            StreamClientSerializationConfig(json = serialization)
+        fun <T> json(
+            serialization: StreamJsonSerialization,
+            productEvents: StreamEventSerialization<T>,
+            alsoExternal: Set<String> = emptySet(),
+        ) =
+            StreamClientSerializationConfig(
+                json = serialization,
+                productEventSerializers = productEvents,
+                alsoExternal = alsoExternal,
+            )
 
         /**
          * Creates a [StreamClientSerializationConfig] with the given event parsing.
          *
          * @param serialization The event parsing implementation.
+         * @param productEvents The product event serializers.
+         * @param alsoExternal The event types to also parse as external.
          * @return A [StreamClientSerializationConfig] with the given event parsing.
          */
-        fun event(serialization: StreamClientEventSerialization) =
-            StreamClientSerializationConfig(eventParser = serialization)
+        fun <T> event(
+            serialization: StreamEventSerialization<StreamClientWsEvent>,
+            productEvents: StreamEventSerialization<T>,
+            alsoExternal: Set<String> = emptySet(),
+        ) =
+            StreamClientSerializationConfig(
+                eventParser = serialization,
+                productEventSerializers = productEvents,
+                alsoExternal = alsoExternal,
+            )
     }
 }

stream-android-core/src/main/java/io/getstream/android/core/api/model/config/StreamHttpConfig.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-core-android/blob/main/LICENSE
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.getstream.android.core.api.model.config
+
+import okhttp3.Interceptor
+import okhttp3.OkHttpClient
+
+/**
+ * Configuration for HTTP clients in the Stream client.
+ *
+ * @param httpBuilder The HTTP client builder.
+ * @param automaticInterceptors Whether to add automatic interceptors.
+ * @param configuredInterceptors The configured interceptors.
+ */
+data class StreamHttpConfig(
+    val httpBuilder: OkHttpClient.Builder,
+    val automaticInterceptors: Boolean = true,
+    val configuredInterceptors: Set<Interceptor> = emptySet(),
+)

stream-android-core/src/main/java/io/getstream/android/core/api/model/exceptions/StreamEndpointErrorData.kt

@@ -15,6 +15,7 @@
  */
 package io.getstream.android.core.api.model.exceptions
 
+import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 import io.getstream.android.core.annotations.StreamCoreApi
 
@@ -40,12 +41,12 @@ import io.getstream.android.core.annotations.StreamCoreApi
 @StreamCoreApi
 @JsonClass(generateAdapter = true)
 public data class StreamEndpointErrorData(
-    val code: Int,
-    val duration: String,
-    val message: String,
-    val moreInfo: String,
-    val statusCode: Int,
-    val details: List<Int>,
-    val unrecoverable: Boolean? = null,
-    val exceptionFields: Map<String, String>? = null,
+    @Json(name = "code") val code: Int,
+    @Json(name = "duration") val duration: String? = null,
+    @Json(name = "message") val message: String? = null,
+    @Json(name = "more_info") val moreInfo: String? = null,
+    @Json(name = "StatusCode") val statusCode: Int? = null,
+    @Json(name = "details") val details: List<Int>? = null,
+    @Json(name = "unrecoverable") val unrecoverable: Boolean? = null,
+    @Json(name = "exception_fields") val exceptionFields: Map<String, String>? = null,
 )

…zation/StreamClientEventSerialization.kt …erialization/StreamEventSerialization.ktstream-android-core/src/main/java/io/getstream/android/core/api/serialization/StreamClientEventSerialization.kt renamed to stream-android-core/src/main/java/io/getstream/android/core/api/serialization/StreamEventSerialization.kt stream-android-core/src/main/java/io/getstream/android/core/api/serialization/StreamClientEventSerialization.kt renamed to stream-android-core/src/main/java/io/getstream/android/core/api/serialization/StreamEventSerialization.kt

@@ -20,42 +20,45 @@ import io.getstream.android.core.api.model.event.StreamClientWsEvent
 import io.getstream.android.core.internal.serialization.StreamClientEventSerializationImpl
 
 /**
- * Interface for serializing and deserializing [StreamClientWsEvent] objects.
+ * Interface for serializing and deserializing product event objects.
  *
  * All operations return a [Result] so callers can safely propagate failures (e.g. malformed input,
  * I/O errors, schema mismatches) without throwing.
  *
- * @see StreamClientWsEvent for the event type handled by this interface.
+ * @param T The product event type handled by this interface.
  */
 @StreamCoreApi
-interface StreamClientEventSerialization {
+interface StreamEventSerialization<T> {
+
     /**
-     * Encodes a [StreamClientWsEvent] into a [String] suitable for transport or storage.
+     * Encodes a product event into a [String] suitable for transport or storage.
      *
      * @param data The event to serialize.
      * @return `Result.success(String)` when encoding succeeds, or `Result.failure(Throwable)` when
      *   the process fails.
      */
-    fun serialize(data: StreamClientWsEvent): Result<String>
+    fun serialize(data: T): Result<String>
 
     /**
-     * Decodes a [String] into a [StreamClientWsEvent].
+     * Decodes a product event from a [String] representation.
      *
-     * @param raw The serialized input to decode (e.g. a JSON string).
-     * @return `Result.success(StreamClientWsEvent)` on success, or `Result.failure(Throwable)` if
-     *   decoding fails.
+     * @param raw The string to deserialize.
+     * @return `Result.success(T)` when decoding succeeds, or `Result.failure(Throwable)` when the
+     *   process fails.
      */
-    fun deserialize(raw: String): Result<StreamClientWsEvent>
+    fun deserialize(raw: String): Result<T>
 }
 
+
+
 /**
- * Creates a new [StreamClientEventSerialization] instance.
+ * Creates a new [StreamEventSerialization] instance that can serialize [io.getstream.android.core.api.model.event.StreamClientWsEvent] objects.
  *
  * @param jsonParser The [StreamJsonSerialization] to use for JSON serialization and
  *   deserialization.
- * @return A new [StreamClientEventSerialization] instance.
+ * @return A new [StreamEventSerialization] instance.
  */
 @StreamCoreApi
-fun StreamClientEventSerialization(
+fun StreamEventSerialization(
     jsonParser: StreamJsonSerialization
-): StreamClientEventSerialization = StreamClientEventSerializationImpl(jsonParser)
+): StreamEventSerialization<StreamClientWsEvent> = StreamClientEventSerializationImpl(jsonParser)

stream-android-core/src/main/java/io/getstream/android/core/api/socket/listeners/StreamClientListener.kt

@@ -17,7 +17,6 @@ package io.getstream.android.core.api.socket.listeners
 
 import io.getstream.android.core.annotations.StreamCoreApi
 import io.getstream.android.core.api.model.connection.StreamConnectionState
-import io.getstream.android.core.api.model.event.StreamClientWsEvent
 
 /**
  * Listener interface for Feeds socket events.
@@ -39,7 +38,7 @@ interface StreamClientListener {
      *
      * @param event The event received from the WebSocket.
      */
-    fun onEvent(event: StreamClientWsEvent) {}
+    fun onEvent(event: Any) {}
 
     /**
      * Called when an error occurs on the client.