[DSM] PEPPER-1402 PEPPER-1397 refactoring DSM event transmission into DSS and retrying failed events

pepper-apis/ddp-common/pom.xml

@@ -143,5 +143,11 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>jakarta.validation</groupId>
+            <artifactId>jakarta.validation-api</artifactId>
+            <version>2.0.2</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 </project>

pepper-apis/dss-core/src/main/java/org/broadinstitute/ddp/model/dsm/DsmNotificationEventType.java → pepper-apis/ddp-common/src/main/java/org/broadinstitute/ddp/notficationevent/DsmNotificationEventType.java

@@ -1,4 +1,4 @@
-package org.broadinstitute.ddp.model.dsm;
+package org.broadinstitute.ddp.notficationevent;
 
 public enum DsmNotificationEventType {
     /**

pepper-apis/dss-core/src/main/java/org/broadinstitute/ddp/json/dsm/DsmNotificationPayload.java → pepper-apis/ddp-common/src/main/java/org/broadinstitute/ddp/notficationevent/DsmNotificationPayload.java

@@ -1,12 +1,10 @@
-package org.broadinstitute.ddp.json.dsm;
+package org.broadinstitute.ddp.notficationevent;
 
 import java.util.Optional;
 import javax.validation.constraints.NotBlank;
 
 import com.google.gson.JsonElement;
 import com.google.gson.annotations.SerializedName;
-import org.broadinstitute.ddp.model.dsm.DsmNotificationEventType;
-import org.broadinstitute.ddp.model.dsm.KitReasonType;
 
 public class DsmNotificationPayload {
 
@@ -39,6 +37,17 @@ public DsmNotificationPayload(String eventType, String kitRequestId, KitReasonTy
         this.kitReasonType = kitReasonType;
     }
 
+    /**
+     * Creates a new event to be sent to DSS.
+     * eventInfo could be ddpParticipantId for participant events, or ddpKitRequestId for kit events.
+     * **/
+    public DsmNotificationPayload(String eventType, long eventDate, KitReasonType kitReasonType, String eventInfo) {
+        this.eventType = eventType;
+        this.eventDate = eventDate;
+        this.eventInfo = eventInfo;
+        this.kitReasonType = kitReasonType;
+    }
+
     public String getEventType() {
         return eventType;
     }

pepper-apis/dss-core/src/main/java/org/broadinstitute/ddp/model/dsm/KitReasonType.java → pepper-apis/ddp-common/src/main/java/org/broadinstitute/ddp/notficationevent/KitReasonType.java

@@ -1,4 +1,4 @@
-package org.broadinstitute.ddp.model.dsm;
+package org.broadinstitute.ddp.notficationevent;
 
 /**
  * The reason of a kit. What each reason means and how it affects workflow will depend on the study's configuration.

pepper-apis/ddp-common/src/main/java/org/broadinstitute/ddp/util/LiquibaseUtil.java

@@ -10,7 +10,6 @@
 import java.util.List;
 
 import com.typesafe.config.Config;
-
 import com.zaxxer.hikari.HikariConfig;
 import com.zaxxer.hikari.HikariDataSource;
 import liquibase.Contexts;

pepper-apis/dsm-core/pom.xml

@@ -249,6 +249,11 @@
             <version>2.4.11</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>io.github.resilience4j</groupId>
+            <artifactId>resilience4j-retry</artifactId>
+            <version>2.2.0</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

pepper-apis/dsm-core/src/main/java/org/broadinstitute/dsm/DSMServer.java

@@ -98,10 +98,10 @@
 import org.broadinstitute.dsm.route.NDIRoute;
 import org.broadinstitute.dsm.route.OncHistoryTemplateRoute;
 import org.broadinstitute.dsm.route.OncHistoryUploadRoute;
-import org.broadinstitute.dsm.route.ParticipantEventRoute;
 import org.broadinstitute.dsm.route.ParticipantExitRoute;
 import org.broadinstitute.dsm.route.ParticipantStatusRoute;
 import org.broadinstitute.dsm.route.PatchRoute;
+import org.broadinstitute.dsm.route.SkippedParticipantEventRoute;
 import org.broadinstitute.dsm.route.TriggerSomaticResultSurveyRoute;
 import org.broadinstitute.dsm.route.TriggerSurveyRoute;
 import org.broadinstitute.dsm.route.UserSettingRoute;
@@ -136,13 +136,13 @@
 import org.broadinstitute.dsm.route.tag.cohort.DeleteCohortTagRoute;
 import org.broadinstitute.dsm.route.util.JacksonResponseTransformer;
 import org.broadinstitute.dsm.security.Auth0Util;
+import org.broadinstitute.dsm.service.EventService;
 import org.broadinstitute.dsm.service.FileDownloadService;
 import org.broadinstitute.dsm.service.SomaticResultUploadService;
 import org.broadinstitute.dsm.statics.ApplicationConfigConstants;
 import org.broadinstitute.dsm.statics.RequestParameter;
 import org.broadinstitute.dsm.statics.RoutePath;
 import org.broadinstitute.dsm.util.DSMConfig;
-import org.broadinstitute.dsm.util.EventUtil;
 import org.broadinstitute.dsm.util.JWTRouteFilter;
 import org.broadinstitute.dsm.util.JavaHeapDumper;
 import org.broadinstitute.dsm.util.JsonNullTransformer;
@@ -348,15 +348,17 @@ public static void createScheduleJob(@NonNull Scheduler scheduler, @NonNull Conf
     /**
      * Job to trigger ddp reminder emails and external shipper
      */
-    public static void createScheduleJob(@NonNull Scheduler scheduler, EventUtil eventUtil, NotificationUtil notificationUtil,
+    public static void createScheduleJob(@NonNull Scheduler scheduler, EventService eventService, NotificationUtil notificationUtil,
                                          @NonNull Class<? extends Job> jobClass, @NonNull String identity, @NonNull String cronExpression,
                                          @NonNull BasicTriggerListener basicTriggerListener) throws SchedulerException {
         //create job
         JobDetail job = JobBuilder.newJob(jobClass).withIdentity(identity, BasicTriggerListener.NO_CONCURRENCY_GROUP).build();
 
-        if (eventUtil != null) {
+        if (eventService != null) {
             //pass parameters to JobDataMap for JobDetail
-            job.getJobDataMap().put(EVENT_UTIL, eventUtil);
+            job.getJobDataMap().put(EVENT_UTIL, eventService);
+        } else {
+            logger.error("EventService is null, some jobs might not work properly");
         }
         if (notificationUtil != null) {
             //pass parameters to JobDataMap for JobDetail
@@ -686,8 +688,8 @@ protected void setupCustomRouting(@NonNull Config cfg) {
         //no GET for USER_SETTINGS_REQUEST because UI gets them per AuthenticationRoute
         patch(UI_ROOT + RoutePath.USER_SETTINGS_REQUEST, new UserSettingRoute(), new GsonResponseTransformer());
 
-        EventUtil eventUtil = new EventUtil();
-        scheduler = setupJobs(cfg, kitUtil, notificationUtil, eventUtil);
+        EventService eventService = new EventService();
+        scheduler = setupJobs(cfg, kitUtil, notificationUtil, eventService);
 
         //TODO - redo with pubsub
         JavaHeapDumper heapDumper = new JavaHeapDumper();
@@ -868,10 +870,10 @@ private void setupMiscellaneousRoutes() {
         get(UI_ROOT + RoutePath.EVENT_TYPES + RoutePath.ROUTE_SEPARATOR + RequestParameter.REALM, new EventTypeRoute(),
                 new GsonResponseTransformer());
 
-        ParticipantEventRoute participantEventRoute = new ParticipantEventRoute();
-        get(UI_ROOT + RoutePath.PARTICIPANT_EVENTS + RoutePath.ROUTE_SEPARATOR + RequestParameter.REALM, participantEventRoute,
+        SkippedParticipantEventRoute skippedParticipantEventRoute = new SkippedParticipantEventRoute();
+        get(UI_ROOT + RoutePath.PARTICIPANT_EVENTS + RoutePath.ROUTE_SEPARATOR + RequestParameter.REALM, skippedParticipantEventRoute,
                 new GsonResponseTransformer());
-        post(UI_ROOT + RoutePath.SKIP_PARTICIPANT_EVENTS, participantEventRoute, new GsonResponseTransformer());
+        post(UI_ROOT + RoutePath.SKIP_PARTICIPANT_EVENTS, skippedParticipantEventRoute, new GsonResponseTransformer());
 
         post(UI_ROOT + RoutePath.NDI_REQUEST, new NDIRoute(), new GsonResponseTransformer());
 
@@ -976,7 +978,7 @@ private void setupPubSubPublisherRoutes(Config config) {
     }
 
     private Scheduler setupJobs(@NonNull Config cfg, @NonNull KitUtil kitUtil, @NonNull NotificationUtil notificationUtil,
-                                @NonNull EventUtil eventUtil) {
+                                @NonNull EventService eventService) {
         String schedulerName = null;
         Scheduler scheduler = null;
         if (cfg.getBoolean(ApplicationConfigConstants.QUARTZ_ENABLE_JOBS)) {
@@ -997,7 +999,7 @@ private Scheduler setupJobs(@NonNull Config cfg, @NonNull KitUtil kitUtil, @NonN
                 createScheduleJob(scheduler, cfg, notificationUtil, kitUtil, GPNotificationJob.class, "GP_SCHEDULE_JOB",
                         cfg.getString(ApplicationConfigConstants.EMAIL_CRON_EXPRESSION_FOR_GP_NOTIFICATION));
 
-                createScheduleJob(scheduler, eventUtil, notificationUtil, DDPEventJob.class, "TRIGGER_DDP_EVENT",
+                createScheduleJob(scheduler, eventService, notificationUtil, DDPEventJob.class, "TRIGGER_DDP_EVENT",
                         cfg.getString(ApplicationConfigConstants.QUARTZ_CRON_EXPRESSION_FOR_DDP_EVENT_TRIGGER),
                         new DDPEventTriggerListener());
 

pepper-apis/dsm-core/src/main/java/org/broadinstitute/dsm/db/DDPInstance.java

@@ -154,7 +154,7 @@ public DDPInstance(int ddpInstanceId, String name) {
     public static DDPInstance getDDPInstance(@NonNull String realm) {
         SimpleResult results = inTransaction((conn) -> {
             SimpleResult dbVals = new SimpleResult();
-            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_ALL_ACTIVE_REALMS + QueryExtension.BY_INSTANCE_NAME)) {
+            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_ALL_ACTIVE_REALMS.concat(QueryExtension.BY_INSTANCE_NAME))) {
                 stmt.setString(1, realm);
                 try (ResultSet rs = stmt.executeQuery()) {
                     if (rs.next()) {
@@ -178,7 +178,7 @@ public static DDPInstance getDDPInstance(@NonNull String realm) {
     public static DDPInstance getDDPInstanceByGuid(@NonNull String studyGuid) {
         SimpleResult results = inTransaction(conn -> {
             SimpleResult dbVals = new SimpleResult();
-            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_ALL_ACTIVE_REALMS + QueryExtension.BY_STUDY_GUID)) {
+            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_ALL_ACTIVE_REALMS.concat(QueryExtension.BY_STUDY_GUID))) {
                 stmt.setString(1, studyGuid);
                 try (ResultSet rs = stmt.executeQuery()) {
                     if (rs.next()) {
@@ -200,7 +200,7 @@ public static DDPInstance getDDPInstanceByGuid(@NonNull String studyGuid) {
     public static DDPInstance getDDPInstanceById(@NonNull Integer ddpInstanceId) {
         SimpleResult results = inTransaction((conn) -> {
             SimpleResult dbVals = new SimpleResult();
-            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_ALL_ACTIVE_REALMS + QueryExtension.BY_INSTANCE_ID)) {
+            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_ALL_ACTIVE_REALMS.concat(QueryExtension.BY_INSTANCE_ID))) {
                 stmt.setInt(1, ddpInstanceId);
                 try (ResultSet rs = stmt.executeQuery()) {
                     if (rs.next()) {
@@ -258,7 +258,7 @@ public static DDPInstance getDDPInstanceWithRole(@NonNull String realm, @NonNull
     // and by Covid19OrderRegistrar
     public static DDPInstance getDDPInstanceWithRole(@NonNull String realm, @NonNull String role, Connection conn) {
         SimpleResult dbVals = new SimpleResult();
-        try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_INSTANCE_WITH_ROLE + QueryExtension.BY_INSTANCE_NAME)) {
+        try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_INSTANCE_WITH_ROLE.concat(QueryExtension.BY_INSTANCE_NAME))) {
             stmt.setString(1, role);
             stmt.setString(2, realm);
             try (ResultSet rs = stmt.executeQuery()) {
@@ -276,7 +276,7 @@ public static DDPInstance getDDPInstanceWithRole(@NonNull String realm, @NonNull
     public static DDPInstance getDDPInstanceWithRoleByStudyGuid(@NonNull String studyGuid, @NonNull String role) {
         SimpleResult results = inTransaction((conn) -> {
             SimpleResult dbVals = new SimpleResult();
-            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_INSTANCE_WITH_ROLE + QueryExtension.BY_STUDY_GUID)) {
+            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_INSTANCE_WITH_ROLE.concat(QueryExtension.BY_STUDY_GUID))) {
                 stmt.setString(1, role);
                 stmt.setString(2, studyGuid);
                 try (ResultSet rs = stmt.executeQuery()) {
@@ -404,31 +404,6 @@ public static DDPInstance getDDPInstanceWithRoleByParticipant(@NonNull String pa
         return (DDPInstance) results.resultValue;
     }
 
-    public static boolean getRole(@NonNull String realm, @NonNull String role) {
-        SimpleResult results = inTransaction((conn) -> {
-            SimpleResult dbVals = new SimpleResult();
-            try (PreparedStatement stmt = conn.prepareStatement(SQL_SELECT_INSTANCE_WITH_ROLE + QueryExtension.BY_INSTANCE_NAME)) {
-                stmt.setString(1, role);
-                stmt.setString(2, realm);
-                try (ResultSet rs = stmt.executeQuery()) {
-                    if (rs.next()) {
-                        dbVals.resultValue = rs.getBoolean(DBConstants.HAS_ROLE);
-                    }
-                } catch (SQLException e) {
-                    throw new RuntimeException("Error getting role of realm " + realm, e);
-                }
-            } catch (SQLException ex) {
-                dbVals.resultException = ex;
-            }
-            return dbVals;
-        });
-
-        if (results.resultException != null) {
-            throw new RuntimeException("Couldn't get role of realm " + realm, results.resultException);
-        }
-        return (boolean) results.resultValue;
-    }
-
     public static DDPInstance getDDPInstanceWithRoleFormResultSet(@NonNull ResultSet rs) throws SQLException {
         String notificationRecipient = rs.getString(DBConstants.NOTIFICATION_RECIPIENT);
         List<String> recipients = null;
@@ -536,8 +511,9 @@ public static DDPInstance from(DDPInstanceDto ddpInstanceDto) {
                 .withCollaboratorIdPrefix(ddpInstanceDto.getCollaboratorIdPrefix())
                 .withDaysMrAttentionNeeded(ddpInstanceDto.getMrAttentionFlagD())
                 .withDaysTissueAttentionNeeded(ddpInstanceDto.getTissueAttentionFlagD())
-                .withHasAuth0Token(ddpInstanceDto.getAuth0Token() != null)
-                .withNotificationRecipient(ddpInstanceDto.getNotificationRecipients())
+                .withHasAuth0Token(ddpInstanceDto.getAuth0Token() != null && ddpInstanceDto.getAuth0Token())
+                .withNotificationRecipient(ddpInstanceDto.getNotificationRecipients().isEmpty()
+                        ? null : ddpInstanceDto.getNotificationRecipients())
                 .withBillingReference(ddpInstanceDto.getBillingReference())
                 .withParticipantIndexES(ddpInstanceDto.getEsParticipantIndex())
                 .withActivityDefinitionIndexES(ddpInstanceDto.getEsActivityDefinitionIndex())

pepper-apis/dsm-core/src/main/java/org/broadinstitute/dsm/db/KitRequestShipping.java

@@ -203,7 +203,7 @@ public class KitRequestShipping extends KitRequest implements HasDdpInstanceId {
     private static final String ERROR = "error";
     private static final String SENT = "sent";
     private static final String RECEIVED = "received";
-    private static final String OVERVIEW = "overview";
+    public static final String OVERVIEW = "overview";
     private static final String DEACTIVATED = "deactivated";
     private static final String TRIGGERED = "triggered";
     private static final String WAITING = "waiting";