Merge pull request #65 from ZenWave360/features/kotlin

ivangsa · web-flow · commit 5ea658be26da · 2025-07-08T17:20:55.000+02:00
feature/kotlin + release 2.1.0
diff --git a/_config.yml b/_config.yml
@@ -13,6 +13,6 @@ aux_links:
 ga_tracking: G-PWPE0ZF877
 ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)
 
-exclude: e2e
+exclude: e2e,release-notes
 
 footer_content: "ZenWave360 &copy; 2022-2024 - Domain Driven Design (DDD) and API-First for Event Driven Microservices."
diff --git a/e2e/src/test/java/io/zenwave360/sdk/e2e/TestMonolithClinicalProject.java b/e2e/src/test/java/io/zenwave360/sdk/e2e/TestMonolithClinicalProject.java
@@ -134,6 +134,13 @@ public void fixControllers() throws Exception {
         TextUtils.replaceInFile(new File(targetFolder + "/src/main/java/com/example/clinical/adapters/web/masterdata/MasterDataApiController.java"),
                 "masterDataService.listMasterDataOfType\\(type, lang\\)",
                 "masterDataService.listMasterDataOfType(MasterDataType.valueOf(type), lang)");
+
+        TextUtils.replaceInFile(new File(targetFolder + "/src/main/java/com/example/clinical/modules/documents/mappers/DocumentServiceMapper.java"),
+                "DocumentInfo asDocumentInfo\\(List<Long> documentIds\\);",
+                "default DocumentInfo asDocumentInfo(List<Long> documentIds) { return new DocumentInfo(); }");
+        TextUtils.replaceInFile(new File(targetFolder + "/src/main/java/com/example/clinical/modules/documents/mappers/DocumentServiceMapper.java"),
+                "DocumentInfo update\\(@MappingTarget DocumentInfo entity, List<Long> documentIds\\);",
+                " default DocumentInfo update(@MappingTarget DocumentInfo entity, List<Long> documentIds) { return entity; }");
     }
 
     @Test
diff --git a/plugins/asyncapi-spring-cloud-streams3/src/main/resources/io/zenwave360/sdk/plugins/SpringCloudStream3Generator/producer/partials/runtime-headers.hbs b/plugins/asyncapi-spring-cloud-streams3/src/main/resources/io/zenwave360/sdk/plugins/SpringCloudStream3Generator/producer/partials/runtime-headers.hbs
@@ -28,8 +28,8 @@
                 }
                 continue;
             }
