Merge 3aad06f into eafef18

Author: millotp

clients/algoliasearch-client-go/.golangci.yml

@@ -50,6 +50,10 @@ linters:
     presets:
       - comments
       - std-error-handling
+    rules:
+      - path: api_search.go
+        linters:
+          - wrapcheck
 formatters:
   enable:
     - gofmt

clients/algoliasearch-client-go/README.md

@@ -41,42 +41,39 @@ You can now import the Algolia API client in your project and play with it.
 
 
 ```go
-import "github.com/algolia/algoliasearch-client-go/v4/algolia/search"
+import "github.com/algolia/algoliasearch-client-go/v4/algolia/next/search"
 
 client, err := search.NewClient("YOUR_APP_ID", "YOUR_API_KEY")
 
 // Add a new record to your Algolia index
-response, err := client.SaveObject(client.NewApiSaveObjectRequest(
-  "<YOUR_INDEX_NAME>", map[string]any{"objectID": "id", "test": "val"},
-))
+saveResponse, err := client.SaveObject("<YOUR_INDEX_NAME>", map[string]any{"objectID": "id", "test": "val"})
 if err != nil {
   // handle the eventual error
   panic(err)
 }
 
 // use the model directly
-print(response)
+print(saveResponse)
 
 // Poll the task status to know when it has been indexed
-taskResponse, err := searchClient.WaitForTask("<YOUR_INDEX_NAME>", response.TaskID, nil, nil, nil)
+_, err = client.WaitForTask("<YOUR_INDEX_NAME>", saveResponse.TaskID)
 if err != nil {
   panic(err)
 }
 
 // Fetch search results, with typo tolerance
-response, err := client.Search(client.NewApiSearchRequest(
-
-  search.NewEmptySearchMethodParams().SetRequests(
-    []search.SearchQuery{*search.SearchForHitsAsSearchQuery(
-      search.NewEmptySearchForHits().SetIndexName("<YOUR_INDEX_NAME>").SetQuery("<YOUR_QUERY>").SetHitsPerPage(50))}),
-))
+response, err := client.Search([]search.SearchQuery{
+  *search.SearchForHitsAsSearchQuery(search.NewSearchForHits("<YOUR_INDEX_NAME>").SetQuery("<YOUR_QUERY>").SetHitsPerPage(50)),
+}, nil)
 if err != nil {
   // handle the eventual error
   panic(err)
 }
 
 // use the model directly
 print(response)
+
+return 0
 ```
 
 For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/libraries/go/)**.

config/clients.config.json

@@ -88,8 +88,8 @@
     "folder": "clients/algoliasearch-client-go",
     "gitRepoId": "algoliasearch-client-go",
     "packageVersion": "4.28.1",
