25903962962

Committed 15 May 2026 06:29AM UTC coverage: 87.282% (-0.5%) from 87.786%

Build # 25903962962

Build Type

Pull #918

github

Committed by

web-flow

Commit Message

Merge 9b21ecf53 into bc0d8ef0a

Pull Request Pull Request #918: Background task queue with admin API, WebSocket updates, and failed-task health signal

Coverage Stats

3978 of 4650 branches covered (85.55%)

Branch coverage included in aggregate %.

518 of 620 new or added lines in 15 files covered. (83.55%)

106 existing lines in 12 files now uncovered.

20722 of 23649 relevant lines covered (87.62%)

834.62 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/controller/response/task-response.ts

/**
 *  SudoSOS back-end API service.
 *  Copyright (C) 2026 Study association GEWIS
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 *  @license
 */

/**
 * @module tasks
 */

import BaseResponse from './base-response';
import { PaginationResult } from '../../helpers/pagination';

/**
 * API response for the `task` entity.
 * @typedef {allOf|BaseResponse} TaskResponse
 * @property {string} type.required - Handler key, e.g. 'send-notification'.
 * @property {string} payload.required - JSON-encoded handler payload.
 * @property {string} status.required - One of pending, processing, completed, failed.
 * @property {integer} attempts.required - Attempts so far.
 * @property {integer} maxAttempts.required - Maximum attempts before status=failed.
 * @property {string} availableAt - Earliest time this task may be picked up.
 * @property {string} startedAt - When the most recent attempt began.
 * @property {string} completedAt - When the task finished successfully.
 * @property {string} lastError - Most recent error message.
 */
export interface TaskResponse extends BaseResponse {
  type: string;
  payload: string;
  status: string;
  attempts: number;
  maxAttempts: number;
  availableAt?: string | null;
  startedAt?: string | null;
  completedAt?: string | null;
  lastError?: string | null;
}

/**
 * Paginated API response for the `task` entity.
 * @typedef {object} PaginatedTaskResponse
 * @property {PaginationResult} _pagination.required - Pagination metadata.
 * @property {Array.<TaskResponse>} records.required - The page of tasks.
 */
export interface PaginatedTaskResponse {
  _pagination: PaginationResult;
  records: TaskResponse[];
}

/**
 * Aggregate counts of tasks by status.
 * @typedef {object} TaskStatsResponse
 * @property {integer} pending.required - Count of tasks waiting to run.
 * @property {integer} processing.required - Count of tasks currently in flight.
 * @property {integer} completed.required - Count of tasks that succeeded.
 * @property {integer} failed.required - Count of tasks that gave up after retries.
 */
export interface TaskStatsResponse {
  pending: number;
  processing: number;
  completed: number;
  failed: number;
}

NEW 1	/**	×
2	* SudoSOS back-end API service.
3	* Copyright (C) 2026 Study association GEWIS
4	*
5	* This program is free software: you can redistribute it and/or modify
6	* it under the terms of the GNU Affero General Public License as published
7	* by the Free Software Foundation, either version 3 of the License, or
8	* (at your option) any later version.
9	*
10	* This program is distributed in the hope that it will be useful,
11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	* GNU Affero General Public License for more details.
14	*
15	* You should have received a copy of the GNU Affero General Public License
16	* along with this program. If not, see <https://www.gnu.org/licenses/>.
17	*
18	* @license
NEW 19	*/	×
20
NEW 21	/**	×
22	* @module tasks
NEW 23	*/	×
24
25	import BaseResponse from './base-response';
26	import { PaginationResult } from '../../helpers/pagination';
27
28	/**
29	* API response for the `task` entity.
30	* @typedef {allOf\|BaseResponse} TaskResponse
31	* @property {string} type.required - Handler key, e.g. 'send-notification'.
32	* @property {string} payload.required - JSON-encoded handler payload.
33	* @property {string} status.required - One of pending, processing, completed, failed.
34	* @property {integer} attempts.required - Attempts so far.
35	* @property {integer} maxAttempts.required - Maximum attempts before status=failed.
36	* @property {string} availableAt - Earliest time this task may be picked up.
37	* @property {string} startedAt - When the most recent attempt began.
38	* @property {string} completedAt - When the task finished successfully.
39	* @property {string} lastError - Most recent error message.
40	*/
41	export interface TaskResponse extends BaseResponse {
42	type: string;
43	payload: string;
44	status: string;
45	attempts: number;
46	maxAttempts: number;
47	availableAt?: string \| null;
48	startedAt?: string \| null;
49	completedAt?: string \| null;
50	lastError?: string \| null;
51	}
52
53	/**
54	* Paginated API response for the `task` entity.
55	* @typedef {object} PaginatedTaskResponse
56	* @property {PaginationResult} _pagination.required - Pagination metadata.
57	* @property {Array.<TaskResponse>} records.required - The page of tasks.
58	*/
59	export interface PaginatedTaskResponse {
60	_pagination: PaginationResult;
61	records: TaskResponse[];
62	}
63
NEW 64	/**	×
65	* Aggregate counts of tasks by status.
66	* @typedef {object} TaskStatsResponse
67	* @property {integer} pending.required - Count of tasks waiting to run.
68	* @property {integer} processing.required - Count of tasks currently in flight.
69	* @property {integer} completed.required - Count of tasks that succeeded.
70	* @property {integer} failed.required - Count of tasks that gave up after retries.
NEW 71	*/	×
72	export interface TaskStatsResponse {
73	pending: number;
74	processing: number;
75	completed: number;
76	failed: number;
NEW 77	}	×

GEWIS / sudosos-backend / 25903962962

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous