fix: add connect timeout config (#411)

aallam · web-flow · commit ef26aff0d499 · 2023-12-07T11:09:04.000+01:00
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/Configuration.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/Configuration.kt
@@ -23,6 +23,11 @@ public interface Configuration : Closeable {
      */
     public val readTimeout: Long
 
+    /**
+     * The timeout when connecting to the server.
+     */
+    public val connectTimeout: Long
+
     /**
      * [LogLevel] to display in the console.
      */
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationAnalytics.kt
@@ -3,7 +3,9 @@
 package com.algolia.search.configuration
 
 import com.algolia.search.client.ClientAnalytics
+import com.algolia.search.configuration.internal.*
 import com.algolia.search.configuration.internal.ConfigurationAnalyticsImpl
+import com.algolia.search.configuration.internal.DEFAULT_CONNECT_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.configuration.internal.DEFAULT_READ_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_WRITE_TIMEOUT
@@ -52,6 +54,7 @@ public fun ConfigurationAnalytics(
     engine: HttpClientEngine? = null,
     httpClientConfig: (HttpClientConfig<*>.() -> Unit)? = null,
     logger: Logger = Logger.Simple,
+    connectTimeout: Long = DEFAULT_CONNECT_TIMEOUT,
 ): ConfigurationAnalytics = ConfigurationAnalyticsImpl(
     applicationID = applicationID,
     apiKey = apiKey,
@@ -64,4 +67,5 @@ public fun ConfigurationAnalytics(
     engine = engine,
     httpClientConfig = httpClientConfig,
     logger = logger,
+    connectTimeout = connectTimeout,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationInsights.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationInsights.kt
@@ -3,7 +3,9 @@
 package com.algolia.search.configuration
 
 import com.algolia.search.client.ClientInsights
+import com.algolia.search.configuration.internal.*
 import com.algolia.search.configuration.internal.ConfigurationInsightsImpl
+import com.algolia.search.configuration.internal.DEFAULT_CONNECT_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.configuration.internal.DEFAULT_READ_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_WRITE_TIMEOUT
@@ -44,6 +46,7 @@ public fun ConfigurationInsights(
     engine: HttpClientEngine? = null,
     httpClientConfig: (HttpClientConfig<*>.() -> Unit)? = null,
     logger: Logger = Logger.Simple,
+    connectTimeout: Long = DEFAULT_CONNECT_TIMEOUT,
 ): ConfigurationInsights = ConfigurationInsightsImpl(
     applicationID = applicationID,
     apiKey = apiKey,
@@ -55,4 +58,5 @@ public fun ConfigurationInsights(
     engine = engine,
     httpClientConfig = httpClientConfig,
     logger = logger,
+    connectTimeout = connectTimeout,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationPersonalization.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationPersonalization.kt
@@ -3,7 +3,9 @@
 package com.algolia.search.configuration
 
 import com.algolia.search.client.ClientPersonalization
+import com.algolia.search.configuration.internal.*
 import com.algolia.search.configuration.internal.ConfigurationPersonalizationImpl
+import com.algolia.search.configuration.internal.DEFAULT_CONNECT_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.configuration.internal.DEFAULT_READ_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_WRITE_TIMEOUT
@@ -52,6 +54,7 @@ public fun ConfigurationPersonalization(
     engine: HttpClientEngine? = null,
     httpClientConfig: (HttpClientConfig<*>.() -> Unit)? = null,
     logger: Logger = Logger.Simple,
+    connectTimeout: Long = DEFAULT_CONNECT_TIMEOUT,
 ): ConfigurationPersonalization = ConfigurationPersonalizationImpl(
     applicationID = applicationID,
     apiKey = apiKey,
@@ -64,4 +67,5 @@ public fun ConfigurationPersonalization(
     engine = engine,
     httpClientConfig = httpClientConfig,
     logger = logger,
+    connectTimeout = connectTimeout,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationPlaces.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationPlaces.kt
@@ -3,7 +3,9 @@
 package com.algolia.search.configuration
 
 import com.algolia.search.client.ClientPlaces
+import com.algolia.search.configuration.internal.*
 import com.algolia.search.configuration.internal.ConfigurationPlacesImpl
+import com.algolia.search.configuration.internal.DEFAULT_CONNECT_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.configuration.internal.DEFAULT_READ_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_WRITE_TIMEOUT
@@ -28,6 +30,7 @@ public fun ConfigurationPlaces(
     engine: HttpClientEngine? = null,
     httpClientConfig: (HttpClientConfig<*>.() -> Unit)? = null,
     logger: Logger = Logger.Simple,
+    connectTimeout: Long = DEFAULT_CONNECT_TIMEOUT,
 ): ConfigurationPlaces = ConfigurationPlacesImpl(
     writeTimeout = writeTimeout,
     readTimeout = readTimeout,
@@ -37,4 +40,5 @@ public fun ConfigurationPlaces(
     engine = engine,
     httpClientConfig = httpClientConfig,
     logger = logger,
+    connectTimeout = connectTimeout,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationRecommend.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationRecommend.kt
@@ -1,6 +1,8 @@
 package com.algolia.search.configuration
 
+import com.algolia.search.configuration.internal.*
 import com.algolia.search.configuration.internal.ConfigurationRecommendImpl
+import com.algolia.search.configuration.internal.DEFAULT_CONNECT_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.configuration.internal.DEFAULT_READ_TIMEOUT
 import com.algolia.search.configuration.internal.DEFAULT_WRITE_TIMEOUT
@@ -43,6 +45,7 @@ public fun ConfigurationRecommend(
     httpClientConfig: (HttpClientConfig<*>.() -> Unit)? = null,
     compression: Compression = Compression.None,
     logger: Logger = Logger.Simple,
+    connectTimeout: Long = DEFAULT_CONNECT_TIMEOUT,
 ): ConfigurationRecommend = ConfigurationRecommendImpl(
     applicationID = applicationID,
     apiKey = apiKey,
@@ -55,4 +58,5 @@ public fun ConfigurationRecommend(
     httpClientConfig = httpClientConfig,
     compression = compression,
     logger = logger,
+    connectTimeout = connectTimeout,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationSearch.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationSearch.kt
@@ -3,6 +3,7 @@
 package com.algolia.search.configuration
 
 import com.algolia.search.client.ClientSearch
+import com.algolia.search.configuration.internal.*
 import com.algolia.search.configuration.internal.ConfigurationSearchImpl
 import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
 import com.algolia.search.configuration.internal.DEFAULT_READ_TIMEOUT
@@ -46,6 +47,8 @@ public fun ConfigurationSearch(
     httpClientConfig: (HttpClientConfig<*>.() -> Unit)? = null,
     compression: Compression = Compression.None,
     logger: Logger = Logger.Simple,
+    connectTimeout: Long = DEFAULT_CONNECT_TIMEOUT,
+
 ): ConfigurationSearch = ConfigurationSearchImpl(
     applicationID = applicationID,
     apiKey = apiKey,
@@ -57,5 +60,6 @@ public fun ConfigurationSearch(
     engine = engine,
     httpClientConfig = httpClientConfig,
     compression = compression,
-    logger = logger
+    logger = logger,
+    connectTimeout = connectTimeout,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationAnalyticsImpl.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationAnalyticsImpl.kt
@@ -28,6 +28,7 @@ internal class ConfigurationAnalyticsImpl(
     override val engine: HttpClientEngine?,
     override val httpClientConfig: (HttpClientConfig<*>.() -> Unit)?,
     override val logger: Logger,
+    override val connectTimeout: Long,
 ) : ConfigurationAnalytics {
 
     override val compression: Compression = Compression.None
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationInsightsImpl.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationInsightsImpl.kt
@@ -26,6 +26,7 @@ internal data class ConfigurationInsightsImpl(
     override val engine: HttpClientEngine?,
     override val httpClientConfig: (HttpClientConfig<*>.() -> Unit)?,
     override val logger: Logger,
+    override val connectTimeout: Long,
 ) : ConfigurationInsights {
 
     override val compression: Compression = Compression.None
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationPersonalizationImpl.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationPersonalizationImpl.kt
@@ -28,6 +28,7 @@ internal class ConfigurationPersonalizationImpl(
     override val engine: HttpClientEngine?,
     override val httpClientConfig: (HttpClientConfig<*>.() -> Unit)?,
     override val logger: Logger,
+    override val connectTimeout: Long,
 ) : ConfigurationPersonalization {
 
     override val compression: Compression = Compression.None
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationPlacesImpl.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationPlacesImpl.kt
@@ -22,6 +22,7 @@ internal class ConfigurationPlacesImpl(
     override val engine: HttpClientEngine?,
     override val httpClientConfig: (HttpClientConfig<*>.() -> Unit)?,
     override val logger: Logger,
+    override val connectTimeout: Long,
 ) : ConfigurationPlaces {
 
     override val compression: Compression = Compression.None
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationRecommendImpl.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationRecommendImpl.kt
@@ -28,6 +28,7 @@ internal class ConfigurationRecommendImpl(
     override val httpClientConfig: (HttpClientConfig<*>.() -> Unit)?,
     override val compression: Compression,
     override val logger: Logger,
+    override val connectTimeout: Long,
 ) : ConfigurationRecommend {
 
     override val httpClient: HttpClient = getHttpClient()
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationSearchImpl.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationSearchImpl.kt
@@ -28,6 +28,7 @@ internal class ConfigurationSearchImpl(
     override val httpClientConfig: (HttpClientConfig<*>.() -> Unit)?,
     override val compression: Compression,
     override val logger: Logger,
+    override val connectTimeout: Long,
 ) : ConfigurationSearch {
 
     override val httpClient: HttpClient = getHttpClient()
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/Constants.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/Constants.kt
@@ -4,4 +4,5 @@ import com.algolia.search.logging.LogLevel
 
 internal const val DEFAULT_WRITE_TIMEOUT: Long = 30000L
 internal const val DEFAULT_READ_TIMEOUT: Long = 5000L
+internal const val DEFAULT_CONNECT_TIMEOUT: Long = 2000L
 internal val DEFAULT_LOG_LEVEL = LogLevel.None
diff --git a/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/extension/HttpClient.kt b/client/src/commonMain/kotlin/com/algolia/search/configuration/internal/extension/HttpClient.kt
@@ -32,7 +32,9 @@ internal fun HttpClientConfig<*>.configure(configuration: Configuration) {
     install(AlgoliaAgent)
 
     // Timeout
-    install(HttpTimeout)
+    install(HttpTimeout) {
+        connectTimeoutMillis = configuration.connectTimeout
+    }
 
     // Gzip Compression
     install(ClientCompression) {
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,7 @@
 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-8.5-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
+T
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -18,5 +18,4 @@ rootProject.name = "algoliasearch-client-kotlin"
 include(":client")
 include(":client-bom")
 
-enableFeaturePreview("VERSION_CATALOGS")
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
