fix(clients): valid JSON on empty body, assert empty body on DELETE requests

Author: shortcuts

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/ApiClient.java

@@ -244,7 +244,8 @@ public RequestBody serialize(Object obj) throws AlgoliaRuntimeException {
         throw new AlgoliaRuntimeException(e);
       }
     } else {
-      content = null;
+      // An empty body is defaulted to "{}" to match an empty JSON object
+      content = "{}";
     }
 
     return RequestBody.create(content, MediaType.parse(this.contentType));
@@ -343,16 +344,10 @@ public Request buildRequest(
     processHeaderParams(headerParams, hasRequestOptions ? requestOptions.getExtraHeaders() : null, reqBuilder);
 
     RequestBody reqBody;
-    if (!HttpMethod.permitsRequestBody(method)) {
+    // We rely on `permitsRequestBody` to tell us if we should provide a body, but
+    // we also set is for DELETE methods
+    if (!HttpMethod.permitsRequestBody(method) || (method.equals("DELETE") && body == null)) {
       reqBody = null;
-    } else if (body == null) {
-      if ("DELETE".equals(method)) {
-        // allow calling DELETE without sending a request body
-        reqBody = null;
-      } else {
-        // use an empty request body (for POST, PUT and PATCH)
-        reqBody = RequestBody.create("", MediaType.parse(this.contentType));
-      }
     } else {
       reqBody = serialize(body);
     }

clients/algoliasearch-client-php/lib/RetryStrategy/ApiWrapper.php

@@ -277,10 +277,10 @@ private function createRequest(
         $protocolVersion = '1.1'
     ) {
         if (is_array($body)) {
-            // Send an empty body instead of "[]" in case there are
-            // no content/params to send
-            if (empty($body)) {
-                $body = '';
+            // `DELETE` methods does not have a body, but for other methods it needs
+            // to be a valid JSON object
+            if ($method != 'DELETE' && empty($body)) {
+                $body = '{}';
             } else {
                 $body = \json_encode($body, $this->jsonOptions);
                 if (JSON_ERROR_NONE !== json_last_error()) {

config/generation.config.js

@@ -27,7 +27,7 @@ module.exports = {
     '!clients/algoliasearch-client-javascript/packages/algoliasearch/jest.config.ts',
 
     // PHP
-    '!clients/algoliasearch-client-php/*',
+    '!clients/algoliasearch-client-php/**',
     'clients/algoliasearch-client-php/lib/Api/*',
     'clients/algoliasearch-client-php/lib/Model/**',
     'clients/algoliasearch-client-php/lib/Configuration/*',

generators/src/main/java/com/algolia/codegen/cts/tests/Request.java

@@ -52,7 +52,7 @@ class RequestProp {
   public String method;
 
   @JsonDeserialize(using = RawDeserializer.class)
-  public String body;
+  public String body = "{}";
 
   @JsonDeserialize(using = RawDeserializer.class)
   public String queryParameters;

generators/src/main/java/com/algolia/codegen/cts/tests/TestsRequest.java

@@ -60,6 +60,12 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
         test.put("method", operationId);
         test.put("testName", req.testName == null ? operationId : req.testName);
         test.put("testIndex", i);
+
+        // `GET` and `DELETE` methods don't have a body
+        if (req.request.method.equals("GET") || req.request.method.equals("DELETE")) {
+          req.request.body = null;
+        }
+
         test.put("request", req.request);
         test.put("hasParameters", req.parameters.size() != 0);
 

templates/java/tests/requests/requests.mustache

@@ -66,12 +66,14 @@ class {{client}}RequestsTests {
 
         assertEquals(req.path, "{{{request.path}}}");
         assertEquals(req.method, "{{{request.method}}}");
-
         {{#request.body}}
         assertDoesNotThrow(() -> {
             JSONAssert.assertEquals("{{#lambda.escapeQuotes}}{{{request.body}}}{{/lambda.escapeQuotes}}", req.body, JSONCompareMode.STRICT);
         });
         {{/request.body}}
+        {{^request.body}}
+        assertEquals(req.body, null);
+        {{/request.body}}
 
         {{#request.queryParameters}}
         try {

templates/php/tests/requests/requests.mustache

@@ -114,9 +114,7 @@ class {{clientPrefix}}Test extends TestCase implements HttpClientInterface
             [
                 "path" => "{{{request.path}}}",
                 "method" => "{{{request.method}}}",
-                {{#request.body}}
-                "body" => json_decode("{{#lambda.escapeQuotes}}{{{request.body}}}{{/lambda.escapeQuotes}}"),
-                {{/request.body}}
+                "body" => {{#request.body}}json_decode("{{#lambda.escapeQuotes}}{{{request.body}}}{{/lambda.escapeQuotes}}"){{/request.body}}{{^request.body}}null{{/request.body}},
                 {{#request.queryParameters}}
                 "queryParameters" => json_decode("{{#lambda.escapeQuotes}}{{{request.queryParameters}}}{{/lambda.escapeQuotes}}", true),
                 {{/request.queryParameters}}