chore: Made inline usage in each request to prevent inline function used on BBBClient.execute() to improve testability

Author: LeeGodSRC

src/main/kotlin/dev/imanity/bbbapi/BBBClient.kt

@@ -12,19 +12,18 @@ import io.ktor.utils.io.core.*
 import kotlinx.coroutines.delay
 import kotlinx.serialization.json.Json
 
-class BBBClient(val token: Token): Closeable {
+class BBBClient(val token: Token) : Closeable {
 
-    val throttler = Throttler()
-    val httpClient = HttpClient {
+    private val throttler = Throttler()
+    private val httpClient = HttpClient {
         install(ContentNegotiation) {
             json(Json {
                 ignoreUnknownKeys = true
             })
-            //ignoreUnknownKeys = true
         }
     }
 
-    suspend inline fun <reified T : Any> execute(request: Request<T>, wait: Boolean = true): Response<T> {
+    suspend fun <T : Any> execute(request: Request<T>, wait: Boolean = true): Response<T> {
         while (wait) {
             val stall = throttler.stall(request.method)
             if (stall <= 0) {
@@ -49,88 +48,60 @@ class BBBClient(val token: Token): Closeable {
         return this.executeRequest(request)
     }
 
-    suspend inline fun <reified T : Any> executeRequest(request: Request<T>): Response<T> {
-        return when (request.method) {
+    private suspend fun <T : Any> executeRequest(request: Request<T>) = kotlin.runCatching {
+        val httpResponse = when (request.method) {
             Method.GET -> get(request)
             Method.POST -> post(request, request.body!!)
             Method.DELETE -> delete(request)
             Method.PATCH -> patch(request, request.body!!)
         }
-    }
-
-    suspend inline fun <reified T> get(request: Request<T>): Response<T> {
-        return try {
-            val response = httpClient.get(request.url) {
-                headers {
-                    append("Authorization", token.urlString)
-                }
-            }
 
-            decode(response)
-        } catch (ex: Exception) {
-            Response(ex)
-        }
+        request.decode(httpResponse)
+    }.getOrElse {
+        Response(Type.EXCEPTION, null, null, it, 0)
     }
 
-    suspend inline fun <reified T> post(request: Request<T>, body: Any): Response<T> {
-        return try {
-            val response = httpClient.post(request.url) {
-                headers {
-                    append("Authorization", token.urlString)
-                    append("Content-Type", "application/json")
-                }
-                setBody(body)
-            }
-
-            decode(response)
-        } catch (ex: Exception) {
-            Response(ex)
+    private suspend fun get(request: Request<*>) = httpClient.get(request.url) {
+        headers {
+            append("Authorization", token.urlString)
         }
     }
 
-    suspend inline fun <reified T> delete(request: Request<T>): Response<T> {
-        return try {
-            val response = httpClient.delete(request.url) {
-                headers {
-                    append("Authorization", token.urlString)
-                }
-            }
-
-            decode(response)
-        } catch (ex: Exception) {
-            Response(ex)
+    private suspend fun post(request: Request<*>, body: Any) = httpClient.post(request.url) {
+        headers {
+            append("Authorization", token.urlString)
+            append("Content-Type", "application/json")
         }
+        setBody(body)
     }
 
-    suspend inline fun <reified T> patch(request: Request<T>, body: Any): Response<T> {
-        return try {
-            val response = httpClient.patch(request.url) {
-                headers {
-                    append("Authorization", token.urlString)
-                    append("Content-Type", "application/json")
-                }
-                setBody(body)
-            }
-
-            decode(response)
-        } catch (ex: Exception) {
-            Response(ex)
+    private suspend fun delete(request: Request<*>) = httpClient.delete(request.url) {
+        headers {
+            append("Authorization", token.urlString)
         }
     }
 
-    suspend inline fun <reified T> decode(response: HttpResponse): Response<T> {
-        val body = response.body<ResponseBody<T>>()
-        return if (response.headers.contains("Retry-After")) {
-            Response(response.headers["Retry-After"]!!.toLong())
-        } else if (body.result == "error") {
-            Response(body.error!!)
-        } else {
-            Response(body.data!!)
+    private suspend fun patch(request: Request<*>, body: Any) = httpClient.patch(request.url) {
+        headers {
+            append("Authorization", token.urlString)
+            append("Content-Type", "application/json")
         }
+        setBody(body)
     }
 
     override fun close() {
         httpClient.close()
     }
 
+}
+
+suspend inline fun <reified T : Any> decodeResponse(response: HttpResponse): Response<T> {
+    val body = response.body<ResponseBody<T>>()
+    return if (response.headers.contains("Retry-After")) {
+        Response(response.headers["Retry-After"]!!.toLong())
+    } else if (body.result == "error") {
+        Response(body.error!!)
+    } else {
+        Response(body.data!!)
+    }
 }

src/main/kotlin/dev/imanity/bbbapi/request/Request.kt

@@ -1,7 +1,12 @@
 package dev.imanity.bbbapi.request
 
-open class Request<T>(urlPath: String,
+import io.ktor.client.statement.*
+
+abstract class Request<T>(urlPath: String,
                       val method: Method,
                       val body: Any?) {
     val url = "https://api.builtbybit.com/v1/$urlPath"
+
+    abstract suspend fun decode(httpResponse: HttpResponse): Response<T>
+
 }

src/main/kotlin/dev/imanity/bbbapi/request/Response.kt

@@ -2,15 +2,15 @@ package dev.imanity.bbbapi.request
 
 import java.lang.Exception
 
-data class Response<T>(
+data class Response<out T>(
     val type: Type,
     val value: T?,
     val error: Error?,
-    val exception: Exception?,
+    val exception: Throwable?,
     val rateLimitTime: Long
 ) {
     constructor(error: Error) : this(Type.ERROR, null, error, null, 0)
-    constructor(exception: Exception) : this(Type.EXCEPTION, null, null, exception, 0)
+    constructor(exception: Throwable) : this(Type.EXCEPTION, null, null, exception, 0)
     constructor(rateLimitTime: Long) : this(Type.RATE_LIMITED, null, null, null, rateLimitTime)
     constructor(value: T) : this(Type.SUCCESS, value, null, null, 0)
 }

src/main/kotlin/dev/imanity/bbbapi/request/impl/HealthRequest.kt

@@ -2,8 +2,14 @@ package dev.imanity.bbbapi.request.impl
 
 import dev.imanity.bbbapi.request.Method
 import dev.imanity.bbbapi.request.Request
+import dev.imanity.bbbapi.request.Response
+import io.ktor.client.statement.*
 
 class HealthRequest: Request<String>("health", Method.GET, null) {
+    override suspend fun decode(httpResponse: HttpResponse): Response<String> {
+        return dev.imanity.bbbapi.decodeResponse(httpResponse)
+    }
+
     override fun equals(other: Any?): Boolean {
         if (this === other) return true
         if (javaClass != other?.javaClass) return false

src/main/kotlin/dev/imanity/bbbapi/request/impl/alert/ListUnreadAlertsRequest.kt

@@ -1,14 +1,21 @@
 package dev.imanity.bbbapi.request.impl.alert
 
+import dev.imanity.bbbapi.decodeResponse
 import dev.imanity.bbbapi.model.Alert
 import dev.imanity.bbbapi.model.sort.SortOptions
 import dev.imanity.bbbapi.request.Method
 import dev.imanity.bbbapi.request.Request
+import dev.imanity.bbbapi.request.Response
+import io.ktor.client.statement.*
 
 data class ListUnreadAlertsRequest(
     val sortOptions: SortOptions
 ): Request<Array<Alert>>(
     "alerts/alerts${sortOptions}",
     Method.GET,
     null
-)
+) {
+    override suspend fun decode(httpResponse: HttpResponse): Response<Array<Alert>> {
+        return decodeResponse(httpResponse)
+    }
+}

src/main/kotlin/dev/imanity/bbbapi/request/impl/alert/MarkUnreadAlertsAsReadRequest.kt

@@ -1,7 +1,10 @@
 package dev.imanity.bbbapi.request.impl.alert
 
+import dev.imanity.bbbapi.decodeResponse
 import dev.imanity.bbbapi.request.Method
 import dev.imanity.bbbapi.request.Request
+import dev.imanity.bbbapi.request.Response
+import io.ktor.client.statement.*
 
 data class MarkUnreadAlertsAsReadRequest(
     val read: Boolean
@@ -11,4 +14,8 @@ data class MarkUnreadAlertsAsReadRequest(
     mapOf(
         "read" to read
     )
-)
+) {
+    override suspend fun decode(httpResponse: HttpResponse): Response<Unit> {
+        return decodeResponse(httpResponse)
+    }
+}

src/main/kotlin/dev/imanity/bbbapi/request/impl/conversation/ListUnreadConversationsRequest.kt

@@ -1,14 +1,21 @@
 package dev.imanity.bbbapi.request.impl.conversation
 
+import dev.imanity.bbbapi.decodeResponse
 import dev.imanity.bbbapi.model.Conversation
 import dev.imanity.bbbapi.model.sort.SortOptions
 import dev.imanity.bbbapi.request.Method
 import dev.imanity.bbbapi.request.Request
+import dev.imanity.bbbapi.request.Response
+import io.ktor.client.statement.*
 
 data class ListUnreadConversationsRequest(
     val sortOptions: SortOptions
 ): Request<Array<Conversation>>(
     "conversations/conversations${sortOptions}",
     Method.GET,
     null
-)
+) {
+    override suspend fun decode(httpResponse: HttpResponse): Response<Array<Conversation>> {
+        return decodeResponse(httpResponse)
+    }
+}

src/main/kotlin/dev/imanity/bbbapi/request/impl/conversation/StartConversationRequest.kt

@@ -1,7 +1,10 @@
 package dev.imanity.bbbapi.request.impl.conversation
 
+import dev.imanity.bbbapi.decodeResponse
 import dev.imanity.bbbapi.request.Method
 import dev.imanity.bbbapi.request.Request
+import dev.imanity.bbbapi.request.Response
+import io.ktor.client.statement.*
 
 data class StartConversationRequest(
     val userIds: Array<Int>,
@@ -35,4 +38,8 @@ data class StartConversationRequest(
         result = 31 * result + message.hashCode()
         return result
     }
+
+    override suspend fun decode(httpResponse: HttpResponse): Response<Int> {
+        return decodeResponse(httpResponse)
+    }
 }

src/main/kotlin/dev/imanity/bbbapi/request/impl/conversation/reply/ListUnreadConversationRepliesRequest.kt

@@ -1,9 +1,12 @@
 package dev.imanity.bbbapi.request.impl.conversation.reply
 
+import dev.imanity.bbbapi.decodeResponse
 import dev.imanity.bbbapi.model.Reply
 import dev.imanity.bbbapi.model.sort.SortOptions
 import dev.imanity.bbbapi.request.Method
 import dev.imanity.bbbapi.request.Request
+import dev.imanity.bbbapi.request.Response
+import io.ktor.client.statement.*
 
 data class ListUnreadConversationRepliesRequest(
     val conversationId: Int,
@@ -12,4 +15,8 @@ data class ListUnreadConversationRepliesRequest(
     "conversations/$conversationId/replies${sortOptions}",
     Method.GET,
     null
-)
+) {
+    override suspend fun decode(httpResponse: HttpResponse): Response<Array<Reply>> {
+        return decodeResponse(httpResponse)
+    }
+}

src/main/kotlin/dev/imanity/bbbapi/request/impl/conversation/reply/ReplyToUnreadConversationRequest.kt

@@ -1,7 +1,10 @@
 package dev.imanity.bbbapi.request.impl.conversation.reply
 
+import dev.imanity.bbbapi.decodeResponse
 import dev.imanity.bbbapi.request.Method
 import dev.imanity.bbbapi.request.Request
+import dev.imanity.bbbapi.request.Response
+import io.ktor.client.statement.*
 
 data class ReplyToUnreadConversationRequest(
     val conversationId: Int,
@@ -12,4 +15,8 @@ data class ReplyToUnreadConversationRequest(
     mapOf(
         "message" to message,
     ),
-)
+) {
+    override suspend fun decode(httpResponse: HttpResponse): Response<Int> {
+        return decodeResponse(httpResponse)
+    }
+}