feat(java): retry strategy APIC-261 (#286)

Author: millotp

clients/algoliasearch-client-java-2/.openapi-generator-ignore

@@ -19,6 +19,7 @@ gradle*
 
 # Selective source file
 algoliasearch-core/com/algolia/auth/**
+algoliasearch-core/com/algolia/ApiException.java
 algoliasearch-core/com/algolia/Configuration.java
 algoliasearch-core/com/algolia/Server*.java
 algoliasearch-core/com/algolia/StringUtil.java

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/ApiException.java

@@ -0,0 +1,30 @@
+package com.algolia.exceptions;
+
+/** Exception thrown in case of API failure such as 4XX, 5XX error. */
+public class AlgoliaApiException extends AlgoliaRuntimeException {
+
+  public int getHttpErrorCode() {
+    return httpErrorCode;
+  }
+
+  private final int httpErrorCode;
+
+  public AlgoliaApiException(
+    String message,
+    Throwable cause,
+    int httpErrorCode
+  ) {
+    super(message, cause);
+    this.httpErrorCode = httpErrorCode;
+  }
+
+  public AlgoliaApiException(String message, int httpErrorCode) {
+    super(message);
+    this.httpErrorCode = httpErrorCode;
+  }
+
+  public AlgoliaApiException(Throwable cause, int httpErrorCode) {
+    super(cause);
+    this.httpErrorCode = httpErrorCode;
+  }
+}

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/exceptions/AlgoliaApiException.java

@@ -0,0 +1,20 @@
+package com.algolia.exceptions;
+
+/**
+ * Exception thrown when an error occurs during the retry strategy. For example: All hosts are
+ * unreachable.
+ */
+public class AlgoliaRetryException extends AlgoliaRuntimeException {
+
+  public AlgoliaRetryException(String message, Throwable cause) {
+    super(message, cause);
+  }
+
+  public AlgoliaRetryException(String message) {
+    super(message);
+  }
+
+  public AlgoliaRetryException(Throwable cause) {
+    super(cause);
+  }
+}

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/exceptions/AlgoliaRetryException.java

@@ -0,0 +1,17 @@
+package com.algolia.exceptions;
+
+/** Exception thrown when an error occurs during the Serialization/Deserialization process */
+public class AlgoliaRuntimeException extends RuntimeException {
+
+  public AlgoliaRuntimeException(String message, Throwable cause) {
+    super(message, cause);
+  }
+
+  public AlgoliaRuntimeException(String message) {
+    super(message);
+  }
+
+  public AlgoliaRuntimeException(Throwable cause) {
+    super(cause);
+  }
+}

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/exceptions/AlgoliaRuntimeException.java

@@ -1,9 +1,11 @@
 package com.algolia.utils;
 
 import com.algolia.ApiCallback;
-import com.algolia.ApiException;
 import com.algolia.ProgressResponseBody;
+import com.algolia.utils.retry.RetryStrategy;
+import com.algolia.utils.retry.StatefulHost;
 import java.io.IOException;
+import java.util.List;
 import java.util.concurrent.TimeUnit;
 import okhttp3.Call;
 import okhttp3.Interceptor;
@@ -15,18 +17,23 @@
 
 public class HttpRequester implements Requester {
 
+  private RetryStrategy retryStrategy;
   private OkHttpClient httpClient;
   private HttpLoggingInterceptor loggingInterceptor;
   private boolean debugging;
 
-  public HttpRequester() {
+  public HttpRequester(List<StatefulHost> hosts) {
+    this.retryStrategy = new RetryStrategy(hosts);
+
     OkHttpClient.Builder builder = new OkHttpClient.Builder();
+    builder.addInterceptor(retryStrategy.getRetryInterceptor());
     builder.addNetworkInterceptor(getProgressInterceptor());
+    builder.retryOnConnectionFailure(false);
 
     httpClient = builder.build();
   }
 
-  public Call newCall(Request request) throws ApiException {
+  public Call newCall(Request request) {
     return httpClient.newCall(request);
   }
 

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/utils/HttpRequester.java

@@ -1,11 +1,10 @@
 package com.algolia.utils;
 
-import com.algolia.ApiException;
 import okhttp3.Call;
 import okhttp3.Request;
 
 public interface Requester {
-  public Call newCall(Request request) throws ApiException;
+  public Call newCall(Request request);
 
   /**
    * Enable/disable debugging for this API client.

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/utils/Requester.java

@@ -0,0 +1,21 @@
+package com.algolia.utils;
+
+import java.time.Clock;
+import java.time.Instant;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.time.zone.ZoneRules;
+
+public class Utils {
+
+  private static final ZoneRules ZONE_RULES_UTC = ZoneOffset.UTC.getRules();
+
+  /**
+   * Memory optimization for getZoneRules with the same ZoneOffset (UTC). ZoneRules is immutable and
+   * threadsafe, but getRules method consumes a lot of memory during load testing.
+   */
+  public static OffsetDateTime nowUTC() {
+    final Instant now = Clock.system(ZoneOffset.UTC).instant();
+    return OffsetDateTime.ofInstant(now, ZONE_RULES_UTC.getOffset(now));
+  }
+}

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/utils/Utils.java

@@ -1,34 +1,46 @@
 package com.algolia.utils.echo;
 
-import com.algolia.ApiException;
 import com.algolia.utils.Requester;
 import okhttp3.Request;
 
 public class EchoRequester implements Requester {
 
-  public CallEcho newCall(Request request) throws ApiException {
+  private int connectionTimeout, readTimeout, writeTimeout;
+
+  public EchoRequester() {
+    this.connectionTimeout = 100;
+    this.readTimeout = 100;
+    this.writeTimeout = 100;
+  }
+
+  public CallEcho newCall(Request request) {
     return new CallEcho(request);
   }
 
   // NO-OP for now
-
   public void setDebugging(boolean debugging) {}
 
   public int getConnectTimeout() {
-    return 100;
+    return this.connectionTimeout;
   }
 
-  public void setConnectTimeout(int connectionTimeout) {}
+  public void setConnectTimeout(int connectionTimeout) {
+    this.connectionTimeout = connectionTimeout;
+  }
 
   public int getReadTimeout() {
-    return 100;
+    return this.readTimeout;
   }
 
-  public void setReadTimeout(int readTimeout) {}
+  public void setReadTimeout(int readTimeout) {
+    this.readTimeout = readTimeout;
+  }
 
   public int getWriteTimeout() {
-    return 100;
+    return this.writeTimeout;
   }
 
-  public void setWriteTimeout(int writeTimeout) {}
+  public void setWriteTimeout(int writeTimeout) {
+    this.writeTimeout = writeTimeout;
+  }
 }

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/utils/echo/EchoRequester.java

@@ -0,0 +1,6 @@
+package com.algolia.utils.retry;
+
+public enum CallType {
+  READ,
+  WRITE,
+}

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/utils/retry/CallType.java

@@ -0,0 +1,7 @@
+package com.algolia.utils.retry;
+
+public enum RetryOutcome {
+  SUCCESS,
+  RETRY,
+  FAILURE,
+}