feature: remove sendForList method and use Type class instead (th…

…ousandeyes#85) * [GitHub Bot] Generated java SDK * feature: remove `sendForList` method and use `Type` class instead + Change headers type from List to Collection --------- Co-authored-by: API Team <api-team@thousandeyes.com>
brumarqu-te · Oct 1, 2024 · 7762c40 · 7762c40
1 parent f0f6b95
commit 7762c40
Show file tree

Hide file tree

Showing 91 changed files with 136 additions and 133 deletions.
diff --git a/...rc/main/java/com/thousandeyes/sdk/account/management/administrative/AccountGroupsApi.java b/...rc/main/java/com/thousandeyes/sdk/account/management/administrative/AccountGroupsApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.account.management.administrative.model.AccountGroupDetail;
 import com.thousandeyes.sdk.account.management.administrative.model.AccountGroupRequest;
 import com.thousandeyes.sdk.account.management.administrative.model.AccountGroups;

diff --git a/.../src/main/java/com/thousandeyes/sdk/account/management/administrative/PermissionsApi.java b/.../src/main/java/com/thousandeyes/sdk/account/management/administrative/PermissionsApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.account.management.administrative.model.Error;
 import com.thousandeyes.sdk.account.management.administrative.model.Permissions;
 import com.thousandeyes.sdk.account.management.administrative.model.UnauthorizedError;

diff --git a/...rative/src/main/java/com/thousandeyes/sdk/account/management/administrative/RolesApi.java b/...rative/src/main/java/com/thousandeyes/sdk/account/management/administrative/RolesApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.account.management.administrative.model.Error;
 import com.thousandeyes.sdk.account.management.administrative.model.RoleDetail;
 import com.thousandeyes.sdk.account.management.administrative.model.RoleRequestBody;

diff --git a/...e/src/main/java/com/thousandeyes/sdk/account/management/administrative/UserEventsApi.java b/...e/src/main/java/com/thousandeyes/sdk/account/management/administrative/UserEventsApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.account.management.administrative.model.AuditUserEvents;
 import com.thousandeyes.sdk.account.management.administrative.model.Error;
 import java.time.OffsetDateTime;

diff --git a/...rative/src/main/java/com/thousandeyes/sdk/account/management/administrative/UsersApi.java b/...rative/src/main/java/com/thousandeyes/sdk/account/management/administrative/UsersApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.account.management.administrative.model.CreatedUser;
 import com.thousandeyes.sdk.account.management.administrative.model.Error;
 import java.net.URI;

diff --git a/agents/src/main/java/com/thousandeyes/sdk/agents/AgentProxiesApi.java b/agents/src/main/java/com/thousandeyes/sdk/agents/AgentProxiesApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.agents.model.AgentProxies;
 import com.thousandeyes.sdk.agents.model.Error;
 import com.thousandeyes.sdk.agents.model.UnauthorizedError;

diff --git a/...rc/main/java/com/thousandeyes/sdk/agents/CloudAndEnterpriseAgentNotificationRulesApi.java b/...rc/main/java/com/thousandeyes/sdk/agents/CloudAndEnterpriseAgentNotificationRulesApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.agents.model.Error;
 import com.thousandeyes.sdk.agents.model.ListNotificationRulesResponse;
 import com.thousandeyes.sdk.agents.model.NotificationRuleDetail;

diff --git a/agents/src/main/java/com/thousandeyes/sdk/agents/CloudAndEnterpriseAgentsApi.java b/agents/src/main/java/com/thousandeyes/sdk/agents/CloudAndEnterpriseAgentsApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.agents.model.AgentDetails;
 import com.thousandeyes.sdk.agents.model.AgentDetailsExpand;
 import com.thousandeyes.sdk.agents.model.AgentListExpand;

diff --git a/agents/src/main/java/com/thousandeyes/sdk/agents/EnterpriseAgentClusterApi.java b/agents/src/main/java/com/thousandeyes/sdk/agents/EnterpriseAgentClusterApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.agents.model.AgentClusterAssignRequest;
 import com.thousandeyes.sdk.agents.model.AgentClusterUnassignRequest;
 import com.thousandeyes.sdk.agents.model.AgentDetails;

diff --git a/alerts/src/main/java/com/thousandeyes/sdk/alerts/AlertRulesApi.java b/alerts/src/main/java/com/thousandeyes/sdk/alerts/AlertRulesApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.alerts.model.Error;
 import com.thousandeyes.sdk.alerts.model.Rule;
 import com.thousandeyes.sdk.alerts.model.RuleDetail;

diff --git a/alerts/src/main/java/com/thousandeyes/sdk/alerts/AlertSuppressionWindowsApi.java b/alerts/src/main/java/com/thousandeyes/sdk/alerts/AlertSuppressionWindowsApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.alerts.model.AlertSuppressionWindowDetail;
 import com.thousandeyes.sdk.alerts.model.AlertSuppressionWindowRequest;
 import com.thousandeyes.sdk.alerts.model.AlertSuppressionWindows;

diff --git a/alerts/src/main/java/com/thousandeyes/sdk/alerts/AlertsApi.java b/alerts/src/main/java/com/thousandeyes/sdk/alerts/AlertsApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.alerts.model.AlertDetail;
 import com.thousandeyes.sdk.alerts.model.Alerts;
 import com.thousandeyes.sdk.alerts.model.Error;

diff --git a/bgp-monitors/src/main/java/com/thousandeyes/sdk/bgp/monitors/BgpMonitorsApi.java b/bgp-monitors/src/main/java/com/thousandeyes/sdk/bgp/monitors/BgpMonitorsApi.java
@@ -20,7 +20,7 @@
 import com.thousandeyes.sdk.client.ApiRequest;
 import com.thousandeyes.sdk.utils.Config;
 import org.apache.commons.lang3.tuple.Pair;
-
+import org.apache.commons.lang3.reflect.TypeUtils;
 import com.thousandeyes.sdk.bgp.monitors.model.Error;
 import com.thousandeyes.sdk.bgp.monitors.model.Monitors;
 import com.thousandeyes.sdk.bgp.monitors.model.UnauthorizedError;

diff --git a/core/client-native/src/main/java/com/thousandeyes/sdk/client/NativeApiClient.java b/core/client-native/src/main/java/com/thousandeyes/sdk/client/NativeApiClient.java
@@ -20,11 +20,11 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.lang.reflect.Type;
 import java.net.URI;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
-import java.util.List;
 import java.util.StringJoiner;
 import java.util.function.Consumer;
 
@@ -50,19 +50,10 @@ public static NativeApiClientBuilder builder() {
     }
 
     @Override
-    public <T> ApiResponse<T> send(ApiRequest request, Class<T> returnType) throws ApiException {
+    public <T> ApiResponse<T> send(ApiRequest request, Type returnType) throws ApiException {
         return sendRequestAndProcessResponse(
                 getRequestBuilder(request),
-                mapper.readerFor(returnType));
-    }
-
-    @Override
-    public <T> ApiResponse<List<T>> sendForList(ApiRequest request, Class<T> returnType)
-            throws ApiException
-    {
-        return sendRequestAndProcessResponse(
-                getRequestBuilder(request),
-                mapper.readerForListOf(returnType));
+                mapper.readerFor(mapper.constructType(returnType)));
     }
 
     private HttpRequest.Builder getRequestBuilder(ApiRequest request) throws ApiException {

diff --git a/core/client-native/src/test/java/com/thousandeyes/sdk/client/NativeApiClientTest.java b/core/client-native/src/test/java/com/thousandeyes/sdk/client/NativeApiClientTest.java
@@ -21,6 +21,7 @@
 import java.util.Map;
 import java.util.stream.Stream;
 
+import org.apache.commons.lang3.reflect.TypeUtils;
 import org.apache.commons.lang3.tuple.Pair;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -114,7 +115,7 @@ void shouldSendRequestForListCorrectly(String testName, ApiRequest request)
         var expectedResponse = List.of(new Response("name", OffsetDateTime.now(ZoneId.of("UTC"))));
         stubHttpClient(expectedResponse);
 
-        var response = apiClient.sendForList(request, Response.class);
+        var response = apiClient.send(request, TypeUtils.parameterize(List.class, Response.class));
 
         assertEquals(expectedResponse, response.getData());
     }

diff --git a/core/client/src/main/java/com/thousandeyes/sdk/client/ApiClient.java b/core/client/src/main/java/com/thousandeyes/sdk/client/ApiClient.java
@@ -18,13 +18,10 @@
 
 package com.thousandeyes.sdk.client;
 
-import java.util.List;
+import java.lang.reflect.Type;
 
 
 
 public interface ApiClient {
-    <T> ApiResponse<T> send(ApiRequest request, Class<T> returnType) throws ApiException;
-
-    <T> ApiResponse<List<T>> sendForList(ApiRequest request, Class<T> returnType)
-            throws ApiException;
+    <T> ApiResponse<T> send(ApiRequest request, Type returnType) throws ApiException;
 }
diff --git a/core/client/src/main/java/com/thousandeyes/sdk/client/ApiClientDecorator.java b/core/client/src/main/java/com/thousandeyes/sdk/client/ApiClientDecorator.java
@@ -18,7 +18,7 @@
 
 package com.thousandeyes.sdk.client;
 
-import java.util.List;
+import java.lang.reflect.Type;
 import java.util.concurrent.Callable;
 
 import lombok.RequiredArgsConstructor;
@@ -30,19 +30,12 @@ public abstract class ApiClientDecorator implements ApiClient {
     private final ApiClient apiClient;
 
     @Override
-    public final <T> ApiResponse<T> send(ApiRequest request, Class<T> returnType)
+    public final <T> ApiResponse<T> send(ApiRequest request, Type returnType)
             throws ApiException
     {
         return decorate(() -> apiClient.send(request, returnType));
     }
 
-    @Override
-    public final <T> ApiResponse<List<T>> sendForList(ApiRequest request, Class<T> returnType)
-            throws ApiException
-    {
-        return decorate(() -> apiClient.sendForList(request, returnType));
-    }
-
     public abstract <T> ApiResponse<T> decorate(Callable<ApiResponse<T>> requestCallable)
             throws ApiException;
 }
diff --git a/core/client/src/main/java/com/thousandeyes/sdk/client/ApiException.java b/core/client/src/main/java/com/thousandeyes/sdk/client/ApiException.java
@@ -18,7 +18,7 @@
 
 package com.thousandeyes.sdk.client;
 
-import java.util.List;
+import java.util.Collection;
 import java.util.Map;
 
 import lombok.Getter;
@@ -28,10 +28,11 @@
 @Getter
 public class ApiException extends Exception {
     private int code = 0;
-    private Map<String, List<String>> responseHeaders = null;
+    private Map<String, ? extends Collection<String>> responseHeaders = null;
     private Object responseBody = null;
 
-    public ApiException() {}
+    public ApiException() {
+    }
 
     public ApiException(Throwable throwable) {
         super(throwable);
@@ -41,22 +42,32 @@ public ApiException(String message) {
         super(message);
     }
 
-    public ApiException(String message, Throwable throwable, int code, Map<String, List<String>> responseHeaders, Object responseBody) {
+    public ApiException(String message, Throwable throwable, int code,
+                        Map<String, ? extends Collection<String>> responseHeaders,
+                        Object responseBody)
+    {
         super(message, throwable);
         this.code = code;
         this.responseHeaders = responseHeaders;
         this.responseBody = responseBody;
     }
 
-    public ApiException(String message, int code, Map<String, List<String>> responseHeaders, Object responseBody) {
+    public ApiException(String message, int code,
+                        Map<String, ? extends Collection<String>> responseHeaders,
+                        Object responseBody)
+    {
         this(message, null, code, responseHeaders, responseBody);
     }
 
-    public ApiException(String message, Throwable throwable, int code, Map<String, List<String>> responseHeaders) {
+    public ApiException(String message, Throwable throwable, int code,
+                        Map<String, ? extends Collection<String>> responseHeaders)
+    {
         this(message, throwable, code, responseHeaders, null);
     }
 
-    public ApiException(int code, Map<String, List<String>> responseHeaders, Object responseBody) {
+    public ApiException(int code, Map<String, ? extends Collection<String>> responseHeaders,
+                        Object responseBody)
+    {
         this(null, null, code, responseHeaders, responseBody);
     }
 
@@ -65,7 +76,10 @@ public ApiException(int code, String message) {
         this.code = code;
     }
 
-    public ApiException(int code, String message, Map<String, List<String>> responseHeaders, Object responseBody) {
+    public ApiException(int code, String message,
+                        Map<String, ? extends Collection<String>> responseHeaders,
+                        Object responseBody)
+    {
         this(code, message);
         this.responseHeaders = responseHeaders;
         this.responseBody = responseBody;

diff --git a/core/client/src/main/java/com/thousandeyes/sdk/client/ApiRequest.java b/core/client/src/main/java/com/thousandeyes/sdk/client/ApiRequest.java
@@ -19,6 +19,7 @@
 package com.thousandeyes.sdk.client;
 
 import java.time.Duration;
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 
@@ -38,6 +39,6 @@ public class ApiRequest {
     Object requestBody;
     List<Pair<String, String>> queryParams;
     @Singular
-    Map<String, List<String>> headers;
+    Map<String, ? extends Collection<String>> headers;
     Duration readTimeout;
 }
diff --git a/core/client/src/main/java/com/thousandeyes/sdk/client/ApiResponse.java b/core/client/src/main/java/com/thousandeyes/sdk/client/ApiResponse.java
@@ -18,21 +18,24 @@
 
 package com.thousandeyes.sdk.client;
 
-import java.util.List;
+import java.util.Collection;
 import java.util.Map;
 
 import lombok.Getter;
 
+
+
 @Getter
 public class ApiResponse<T> {
     final private int statusCode;
-    final private Map<String, List<String>> headers;
+    final private Map<String, ? extends Collection<String>> headers;
     final private T data;
-    
-    public ApiResponse(int statusCode, Map<String, List<String>> headers) {
+
+    public ApiResponse(int statusCode, Map<String, ? extends Collection<String>> headers) {
         this(statusCode, headers, null);
     }
-    public ApiResponse(int statusCode, Map<String, List<String>> headers, T data) {
+
+    public ApiResponse(int statusCode, Map<String, ? extends Collection<String>> headers, T data) {
         this.statusCode = statusCode;
         this.headers = headers;
         this.data = data;

diff --git a/core/client/src/main/java/com/thousandeyes/sdk/client/RateLimitDecorator.java b/core/client/src/main/java/com/thousandeyes/sdk/client/RateLimitDecorator.java
@@ -19,8 +19,10 @@
 package com.thousandeyes.sdk.client;
 
 import java.time.Instant;
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.OptionalLong;
 import java.util.concurrent.Callable;
 import java.util.concurrent.TimeUnit;
@@ -60,11 +62,11 @@ private <T> T awaitAndRetry(ApiException apiException, Callable<T> requestCallab
         throw apiException;
     }
 
-    private OptionalLong retryAfterInSeconds(Map<String, List<String>> headers) {
+    private OptionalLong retryAfterInSeconds(Map<String, ? extends Collection<String>> headers) {
         return RATE_LIMIT_RESET_HEADERS.stream()
-                                       .flatMap(headerName -> headers.getOrDefault(headerName,
-                                                                                   List.of())
-                                                                     .stream())
+                                       .flatMap(headerName -> Optional.ofNullable(
+                                               headers.get(headerName)).stream())
+                                       .flatMap(Collection::stream)
                                        .mapToLong(Long::parseLong)
                                        .map(rlResetInstant -> rlResetInstant -
                                                               Instant.now().getEpochSecond())

diff --git a/core/client/src/test/java/com/thousandeyes/sdk/RateLimitDecoratorTest.java b/core/client/src/test/java/com/thousandeyes/sdk/RateLimitDecoratorTest.java
@@ -26,6 +26,7 @@
 import static org.mockito.Mockito.when;
 
 import java.time.Instant;
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 
@@ -57,7 +58,7 @@ private static String getTimeInSeconds(Instant instant) {
 
     @Test
     void shouldNotAwaitOtherStatusCode() throws ApiException {
-        when(client.send(any(), eq(String.class))).thenReturn(okResponse);
+        when(client.<String>send(any(), eq(String.class))).thenReturn(okResponse);
         var response = rlClient.send(mock(ApiRequest.class), String.class);
         assertEquals(response, okResponse);
     }
@@ -80,12 +81,12 @@ void shouldThrowIfApiExceptionHasNoHeaders() throws ApiException {
     @ValueSource(strings = { "x-organization-rate-limit-reset", "x-instant-test-rate-limit-reset" })
     void shouldRetryProperRateLimitApiException(String header) throws ApiException {
         var resetTime = getTimeInSeconds(Instant.now().plusSeconds(2));
-        var headers = Map.of(header, List.of(resetTime));
+        Map<String, Collection<String>> headers = Map.of(header, List.of(resetTime));
 
         var exception = new ApiException(TOO_MANY_REQUESTS, headers, null);
 
-        when(client.send(any(), eq(String.class))).thenThrow(exception)
-                                                  .thenReturn(okResponse);
+        when(client.<String>send(any(), eq(String.class))).thenThrow(exception)
+                                                          .thenReturn(okResponse);
 
         var response = rlClient.send(mock(ApiRequest.class), String.class);
         assertEquals(response, okResponse);