EVA-4054 Add call home end point and notify secondary emails on submission upload (#34)

Author: nitin-ebi

src/main/java/uk/ac/ebi/eva/submission/controller/callhome/CallHomeController.java

@@ -0,0 +1,25 @@
+package uk.ac.ebi.eva.submission.controller.callhome;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import uk.ac.ebi.eva.submission.service.CallHomeService;
+
+@RestController
+@RequestMapping("/v1/call-home")
+public class CallHomeController {
+    private final CallHomeService callHomeService;
+
+    public CallHomeController(CallHomeService callHomeService) {
+        this.callHomeService = callHomeService;
+    }
+
+    @PostMapping("/events")
+    public ResponseEntity<Void> ingest(@RequestBody JsonNode callHomeEventJson) {
+        callHomeService.registerCallHomeEvent(callHomeEventJson);
+        return ResponseEntity.ok().build();
+    }
+}

src/main/java/uk/ac/ebi/eva/submission/entity/CallHomeEventEntity.java

@@ -0,0 +1,127 @@
+package uk.ac.ebi.eva.submission.entity;
+
+import com.fasterxml.jackson.databind.JsonNode;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.Table;
+import java.time.LocalDateTime;
+
+@Entity
+@Table(schema = "eva_submissions", name = "call_home_event")
+public class CallHomeEventEntity {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(name = "deployment_id")
+    private String deploymentId;
+
+    @Column(name = "run_id")
+    private String runId;
+
+    @Column(name = "event_type")
+    private String eventType;
+
+    @Column(name = "cli_version")
+    private String cliVersion;
+
+    @Column(name = "created_at")
+    private LocalDateTime createdAt;
+
+    @Column(name = "runtime_seconds")
+    private Integer runtimeSeconds;
+
+    @Column(name = "executor")
+    private String executor;
+
+    @Column(name = "tasks")
+    private String tasks;
+
+    @Column(name = "raw_payload", columnDefinition = "jsonb", nullable = false)
+    private JsonNode rawPayload;
+
+    public CallHomeEventEntity() {
+    }
+
+    public Long getId() {
+        return id;
+    }
+
+    public String getDeploymentId() {
+        return deploymentId;
+    }
+
+    public void setDeploymentId(String deploymentId) {
+        this.deploymentId = deploymentId;
+    }
+
+    public String getRunId() {
+        return runId;
+    }
+
+    public void setRunId(String runId) {
+        this.runId = runId;
+    }
+
+    public String getEventType() {
+        return eventType;
+    }
+
+    public void setEventType(String eventType) {
+        this.eventType = eventType;
+    }
+
+    public String getCliVersion() {
+        return cliVersion;
+    }
+
+    public void setCliVersion(String cliVersion) {
+        this.cliVersion = cliVersion;
+    }
+
+    public LocalDateTime getCreatedAt() {
+        return createdAt;
+    }
+
+    public void setCreatedAt(LocalDateTime createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    public Integer getRuntimeSeconds() {
+        return runtimeSeconds;
+    }
+
+    public void setRuntimeSeconds(Integer runtimeSeconds) {
+        this.runtimeSeconds = runtimeSeconds;
+    }
+
+    public String getExecutor() {
+        return executor;
+    }
+
+    public void setExecutor(String executor) {
+        this.executor = executor;
+    }
+
+    public String getTasks() {
+        return tasks;
+    }
+
+    public void setTasks(String tasks) {
+        this.tasks = tasks;
+    }
+
+    public JsonNode getRawPayload() {
+        return rawPayload;
+    }
+
+    public void setRawPayload(JsonNode rawPayload) {
+        this.rawPayload = rawPayload;
+    }
+}
+

src/main/java/uk/ac/ebi/eva/submission/entity/SubmissionAccount.java

@@ -8,6 +8,7 @@
 import javax.persistence.Id;
 import javax.persistence.Table;
 import javax.persistence.UniqueConstraint;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
@@ -54,6 +55,7 @@ public SubmissionAccount(String userId, String loginType, String firstName, Stri
         this.firstName = firstName != null ? firstName : "";
         this.lastName = lastName != null ? lastName : "";
         this.primaryEmail = primaryEmail;
+        this.secondaryEmails = new ArrayList<>();
     }
 
     public SubmissionAccount(String userId, String loginType, String firstName, String lastName, String primaryEmail,

src/main/java/uk/ac/ebi/eva/submission/repository/CallHomeEventRepository.java

@@ -0,0 +1,7 @@
+package uk.ac.ebi.eva.submission.repository;
+
+import org.springframework.data.repository.CrudRepository;
+import uk.ac.ebi.eva.submission.entity.CallHomeEventEntity;
+
+public interface CallHomeEventRepository extends CrudRepository<CallHomeEventEntity, Long> {
+}

src/main/java/uk/ac/ebi/eva/submission/service/CallHomeService.java

@@ -0,0 +1,61 @@
+package uk.ac.ebi.eva.submission.service;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import org.springframework.stereotype.Service;
+import uk.ac.ebi.eva.submission.entity.CallHomeEventEntity;
+import uk.ac.ebi.eva.submission.repository.CallHomeEventRepository;
+
+import java.time.LocalDateTime;
+
+@Service
+public class CallHomeService {
+    private final CallHomeEventRepository callHomeEventRepository;
+
+    private static final ObjectMapper MAPPER = new ObjectMapper()
+            .registerModule(new JavaTimeModule());
+
+    public CallHomeService(CallHomeEventRepository callHomeEventRepository) {
+        this.callHomeEventRepository = callHomeEventRepository;
+    }
+
+    public void registerCallHomeEvent(JsonNode callHomeEventJson) {
+        CallHomeEventEntity callHomeEventEntity = getCallHomeEventEntity(callHomeEventJson);
+        callHomeEventRepository.save(callHomeEventEntity);
+    }
+
+    private CallHomeEventEntity getCallHomeEventEntity(JsonNode callHomeEventJson) {
+        CallHomeEventEntity callHomeEventEntity = new CallHomeEventEntity();
+
+        callHomeEventEntity.setDeploymentId(get(callHomeEventJson, "deploymentId", String.class));
+        callHomeEventEntity.setRunId(get(callHomeEventJson, "runId", String.class));
+        callHomeEventEntity.setEventType(get(callHomeEventJson, "eventType", String.class));
+        callHomeEventEntity.setCliVersion(get(callHomeEventJson, "cliVersion", String.class));
+        callHomeEventEntity.setCreatedAt(get(callHomeEventJson, "createdAt", LocalDateTime.class));
+        callHomeEventEntity.setRuntimeSeconds(get(callHomeEventJson, "runtimeSeconds", Integer.class));
+        callHomeEventEntity.setExecutor(get(callHomeEventJson, "executor", String.class));
+        callHomeEventEntity.setTasks(get(callHomeEventJson, "tasks", String.class));
+        callHomeEventEntity.setRawPayload(callHomeEventJson);
+
+        return callHomeEventEntity;
+    }
+
+    private <T> T get(JsonNode node, String field, Class<T> type) {
+        if (node == null || field == null) {
+            return null;
+        }
+
+        JsonNode v = node.get(field);
+        if (v == null || v.isNull()) {
+            return null;
+        }
+
+        try {
+            return MAPPER.convertValue(v, type);
+        } catch (IllegalArgumentException e) {
+            return null;
+        }
+    }
+
+}

src/main/java/uk/ac/ebi/eva/submission/service/SubmissionService.java

@@ -297,10 +297,11 @@ public void sendMailNotificationToUserForStatusUpdate(SubmissionAccount submissi
                                                           String projectTitle, SubmissionStatus submissionStatus,
                                                           boolean needConsentStatement, boolean deprecatedVersion, boolean success) {
         String sendTo = submissionAccount.getPrimaryEmail();
+        List<String> sendCC = submissionAccount.getSecondaryEmails();
         String subject = emailHelper.getSubjectForSubmissionStatusUpdate(submissionStatus, success);
         String body = emailHelper.getTextForSubmissionStatusUpdate(submissionAccount, submissionId, projectTitle,
                 submissionStatus, needConsentStatement, deprecatedVersion, success);
-        mailSender.sendEmail(emailHelper.getEvaHelpdeskEmail(), sendTo, subject, body);
+        mailSender.sendEmail(emailHelper.getEvaHelpdeskEmail(), sendTo, sendCC, subject, body);
     }
 
     public void sendMailNotificationToEVAHelpdeskForSubmissionUploaded(SubmissionAccount submissionAccount,

src/main/java/uk/ac/ebi/eva/submission/util/EmailNotificationHelper.java

@@ -94,7 +94,9 @@ public String getTextForEVAHelpdeskSubmissionUploaded(SubmissionAccount submissi
                 .addLineBreak()
                 .addText("User Name: " + getUserNameFromSubmissionAccountOrDefault(submissionAccount, "Not Set"))
                 .addLineBreak()
-                .addText("User Email: " + submissionAccount.getPrimaryEmail())
+                .addText("User Primary Email: " + submissionAccount.getPrimaryEmail())
+                .addLineBreak()
+                .addText("User Secondary Emails: " + String.join(", ", submissionAccount.getSecondaryEmails()))
                 .addGap(2)
                 .build();
 

src/main/java/uk/ac/ebi/eva/submission/util/MailSender.java

@@ -9,6 +9,8 @@
 
 import javax.mail.MessagingException;
 import javax.mail.internet.MimeMessage;
+import java.util.Collections;
+import java.util.List;
 
 @Component
 public class MailSender {
@@ -26,11 +28,18 @@ public void sendEmail(String to, String subject, String body) {
     }
 
     public void sendEmail(String from, String to, String subject, String body) {
+        sendEmail(from, to, Collections.emptyList(), subject, body);
+    }
+
+    public void sendEmail(String from, String to, List<String> ccList, String subject, String body) {
         MimeMessage message = javaMailSender.createMimeMessage();
         MimeMessageHelper helper = new MimeMessageHelper(message);
         try {
             helper.setFrom(from);
             helper.setTo(to);
+            if (ccList != null && !ccList.isEmpty()) {
+                helper.setCc(ccList.toArray(new String[0]));
+            }
             helper.setSubject(subject);
             helper.setText(body, true);
             javaMailSender.send(message);