add display of logs matching any state

4 files changed, 44 insertions, 11 deletions

diff --git a/server/controllers/api/jobs.ts b/server/controllers/api/jobs.ts
index ed6c94533..1131a44d6 100644
--- a/server/controllers/api/jobs.ts
+++ b/server/controllers/api/jobs.ts
@@ -12,11 +12,23 @@ import {
   setDefaultSort
 } from '../../middlewares'
 import { paginationValidator } from '../../middlewares/validators'
-import { listJobsValidator } from '../../middlewares/validators/jobs'
+import { listJobsStateValidator, listJobsValidator } from '../../middlewares/validators/jobs'
 import { isArray } from '../../helpers/custom-validators/misc'
+import { jobStates } from '@server/helpers/custom-validators/jobs'
 
 const jobsRouter = express.Router()
 
+jobsRouter.get('/',
+  authenticate,
+  ensureUserHasRight(UserRight.MANAGE_JOBS),
+  paginationValidator,
+  jobsSortValidator,
+  setDefaultSort,
+  setDefaultPagination,
+  listJobsValidator,
+  asyncMiddleware(listJobs)
+)
+
 jobsRouter.get('/:state',
   authenticate,
   ensureUserHasRight(UserRight.MANAGE_JOBS),
@@ -25,6 +37,7 @@ jobsRouter.get('/:state',
   setDefaultSort,
   setDefaultPagination,
   listJobsValidator,
+  listJobsStateValidator,
   asyncMiddleware(listJobs)
 )
 
@@ -37,7 +50,7 @@ export {
 // ---------------------------------------------------------------------------
 
 async function listJobs (req: express.Request, res: express.Response) {
-  const state = req.params.state as JobState
+  const state = req.params.state as JobState || jobStates
   const asc = req.query.sort === 'createdAt'
   const jobType = req.query.jobType
 
@@ -52,7 +65,11 @@ async function listJobs (req: express.Request, res: express.Response) {
 
   const result: ResultList<Job> = {
     total,
-    data: jobs.map(j => formatJob(j, state))
+    data: Array.isArray(state)
+      ? await Promise.all(
+        jobs.map(async j => formatJob(j, await j.getState() as JobState))
+      )
+      : jobs.map(j => formatJob(j, state))
   }
   return res.json(result)
 }
diff --git a/server/helpers/custom-validators/jobs.ts b/server/helpers/custom-validators/jobs.ts
index dd33e85a3..72dc73ee4 100644
--- a/server/helpers/custom-validators/jobs.ts
+++ b/server/helpers/custom-validators/jobs.ts
@@ -15,6 +15,7 @@ function isValidJobType (value: any) {
 // ---------------------------------------------------------------------------
 
 export {
+  jobStates,
   isValidJobState,
   isValidJobType
 }
diff --git a/server/lib/job-queue/job-queue.ts b/server/lib/job-queue/job-queue.ts
index 8d97434ac..49f06584d 100644
--- a/server/lib/job-queue/job-queue.ts
+++ b/server/lib/job-queue/job-queue.ts
@@ -154,13 +154,13 @@ class JobQueue {
   }
 
   async listForApi (options: {
-    state: JobState
+    state: JobState | JobState[]
     start: number
     count: number
     asc?: boolean
     jobType: JobType
   }): Promise<Bull.Job[]> {
-    const { state, start, count, asc, jobType } = options
+    const { state = Array.isArray(options.state) ? options.state : [ options.state ], start, count, asc, jobType } = options
     let results: Bull.Job[] = []
 
     const filteredJobTypes = this.filterJobTypes(jobType)
@@ -172,7 +172,7 @@ class JobQueue {
         continue
       }
 
-      const jobs = await queue.getJobs([ state ], 0, start + count, asc)
+      const jobs = await queue.getJobs(state as Bull.JobStatus[], 0, start + count, asc)
       results = results.concat(jobs)
     }
 
@@ -188,7 +188,8 @@ class JobQueue {
     return results.slice(start, start + count)
   }
 
-  async count (state: JobState, jobType?: JobType): Promise<number> {
+  async count (state: JobState | JobState[], jobType?: JobType): Promise<number> {
+    const states = Array.isArray(state) ? state : [ state ]
     let total = 0
 
     const filteredJobTypes = this.filterJobTypes(jobType)
@@ -202,7 +203,9 @@ class JobQueue {
 
       const counts = await queue.getJobCounts()
 
-      total += counts[state]
+      for (const s of states) {
+        total += counts[s]
+      }
     }
 
     return total
diff --git a/server/middlewares/validators/jobs.ts b/server/middlewares/validators/jobs.ts
index b57615dbc..0fc183c1a 100644
--- a/server/middlewares/validators/jobs.ts
+++ b/server/middlewares/validators/jobs.ts
@@ -5,8 +5,6 @@ import { logger } from '../../helpers/logger'
 import { areValidationErrors } from './utils'
 
 const listJobsValidator = [
-  param('state')
-    .custom(isValidJobState).not().isEmpty().withMessage('Should have a valid job state'),
   query('jobType')
     .optional()
     .custom(isValidJobType).withMessage('Should have a valid job state'),
@@ -20,8 +18,22 @@ const listJobsValidator = [
   }
 ]
 
+const listJobsStateValidator = [
+  param('state')
+    .custom(isValidJobState).not().isEmpty().withMessage('Should have a valid job state'),
+
+  (req: express.Request, res: express.Response, next: express.NextFunction) => {
+    logger.debug('Checking listJobsValidator parameters.', { parameters: req.params })
+
+    if (areValidationErrors(req, res)) return
+
+    return next()
+  }
+]
+
 // ---------------------------------------------------------------------------
 
 export {
-  listJobsValidator
+  listJobsValidator,
+  listJobsStateValidator
 }