feature(#528): usertask notifications (#539)

closes #528 **Changes** - create usertask notification api
Miragon · Feb 14, 2025 · 3707515 · 3707515
1 parent aecc131
commit 3707515
Show file tree

Hide file tree

Showing 40 changed files with 587 additions and 44 deletions.
diff --git a/.run/MiranumPlatformSDU.run.xml b/.run/MiranumPlatformSDU.run.xml
@@ -10,7 +10,7 @@
       <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" />
       <ENTRIES>
         <ENTRY IS_ENABLED="true" PARSER="runconfig" IS_EXECUTABLE="false" />
-        <ENTRY IS_ENABLED="true" PARSER="env" IS_EXECUTABLE="false" PATH="examples/single-deployment-unit-example/single-deployment-stack/.env" />
+        <ENTRY IS_ENABLED="true" PARSER="env" IS_EXECUTABLE="false" PATH="examples/stack/.env" />
       </ENTRIES>
     </extension>
     <method v="2">

diff --git a/examples/single-deployment-unit-example/pom.xml b/examples/single-deployment-unit-example/pom.xml
@@ -26,6 +26,10 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jpa</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-mail</artifactId>
+        </dependency>
 
         <!-- Camunda -->
         <dependency>
@@ -75,6 +79,11 @@
             <artifactId>miranum-engine-deployment</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.miragon.miranum</groupId>
+            <artifactId>miranum-engine-user</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>io.miragon.miranum</groupId>
             <artifactId>miranum-deployment-server-embedded-starter</artifactId>

diff --git a/...a/io/miragon/miranum/platform/example/adapter/in/miranum/UsertaskNotificationAdapter.java b/...a/io/miragon/miranum/platform/example/adapter/in/miranum/UsertaskNotificationAdapter.java
@@ -0,0 +1,47 @@
+package io.miragon.miranum.platform.example.adapter.in.miranum;
+
+import io.miragon.miranum.platform.example.application.domain.Notification;
+import io.miragon.miranum.platform.example.application.port.in.NotificationInPort;
+import io.miragon.miranum.platform.tasklist.application.port.out.task.TaskNotificationOutPort;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.camunda.bpm.engine.delegate.DelegateTask;
+import org.springframework.stereotype.Component;
+
+import java.util.List;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class UsertaskNotificationAdapter implements TaskNotificationOutPort {
+
+    private final NotificationInPort notificationInPort;
+
+    @Override
+    public void notifyAssignee(final String assignee, final String eventName, final DelegateTask task) {
+        // example implementation
+        notificationInPort.notifyUsers(List.of(assignee), Notification.builder()
+            .eventName(eventName)
+            .taskName(task.getName())
+            .build());
+    }
+
+    @Override
+    public void notifyCandidateUsers(final List<String> candidateUsers, final String eventName, final DelegateTask task) {
+        // example implementation
+        notificationInPort.notifyUsers(candidateUsers, Notification.builder()
+                .eventName(eventName)
+                .taskName(task.getName())
+                .build());
+    }
+
+    @Override
+    public void notifyCandidateGroups(final List<String> candidateGroups, final String eventName, final DelegateTask task) {
+        // example implementation
+        notificationInPort.notifyGroup(candidateGroups, Notification.builder()
+                .eventName(eventName)
+                .taskName(task.getName())
+                .build());
+    }
+
+}
diff --git a/...ple/src/main/java/io/miragon/miranum/platform/example/adapter/out/email/EmailAdapter.java b/...ple/src/main/java/io/miragon/miranum/platform/example/adapter/out/email/EmailAdapter.java
@@ -0,0 +1,52 @@
+package io.miragon.miranum.platform.example.adapter.out.email;
+
+import io.miragon.miranum.platform.example.application.domain.SendNotification;
+import io.miragon.miranum.platform.example.application.port.out.SendNotificationOutPort;
+import jakarta.mail.Message;
+import jakarta.mail.MessagingException;
+import jakarta.mail.internet.InternetAddress;
+import jakarta.mail.internet.MimeMessage;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.mail.javamail.JavaMailSender;
+import org.springframework.mail.javamail.JavaMailSenderImpl;
+import org.springframework.stereotype.Component;
+
+import java.util.Properties;
+
+@Slf4j
+@Component
+public class EmailAdapter implements SendNotificationOutPort {
+
+    private final JavaMailSender mailSender;
+
+    public EmailAdapter() throws jakarta.mail.MessagingException {
+        final JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
+
+        final int timeout = 30000; // 30 seconds
+        Properties properties = mailSender.getJavaMailProperties();
+        properties.put("mail.smtp.connectiontimeout", timeout);
+        properties.put("mail.smtp.timeout", timeout);
+        properties.put("mail.smtp.writetimeout", timeout);
+
+        mailSender.testConnection();
+
+        this.mailSender = mailSender;
+    }
+
+
+    @Override
+    public void notify(final SendNotification sendNotification) {
+        try {
+            final MimeMessage mimeMessage = this.mailSender.createMimeMessage();
+
+            mimeMessage.setFrom(new InternetAddress("[email protected]"));
+            mimeMessage.setRecipients(Message.RecipientType.TO, InternetAddress.parse(String.join(",", sendNotification.receivers())));
+            mimeMessage.setSubject(sendNotification.subject());
+            mimeMessage.setText(sendNotification.body());
+
+            this.mailSender.send(mimeMessage);
+        } catch (final MessagingException e) {
+            log.error("Error sending email", e);
+        }
+    }
+}
diff --git a/...ain/java/io/miragon/miranum/platform/example/application/UsertaskNotificationUseCase.java b/...ain/java/io/miragon/miranum/platform/example/application/UsertaskNotificationUseCase.java
@@ -0,0 +1,55 @@
+package io.miragon.miranum.platform.example.application;
+
+import io.miragon.miranum.platform.example.application.domain.Notification;
+import io.miragon.miranum.platform.example.application.domain.SendNotification;
+import io.miragon.miranum.platform.example.application.port.in.NotificationInPort;
+import io.miragon.miranum.platform.example.application.port.out.SendNotificationOutPort;
+import io.miragon.miranum.platform.user.application.port.in.UserApi;
+import io.miragon.miranum.platform.user.domain.User;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@Component
+@RequiredArgsConstructor
+public class UsertaskNotificationUseCase implements NotificationInPort {
+
+    private final SendNotificationOutPort sendNotificationOutPort;
+    private final UserApi userApi;
+
+    @Override
+    public void notifyUsers(final List<String> users, final Notification notification) {
+        // don't send notification for create and complete events
+        if(notification.getEventName().equalsIgnoreCase("create") || notification.getEventName().equalsIgnoreCase("complete")) {
+            return;
+        }
+
+        final List<User> receivers = new ArrayList<>();
+        users.forEach(user -> receivers.add(userApi.getUserByUserName(user)));
+
+        sendNotificationOutPort.notify(SendNotification.builder()
+            .receivers(receivers.stream().map(User::getEmail).toList())
+            .subject(notification.getTitle())
+            .body(notification.getMessage())
+            .build());
+    }
+
+    @Override
+    public void notifyGroup(final List<String> groups, final Notification notification) {
+        // don't send notification for assignment events
+        if (notification.getEventName().equalsIgnoreCase("assignment")) {
+            return;
+        }
+
+        final List<User> receivers = new ArrayList<>();
+        groups.forEach(group -> receivers.addAll(userApi.getUsersByGroup(group)));
+
+        sendNotificationOutPort.notify(SendNotification.builder()
+            .receivers(receivers.stream().map(User::getEmail).toList())
+            .subject(notification.getTitle())
+            .body(notification.getMessage())
+            .build());
+    }
+}
diff --git a/...le/src/main/java/io/miragon/miranum/platform/example/application/domain/Notification.java b/...le/src/main/java/io/miragon/miranum/platform/example/application/domain/Notification.java
@@ -0,0 +1,25 @@
+package io.miragon.miranum.platform.example.application.domain;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Getter
+@Builder
+public class Notification {
+
+    private String eventName;
+    private String taskName;
+
+    public String getTitle() {
+        return eventName.equalsIgnoreCase("create") || eventName.equalsIgnoreCase("assignment") ?
+                String.format("Task %s was assigned to you", taskName) :
+                String.format("Task %s was completed", taskName);
+    }
+
+    public String getMessage() {
+        return eventName.equalsIgnoreCase("create") || eventName.equalsIgnoreCase("assignment") ?
+                "You have a new Task":
+                "Task was completed";
+    }
+
+}
diff --git a/...rc/main/java/io/miragon/miranum/platform/example/application/domain/SendNotification.java b/...rc/main/java/io/miragon/miranum/platform/example/application/domain/SendNotification.java
@@ -0,0 +1,12 @@
+package io.miragon.miranum.platform.example.application.domain;
+
+import lombok.Builder;
+
+import java.util.List;
+
+@Builder
+public record SendNotification(
+    List<String> receivers,
+    String subject,
+    String body
+) { }
diff --git a/...main/java/io/miragon/miranum/platform/example/application/port/in/NotificationInPort.java b/...main/java/io/miragon/miranum/platform/example/application/port/in/NotificationInPort.java
@@ -0,0 +1,13 @@
+package io.miragon.miranum.platform.example.application.port.in;
+
+import io.miragon.miranum.platform.example.application.domain.Notification;
+
+import java.util.List;
+
+public interface NotificationInPort {
+
+    void notifyUsers(final List<String> users, final Notification notification);
+
+    void notifyGroup(final List<String> groups, final Notification notification);
+
+}
diff --git a/...ava/io/miragon/miranum/platform/example/application/port/out/SendNotificationOutPort.java b/...ava/io/miragon/miranum/platform/example/application/port/out/SendNotificationOutPort.java
@@ -0,0 +1,9 @@
+package io.miragon.miranum.platform.example.application.port.out;
+
+import io.miragon.miranum.platform.example.application.domain.SendNotification;
+
+public interface SendNotificationOutPort {
+
+    void notify(final SendNotification sendNotification);
+
+}
diff --git a/.../main/java/io/miragon/miranum/platform/example/shared/security/SecurityConfiguration.java b/.../main/java/io/miragon/miranum/platform/example/shared/security/SecurityConfiguration.java
@@ -1,11 +1,11 @@
 package io.miragon.miranum.platform.example.shared.security;
 
-import io.miragon.miranum.platform.example.engine.sso.GrantedAuthoritiesExtractor;
-import io.miragon.miranum.platform.example.engine.sso.TokenParsingOAuth2UserService;
-import io.miragon.miranum.platform.example.engine.sso.TokenParsingOidcUserService;
-import io.miragon.miranum.platform.example.engine.sso.rest.RestExceptionHandler;
-import io.miragon.miranum.platform.example.engine.sso.webapp.OAuthContainerBasedAuthenticationProvider;
-import io.miragon.miranum.platform.example.engine.sso.webapp.OAuthLogoutHandler;
+import io.miragon.miranum.platform.example.shared.sso.GrantedAuthoritiesExtractor;
+import io.miragon.miranum.platform.example.shared.sso.TokenParsingOAuth2UserService;
+import io.miragon.miranum.platform.example.shared.sso.TokenParsingOidcUserService;
+import io.miragon.miranum.platform.example.shared.sso.rest.RestExceptionHandler;
+import io.miragon.miranum.platform.example.shared.sso.webapp.OAuthContainerBasedAuthenticationProvider;
+import io.miragon.miranum.platform.example.shared.sso.webapp.OAuthLogoutHandler;
 import jakarta.annotation.PostConstruct;
 import jakarta.servlet.DispatcherType;
 import lombok.RequiredArgsConstructor;

diff --git a/...ndaAuthenticationFilterConfiguration.java → ...ndaAuthenticationFilterConfiguration.java b/...ndaAuthenticationFilterConfiguration.java → ...ndaAuthenticationFilterConfiguration.java
@@ -1,8 +1,8 @@
 
 
-package io.miragon.miranum.platform.example.engine.sso;
+package io.miragon.miranum.platform.example.shared.sso;
 
-import io.miragon.miranum.platform.example.engine.sso.rest.ServiceAccountAuthenticationProvider;
+import io.miragon.miranum.platform.example.shared.sso.rest.ServiceAccountAuthenticationProvider;
 import org.camunda.bpm.engine.IdentityService;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.context.annotation.Bean;

diff --git a/.../sso/CamundaUserAuthenticationFilter.java → .../sso/CamundaUserAuthenticationFilter.java b/.../sso/CamundaUserAuthenticationFilter.java → .../sso/CamundaUserAuthenticationFilter.java
@@ -1,6 +1,6 @@
-package io.miragon.miranum.platform.example.engine.sso;
+package io.miragon.miranum.platform.example.shared.sso;
 
-import io.miragon.miranum.platform.example.engine.sso.rest.ServiceAccountAuthenticationProvider;
+import io.miragon.miranum.platform.example.shared.sso.rest.ServiceAccountAuthenticationProvider;
 import jakarta.servlet.*;
 import org.camunda.bpm.engine.IdentityService;
 

diff --git a/...gine/sso/GrantedAuthoritiesExtractor.java → ...ared/sso/GrantedAuthoritiesExtractor.java b/...gine/sso/GrantedAuthoritiesExtractor.java → ...ared/sso/GrantedAuthoritiesExtractor.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso;
+package io.miragon.miranum.platform.example.shared.sso;
 
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Value;
@@ -11,7 +11,6 @@
 import org.springframework.security.oauth2.jwt.Jwt;
 import org.springframework.security.oauth2.server.resource.authentication.JwtAuthenticationToken;
 import org.springframework.stereotype.Component;
-import org.springframework.util.Assert;
 
 import java.security.Principal;
 import java.util.*;

diff --git a/...ne/sso/TokenParsingOAuth2UserService.java → ...ed/sso/TokenParsingOAuth2UserService.java b/...ne/sso/TokenParsingOAuth2UserService.java → ...ed/sso/TokenParsingOAuth2UserService.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso;
+package io.miragon.miranum.platform.example.shared.sso;
 
 import org.springframework.security.oauth2.client.registration.ClientRegistration;
 import org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest;

diff --git a/...gine/sso/TokenParsingOidcUserService.java → ...ared/sso/TokenParsingOidcUserService.java b/...gine/sso/TokenParsingOidcUserService.java → ...ared/sso/TokenParsingOidcUserService.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso;
+package io.miragon.miranum.platform.example.shared.sso;
 
 import org.springframework.security.oauth2.client.oidc.userinfo.OidcUserRequest;
 import org.springframework.security.oauth2.client.userinfo.OAuth2UserService;

diff --git a/...e/sso/init/AuthenticationInitializer.java → ...d/sso/init/AuthenticationInitializer.java b/...e/sso/init/AuthenticationInitializer.java → ...d/sso/init/AuthenticationInitializer.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso.init;
+package io.miragon.miranum.platform.example.shared.sso.init;
 
 import org.camunda.bpm.engine.AuthorizationService;
 import org.springframework.beans.factory.annotation.Value;
@@ -46,5 +46,5 @@ public AuthenticationInitializer(
         AuthorizationHelper.setupGroupDeploymentPermissions(authorizationService, workerRole);
 
     }
-    
+
 }
