Merge branch 'feature/jspecify' into feature/sdk-fixes

# Conflicts:
#	pom.xml

Author: ivangsa

plugins/backend-application-default/README.md

@@ -41,6 +41,7 @@ Visit https://www.zenwave360.io/docs/zenwave-sdk/backend-application for complet
 | `style`                           | Programming Style                                                                                                                                                    | ProgrammingStyle | imperative              | imperative, reactive                                                                                                                                       |
 | `useLombok`                       | Use @Getter and @Setter annotations from Lombok                                                                                                                      | boolean          | false                   |                                                                                                                                                            |
 | `useSpringModulith`               | Whether to use Spring Modulith annotations and features                                                                                                              | boolean          | false                   |                                                                                                                                                            |
+| `useJSpecify`                     | Whether to use JSpecify for nullability annotations                                                                                                                  | boolean          | false                       |                                                                                                                                                            |
 | `addRelationshipsById`            | Controls whether to add a read/write relationship by id when mapping relationships between aggregate (not recommended) keeping the relationship by object readonly.  | boolean          | false                   |                                                                                                                                                            |
 | `idJavaType`                      | Specifies the Java data type for the ID fields of entities. Defaults to Long for JPA and String for MongoDB if not explicitly set.                                   | String           |                         |                                                                                                                                                            |
 | `includeEmitEventsImplementation` | Whether to add AsyncAPI/ApplicationEventPublisher as service dependencies. Depends on the naming convention of zenwave-asyncapi plugin to work.                      | boolean          | true                    |                                                                                                                                                            |

plugins/backend-application-default/src/main/java/io/zenwave360/sdk/plugins/BackendApplicationProjectTemplates.java

@@ -3,11 +3,14 @@
 import io.zenwave360.sdk.doc.DocumentedOption;
 import io.zenwave360.sdk.generators.Generator;
 import io.zenwave360.sdk.options.PersistenceType;
+import io.zenwave360.sdk.plugins.annotators.AnnotationHelper;
+import io.zenwave360.sdk.plugins.annotators.JSpecifyAnnotator;
 import io.zenwave360.sdk.utils.JSONPath;
 import io.zenwave360.sdk.zdl.ProjectTemplates;
 import io.zenwave360.sdk.zdl.layouts.CleanArchitectureProjectLayout;
 import io.zenwave360.sdk.zdl.layouts.CleanHexagonalProjectLayout;
 import io.zenwave360.sdk.zdl.layouts.ProjectLayout;
+import io.zenwave360.sdk.zdl.utils.ZDLAnnotator;
 import io.zenwave360.sdk.zdl.utils.ZDLFindUtils;
 
 import java.util.ArrayList;
