fix(java): waitForApiKey consistency

Author: Fluf22

scripts/cts/testServer/waitForApiKey.ts

@@ -25,7 +25,11 @@ function addRoutes(app: Express): void {
           maxHitsPerQuery: 20,
           createdAt: 1720094400,
         });
+
+        retryCount.add = -1;
       } else {
+        // eslint-disable-next-line no-console
+        console.error(`Invalid retry count: ${retryCount.add}`);
         res.status(500).json({ message: `Internal Server Error` });
       }
 
@@ -51,7 +55,11 @@ function addRoutes(app: Express): void {
           maxHitsPerQuery: 20,
           createdAt: 1720094400,
         });
+
+        retryCount.update = -1;
       } else {
+        // eslint-disable-next-line no-console
+        console.error(`Invalid retry count: ${retryCount.update}`);
         res.status(500).json({ message: `Internal Server Error` });
       }
 
@@ -69,12 +77,18 @@ function addRoutes(app: Express): void {
         });
       } else if (retryCount.delete === 3) {
         res.status(404).json({ message: `API key doesn't exist` });
+
+        retryCount.delete = -1;
       } else {
+        // eslint-disable-next-line no-console
+        console.error(`Invalid retry count: ${retryCount.delete}`);
         res.status(500).json({ message: `Internal Server Error` });
       }
 
       retryCount.delete += 1;
     } else {
+      // eslint-disable-next-line no-console
+      console.error(`Invalid API key ${req.params.key}`);
       res.status(500).json({ message: `Internal Server Error` });
     }
   });

templates/java/api_helpers.mustache

@@ -112,8 +112,8 @@ this.waitForAppTask(taskID, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIM
   * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
   */
 public GetApiKeyResponse waitForApiKey(
-  ApiKeyOperation operation,
   String key,
+  ApiKeyOperation operation,
   ApiKey apiKey,
   int maxRetries,
   IntUnaryOperator timeout,
@@ -146,28 +146,26 @@ public GetApiKeyResponse waitForApiKey(
     );
   }
 
-  // bypass lambda restriction to modify final object
-  final GetApiKeyResponse[] addedKey = new GetApiKeyResponse[] { null };
-
-  // check the status of the getApiKey method
-  TaskUtils.retryUntil(
+  return TaskUtils.retryUntil(
     () -> {
       try {
-        addedKey[0] = this.getApiKey(key, requestOptions);
-        // magic number to signify we found the key
-        return -2;
+        return this.getApiKey(key, requestOptions);
       } catch (AlgoliaApiException e) {
-        return e.getStatusCode();
+        if (e.getStatusCode() == 404) {
+          return null;
+        }
+
+        throw e;
       }
     },
-    (Integer status) -> {
+    (GetApiKeyResponse response) -> {
       switch (operation) {
         case ADD:
-          // stop either when the key is created or when we don't receive 404
-          return status == -2 || status != 404;
+          // stop when we don't receive 404 meaning the key is created
+          return response != null;
         case DELETE:
           // stop when the key is not found
-          return status == 404;
+          return response == null;
         default:
           // continue
           return false;
@@ -176,84 +174,82 @@ public GetApiKeyResponse waitForApiKey(
     maxRetries,
     timeout
   );
-
-  return addedKey[0];
 }
 
 /**
   * Helper: Wait for an API key to be added or deleted based on a given `operation`.
   *
-  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   * @param key The `key` that has been added or deleted.
+  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   * @param maxRetries The maximum number of retry. 50 by default. (optional)
   * @param timeout  The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)
   * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
   */
-public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions) {
-  return this.waitForApiKey(operation, key, null, maxRetries, timeout, requestOptions);
+public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions) {
+  return this.waitForApiKey(key, operation, null, maxRetries, timeout, requestOptions);
 }
 /**
   * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
   *
-  * @param operation The `operation` that was done on a `key`.
   * @param key The `key` that has been added, deleted or updated.
+  * @param operation The `operation` that was done on a `key`.
   * @param apiKey Necessary to know if an `update` operation has been processed, compare fields of the response with it.
   * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
   */
-public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, RequestOptions requestOptions) {
-  return this.waitForApiKey(operation, key, apiKey, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, requestOptions);
+public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation, ApiKey apiKey, RequestOptions requestOptions) {
+  return this.waitForApiKey(key, operation, apiKey, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, requestOptions);
 }
 /**
   * Helper: Wait for an API key to be added or deleted based on a given `operation`.
   *
-  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   * @param key The `key` that has been added or deleted.
+  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
   */
-public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, RequestOptions requestOptions) {
-  return this.waitForApiKey(operation, key, null, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, requestOptions);
+public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation, RequestOptions requestOptions) {
+  return this.waitForApiKey(key, operation, null, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, requestOptions);
 }
 /**
   * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
   *
-  * @param operation The `operation` that was done on a `key`.
   * @param key The `key` that has been added, deleted or updated.
+  * @param operation The `operation` that was done on a `key`.
   * @param apiKey Necessary to know if an `update` operation has been processed, compare fields of the response with it.
   * @param maxRetries The maximum number of retry. 50 by default. (optional)
   * @param timeout  The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)
   */
-public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout) {
-  return this.waitForApiKey(operation, key, apiKey, maxRetries, timeout, null);
+public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout) {
+  return this.waitForApiKey(key, operation, apiKey, maxRetries, timeout, null);
 }
 /**
   * Helper: Wait for an API key to be added or deleted based on a given `operation`.
   *
-  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   * @param key The `key` that has been added or deleted.
+  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   * @param maxRetries The maximum number of retry. 50 by default. (optional)
   * @param timeout  The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)
   */
-public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout) {
-  return this.waitForApiKey(operation, key, null, maxRetries, timeout, null);
+public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation, int maxRetries, IntUnaryOperator timeout) {
+  return this.waitForApiKey(key, operation, null, maxRetries, timeout, null);
 }
 /**
   * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
   *
-  * @param operation The `operation` that was done on a `key`.
   * @param key The `key` that has been added, deleted or updated.
+  * @param operation The `operation` that was done on a `key`.
   * @param apiKey Necessary to know if an `update` operation has been processed, compare fields of the response with it.
   */
