Persist the fact that automated emails were sent so that they are not resent in the event of a server restart.

ocielliottc · ocielliottc · commit cecb12894f20 · 2024-10-16T10:23:01.000-05:00
diff --git a/server/src/main/java/com/objectcomputing/checkins/services/email/AutomatedEmail.java b/server/src/main/java/com/objectcomputing/checkins/services/email/AutomatedEmail.java
@@ -0,0 +1,41 @@
+package com.objectcomputing.checkins.services.email;
+
+import io.micronaut.data.annotation.TypeDef;
+import io.micronaut.data.model.DataType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+import jakarta.validation.constraints.NotNull;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
+
+import java.util.Objects;
+
+@Setter
+@Getter
+@Entity
+@AllArgsConstructor
+@Table(name = "automated_email_sent")
+public class AutomatedEmail {
+    @Id
+    @Column(name = "id")
+    @TypeDef(type = DataType.STRING)
+    @Schema(description = "id of the email")
+    private String id;
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AutomatedEmail email = (AutomatedEmail) o;
+        return id.equals(email.id);
+    }
+
+    @Override
+    public int hashCode() {
+        return id.hashCode();
+    }
+}
diff --git a/server/src/main/java/com/objectcomputing/checkins/services/email/AutomatedEmailRepository.java b/server/src/main/java/com/objectcomputing/checkins/services/email/AutomatedEmailRepository.java
@@ -0,0 +1,15 @@
+package com.objectcomputing.checkins.services.email;
+
+import io.micronaut.data.jdbc.annotation.JdbcRepository;
+import io.micronaut.data.model.query.builder.sql.Dialect;
+import io.micronaut.data.repository.CrudRepository;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+
+@JdbcRepository(dialect = Dialect.POSTGRES)
+public interface AutomatedEmailRepository extends CrudRepository<AutomatedEmail, String> {
+
+    @Override
+    <S extends AutomatedEmail> S save(@Valid @NotNull S entity);
+
+}
diff --git a/server/src/main/java/com/objectcomputing/checkins/services/pulse/PulseServicesImpl.java b/server/src/main/java/com/objectcomputing/checkins/services/pulse/PulseServicesImpl.java
@@ -6,6 +6,8 @@
 import com.objectcomputing.checkins.services.memberprofile.MemberProfileServices;
 import com.objectcomputing.checkins.services.settings.SettingsServices;
 import com.objectcomputing.checkins.services.settings.Setting;
+import com.objectcomputing.checkins.services.email.AutomatedEmail;
+import com.objectcomputing.checkins.services.email.AutomatedEmailRepository;
 import com.objectcomputing.checkins.exceptions.NotFoundException;
 
 import lombok.Getter;
@@ -20,6 +22,7 @@
 
 import java.util.Map;
 import java.util.HashMap;
+import java.util.Optional;
 import java.time.LocalDate;
 import java.time.DayOfWeek;
 import java.time.temporal.ChronoUnit;