@@ -24,6 +27,9 @@ public class BackendApplicationProjectTemplates extends ProjectTemplates {
     @DocumentedOption(description = "Whether to use Spring Modulith annotations and features")
     public boolean useSpringModulith = false;
 
+    @DocumentedOption(description = "Whether to use JSpecify for nullability annotations")
+    public boolean useJSpecify = false;
+
     public PersistenceType persistence = PersistenceType.mongodb;
 
     public boolean includeEmitEventsImplementation = true;
@@ -54,9 +60,19 @@ public List<Object> getTemplateHelpers(Generator generator) {
         var helpers = new ArrayList<>(super.getTemplateHelpers(generator));
         helpers.add(new BackendApplicationDefaultHelpers((BackendApplicationDefaultGenerator) generator));
         helpers.add(new BackendApplicationDefaultJpaHelpers((BackendApplicationDefaultGenerator) generator));
+        helpers.add(AnnotationHelper.class);
         return helpers;
     }
 
+    @Override
+    public List<ZDLAnnotator> getZDLAnnotators() {
+        var annotators = new ArrayList<>(super.getZDLAnnotators());
+        if(useJSpecify) {
+            annotators.add(new JSpecifyAnnotator());
+        }
+        return annotators;
+    }
+
     public BackendApplicationProjectTemplates() {
         setTemplatesFolder("io/zenwave360/sdk/plugins/BackendApplicationDefaultGenerator");
 

plugins/backend-application-default/src/main/java/io/zenwave360/sdk/plugins/annotators/AnnotationHelper.java

@@ -0,0 +1,47 @@
+package io.zenwave360.sdk.plugins.annotators;
+
+import com.github.jknack.handlebars.Options;
+import io.zenwave360.sdk.zdl.model.JavaZdlModel;
+
+import java.util.Map;
+import java.util.stream.Collectors;
+
+public class AnnotationHelper {
+    public static String annotate(Object javaModel, Options options) {
+        var zdl = (Map) options.get("zdl");
+        var model = options.param(0);
+        if(javaModel instanceof JavaZdlModel.Service) {
+            return annotate((JavaZdlModel.Service) javaModel, (Map) model, zdl);
+        }
+        if(javaModel instanceof JavaZdlModel.ServiceMethod) {
+            return annotate((JavaZdlModel.ServiceMethod) javaModel, (Map) model, zdl);
+        }
+        return "";
+    }
+
+    public static String addImports(Object javaModel, Options options) {
+        var zdl = (Map) options.get("zdl");
+        var model = options.param(0);
+        if(javaModel instanceof JavaZdlModel.Service) {
+            return addImports((JavaZdlModel.Service) javaModel, (Map) model, zdl);
+        }
+        return "";
+    }
+
+    private static String addImports(JavaZdlModel.Service service, Map<String, Object> zdlService, Map<String, Object> zdl) {
+        return service.annotations().stream().map(a -> "import " + a.name()).collect(Collectors.joining(";\n"));
+    }
+
+
+    private static String annotate(JavaZdlModel.Service service, Map<String, Object> zdlService, Map<String, Object> zdl) {
+        return service.annotations().stream().map(a -> "@" + a.name()).collect(Collectors.joining("\n"));
+    }
+
+    private static String annotate(JavaZdlModel.ServiceMethod serviceMethod, Map<String, Object> zdlMethod, Map<String, Object> zdl) {
+        return "// todo";
+    }
+
+    private static String annotate(JavaZdlModel.MethodParameter methodParameter, Map<String, Object> zdlService, Map<String, Object> zdl) {
+        return methodParameter.annotations().stream().map(a -> "@" + a.name()).collect(Collectors.joining("\n"));
+    }
+}

plugins/backend-application-default/src/main/java/io/zenwave360/sdk/plugins/annotators/JSpecifyAnnotator.java

@@ -0,0 +1,21 @@
+package io.zenwave360.sdk.plugins.annotators;
+
+import io.zenwave360.sdk.zdl.model.JavaZdlModel;
+import io.zenwave360.sdk.zdl.utils.ZDLAnnotator;
+
+import java.util.Map;
+
+public class JSpecifyAnnotator implements ZDLAnnotator {
+
+    @Override
+    public void annotate(JavaZdlModel.Service service, Map<String, Object> zdlService, Map<String, Object> zdl) {
+        service.annotations().add(new JavaZdlModel.Annotation("org.jspecify.annotations.NullMarked", null, null));
+    }
+
+    @Override
+    public void annotate(JavaZdlModel.MethodParameter methodParameter, Map<String, Object> method, Map<String, Object> zdl) {
+        if(methodParameter.isOptional()) {
+            methodParameter.annotations().add(new JavaZdlModel.Annotation("org.jspecify.annotations.Nullable", null, null));
+        }
+    }
+}

plugins/backend-application-default/src/main/resources/io/zenwave360/sdk/plugins/BackendApplicationDefaultGenerator/src/main/java/core/implementation/imperative/ServiceImpl.java.hbs

@@ -39,6 +39,10 @@ import org.springframework.transaction.annotation.Transactional;
 {{~#if useLombok}}
 @lombok.AllArgsConstructor
 {{~/if}}
+{{~#if useSpringModulith}}
+@org.springframework.modulith.NamedInterface("{{service.name}}")
+{{~/if}}
+{{annotate service.javaService service}}
 public class {{service.name}}Impl implements {{service.name}} {
 
     private final Logger log = LoggerFactory.getLogger(getClass());

plugins/backend-application-default/src/main/resources/io/zenwave360/sdk/plugins/BackendApplicationDefaultGenerator/src/main/java/core/inbound/Service.java.hbs

@@ -17,6 +17,7 @@ import org.springframework.data.domain.Pageable;
 {{~#if useSpringModulith}}
 @org.springframework.modulith.NamedInterface("{{service.name}}")
 {{~/if}}
+{{annotate service.javaService service}}
 public interface {{service.name}} {
 
 {{#each service.methods as |method|}}

plugins/backend-application-default/src/test/resources/jpa-elasticsearch-scs3-pom.xml

@@ -128,6 +128,11 @@
             <version>${lombok.version}</version>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.jspecify</groupId>
+            <artifactId>jspecify</artifactId>
+            <version>1.0.0</version>
+        </dependency>
 
         <dependency>
             <groupId>org.mariadb.jdbc</groupId>

plugins/backend-application-default/src/test/resources/mongodb-elasticsearch-scs3-pom.xml

@@ -114,6 +114,11 @@
             <version>${lombok.version}</version>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.jspecify</groupId>
+            <artifactId>jspecify</artifactId>
+            <version>1.0.0</version>
+        </dependency>
 
         <dependency>
             <groupId>org.springframework.boot</groupId>

zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/generators/ZDLProjectGenerator.java

@@ -1,17 +1,14 @@
 package io.zenwave360.sdk.generators;
 
 import com.fasterxml.jackson.annotation.JsonAnySetter;
-import com.fasterxml.jackson.databind.DeserializationFeature;
-import com.fasterxml.jackson.databind.JsonMappingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import io.zenwave360.sdk.templating.HandlebarsEngine;
 import io.zenwave360.sdk.templating.TemplateInput;
 import io.zenwave360.sdk.templating.TemplateOutput;
-import io.zenwave360.sdk.utils.CommaSeparatedCollectionDeserializationHandler;
 import io.zenwave360.sdk.utils.JSONPath;
 import io.zenwave360.sdk.zdl.GeneratedProjectFiles;
 import io.zenwave360.sdk.zdl.ProjectTemplates;
 import io.zenwave360.sdk.zdl.layouts.ProjectLayout;
+import io.zenwave360.sdk.zdl.model.JavaZdlModel;
+import io.zenwave360.sdk.zdl.utils.ZDLAnnotator;
 import io.zenwave360.sdk.zdl.utils.ZDLFindUtils;
 
 import java.util.*;
@@ -45,6 +42,10 @@ public GeneratedProjectFiles generateProjectFiles(Map<String, Object> contextMod
         var generatedProjectFiles = new GeneratedProjectFiles();
         var apiModel = getZDLModel(contextModel);
 
+        for (ZDLAnnotator zdlAnnotator : templates.getZDLAnnotators()) {
+            zdlAnnotator.annotate((JavaZdlModel) apiModel.get("javaModel"), apiModel);
+        }
+
         Map<String, Map<String, Object>> aggregates = (Map) apiModel.get("aggregates");
         Set<Map<String, Object>> domainEvents = new HashSet<>();
         for (Map<String, Object> aggregate : aggregates.values()) {
@@ -139,11 +140,10 @@ public GeneratedProjectFiles generateProjectFiles(Map<String, Object> contextMod
             }
         }
 
-        Map<String, Map<String, Object>> services = JSONPath.get(apiModel, "$.options.options.service", Collections.emptyMap());
+        Map<String, Map<String, Object>> services = JSONPath.get(apiModel, "$.services", Collections.emptyMap());
         List<Map<String, Object>> servicesList = new ArrayList<>();
         for (Map<String, Object> service : services.values()) {
-            String serviceName = ((String) service.get("value"));
-            service.put("name", serviceName);
+            String serviceName = ((String) service.get("name"));
             List<Map<String, Object>> entitiesByService = getEntitiesByService(service, apiModel);
             service.put("entities", entitiesByService);
 //            boolean isGenerateService = entitiesByService.stream().anyMatch(entity -> isGenerateEntity(entity));

zenwave-sdk-cli/src/main/java/io/zenwave360/sdk/plugins/ZdlToJsonPlugin.java

@@ -20,7 +20,8 @@ public ZdlToJsonPlugin() {
 
     @Override
     public Map<String, Object> process(Map<String, Object> contextModel) {
-        var zdl = contextModel.get("zdl");
+        var zdl = (Map)  contextModel.get("zdl");
+        zdl.remove("javaModel");
         ObjectMapper objectMapper = new ObjectMapper();
         try {
             var json = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(zdl);