feat: http timeouts

crowdin · Mar 3, 2024 · e72485c · e72485c
1 parent 178b640
commit e72485c
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -84,6 +84,25 @@ Usage of these libraries is wrapped into interfaces and gives possibility to ove
 
 The library entry point is `com.crowdin.client.Client` and this class has additional constructor where you can specify additional configurations (please refer to javadoc).
 
+#### Http timeouts
+
+Library allows you to configure http requests timeout.
+
+```java
+import com.crowdin.client.Client;
+import com.crowdin.client.core.model.ClientConfig;
+import com.crowdin.client.core.model.Credentials;
+
+public class Main {
+
+    public static void main(String[] args) {
+        Credentials credentials = new Credentials("token", "organization");
+        Client client = new Client(credentials, ClientConfig.builder().httpTimeoutMs(5000).build());
+    }
+
+}
+```
+
 ## Seeking Assistance
 
 If you find any problems or would like to suggest a feature, please read the [How can I contribute](/CONTRIBUTING.md#how-can-i-contribute) section in our contributing guidelines.

diff --git a/src/main/java/com/crowdin/client/Sandbox.java b/src/main/java/com/crowdin/client/Sandbox.java
@@ -2,6 +2,7 @@
 
 import com.crowdin.client.core.http.exceptions.HttpBadRequestException;
 import com.crowdin.client.core.http.exceptions.HttpException;
+import com.crowdin.client.core.model.ClientConfig;
 import com.crowdin.client.core.model.Credentials;
 import com.crowdin.client.core.model.ResponseObject;
 import com.crowdin.client.users.model.User;
@@ -15,7 +16,7 @@ public static void main(String[] args) throws FileNotFoundException, Interrupted
         if (args.length > 0) {
             try {
                 Credentials credentials = new Credentials(args[0], "oliynyk");
-                var client = new Client(credentials);
+                var client = new Client(credentials, ClientConfig.builder().httpTimeoutMs(5000).build());
                 ResponseObject<User> user = client.getUsersApi().getAuthenticatedUser();
                 System.out.println(user.getData());
             } catch (HttpException e) {

diff --git a/src/main/java/com/crowdin/client/core/CrowdinApi.java b/src/main/java/com/crowdin/client/core/CrowdinApi.java
@@ -33,7 +33,7 @@ public CrowdinApi(Credentials credentials, ClientConfig clientConfig) {
             ? clientConfig.getJsonTransformer() : new JacksonJsonTransformer();
         this.httpClient = (clientConfig.getHttpClient() != null)
             ? clientConfig.getHttpClient()
-            : new ApacheHttpClient(credentials, jsonTransformer, defaultHeaders, clientConfig.getProxy(), clientConfig.getProxyCreds());
+            : new ApacheHttpClient(credentials, jsonTransformer, defaultHeaders, clientConfig.getProxy(), clientConfig.getProxyCreds(), clientConfig.getHttpTimeoutMs());
         this.clientConfig = clientConfig;
         if (credentials.getBaseUrl() != null) {
             if (credentials.getBaseUrl().endsWith("/")) {

diff --git a/src/main/java/com/crowdin/client/core/http/impl/http/ApacheHttpClient.java b/src/main/java/com/crowdin/client/core/http/impl/http/ApacheHttpClient.java
@@ -59,16 +59,22 @@ public ApacheHttpClient(Credentials credentials, JsonTransformer jsonTransformer
             .build();
     }
 
-    public ApacheHttpClient(Credentials credentials, JsonTransformer jsonTransformer, Map<String, ?> defaultHeaders, ClientConfig.Host proxy, ClientConfig.UsernamePasswordCredentials proxyCreds) {
+    public ApacheHttpClient(Credentials credentials, JsonTransformer jsonTransformer, Map<String, ?> defaultHeaders, ClientConfig.Host proxy, ClientConfig.UsernamePasswordCredentials proxyCreds, Integer timeoutMs) {
         this.credentials = credentials;
         this.jsonTransformer = jsonTransformer;
         this.defaultHeaders = defaultHeaders;
         this.proxy = proxy;
         this.proxyCreds = proxyCreds;
+        RequestConfig.Builder requestConfig = RequestConfig.custom().setCookieSpec(CookieSpecs.STANDARD);
+        if (timeoutMs != null) {
+            requestConfig.setConnectionRequestTimeout(timeoutMs);
+            requestConfig.setConnectTimeout(timeoutMs);
+            requestConfig.setSocketTimeout(timeoutMs);
+        }
         this.httpClient = (proxy != null)
             ? HttpClientBuilder.create()
                 .setProxy(new HttpHost(proxy.getHost(), proxy.getPort()))
-                .setDefaultRequestConfig(RequestConfig.custom().setCookieSpec(CookieSpecs.STANDARD).build())
+                .setDefaultRequestConfig(requestConfig.build())
                 .setDefaultCredentialsProvider((proxyCreds != null)
                     ? new BasicCredentialsProvider() {{
                             setCredentials(new AuthScope(proxy.getHost(), proxy.getPort()), new UsernamePasswordCredentials(proxyCreds.getUsername(), proxyCreds.getPassword()));
@@ -77,7 +83,7 @@ public ApacheHttpClient(Credentials credentials, JsonTransformer jsonTransformer
                 .build()
             : HttpClientBuilder
                 .create()
-                .setDefaultRequestConfig(RequestConfig.custom().setCookieSpec(CookieSpecs.STANDARD).build())
+                .setDefaultRequestConfig(requestConfig.build())
                 .build();
     }
 

diff --git a/src/main/java/com/crowdin/client/core/model/ClientConfig.java b/src/main/java/com/crowdin/client/core/model/ClientConfig.java
@@ -25,6 +25,10 @@ public class ClientConfig {
      * Provide custom http client
      */
     private HttpClient httpClient;
+    /**
+     * Http request timeout in milliseconds
+     */
+    private Integer httpTimeoutMs;
     /**
      * Provide custom json transformer
      */