Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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();

Expand All @@ -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(
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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);
}

}
51 changes: 38 additions & 13 deletions ui/src/history/history.page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
<>
Expand All @@ -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>
Expand Down
11 changes: 6 additions & 5 deletions ui/src/shared/http-request.ts
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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]
);
}
2 changes: 1 addition & 1 deletion ui/src/shared/view/page.view.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
Loading
Loading