-import * as express from 'express'
-import { ResultList } from '../../../shared'
-import { Job, JobState, JobType } from '../../../shared/models'
-import { UserRight } from '../../../shared/models/users'
+import express from 'express'
+import { HttpStatusCode, Job, JobState, JobType, ResultList, UserRight } from '@shared/models'
import { isArray } from '../../helpers/custom-validators/misc'
import { JobQueue } from '../../lib/job-queue'
import {
authenticate,
ensureUserHasRight,
jobsSortValidator,
+ openapiOperationDoc,
+ paginationValidatorBuilder,
setDefaultPagination,
setDefaultSort
} from '../../middlewares'
-import { paginationValidator } from '../../middlewares/validators'
import { listJobsValidator } from '../../middlewares/validators/jobs'
const jobsRouter = express.Router()
+jobsRouter.post('/pause',
+ authenticate,
+ ensureUserHasRight(UserRight.MANAGE_JOBS),
+ asyncMiddleware(pauseJobQueue)
+)
+
+jobsRouter.post('/resume',
+ authenticate,
+ ensureUserHasRight(UserRight.MANAGE_JOBS),
+ asyncMiddleware(resumeJobQueue)
+)
+
jobsRouter.get('/:state?',
+ openapiOperationDoc({ operationId: 'getJobs' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_JOBS),
- paginationValidator,
+ paginationValidatorBuilder([ 'jobs' ]),
jobsSortValidator,
setDefaultSort,
setDefaultPagination,
// ---------------------------------------------------------------------------
+async function pauseJobQueue (req: express.Request, res: express.Response) {
+ await JobQueue.Instance.pause()
+
+ return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
+}
+
+async function resumeJobQueue (req: express.Request, res: express.Response) {
+ await JobQueue.Instance.resume()
+
+ return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
+}
+
async function listJobs (req: express.Request, res: express.Response) {
const state = req.params.state as JobState
const asc = req.query.sort === 'createdAt'
const result: ResultList<Job> = {
total,
- data: state
- ? jobs.map(j => formatJob(j, state))
- : await Promise.all(jobs.map(j => formatJobWithUnknownState(j)))
+ data: await Promise.all(jobs.map(j => formatJob(j, state)))
}
return res.json(result)
}
-async function formatJobWithUnknownState (job: any) {
- return formatJob(job, await job.getState())
-}
-
-function formatJob (job: any, state: JobState): Job {
+async function formatJob (job: any, state?: JobState): Promise<Job> {
const error = isArray(job.stacktrace) && job.stacktrace.length !== 0
? job.stacktrace[0]
: null
return {
id: job.id,
- state: state,
+ state: state || await job.getState(),
type: job.queue.name as JobType,
data: job.data,
+ progress: await job.progress(),
+ priority: job.opts.priority,
error,
createdAt: new Date(job.timestamp),
finishedOn: new Date(job.finishedOn),