feat(cts): generate tests for helpers

Author: millotp

clients/algoliasearch-client-csharp/algoliasearch/Models/Common/SecuredApiKeyRestrictionHelper.cs

@@ -9,7 +9,7 @@ namespace Algolia.Search.Models.Search;
 /// <summary>
 /// Secured Api Key restrictions
 /// </summary>
-public partial class SecuredAPIKeyRestrictions
+public partial class SecuredApiKeyRestrictions
 {
 
   /// <summary>

clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

@@ -273,20 +273,20 @@ public string GenerateSecuredApiKey(string parentApiKey, SecuredAPIKeyRestrictio
 
 
   /// <summary>
-  ///  Get the remaining validity of a key generated by `GenerateSecuredApiKeys`.
+  ///  Get the remaining validity of a key generated by `GenerateSecuredApiKey`.
   /// </summary>
   /// <param name="securedAPIKey">The secured API Key</param>
   /// <returns></returns>
   /// <exception cref="ArgumentNullException"></exception>
   /// <exception cref="AlgoliaException"></exception>
   public TimeSpan GetSecuredApiKeyRemainingValidity(string securedAPIKey)
   {
-    if (string.IsNullOrWhiteSpace(securedAPIKey))
+    if (string.IsNullOrWhiteSpace(securedApiKey))
     {
-      throw new ArgumentNullException(nameof(securedAPIKey));
+      throw new ArgumentNullException(nameof(securedApiKey));
     }
 
-    var decodedKey = Encoding.UTF8.GetString(Convert.FromBase64String(securedAPIKey));
+    var decodedKey = Encoding.UTF8.GetString(Convert.FromBase64String(securedApiKey));
 
     var regex = new Regex(@"validUntil=\d+");
     var matches = regex.Matches(decodedKey);

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

@@ -42,16 +42,14 @@ export function serializeUrl(
 }
 
 export function serializeQueryParameters(parameters: QueryParameters): string {
-  const isObjectOrArray = (value: any): boolean =>
-    Object.prototype.toString.call(value) === '[object Object]' ||
-    Object.prototype.toString.call(value) === '[object Array]';
-
   return Object.keys(parameters)
+    .filter((key) => parameters[key] !== undefined)
+    .sort()
     .map(
       (key) =>
         `${key}=${encodeURIComponent(
-          isObjectOrArray(parameters[key])
-            ? JSON.stringify(parameters[key])
+          Object.prototype.toString.call(parameters[key]) === '[object Array]'
+            ? parameters[key].join(',')
             : parameters[key]
         ).replaceAll('+', '%20')}`
     )

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt

@@ -335,13 +335,13 @@ public suspend fun <T> SearchClient.replaceAllObjects(
 /**
  * Generate a virtual API Key without any call to the server.
  *
- * @param parentAPIKey API key to generate from.
+ * @param parentApiKey API key to generate from.
  * @param restriction Restriction to add the key
  * @throws Exception if an error occurs during the encoding
  */
-public fun SearchClient.generateSecuredApiKey(parentAPIKey: String, restriction: SecuredAPIKeyRestrictions): String {
+public fun SearchClient.generateSecuredApiKey(parentApiKey: String, restriction: SecuredApiKeyRestrictions): String {
   val restrictionString = buildRestrictionString(restriction)
-  val hash = encodeKeySHA256(parentAPIKey, restrictionString)
+  val hash = encodeKeySHA256(parentApiKey, restrictionString)
   return "$hash$restrictionString".encodeBase64()
 }
 
@@ -350,7 +350,7 @@ public fun SearchClient.generateSecuredApiKey(parentAPIKey: String, restriction:
  *
  * @param apiKey The secured API Key to check.
  * @return Duration left before the secured API key expires.
- * @throws IllegalArgumentException if [apiKey] doesn't have a [SecuredAPIKeyRestrictions.validUntil].
+ * @throws IllegalArgumentException if [apiKey] doesn't have a [SecuredApiKeyRestrictions.validUntil].
  */
 public fun securedApiKeyRemainingValidity(apiKey: String): Duration {
   val decoded = apiKey.decodeBase64String()

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/internal/SearchClient.kt

@@ -2,16 +2,16 @@ package com.algolia.client.extensions.internal
 
 import com.algolia.client.api.SearchClient
 import com.algolia.client.model.search.SearchParamsObject
-import com.algolia.client.model.search.SecuredAPIKeyRestrictions
+import com.algolia.client.model.search.SecuredApiKeyRestrictions
 import io.ktor.http.*
 import kotlinx.serialization.json.JsonArray
 import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.json.jsonPrimitive
 
 /**
- * Builds a restriction string based on provided [SecuredAPIKeyRestrictions].
+ * Builds a restriction string based on provided [SecuredApiKeyRestrictions].
  */
-internal fun SearchClient.buildRestrictionString(restriction: SecuredAPIKeyRestrictions): String {
+internal fun SearchClient.buildRestrictionString(restriction: SecuredApiKeyRestrictions): String {
   return Parameters.build {
     restriction.searchParams?.let { searchParams ->
       val json = options.json.encodeToJsonElement(SearchParamsObject.serializer(), searchParams).jsonObject

clients/algoliasearch-client-kotlin/client/src/commonTest/kotlin/com/algolia/client/TestSecureApiKey.kt

@@ -1,7 +1,7 @@
 package com.algolia.client
 
 import com.algolia.client.api.SearchClient
-import com.algolia.client.extensions.SecuredAPIKeyRestrictions
+import com.algolia.client.extensions.SecuredApiKeyRestrictions
 import com.algolia.client.extensions.generateSecuredApiKey
 import com.algolia.client.extensions.securedApiKeyRemainingValidity
 import com.algolia.client.model.search.SearchParamsObject
@@ -14,14 +14,14 @@ class TestSecureApiKey {
 
   @Test
   fun securedApiKey() {
-    val parentAPIKey = "SearchOnlyApiKeyKeptPrivate"
-    val restriction = SecuredAPIKeyRestrictions(
+    val parentApiKey = "SearchOnlyApiKeyKeptPrivate"
+    val restriction = SecuredApiKeyRestrictions(
       query = SearchParamsObject(filters = "_tags:user_42"),
       validUntil = Clock.System.now() + 2.days,
     )
 
     val client = SearchClient("appId", "apiKey")
-    val securedApiKey = client.generateSecuredApiKey(parentAPIKey, restriction)
+    val securedApiKey = client.generateSecuredApiKey(parentApiKey, restriction)
     val validity = securedApiKeyRemainingValidity(securedApiKey)
     assertTrue { validity > 1.days }
   }

clients/algoliasearch-client-python/algoliasearch/http/serializer.py

@@ -1,5 +1,6 @@
 from json import dumps
 from typing import Any, Dict
+from urllib.parse import urlencode
 
 PRIMITIVE_TYPES = (float, bool, bytes, str, int)
 
@@ -12,21 +13,28 @@ class QueryParametersSerializer:
     query_parameters: Dict[str, Any] = {}
 
     def parse(self, value) -> Any:
-        if isinstance(value, dict):
-            return dumps(value)
-        elif isinstance(value, list):
+        if isinstance(value, list):
             return ",".join([self.parse(item) for item in value])
+        elif isinstance(value, dict):
+            return dumps(value)
         elif isinstance(value, bool):
             return "true" if value else "false"
         else:
             return str(value)
 
+    def encoded(self) -> str:
+        return urlencode(dict(sorted(self.query_parameters.items(), key=lambda val: val[0]))).replace("+", "%20")
+
     def __init__(self, query_parameters: Dict[str, Any]) -> None:
         self.query_parameters = {}
         if query_parameters is None:
             return
         for key, value in query_parameters.items():
-            self.query_parameters[key] = self.parse(value)
+            if isinstance(value, dict):
+                for dkey, dvalue in value.items():
+                    self.query_parameters[dkey] = self.parse(dvalue)
+            else:
+                self.query_parameters[key] = self.parse(value)
 
 
 def bodySerializer(obj: Any) -> dict:

clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift

@@ -517,18 +517,18 @@ public extension SearchClient {
     /// - returns: String?
     func generateSecuredApiKey(
         parentApiKey: String,
-        with restriction: SecuredAPIKeyRestrictions = SecuredAPIKeyRestrictions()
+        with restriction: SecuredApiKeyRestrictions = SecuredApiKeyRestrictions()
     ) throws -> String? {
         let queryParams = try restriction.toURLEncodedString()
         let hash = queryParams.hmac256(withKey: parentApiKey)
         return "\(hash)\(queryParams)".data(using: .utf8)?.base64EncodedString()
     }
 
     /// Get the remaining validity of a secured API key
-    /// - parameter securedAPIKey: The secured API key
+    /// - parameter securedApiKey: The secured API key
     /// - returns: TimeInterval?
-    func getSecuredApiKeyRemainingValidity(for securedAPIKey: String) -> TimeInterval? {
-        guard let rawDecodedAPIKey = String(data: Data(base64Encoded: securedAPIKey) ?? Data(), encoding: .utf8),
+    func getSecuredApiKeyRemainingValidity(for securedApiKey: String) -> TimeInterval? {
+        guard let rawDecodedAPIKey = String(data: Data(base64Encoded: securedApiKey) ?? Data(), encoding: .utf8),
               !rawDecodedAPIKey.isEmpty else {
             return nil
         }

clients/algoliasearch-client-swift/Sources/Search/Extra/SecuredApiKeyRestrictionExtension.swift

@@ -3,7 +3,7 @@
 #endif
 import Foundation
 
-public extension SecuredAPIKeyRestrictions {
+public extension SecuredApiKeyRestrictions {
     func toURLEncodedString() throws -> String {
         var queryDictionary: [String: Any] = [:]
 

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

@@ -93,14 +93,18 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
               }
               stepOut.put("stepTemplate", "tests/client/method.mustache");
               stepOut.put("isMethod", true); // TODO: remove once dart and kotlin are converted
+              stepOut.put("isHelper", (boolean) ope.vendorExtensions.getOrDefault("x-helper", false));
+              stepOut.put("hasOperationParams", ope.hasParams);
             }
 
             stepOut.put("object", step.object);
             stepOut.put("path", step.path);
 
-            Map<String, Object> requestOptions = new HashMap<>();
-            paramsType.enhanceParameters(step.requestOptions, requestOptions);
-            stepOut.put("requestOptions", requestOptions);
+            if (step.requestOptions != null) {
+              Map<String, Object> requestOptions = new HashMap<>();
+              paramsType.enhanceParameters(step.requestOptions, requestOptions);
+              stepOut.put("requestOptions", requestOptions);
+            }
 
             if (step.path != null && CUSTOM_METHODS.contains(step.path)) {
               stepOut.put("isCustom", true);
@@ -148,10 +152,11 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
                 stepOut.put("expectedError", step.expected.error.replace(step.path, Helpers.toPascalCase(step.path)));
               }
             } else if (step.expected.match != null) {
-              if (step.expected.match instanceof Map) {
-                Map<String, Object> match = new HashMap<>();
-                paramsType.enhanceParameters((Map<String, Object>) step.expected.match, match);
-                stepOut.put("match", match);
+              Map<String, Object> matchMap = new HashMap<>();
+              if (step.expected.match instanceof Map match) {
+                paramsType.enhanceParameters(match, matchMap);
+                stepOut.put("match", matchMap);
+                stepOut.put("matchIsObject", true);
               } else {
                 stepOut.put("match", step.expected.match);
               }