chore(deps): upgrade openapi-generator to v6 APIC-502 (#685)

millotp · web-flow · commit 1e27a2874f81 · 2022-06-15T14:02:54.000+02:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -101,8 +101,9 @@ module.exports = {
         'no-continue': 0,
         '@typescript-eslint/prefer-enum-initializers': 0,
 
-        '@typescript-eslint/no-unused-vars': 2,
         'unused-imports/no-unused-imports-ts': 2,
+        '@typescript-eslint/no-unused-vars': 2,
+        '@typescript-eslint/consistent-indexed-object-style': 2,
         '@typescript-eslint/member-ordering': [
           'error',
           {
diff --git a/config/openapitools.json b/config/openapitools.json
@@ -1,6 +1,6 @@
 {
   "generator-cli": {
-    "version": "5.4.0",
+    "version": "6.0.0",
     "generators": {
       "javascript-search": {
         "output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-search",
diff --git a/generators/build.gradle b/generators/build.gradle
@@ -12,7 +12,7 @@ repositories {
 }
 
 dependencies {
-    compileOnly 'org.openapitools:openapi-generator:5.4.0'
+    compileOnly 'org.openapitools:openapi-generator:6.0.0'
     compileOnly 'org.yaml:snakeyaml:1.30'
 }
 
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java
@@ -7,6 +7,7 @@
 import java.util.*;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.languages.JavaClientCodegen;
+import org.openapitools.codegen.model.ModelsMap;
 import org.openapitools.codegen.utils.ModelUtils;
 
 @SuppressWarnings("unchecked")
@@ -21,8 +22,6 @@ public String getName() {
   public void processOpts() {
     // generator specific options
     String client = (String) additionalProperties.get("client");
-    setDateLibrary("java8");
-    setLibrary("okhttp-gson");
     setSourceFolder("algoliasearch-core/src/main/java");
     setGroupId("com.algolia");
     setModelPackage("com.algolia.model." + Utils.camelize(client));
@@ -45,23 +44,14 @@ public void processOpts() {
       file.getTemplateFile().equals("ApiClient.mustache") ||
       file.getTemplateFile().equals("ApiCallback.mustache") ||
       file.getTemplateFile().equals("ApiResponse.mustache") ||
+      file.getTemplateFile().equals("AbstractOpenApiSchema.mustache") ||
+      file.getTemplateFile().equals("maven.yml.mustache") ||
       file.getTemplateFile().equals("JSON.mustache") ||
       file.getTemplateFile().equals("ProgressRequestBody.mustache") ||
       file.getTemplateFile().equals("ProgressResponseBody.mustache") ||
       file.getTemplateFile().equals("Pair.mustache")
     );
-  }
-
-  @Override
-  public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List<Server> servers) {
-    return Utils.specifyCustomRequest(super.fromOperation(path, httpMethod, operation, servers));
-  }
-
-  @Override
-  public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> objs, List<Object> allModels) {
-    Map<String, Object> results = super.postProcessOperationsWithModels(objs, allModels);
 
-    String client = (String) additionalProperties.get("client");
     additionalProperties.put("isSearchClient", client.equals("search"));
 
     try {
@@ -72,16 +62,24 @@ public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> o
       e.printStackTrace();
       System.exit(1);
     }
+  }
+
+  @Override
+  protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, Schema schema) {
+    super.addParentContainer(codegenModel, codegenModel.name, schema);
+  }
 
-    return results;
+  @Override
+  public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List<Server> servers) {
+    return Utils.specifyCustomRequest(super.fromOperation(path, httpMethod, operation, servers));
   }
 
   @Override
-  public Map<String, Object> postProcessAllModels(Map<String, Object> objs) {
-    Map<String, Object> models = super.postProcessAllModels(objs);
+  public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs) {
+    Map<String, ModelsMap> models = super.postProcessAllModels(objs);
 
-    for (Object modelContainer : models.values()) {
-      CodegenModel model = ((Map<String, List<Map<String, CodegenModel>>>) modelContainer).get("models").get(0).get("model");
+    for (ModelsMap modelContainer : models.values()) {
+      CodegenModel model = modelContainer.getModels().get(0).getModel();
       if (!model.oneOf.isEmpty()) {
         List<HashMap<String, String>> oneOfList = new ArrayList();
 
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java
@@ -2,14 +2,13 @@
 
 import com.algolia.codegen.exceptions.*;
 import io.swagger.v3.oas.models.Operation;
-import io.swagger.v3.oas.models.media.Schema;
-import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.servers.Server;
 import java.util.List;
-import java.util.Map;
 import org.openapitools.codegen.CodegenOperation;
 import org.openapitools.codegen.SupportingFile;
 import org.openapitools.codegen.languages.TypeScriptNodeClientCodegen;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.OperationsMap;
 
 public class AlgoliaJavaScriptGenerator extends TypeScriptNodeClientCodegen {
 
@@ -30,6 +29,9 @@ public void processOpts() {
     setSupportsES6(true);
     setModelPropertyNaming("original");
     setApiPackage("src");
+
+    languageSpecificPrimitives.add("Record");
+    instantiationTypes.put("map", "Record");
     // clear all supported files to avoid unwanted ones
     supportingFiles.clear();
 
@@ -64,8 +66,8 @@ private void setDefaultGeneratorOptions() {
 
   /** Provides an opportunity to inspect and modify operation data before the code is generated. */
   @Override
-  public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> objs, List<Object> allModels) {
-    Map<String, Object> results = super.postProcessOperationsWithModels(objs, allModels);
+  public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
+    OperationsMap results = super.postProcessOperationsWithModels(objs, allModels);
 
     setDefaultGeneratorOptions();
     try {
@@ -77,7 +79,7 @@ public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> o
       System.exit(1);
     }
 
-    List<CodegenOperation> operations = ((Map<String, List<CodegenOperation>>) results.get("operations")).get("operation");
+    List<CodegenOperation> operations = results.getOperations().getOperation();
 
     // We read operations and detect if we should wrap parameters under an object.
     // We only wrap if there is a mix between body parameters and other parameters.
@@ -139,21 +141,4 @@ public String toApiFilename(String name) {
   public String apiFilename(String templateName, String tag) {
     return super.apiFilename(templateName, toApiFilename(CLIENT));
   }
-
-  @Override
-  protected String getParameterDataType(Parameter parameter, Schema p) {
-    String type = super.getParameterDataType(parameter, p);
-    // openapi generator is wrong, 'object' is not a fit all object, we need 'any'
-    // we use replace because there might be more to this type, like '| undefined'
-    return type.replace("{ [key: string]: object; }", "Record<string, any>");
-  }
-
-  @Override
-  public String toInstantiationType(Schema schema) {
-    String type = super.toInstantiationType(schema);
-
-    // Same as the `getParameterDataType` but for the models, the generator
-    // consider `object` as a fit all which is wrong in TypeScript
-    return type.replace("null<String, object>", "Record<string, any>");
-  }
 }
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java
@@ -4,7 +4,6 @@
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.servers.Server;
 import java.util.List;
-import java.util.Map;
 import org.openapitools.codegen.CodegenOperation;
 import org.openapitools.codegen.SupportingFile;
 import org.openapitools.codegen.languages.PhpClientCodegen;
@@ -31,6 +30,15 @@ public void processOpts() {
     supportingFiles.removeIf(file -> file.getTemplateFile().equals("Configuration.mustache"));
 
     supportingFiles.add(new SupportingFile("Configuration.mustache", "lib/Configuration", "Configuration.php"));
+
+    setDefaultGeneratorOptions(client);
+    try {
+      Utils.generateServer(client, additionalProperties);
+      additionalProperties.put("packageVersion", Utils.getClientConfigField("php", "packageVersion"));
+    } catch (GeneratorException e) {
+      e.printStackTrace();
+      System.exit(1);
+    }
   }
 
   @Override
@@ -47,25 +55,6 @@ public void setDefaultGeneratorOptions(String client) {
     additionalProperties.put("configClassname", Utils.createClientName(client, "php") + "Config");
   }
 
-  /** Provides an opportunity to inspect and modify operation data before the code is generated. */
-  @Override
-  public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> objs, List<Object> allModels) {
-    Map<String, Object> results = super.postProcessOperationsWithModels(objs, allModels);
-
-    String client = (String) additionalProperties.get("client");
-
-    setDefaultGeneratorOptions(client);
-    try {
-      Utils.generateServer(client, additionalProperties);
-      additionalProperties.put("packageVersion", Utils.getClientConfigField("php", "packageVersion"));
-    } catch (GeneratorException e) {
-      e.printStackTrace();
-      System.exit(1);
-    }
-
-    return results;
-  }
-
   public String getComposerPackageName() {
     return "algolia/algoliasearch-client-php";
   }
diff --git a/generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java b/generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java
@@ -11,6 +11,8 @@
 import java.util.Map.Entry;
 import java.util.TreeMap;
 import org.openapitools.codegen.*;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.ModelsMap;
 
 @SuppressWarnings("unchecked")
 public class AlgoliaCTSGenerator extends DefaultCodegen {
@@ -56,12 +58,12 @@ public void processOpts() {
   }
 
   @Override
-  public Map<String, Object> postProcessAllModels(Map<String, Object> objs) {
-    Map<String, Object> mod = super.postProcessAllModels(objs);
-    for (Entry<String, Object> entry : mod.entrySet()) {
-      List<Object> innerModel = ((Map<String, List<Object>>) entry.getValue()).get("models");
+  public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs) {
+    Map<String, ModelsMap> mod = super.postProcessAllModels(objs);
+    for (Entry<String, ModelsMap> entry : mod.entrySet()) {
+      List<ModelMap> innerModel = entry.getValue().getModels();
       if (!innerModel.isEmpty()) {
-        models.put(entry.getKey(), (CodegenModel) ((Map<String, Object>) innerModel.get(0)).get("model"));
+        models.put(entry.getKey(), innerModel.get(0).getModel());
       }
     }
     return mod;
diff --git a/generators/src/main/java/com/algolia/codegen/cts/tests/ParametersWithDataType.java b/generators/src/main/java/com/algolia/codegen/cts/tests/ParametersWithDataType.java
@@ -372,7 +372,7 @@ private void handlePrimitive(Object param, Map<String, Object> testOutput, IJson
       transferPrimitiveData(spec, testOutput);
     } else {
       inferDataType(param, null, testOutput);
-      if (spec instanceof CodegenParameter && ((CodegenParameter) spec).isAnyType) {
+      if (isAnyType(spec)) {
         testOutput.put("isAnyType", true);
       }
     }
@@ -395,6 +395,19 @@ private String getTypeName(IJsonSchemaValidationProperties param) {
     return null;
   }
 
+  private boolean isAnyType(IJsonSchemaValidationProperties param) {
+    if (param instanceof CodegenParameter) {
+      return ((CodegenParameter) param).isAnyType;
+    }
+    if (param instanceof CodegenProperty) {
+      return ((CodegenProperty) param).isAnyType;
+    }
+    if (param instanceof CodegenResponse) {
+      return ((CodegenResponse) param).isAnyType;
+    }
+    return false;
+  }
+
   private boolean isEnum(IJsonSchemaValidationProperties param) {
     if (param instanceof CodegenParameter) {
       return ((CodegenParameter) param).isEnum;
diff --git a/specs/analytics/common/schemas/getTopHits.yml b/specs/analytics/common/schemas/getTopHits.yml
@@ -9,6 +9,7 @@ topHitsResponse:
       description: A list of top hits with their count.
       items:
         type: object
+        title: topHit
         additionalProperties: false
         required:
           - hit
@@ -30,6 +31,7 @@ topHitsResponseWithAnalytics:
       description: A list of top hits with their count and analytics.
       items:
         type: object
+        title: topHitWithAnalytics
         additionalProperties: false
         required:
           - hit
diff --git a/specs/analytics/common/schemas/getTopSearches.yml b/specs/analytics/common/schemas/getTopSearches.yml
@@ -9,6 +9,7 @@ topSearchesResponse:
       description: A list of top searches with their count.
       items:
         type: object
+        title: topSearch
         additionalProperties: false
         required:
           - search
@@ -33,6 +34,7 @@ topSearchesResponseWithAnalytics:
       description: A list of top searches with their count and analytics.
       items:
         type: object
+        title: topSearchWithAnalytics
         additionalProperties: false
         required:
           - search
diff --git a/specs/analytics/paths/click/getAverageClickPosition.yml b/specs/analytics/paths/click/getAverageClickPosition.yml
@@ -32,6 +32,7 @@ get:
                 description: A list of average click position with their date.
                 items:
                   type: object
+                  title: averageClickEvent
                   additionalProperties: false
                   required:
                     - average
diff --git a/specs/analytics/paths/click/getClickPositions.yml b/specs/analytics/paths/click/getClickPositions.yml
@@ -32,6 +32,7 @@ get:
                 maxItems: 2
                 items:
                   type: object
+                  title: clickPosition
                   additionalProperties: false
                   required:
                     - position
diff --git a/specs/analytics/paths/click/getClickThroughRate.yml b/specs/analytics/paths/click/getClickThroughRate.yml
@@ -35,6 +35,7 @@ get:
                 description: A list of click-through rate events with their date.
                 items:
                   type: object
+                  title: clickThroughRateEvent
                   additionalProperties: false
                   required:
                     - rate
diff --git a/specs/analytics/paths/click/getConversionRate.yml b/specs/analytics/paths/click/getConversionRate.yml
@@ -35,6 +35,7 @@ get:
                 description: A list of conversion events with their date.
                 items:
                   type: object
+                  title: conversionRateEvent
                   additionalProperties: false
                   required:
                     - rate
diff --git a/specs/analytics/paths/search/getNoClickRate.yml b/specs/analytics/paths/search/getNoClickRate.yml
@@ -35,6 +35,7 @@ get:
                 description: A list of searches without clicks with their date, rate and counts.
                 items:
                   type: object
+                  title: noClickRateEvent
                   additionalProperties: false
                   required:
                     - rate
diff --git a/specs/analytics/paths/search/getNoResultsRate.yml b/specs/analytics/paths/search/getNoResultsRate.yml
@@ -35,6 +35,7 @@ get:
                 description: A list of searches without results with their date, rate and counts.
                 items:
                   type: object
+                  title: noResultsRateEvent
                   additionalProperties: false
                   required:
                     - date
diff --git a/specs/analytics/paths/search/getSearchesCount.yml b/specs/analytics/paths/search/getSearchesCount.yml
@@ -29,6 +29,7 @@ get:
                 description: A list of search events with their date and count.
                 items:
                   type: object
+                  title: searchEvent
                   additionalProperties: false
                   required:
                     - date
diff --git a/specs/analytics/paths/search/getSearchesNoClicks.yml b/specs/analytics/paths/search/getSearchesNoClicks.yml
@@ -28,6 +28,7 @@ get:
                 description: A list of searches with no clicks and their count.
                 items:
                   type: object
+                  title: searchNoClickEvent
                   additionalProperties: false
                   required:
                     - search
diff --git a/specs/analytics/paths/search/getSearchesNoResults.yml b/specs/analytics/paths/search/getSearchesNoResults.yml
@@ -28,6 +28,7 @@ get:
                 description: A list of searches with no results and their count.
                 items:
                   type: object
+                  title: searchNoResultEvent
                   additionalProperties: false
                   required:
                     - search
diff --git a/specs/analytics/paths/search/getTopCountries.yml b/specs/analytics/paths/search/getTopCountries.yml
@@ -28,6 +28,7 @@ get:
                 description: A list of countries with their count.
                 items:
                   type: object
+                  title: topCountry
                   additionalProperties: false
                   required:
                     - country
diff --git a/specs/analytics/paths/search/getUsersCount.yml b/specs/analytics/paths/search/getUsersCount.yml
@@ -29,6 +29,7 @@ get:
                 description: A list of users count with their date.
                 items:
                   type: object
+                  title: userWithDate
                   additionalProperties: false
                   required:
                     - date
diff --git a/specs/search/common/schemas/SearchResponse.yml b/specs/search/common/schemas/SearchResponse.yml
diff --git a/specs/search/paths/advanced/getLogs.yml b/specs/search/paths/advanced/getLogs.yml
diff --git a/specs/search/paths/multiclusters/searchUserIds.yml b/specs/search/paths/multiclusters/searchUserIds.yml
diff --git a/specs/search/paths/rules/common/schemas.yml b/specs/search/paths/rules/common/schemas.yml
diff --git a/specs/search/paths/search/searchForFacetValues.yml b/specs/search/paths/search/searchForFacetValues.yml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"generator-cli": {`
`3`		`- "version": "5.4.0",`
	`3`	`+ "version": "6.0.0",`
`4`	`4`	`"generators": {`
`5`	`5`	`"javascript-search": {`
`6`	`6`	`"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-search",`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ repositories {`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`dependencies {`
`15`		`- compileOnly 'org.openapitools:openapi-generator:5.4.0'`
	`15`	`+ compileOnly 'org.openapitools:openapi-generator:6.0.0'`
`16`	`16`	`compileOnly 'org.yaml:snakeyaml:1.30'`
`17`	`17`	`}`
`18`	`18`