-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(clients): delete unused models (#3445)
- Loading branch information
Showing
10 changed files
with
146 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
generators/src/main/java/com/algolia/codegen/utils/ModelPruner.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| package com.algolia.codegen.utils; | ||
|
|
||
| import java.io.File; | ||
| import java.util.*; | ||
| import org.openapitools.codegen.*; | ||
| import org.openapitools.codegen.model.ModelMap; | ||
| import org.openapitools.codegen.model.OperationsMap; | ||
|
|
||
| public class ModelPruner { | ||
|
|
||
| private static Set<String> primitiveModels = new HashSet<>(Arrays.asList("object", "array", "string", "boolean", "integer")); | ||
|
|
||
| private Map<String, CodegenModel> models; | ||
| private Set<String> visitedModels; | ||
|
|
||
| private ModelPruner(Map<String, CodegenModel> models) { | ||
| this.visitedModels = new TreeSet<>(String.CASE_INSENSITIVE_ORDER); | ||
| this.models = models; | ||
| } | ||
|
|
||
| private CodegenModel getModel(String name) { | ||
| name = name.replace("?", ""); | ||
| // openapi generator returns some weird error when looking for primitive type, so we filter them | ||
| // by hand | ||
| if (primitiveModels.contains(name)) { | ||
| return null; | ||
| } | ||
|
|
||
| return models.get(name); | ||
| } | ||
|
|
||
| private CodegenModel propertyToModel(CodegenProperty prop) { | ||
| return prop == null ? null : getModel(prop.openApiType); | ||
| } | ||
|
|
||
| private void exploreProperties(CodegenModel model, List<CodegenProperty> properties) { | ||
| for (CodegenProperty property : properties) { | ||
| CodegenModel propModel = propertyToModel(property); | ||
| if (propModel != null && !visitedModels.contains(propModel.name)) { | ||
| visitedModels.add(property.openApiType); | ||
| visitedModels.add(propModel.name); | ||
| visitModelRecursive(propModel); | ||
| } | ||
| CodegenModel itemsModel = propertyToModel(property.mostInnerItems); | ||
| if (itemsModel != null && !visitedModels.contains(itemsModel.name)) { | ||
| // In csharp the real model name varies if its part of the modelMapping so we have to add | ||
| // both | ||
| visitedModels.add(property.mostInnerItems.openApiType); | ||
| visitedModels.add(itemsModel.name); | ||
| visitModelRecursive(itemsModel); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void visitModelRecursive(CodegenModel model) { | ||
| exploreProperties(model, model.getVars()); | ||
| if (model.getComposedSchemas() != null && model.getComposedSchemas().getOneOf() != null) { | ||
| exploreProperties(model, model.getComposedSchemas().getOneOf()); | ||
| } | ||
| } | ||
|
|
||
| private static Map<String, CodegenModel> convertToMap(CodegenConfig config, List<ModelMap> models) { | ||
| Map<String, CodegenModel> modelsMap = new TreeMap<>(String.CASE_INSENSITIVE_ORDER); | ||
| for (ModelMap modelMap : models) { | ||
| CodegenModel model = modelMap.getModel(); | ||
|
|
||
| modelsMap.put(config.toModelName(model.name), model); | ||
| } | ||
| return modelsMap; | ||
| } | ||
|
|
||
| private void exploreGraph(OperationsMap operations) { | ||
| for (CodegenModel model : models.values()) { | ||
| visitModelRecursive(model); | ||
| } | ||
|
|
||
| for (CodegenOperation ope : operations.getOperations().getOperation()) { | ||
| if (ope.returnType != null) { | ||
| CodegenModel returnType = getModel(ope.returnBaseType); | ||
| if (returnType != null) { | ||
| visitedModels.add(returnType.name); | ||
| } | ||
| } | ||
| for (CodegenParameter param : ope.allParams) { | ||
| CodegenModel paramType = getModel(param.baseType != null ? param.baseType : param.dataType); | ||
| if (paramType != null) { | ||
| visitedModels.add(paramType.name); | ||
| } | ||
| CodegenModel itemsModel = propertyToModel(param.mostInnerItems); | ||
| if (itemsModel != null) { | ||
| visitedModels.add(itemsModel.name); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** remove all the unused models, most likely the sub models of allOf */ | ||
| public static void removeOrphans(CodegenConfig config, OperationsMap operations, List<ModelMap> allModels, boolean keepError) { | ||
| // visit all the models that are accessible from: | ||
| // - the properties of a model (needs recursive search) | ||
| // - the return type of an operation | ||
| // - the parameters of an operation | ||
|
|
||
| ModelPruner modelPruner = new ModelPruner(convertToMap(config, allModels)); | ||
| Helpers.prettyPrint(modelPruner.models.keySet()); | ||
| modelPruner.exploreGraph(operations); | ||
|
|
||
| List<String> toRemove = new ArrayList<>(); | ||
| for (String modelName : modelPruner.models.keySet()) { | ||
| if (keepError && modelName.equals("ErrorBase")) { | ||
| continue; | ||
| } | ||
| if (!modelPruner.visitedModels.contains(modelName)) { | ||
| toRemove.add(modelName); | ||
| } | ||
| } | ||
|
|
||
| String templateName = config.modelTemplateFiles().keySet().iterator().next(); | ||
|
|
||
| for (String modelName : toRemove) { | ||
| String filename = config.modelFilename(templateName, modelName); | ||
| File file = new File(filename); | ||
| if (file.exists()) { | ||
| file.delete(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public static void removeOrphans(CodegenConfig config, OperationsMap operations, List<ModelMap> allModels) { | ||
| removeOrphans(config, operations, allModels, false); | ||
| } | ||
| } |