feat: add configurable timeouts (#71)

Author: aallam

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

openai-client/build.gradle.kts

@@ -20,6 +20,7 @@ kotlin {
                 optIn("kotlin.RequiresOptIn")
                 optIn("okio.ExperimentalFileSystem")
                 optIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
+                optIn("com.aallam.openai.api.ExperimentalOpenAI")
             }
         }
         val commonMain by getting {

openai-client/src/commonMain/kotlin/com.aallam.openai.client/OpenAIConfig.kt

@@ -1,13 +1,21 @@
 package com.aallam.openai.client
 
+import com.aallam.openai.api.http.Timeout
 import com.aallam.openai.api.logging.LogLevel
 import com.aallam.openai.api.logging.Logger
+import kotlin.time.Duration.Companion.seconds
 
 /**
  * OpenAI client configuration.
+ *
+ * @param token OpenAI Token
+ * @param logger http client logging level
+ * @param logLevel http client logger
+ * @param timeout http client timeout
  */
 public class OpenAIConfig(
     public val token: String,
     public val logLevel: LogLevel = LogLevel.Headers,
     public val logger: Logger = Logger.Simple,
+    public val timeout: Timeout = Timeout(socket = 30.seconds),
 )

openai-client/src/commonMain/kotlin/com.aallam.openai.client/internal/HttpClient.kt

@@ -11,14 +11,11 @@ import io.ktor.client.plugins.auth.providers.bearer
 import io.ktor.client.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.client.plugins.defaultRequest
 import io.ktor.client.plugins.logging.Logging
-import io.ktor.client.request.accept
-import io.ktor.client.request.header
 import io.ktor.http.ContentType
-import io.ktor.http.HttpHeaders
 import io.ktor.http.URLProtocol
-import io.ktor.http.contentType
 import io.ktor.serialization.kotlinx.KotlinxSerializationConverter
 import kotlinx.serialization.json.Json
+import kotlin.time.DurationUnit
 
 /**
  * Default Http Client.
@@ -41,7 +38,15 @@ internal fun createHttpClient(config: OpenAIConfig): HttpClient {
         }
 
         install(HttpTimeout) {
-            socketTimeoutMillis = 30000 // 30s
+            config.timeout.socket?.let { socketTimeout ->
+                socketTimeoutMillis = socketTimeout.toLong(DurationUnit.MILLISECONDS)
+            }
+            config.timeout.connect?.let { connectTimeout ->
+                connectTimeoutMillis = connectTimeout.toLong(DurationUnit.MILLISECONDS)
+            }
+            config.timeout.request?.let { requestTimeout ->
+                requestTimeoutMillis = requestTimeout.toLong(DurationUnit.MILLISECONDS)
+            }
         }
 
         defaultRequest {

openai-core/src/commonMain/kotlin/com.aallam.openai.api/http/Timeout.kt

@@ -0,0 +1,18 @@
+package com.aallam.openai.api.http
+
+import com.aallam.openai.api.ExperimentalOpenAI
+import kotlin.time.Duration
+
+/**
+ * Http operations timeouts.
+ *
+ * @param request time period required to process an HTTP call: from sending a request to receiving a response
+ * @param connect time period in which a client should establish a connection with a server
+ * @param socket maximum time of inactivity between two data packets when exchanging data with a server
+ */
+@ExperimentalOpenAI
+public class Timeout(
+    public val request: Duration? = null,
+    public val connect: Duration? = null,
+    public val socket: Duration? = null,
+)