diff --git a/.../engine/sso/init/AuthorizationHelper.java → .../shared/sso/init/AuthorizationHelper.java b/.../engine/sso/init/AuthorizationHelper.java → .../shared/sso/init/AuthorizationHelper.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso.init;
+package io.miragon.miranum.platform.example.shared.sso.init;
 
 import lombok.extern.slf4j.Slf4j;
 import org.camunda.bpm.engine.AuthorizationService;

diff --git a/...engine/sso/rest/RestExceptionHandler.java → ...shared/sso/rest/RestExceptionHandler.java b/...engine/sso/rest/RestExceptionHandler.java → ...shared/sso/rest/RestExceptionHandler.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso.rest;
+package io.miragon.miranum.platform.example.shared.sso.rest;
 
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;

diff --git a/...ServiceAccountAuthenticationProvider.java → ...ServiceAccountAuthenticationProvider.java b/...ServiceAccountAuthenticationProvider.java → ...ServiceAccountAuthenticationProvider.java
@@ -1,6 +1,6 @@
 
 
-package io.miragon.miranum.platform.example.engine.sso.rest;
+package io.miragon.miranum.platform.example.shared.sso.rest;
 
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.security.authentication.AbstractAuthenticationToken;
@@ -10,9 +10,12 @@
 import org.springframework.security.oauth2.jwt.Jwt;
 import org.springframework.stereotype.Component;
 
