Skip to content

Added $ (dollar sign) escape for kotlin generator #2388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 6.18.x
Choose a base branch
from
Open

Added $ (dollar sign) escape for kotlin generator #2388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1582,7 +1582,7 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
if (param.isEnumRef) {
param.isEnum = true;
}
processGenericAnnotations(param, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false);
processGenericAnnotations(param, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false, false);
if (useBeanValidation && !param.isContainer && param.isModel) {
param.vendorExtensions.put("withValid", true);
}
Expand All @@ -1609,7 +1609,7 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
}
}
if (op.returnProperty != null) {
processGenericAnnotations(op.returnProperty, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false);
processGenericAnnotations(op.returnProperty, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false, false);
op.returnType = op.returnProperty.vendorExtensions.get("typeWithEnumWithGenericAnnotations").toString();
}
}
Expand Down Expand Up @@ -2370,7 +2370,7 @@ private void processDiscriminatorProperty(CodegenProperty prop, CodegenDiscrimin
prop.dataType = discriminator.getPropertyType();
prop.datatypeWithEnum = discriminator.getPropertyType();
prop.baseType = discriminator.getPropertyType();
processGenericAnnotations(prop, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false);
processGenericAnnotations(prop, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false, false);
}

private void processProperty(CodegenProperty property, boolean isServer, CodegenModel model, Map<String, ModelsMap> models) {
Expand Down Expand Up @@ -2398,7 +2398,7 @@ private void processProperty(CodegenProperty property, boolean isServer, Codegen
property.maxLength = null;
}

processGenericAnnotations(property, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false);
processGenericAnnotations(property, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false, false);

normalizeExtraAnnotations(EXT_ANNOTATIONS_FIELD, false, property.vendorExtensions);
normalizeExtraAnnotations(EXT_ANNOTATIONS_SETTER, false, property.vendorExtensions);
Expand Down Expand Up @@ -2432,7 +2432,7 @@ private void processParentModel(CodegenModel model, List<CodegenProperty> requir
var parentVars = new ArrayList<CodegenProperty>();
for (var v : parent.allVars) {
if (notContainsProp(v, model.vars)) {
processGenericAnnotations(v, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false);
processGenericAnnotations(v, useBeanValidation, isGenerateHardNullable(), false, false, false, false, false, false);
parentVars.add(v);
}
}
Expand Down
133 changes: 123 additions & 10 deletions ...enerator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautKotlinCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@
import static io.micronaut.openapi.generator.Utils.calcQueryValueFormat;
import static io.micronaut.openapi.generator.Utils.isDateType;
import static io.micronaut.openapi.generator.Utils.normalizeExtraAnnotations;
import static io.micronaut.openapi.generator.Utils.normalizeStr;
import static io.micronaut.openapi.generator.Utils.normalizeStrValue;
import static io.micronaut.openapi.generator.Utils.processDuplicateVars;
import static io.micronaut.openapi.generator.Utils.processGenericAnnotations;
import static io.micronaut.openapi.generator.Utils.readListOfStringsProperty;
Expand Down Expand Up @@ -995,6 +997,7 @@ public void addOperationToGroup(String tag, String resourcePath, Operation opera
List<CodegenOperation> opList = operations.computeIfAbsent(basePath, k -> new ArrayList<>());
opList.add(co);
co.baseName = basePath;
co.vendorExtensions.put("normalizedBaseName", normalizeStr(basePath));
return;
}

Expand All @@ -1004,6 +1007,12 @@ public void addOperationToGroup(String tag, String resourcePath, Operation opera
}

super.addOperationToGroup(superSanitizeTag(tag), resourcePath, operation, co, operations);

var foundTag = co.tags.stream().filter(t -> t.getName().equals(tag)).findFirst().orElse(null);
co.vendorExtensions.put("normalizedBaseTag", normalizeStr(tag));
if (foundTag != null) {
co.vendorExtensions.put("normalizedTagDesc", normalizeStr(foundTag.getDescription()));
}
}

@Override
Expand Down Expand Up @@ -1121,6 +1130,9 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo

for (CodegenOperation op : operationList) {

objs.put("normalizedBaseTag", op.vendorExtensions.get("normalizedBaseTag"));
objs.put("normalizedTagDesc", op.vendorExtensions.get("normalizedTagDesc"));

handleImplicitHeaders(op);
handleConstantParams(op);

Expand Down Expand Up @@ -1199,6 +1211,7 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
param.isBodyParam = true;
param.isFormParam = false;
param.vendorExtensions.put("isPart", true);
param.vendorExtensions.put("baseNameNormalized", normalizeStr(param.baseName));
if (param.isEnumRef) {
param.isEnum = true;
}
Expand All @@ -1211,6 +1224,7 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
p.isBodyParam = true;
p.isFormParam = false;
p.vendorExtensions.put("isPart", true);
p.vendorExtensions.put("baseNameNormalized", normalizeStr(p.baseName));
if (p.isEnumRef) {
p.isEnum = true;
}
Expand All @@ -1226,7 +1240,7 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
param.isEnum = true;
}
processGenericAnnotations(param, useBeanValidation, false, param.isNullable || !param.required,
param.required, false, true, ksp);
param.required, false, true, true, ksp);
param.vendorExtensions.put("isString", "string".equalsIgnoreCase(param.dataType));
param.vendorExtensions.put("withoutExample", param.example == null || param.example.equals(NULL_STRING));
if (useBeanValidation && ((!param.isContainer && param.isModel)
Expand All @@ -1237,7 +1251,7 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
// check pattern property for date types: if set, need use this pattern as `@Format` annotation value
if (isDateType(param.dataType)) {
if (StringUtils.isNotEmpty(param.pattern)) {
param.vendorExtensions.put("formatPattern", param.pattern);
param.vendorExtensions.put("formatPattern", normalizeStr(param.pattern));
param.pattern = null;
}
param.minItems = null;
Expand All @@ -1262,9 +1276,11 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
additionalProperties.put("enumParams", enumParams);

if (op.returnProperty != null) {
processGenericAnnotations(op.returnProperty, useBeanValidation, false, false, false, false, false, ksp);
processGenericAnnotations(op.returnProperty, useBeanValidation, false, false, false, false, false, true, ksp);
op.returnType = op.returnProperty.vendorExtensions.get("typeWithEnumWithGenericAnnotations").toString();
}

normalizeTextsInOperation(op);
}

if (needToAddImportFormat) {
Expand All @@ -1274,6 +1290,80 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
return objs;
}

private void normalizeTextsInOperation(CodegenOperation op) {

if (op.vendorExtensions.containsKey("x-deprecated-message")) {
op.vendorExtensions.put("x-deprecated-message-normalized", normalizeStr(op.vendorExtensions.get("x-deprecated-message").toString()));
}

if (op.vendorExtensions.containsKey("x-roles")) {
var roles = (List<String>) op.vendorExtensions.get("x-roles");
var normalizedRoles = new ArrayList<String>(roles.size());
for (var role : roles) {
normalizedRoles.add(normalizeStr(role));
}
op.vendorExtensions.put("x-roles-normalized", normalizedRoles);
}

if (op.summary != null) {
op.vendorExtensions.put("summaryNormalized", normalizeStr(op.summary));
}
if (op.notes != null) {
op.vendorExtensions.put("notesNormalized", normalizeStr(op.notes));
}
if (op.tags != null) {
for (var tag : op.tags) {
tag.setName(normalizeStr(tag.getName()));
}
}
if (op.responses != null) {
for (var response : op.responses) {
response.vendorExtensions.put("messageNormalized", normalizeStr(response.message));
}
}
if (op.produces != null) {
for (var produce : op.produces) {
produce.put("mediaTypeNormalized", normalizeStr(produce.get("mediaType")));
}
}
if (op.consumes != null) {
for (var consume : op.consumes) {
consume.put("mediaTypeNormalized", normalizeStr(consume.get("mediaType")));
}
}
if (op.vendorExtensions.containsKey("swaggerParams")) {
for (var swaggerParam : (List<CodegenParameter>) op.vendorExtensions.get("swaggerParams")) {
swaggerParam.vendorExtensions.put("baseNameNormalized", normalizeStr(swaggerParam.baseName));
swaggerParam.vendorExtensions.put("descriptionNormalized", normalizeStr(swaggerParam.description));
}
}
if (op.authMethods != null) {
for (var authMethod : op.authMethods) {
authMethod.vendorExtensions.put("nameNormalized", normalizeStr(authMethod.name));
if (authMethod.scopes != null) {
for (var scope : authMethod.scopes) {
scope.put("scopeNormalized", normalizeStr((String) scope.get("scope")));
}
}
}
}
op.vendorExtensions.put("pathNormalized", normalizeStr(op.path));

if (op.allParams != null) {
for (var param : op.allParams) {
param.vendorExtensions.put("baseNameNormalized", normalizeStr(param.baseName));
if (param.defaultValue != null) {
param.vendorExtensions.put("defaultValueNormalized", normalizeStr(param.defaultValue));
}
normalizeStrValue("x-pattern-message", param.vendorExtensions);
normalizeStrValue("x-size-message", param.vendorExtensions);
normalizeStrValue("x-not-null-message", param.vendorExtensions);
normalizeStrValue("x-minimum-message", param.vendorExtensions);
normalizeStrValue("x-maximum-message", param.vendorExtensions);
}
}
}

/**
* This method removes all implicit header parameters from the list of parameters.
*
Expand Down Expand Up @@ -1727,7 +1817,7 @@ public CodegenParameter fromParameter(Parameter p, Set<String> imports) {
if (realName.contains("`")) {
realName = realName.replace("`", "");
}
parameter.vendorExtensions.put("realName", realName);
parameter.vendorExtensions.put("realName", normalizeStr(realName));

Schema parameterSchema;
if (p.getSchema() != null) {
Expand Down Expand Up @@ -1766,7 +1856,7 @@ public CodegenParameter fromParameter(Parameter p, Set<String> imports) {
if (ksp && !defaultValueInit.equals(NULL_STRING)) {
parameter.isNullable = false;
}
parameter.vendorExtensions.put("defaultValueInit", defaultValueInit);
parameter.vendorExtensions.put("defaultValueInit", normalizeStr(defaultValueInit));
parameter.vendorExtensions.put("defaultValueIsNotNull", !defaultValueInit.equals(NULL_STRING));
}

Expand Down Expand Up @@ -1806,7 +1896,7 @@ public CodegenProperty fromProperty(String name, Schema schema, boolean required
property.nameInCamelCase = camelize(realName, LOWERCASE_FIRST_LETTER);
property.nameInSnakeCase = CaseFormat.UPPER_CAMEL.to(CaseFormat.UPPER_UNDERSCORE, property.nameInCamelCase);
}
property.vendorExtensions.put("realName", realName);
property.vendorExtensions.put("realName", normalizeStr(realName));

if (schema != null && schema.get$ref() != null) {
var refSchema = ModelUtils.getSchemaFromRefToSchemaWithProperties(openAPI, schema.get$ref());
Expand Down Expand Up @@ -1838,7 +1928,7 @@ public CodegenProperty fromProperty(String name, Schema schema, boolean required
defaultValueInit = NULL_STRING;
}
if (defaultValueInit != null) {
property.vendorExtensions.put("defaultValueInit", defaultValueInit);
property.vendorExtensions.put("defaultValueInit", normalizeStr(defaultValueInit));
}

return property;
Expand Down Expand Up @@ -2173,6 +2263,10 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
model.vendorExtensions.put("requiredParentVarsWithoutDiscriminator", requiredParentVarsWithoutDiscriminator);
}

if (model.vendorExtensions.containsKey("x-deprecated-message")) {
model.vendorExtensions.put("x-deprecated-message-normalized", normalizeStr((String) model.vendorExtensions.get("x-deprecated-message")));
}
model.vendorExtensions.put("descriptionNormalized", normalizeStr(model.description));
model.vendorExtensions.put("requiredVarsWithoutDiscriminator", requiredVarsWithoutDiscriminator);
model.vendorExtensions.put("requiredVars", requiredVars);
model.vendorExtensions.put("withRequiredOrOptionalVars", !requiredVarsWithoutDiscriminator.isEmpty() || !optionalVars.isEmpty());
Expand Down Expand Up @@ -2340,10 +2434,11 @@ protected void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars,

var baseType = (String) vendorExtensions.get("baseType");
for (var enumVar : enumVars) {
var value = (String) enumVar.get("value");
if ((boolean) enumVar.get("isString")) {
enumVar.put("valueNormalized", normalizeStr(value));
continue;
}
var value = (String) enumVar.get("value");
value = value.replace("\"", "");
if ("char".equals(baseType) && !value.startsWith("'")) {
enumVar.put("value", "'" + value + "'");
Expand All @@ -2352,6 +2447,7 @@ protected void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars,
} else if ("byte".equalsIgnoreCase(baseType)) {
enumVar.put("value", value);
}
enumVar.put("valueNormalized", enumVar.get("value"));
}
}

Expand Down Expand Up @@ -2459,6 +2555,22 @@ private void processOneOfModels(CodegenModel model, Collection<ModelsMap> models

private void processProperty(CodegenProperty property, boolean isServer, CodegenModel model, Map<String, ModelsMap> models) {

property.vendorExtensions.put("baseNameNormalized", normalizeStr(property.baseName));
if (property.example != null) {
property.vendorExtensions.put("exampleNormalized", normalizeStr(property.example));
}
if (property.description != null) {
property.vendorExtensions.put("descriptionNormalized", normalizeStr(property.description));
}
if (property.vendorExtensions.containsKey("x-deprecated-message")) {
property.vendorExtensions.put("x-deprecated-message-normalized", normalizeStr((String) property.vendorExtensions.get("x-deprecated-message")));
}
normalizeStrValue("x-pattern-message", property.vendorExtensions);
normalizeStrValue("x-size-message", property.vendorExtensions);
normalizeStrValue("x-not-null-message", property.vendorExtensions);
normalizeStrValue("x-minimum-message", property.vendorExtensions);
normalizeStrValue("x-maximum-message", property.vendorExtensions);

property.vendorExtensions.put("withRequiredAndOptionalVars", model.vendorExtensions.get("withRequiredAndOptionalVars"));
property.vendorExtensions.put("inRequiredArgsConstructor", !property.isReadOnly || isServer);
property.vendorExtensions.put("isServer", isServer);
Expand All @@ -2469,6 +2581,7 @@ private void processProperty(CodegenProperty property, boolean isServer, Codegen
property.vendorExtensions.put("x-implements", model.vendorExtensions.get("x-implements"));
if (NULL_STRING.equals(property.example)) {
property.example = null;
property.vendorExtensions.remove("exampleNormalized");
}
if (useBeanValidation && (
(!property.isContainer && property.isModel)
Expand All @@ -2480,7 +2593,7 @@ private void processProperty(CodegenProperty property, boolean isServer, Codegen
// check pattern property for date types: if set, need use this pattern as `@Format` annotation value
if (isDateType(property.dataType)) {
if (StringUtils.isNotEmpty(property.pattern)) {
property.vendorExtensions.put("formatPattern", property.pattern);
property.vendorExtensions.put("formatPattern", normalizeStr(property.pattern));
property.pattern = null;
}
property.minItems = null;
Expand All @@ -2494,7 +2607,7 @@ private void processProperty(CodegenProperty property, boolean isServer, Codegen
}

processGenericAnnotations(property, useBeanValidation, false, property.isNullable || property.isDiscriminator,
property.required, property.isReadOnly, true, ksp);
property.required, property.isReadOnly, true, true, ksp);

normalizeExtraAnnotations(EXT_ANNOTATIONS_FIELD, true, property.vendorExtensions);
normalizeExtraAnnotations(EXT_ANNOTATIONS_SETTER, true, property.vendorExtensions);
Expand Down
Loading
Loading