server/controllers/api/jobs.ts

   1 import * as 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'
   7 import {
   8   asyncMiddleware,
   9   authenticate,
  10   ensureUserHasRight,
  11   jobsSortValidator,
  12   paginationValidatorBuilder,
  13   setDefaultPagination,
  14   setDefaultSort
  15 } from '../../middlewares'
  16 import { listJobsValidator } from '../../middlewares/validators/jobs'
  17
  18 const jobsRouter = express.Router()
  19
  20 jobsRouter.get('/:state?',
  21   authenticate,
  22   ensureUserHasRight(UserRight.MANAGE_JOBS),
  23   paginationValidatorBuilder([ 'jobs' ]),
  24   jobsSortValidator,
  25   setDefaultSort,
  26   setDefaultPagination,
  27   listJobsValidator,
  28   asyncMiddleware(listJobs)
  29 )
  30
  31 // ---------------------------------------------------------------------------
  32
  33 export {
  34   jobsRouter
  35 }
  36
  37 // ---------------------------------------------------------------------------
  38
  39 async function listJobs (req: express.Request, res: express.Response) {
  40   const state = req.params.state as JobState
  41   const asc = req.query.sort === 'createdAt'
  42   const jobType = req.query.jobType
  43
  44   const jobs = await JobQueue.Instance.listForApi({
  45     state,
  46     start: req.query.start,
  47     count: req.query.count,
  48     asc,
  49     jobType
  50   })
  51   const total = await JobQueue.Instance.count(state, jobType)
  52
  53   const result: ResultList<Job> = {
  54     total,
  55     data: await Promise.all(jobs.map(j => formatJob(j, state)))
  56   }
  57
  58   return res.json(result)
  59 }
  60
  61 async function formatJob (job: any, state?: JobState): Promise<Job> {
  62   const error = isArray(job.stacktrace) && job.stacktrace.length !== 0
  63     ? job.stacktrace[0]
  64     : null
  65
  66   return {
  67     id: job.id,
  68     state: state || await job.getState(),
  69     type: job.queue.name as JobType,
  70     data: job.data,
  71     progress: await job.progress(),
  72     priority: job.opts.priority,
  73     error,
  74     createdAt: new Date(job.timestamp),
  75     finishedOn: new Date(job.finishedOn),
  76     processedOn: new Date(job.processedOn)
  77   }
  78 }