-import java.util.*;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
 
-import static io.miragon.miranum.platform.example.engine.sso.GrantedAuthoritiesExtractor.SPRING_ROLE_PREFIX;
+import static io.miragon.miranum.platform.example.shared.sso.GrantedAuthoritiesExtractor.SPRING_ROLE_PREFIX;
 
 /**
  * User authentication provider.

diff --git a/...ContainerBasedAuthenticationProvider.java → ...ContainerBasedAuthenticationProvider.java b/...ContainerBasedAuthenticationProvider.java → ...ContainerBasedAuthenticationProvider.java
@@ -1,6 +1,6 @@
-package io.miragon.miranum.platform.example.engine.sso.webapp;
+package io.miragon.miranum.platform.example.shared.sso.webapp;
 
-import io.miragon.miranum.platform.example.engine.sso.GrantedAuthoritiesExtractor;
+import io.miragon.miranum.platform.example.shared.sso.GrantedAuthoritiesExtractor;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import org.camunda.bpm.engine.ProcessEngine;

diff --git a/.../webapp/OAuthIdentityServiceProvider.java → .../webapp/OAuthIdentityServiceProvider.java b/.../webapp/OAuthIdentityServiceProvider.java → .../webapp/OAuthIdentityServiceProvider.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso.webapp;
+package io.miragon.miranum.platform.example.shared.sso.webapp;
 
 import org.apache.commons.lang3.StringUtils;
 import org.camunda.bpm.engine.identity.*;
@@ -21,7 +21,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-import static io.miragon.miranum.platform.example.engine.sso.GrantedAuthoritiesExtractor.SPRING_ROLE_PREFIX;
+import static io.miragon.miranum.platform.example.shared.sso.GrantedAuthoritiesExtractor.SPRING_ROLE_PREFIX;
 import static java.util.stream.Collectors.toList;
 
 /**

diff --git a/...engine/sso/webapp/OAuthLogoutHandler.java → ...shared/sso/webapp/OAuthLogoutHandler.java b/...engine/sso/webapp/OAuthLogoutHandler.java → ...shared/sso/webapp/OAuthLogoutHandler.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso.webapp;
+package io.miragon.miranum.platform.example.shared.sso.webapp;
 
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;

diff --git a/...eadOnlyIdentityProviderConfiguration.java → ...eadOnlyIdentityProviderConfiguration.java b/...eadOnlyIdentityProviderConfiguration.java → ...eadOnlyIdentityProviderConfiguration.java
@@ -1,4 +1,4 @@
-package io.miragon.miranum.platform.example.engine.sso.webapp;
+package io.miragon.miranum.platform.example.shared.sso.webapp;
 
 import org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl;
 import org.camunda.bpm.engine.impl.persistence.GenericManagerFactory;