showing history

Author: sterlp

CHANGELOG.md

@@ -1,3 +1,6 @@
 # Changelog
 
-## [v1.0.1]
+## [v1.0.1]
+
+- Showing trigger history entries
+- Added PersistentTaskService as a abstraction

README.md

@@ -10,6 +10,8 @@ Secondary goal is to support [Poor mans Workflow](https://github.com/sterlp/pmw)
 
 # Setup and Run a Task
 
+- [JavaDoc](https://sterlp.github.io/spring-persistent-tasks/javadoc-core/)
+
 ## Maven
 
 - [Maven Central spring-persistent-tasks-core](https://central.sonatype.com/artifact/org.sterl.spring/spring-persistent-tasks-core/versions)

core/src/main/java/org/sterl/spring/persistent_tasks/PersistentTaskService.java

@@ -0,0 +1,49 @@
+package org.sterl.spring.persistent_tasks;
+
+import java.io.Serializable;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.event.EventListener;
+import org.springframework.stereotype.Service;
+import org.sterl.spring.persistent_tasks.api.AddTriggerRequest;
+import org.sterl.spring.persistent_tasks.api.TriggerKey;
+import org.sterl.spring.persistent_tasks.api.event.TriggerTaskCommand;
+import org.sterl.spring.persistent_tasks.scheduler.SchedulerService;
+import org.sterl.spring.persistent_tasks.trigger.TriggerService;
+
+/**
+ * Abstraction to {@link SchedulerService} or {@link TriggerService}
+ * depends on if the {@link SchedulerService} is available.
+ */
+@Service
+public class PersistentTaskService {
+
+    @Autowired(required = false)
+    private SchedulerService schedulerService;
+    @Autowired
+    private TriggerService triggerService;
+    
+    @EventListener
+    void queue(TriggerTaskCommand<? extends Serializable> event) {
+        if (event.triggers().size() == 1) {
+            runOrQueue(event.triggers().iterator().next());
+        } else {
+            triggerService.queueAll(event.triggers());
+        }
+    }
+
+    /**
+     * Runs the given trigger if a free threads are available
+     * and the runAt time is not in the future.
+     * @return the reference to the {@link TriggerKey} 
+     */
+    public <T extends Serializable> TriggerKey runOrQueue(
+            AddTriggerRequest<T> triggerRequest) {
+        if (schedulerService == null) {
+            schedulerService.runOrQueue(triggerRequest);
+        } else {
+            triggerService.queue(triggerRequest);
+        }
+        return triggerRequest.key();
+    }
+}

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

@@ -117,10 +117,11 @@ public List<Future<TriggerKey>> triggerNextTasks(OffsetDateTime timeDue) {
     }
 
     /**
-     * Runs the next trigger if free threads are available
+     * Runs the given trigger if a free threads are available
      * and the runAt time is not in the future.
      */
-    public Optional<Future<TriggerKey>> runOrQueue(AddTriggerRequest<? extends Serializable> triggerRequest) {
+    public <T extends Serializable> Optional<Future<TriggerKey>> runOrQueue(
+            AddTriggerRequest<T> triggerRequest) {
         return trx.execute(t -> {
             Optional<Future<TriggerKey>> result = Optional.empty();
             var trigger = triggerService.queue(triggerRequest);

core/src/main/java/org/sterl/spring/persistent_tasks/trigger/TriggerService.java

@@ -6,7 +6,6 @@
 import java.util.List;
 import java.util.Optional;
 
-import org.springframework.context.event.EventListener;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.lang.NonNull;
@@ -16,7 +15,6 @@
 import org.sterl.spring.persistent_tasks.api.AddTriggerRequest;
 import org.sterl.spring.persistent_tasks.api.TaskId;
 import org.sterl.spring.persistent_tasks.api.TriggerKey;
-import org.sterl.spring.persistent_tasks.api.event.TriggerTaskCommand;
 import org.sterl.spring.persistent_tasks.shared.model.TriggerStatus;
 import org.sterl.spring.persistent_tasks.shared.stereotype.TransactionalService;
 import org.sterl.spring.persistent_tasks.task.TaskService;
@@ -45,13 +43,20 @@ public class TriggerService {
      * and handle any errors etc.
      *
      * @param trigger the {@link TriggerEntity} to run
-     * @return the reference to the updated {@link TriggerEntity}
+     * @return the reference to the found an executed {@link TriggerEntity}
      */
     @Transactional(propagation = Propagation.NEVER)
     public Optional<TriggerEntity> run(@Nullable TriggerEntity trigger) {
         return runTrigger.execute(trigger);
     }
 
+    /**
+     * The main purpose of this method is to simplify testing and run just one trigger.
+     * 
+     * @param triggerKey the key to trigger which should be executed
+     * @param runningOn just any string, could be test for testing, usually the scheduler name
+     * @return the reference to the found an executed {@link TriggerEntity}
+     */
     @Transactional(propagation = Propagation.NEVER)
     public Optional<TriggerEntity> run(TriggerKey triggerKey, String runningOn) {
         final TriggerEntity trigger = lockNextTrigger.lock(triggerKey, runningOn);
@@ -106,11 +111,14 @@ public boolean hasPendingTriggers() {
         return readTrigger.hasPendingTriggers();
     }
 
-    @EventListener
-    public void queue(TriggerTaskCommand<? extends Serializable> event) {
-        queueAll(event.triggers());
-    }
-
+    /**
+     * Adds or updates an existing trigger based on its {@link TriggerKey}
+     * 
+     * @param <T> the state type
+     * @param tigger the {@link AddTriggerRequest} to save
+     * @return the saved {@link TriggerEntity}
+     * @throws IllegalStateException if the trigger already exists and is {@link TriggerStatus#RUNNING}
+     */
     public <T extends Serializable> TriggerEntity queue(AddTriggerRequest<T> tigger) {
         taskService.assertIsKnown(tigger.taskId());
         return editTrigger.addTrigger(tigger);

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

@@ -17,6 +17,7 @@
 import org.sterl.spring.persistent_tasks.api.TriggerKey;
 import org.sterl.spring.persistent_tasks.shared.model.TriggerData;
 import org.sterl.spring.persistent_tasks.shared.model.TriggerStatus;
+import org.sterl.spring.persistent_tasks.trigger.event.TriggerAddedEvent;
 import org.sterl.spring.persistent_tasks.trigger.event.TriggerCanceledEvent;
 import org.sterl.spring.persistent_tasks.trigger.event.TriggerCompleteEvent;
 import org.sterl.spring.persistent_tasks.trigger.event.TriggerFailedEvent;
@@ -90,14 +91,15 @@ public <T extends Serializable> TriggerEntity addTrigger(AddTriggerRequest<T> ti
         final Optional<TriggerEntity> existing = triggerRepository.findByKey(result.getKey());
         if (existing.isPresent()) {
             if (existing.get().isRunning()) 
-                throw new IllegalStateException("Cannot update running trigger " + result.getKey());
+                throw new IllegalStateException("Cannot update a running trigger " + result.getKey());
 
             existing.get().setData(result.getData());
             result = existing.get();
             log.debug("Updated trigger={}", result);
         } else {
             result = triggerRepository.save(result);
             log.debug("Added trigger={}", result);
+            publisher.publishEvent(new TriggerAddedEvent(result));
         }
         return result;
     }

core/src/main/java/org/sterl/spring/persistent_tasks/trigger/event/TriggerAddedEvent.java

@@ -0,0 +1,7 @@
+package org.sterl.spring.persistent_tasks.trigger.event;
+
+import org.sterl.spring.persistent_tasks.trigger.model.TriggerEntity;
+
+public record TriggerAddedEvent(TriggerEntity trigger) implements TriggerLifeCycleEvent {
+
+}

screenshots/triggers-screen.png

@@ -20,7 +20,7 @@ const TriggerHistoryListView = ({ triggers }: { triggers?: Trigger[] }) => {
                         <Col>
                             <TriggerStatusView data={t} />
                             <strong>
-                                {" " + formatDateTime(t.createdTime)}:
+                                {" at " + formatDateTime(t.createdTime)}
                             </strong>
                         </Col>
                         <Col>

ui/src/history/view/trigger-history.view.tsx

@@ -1 +1 @@
-mvn clean deploy -DskipTests -Prelease
+mvn clean source:jar javadoc:jar deploy -DskipTests -Prelease