Merge branch 'main' into v1.6

Author: sterlp

CHANGELOG.md

@@ -1,23 +1,32 @@
 # Changelog
 
+## v1.5.6 - (2025-03-06)
+
+-   Better ID search
+-   Added info to the UI how to search
+
+## v1.5.5 - (2025-03-04)
+
+-   MdcTriggerInterceptor adds now start date and scheduler name
+
 ## v1.5.4 - (2025-01-19)
 
--  Added MdcTriggerInterceptor
+-   Added MdcTriggerInterceptor
 
 ## v1.5.3 - (2025-01-14)
 
--  adjusted trigger cols that the UI does not break
--  showing always all existing schedulers
+-   adjusted trigger cols that the UI does not break
+-   showing always all existing schedulers
 
 ## v1.5.2 - (2025-01-13)
 
--  FixedIntervalRetryStrategy
--  Added SchedulerCustomizer
+-   FixedIntervalRetryStrategy
+-   Added SchedulerCustomizer
 
 ## v1.5.1 - (2025-01-12)
 
--  filter trigger by status
--  filter history by status
+-   filter trigger by status
+-   filter history by status
 
 ## v1.5.0 - (2025-01-11)
 

README.md

@@ -1,4 +1,6 @@
 [![Java CI with Maven](https://github.com/sterlp/spring-persistent-tasks/actions/workflows/build.yml/badge.svg)](https://github.com/sterlp/spring-persistent-tasks/actions/workflows/build.yml)
+[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.x-brightgreen.svg)](https://spring.io/projects/spring-boot)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
 # Spring Persistent Tasks
 
@@ -8,6 +10,16 @@ Focus is the usage with spring boot and JPA.
 
 Secondary goal is to support [Poor mans Workflow](https://github.com/sterlp/pmw)
 
+# Key Features ✨
+1. **JPA-Powered Persistence** - Automatically persists tasks to your database
+1. **Spring Boot Auto-Configuration** - Simple setup with @EnableSpringPersistentTasks
+1. **Clustering Support** - Built-in lock management for distributed environments
+1. **Type-Safe Tasks** - Generic task definitions with state objects
+1. **Retry Mechanisms** - Automatic retry policies for failed executions
+1. **Transactional Integration** - Works with Spring's transaction management
+1. **Queue Management** - Intelligent task queuing and prioritization
+1. **Different DB Supports** -- 
+
 # Documentation
 
 Use for more advanced doc the [WIKI](https://github.com/sterlp/spring-persistent-tasks/wiki).
@@ -17,10 +29,10 @@ The README contains a shorter how to use.
 
 ## Tested in the pipeline
 
--   H2
--   azure-sql-edge (MSSQL)
--   PostgreSQL
--   MariaDB
+- [![H2](https://img.shields.io/badge/H2-Database-green.svg)](https://www.h2database.com)
+- [![Azure SQL Edge](https://img.shields.io/badge/Azure_SQL_Edge-2022-0078D4?logo=microsoftsqlserver)](https://azure.microsoft.com/en-us/products/azure-sql/edge/)
+- [![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16-336791?logo=postgresql)](https://www.postgresql.org)
+- [![MariaDB](https://img.shields.io/badge/MariaDB-11.1-003545?logo=mariadb)](https://mariadb.org)
 
 ![History](screenshots/supported-dbs.png)
 
@@ -76,7 +88,7 @@ PersistentTaskService persistentTaskService;
 
 public void triggerTask1(Vehicle vehicle) {
     persistentTaskService.runOrQueue(
-        TaskTriggerBuilder.newTrigger("task1").state(vehicle).build());
+        TriggerBuilder.newTrigger("task1").state(vehicle).build());
 }
 ```
 

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

@@ -17,6 +17,7 @@
 import org.sterl.spring.persistent_tasks.history.model.TriggerHistoryLastStateEntity;
 import org.sterl.spring.persistent_tasks.history.repository.TriggerHistoryDetailRepository;
 import org.sterl.spring.persistent_tasks.history.repository.TriggerHistoryLastStateRepository;
+import org.sterl.spring.persistent_tasks.shared.StringHelper;
 import org.sterl.spring.persistent_tasks.shared.stereotype.TransactionalService;
 import org.sterl.spring.persistent_tasks.trigger.TriggerService;
 import org.sterl.spring.persistent_tasks.trigger.model.TriggerEntity;
@@ -102,7 +103,7 @@ public Page<TriggerHistoryLastStateEntity> findTriggerState(
         if (key == null && status == null) {
             return triggerHistoryLastStateRepository.findAll(page);
         }
-        final var id = key == null ? null : key.getId();
+        final var id = StringHelper.applySearchWildCard(key);
         final var name = key == null ? null : key.getTaskName();
         return triggerHistoryLastStateRepository.findAll(id, name, status, page);
     }

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

@@ -169,7 +169,8 @@ public List<TriggerEntity> rescheduleAbandonedTasks(OffsetDateTime timeout) {
                 .toList();
 
         int running = triggerService.markTriggersAsRunning(runningKeys, name);
-        log.debug("({}) - {} trigger(s) are running on {} schedulers", running, runningKeys, schedulers);
+        log.debug("({}) - {} trigger(s) are running on {} schedulers", 
+                running, runningKeys, schedulers);
         return triggerService.rescheduleAbandonedTasks(timeout);
     }
 

core/src/main/java/org/sterl/spring/persistent_tasks/scheduler/api/SchedulerResource.java

@@ -25,8 +25,7 @@ public class SchedulerResource {
     public List<SchedulerEntity> listAll() {
         return anyService.listAll();
     }
-    
-    
+
     @GetMapping("/schedulers/{name}")
     public ResponseEntity<SchedulerEntity> get(@PathVariable("name") String name) {
         return ResponseEntity.of(anyService.findStatus(name));

core/src/main/java/org/sterl/spring/persistent_tasks/shared/StringHelper.java

@@ -0,0 +1,22 @@
+package org.sterl.spring.persistent_tasks.shared;
+
+import org.sterl.spring.persistent_tasks.api.TriggerKey;
+
+public class StringHelper {
+
+    /**
+     * Replaces all <code>*</code> with <code>%</code> as needed
+     */
+    public static String applySearchWildCard(String value) {
+        if (value == null || value.length() == 0) return null;
+        return value.replace('*', '%').replace('[', '_');
+    }
+
+    /**
+     * Replaces all <code>*</code> with <code>%</code> as needed for the id.
+     */
+    public static String applySearchWildCard(TriggerKey key) {
+        if (key == null) return null;
+        return applySearchWildCard(key.getId());
+    }
+}

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

@@ -19,9 +19,9 @@
 public interface TriggerDataRepository<T extends HasTriggerData> extends JpaRepository<T, Long> {
     @Query("""
             SELECT e FROM #{#entityName} e
-            WHERE  (e.data.key.id LIKE :id% OR :id IS NULL)
-            AND    (e.data.key.taskName = :taskName OR :taskName IS NULL)
-            AND    (e.data.status = :status OR :status IS NULL)
+            WHERE  (:id IS NULL       OR e.data.key.id LIKE :id)
+            AND    (:taskName IS NULL OR e.data.key.taskName = :taskName)
+            AND    (:status IS NULL   OR e.data.status = :status)
             """)
      Page<T> findAll(@Param("id") String id,
              @Param("taskName") String taskName,

core/src/main/java/org/sterl/spring/persistent_tasks/trigger/component/ReadTriggerComponent.java

@@ -11,6 +11,7 @@
 import org.sterl.spring.persistent_tasks.api.TaskId;
 import org.sterl.spring.persistent_tasks.api.TriggerKey;
 import org.sterl.spring.persistent_tasks.api.TriggerStatus;
+import org.sterl.spring.persistent_tasks.shared.StringHelper;
 import org.sterl.spring.persistent_tasks.shared.stereotype.TransactionalCompontant;
 import org.sterl.spring.persistent_tasks.trigger.model.TriggerEntity;
 import org.sterl.spring.persistent_tasks.trigger.repository.TriggerRepository;
@@ -53,7 +54,7 @@ public List<TriggerEntity> findTriggersLastPingAfter(OffsetDateTime dateTime) {
     public Page<TriggerEntity> listTriggers(@Nullable TriggerKey key,
             @Nullable TriggerStatus status, Pageable page) {
         if (key == null && status == null) return triggerRepository.findAll(page);
-        final var id = key == null ? null : key.getId();
+        final var id = StringHelper.applySearchWildCard(key);
         final var name = key == null ? null : key.getTaskName();
         return triggerRepository.findAll(id, name, status, page);
     }

core/src/main/java/org/sterl/spring/persistent_tasks/trigger/interceptor/MdcTriggerInterceptor.java

@@ -13,22 +13,33 @@
 @Component
 public class MdcTriggerInterceptor {
 
+    public static final String TASK_RUNNING_ON = "taskRunningOn";
+    public static final String TASK_START = "taskStart";
     public static final String TASK_NAME = "taskName";
+    public static final String TASK_KEY = "taskKey";
     public static final String TASK_ID = "taskId";
 
     @EventListener
     public void beforeRun(TriggerRunningEvent data) {
+        MDC.put(TASK_RUNNING_ON, data.runningOn());
+        MDC.put(TASK_START, data.getData().getStart() + "");
         MDC.put(TASK_NAME, data.key().getTaskName());
-        MDC.put(TASK_ID, data.key().getId());
+        MDC.put(TASK_KEY, data.key().getId());
+        MDC.put(TASK_ID, data.id() + "");
     }
     @EventListener
     public void onFailed(TriggerFailedEvent data) {
-        MDC.remove(TASK_NAME);
-        MDC.remove(TASK_ID);
+        clearMdc();
     }
     @EventListener
     public void onSuccess(TriggerSuccessEvent data) {
+        clearMdc();
+    }
+    private void clearMdc() {
+        MDC.remove(TASK_RUNNING_ON);
+        MDC.remove(TASK_START);
         MDC.remove(TASK_NAME);
+        MDC.remove(TASK_KEY);
         MDC.remove(TASK_ID);
     }
 }

core/src/test/java/org/sterl/spring/persistent_tasks/trigger/api/TriggerResourceTest.java

@@ -4,6 +4,7 @@
 
 import java.time.Duration;
 import java.time.OffsetDateTime;
+import java.util.UUID;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -63,14 +64,28 @@ void testList() {
     @Test
     void testSearchById() {
         // GIVEN
+        var uuid = UUID.randomUUID().toString();
         var key1 = triggerService.queue(TriggerBuilder
-                .newTrigger("task1").build()).getKey();
+                .newTrigger("task1")
+                    .id("[@foo:[email protected]:" + uuid + "]")
+                    .build())
+                .getKey();
         var key2 = triggerService.queue(TriggerBuilder
                 .newTrigger("task1").build()).getKey();
 
         // WHEN
         var response = template.exchange(
-                baseUrl + "?id=" + key1.getId().substring(0, 30),
+                baseUrl + "?id=*" + key2.getId().substring(5, 30) + "*",
+                HttpMethod.GET,
+                null,
+                String.class);
+        // THEN
+        assertThat(response.getBody()).contains(key2.getId());
+        assertThat(response.getBody()).doesNotContain(key1.getId());
+        
+        // WHEN
+        response = template.exchange(
+                baseUrl + "?id=" + key1.getId().substring(0, 30) + "*",
                 HttpMethod.GET,
                 null,
                 String.class);
@@ -81,20 +96,20 @@ void testSearchById() {
         assertThat(response.getBody()).contains(key1.getId());
         assertThat(response.getBody()).doesNotContain(key2.getId());
     }
-    
+
     @Test
     void testSearchByStatus() {
         // GIVEN
         var k1 = createStatus(new TriggerKey("1-foo", "foo"), TriggerStatus.WAITING).getKey();
         var k2 = createStatus(new TriggerKey("2-foo", "bar"), TriggerStatus.RUNNING).getKey();
-        
+
         // WHEN
         var response = template.exchange(
                 baseUrl + "?status=" + TriggerStatus.RUNNING,
                 HttpMethod.GET,
                 null,
                 String.class);
-        
+
         // THEN
         assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
         assertThat(response.getBody()).isNotNull();