Merge pull request #297 from bcgov/feature/GRAD2-2430

GRAD2-2430: task is complete.

api/src/main/java/ca/bc/gov/educ/api/trax/repository/EventRepository.java

@@ -2,8 +2,12 @@
 
 import ca.bc.gov.educ.api.trax.model.entity.Event;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Modifying;
+import org.springframework.data.jpa.repository.Query;
 import org.springframework.stereotype.Repository;
+import org.springframework.transaction.annotation.Transactional;
 
+import java.time.LocalDateTime;
 import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
@@ -15,4 +19,9 @@ public interface EventRepository extends JpaRepository<Event, UUID> {
 
     List<Event> findAllByEventStatusOrderByCreateDate(String eventStatus);
 
+    @Transactional
+    @Modifying
+    @Query("delete from Event where createDate <= :createDate")
+    void deleteByCreateDateBefore(LocalDateTime createDate);
+
 }

api/src/main/java/ca/bc/gov/educ/api/trax/repository/TraxUpdatedPubEventRepository.java

@@ -1,10 +1,12 @@
 package ca.bc.gov.educ.api.trax.repository;
 
 import ca.bc.gov.educ.api.trax.model.entity.TraxUpdatedPubEvent;
-import org.springframework.data.domain.Pageable;
-import org.springframework.data.domain.Slice;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Modifying;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.transaction.annotation.Transactional;
 
+import java.time.LocalDateTime;
 import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
@@ -38,4 +40,9 @@ public interface TraxUpdatedPubEventRepository extends JpaRepository<TraxUpdated
    */
   List<TraxUpdatedPubEvent> findByEventStatusOrderByCreateDate(String eventStatus);
 
+  @Transactional
+  @Modifying
+  @Query("delete from TraxUpdatedPubEvent where createDate <= :createDate")
+  void deleteByCreateDateBefore(LocalDateTime createDate);
+
 }

api/src/main/java/ca/bc/gov/educ/api/trax/scheduler/PurgeOldRecordsScheduler.java

@@ -0,0 +1,46 @@
+package ca.bc.gov.educ.api.trax.scheduler;
+
+import ca.bc.gov.educ.api.trax.repository.EventRepository;
+import ca.bc.gov.educ.api.trax.repository.TraxUpdatedPubEventRepository;
+import ca.bc.gov.educ.api.trax.util.EducGradTraxApiConstants;
+import jakarta.transaction.Transactional;
+import lombok.extern.slf4j.Slf4j;
+import net.javacrumbs.shedlock.core.LockAssert;
+import net.javacrumbs.shedlock.spring.annotation.SchedulerLock;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+import java.time.LocalDateTime;
+
+@Component
+@Slf4j
+public class PurgeOldRecordsScheduler {
+
+    private final EventRepository eventRepository;
+    private final TraxUpdatedPubEventRepository traxUpdatedPubEventRepository;
+    private final EducGradTraxApiConstants constants;
+
+    public PurgeOldRecordsScheduler(final EventRepository eventRepository,
+                                    final TraxUpdatedPubEventRepository traxUpdatedPubEventRepository,
+                                    final EducGradTraxApiConstants constants) {
+        this.eventRepository = eventRepository;
+        this.traxUpdatedPubEventRepository = traxUpdatedPubEventRepository;
+        this.constants = constants;
+    }
+
+    @Scheduled(cron = "${cron.scheduled.process.purge-old-records.run}")
+    @SchedulerLock(name = "PurgeOldRecordsLock",
+            lockAtLeastFor = "PT1H", lockAtMostFor = "PT1H") //midnight job so lock for an hour
+    @Transactional
+    public void purgeOldRecords() {
+        LockAssert.assertLocked();
+        final LocalDateTime createDateToCompare = this.calculateCreateDateBasedOnStaleEventInDays();
+        this.eventRepository.deleteByCreateDateBefore(createDateToCompare);
+        this.traxUpdatedPubEventRepository.deleteByCreateDateBefore(createDateToCompare);
+    }
+
+    private LocalDateTime calculateCreateDateBasedOnStaleEventInDays() {
+        final LocalDateTime currentTime = LocalDateTime.now();
+        return currentTime.minusDays(this.constants.getRecordsStaleInDays());
+    }
+}

api/src/main/java/ca/bc/gov/educ/api/trax/util/EducGradTraxApiConstants.java

@@ -169,4 +169,7 @@ public class EducGradTraxApiConstants {
     @Value("${cron.scheduled.process.trigger-jobs.read-trax-update.threshold}")
     private int traxTriggersProcessingThreshold;
 
+    @Value("${cron.scheduled.process.purge-old-records.staleInDays}")
+    private int recordsStaleInDays;
+
 }

api/src/main/resources/application.yaml

@@ -131,6 +131,9 @@ cron:
           lockAtLeastFor: ${CRON_SCHEDULED_TRIGGER_TRAX_UPDATES_LOCK_AT_LEAST_FOR}
           lockAtMostFor: ${CRON_SCHEDULED_TRIGGER_TRAX_UPDATES_LOCK_AT_MOST_FOR}
           threshold: ${CRON_SCHEDULED_TRIGGER_TRAX_UPDATES_THRESHOLD}
+      purge-old-records:
+        run: ${CRON_SCHEDULED_PURGE_OLD_RECORDS}
+        staleInDays: ${RECORDS_STALE_IN_DAYS}
 
 #Incremental Trax Update
 trax:

api/src/test/resources/application.yaml

@@ -90,6 +90,9 @@ cron:
           lockAtLeastFor: 800ms
           lockAtMostFor: 900ms
           threshold: 100
+      purge-old-records:
+        run: 0 30 0 * * *
+        staleInDays: 90
 
 #Incremental Trax Update
 trax: