feat(java): endpoint level timeout

Author: Fluf22

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/config/RequestOptions.java

@@ -4,6 +4,7 @@
 import java.time.Duration;
 import java.util.HashMap;
 import java.util.Map;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Request options are used to pass extra parameters, headers, timeout to the request. Parameters
@@ -15,6 +16,7 @@ public final class RequestOptions {
   private final Map<String, String> queryParameters = new HashMap<>();
   private Duration readTimeout;
   private Duration writeTimeout;
+  private Duration connectTimeout;
 
   public RequestOptions addExtraHeader(String key, Object value) {
     if (value == null) return this;
@@ -62,6 +64,32 @@ public RequestOptions setWriteTimeout(Duration writeTimeout) {
     return this;
   }
 
+  public Duration getConnectTimeout() {
+    return connectTimeout;
+  }
+
+  public RequestOptions setConnectTimeout(Duration connectTimeout) {
+    this.connectTimeout = connectTimeout;
+    return this;
+  }
+
+  // `this` will be merged in `other`. Values in `other` will take precedence over `this`'s.
+  public RequestOptions mergeRight(@Nullable RequestOptions other) {
+    if (other == null) {
+      return this;
+    }
+
+    RequestOptions requestOptions = new RequestOptions();
+    requestOptions.headers.putAll(this.headers);
+    requestOptions.headers.putAll(other.headers);
+    requestOptions.queryParameters.putAll(this.queryParameters);
+    requestOptions.queryParameters.putAll(other.queryParameters);
+    requestOptions.readTimeout = other.readTimeout != null ? other.readTimeout : this.readTimeout;
+    requestOptions.writeTimeout = other.writeTimeout != null ? other.writeTimeout : this.writeTimeout;
+    requestOptions.connectTimeout = other.connectTimeout != null ? other.connectTimeout : this.connectTimeout;
+    return requestOptions;
+  }
+
   @Override
   public String toString() {
     return (
@@ -74,6 +102,8 @@ public String toString() {
       readTimeout +
       ", writeTimeout=" +
       writeTimeout +
+      ", connectTimeout=" +
+      connectTimeout +
       '}'
     );
   }

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/HttpRequester.java

@@ -172,6 +172,9 @@ private OkHttpClient getOkHttpClient(RequestOptions requestOptions) {
     if (requestOptions.getWriteTimeout() != null) {
       builder.writeTimeout(requestOptions.getWriteTimeout());
     }
+    if (requestOptions.getConnectTimeout() != null) {
+      builder.connectTimeout(requestOptions.getConnectTimeout());
+    }
     return builder.build();
   }
 

templates/java/api.mustache

@@ -6,6 +6,7 @@ import {{invokerPackage}}.ApiClient;
 import {{invokerPackage}}.config.ClientOptions;
 
 import com.fasterxml.jackson.core.type.TypeReference;
+import org.jetbrains.annotations.Nullable;
 
 import okhttp3.Call;
 import okhttp3.Request;
@@ -138,7 +139,7 @@ public class {{classname}} extends ApiClient {
      {{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
      * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
     {{> api_javadoc}}
-    public {{> return_type}} {{operationId}}({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}} {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<T> innerType{{/x-is-generic}}{{/vendorExtensions}}{{#hasParams}}, {{/hasParams}}RequestOptions requestOptions) throws AlgoliaRuntimeException {
+    public {{> return_type}} {{operationId}}({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}} {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<T> innerType{{/x-is-generic}}{{/vendorExtensions}}{{#hasParams}}, {{/hasParams}}@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
         {{#returnType}}return {{/returnType}}LaunderThrowable.await({{operationId}}Async({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}requestOptions));
         {{^returnType}}return ;{{/returnType}}
     }
@@ -161,7 +162,7 @@ public class {{classname}} extends ApiClient {
     {{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
     * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
    {{> api_javadoc}}
-  public {{> return_type}} {{operationId}}({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}, {{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<T> innerType, {{/x-is-generic}}{{/vendorExtensions}}RequestOptions requestOptions) throws AlgoliaRuntimeException {
+  public {{> return_type}} {{operationId}}({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}, {{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<T> innerType, {{/x-is-generic}}{{/vendorExtensions}} @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
     {{#returnType}}return {{/returnType}}this.{{operationId}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, {{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}requestOptions);
   }
   {{/optionalParams.0}}
@@ -185,7 +186,7 @@ public class {{classname}} extends ApiClient {
   * @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
   * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
   {{> api_javadoc}}
-  public {{> return_type_async}} {{operationId}}Async({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}},{{/requiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}, {{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<T> innerType, {{/x-is-generic}}{{/vendorExtensions}}RequestOptions requestOptions) throws AlgoliaRuntimeException {
+  public {{> return_type_async}} {{operationId}}Async({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}},{{/requiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}, {{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<T> innerType, {{/x-is-generic}}{{/vendorExtensions}}@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
     {{#allParams}}{{#required}}
     Parameters.requireNonNull({{paramName}}, "Parameter `{{paramName}}` is required when calling `{{operationId}}`.");
     {{/required}}{{/allParams}}
@@ -198,7 +199,7 @@ public class {{classname}} extends ApiClient {
         {{#headerParams}}.addHeader("{{baseName}}", {{paramName}}){{/headerParams}}    
           {{#vendorExtensions}}{{#queryParams}}{{^x-is-custom-request}}.addQueryParameter("{{baseName}}", {{paramName}}){{/x-is-custom-request}}{{#x-is-custom-request}}.addQueryParameters(parameters){{/x-is-custom-request}}{{/queryParams}}{{/vendorExtensions}}
         .build();
-    return executeAsync(request, requestOptions, {{#vendorExtensions}}{{#x-is-generic}}{{{returnType}}}.class, innerType{{/x-is-generic}}{{/vendorExtensions}}{{^vendorExtensions.x-is-generic}}{{^returnType}}null{{/returnType}}{{#returnType}}new TypeReference<{{{.}}}>(){}{{/returnType}}{{/vendorExtensions.x-is-generic}});
+    return executeAsync(request, {{#vendorExtensions.x-timeouts}}new RequestOptions().setReadTimeout(Duration.ofMillis({{{read}}}L)).setWriteTimeout(Duration.ofMillis({{{write}}}L)).setConnectTimeout(Duration.ofMillis({{{connect}}}L)).mergeRight({{/vendorExtensions.x-timeouts}}requestOptions{{#vendorExtensions.x-timeouts}}){{/vendorExtensions.x-timeouts}}, {{#vendorExtensions}}{{#x-is-generic}}{{{returnType}}}.class, innerType{{/x-is-generic}}{{/vendorExtensions}}{{^vendorExtensions.x-is-generic}}{{^returnType}}null{{/returnType}}{{#returnType}}new TypeReference<{{{.}}}>(){}{{/returnType}}{{/vendorExtensions.x-is-generic}});
   }
 
   {{! This case only sets `requestOptions` as optional }}
@@ -221,7 +222,7 @@ public class {{classname}} extends ApiClient {
   * @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
   * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
   {{> api_javadoc}}
-  public {{> return_type_async}} {{operationId}}Async({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}, {{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<T> innerType, {{/x-is-generic}}{{/vendorExtensions}}RequestOptions requestOptions) throws AlgoliaRuntimeException {
+  public {{> return_type_async}} {{operationId}}Async({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}, {{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<T> innerType, {{/x-is-generic}}{{/vendorExtensions}}@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
     return this.{{operationId}}Async({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, {{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}requestOptions);
   }
   {{/optionalParams.0}}