feat(dart): endpoint level timeout

Author: Fluf22

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/dio/dio_requester.dart

@@ -121,4 +121,12 @@ class DioRequester implements Requester {
   void setClientApiKey(String apiKey) {
     _authInterceptor.apiKey = apiKey;
   }
+
+  @override
+  get connectTimeout => _client.options.connectTimeout;
+
+  @override
+  void setConnectTimeout(Duration connectTimeout) {
+    _client.options.connectTimeout = connectTimeout;
+  }
 }

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/request_options.dart

@@ -6,6 +6,9 @@ final class RequestOptions {
   /// The read timeout for the request in milliseconds.
   final Duration? readTimeout;
 
+  /// The connect timeout for the request in milliseconds.
+  final Duration? connectTimeout;
+
   /// Header names to their respective values to be sent with the request.
   final Map<String, dynamic> headers;
 
@@ -18,18 +21,35 @@ final class RequestOptions {
   const RequestOptions({
     this.writeTimeout,
     this.readTimeout,
+    this.connectTimeout,
     this.headers = const {},
     this.urlParameters = const {},
     this.body,
   });
 
+  RequestOptions operator +(RequestOptions? other) {
+    if (other == null) {
+      return this;
+    }
+
+    return RequestOptions(
+      writeTimeout: other.writeTimeout ?? writeTimeout,
+      readTimeout: other.readTimeout ?? readTimeout,
+      connectTimeout: other.connectTimeout ?? connectTimeout,
+      headers: {...headers, ...other.headers},
+      urlParameters: {...urlParameters, ...other.urlParameters},
+      body: other.body ?? body,
+    );
+  }
+
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
       other is RequestOptions &&
           runtimeType == other.runtimeType &&
           writeTimeout == other.writeTimeout &&
           readTimeout == other.readTimeout &&
+          connectTimeout == other.connectTimeout &&
           headers == other.headers &&
           urlParameters == other.urlParameters &&
           body == other.body;
@@ -38,12 +58,13 @@ final class RequestOptions {
   int get hashCode =>
       writeTimeout.hashCode ^
       readTimeout.hashCode ^
+      connectTimeout.hashCode ^
       headers.hashCode ^
       urlParameters.hashCode ^
       body.hashCode;
 
   @override
   String toString() {
-    return 'RequestOptions{writeTimeout: $writeTimeout, readTimeout: $readTimeout, headers: $headers, urlParameters: $urlParameters, body: $body}';
+    return 'RequestOptions{writeTimeout: $writeTimeout, readTimeout: $readTimeout, connectTimeout: $connectTimeout, headers: $headers, urlParameters: $urlParameters, body: $body}';
   }
 }

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/requester.dart

@@ -14,6 +14,10 @@ abstract class Requester {
   /// Allows to switch the API key used to authenticate requests.
   void setClientApiKey(String apiKey);
 
+  /// Allows to customise the connect timeout for the requester.
+  get connectTimeout => null;
+  void setConnectTimeout(Duration connectTimeout);
+
   /// Closes any underlying resources that the Requester might be using.
   ///
   /// By default, it does nothing (no-op), but it can be implemented to handle resource cleanup

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/retry_strategy.dart

@@ -53,8 +53,13 @@ final class RetryStrategy {
     final List<AlgoliaException> errors = [];
     for (final host in hosts) {
       final httpRequest = _buildRequest(host, request, callType, options);
+      final requesterConnectTimeout = requester.connectTimeout;
+      if (options?.connectTimeout != null) {
+        requester.setConnectTimeout(options!.connectTimeout!);
+      }
       try {
         final response = await requester.perform(httpRequest);
+        requester.setConnectTimeout(requesterConnectTimeout);
         return response.body ?? const {};
       } on AlgoliaTimeoutException catch (e) {
         host.timedOut();

generators/src/main/java/com/algolia/codegen/AlgoliaDartGenerator.java

@@ -2,7 +2,10 @@
 
 import static org.apache.commons.lang3.StringUtils.*;
 
+import com.algolia.codegen.lambda.ToSecondsLambda;
 import com.algolia.codegen.utils.*;
+import com.google.common.collect.ImmutableMap;
+import com.samskivert.mustache.Mustache;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.servers.Server;
@@ -109,6 +112,11 @@ public void processOpts() {
     additionalProperties.put("packageVersion", version);
   }
 
+  @Override
+  protected ImmutableMap.Builder<String, Mustache.Lambda> addMustacheLambdas() {
+    return super.addMustacheLambdas().put("toSeconds", new ToSecondsLambda());
+  }
+
   @Override
   public void processOpenAPI(OpenAPI openAPI) {
     super.processOpenAPI(openAPI);

templates/dart/api.mustache

@@ -165,7 +165,11 @@ final class {{classname}} implements ApiClient {
     );  
     {{#returnType}}final response = {{/returnType}}await _retryStrategy.execute(
       request: request,
-      options: requestOptions,
+      options: {{#vendorExtensions.x-timeouts}}new RequestOptions(
+          writeTimeout: Duration(seconds: {{#lambda.toSeconds}}{{{write}}}{{/lambda.toSeconds}}),
+          readTimeout: Duration(seconds: {{#lambda.toSeconds}}{{{read}}}{{/lambda.toSeconds}}),
+          connectTimeout: Duration(seconds: {{#lambda.toSeconds}}{{{connect}}}{{/lambda.toSeconds}}),
+      ) + {{/vendorExtensions.x-timeouts}}requestOptions,
     );
     {{#returnType}}
     return deserialize<{{{.}}}, {{{returnBaseType}}}>(response, '{{{.}}}', growable: true,);

tests/output/dart/lib/src/run.dart

@@ -25,6 +25,7 @@ Future<void> runTest<T extends ApiClient>({
 /// Uses provided function to intercept HTTP requests.
 class RequestInterceptor extends Requester {
   String apiKey = "fake";
+  Duration connectTimeout = Duration(seconds: 30);
 
   Function(HttpRequest) onRequest = (_) {};
 
@@ -46,6 +47,11 @@ class RequestInterceptor extends Requester {
   void setClientApiKey(String apiKey) {
     this.apiKey = apiKey;
   }
+
+  @override
+  void setConnectTimeout(Duration connectTimeout) {
+    this.connectTimeout = connectTimeout;
+  }
 }
 
 /// [InterceptionException] implements [Exception].