fixed timer which deletes old triggers

Author: sterlp

core/src/main/java/org/sterl/spring/persistent_tasks/history/HistoryService.java

@@ -21,7 +21,7 @@
 import org.sterl.spring.persistent_tasks.history.model.HistoryTriggerEntity;
 import org.sterl.spring.persistent_tasks.history.model.QCompletedTriggerEntity;
 import org.sterl.spring.persistent_tasks.history.repository.CompletedTriggerRepository;
-import org.sterl.spring.persistent_tasks.history.repository.TriggerHistoryDetailRepository;
+import org.sterl.spring.persistent_tasks.history.repository.HistoryTriggerRepository;
 import org.sterl.spring.persistent_tasks.shared.QueryHelper;
 import org.sterl.spring.persistent_tasks.shared.model.HasTrigger;
 import org.sterl.spring.persistent_tasks.shared.stereotype.TransactionalService;
@@ -36,7 +36,7 @@
 public class HistoryService {
     private final EntityManager em;
     private final CompletedTriggerRepository completedTriggerRepository;
-    private final TriggerHistoryDetailRepository triggerHistoryDetailRepository;
+    private final HistoryTriggerRepository historyTriggerRepository;
     private final ApplicationEventPublisher applicationEventPublisher;
 
     public Optional<CompletedTriggerEntity> findStatus(long triggerId) {
@@ -51,11 +51,11 @@ public Optional<CompletedTriggerEntity> findLastKnownStatus(TriggerKey triggerKe
 
     public void deleteAll() {
         completedTriggerRepository.deleteAllInBatch();
-        triggerHistoryDetailRepository.deleteAllInBatch();
+        historyTriggerRepository.deleteAllInBatch();
     }
 
     public long deleteAllOlderThan(OffsetDateTime age) {
-        var result = triggerHistoryDetailRepository.deleteOlderThan(age);
+        var result = historyTriggerRepository.deleteOlderThan(age);
         result += completedTriggerRepository.deleteOlderThan(age);
         return result;
     }
@@ -64,12 +64,12 @@ public long deleteAllOlderThan(OffsetDateTime age) {
      * Counts the <b>unique</b> triggers in the history.
      */
     public long countTriggers(TriggerStatus status) {
-        return triggerHistoryDetailRepository.countByStatus(status);
+        return historyTriggerRepository.countByStatus(status);
     }
 
     public Page<HistoryTriggerEntity> findAllDetailsForInstance(long instanceId, Pageable page) {
         page = QueryHelper.applySortIfEmpty(page, Sort.by(Direction.DESC, "id"));
-        return triggerHistoryDetailRepository.findAllByInstanceId(instanceId, page);
+        return historyTriggerRepository.findAllByInstanceId(instanceId, page);
     }
 
     public Optional<TriggerKey> reQueue(Long id, OffsetDateTime runAt) {

core/src/main/java/org/sterl/spring/persistent_tasks/history/component/TriggerHistoryComponent.java

@@ -1,6 +1,5 @@
 package org.sterl.spring.persistent_tasks.history.component;
 
-import org.apache.commons.lang3.StringUtils;
 import org.springframework.context.event.EventListener;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.stereotype.Component;
@@ -11,7 +10,7 @@
 import org.sterl.spring.persistent_tasks.history.model.CompletedTriggerEntity;
 import org.sterl.spring.persistent_tasks.history.model.HistoryTriggerEntity;
 import org.sterl.spring.persistent_tasks.history.repository.CompletedTriggerRepository;
-import org.sterl.spring.persistent_tasks.history.repository.TriggerHistoryDetailRepository;
+import org.sterl.spring.persistent_tasks.history.repository.HistoryTriggerRepository;
 import org.sterl.spring.persistent_tasks.shared.model.TriggerEntity;
 import org.sterl.spring.persistent_tasks.trigger.event.TriggerLifeCycleEvent;
 import org.sterl.spring.persistent_tasks.trigger.event.TriggerRunningEvent;
@@ -25,7 +24,7 @@
 public class TriggerHistoryComponent {
 
     private final CompletedTriggerRepository completedTriggerRepository;
-    private final TriggerHistoryDetailRepository triggerHistoryDetailRepository;
+    private final HistoryTriggerRepository historyTriggerRepository;
 
     // we have to ensure to run in an own transaction
     // as if the trigger fails, a rollback would also remove this entry
@@ -45,11 +44,11 @@ public void onRunning(TriggerRunningEvent e) {
     @TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT)
     void onPersistentTaskEvent(TriggerLifeCycleEvent e) {
         if (e instanceof TriggerRunningEvent) return; // we have an own listener for that
+        
         log.debug("Received event={} for {} new status={}",
                 e.getClass().getSimpleName(),
                 e.key(), e.status());
 
-        
         execute(e.id(), e.data(), e.isDone());
     }
 
@@ -62,17 +61,8 @@ public void execute(final long triggerId, final TriggerEntity data, boolean isDo
             completedTriggerRepository.save(state);
         }
 
-        var detail = new HistoryTriggerEntity();
-        detail.setExecutionCount(data.getExecutionCount());
+        var detail = HistoryTriggerEntity.from(data);
         detail.setInstanceId(triggerId);
-        detail.setKey(data.getKey());
-        
-        var msg = data.getExceptionName();
-        if (data.getLastException() != null) msg = data.getLastException();
-        detail.setMessage(StringUtils.substring(msg, 0, 200));
-
-        detail.setStart(data.getStart());
-        detail.setStatus(data.getStatus());
-        triggerHistoryDetailRepository.save(detail);
+        historyTriggerRepository.save(detail);
     }
 }

core/src/main/java/org/sterl/spring/persistent_tasks/history/model/HistoryTriggerEntity.java

@@ -2,6 +2,7 @@
 
 import java.time.OffsetDateTime;
 
+import org.apache.commons.lang3.StringUtils;
 import org.sterl.spring.persistent_tasks.api.TriggerKey;
 import org.sterl.spring.persistent_tasks.api.TriggerStatus;
 import org.sterl.spring.persistent_tasks.shared.model.TriggerEntity;
@@ -77,5 +78,20 @@ public class HistoryTriggerEntity {
 
     @Column(length = 200, updatable = false)
     private String message;
+    
+    
+    public static HistoryTriggerEntity from(TriggerEntity data) {
+        var result = new HistoryTriggerEntity();
+        result.setExecutionCount(data.getExecutionCount());
+        result.setKey(data.getKey());
+        
+        var msg = data.getExceptionName();
+        if (data.getLastException() != null) msg = data.getLastException();
+        result.setMessage(StringUtils.substring(msg, 0, 200));
+
+        result.setStart(data.getStart());
+        result.setStatus(data.getStatus());
+        return result;
+    }
 
 }

core/src/main/java/org/sterl/spring/persistent_tasks/history/repository/TriggerHistoryDetailRepository.java renamed to core/src/main/java/org/sterl/spring/persistent_tasks/history/repository/HistoryTriggerRepository.java

@@ -12,7 +12,7 @@
 import org.sterl.spring.persistent_tasks.api.TriggerStatus;
 import org.sterl.spring.persistent_tasks.history.model.HistoryTriggerEntity;
 
-public interface TriggerHistoryDetailRepository
+public interface HistoryTriggerRepository
         extends JpaRepository<HistoryTriggerEntity, Long>, QuerydslPredicateExecutor<HistoryTriggerEntity> {
 
     @Query("""
@@ -28,7 +28,7 @@ Page<HistoryTriggerEntity> findAllByInstanceId(
             WHERE e.createdTime < :age
             """)
     @Modifying
-    long deleteOlderThan(@Param("age") OffsetDateTime age);
+    int deleteOlderThan(@Param("age") OffsetDateTime age);
 
     @Query("""
             SELECT COUNT(e.id)

core/src/main/java/org/sterl/spring/persistent_tasks/scheduler/SchedulerTimer.java

@@ -43,8 +43,10 @@ void rescheduleAbandonedTasks() {
         for (SchedulerService s : schedulerServices) {
             try {
                 final var count = s.rescheduleAbandonedTriggers(timeout);
-                log.info("Found {} abandoned tasks for {}. Timeout={}", 
-                        count.size(), s.getName(), taskTimeout);
+                if (count.size() > 0) {
+                    log.info("Found {} abandoned tasks for {}. Timeout={}", 
+                            count.size(), s.getName(), taskTimeout);
+                }
             } catch (Exception e) {
                 log.error("Scheduler {} failed schedule abandoned tasks", s.getName(), e);
             }

core/src/main/java/org/sterl/spring/persistent_tasks/shared/repository/TriggerRepository.java

@@ -133,5 +133,5 @@ WHERE e.data.status IN ( :status )
            WHERE e.data.createdTime < :age
            """)
     @Modifying
-    long deleteOlderThan(@Param("age") OffsetDateTime age);
+    int deleteOlderThan(@Param("age") OffsetDateTime age);
 }

core/src/test/java/org/sterl/spring/persistent_tasks/history/HistoryServiceTest.java

@@ -4,6 +4,7 @@
 
 import java.time.OffsetDateTime;
 import java.util.Optional;
+import java.util.Random;
 import java.util.concurrent.TimeoutException;
 
 import org.junit.jupiter.api.RepeatedTest;
@@ -16,13 +17,21 @@
 import org.sterl.spring.persistent_tasks.api.TriggerKey;
 import org.sterl.spring.persistent_tasks.api.TriggerRequest;
 import org.sterl.spring.persistent_tasks.api.TriggerStatus;
+import org.sterl.spring.persistent_tasks.history.component.TriggerHistoryComponent;
+import org.sterl.spring.persistent_tasks.shared.model.TriggerEntity;
+
+import com.github.f4b6a3.uuid.UuidCreator;
 
 class HistoryServiceTest extends AbstractSpringTest {
 
+    Random random = new Random();
     @Autowired 
     private HistoryService subject;
     @Autowired
     private PersistentTaskService persistentTaskService;
+    
+    @Autowired
+    private TriggerHistoryComponent triggerHistory;
 
     @Test
     void testReQueueTrigger() {
@@ -76,4 +85,43 @@ void testTriggerHistoryTrx() {
         hibernateAsserts.assertTrxCount(3);
         assertThat(subject.countTriggers(trigger)).isEqualTo(1);
     }
+    
+    @Test
+    void testTriggerDelete() {
+        // GIVEN
+        // WHEN
+        subject.deleteAll();
+    }
+    
+    @Test
+    void testDeleteByDate() {
+        // GIVEN
+        var now = OffsetDateTime.now();
+        var task = UuidCreator.getTimeOrderedEpochFast().toString();
+        var instanceId = random.nextLong(0, 99999) + now.toEpochSecond();
+        
+        trx.executeWithoutResult(t -> {
+            triggerHistory.execute(instanceId, TriggerEntity.builder()
+                    .key(new TriggerKey("123", task))
+                    .createdTime(now)
+                    .build(), true);
+            
+            // this one we keep
+            triggerHistory.execute(instanceId, TriggerEntity.builder()
+                    .key(new TriggerKey("123", task))
+                    .createdTime(now.plusMinutes(1))
+                    .build(), true);
+        });
+
+        // WHEN
+        var count = subject.deleteAllOlderThan(now.minusSeconds(1));
+        
+        // THEN
+        assertThat(count).isZero();
+        
+        // WHEN
+        count = subject.deleteAllOlderThan(now.plusSeconds(30));
+        // THEN
+        assertThat(count).isEqualTo(3);
+    }
 }

core/src/test/java/org/sterl/spring/persistent_tasks/trigger/TriggerServiceTest.java

@@ -433,16 +433,19 @@ void testRescheduleAbandonedTasks() {
     void testRescheduleAbandonedTasksOnlyRunning() {
         // GIVEN
         var now = OffsetDateTime.now();
-        var t1 = new RunningTriggerEntity(new TriggerKey(UuidCreator.getTimeOrdered().toString(), "fooTask"))
+        var t1 = trx.execute(t -> {
+            RunningTriggerEntity running = null;
+            for (var status : TriggerStatus.values()) {
+                var any = new RunningTriggerEntity(new TriggerKey(UuidCreator.getTimeOrdered().toString(), "fooTask"))
                         .runOn("fooScheduler");
-        t1.setLastPing(now.minusSeconds(60));
-        triggerRepository.save(t1);
+                any.getData().setStatus(status);
+                any.setLastPing(now.minusSeconds(60));
+                any = triggerRepository.save(any);
+                if (status == TriggerStatus.RUNNING) running = any;
+            }
+            return running;
+        });
 
-        var t2 = new RunningTriggerEntity(
-                new TriggerKey(UuidCreator.getTimeOrdered().toString(), "barTask"));
-        t2.setLastPing(now.minusSeconds(60));
-        triggerRepository.save(t2);
-
         // WHEN
         final var rescheduledTasks = subject.rescheduleAbandoned(now.minusSeconds(59));
 
@@ -615,4 +618,10 @@ void testAwaitForSignalTriggersInTimeoutWillNotRun() {
         // AND
         asserts.assertMissing("old state");
     }
+    
+    @Test
+    void testDeleteAll() {
+        // WHEN
+        subject.deleteAll();
+    }
 }