@@ -39,7 +42,7 @@ private class Frequency {
   private final CheckInsConfiguration checkInsConfiguration;
   private final MemberProfileServices memberProfileServices;
   private final SettingsServices settingsServices;
-  private final Map<String, Boolean> sent = new HashMap<String, Boolean>();
+  private final AutomatedEmailRepository automatedEmailRepository;
 
   @Inject
   private PulseEmail email;
@@ -57,11 +60,13 @@ public PulseServicesImpl(
                     @Named(MailJetFactory.MJML_FORMAT) EmailSender emailSender,
                     CheckInsConfiguration checkInsConfiguration,
                     MemberProfileServices memberProfileServices,
-                    SettingsServices settingsServices) {
+                    SettingsServices settingsServices,
+                    AutomatedEmailRepository automatedEmailRepository) {
     this.emailSender = emailSender;
     this.checkInsConfiguration = checkInsConfiguration;
     this.memberProfileServices = memberProfileServices;
     this.settingsServices = settingsServices;
+    this.automatedEmailRepository = automatedEmailRepository;
   }
 
   public void sendPendingEmail(LocalDate check) {
@@ -89,16 +94,18 @@ public void sendPendingEmail(LocalDate check) {
       do {
         if (start.getDayOfMonth() == check.getDayOfMonth()) {
           LOG.info("Check day of month matches frequency day");
-          final String key = new StringBuilder(start.getMonth().toString())
+          final String key = new StringBuilder("pulse")
+                             .append(start.getMonth().toString())
                              .append("_")
                              .append(String.valueOf(start.getDayOfMonth()))
                              .toString();
-          if (sent.containsKey(key)) {
-            LOG.info("The Pulse Email has already been sent today");
-          } else {
+          Optional<AutomatedEmail> sent = automatedEmailRepository.findById(key);
+          if (sent.isEmpty()) {
             LOG.info("Sending Pulse Email");
             email.send();
-            sent.put(key, true);
+            automatedEmailRepository.save(new AutomatedEmail(key));
+          } else {
+            LOG.info("The Pulse Email has already been sent today");
           }
           break;
         }
diff --git a/server/src/main/java/com/objectcomputing/checkins/services/reviews/ReviewPeriodServicesImpl.java b/server/src/main/java/com/objectcomputing/checkins/services/reviews/ReviewPeriodServicesImpl.java
@@ -11,6 +11,8 @@
 import com.objectcomputing.checkins.services.feedback_request.FeedbackRequest;
 import com.objectcomputing.checkins.services.memberprofile.MemberProfileRepository;
 import com.objectcomputing.checkins.services.memberprofile.MemberProfile;
+import com.objectcomputing.checkins.services.email.AutomatedEmail;
+import com.objectcomputing.checkins.services.email.AutomatedEmailRepository;
 import io.micronaut.context.annotation.Value;
 import io.micronaut.context.env.Environment;
 import io.micronaut.core.io.Readable;
@@ -39,6 +41,7 @@ class ReviewPeriodServicesImpl implements ReviewPeriodServices {
 
     private static final Logger LOG = LoggerFactory.getLogger(ReviewPeriodServicesImpl.class);
 
+    private final AutomatedEmailRepository automatedEmailRepository;
     private final ReviewPeriodRepository reviewPeriodRepository;
     private final ReviewAssignmentRepository reviewAssignmentRepository;
     private final MemberProfileRepository memberProfileRepository;
@@ -50,7 +53,6 @@ class ReviewPeriodServicesImpl implements ReviewPeriodServices {
     private final String webAddress;
 
     private enum SelfReviewDate { LAUNCH, THREE_DAYS, ONE_DAY }
-    private final Map<String, Boolean> sent = new HashMap<>();
 
     @Value("classpath:mjml/supervisor_review_assignment.mjml")
     private Readable supervisorReviewAssignmentTemplate;
@@ -67,7 +69,8 @@ private enum SelfReviewDate { LAUNCH, THREE_DAYS, ONE_DAY }
                                     ReviewStatusTransitionValidator reviewStatusTransitionValidator,
                                     @Named(MailJetFactory.MJML_FORMAT) EmailSender emailSender,
                                     Environment environment,
-                                    CheckInsConfiguration checkInsConfiguration) {
+                                    CheckInsConfiguration checkInsConfiguration,
+                                    AutomatedEmailRepository automatedEmailRepository) {
         this.reviewPeriodRepository = reviewPeriodRepository;
         this.reviewAssignmentRepository = reviewAssignmentRepository;
         this.memberProfileRepository = memberProfileRepository;
@@ -77,6 +80,7 @@ private enum SelfReviewDate { LAUNCH, THREE_DAYS, ONE_DAY }
         this.emailSender = emailSender;
         this.environment = environment;
         this.webAddress = checkInsConfiguration.getWebAddress();
+        this.automatedEmailRepository = automatedEmailRepository;
     }
 
    void setEmailSender(EmailSender emailSender) {
@@ -364,8 +368,10 @@ public void sendNotifications(LocalDate today) {
             reviewPeriodRepository.findByReviewStatus(ReviewStatus.OPEN);
         for(ReviewPeriod openPeriod : openPeriods) {
             for(SelfReviewDate date : SelfReviewDate.values()) {
-                String key = openPeriod.getId().toString() + date.toString();
-                if (!sent.containsKey(key)) {
+                String key = "self_review_notification" +
+                             openPeriod.getId().toString() + date.toString();
+                Optional<AutomatedEmail> sent = automatedEmailRepository.findById(key);
+                if (sent.isEmpty()) {
                     LocalDateTime check;
                     switch(date) {
                         case SelfReviewDate.LAUNCH:
@@ -389,7 +395,7 @@ public void sendNotifications(LocalDate today) {
                     if (check != null) {
                         if (today.isEqual(check.toLocalDate())) {
                             sendSelfReviewEmail(openPeriod.getId(), date);
-                            sent.put(key, true);
+                            automatedEmailRepository.save(new AutomatedEmail(key));
                         }
                     }
                 }
diff --git a/server/src/main/resources/db/common/V114__create_automated_email_sent_table.sql b/server/src/main/resources/db/common/V114__create_automated_email_sent_table.sql
@@ -0,0 +1,4 @@
+drop table if exists automated_email_sent;
+CREATE TABLE automated_email_sent(
+   id varchar PRIMARY KEY
+);
