PeerTube/server/core/controllers/api/jobs.ts

113 lines
2.9 KiB
TypeScript
Raw Normal View History

import { HttpStatusCode, Job, JobState, JobType, ResultList, UserRight } from '@peertube/peertube-models'
2022-08-08 10:42:08 +02:00
import { Job as BullJob } from 'bullmq'
2021-08-27 14:32:44 +02:00
import express from 'express'
import { isArray } from '../../helpers/custom-validators/misc.js'
import { JobQueue } from '../../lib/job-queue/index.js'
import {
2023-06-20 14:17:34 +02:00
apiRateLimiter,
asyncMiddleware,
authenticate,
ensureUserHasRight,
jobsSortValidator,
openapiOperationDoc,
2021-03-09 09:22:05 +01:00
paginationValidatorBuilder,
setDefaultPagination,
setDefaultSort
} from '../../middlewares/index.js'
import { listJobsValidator } from '../../middlewares/validators/jobs.js'
2017-11-30 10:51:13 +01:00
const jobsRouter = express.Router()
2023-06-20 14:17:34 +02:00
jobsRouter.use(apiRateLimiter)
jobsRouter.post('/pause',
authenticate,
ensureUserHasRight(UserRight.MANAGE_JOBS),
asyncMiddleware(pauseJobQueue)
)
jobsRouter.post('/resume',
authenticate,
ensureUserHasRight(UserRight.MANAGE_JOBS),
2023-02-16 11:56:58 +01:00
resumeJobQueue
)
2020-12-14 12:00:35 +01:00
jobsRouter.get('/:state?',
openapiOperationDoc({ operationId: 'getJobs' }),
2020-12-13 19:27:25 +01:00
authenticate,
ensureUserHasRight(UserRight.MANAGE_JOBS),
2021-03-09 09:22:05 +01:00
paginationValidatorBuilder([ 'jobs' ]),
2020-12-13 19:27:25 +01:00
jobsSortValidator,
setDefaultSort,
setDefaultPagination,
listJobsValidator,
asyncMiddleware(listJobs)
)
2017-11-30 10:51:13 +01:00
// ---------------------------------------------------------------------------
export {
jobsRouter
}
// ---------------------------------------------------------------------------
async function pauseJobQueue (req: express.Request, res: express.Response) {
await JobQueue.Instance.pause()
return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
}
2023-02-16 11:56:58 +01:00
function resumeJobQueue (req: express.Request, res: express.Response) {
JobQueue.Instance.resume()
return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
}
2019-10-21 14:50:55 +02:00
async function listJobs (req: express.Request, res: express.Response) {
2020-12-14 12:00:35 +01:00
const state = req.params.state as JobState
2018-07-10 17:02:20 +02:00
const asc = req.query.sort === 'createdAt'
2019-12-04 14:49:59 +01:00
const jobType = req.query.jobType
2019-12-04 14:49:59 +01:00
const jobs = await JobQueue.Instance.listForApi({
state,
start: req.query.start,
count: req.query.count,
asc,
jobType
})
2020-11-09 16:13:03 +01:00
const total = await JobQueue.Instance.count(state, jobType)
2020-01-31 16:56:52 +01:00
const result: ResultList<Job> = {
total,
2021-01-21 14:42:43 +01:00
data: await Promise.all(jobs.map(j => formatJob(j, state)))
}
2020-12-14 12:00:35 +01:00
return res.json(result)
}
2017-11-30 10:51:13 +01:00
2022-08-08 10:42:08 +02:00
async function formatJob (job: BullJob, state?: JobState): Promise<Job> {
return {
id: job.id,
2021-01-21 14:42:43 +01:00
state: state || await job.getState(),
2022-08-08 10:42:08 +02:00
type: job.queueName as JobType,
data: job.data,
parent: job.parent
? { id: job.parent.id }
: undefined,
2022-08-08 10:42:08 +02:00
progress: job.progress as number,
priority: job.opts.priority,
error: getJobError(job),
2018-07-10 17:02:20 +02:00
createdAt: new Date(job.timestamp),
finishedOn: new Date(job.finishedOn),
processedOn: new Date(job.processedOn)
}
2017-11-30 10:51:13 +01:00
}
function getJobError (job: BullJob) {
if (isArray(job.stacktrace) && job.stacktrace.length !== 0) return job.stacktrace[0]
if (job.failedReason) return job.failedReason
return null
}