Filter by status for trigger and history (#8)

sterlp · web-flow · commit 6f9ee76d65c5 · 2025-01-12T19:06:53.000+01:00
* added filter by status

* filter trigger by status

* filter added to history page
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.5.1 - (2025-01-12)
+
+-  filter trigger by status
+-  filter history by status
+
 ## v1.5.0 - (2025-01-11)
 
 -   Adjusted transaction handling for trigger life cycle events
diff --git a/core/src/main/java/org/sterl/spring/persistent_tasks/history/HistoryService.java b/core/src/main/java/org/sterl/spring/persistent_tasks/history/HistoryService.java
@@ -96,18 +96,15 @@ public long countTriggers(TriggerKey key) {
      * @return the found data, looking only the last states
      */
     public Page<TriggerHistoryLastStateEntity> findTriggerState(
-            @Nullable TriggerKey key, Pageable page) {
-        
+            @Nullable TriggerKey key, @Nullable TriggerStatus status, Pageable page) {
+
         page = applyDefaultSortIfNeeded(page);
-        if (key == null) return triggerHistoryLastStateRepository.findAll(page);
-        if (key.getId() == null && key.getTaskName() == null) return triggerHistoryLastStateRepository.findAll(page);
-        if (key.getId() == null && key.getTaskName() != null) {
-            return triggerHistoryLastStateRepository.findAll(key.getTaskName(), page);
+        if (key == null && status == null) {
+            return triggerHistoryLastStateRepository.findAll(page);
         }
-        return triggerHistoryLastStateRepository.findAll(
-                key.getId(),
-                key.getTaskName(),
-                page);
+        final var id = key == null ? null : key.getId();
+        final var name = key == null ? null : key.getTaskName();
+        return triggerHistoryLastStateRepository.findAll(id, name, status, page);
     }
 
     private Pageable applyDefaultSortIfNeeded(Pageable page) {
diff --git a/core/src/main/java/org/sterl/spring/persistent_tasks/history/api/TriggerHistoryResource.java b/core/src/main/java/org/sterl/spring/persistent_tasks/history/api/TriggerHistoryResource.java
@@ -14,6 +14,7 @@
 import org.sterl.spring.persistent_tasks.api.TaskStatusHistoryOverview;
 import org.sterl.spring.persistent_tasks.api.Trigger;
 import org.sterl.spring.persistent_tasks.api.TriggerKey;
+import org.sterl.spring.persistent_tasks.api.TriggerStatus;
 import org.sterl.spring.persistent_tasks.history.HistoryService;
 import org.sterl.spring.persistent_tasks.history.api.HistoryConverter.FromLastTriggerStateEntity;
 import org.sterl.spring.persistent_tasks.history.api.HistoryConverter.FromTriggerStateDetailEntity;
@@ -41,11 +42,11 @@ public List<TaskStatusHistoryOverview> taskStatusHistory() {
     public PagedModel<Trigger> list(
             @RequestParam(name = "id", required = false) String id,
             @RequestParam(name = "taskName", required = false) String taskName,
-            @PageableDefault(size = 100) Pageable pageable) {
+            @RequestParam(name = "status", required = false) TriggerStatus status,
+            @PageableDefault(size = 100) Pageable page) {
 
+        var key = new TriggerKey(StringUtils.trimToNull(id), StringUtils.trimToNull(taskName));
         return FromLastTriggerStateEntity.INSTANCE.toPage( //
-                historyService.findTriggerState(
-                        new TriggerKey(StringUtils.trimToNull(id), StringUtils.trimToNull(taskName)), 
-                        pageable));
+                historyService.findTriggerState(key, status, page));
     }
 }
diff --git a/core/src/main/java/org/sterl/spring/persistent_tasks/shared/repository/TriggerDataRepository.java b/core/src/main/java/org/sterl/spring/persistent_tasks/shared/repository/TriggerDataRepository.java
@@ -20,9 +20,12 @@ public interface TriggerDataRepository<T extends HasTriggerData> extends JpaRepo
             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)
             """)
      Page<T> findAll(@Param("id") String id,
-             @Param("taskName") String taskName, Pageable page);
+             @Param("taskName") String taskName,
+             @Param("status") TriggerStatus status,
+             Pageable page);
 
     @Query("""
            SELECT e FROM #{#entityName} e
diff --git a/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/TriggerService.java b/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/TriggerService.java
@@ -94,8 +94,9 @@ public Optional<TriggerEntity> get(TriggerKey triggerKey) {
     }
 
     @Transactional(readOnly = true , timeout = 10)
-    public Page<TriggerEntity> findAllTriggers(TriggerKey key, Pageable page) {
-        return this.readTrigger.listTriggers(key, page);
+    public Page<TriggerEntity> findAllTriggers(
+            @Nullable TriggerKey key, @Nullable TriggerStatus status, Pageable page) {
+        return this.readTrigger.listTriggers(key, status, page);
     }
     
     @Transactional(readOnly = true , timeout = 10)
diff --git a/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/api/TriggerResource.java b/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/api/TriggerResource.java
@@ -18,6 +18,7 @@
 import org.springframework.web.bind.annotation.RestController;
 import org.sterl.spring.persistent_tasks.api.Trigger;
 import org.sterl.spring.persistent_tasks.api.TriggerKey;
+import org.sterl.spring.persistent_tasks.api.TriggerStatus;
 import org.sterl.spring.persistent_tasks.trigger.TriggerService;
 import org.sterl.spring.persistent_tasks.trigger.api.TriggerConverter.FromTriggerEntity;
 
@@ -39,12 +40,12 @@ public long count() {
     public PagedModel<Trigger> list(
             @RequestParam(name = "id", required = false) String id,
             @RequestParam(name = "taskName", required = false) String taskName,
+            @RequestParam(name = "status", required = false) TriggerStatus status,
             @PageableDefault(size = 100, direction = Direction.ASC, sort = "data.runAt")
             Pageable pageable) {
+        var key = new TriggerKey(StringUtils.trimToNull(id), StringUtils.trimToNull(taskName));
         return FromTriggerEntity.INSTANCE.toPage(
-                triggerService.findAllTriggers(
-                        new TriggerKey(StringUtils.trimToNull(id), StringUtils.trimToNull(taskName)), 
-                        pageable));
+                triggerService.findAllTriggers(key, status, pageable));
     }
     
     @PostMapping("triggers/{taskName}/{id}/run-at")
diff --git a/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/component/ReadTriggerComponent.java b/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/component/ReadTriggerComponent.java
@@ -50,10 +50,12 @@ public List<TriggerEntity> findTriggersLastPingAfter(OffsetDateTime dateTime) {
         return triggerRepository.findTriggersLastPingAfter(dateTime);
     }
 
-    public Page<TriggerEntity> listTriggers(TriggerKey key, Pageable page) {
-        if (key == null) return triggerRepository.findAll(page);
-        if (key.getId() == null) return listTriggers(key.toTaskId(), page);
-        return triggerRepository.findAll(key.getId(), key.getTaskName(), page);
+    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 name = key == null ? null : key.getTaskName();
+        return triggerRepository.findAll(id, name, status, page);
     }
 
     public Page<TriggerEntity> listTriggers(TaskId<? extends Serializable> task, Pageable page) {
diff --git a/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/model/TriggerEntity.java b/core/src/main/java/org/sterl/spring/persistent_tasks/trigger/model/TriggerEntity.java
@@ -104,6 +104,7 @@ public TriggerEntity complete(Exception e) {
     public TriggerEntity runAt(OffsetDateTime runAt) {
         data.setStatus(TriggerStatus.WAITING);
         data.setRunAt(runAt);
+        setRunningOn(null);
         return this;
     }
 
diff --git a/core/src/test/java/org/sterl/spring/persistent_tasks/scheduler/SchedulerServiceTransactionTest.java b/core/src/test/java/org/sterl/spring/persistent_tasks/scheduler/SchedulerServiceTransactionTest.java
@@ -161,6 +161,8 @@ void test_fail_in_transaction() throws Exception {
         // AND
         var data = persistentTaskService.getLastDetailData(trigger.key());
         assertThat(data.get().getStatus()).isEqualTo(TriggerStatus.FAILED);
+        assertThat(triggerService.get(trigger.getKey()).get().getRunningOn()).isNull();
+        assertThat(triggerService.get(trigger.getKey()).get().status()).isEqualTo(TriggerStatus.WAITING);
         // AND
         var history = historyService.findAllDetailsForKey(trigger.key()).getContent();
         assertThat(history.get(0).getData().getStatus()).isEqualTo(TriggerStatus.FAILED);
diff --git a/core/src/test/java/org/sterl/spring/persistent_tasks/trigger/api/TriggerResourceTest.java b/core/src/test/java/org/sterl/spring/persistent_tasks/trigger/api/TriggerResourceTest.java
@@ -7,6 +7,7 @@
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.web.server.LocalServerPort;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpMethod;
@@ -16,12 +17,18 @@
 import org.sterl.spring.persistent_tasks.AbstractSpringTest.TaskConfig.Task3;
 import org.sterl.spring.persistent_tasks.api.TaskId.TaskTriggerBuilder;
 import org.sterl.spring.persistent_tasks.api.Trigger;
+import org.sterl.spring.persistent_tasks.api.TriggerKey;
 import org.sterl.spring.persistent_tasks.api.TriggerStatus;
+import org.sterl.spring.persistent_tasks.shared.model.TriggerData;
+import org.sterl.spring.persistent_tasks.trigger.model.TriggerEntity;
+import org.sterl.spring.persistent_tasks.trigger.repository.TriggerRepository;
 
 class TriggerResourceTest extends AbstractSpringTest {
 
     @LocalServerPort
     private int port;
+    @Autowired
+    private TriggerRepository triggerRepository;
     private String baseUrl;
     private final RestTemplate template = new RestTemplate();
 
@@ -33,7 +40,8 @@ void setupRest() {
     @Test
     void testList() {
         // GIVEN
-        var triggerKey = triggerService.queue(TaskTriggerBuilder.newTrigger("task1").build()).getKey();
+        var k1 = createStatus(new TriggerKey("1-foo", "foo"), TriggerStatus.WAITING).getKey();
+        var k2 = createStatus(new TriggerKey("2-foo", "bar"), TriggerStatus.WAITING).getKey();
         
         // WHEN
         var response = template.exchange(
@@ -45,8 +53,11 @@ void testList() {
         // THEN
         assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
         assertThat(response.getBody()).isNotNull();
-        assertThat(response.getBody()).contains(triggerKey.getId());
-        assertThat(response.getBody()).contains(triggerKey.getTaskName());
+        assertThat(response.getBody()).contains(k1.getId());
+        assertThat(response.getBody()).contains(k1.getTaskName());
+        // AND
+        assertThat(response.getBody()).contains(k2.getId());
+        assertThat(response.getBody()).contains(k2.getTaskName());
     }
     
     @Test
@@ -71,6 +82,26 @@ void testSearchById() {
         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();
+        assertThat(response.getBody()).contains(k2.getId());
+        assertThat(response.getBody()).doesNotContain(k1.getId());
+    }
+    
     @Test
     void testCancel() {
         // GIVEN
@@ -115,5 +146,25 @@ void testUpdateRunAt() {
         assertThat(triggerService.countTriggers(TriggerStatus.WAITING)).isOne();
         assertThat(response.getBody().getKey()).isEqualTo(triggerKey);
     }
+    
+    
+    private TriggerEntity createStatus(TriggerKey key, TriggerStatus status) {
+        final var now = OffsetDateTime.now();
+        final var isCancel = status == TriggerStatus.CANCELED;
+
+        TriggerEntity result = new TriggerEntity();
+        result.setData(TriggerData
+                .builder()
+                .start(isCancel ? null : now.minusMinutes(1))
+                .end(isCancel ? null : now)
+                .createdTime(now)
+                .key(key)
+                .status(status)
+                .runningDurationInMs(isCancel ? null : 600L)
+                .build()
+            );
+        
+        return triggerRepository.save(result);
+    }
 
 }
diff --git a/ui/src/history/history.page.tsx b/ui/src/history/history.page.tsx
@@ -4,27 +4,25 @@ import useAutoRefresh from "@src/shared/use-auto-refresh";
 import HttpErrorView from "@src/shared/view/http-error.view";
 import PageView from "@src/shared/view/page.view";
 import ReloadButton from "@src/shared/view/reload-button.view";
+import TriggerStatusSelect from "@src/shared/view/triger-status-select.view";
 import TriggerItemView from "@src/shared/view/trigger-list-item.view";
 import TaskSelect from "@src/task/view/task-select.view";
+import { useQuery } from "crossroad";
 import { useState } from "react";
 import { Accordion, Col, Form, Row, Stack } from "react-bootstrap";
 
 const HistoryPage = () => {
-    const [page, setPage] = useState(0);
-    const [taskName, setTaskName] = useState("");
-    const [id, setId] = useState("");
+    const [query, setQuery] = useQuery();
 
     const triggers = useServerObject<PagedModel<Trigger>>(
         "/spring-tasks-api/history"
     );
 
     const doReload = () => {
-        triggers.doGet(
-            "?size=10&page=" + page + "&taskName=" + taskName + "&id=" + id
-        );
+        triggers.doGet("?size=10&" + new URLSearchParams(query).toString());
     };
 
-    useAutoRefresh(10000, doReload, [page, taskName, id]);
+    useAutoRefresh(10000, doReload, [query]);
 
     return (
         <>
@@ -33,25 +31,52 @@ const HistoryPage = () => {
                 <Row>
                     <Col>
                         <Form.Control
+                            defaultValue={query.id || ""}
                             type="text"
                             placeholder="Search..."
                             onKeyUp={(e) =>
                                 e.key == "Enter"
-                                    ? setId(
-                                          (e.target as HTMLInputElement).value
-                                      )
+                                    ? setQuery((prev) => ({
+                                          ...prev,
+                                          id: (e.target as HTMLInputElement)
+                                              .value,
+                                      }))
                                     : null
                             }
                         />
                     </Col>
+                    <Col>
+                        <TriggerStatusSelect
+                            value={query.status}
+                            onTaskChange={(status) =>
+                                setQuery((prev) => ({
+                                    ...prev,
+                                    status,
+                                }))
+                            }
+                        />
+                    </Col>
                 </Row>
                 <Row className="align-items-center mb-2">
                     <Col>
-                        <TaskSelect onTaskChange={setTaskName} />
+                        <TaskSelect
+                            value={query.taskName}
+                            onTaskChange={(taskName) =>
+                                setQuery((prev) => ({
+                                    ...prev,
+                                    taskName: taskName,
+                                }))
+                            }
+                        />
                     </Col>
-                    <Col className="align-items-center">
+                    <Col>
                         <PageView
-                            onPage={(p) => setPage(p)}
+                            onPage={(page) =>
+                                setQuery((prev) => ({
+                                    ...prev,
+                                    page: page + "",
+                                }))
+                            }
                             data={triggers.data}
                         />
                     </Col>
diff --git a/ui/src/shared/http-request.ts b/ui/src/shared/http-request.ts
@@ -1,5 +1,5 @@
 import axios from "axios";
-import { useMemo, useState } from "react";
+import { useCallback, useMemo, useState } from "react";
 
 export interface ServerObject<T> {
     isLoading: boolean,
@@ -36,9 +36,9 @@ export const useServerObject = <T>(url: string, startValue?: T): ServerObject<T>
             })
             .finally(() => setIsLoading(false));
         return () => controller.abort();
-    }
+    };
 
-    const doCall = (urlPart?: string, method: HttpMethod = "GET", dataToSend?: unknown) => {
+    const doCall = useCallback((urlPart?: string, method: HttpMethod = "GET", dataToSend?: unknown) => {
         return axios.request({
             baseURL: url + (urlPart ?? ""),
             data: dataToSend,
@@ -47,9 +47,10 @@ export const useServerObject = <T>(url: string, startValue?: T): ServerObject<T>
         .then((response) => setData(response.data as T))
         .catch(e => steError(e))
         .finally(() => setIsLoading(false));
-    }
+    }, [url]);
+
     return useMemo(
         () => ({ isLoading, data, error, doGet, doCall }),
-        [isLoading, data, error, doCall]
+        [isLoading, data, error, doCall, url]
     );
 }
diff --git a/ui/src/shared/view/page.view.tsx b/ui/src/shared/view/page.view.tsx
@@ -32,7 +32,7 @@ const PageView: React.FC<PageViewProps> = ({ data, onPage }) => {
         : "-";
 
     return (
-        <Pagination className="mb-0 mt-0 align-items-center">
+        <Pagination className="mb-0 mt-0 d-felx align-items-center justify-content-center">
             <Pagination.Prev
                 data-testid="prev"
                 onClick={handlePrevClick}
diff --git a/ui/src/shared/view/triger-status-select.view.tsx b/ui/src/shared/view/triger-status-select.view.tsx
diff --git a/ui/src/task/view/staus.view.tsx b/ui/src/task/view/staus.view.tsx
diff --git a/ui/src/task/view/task-select.view.tsx b/ui/src/task/view/task-select.view.tsx
diff --git a/ui/src/trigger/triggers.page.tsx b/ui/src/trigger/triggers.page.tsx
diff --git a/ui/src/trigger/views/trigger-staus.view.tsx b/ui/src/trigger/views/trigger-staus.view.tsx

Original file line number	Diff line number	Diff line change
`@@ -94,8 +94,9 @@ public Optional<TriggerEntity> get(TriggerKey triggerKey) {`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`@Transactional(readOnly = true , timeout = 10)`
`97`		`- public Page<TriggerEntity> findAllTriggers(TriggerKey key, Pageable page) {`
`98`		`- return this.readTrigger.listTriggers(key, page);`
	`97`	`+ public Page<TriggerEntity> findAllTriggers(`
	`98`	`+ @Nullable TriggerKey key, @Nullable TriggerStatus status, Pageable page) {`
	`99`	`+ return this.readTrigger.listTriggers(key, status, page);`
`99`	`100`	`}`
`100`	`101`
`101`	`102`	`@Transactional(readOnly = true , timeout = 10)`
Original file line number	Diff line number	Diff line change
`@@ -104,6 +104,7 @@ public TriggerEntity complete(Exception e) {`
`104`	`104`	`public TriggerEntity runAt(OffsetDateTime runAt) {`
`105`	`105`	`data.setStatus(TriggerStatus.WAITING);`
`106`	`106`	`data.setRunAt(runAt);`
	`107`	`+ setRunningOn(null);`
`107`	`108`	`return this;`
`108`	`109`	`}`
`109`	`110`