-    "modelFolder": "algolia",
-    "apiFolder": "algolia",
+    "modelFolder": "algolia/next",
+    "apiFolder": "algolia/next",
     "dockerImage": "apic_base",
     "tests": {
       "extension": "_test.go",

generators/src/main/java/com/algolia/codegen/AlgoliaGoGenerator.java

@@ -1,8 +1,10 @@
 package com.algolia.codegen;
 
+import com.algolia.codegen.cts.lambda.ScreamingSnakeCaseLambda;
 import com.algolia.codegen.exceptions.*;
-import com.algolia.codegen.lambda.ScreamingSnakeCaseLambda;
 import com.algolia.codegen.utils.*;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Iterables;
 import com.samskivert.mustache.Mustache;
@@ -11,6 +13,7 @@
 import io.swagger.v3.oas.models.servers.Server;
 import java.io.File;
 import java.util.*;
+import java.util.stream.Collectors;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.languages.GoClientCodegen;
 import org.openapitools.codegen.model.ModelMap;
@@ -19,6 +22,9 @@
 
 public class AlgoliaGoGenerator extends GoClientCodegen {
 
+  // This is used for the CTS generation
+  private static final AlgoliaGoGenerator INSTANCE = new AlgoliaGoGenerator();
+
   @Override
   public String getName() {
     return "algolia-go";
@@ -29,10 +35,9 @@ public void processOpts() {
     String client = (String) additionalProperties.get("client");
 
     additionalProperties.put("packageName", client.equals("query-suggestions") ? "suggestions" : Helpers.camelize(client));
-    additionalProperties.put("enumClassPrefix", true);
     additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize(client)) + "Client", true);
 
-    String outputFolder = "algolia" + File.separator + client;
+    String outputFolder = "algolia/next/" + client;
     setOutputDir(getOutputDir() + File.separator + outputFolder);
 
     super.processOpts();
@@ -44,6 +49,7 @@ public void processOpts() {
     typeMapping.put("AnyType", "any");
 
     modelNameMapping.put("range", "modelRange");
+    typeMapping.put("integer", "int");
 
     apiTestTemplateFiles.clear();
     modelTestTemplateFiles.clear();
@@ -54,7 +60,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("configuration.mustache", "", "configuration.go"));
     supportingFiles.add(new SupportingFile("client.mustache", "", "client.go"));
 
-    Helpers.addCommonSupportingFiles(supportingFiles, "../../");
+    Helpers.addCommonSupportingFiles(supportingFiles, "../../../");
 
     try {
       additionalProperties.put("packageVersion", Helpers.getClientConfigField("go", "packageVersion"));
@@ -78,6 +84,13 @@ public void processOpenAPI(OpenAPI openAPI) {
     super.processOpenAPI(openAPI);
     Helpers.generateServers(super.fromServers(openAPI.getServers()), additionalProperties);
     Timeouts.enrichBundle(openAPI, additionalProperties);
+    additionalProperties.put(
+      "appDescription",
+      Arrays.stream(openAPI.getInfo().getDescription().split("\n"))
+        .map(line -> "// " + line)
+        .collect(Collectors.joining("\n"))
+        .trim()
+    );
   }
 
   @Override
@@ -118,7 +131,8 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
       String modelName = entry.getKey();
       CodegenModel model = entry.getValue().getModels().get(0).getModel();
 
-      // for some reason the property additionalPropertiesIsAnyType is not propagated to the
+      // for some reason the property additionalPropertiesIsAnyType is not propagated
+      // to the
       // property
       for (CodegenProperty prop : model.getVars()) {
         ModelsMap propertyModel = models.get(prop.datatypeWithEnum);
@@ -140,9 +154,105 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
   @Override
   public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> models) {
     OperationsMap operations = super.postProcessOperationsWithModels(objs, models);
+
+    // Flatten body params to remove the wrapping object
+    for (CodegenOperation ope : operations.getOperations().getOperation()) {
+      // clean up the description
+      String[] lines = ope.unescapedNotes.split("\n");
+      ope.notes = (lines[0] +
+        "\n" +
+        Arrays.stream(lines)
+          .skip(1)
+          .map(line -> "// " + line)
+          .collect(Collectors.joining("\n"))).trim();
+
+      // enrich the params
+      for (CodegenParameter param : ope.optionalParams) {
+        param.nameInPascalCase = Helpers.capitalize(param.baseName);
+      }
+
+      CodegenParameter bodyParam = ope.bodyParam;
+      if (bodyParam != null) {
+        flattenBody(ope);
+      }
+
+      // If the optional param struct only has 1 param, we can remove the wrapper
+      if (ope.optionalParams.size() == 1) {
+        CodegenParameter param = ope.optionalParams.get(0);
+
+        // move it to required, it's easier to handle im mustache
+        ope.optionalParams.clear();
+
+        ope.requiredParams.add(param);
+      }
+    }
+
     ModelPruner.removeOrphanModelFiles(this, operations, models);
     Helpers.removeHelpers(operations);
     GenericPropagator.propagateGenericsToOperations(operations, models);
     return operations;
   }
+
+  private void flattenBody(CodegenOperation ope) {
+    CodegenParameter bodyParam = ope.bodyParam;
+    bodyParam.nameInPascalCase = Helpers.capitalize(bodyParam.baseName);
+    if (!bodyParam.isModel) {
+      return;
+    }
+
+    if (!canFlattenBody(ope)) {
+      System.out.println(
+        "Operation " + ope.operationId + " has body param " + bodyParam.paramName + " in colision with a parameter, skipping flattening"
+      );
+      return;
+    }
+
+    bodyParam.vendorExtensions.put("x-flat-body", bodyParam.getVars().size() > 0);
+
+    if (bodyParam.getVars().size() > 0) {
+      ope.allParams.removeIf(param -> param.isBodyParam);
+      ope.requiredParams.removeIf(param -> param.isBodyParam);
+      ope.optionalParams.removeIf(param -> param.isBodyParam);
+    }
+
+    for (CodegenProperty prop : bodyParam.getVars()) {
+      prop.nameInLowerCase = toParamName(prop.baseName);
+
+      CodegenParameter param = new ObjectMapper()
+        .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
+        .convertValue(prop, CodegenParameter.class);
+      param.nameInPascalCase = Helpers.capitalize(prop.baseName);
+      param.paramName = toParamName(prop.baseName);
+
+      if (prop.required) {
+        ope.requiredParams.add(param);
+      } else {
+        ope.optionalParams.add(param);
+      }
+      ope.allParams.add(param);
+    }
+  }
+
+  public static boolean canFlattenBody(CodegenOperation ope) {
+    if (ope.bodyParam == null || !ope.bodyParam.isModel) {
+      return false;
+    }
+
+    if (ope.allParams.size() == 1) {
+      return true;
+    }
+
+    for (CodegenProperty prop : ope.bodyParam.getVars()) {
+      for (CodegenParameter param : ope.allParams) {
+        if (param.paramName.equals(prop.baseName)) {
+          return false;
+        }
+      }
+    }
+    return true;
+  }
+
+  public static String toEnum(String value) {
+    return INSTANCE.toEnumVarName(value, "String");
+  }
 }

generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java

@@ -236,20 +236,13 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
         continue;
       }
 
-      boolean hasBodyParams = !ope.bodyParams.isEmpty();
+      boolean hasBodyParams = ope.bodyParam != null;
       boolean hasHeaderParams = !ope.headerParams.isEmpty();
       boolean hasQueryParams = !ope.queryParams.isEmpty();
       boolean hasPathParams = !ope.pathParams.isEmpty();
 
       // If there is nothing but body params, we just check if it's a single param
-      if (
-        hasBodyParams &&
-        !hasHeaderParams &&
-        !hasQueryParams &&
-        !hasPathParams &&
-        ope.bodyParams.size() == 1 &&
-        !ope.bodyParams.get(0).isArray
-      ) {
+      if (hasBodyParams && !hasHeaderParams && !hasQueryParams && !hasPathParams && !ope.bodyParam.isArray) {
         // At this point the single parameter is already an object, to avoid double wrapping we skip
         // it
         ope.vendorExtensions.put("x-is-single-body-param", true);

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

@@ -102,6 +102,7 @@ protected Builder<String, Lambda> addMustacheLambdas() {
     lambdas.put("escapeSlash", new EscapeSlashLambda());
     lambdas.put("escapeJSON", new EscapeJSONLambda());
     lambdas.put("replaceBacktick", new ReplaceBacktickLambda());
+    lambdas.put("screamingSnakeCase", new ScreamingSnakeCaseLambda());
 
     return lambdas;
   }

generators/src/main/java/com/algolia/codegen/cts/lambda/DynamicSnippetLambda.java

@@ -32,6 +32,7 @@ public class DynamicSnippetLambda implements Mustache.Lambda {
   private final Map<String, CodegenOperation> operations;
 
   private final Map<String, Snippet> snippets;
+  private final String language;
 
   public DynamicSnippetLambda(
     DefaultCodegen generator,
@@ -41,6 +42,7 @@ public DynamicSnippetLambda(
     String client
   ) {
     this.operations = operations;
+    this.language = language;
     this.paramsType = new ParametersWithDataType(models, language, client, true);
 
     JsonNode snippetsFile = Helpers.readJsonFile("tests/CTS/guides/" + client + ".json");
@@ -74,7 +76,7 @@ public void execute(Template.Fragment fragment, Writer writer) throws IOExceptio
 
     // set the method attributes
     Map<String, Object> context = (Map<String, Object>) fragment.context();
-    snippet.addMethodCall(context, paramsType, operation);
+    snippet.addMethodCall(language, context, paramsType, operation);
 
     writer.write(adaptor.compileTemplate(executor, context, "tests/method.mustache"));
   }

generators/src/main/java/com/algolia/codegen/lambda/ScreamingSnakeCaseLambda.java renamed to generators/src/main/java/com/algolia/codegen/cts/lambda/ScreamingSnakeCaseLambda.java

@@ -1,4 +1,4 @@
-package com.algolia.codegen.lambda;
+package com.algolia.codegen.cts.lambda;
 
 import com.algolia.codegen.utils.Helpers;
 import com.samskivert.mustache.Mustache;

generators/src/main/java/com/algolia/codegen/cts/manager/GoCTSManager.java

@@ -1,7 +1,9 @@
 package com.algolia.codegen.cts.manager;
 
+import com.algolia.codegen.AlgoliaGoGenerator;
 import com.algolia.codegen.exceptions.GeneratorException;
 import com.algolia.codegen.utils.*;
+import com.samskivert.mustache.Mustache.Lambda;
 import java.util.*;
 import org.openapitools.codegen.SupportingFile;
 
@@ -40,4 +42,9 @@ public void addSnippetsSupportingFiles(List<SupportingFile> supportingFiles, Str
     supportingFiles.add(new SupportingFile("snippets/.golangci.mustache", output + "/go/.golangci.yml"));
     supportingFiles.add(new SupportingFile("snippets/go.mod.mustache", output + "/go/go.mod"));
   }
+
+  @Override
+  public void addMustacheLambdas(Map<String, Lambda> lambdas) {
+    lambdas.put("toEnum", (fragment, writer) -> writer.write(AlgoliaGoGenerator.toEnum(fragment.execute())));
+  }
 }

generators/src/main/java/com/algolia/codegen/cts/manager/JavaCTSManager.java

@@ -52,6 +52,6 @@ public void addDataToBundle(Map<String, Object> bundle) throws GeneratorExceptio
 
   @Override
   public void addMustacheLambdas(Map<String, Lambda> lambdas) {
-    lambdas.put("javaEnum", (fragment, writer) -> writer.write(AlgoliaJavaGenerator.toEnum(fragment.execute())));
+    lambdas.put("toEnum", (fragment, writer) -> writer.write(AlgoliaJavaGenerator.toEnum(fragment.execute())));
   }
 }