X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fjob-queue%2Fjob-queue.ts;h=8597eb00018356dc081237b0f48f57cb7f8d6415;hb=1c30b112b9860255bdb458482c8dba9432419c49;hp=69335acf0b2a2d7dbec41f537e732c0edf9f9905;hpb=0138af9237b77dd7d3a49260d164193b4048de84;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/job-queue/job-queue.ts b/server/lib/job-queue/job-queue.ts index 69335acf0..8597eb000 100644 --- a/server/lib/job-queue/job-queue.ts +++ b/server/lib/job-queue/job-queue.ts @@ -1,179 +1,540 @@ -import * as kue from 'kue' -import { JobState, JobType } from '../../../shared/models' +import { + FlowJob, + FlowProducer, + Job, + JobsOptions, + Queue, + QueueEvents, + QueueEventsOptions, + QueueOptions, + QueueScheduler, + QueueSchedulerOptions, + Worker, + WorkerOptions +} from 'bullmq' +import { jobStates } from '@server/helpers/custom-validators/jobs' +import { CONFIG } from '@server/initializers/config' +import { processVideoRedundancy } from '@server/lib/job-queue/handlers/video-redundancy' +import { pick, timeoutPromise } from '@shared/core-utils' +import { + ActivitypubFollowPayload, + ActivitypubHttpBroadcastPayload, + ActivitypubHttpFetcherPayload, + ActivitypubHttpUnicastPayload, + ActorKeysPayload, + AfterVideoChannelImportPayload, + DeleteResumableUploadMetaFilePayload, + EmailPayload, + FederateVideoPayload, + JobState, + JobType, + ManageVideoTorrentPayload, + MoveObjectStoragePayload, + NotifyPayload, + RefreshPayload, + VideoChannelImportPayload, + VideoFileImportPayload, + VideoImportPayload, + VideoLiveEndingPayload, + VideoRedundancyPayload, + VideoStudioEditionPayload, + VideoTranscodingPayload +} from '../../../shared/models' import { logger } from '../../helpers/logger' -import { CONFIG, JOB_ATTEMPTS, JOB_COMPLETED_LIFETIME, JOB_CONCURRENCY, JOB_REQUEST_TTL } from '../../initializers' +import { + JOB_ATTEMPTS, + JOB_CONCURRENCY, + JOB_REMOVAL_OPTIONS, + JOB_TTL, + REPEAT_JOBS, + WEBSERVER +} from '../../initializers/constants' +import { Hooks } from '../plugins/hooks' import { Redis } from '../redis' -import { ActivitypubHttpBroadcastPayload, processActivityPubHttpBroadcast } from './handlers/activitypub-http-broadcast' -import { ActivitypubHttpFetcherPayload, processActivityPubHttpFetcher } from './handlers/activitypub-http-fetcher' -import { ActivitypubHttpUnicastPayload, processActivityPubHttpUnicast } from './handlers/activitypub-http-unicast' -import { EmailPayload, processEmail } from './handlers/email' -import { processVideoFile, processVideoImport, VideoFilePayload, VideoImportPayload } from './handlers/video-file' -import { ActivitypubFollowPayload, processActivityPubFollow } from './handlers/activitypub-follow' - -type CreateJobArgument = +import { processActivityPubCleaner } from './handlers/activitypub-cleaner' +import { processActivityPubFollow } from './handlers/activitypub-follow' +import { processActivityPubHttpSequentialBroadcast, processActivityPubParallelHttpBroadcast } from './handlers/activitypub-http-broadcast' +import { processActivityPubHttpFetcher } from './handlers/activitypub-http-fetcher' +import { processActivityPubHttpUnicast } from './handlers/activitypub-http-unicast' +import { refreshAPObject } from './handlers/activitypub-refresher' +import { processActorKeys } from './handlers/actor-keys' +import { processAfterVideoChannelImport } from './handlers/after-video-channel-import' +import { processEmail } from './handlers/email' +import { processFederateVideo } from './handlers/federate-video' +import { processManageVideoTorrent } from './handlers/manage-video-torrent' +import { onMoveToObjectStorageFailure, processMoveToObjectStorage } from './handlers/move-to-object-storage' +import { processNotify } from './handlers/notify' +import { processVideoChannelImport } from './handlers/video-channel-import' +import { processVideoFileImport } from './handlers/video-file-import' +import { processVideoImport } from './handlers/video-import' +import { processVideoLiveEnding } from './handlers/video-live-ending' +import { processVideoStudioEdition } from './handlers/video-studio-edition' +import { processVideoTranscoding } from './handlers/video-transcoding' +import { processVideosViewsStats } from './handlers/video-views-stats' +import { parseDurationToMs } from '@server/helpers/core-utils' + +export type CreateJobArgument = { type: 'activitypub-http-broadcast', payload: ActivitypubHttpBroadcastPayload } | + { type: 'activitypub-http-broadcast-parallel', payload: ActivitypubHttpBroadcastPayload } | { type: 'activitypub-http-unicast', payload: ActivitypubHttpUnicastPayload } | { type: 'activitypub-http-fetcher', payload: ActivitypubHttpFetcherPayload } | + { type: 'activitypub-http-cleaner', payload: {} } | { type: 'activitypub-follow', payload: ActivitypubFollowPayload } | - { type: 'video-file-import', payload: VideoImportPayload } | - { type: 'video-file', payload: VideoFilePayload } | - { type: 'email', payload: EmailPayload } + { type: 'video-file-import', payload: VideoFileImportPayload } | + { type: 'video-transcoding', payload: VideoTranscodingPayload } | + { type: 'email', payload: EmailPayload } | + { type: 'video-import', payload: VideoImportPayload } | + { type: 'activitypub-refresher', payload: RefreshPayload } | + { type: 'videos-views-stats', payload: {} } | + { type: 'video-live-ending', payload: VideoLiveEndingPayload } | + { type: 'actor-keys', payload: ActorKeysPayload } | + { type: 'video-redundancy', payload: VideoRedundancyPayload } | + { type: 'delete-resumable-upload-meta-file', payload: DeleteResumableUploadMetaFilePayload } | + { type: 'video-studio-edition', payload: VideoStudioEditionPayload } | + { type: 'manage-video-torrent', payload: ManageVideoTorrentPayload } | + { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } | + { type: 'video-channel-import', payload: VideoChannelImportPayload } | + { type: 'after-video-channel-import', payload: AfterVideoChannelImportPayload } | + { type: 'notify', payload: NotifyPayload } | + { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } | + { type: 'federate-video', payload: FederateVideoPayload } + +export type CreateJobOptions = { + delay?: number + priority?: number +} -const handlers: { [ id in JobType ]: (job: kue.Job) => Promise} = { - 'activitypub-http-broadcast': processActivityPubHttpBroadcast, +const handlers: { [id in JobType]: (job: Job) => Promise } = { + 'activitypub-http-broadcast': processActivityPubHttpSequentialBroadcast, + 'activitypub-http-broadcast-parallel': processActivityPubParallelHttpBroadcast, 'activitypub-http-unicast': processActivityPubHttpUnicast, 'activitypub-http-fetcher': processActivityPubHttpFetcher, + 'activitypub-cleaner': processActivityPubCleaner, 'activitypub-follow': processActivityPubFollow, - 'video-file-import': processVideoImport, - 'video-file': processVideoFile, - 'email': processEmail + 'video-file-import': processVideoFileImport, + 'video-transcoding': processVideoTranscoding, + 'email': processEmail, + 'video-import': processVideoImport, + 'videos-views-stats': processVideosViewsStats, + 'activitypub-refresher': refreshAPObject, + 'video-live-ending': processVideoLiveEnding, + 'actor-keys': processActorKeys, + 'video-redundancy': processVideoRedundancy, + 'move-to-object-storage': processMoveToObjectStorage, + 'manage-video-torrent': processManageVideoTorrent, + 'video-studio-edition': processVideoStudioEdition, + 'video-channel-import': processVideoChannelImport, + 'after-video-channel-import': processAfterVideoChannelImport, + 'notify': processNotify, + 'federate-video': processFederateVideo +} + +const errorHandlers: { [id in JobType]?: (job: Job, err: any) => Promise } = { + 'move-to-object-storage': onMoveToObjectStorageFailure } -const jobsWithTLL: JobType[] = [ +const jobTypes: JobType[] = [ + 'activitypub-follow', 'activitypub-http-broadcast', - 'activitypub-http-unicast', + 'activitypub-http-broadcast-parallel', 'activitypub-http-fetcher', - 'activitypub-follow' + 'activitypub-http-unicast', + 'activitypub-cleaner', + 'email', + 'video-transcoding', + 'video-file-import', + 'video-import', + 'videos-views-stats', + 'activitypub-refresher', + 'video-redundancy', + 'actor-keys', + 'video-live-ending', + 'move-to-object-storage', + 'manage-video-torrent', + 'video-studio-edition', + 'video-channel-import', + 'after-video-channel-import', + 'notify', + 'federate-video' ] +const silentFailure = new Set([ 'activitypub-http-unicast' ]) + class JobQueue { private static instance: JobQueue - private jobQueue: kue.Queue + private workers: { [id in JobType]?: Worker } = {} + private queues: { [id in JobType]?: Queue } = {} + private queueSchedulers: { [id in JobType]?: QueueScheduler } = {} + private queueEvents: { [id in JobType]?: QueueEvents } = {} + + private flowProducer: FlowProducer + private initialized = false private jobRedisPrefix: string - private constructor () {} + private constructor () { + } - async init () { + init () { // Already initialized if (this.initialized === true) return this.initialized = true - this.jobRedisPrefix = 'q-' + CONFIG.WEBSERVER.HOST + this.jobRedisPrefix = 'bull-' + WEBSERVER.HOST + + for (const handlerName of Object.keys(handlers)) { + this.buildWorker(handlerName) + this.buildQueue(handlerName) + this.buildQueueScheduler(handlerName) + this.buildQueueEvent(handlerName) + } + + this.flowProducer = new FlowProducer({ + connection: Redis.getRedisClientOptions('FlowProducer'), + prefix: this.jobRedisPrefix + }) + this.flowProducer.on('error', err => { logger.error('Error in flow producer', { err }) }) + + this.addRepeatableJobs() + } - this.jobQueue = kue.createQueue({ + private buildWorker (handlerName: JobType) { + const workerOptions: WorkerOptions = { + autorun: false, + concurrency: this.getJobConcurrency(handlerName), prefix: this.jobRedisPrefix, - redis: { - host: CONFIG.REDIS.HOSTNAME, - port: CONFIG.REDIS.PORT, - auth: CONFIG.REDIS.AUTH, - db: CONFIG.REDIS.DB + connection: Redis.getRedisClientOptions('Worker') + } + + const handler = function (job: Job) { + const timeout = JOB_TTL[handlerName] + const p = handlers[handlerName](job) + + if (!timeout) return p + + return timeoutPromise(p, timeout) + } + + const processor = async (jobArg: Job) => { + const job = await Hooks.wrapObject(jobArg, 'filter:job-queue.process.params', { type: handlerName }) + + return Hooks.wrapPromiseFun(handler, job, 'filter:job-queue.process.result') + } + + const worker = new Worker(handlerName, processor, workerOptions) + + worker.on('failed', (job, err) => { + const logLevel = silentFailure.has(handlerName) + ? 'debug' + : 'error' + + logger.log(logLevel, 'Cannot execute job %s in queue %s.', job.id, handlerName, { payload: job.data, err }) + + if (errorHandlers[job.name]) { + errorHandlers[job.name](job, err) + .catch(err => logger.error('Cannot run error handler for job failure %d in queue %s.', job.id, handlerName, { err })) } }) - this.jobQueue.setMaxListeners(20) + worker.on('error', err => { logger.error('Error in job worker %s.', handlerName, { err }) }) - this.jobQueue.on('error', err => { - logger.error('Error in job queue.', { err }) - process.exit(-1) - }) - this.jobQueue.watchStuckJobs(5000) + this.workers[handlerName] = worker + } - await this.reactiveStuckJobs() + private buildQueue (handlerName: JobType) { + const queueOptions: QueueOptions = { + connection: Redis.getRedisClientOptions('Queue'), + prefix: this.jobRedisPrefix + } - for (const handlerName of Object.keys(handlers)) { - this.jobQueue.process(handlerName, JOB_CONCURRENCY[handlerName], async (job, done) => { - try { - const res = await handlers[ handlerName ](job) - return done(null, res) - } catch (err) { - return done(err) - } + const queue = new Queue(handlerName, queueOptions) + queue.on('error', err => { logger.error('Error in job queue %s.', handlerName, { err }) }) + + this.queues[handlerName] = queue + } + + private buildQueueScheduler (handlerName: JobType) { + const queueSchedulerOptions: QueueSchedulerOptions = { + autorun: false, + connection: Redis.getRedisClientOptions('QueueScheduler'), + prefix: this.jobRedisPrefix, + maxStalledCount: 10 + } + + const queueScheduler = new QueueScheduler(handlerName, queueSchedulerOptions) + queueScheduler.on('error', err => { logger.error('Error in job queue scheduler %s.', handlerName, { err }) }) + + this.queueSchedulers[handlerName] = queueScheduler + } + + private buildQueueEvent (handlerName: JobType) { + const queueEventsOptions: QueueEventsOptions = { + autorun: false, + connection: Redis.getRedisClientOptions('QueueEvent'), + prefix: this.jobRedisPrefix + } + + const queueEvents = new QueueEvents(handlerName, queueEventsOptions) + queueEvents.on('error', err => { logger.error('Error in job queue events %s.', handlerName, { err }) }) + + this.queueEvents[handlerName] = queueEvents + } + + // --------------------------------------------------------------------------- + + async terminate () { + const promises = Object.keys(this.workers) + .map(handlerName => { + const worker: Worker = this.workers[handlerName] + const queue: Queue = this.queues[handlerName] + const queueScheduler: QueueScheduler = this.queueSchedulers[handlerName] + const queueEvent: QueueEvents = this.queueEvents[handlerName] + + return Promise.all([ + worker.close(false), + queue.close(), + queueScheduler.close(), + queueEvent.close() + ]) + }) + + return Promise.all(promises) + } + + start () { + const promises = Object.keys(this.workers) + .map(handlerName => { + const worker: Worker = this.workers[handlerName] + const queueScheduler: QueueScheduler = this.queueSchedulers[handlerName] + const queueEvent: QueueEvents = this.queueEvents[handlerName] + + return Promise.all([ + worker.run(), + queueScheduler.run(), + queueEvent.run() + ]) }) + + return Promise.all(promises) + } + + async pause () { + for (const handlerName of Object.keys(this.workers)) { + const worker: Worker = this.workers[handlerName] + + await worker.pause() + } + } + + resume () { + for (const handlerName of Object.keys(this.workers)) { + const worker: Worker = this.workers[handlerName] + + worker.resume() } } - createJob (obj: CreateJobArgument, priority = 'normal') { - return new Promise((res, rej) => { - let job = this.jobQueue - .create(obj.type, obj.payload) - .priority(priority) - .attempts(JOB_ATTEMPTS[obj.type]) - .backoff({ delay: 60 * 1000, type: 'exponential' }) + // --------------------------------------------------------------------------- - if (jobsWithTLL.indexOf(obj.type) !== -1) { - job = job.ttl(JOB_REQUEST_TTL) + createJobAsync (options: CreateJobArgument & CreateJobOptions): void { + this.createJob(options) + .catch(err => logger.error('Cannot create job.', { err, options })) + } + + createJob (options: CreateJobArgument & CreateJobOptions) { + const queue: Queue = this.queues[options.type] + if (queue === undefined) { + logger.error('Unknown queue %s: cannot create job.', options.type) + return + } + + const jobOptions = this.buildJobOptions(options.type as JobType, pick(options, [ 'priority', 'delay' ])) + + return queue.add('job', options.payload, jobOptions) + } + + createSequentialJobFlow (...jobs: ((CreateJobArgument & CreateJobOptions) | undefined)[]) { + let lastJob: FlowJob + + for (const job of jobs) { + if (!job) continue + + lastJob = { + ...this.buildJobFlowOption(job), + + children: lastJob + ? [ lastJob ] + : [] } + } - return job.save(err => { - if (err) return rej(err) + return this.flowProducer.add(lastJob) + } - return res() - }) + createJobWithChildren (parent: CreateJobArgument & CreateJobOptions, children: (CreateJobArgument & CreateJobOptions)[]) { + return this.flowProducer.add({ + ...this.buildJobFlowOption(parent), + + children: children.map(c => this.buildJobFlowOption(c)) }) } - async listForApi (state: JobState, start: number, count: number, sort: 'ASC' | 'DESC'): Promise { - const jobStrings = await Redis.Instance.listJobs(this.jobRedisPrefix, state, 'alpha', sort, start, count) + private buildJobFlowOption (job: CreateJobArgument & CreateJobOptions): FlowJob { + return { + name: 'job', + data: job.payload, + queueName: job.type, + opts: this.buildJobOptions(job.type as JobType, pick(job, [ 'priority', 'delay' ])) + } + } - const jobPromises = jobStrings - .map(s => s.split('|')) - .map(([ , jobId ]) => this.getJob(parseInt(jobId, 10))) + private buildJobOptions (type: JobType, options: CreateJobOptions = {}): JobsOptions { + return { + backoff: { delay: 60 * 1000, type: 'exponential' }, + attempts: JOB_ATTEMPTS[type], + priority: options.priority, + delay: options.delay, - return Promise.all(jobPromises) + ...this.buildJobRemovalOptions(type) + } } - count (state: JobState) { - return new Promise((res, rej) => { - this.jobQueue[state + 'Count']((err, total) => { - if (err) return rej(err) + // --------------------------------------------------------------------------- - return res(total) - }) + async listForApi (options: { + state?: JobState + start: number + count: number + asc?: boolean + jobType: JobType + }): Promise { + const { state, start, count, asc, jobType } = options + + const states = this.buildStateFilter(state) + const filteredJobTypes = this.buildTypeFilter(jobType) + + let results: Job[] = [] + + for (const jobType of filteredJobTypes) { + const queue: Queue = this.queues[jobType] + + if (queue === undefined) { + logger.error('Unknown queue %s to list jobs.', jobType) + continue + } + + const jobs = await queue.getJobs(states, 0, start + count, asc) + results = results.concat(jobs) + } + + results.sort((j1: any, j2: any) => { + if (j1.timestamp < j2.timestamp) return -1 + else if (j1.timestamp === j2.timestamp) return 0 + + return 1 }) + + if (asc === false) results.reverse() + + return results.slice(start, start + count) } - removeOldJobs () { - const now = new Date().getTime() - kue.Job.rangeByState('complete', 0, -1, 'asc', (err, jobs) => { - if (err) { - logger.error('Cannot get jobs when removing old jobs.', { err }) - return + async count (state: JobState, jobType?: JobType): Promise { + const states = state ? [ state ] : jobStates + const filteredJobTypes = this.buildTypeFilter(jobType) + + let total = 0 + + for (const type of filteredJobTypes) { + const queue = this.queues[type] + if (queue === undefined) { + logger.error('Unknown queue %s to count jobs.', type) + continue } - for (const job of jobs) { - if (now - job.created_at > JOB_COMPLETED_LIFETIME) { - job.remove() - } + const counts = await queue.getJobCounts() + + for (const s of states) { + total += counts[s] } - }) + } + + return total } - private reactiveStuckJobs () { - const promises: Promise[] = [] + private buildStateFilter (state?: JobState) { + if (!state) return jobStates - this.jobQueue.active((err, ids) => { - if (err) throw err + const states = [ state ] - for (const id of ids) { - kue.Job.get(id, (err, job) => { - if (err) throw err + // Include parent if filtering on waiting + if (state === 'waiting') states.push('waiting-children') - const p = new Promise((res, rej) => { - job.inactive(err => { - if (err) return rej(err) - return res() - }) - }) + return states + } - promises.push(p) - }) - } - }) + private buildTypeFilter (jobType?: JobType) { + if (!jobType) return jobTypes + + return jobTypes.filter(t => t === jobType) + } + + async getStats () { + const promises = jobTypes.map(async t => ({ jobType: t, counts: await this.queues[t].getJobCounts() })) return Promise.all(promises) } - private getJob (id: number) { - return new Promise((res, rej) => { - kue.Job.get(id, (err, job) => { - if (err) return rej(err) + // --------------------------------------------------------------------------- - return res(job) - }) - }) + async removeOldJobs () { + for (const key of Object.keys(this.queues)) { + const queue: Queue = this.queues[key] + await queue.clean(parseDurationToMs('7 days'), 1000, 'completed') + await queue.clean(parseDurationToMs('7 days'), 1000, 'failed') + } + } + + private addRepeatableJobs () { + this.queues['videos-views-stats'].add('job', {}, { + repeat: REPEAT_JOBS['videos-views-stats'], + + ...this.buildJobRemovalOptions('videos-views-stats') + }).catch(err => logger.error('Cannot add repeatable job.', { err })) + + if (CONFIG.FEDERATION.VIDEOS.CLEANUP_REMOTE_INTERACTIONS) { + this.queues['activitypub-cleaner'].add('job', {}, { + repeat: REPEAT_JOBS['activitypub-cleaner'], + + ...this.buildJobRemovalOptions('activitypub-cleaner') + }).catch(err => logger.error('Cannot add repeatable job.', { err })) + } + } + + private getJobConcurrency (jobType: JobType) { + if (jobType === 'video-transcoding') return CONFIG.TRANSCODING.CONCURRENCY + if (jobType === 'video-import') return CONFIG.IMPORT.VIDEOS.CONCURRENCY + + return JOB_CONCURRENCY[jobType] + } + + private buildJobRemovalOptions (queueName: string) { + return { + removeOnComplete: { + // Wants seconds + age: (JOB_REMOVAL_OPTIONS.SUCCESS[queueName] || JOB_REMOVAL_OPTIONS.SUCCESS.DEFAULT) / 1000, + + count: JOB_REMOVAL_OPTIONS.COUNT + }, + removeOnFail: { + // Wants seconds + age: (JOB_REMOVAL_OPTIONS.FAILURE[queueName] || JOB_REMOVAL_OPTIONS.FAILURE.DEFAULT) / 1000, + + count: JOB_REMOVAL_OPTIONS.COUNT / 1000 + } + } } static get Instance () { @@ -184,5 +545,6 @@ class JobQueue { // --------------------------------------------------------------------------- export { + jobTypes, JobQueue }