|
| 1 | +package com.algolia.codegen; |
| 2 | + |
| 3 | +import com.algolia.codegen.exceptions.*; |
| 4 | +import java.util.*; |
| 5 | +import org.openapitools.codegen.*; |
| 6 | +import org.openapitools.codegen.model.*; |
| 7 | + |
| 8 | +public class GenericPropagator { |
| 9 | + |
| 10 | + private static Set<String> primitiveModels = new HashSet<>(Arrays.asList("object", "array", "string", "boolean", "integer")); |
| 11 | + |
| 12 | + // Only static use of this class |
| 13 | + private GenericPropagator() {} |
| 14 | + |
| 15 | + private static void setVendorExtension(IJsonSchemaValidationProperties property, String key, Object value) { |
| 16 | + if (property instanceof CodegenModel) { |
| 17 | + ((CodegenModel) property).vendorExtensions.put(key, value); |
| 18 | + } else if (property instanceof CodegenProperty) { |
| 19 | + ((CodegenProperty) property).vendorExtensions.put(key, value); |
| 20 | + } |
| 21 | + } |
| 22 | + |
| 23 | + /** |
| 24 | + * Add the property x-propagated-generic to a model or property, meaning it should be replaced |
| 25 | + * with T directly |
| 26 | + */ |
| 27 | + private static void setPropagatedGeneric(IJsonSchemaValidationProperties property) { |
| 28 | + setVendorExtension(property, "x-propagated-generic", true); |
| 29 | + } |
| 30 | + |
| 31 | + /** |
| 32 | + * Add the property x-has-child-generic to a model or property, meaning one of its members is |
| 33 | + * generic and it should propagate the T |
| 34 | + */ |
| 35 | + private static void setHasChildGeneric(IJsonSchemaValidationProperties property) { |
| 36 | + setVendorExtension(property, "x-has-child-generic", true); |
| 37 | + } |
| 38 | + |
| 39 | + /** |
| 40 | + * @return true if the vendor extensions of the property contains either x-propagated-generic or |
| 41 | + * x-has-child-generic |
| 42 | + */ |
| 43 | + private static boolean hasGeneric(IJsonSchemaValidationProperties property) { |
| 44 | + if (property instanceof CodegenModel) { |
| 45 | + return ( |
| 46 | + (boolean) ((CodegenModel) property).vendorExtensions.getOrDefault("x-propagated-generic", false) || |
| 47 | + (boolean) ((CodegenModel) property).vendorExtensions.getOrDefault("x-has-child-generic", false) |
| 48 | + ); |
| 49 | + } else if (property instanceof CodegenProperty) { |
| 50 | + return ( |
| 51 | + (boolean) ((CodegenProperty) property).vendorExtensions.getOrDefault("x-propagated-generic", false) || |
| 52 | + (boolean) ((CodegenProperty) property).vendorExtensions.getOrDefault("x-has-child-generic", false) |
| 53 | + ); |
| 54 | + } |
| 55 | + return false; |
| 56 | + } |
| 57 | + |
| 58 | + private static CodegenModel propertyToModel(Map<String, CodegenModel> models, CodegenProperty prop) { |
| 59 | + // openapi generator returns some weird error when looking for primitive type, |
| 60 | + // so we filter them by hand |
| 61 | + if (prop == null || primitiveModels.contains(prop.openApiType) || !models.containsKey(prop.openApiType)) { |
| 62 | + return null; |
| 63 | + } |
| 64 | + return models.get(prop.openApiType); |
| 65 | + } |
| 66 | + |
| 67 | + private static boolean markPropagatedGeneric(IJsonSchemaValidationProperties model) { |
| 68 | + CodegenProperty items = model.getItems(); |
| 69 | + // if items itself isn't generic, we recurse on its items and properties until we reach the |
| 70 | + // end or find a generic property |
| 71 | + if (items != null && ((boolean) items.vendorExtensions.getOrDefault("x-is-generic", false) || markPropagatedGeneric(items))) { |
| 72 | + setPropagatedGeneric(model); |
| 73 | + return true; |
| 74 | + } |
| 75 | + for (CodegenProperty var : model.getVars()) { |
| 76 | + // same thing for the var, if it's not a generic, we recurse on it until we find one |
| 77 | + if ((boolean) var.vendorExtensions.getOrDefault("x-is-generic", false) || markPropagatedGeneric(var)) { |
| 78 | + setPropagatedGeneric(model); |
| 79 | + return true; |
| 80 | + } |
| 81 | + } |
| 82 | + return false; |
| 83 | + } |
| 84 | + |
| 85 | + private static boolean propagateGenericRecursive(Map<String, CodegenModel> models, IJsonSchemaValidationProperties property) { |
| 86 | + CodegenProperty items = property.getItems(); |
| 87 | + // if items itself isn't generic, we recurse on its items and properties (and it's |
| 88 | + // equivalent model if we find one) until we reach the end or find a generic property. |
| 89 | + // We need to check the model too because the tree isn't complete sometime, depending on the ref |
| 90 | + // in the spec, so we get the model with the same name and recurse. |
| 91 | + if (items != null && ((hasGeneric(items) || propagateGenericRecursive(models, items) || hasGeneric(propertyToModel(models, items))))) { |
| 92 | + setHasChildGeneric(property); |
| 93 | + return true; |
| 94 | + } |
| 95 | + for (CodegenProperty var : property.getVars()) { |
| 96 | + // same thing for the var |
| 97 | + if (hasGeneric(var) || propagateGenericRecursive(models, var) || hasGeneric(propertyToModel(models, var))) { |
| 98 | + setHasChildGeneric(property); |
| 99 | + return true; |
| 100 | + } |
| 101 | + } |
| 102 | + return false; |
| 103 | + } |
| 104 | + |
| 105 | + private static Map<String, CodegenModel> convertToMap(Map<String, ModelsMap> models) { |
| 106 | + Map<String, CodegenModel> modelsMap = new TreeMap<>(String.CASE_INSENSITIVE_ORDER); |
| 107 | + for (ModelsMap modelMap : models.values()) { |
| 108 | + // modelContainers always have 1 and only 1 model in our specs |
| 109 | + CodegenModel model = modelMap.getModels().get(0).getModel(); |
| 110 | + modelsMap.put(model.name, model); |
| 111 | + } |
| 112 | + return modelsMap; |
| 113 | + } |
| 114 | + |
| 115 | + private static Map<String, CodegenModel> convertToMap(List<ModelMap> models) { |
| 116 | + Map<String, CodegenModel> modelsMap = new TreeMap<>(String.CASE_INSENSITIVE_ORDER); |
| 117 | + for (ModelMap modelMap : models) { |
| 118 | + CodegenModel model = modelMap.getModel(); |
| 119 | + modelsMap.put(model.name, model); |
| 120 | + } |
| 121 | + return modelsMap; |
| 122 | + } |
| 123 | + |
| 124 | + /** |
| 125 | + * Models and their members will be marked with either x-propagated-generic or x-has-child-generic |
| 126 | + */ |
| 127 | + public static void propagateGenericsToModels(Map<String, ModelsMap> modelsMap) { |
| 128 | + // We propagate generics in two phases: |
| 129 | + // 1. We mark the direct parent of the generic model to replace it with T |
| 130 | + // 2. We tell each parent with generic properties to pass that generic type all the way down |
| 131 | + |
| 132 | + Map<String, CodegenModel> models = convertToMap(modelsMap); |
| 133 | + |
| 134 | + for (CodegenModel model : models.values()) { |
| 135 | + markPropagatedGeneric(model); |
| 136 | + } |
| 137 | + |
| 138 | + for (CodegenModel model : models.values()) { |
| 139 | + propagateGenericRecursive(models, model); |
| 140 | + } |
| 141 | + } |
| 142 | + |
| 143 | + /** Mark operations with a generic return type with x-is-generic */ |
| 144 | + public static void propagateGenericsToOperations(OperationsMap operations, List<ModelMap> allModels) { |
| 145 | + Map<String, CodegenModel> models = convertToMap(allModels); |
| 146 | + for (CodegenOperation ope : operations.getOperations().getOperation()) { |
| 147 | + CodegenModel returnType = models.get(ope.returnType); |
| 148 | + if (returnType != null && hasGeneric(returnType)) { |
| 149 | + ope.vendorExtensions.put("x-is-generic", true); |
| 150 | + // we use {{#optionalParams.0}} to check for optionalParams, so we loose the |
| 151 | + // vendorExtensions at the operation level |
| 152 | + if (ope.optionalParams.size() > 0) { |
| 153 | + ope.optionalParams.get(0).vendorExtensions.put("x-is-generic", true); |
| 154 | + } |
| 155 | + } |
| 156 | + } |
| 157 | + } |
| 158 | +} |
0 commit comments