feat(clients): endpoint level timeout part 2 [skip-bc] (generated)

algolia-bot · Fluf22 · millotp · algolia-bot · commit 6e71ebc1611a · 2025-01-13T10:57:08.000Z
algolia/api-clients-automation#4318 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com> Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
diff --git a/src/main/scala/algoliasearch/api/AbtestingClient.scala b/src/main/scala/algoliasearch/api/AbtestingClient.scala
@@ -52,15 +52,15 @@ object AbtestingClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(region: Option[String] = None): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/api/AnalyticsClient.scala b/src/main/scala/algoliasearch/api/AnalyticsClient.scala
@@ -66,15 +66,15 @@ object AnalyticsClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(region: Option[String] = None): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/api/IngestionClient.scala b/src/main/scala/algoliasearch/api/IngestionClient.scala
@@ -112,15 +112,15 @@ object IngestionClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(25, TimeUnit.SECONDS)
+    Duration(25000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(25, TimeUnit.SECONDS)
+    Duration(25000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(25, TimeUnit.SECONDS)
+    Duration(25000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(region: String): Seq[Host] = {
@@ -1223,7 +1223,16 @@ class IngestionClient(
       .withBody(pushTaskPayload)
       .withQueryParameter("watch", watch)
       .build()
-    execute[WatchResponse](request, requestOptions)
+    execute[WatchResponse](
+      request,
+      Some(
+        RequestOptions(
+          writeTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          readTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          connectTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS))
+        ) + requestOptions
+      )
+    )
   }
 
   /** Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
@@ -1453,7 +1462,16 @@ class IngestionClient(
       .withMethod("POST")
       .withPath(s"/1/sources/${escape(sourceID)}/discover")
       .build()
-    execute[WatchResponse](request, requestOptions)
+    execute[WatchResponse](
+      request,
+      Some(
+        RequestOptions(
+          writeTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          readTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          connectTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS))
+        ) + requestOptions
+      )
+    )
   }
 
   /** Try a transformation before creating it.
@@ -1676,7 +1694,16 @@ class IngestionClient(
       .withPath(s"/1/sources/validate")
       .withBody(sourceCreate)
       .build()
-    execute[WatchResponse](request, requestOptions)
+    execute[WatchResponse](
+      request,
+      Some(
+        RequestOptions(
+          writeTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          readTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          connectTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS))
+        ) + requestOptions
+      )
+    )
   }
 
   /** Validates an update of a source payload to ensure it can be created and that the data source can be reached by
@@ -1704,7 +1731,16 @@ class IngestionClient(
       .withPath(s"/1/sources/${escape(sourceID)}/validate")
       .withBody(sourceUpdate)
       .build()
-    execute[WatchResponse](request, requestOptions)
+    execute[WatchResponse](
+      request,
+      Some(
+        RequestOptions(
+          writeTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          readTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS)),
+          connectTimeout = Some(Duration(180000, TimeUnit.MILLISECONDS))
+        ) + requestOptions
+      )
+    )
   }
 
 }
diff --git a/src/main/scala/algoliasearch/api/InsightsClient.scala b/src/main/scala/algoliasearch/api/InsightsClient.scala
@@ -46,15 +46,15 @@ object InsightsClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(region: Option[String] = None): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/api/MonitoringClient.scala b/src/main/scala/algoliasearch/api/MonitoringClient.scala
@@ -52,15 +52,15 @@ object MonitoringClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/api/PersonalizationClient.scala b/src/main/scala/algoliasearch/api/PersonalizationClient.scala
@@ -48,15 +48,15 @@ object PersonalizationClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(region: String): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala b/src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala
@@ -50,15 +50,15 @@ object QuerySuggestionsClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(region: String): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/api/RecommendClient.scala b/src/main/scala/algoliasearch/api/RecommendClient.scala
@@ -50,15 +50,15 @@ object RecommendClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(appId: String): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/api/SearchClient.scala b/src/main/scala/algoliasearch/api/SearchClient.scala
@@ -107,15 +107,15 @@ object SearchClient {
   )
 
   private def readTimeout(): Duration = {
-    Duration(5, TimeUnit.SECONDS)
+    Duration(5000, TimeUnit.MILLISECONDS)
   }
 
   private def connectTimeout(): Duration = {
-    Duration(2, TimeUnit.SECONDS)
+    Duration(2000, TimeUnit.MILLISECONDS)
   }
 
   private def writeTimeout(): Duration = {
-    Duration(30, TimeUnit.SECONDS)
+    Duration(30000, TimeUnit.MILLISECONDS)
   }
 
   private def hosts(appId: String): Seq[Host] = {
diff --git a/src/main/scala/algoliasearch/config/RequestOptions.scala b/src/main/scala/algoliasearch/config/RequestOptions.scala
@@ -16,13 +16,27 @@ import scala.concurrent.duration.Duration
   *   HTTP read timeout
   * @param writeTimeout
   *   HTTP write timeout
+  * @param connectTimeout
+  *   HTTP connect timeout
   */
 case class RequestOptions(
     headers: Map[String, String] = Map.empty,
     queryParameters: Map[String, String] = Map.empty,
     readTimeout: Option[Duration] = None,
-    writeTimeout: Option[Duration] = None
-)
+    writeTimeout: Option[Duration] = None,
+    connectTimeout: Option[Duration] = None
+) {
+  def +(other: Option[RequestOptions]): RequestOptions = {
+    val some = other.getOrElse(return this)
+    new RequestOptions(
+      headers = this.headers ++ some.headers,
+      queryParameters = this.queryParameters ++ some.queryParameters,
+      readTimeout = some.readTimeout.orElse(this.readTimeout),
+      writeTimeout = some.writeTimeout.orElse(this.writeTimeout),
+      connectTimeout = some.connectTimeout.orElse(this.connectTimeout)
+    )
+  }
+}
 
 object RequestOptions {
 
@@ -33,6 +47,7 @@ object RequestOptions {
     private val queryParameters: mutable.Map[String, String] = mutable.Map()
     private var readTimeout: Option[Duration] = None
     private var writeTimeout: Option[Duration] = None
+    private var connectTimeout: Option[Duration] = None
 
     /** Adds a header to the request.
       */
@@ -62,14 +77,22 @@ object RequestOptions {
       this
     }
 
+    /** Sets the write timeout for the request.
+      */
+    def withConnectTimeout(connectTimeout: Option[Duration]): Builder = {
+      this.connectTimeout = connectTimeout
+      this
+    }
+
     /** Builds the [[RequestOptions]].
       */
     def build(): RequestOptions = {
       RequestOptions(
         headers = headers.toMap,
         queryParameters = queryParameters.toMap,
         readTimeout = readTimeout,
-        writeTimeout = writeTimeout
+        writeTimeout = writeTimeout,
+        connectTimeout = connectTimeout
       )
     }
   }
diff --git a/src/main/scala/algoliasearch/internal/HttpRequester.scala b/src/main/scala/algoliasearch/internal/HttpRequester.scala
@@ -115,6 +115,7 @@ private[algoliasearch] class HttpRequester private (
     requestOptions.foreach(options => {
       options.readTimeout.foreach(timeout => builder.readTimeout(timeout.toMillis, TimeUnit.MILLISECONDS))
       options.writeTimeout.foreach(timeout => builder.writeTimeout(timeout.toMillis, TimeUnit.MILLISECONDS))
+      options.connectTimeout.foreach(timeout => builder.connectTimeout(timeout.toMillis, TimeUnit.MILLISECONDS))
     })
     builder.build
   }

Original file line number	Diff line number	Diff line change
`@@ -52,15 +52,15 @@ object AbtestingClient {`
`52`	`52`	`)`
`53`	`53`
`54`	`54`	`private def readTimeout(): Duration = {`
`55`		`- Duration(5, TimeUnit.SECONDS)`
	`55`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`private def connectTimeout(): Duration = {`
`59`		`- Duration(2, TimeUnit.SECONDS)`
	`59`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`private def writeTimeout(): Duration = {`
`63`		`- Duration(30, TimeUnit.SECONDS)`
	`63`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`private def hosts(region: Option[String] = None): Seq[Host] = {`
Original file line number	Diff line number	Diff line change
`@@ -66,15 +66,15 @@ object AnalyticsClient {`
`66`	`66`	`)`
`67`	`67`
`68`	`68`	`private def readTimeout(): Duration = {`
`69`		`- Duration(5, TimeUnit.SECONDS)`
	`69`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`private def connectTimeout(): Duration = {`
`73`		`- Duration(2, TimeUnit.SECONDS)`
	`73`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`private def writeTimeout(): Duration = {`
`77`		`- Duration(30, TimeUnit.SECONDS)`
	`77`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`private def hosts(region: Option[String] = None): Seq[Host] = {`
Original file line number	Diff line number	Diff line change
`@@ -46,15 +46,15 @@ object InsightsClient {`
`46`	`46`	`)`
`47`	`47`
`48`	`48`	`private def readTimeout(): Duration = {`
`49`		`- Duration(5, TimeUnit.SECONDS)`
	`49`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`private def connectTimeout(): Duration = {`
`53`		`- Duration(2, TimeUnit.SECONDS)`
	`53`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`private def writeTimeout(): Duration = {`
`57`		`- Duration(30, TimeUnit.SECONDS)`
	`57`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`private def hosts(region: Option[String] = None): Seq[Host] = {`
Original file line number	Diff line number	Diff line change
`@@ -52,15 +52,15 @@ object MonitoringClient {`
`52`	`52`	`)`
`53`	`53`
`54`	`54`	`private def readTimeout(): Duration = {`
`55`		`- Duration(5, TimeUnit.SECONDS)`
	`55`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`private def connectTimeout(): Duration = {`
`59`		`- Duration(2, TimeUnit.SECONDS)`
	`59`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`private def writeTimeout(): Duration = {`
`63`		`- Duration(30, TimeUnit.SECONDS)`
	`63`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`private def hosts(): Seq[Host] = {`
Original file line number	Diff line number	Diff line change
`@@ -48,15 +48,15 @@ object PersonalizationClient {`
`48`	`48`	`)`
`49`	`49`
`50`	`50`	`private def readTimeout(): Duration = {`
`51`		`- Duration(5, TimeUnit.SECONDS)`
	`51`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`private def connectTimeout(): Duration = {`
`55`		`- Duration(2, TimeUnit.SECONDS)`
	`55`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`private def writeTimeout(): Duration = {`
`59`		`- Duration(30, TimeUnit.SECONDS)`
	`59`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`private def hosts(region: String): Seq[Host] = {`
Original file line number	Diff line number	Diff line change
`@@ -50,15 +50,15 @@ object QuerySuggestionsClient {`
`50`	`50`	`)`
`51`	`51`
`52`	`52`	`private def readTimeout(): Duration = {`
`53`		`- Duration(5, TimeUnit.SECONDS)`
	`53`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`private def connectTimeout(): Duration = {`
`57`		`- Duration(2, TimeUnit.SECONDS)`
	`57`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`private def writeTimeout(): Duration = {`
`61`		`- Duration(30, TimeUnit.SECONDS)`
	`61`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`private def hosts(region: String): Seq[Host] = {`
Original file line number	Diff line number	Diff line change
`@@ -50,15 +50,15 @@ object RecommendClient {`
`50`	`50`	`)`
`51`	`51`
`52`	`52`	`private def readTimeout(): Duration = {`
`53`		`- Duration(5, TimeUnit.SECONDS)`
	`53`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`private def connectTimeout(): Duration = {`
`57`		`- Duration(2, TimeUnit.SECONDS)`
	`57`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`private def writeTimeout(): Duration = {`
`61`		`- Duration(30, TimeUnit.SECONDS)`
	`61`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`private def hosts(appId: String): Seq[Host] = {`
Original file line number	Diff line number	Diff line change
`@@ -107,15 +107,15 @@ object SearchClient {`
`107`	`107`	`)`
`108`	`108`
`109`	`109`	`private def readTimeout(): Duration = {`
`110`		`- Duration(5, TimeUnit.SECONDS)`
	`110`	`+ Duration(5000, TimeUnit.MILLISECONDS)`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`private def connectTimeout(): Duration = {`
`114`		`- Duration(2, TimeUnit.SECONDS)`
	`114`	`+ Duration(2000, TimeUnit.MILLISECONDS)`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`private def writeTimeout(): Duration = {`
`118`		`- Duration(30, TimeUnit.SECONDS)`
	`118`	`+ Duration(30000, TimeUnit.MILLISECONDS)`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`private def hosts(appId: String): Seq[Host] = {`