-            if (location.startsWith("/")) {
-                var expression = location.substring(1);
+            if (location.startsWith("#/")) {
+                var expression = location.substring(2);
                 try {
                     var parts = java.util.Arrays.asList(expression.split("/"));
                     var value = payload;
diff --git a/plugins/backend-application-default/src/main/java/io/zenwave360/sdk/plugins/BackendApplicationDefaultHelpers.java b/plugins/backend-application-default/src/main/java/io/zenwave360/sdk/plugins/BackendApplicationDefaultHelpers.java
@@ -475,7 +475,7 @@ public Object skipEntityRepository(Map entity, Options options) {
 
     public Object skipEntityId(Map entity, Options options) {
         var zdl = options.get("zdl");
-        return is(Map.of("zdl", zdl, "entity", entity), "vo", "input");
+        return is(Map.of("zdl", zdl, "entity", entity), "embedded", "vo", "input", "abstract");
     };
 
     public Object addExtends(Object entity, Options options) {
diff --git a/plugins/backend-application-default/src/main/java/io/zenwave360/sdk/plugins/BackendApplicationProjectTemplates.java b/plugins/backend-application-default/src/main/java/io/zenwave360/sdk/plugins/BackendApplicationProjectTemplates.java
@@ -27,7 +27,7 @@ public class BackendApplicationProjectTemplates extends ProjectTemplates {
 
     protected Function<Map<String, Object>, Boolean> skipEntityRepository = (model) -> is(model, "persistence") // if polyglot persistence -> skip
             || !(is(model, "aggregate") || ZDLFindUtils.isAggregateRoot(JSONPath.get(model, "zdl"), JSONPath.get(model, "$.entity.name")));
-    protected Function<Map<String, Object>, Boolean> skipEntityId = (model) -> is(model, "embedded", "vo", "input", "abstract");
+//    protected Function<Map<String, Object>, Boolean> skipEntityId = (model) -> is(model, "embedded", "vo", "input", "abstract");
     protected Function<Map<String, Object>, Boolean> skipEntity = (model) -> is(model, "vo", "input");
 //    protected Function<Map<String, Object>, Boolean> skipEntityInput = (model) -> inputDTOSuffix == null || inputDTOSuffix.isEmpty();
 
diff --git a/plugins/customizations/kotlin-backend-application/src/main/java/io/zenwave360/sdk/plugins/kotlin/BackendApplicationKotlinHelpers.java b/plugins/customizations/kotlin-backend-application/src/main/java/io/zenwave360/sdk/plugins/kotlin/BackendApplicationKotlinHelpers.java
@@ -32,9 +32,7 @@ public String methodParametersSignature(Map<String, Object> method, Options opti
 
     public String mapperInputSignature(String inputType, Options options) {
         var zdl = (Map) options.get("zdl");
-        var signature = ZDLJavaSignatureUtils.mapperInputSignature(inputType, zdl);
-        signature = signature.replace("java.util.Map input", "java.util.Map<String,Any?> input");
-        return ZDLJavaSignatureUtils.toKotlinMethodSignature(signature);
+        return ZDLJavaSignatureUtils.kotlinMapperInputSignature(inputType, zdl);
     }
 
     public String returnType(Map<String, Object> method, Options options) {
@@ -47,6 +45,12 @@ public String fieldType(Map field, Options options) {
         return fixKotlinCollectionTypes(ZDLJavaSignatureUtils.fieldType(field, prefix, suffix));
     };
 
+    public boolean isRequired(Map field, Options options) {
+        var isRequired = JSONPath.get(field, "validations.required") != null;
+        var isArray = JSONPath.get(field, "isArray", false);
+        return isRequired && !isArray;
+    }
+
     public String relationshipFieldType(Map field, Options options) {
         String prefix = (String) options.hash.getOrDefault("prefix", "");
         String suffix = (String) options.hash.getOrDefault("suffix", "");
diff --git a/plugins/customizations/kotlin-backend-application/src/main/resources/io/zenwave360/sdk/plugins/kotlin/BackendApplicationDefaultGenerator/src/main/kotlin/core/domain/vo/Entity.kt.hbs b/plugins/customizations/kotlin-backend-application/src/main/resources/io/zenwave360/sdk/plugins/kotlin/BackendApplicationDefaultGenerator/src/main/kotlin/core/domain/vo/Entity.kt.hbs
@@ -25,7 +25,7 @@ data class {{entity.className}}(
 {{#each entity.fields as |field|}}
     {{~#if field.isArray}}
     fun add{{capitalize field.name}}({{field.name}}: {{javaType field}}): {{entity.className}} {
-        this.{{field.name}}.add({{field.name}})
+        this.{{field.name}} += {{field.name}}
         return this
     }
     {{~/if}}
diff --git a/plugins/customizations/kotlin-backend-application/src/main/resources/io/zenwave360/sdk/plugins/kotlin/BackendApplicationDefaultGenerator/src/main/kotlin/core/inbound/dtos/EntityInput.kt.hbs b/plugins/customizations/kotlin-backend-application/src/main/resources/io/zenwave360/sdk/plugins/kotlin/BackendApplicationDefaultGenerator/src/main/kotlin/core/inbound/dtos/EntityInput.kt.hbs
diff --git a/plugins/customizations/kotlin-backend-application/src/main/resources/io/zenwave360/sdk/plugins/kotlin/BackendApplicationDefaultGenerator/src/main/kotlin/core/inbound/dtos/InputOrOutput.kt.hbs b/plugins/customizations/kotlin-backend-application/src/main/resources/io/zenwave360/sdk/plugins/kotlin/BackendApplicationDefaultGenerator/src/main/kotlin/core/inbound/dtos/InputOrOutput.kt.hbs
@@ -12,11 +12,7 @@ import jakarta.validation.constraints.*
 data class {{entity.className}}(
 {{#each entity.fields as |field|}}
     {{{fieldValidationAnnotations field}}}
-    {{~#if @last}}
-    val {{field.name}}: {{{fieldType field}}}{{#unless field.isArray}}?{{/unless}} {{{fieldTypeInitializer field}}}
-    {{~else}}
-    val {{field.name}}: {{{fieldType field}}}{{#unless field.isArray}}?{{/unless}} {{{fieldTypeInitializer field}}},
-    {{~/if}}
+    val {{field.name}}: {{{fieldType field}}}{{#unless field.isArray}}?{{/unless}} {{{fieldTypeInitializer field}}}{{~#unless @last}},{{~/unless}}
 {{/each}}
 ) {{addExtends entity}} : Serializable {
 
diff --git a/plugins/zdl-to-asyncapi/src/main/java/io/zenwave360/sdk/plugins/ZDLToAsyncAPIGenerator.java b/plugins/zdl-to-asyncapi/src/main/java/io/zenwave360/sdk/plugins/ZDLToAsyncAPIGenerator.java
@@ -148,7 +148,8 @@ public GeneratedProjectFiles generate(Map<String, Object> contextModel) {
                 schemas.put(entityName, asyncAPISchema);
             }
             if (schemaFormat == SchemaFormat.avro) {
-                EntitiesToAvroConverter toAvroConverter = new EntitiesToAvroConverter().withIdType(idType).withNamespace(avroPackage);
+                var avroIdType = "string".equals(idType) ? "string" : "long";
+                EntitiesToAvroConverter toAvroConverter = new EntitiesToAvroConverter().withIdType(avroIdType).withNamespace(avroPackage);
                 generatedProjectFiles.singleFiles.addAll(convertToAvro(toAvroConverter, schema, model));
             }
         }
diff --git a/release-notes/release-notes.v2.0.0.md b/release-notes/release-notes.v2.0.0.md
@@ -13,7 +13,7 @@ These changes are transparent for users and it will help build tools around ZenW
 Users that need to rely on previous version with jbang can use the following command:
 
 ```shell
-jbang alias add --fresh --force --name=zw v1.7.1@zenwave360/zenwave-sdk
+jbang alias add --fresh --force --name=zw v1_7_1@zenwave360/zenwave-sdk
 ```
 
 This release also includes several bugfixes and new features:
diff --git a/release-notes/release-notes.v2.1.0.md b/release-notes/release-notes.v2.1.0.md
@@ -0,0 +1,28 @@
+## What's Changed
+
+* Merged 2.1.0 by @ivangsa in https://github.com/ZenWave360/zenwave-sdk/pull/45
+
+## What's New
+
+- Spring-Boot + Kotlin support via ProjectTemplates: this introduces the first mayor customization of `BackendApplicationDefaultPlugin`, `OpenAPIControllersPlugin` and `SpringWebTestClientPlugin`.
+- `useSpringModulith` option in BackendApplicationDefaultPlugin: adds Spring Modulith `@NamedInterface` annotations to public service interfaces and events.
+
+Users that need to rely on previous v1.7.1, with jbang you can use the following command to install:
+
+```shell
+jbang alias add --fresh --force --name=zw v1_7_1@zenwave360/zenwave-sdk
+```
+
+This release also includes several bugfixes and features:
+
+* 2025-07-08 d3a979c8 fix: skipEntityId for "embedded" and "abstract" entities (bug) {{Ivan Garcia Sainz-Aja}}  (HEAD -> features/kotlin)
+* 2025-07-08 17861f4f fix: autoheader support with json pointer (bug) {{Ivan Garcia Sainz-Aja}}
+* 2025-06-14 7c785066 feat: add support for Kotlin+SpringBoot ProjectTemplates {{Ivan Garcia Sainz-Aja}}
+* 2025-06-30 32d1257d feat: useSpringModulith {{Ivan Garcia Sainz-Aja}}  (origin/features/useSpringModulith, features/useSpringModulith)
+* 2024-06-20 5b15c8f0 refactors ProjectTemplates.java / Generator.java {{Ivan Garcia Sainz-Aja}}  (origin/develop)
+* 2025-06-18 9911f5b0 fix(ServiceTest.hbs): escape input parameter type for generics {{Ivan Garcia Sainz-Aja}}
+* 2025-06-01 95feb376 feat: add validation for empty ZDL models and update markdown generation logic {{Ivan Garcia Sainz-Aja}}
+* 2025-05-07 d31cda53 fix: use formatted POJO name in converted json for javaType value {{Dmitrii Mikheev}}
+
+
+**Full Changelog**: https://github.com/ZenWave360/zenwave-sdk/compare/v2.0.0-RC1...v2.1.0
diff --git a/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/generators/Generator.java b/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/generators/Generator.java
@@ -1,5 +1,6 @@
 package io.zenwave360.sdk.generators;
 
+import static java.lang.reflect.Modifier.isPrivate;
 import static java.lang.reflect.Modifier.isStatic;
 import static org.apache.commons.lang3.reflect.FieldUtils.getAllFields;
 
@@ -8,15 +9,18 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import io.zenwave360.sdk.templating.HandlebarsEngine;
 import io.zenwave360.sdk.templating.TemplateEngine;
 import io.zenwave360.sdk.zdl.GeneratedProjectFiles;
 import io.zenwave360.sdk.zdl.layouts.ProjectLayout;
 
 public abstract class Generator {
 
+    @JsonIgnore
     private final HandlebarsEngine handlebarsEngine = new HandlebarsEngine();
 
+    @JsonIgnore
     public TemplateEngine getTemplateEngine() {
         return handlebarsEngine;
     }
@@ -36,7 +40,7 @@ public static Map<String, Object> asConfigurationMap(Object object) {
         Field[] fields = getAllFields(object.getClass());
         for (Field field : fields) {
             try {
-                if (!isStatic(field.getModifiers()) && field.canAccess(object) && !field.getName().startsWith("this$")) {
+                if (!isStatic(field.getModifiers()) && !isPrivate(field.getModifiers()) && field.canAccess(object) && !field.getName().startsWith("this$")) {
                     var value = field.get(object);
                     if (value instanceof ProjectLayout layout) {
                         config.put("layout", layout.asMap());
diff --git a/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/templating/HandlebarsEngine.java b/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/templating/HandlebarsEngine.java
@@ -8,6 +8,7 @@
 import java.util.List;
 import java.util.Map;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.github.jknack.handlebars.Context;
 import com.github.jknack.handlebars.Handlebars;
 import com.github.jknack.handlebars.context.FieldValueResolver;
diff --git a/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/zdl/utils/ZDLHttpUtils.java b/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/zdl/utils/ZDLHttpUtils.java
@@ -70,7 +70,9 @@ public static String getJavaType(Map<String, Object> param, String openApiModelN
             return "Boolean";
         }
         if ("array".equals(type)) {
-            return "List<String>";
+            var itemsSchema = JSONPath.get(param, "$.schema.items");
+            var itemsType = getJavaType(Maps.of("schema", itemsSchema), openApiModelNamePrefix, openApiModelNameSuffix);
+            return "List<" + itemsType + ">";
         }
         if(schemaName != null) {
             return openApiModelNamePrefix + schemaName + openApiModelNameSuffix;
diff --git a/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/zdl/utils/ZDLJavaSignatureUtils.java b/zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/zdl/utils/ZDLJavaSignatureUtils.java
@@ -116,7 +116,18 @@ public static String methodParametersSignature(String idJavaType, Map method, Ma
     public static String kotlinMethodParametersSignature(String idJavaType, Map method, Map zdl) {
         var signature = methodParametersSignature(idJavaType, method, zdl);
         signature = signature.replace("java.util.Map", "java.util.Map<String,Any?>");
-        return toKotlinMethodSignature(signature);
+        var kotlinSignature = toKotlinMethodSignature(signature);
+        var isInlineParam = JSONPath.get(zdl, "$.allEntitiesAndEnums." + method.get("parameter") + ".options.inline", false);
+        if(isInlineParam) {
+            var optionalParamFields = JSONPath.get(zdl, "$.inputs." + method.get("parameter") + ".fields[*][?(!@.validations.required)]", List.<Map>of());
+            for (var field : optionalParamFields) {
+                if(!JSONPath.get(field, "$.isArray", false)) {
+                    kotlinSignature = kotlinSignature.replace(field.get("name") + ": " + field.get("type"), field.get("name") + ": " + field.get("type") + "?");
+                }
+            }
+
+        }
+        return kotlinSignature;
     }
 
     public static String toKotlinMethodSignature(String signature) {
@@ -148,6 +159,23 @@ public static String mapperInputSignature(String inputType, Map zdl) {
         return StringUtils.join(inputSignature(inputType, null, zdl), ", ");
     }
 
+    public static String kotlinMapperInputSignature(String inputType, Map zdl) {
+        if("Map".equals(inputType) || "java.util.Map".equals(inputType)) {
+            return "input: java.util.Map<String,Any?>";
+        }
+        var mapperInputSignature = StringUtils.join(inputSignature(inputType, null, zdl), ", ");
+        var kotlinSignature = toKotlinMethodSignature(mapperInputSignature);
+        if(JSONPath.get(zdl, "$.inputs." + inputType + ".options.inline", false)) {
+            var optionalParamFields = JSONPath.get(zdl, "$.inputs." + inputType + ".fields[*][?(!@.validations.required)]", List.<Map>of());
+            for (var field : optionalParamFields) {
+                if(!JSONPath.get(field, "$.isArray", false)) {
+                    kotlinSignature = kotlinSignature.replace(field.get("name") + ": " + field.get("type"), field.get("name") + ": " + field.get("type") + "?");
+                }
+            }
+        }
+        return kotlinSignature;
+    }
+
     public static String mapperInputCallSignature(String inputType, Map zdl) {
         return inputSignature(inputType, null, zdl).stream()
                 .map(p -> p.split(" ")[1])
diff --git a/zenwave-sdk-cli/src/test/java/io/zenwave360/sdk/zdl/utils/ZDLJavaSignatureUtilsTest.java b/zenwave-sdk-cli/src/test/java/io/zenwave360/sdk/zdl/utils/ZDLJavaSignatureUtilsTest.java
@@ -67,6 +67,32 @@ void methodParametersSignatureWithNaturalIdsAndParameter() throws IOException {
         Assertions.assertEquals("Long customerId, String anotherId, Customer input", signature);
     }
 
+    @Test
+    void methodParametersSignatureWithNaturalIdsAndParameter_kotlin() throws IOException {
+        var model = loadZDL("classpath:io/zenwave360/sdk/resources/zdl/natural-ids.zdl");
+        var method = JSONPath.get(model, "$.services.CustomerService.methods.updateCustomer", Map.of());
+        var signature = ZDLJavaSignatureUtils.kotlinMethodParametersSignature("String", method, model);
+        Assertions.assertEquals("customerId: Long, anotherId: String, input: Customer", signature);
+    }
+
+    @Test
+    void methodParametersSignatureWithInlineParameter_kotlin() throws IOException {
+        var model = loadZDL("classpath:io/zenwave360/sdk/resources/zdl/customer-address.zdl");
+        var method = JSONPath.get(model, "$.services.CustomerService.methods.addCustomerAddress", Map.of());
+        var signature = ZDLJavaSignatureUtils.kotlinMethodParametersSignature("String", method, model);
+        Assertions.assertEquals("customerId: String, address: Address?", signature);
+    }
+
+    @Test
+    void kotlinMapperInputSignatureWithInline_kotlin() throws IOException {
+        var model = loadZDL("classpath:io/zenwave360/sdk/resources/zdl/customer-address.zdl");
+        var method = JSONPath.get(model, "$.services.CustomerService.methods.addCustomerAddress", Map.of());
+        var signature = ZDLJavaSignatureUtils.kotlinMapperInputSignature("CustomerAddressId", model);
+        Assertions.assertEquals("customerId: String, address: Address?", signature);
+    }
+
+
+
     @Test
     void methodParametersCallSignature() throws IOException {
         var model = loadZDL("classpath:io/zenwave360/sdk/resources/zdl/order-faults-attachments-model.zdl");
diff --git a/zenwave-sdk-test-resources/src/main/resources/io/zenwave360/sdk/resources/zdl/customer-address.zdl b/zenwave-sdk-test-resources/src/main/resources/io/zenwave360/sdk/resources/zdl/customer-address.zdl
@@ -68,7 +68,7 @@ input AddressInputCopy {
 
 @inline
 input CustomerAddressId {
-  customerId String /** customer id javadoc comment */
+  customerId String required /** customer id javadoc comment */
   address Address
 }
 

Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,8 @@`
`28`	`28`	`}`
`29`	`29`	`continue;`
`30`	`30`	`}`
`31`		`- if (location.startsWith("/")) {`
`32`		`- var expression = location.substring(1);`
	`31`	`+ if (location.startsWith("#/")) {`
	`32`	`+ var expression = location.substring(2);`
`33`	`33`	`try {`
`34`	`34`	`var parts = java.util.Arrays.asList(expression.split("/"));`
`35`	`35`	`var value = payload;`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ data class {{entity.className}}(`
`25`	`25`	`{{#each entity.fields as \|field\|}}`
`26`	`26`	`{{~#if field.isArray}}`
`27`	`27`	`fun add{{capitalize field.name}}({{field.name}}: {{javaType field}}): {{entity.className}} {`
`28`		`- this.{{field.name}}.add({{field.name}})`
	`28`	`+ this.{{field.name}} += {{field.name}}`
`29`	`29`	`return this`
`30`	`30`	`}`
`31`	`31`	`{{~/if}}`
Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,8 @@ public GeneratedProjectFiles generate(Map<String, Object> contextModel) {`
`148`	`148`	`schemas.put(entityName, asyncAPISchema);`
`149`	`149`	`}`
`150`	`150`	`if (schemaFormat == SchemaFormat.avro) {`
`151`		`- EntitiesToAvroConverter toAvroConverter = new EntitiesToAvroConverter().withIdType(idType).withNamespace(avroPackage);`
	`151`	`+ var avroIdType = "string".equals(idType) ? "string" : "long";`
	`152`	`+ EntitiesToAvroConverter toAvroConverter = new EntitiesToAvroConverter().withIdType(avroIdType).withNamespace(avroPackage);`
`152`	`153`	`generatedProjectFiles.singleFiles.addAll(convertToAvro(toAvroConverter, schema, model));`
`153`	`154`	`}`
`154`	`155`	`}`