server/controllers/api/jobs.ts

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