1 import express from 'express'
2 import { ResultList } from '../../../shared'
3 import { Job, JobState, JobType } from '../../../shared/models'
4 import { UserRight } from '../../../shared/models/users'
5 import { isArray } from '../../helpers/custom-validators/misc'
6 import { JobQueue } from '../../lib/job-queue'
13 paginationValidatorBuilder,
16 } from '../../middlewares'
17 import { listJobsValidator } from '../../middlewares/validators/jobs'
19 const jobsRouter = express.Router()
21 jobsRouter.get('/:state?',
22 openapiOperationDoc({ operationId: 'getJobs' }),
24 ensureUserHasRight(UserRight.MANAGE_JOBS),
25 paginationValidatorBuilder([ 'jobs' ]),
30 asyncMiddleware(listJobs)
33 // ---------------------------------------------------------------------------
39 // ---------------------------------------------------------------------------
41 async function listJobs (req: express.Request, res: express.Response) {
42 const state = req.params.state as JobState
43 const asc = req.query.sort === 'createdAt'
44 const jobType = req.query.jobType
46 const jobs = await JobQueue.Instance.listForApi({
48 start: req.query.start,
49 count: req.query.count,
53 const total = await JobQueue.Instance.count(state, jobType)
55 const result: ResultList<Job> = {
57 data: await Promise.all(jobs.map(j => formatJob(j, state)))
60 return res.json(result)
63 async function formatJob (job: any, state?: JobState): Promise<Job> {
64 const error = isArray(job.stacktrace) && job.stacktrace.length !== 0
70 state: state || await job.getState(),
71 type: job.queue.name as JobType,
73 progress: await job.progress(),
74 priority: job.opts.priority,
76 createdAt: new Date(job.timestamp),
77 finishedOn: new Date(job.finishedOn),
78 processedOn: new Date(job.processedOn)