feat: alert on low remaining contract days

README.md

@@ -37,6 +37,8 @@ ASA_CARE_PRODUCT_CODE=
 ASA_PAID_CARE_MISSION_CODES=
 SENSITIVE_WORKERS_CODES=
 MAX_LATENESS_REPORT=
+ACCOUNTANTS=
+LOW_REMAINING_DAYS_THRESHOLD=
 ```
 
 Then, run Spring Boot as usual,

src/main/java/school/hei/asa/endpoint/event/model/LowRemainingDaysAlertRequested.java

@@ -0,0 +1,31 @@
+package school.hei.asa.endpoint.event.model;
+
+import java.time.Duration;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder(toBuilder = true)
+@Data
+@EqualsAndHashCode(callSuper = false)
+@ToString
+public class LowRemainingDaysAlertRequested extends PojaEvent {
+
+  private String workerCode;
+  private int remainingDays;
+
+  @Override
+  public Duration maxConsumerDuration() {
+    return Duration.ofSeconds(45);
+  }
+
+  @Override
+  public Duration maxConsumerBackoffBetweenRetries() {
+    return Duration.ofSeconds(30);
+  }
+}

src/main/java/school/hei/asa/endpoint/rest/controller/CalendarController.java

@@ -27,6 +27,7 @@
 import school.hei.asa.model.Mission;
 import school.hei.asa.model.Worker;
 import school.hei.asa.service.CalendarService;
+import school.hei.asa.service.LowRemainingDaysAlertService;
 
 @AllArgsConstructor
 @Controller
@@ -35,6 +36,7 @@ public class CalendarController {
   private final CalendarService calendarService;
   private final WorkerFromAuthentication workerFromAuthentication;
   private final WorkerToModelAdder workerToModelAdder;
+  private final LowRemainingDaysAlertService lowRemainingDaysAlertService;
 
   @GetMapping("/work-and-care-calendar")
   public String getCalendar(
@@ -43,7 +45,6 @@ public String getCalendar(
       @RequestParam(required = false) String workerCode,
       @RequestParam(required = false) Integer year) {
     year = year == null ? now().getYear() : year;
-    model.addAttribute("year", year);
 
     var workerCodeOrAuth =
         workerCode == null || workerCode.isBlank()
@@ -66,7 +67,11 @@ public String getCalendar(
           missionCounts.put(month, typeCounts);
         });
     var lateReportedDaysByMonth = calendarService.lateReportedDaysByMonth(worker, year);
+    var warningBannerMessage =
+        lowRemainingDaysAlertService.verifyRemainingDaysAndBuildAlertMessage(worker).orElse(null);
 
+    model.addAttribute("year", year);
+    model.addAttribute("warningBannerMessage", warningBannerMessage);
     model.addAttribute("workerCode", workerCodeOrAuth);
     model.addAttribute("currentYear", now().getYear());
     model.addAttribute(

src/main/java/school/hei/asa/endpoint/rest/controller/DailyExecutionController.java

@@ -10,20 +10,28 @@
 import school.hei.asa.endpoint.rest.model.th.ThDailyExecutionForm;
 import school.hei.asa.endpoint.rest.security.WorkerFromAuthentication;
 import school.hei.asa.endpoint.rest.service.ThMissionService;
-import school.hei.asa.repository.DailyExecutionRepository;
+import school.hei.asa.service.DailyExecutionService;
+import school.hei.asa.service.LowRemainingDaysAlertService;
 
 @Controller
 @AllArgsConstructor
 public class DailyExecutionController {
   private final ThDailyExecutionFormMapper thDailyExecutionFormMapper;
-  private final DailyExecutionRepository dailyExecutionRepository;
+  private final DailyExecutionService dailyExecutionService;
   private final WorkerFromAuthentication workerFromAuthentication;
   private final ThMissionService thMissionService;
+  private final LowRemainingDaysAlertService lowRemainingDaysAlertService;
 
   @GetMapping("/daily-execution")
-  public String getDailyExecutionForm(Model model) {
+  public String getDailyExecutionForm(Model model, Authentication authentication) {
+    var worker = workerFromAuthentication.apply(authentication).get();
     var sortedMissions = thMissionService.sortedMissionsWithoutMissionExecution();
+    var warningBannerMessage =
+        lowRemainingDaysAlertService.verifyRemainingDaysAndBuildAlertMessage(worker).orElse(null);
+
     model.addAttribute("missions", sortedMissions);
+    model.addAttribute("warningBannerMessage", warningBannerMessage);
+
     return "daily-execution";
   }
 
@@ -32,7 +40,8 @@ public String createDailyExecution(Authentication authentication, ThDailyExecuti
     var worker = workerFromAuthentication.apply(authentication).get();
     var dailyExecution = thDailyExecutionFormMapper.toDomain(dmeForm, worker);
 
-    dailyExecutionRepository.save(dailyExecution);
+    dailyExecutionService.saveAndAlert(dailyExecution);
+
     return "redirect:/work-and-care-calendar";
   }
 }

src/main/java/school/hei/asa/number/DaysFormatter.java

@@ -0,0 +1,16 @@
+package school.hei.asa.number;
+
+import java.math.BigDecimal;
+
+public final class DaysFormatter {
+
+  private DaysFormatter() {}
+
+  public static String format(double days) {
+    var normalized = BigDecimal.valueOf(days).stripTrailingZeros();
+    if (normalized.scale() <= 0) {
+      return normalized.toBigInteger().toString();
+    }
+    return normalized.toPlainString();
+  }
+}

src/main/java/school/hei/asa/repository/ContractRepository.java

@@ -2,6 +2,7 @@
 
 import jakarta.transaction.Transactional;
 import java.util.List;
+import java.util.Optional;
 import lombok.AllArgsConstructor;
 import org.springframework.stereotype.Repository;
 import school.hei.asa.model.Worker;
@@ -25,6 +26,14 @@ public List<Contract> findAllByWorker(Worker worker) {
             workerMapper.toEntity(worker)));
   }
 
+  @Transactional
+  public Optional<Contract> findActiveContractByWorker(Worker worker) {
+    return jContractRepository
+        .findFirstByWorkerAndDurationInDaysIsNotNullOrderByEntranceInstantDesc(
+            workerMapper.toEntity(worker))
+        .map(jContract -> contractMapper.toDomain(List.of(jContract)).getFirst());
+  }
+
   public List<Contract> findAll() {
     return contractMapper.toDomain(jContractRepository.findAll());
   }

src/main/java/school/hei/asa/repository/DailyExecutionRepository.java

@@ -22,6 +22,7 @@
 @Repository
 public class DailyExecutionRepository {
 
+  private final ContractRepository contractRepository;
   private final MissionExecutionRepository missionExecutionRepository;
   private final JMissionExecutionRepository jMissionExecutionRepository;
   private final JWorkerRepository jWorkerRepository;
@@ -33,6 +34,9 @@ public class DailyExecutionRepository {
   @Transactional(isolation = SERIALIZABLE)
   public void save(DailyExecution dailyExecution) {
     var date = dailyExecution.date();
+    if (contractRepository.findActiveContractByWorker(dailyExecution.worker()).isEmpty()) {
+      throw new IllegalStateException("Unable to punch in : you have no active contract.");
+    }
     if (!missionExecutionRepository.findAllBy(dailyExecution.worker(), date).isEmpty()) {
       throw new IllegalArgumentException("Day already has MissionExecution: " + date);
     }

src/main/java/school/hei/asa/repository/jrepository/JContractRepository.java

@@ -1,6 +1,7 @@
 package school.hei.asa.repository.jrepository;
 
 import java.util.List;
+import java.util.Optional;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.stereotype.Repository;
@@ -25,4 +26,7 @@ public interface JContractRepository extends JpaRepository<JContract, String> {
 
   @Query("SELECT c FROM JContract c WHERE c.endInstant IS NULL AND c.durationInDays != 0")
   List<JContract> findActiveContracts();
+
+  Optional<JContract> findFirstByWorkerAndDurationInDaysIsNotNullOrderByEntranceInstantDesc(
+      JWorker jWorker);
 }

src/main/java/school/hei/asa/service/ContractService.java

@@ -1,6 +1,8 @@
 package school.hei.asa.service;
 
+import static java.time.ZoneId.systemDefault;
 import static java.util.Locale.FRENCH;
+import static java.util.Locale.US;
 import static school.hei.asa.model.DailyExecution.Type.fullCare;
 import static school.hei.asa.model.DailyExecution.Type.fullWork;
 
@@ -9,6 +11,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.stream.Collectors;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -49,6 +52,27 @@ public List<Contract> getAllContractsByWorker(Worker worker) {
     return contractRepository.findAllByWorker(worker);
   }
 
+  public Optional<Contract> findActiveContractByWorker(Worker worker) {
+    return contractRepository.findActiveContractByWorker(worker);
+  }
+
+  public double getRemainingDaysOnActiveContractOrZero(Worker worker) {
+    var activeContractOpt = findActiveContractByWorker(worker);
+    if (activeContractOpt.isEmpty()) {
+      return 0d;
+    }
+
+    var contract = activeContractOpt.get();
+    var startDate = contract.entranceInstant().atZone(systemDefault()).toLocalDate();
+    var endDate =
+        contract.endInstant() == null
+            ? LocalDate.now()
+            : contract.endInstant().atZone(systemDefault()).toLocalDate();
+    var actualWorkedDays = getActualWorkedDaysByDateByWorker(startDate, worker.code(), endDate);
+    var workedDays = actualWorkedDays.equals("-") ? 0d : Double.parseDouble(actualWorkedDays);
+    return contract.duration().toDays() - workedDays;
+  }
+
   public String getActualWorkedDaysByDateByWorker(
       LocalDate startDate, String workerCode, LocalDate endDate) {
     var dailyExecutions =
@@ -80,7 +104,7 @@ private String executedDays(List<DailyExecution> executions) {
                 })
             .reduce(Double::sum)
             .get();
-    return String.format("%.1f", result);
+    return String.format(US, "%.1f", result);
   }
 
   public List<Contract> findActiveContracts() {

src/main/java/school/hei/asa/service/DailyExecutionService.java

@@ -0,0 +1,18 @@
+package school.hei.asa.service;
+
+import lombok.AllArgsConstructor;
+import org.springframework.stereotype.Service;
+import school.hei.asa.model.DailyExecution;
+import school.hei.asa.repository.DailyExecutionRepository;
+
+@Service
+@AllArgsConstructor
+public class DailyExecutionService {
+  private final DailyExecutionRepository dailyExecutionRepository;
+  private final LowRemainingDaysAlertService lowRemainingDaysAlertService;
+
+  public void saveAndAlert(DailyExecution dailyExecution) {
+    dailyExecutionRepository.save(dailyExecution);
+    lowRemainingDaysAlertService.sendAlertEmailIfLowRemainingDays(dailyExecution.worker());
+  }
+}

src/main/java/school/hei/asa/service/LowRemainingDaysAlertService.java

@@ -0,0 +1,72 @@
+package school.hei.asa.service;
+
+import static java.util.Locale.US;
+
+import java.util.List;
+import java.util.Optional;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+import school.hei.asa.endpoint.event.EventProducer;
+import school.hei.asa.endpoint.event.model.LowRemainingDaysAlertRequested;
+import school.hei.asa.model.Worker;
+
+@Slf4j
+@Service
+public class LowRemainingDaysAlertService {
+
+  private final ContractService contractService;
+  private final EventProducer<LowRemainingDaysAlertRequested> eventProducer;
+  private final int lowRemainingDaysThreshold;
+
+  public LowRemainingDaysAlertService(
+      ContractService contractService,
+      EventProducer<LowRemainingDaysAlertRequested> eventProducer,
+      @Value("${LOW_REMAINING_DAYS_THRESHOLD}") int lowRemainingDaysThreshold) {
+    this.contractService = contractService;
+    this.eventProducer = eventProducer;
+    this.lowRemainingDaysThreshold = lowRemainingDaysThreshold;
+  }
+
+  public Optional<String> verifyRemainingDaysAndBuildAlertMessage(Worker worker) {
+    var remainingDays = contractService.getRemainingDaysOnActiveContractOrZero(worker);
+
+    if (remainingDays <= 0) {
+      return Optional.of(
+          "Please note : You do not have an active contract. Please contact your administrator.");
+    }
+
+    if (!isBelowThreshold(remainingDays)) {
+      return Optional.empty();
+    }
+
+    return Optional.of(
+        "Please note : You have " + formatDays(remainingDays) + " day(s) left on your contract !");
+  }
+
+  public void sendAlertEmailIfLowRemainingDays(Worker worker) {
+    var remainingDays = contractService.getRemainingDaysOnActiveContractOrZero(worker);
+
+    if (!isBelowThreshold(remainingDays)) {
+      return;
+    }
+
+    log.info("Requesting alert email to accountants for worker '{}'", worker.code());
+    eventProducer.accept(
+        List.of(
+            LowRemainingDaysAlertRequested.builder()
+                .workerCode(worker.code())
+                .remainingDays((int) remainingDays)
+                .build()));
+  }
+
+  private boolean isBelowThreshold(double remainingDays) {
+    return remainingDays > 0 && remainingDays < lowRemainingDaysThreshold;
+  }
+
+  private static String formatDays(double days) {
+    return days == Math.floor(days)
+        ? String.format(US, "%.0f", days)
+        : String.format(US, "%.1f", days);
+  }
+}