feat(cts): add requestOptions tests

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts

@@ -257,13 +257,13 @@ export function createTransporter({
       cacheable: baseRequestOptions?.cacheable,
       timeout: baseRequestOptions?.timeout,
       queryParameters: {
-        ...baseRequestOptions?.queryParameters,
         ...methodOptions.queryParameters,
+        ...baseRequestOptions?.queryParameters,
       },
       headers: {
         Accept: 'application/json',
-        ...baseRequestOptions?.headers,
         ...methodOptions.headers,
+        ...baseRequestOptions?.headers,
       },
     };
 

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/helpers.ts

@@ -1,9 +1,9 @@
 import type {
   Headers,
   Host,
+  QueryParameters,
   Request,
   RequestOptions,
-  QueryParameters,
   Response,
   StackFrame,
 } from '../types';

clients/algoliasearch-client-php/lib/ObjectSerializer.php

@@ -402,12 +402,12 @@ public static function deserialize($data, $class, $httpHeaders = null)
         // If a discriminator is defined and points to a valid subclass, use it.
         $discriminator = $class::DISCRIMINATOR;
         if (
-                !empty($discriminator) &&
-                isset($data->{$discriminator}) &&
-                is_string($data->{$discriminator})
-            ) {
+            !empty($discriminator) &&
+            isset($data->{$discriminator}) &&
+            is_string($data->{$discriminator})
+        ) {
             $subclass =
-                    '\Algolia\AlgoliaSearch\Model\\' . $data->{$discriminator};
+                '\Algolia\AlgoliaSearch\Model\\' . $data->{$discriminator};
             if (is_subclass_of($subclass, $class)) {
                 $class = $subclass;
             }
@@ -419,15 +419,14 @@ public static function deserialize($data, $class, $httpHeaders = null)
             $propertySetter = $instance::setters()[$property];
 
             if (
-                    !isset($propertySetter) ||
-                    !isset($data->{$instance::attributeMap()[$property]})
-                ) {
+                !isset($propertySetter) ||
+                !isset($data->{$instance::attributeMap()[$property]})
+            ) {
                 continue;
             }
 
             if (isset($data->{$instance::attributeMap()[$property]})) {
-                $propertyValue =
-                        $data->{$instance::attributeMap()[$property]};
+                $propertyValue = $data->{$instance::attributeMap()[$property]};
                 $instance->$propertySetter(
                     self::deserialize($propertyValue, $type, null)
                 );

clients/algoliasearch-client-php/lib/RequestOptions/RequestOptionsFactory.php

@@ -63,39 +63,19 @@ private function normalize($options)
         ];
 
         foreach ($options as $optionName => $value) {
-            if (is_array($value)) {
-                if ($optionName === 'headers') {
-                    $headersToLowerCase = [];
+            if (is_array($value) && $optionName === 'headers') {
+                $headersToLowerCase = [];
 
-                    foreach ($value as $key => $v) {
-                        $headersToLowerCase[mb_strtolower($key)] = $v;
-                    }
-
-                    $normalized[$optionName] = $this->format(
-                        $headersToLowerCase
-                    );
-                } else {
-                    $normalized[$optionName] = $this->format(
-                        $value,
-                        $optionName === 'queryParameters'
-                    );
+                foreach ($value as $key => $v) {
+                    $headersToLowerCase[mb_strtolower($key)] = $v;
                 }
+
+                $normalized[$optionName] = $headersToLowerCase;
             } else {
                 $normalized[$optionName] = $value;
             }
         }
 
         return $normalized;
     }
-
-    private function format($options, $isQueryParameters = false)
-    {
-        foreach ($options as $name => $value) {
-            if (is_array($value) && $isQueryParameters) {
-                $options[$name] = implode(',', $value);
-            }
-        }
-
-        return $options;
-    }
 }

clients/algoliasearch-client-php/lib/Support/Helpers.php

@@ -22,7 +22,18 @@ public static function buildQuery(array $args)
 
         $args = array_map(function ($value) {
             if (is_array($value)) {
-                return json_encode($value);
+                // PHP converts `true,false` in arrays to `1,`, so we create strings instead
+                // to avoid sending wrong values
+                $values = array_map(function ($v) {
+                    if (is_bool($v)) {
+                        return $v ? 'true' : 'false';
+                    }
+
+                    return $v;
+                }, $value);
+
+                // We then return the array as a string comma separated
+                return implode(',', $values);
             } elseif (is_bool($value)) {
                 return $value ? 'true' : 'false';
             }

generators/src/main/java/com/algolia/codegen/cts/AlgoliaCtsGenerator.java

@@ -194,6 +194,7 @@ public Map<String, Object> postProcessSupportingFileData(
       if (e.isSkipable()) {
         System.exit(0);
       }
+      e.printStackTrace();
       System.exit(1);
     } catch (Exception e) {
       e.printStackTrace();

generators/src/main/java/com/algolia/codegen/cts/CTSException.java

@@ -8,6 +8,10 @@ public CTSException(String message) {
     super(message);
   }
 
+  public CTSException(String message, Throwable cause) {
+    super(message, cause);
+  }
+
   public CTSException(String message, boolean skipable) {
     this(message);
     this.skipable = skipable;

generators/src/main/java/com/algolia/codegen/cts/ParametersWithDataType.java

@@ -39,9 +39,50 @@ public Map<String, Object> buildJSONForRequest(
     test.put("testName", req.testName == null ? operationId : req.testName);
     test.put("testIndex", testIndex);
     test.put("request", req.request);
-
     test.put("hasParameters", req.parameters.size() != 0);
 
+    if (req.requestOptions != null) {
+      test.put("hasRequestOptions", true);
+      test.put(
+        "requestOptions",
+        Json.mapper().writeValueAsString(req.requestOptions)
+      );
+      Map<String, Object> requestOptions = new HashMap<>();
+
+      if (req.requestOptions.queryParameters != null) {
+        CodegenParameter objSpec = new CodegenParameter();
+        objSpec.dataType =
+          inferDataType(req.requestOptions.queryParameters, objSpec, null);
+        requestOptions.put(
+          "queryParameters",
+          traverseParams(
+            "queryParameters",
+            req.requestOptions.queryParameters,
+            objSpec,
+            "",
+            0
+          )
+        );
+      }
+
+      if (req.requestOptions.headers != null) {
+        List<Map<String, String>> headers = new ArrayList<Map<String, String>>();
+
+        for (Entry<String, String> entry : req.requestOptions.headers.entrySet()) {
+          Map<String, String> parameter = new HashMap<>();
+
+          parameter.put("key", entry.getKey());
+          parameter.put("value", entry.getValue());
+
+          headers.add(parameter);
+        }
+
+        requestOptions.put("headers", headers);
+      }
+
+      test.put("requestOptionsWithDataType", requestOptions);
+    }
+
     if (req.parameters.size() == 0) {
       return test;
     }
@@ -479,6 +520,21 @@ private String inferDataType(
         if (spec != null) spec.setIsBoolean(true);
         if (output != null) output.put("isBoolean", true);
         return "Boolean";
+      case "ArrayList":
+        if (spec != null) {
+          spec.setIsArray(true);
+          // This is just to find the correct path in `handlePrimitive`,
+          // but it's not always the real type
+          CodegenProperty baseItems = new CodegenProperty();
+          baseItems.dataType = "String";
+          spec.setItems(baseItems);
+        }
+        if (output != null) output.put("isArray", true);
+        return "List";
+      case "LinkedHashMap":
+        if (spec != null) spec.baseType = "Object";
+        if (output != null) output.put("isFreeFormObject", true);
+        return "Object";
       default:
         throw new CTSException(
           "Unknown type: " + param.getClass().getSimpleName()

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

@@ -14,6 +14,7 @@ public class Request {
   public String testName;
 
   public Map<String, Object> parameters;
+  public RequestOptions requestOptions;
   public RequestProp request;
 
   @Override
@@ -22,12 +23,29 @@ public String toString() {
     sb.append("class Request {\n");
     sb.append("    testName: ").append(testName).append("\n");
     sb.append("    parameters: ").append(parameters).append("\n");
+    sb.append("    requestOptions: ").append(requestOptions).append("\n");
     sb.append("    request: ").append(request).append("\n");
     sb.append("}");
     return sb.toString();
   }
 }
 
+class RequestOptions {
+
+  public Map<String, Object> queryParameters;
+  public Map<String, String> headers;
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("class RequestOptions {\n");
+    sb.append("    queryParameters: ").append(queryParameters).append("\n");
+    sb.append("    headers: ").append(headers).append("\n");
+    sb.append("}");
+    return sb.toString();
+  }
+}
+
 class RequestProp {
 
   public String path;