-public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey) {
-  return this.waitForApiKey(operation, key, apiKey, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, null);
+public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation, ApiKey apiKey) {
+  return this.waitForApiKey(key, operation, apiKey, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, null);
 }
 /**
   * Helper: Wait for an API key to be added or deleted based on a given `operation`.
   *
-  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   * @param key The `key` that has been added or deleted.
+  * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
   */
-public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key) {
-  return this.waitForApiKey(operation, key, null, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, null);
+public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation) {
+  return this.waitForApiKey(key, operation, null, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, null);
 }
 
 /**

templates/java/tests/client/suite.mustache

@@ -16,6 +16,7 @@ import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInstance;
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.json.JsonMapper;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -29,7 +30,11 @@ class {{client}}ClientTests {
     
   @BeforeAll
   void init() {
-    this.json = JsonMapper.builder().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false).build();
+    this.json = JsonMapper.
+      builder().
+      configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false).
+      serializationInclusion(JsonInclude.Include.NON_NULL).
+      build();
   }
 
   {{client}} createClient() {
@@ -82,7 +87,12 @@ class {{client}}ClientTests {
             assertDoesNotThrow(() -> JSONAssert.assertEquals("{{#lambda.escapeQuotes}}{{{match.parameters}}}{{/lambda.escapeQuotes}}", json.writeValueAsString(res), JSONCompareMode.STRICT));
             {{/matchIsJSON}}
             {{^matchIsJSON}}
-            assertEquals("{{{match}}}", res);
+              {{#matchIsNull}}
+                assertEquals(null, res);
+              {{/matchIsNull}}
+              {{^matchIsNull}}
+                assertEquals("{{{match}}}", res);
+              {{/matchIsNull}}
             {{/matchIsJSON}}
           {{/testResponse}}
         {{/match}}

tests/output/java/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists