-import * as Bull from 'bull'
-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 {
+ 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 { CONFIG, JOB_ATTEMPTS, JOB_COMPLETED_LIFETIME, JOB_CONCURRENCY, JOB_TTL, REPEAT_JOBS } from '../../initializers'
-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, processVideoFileImport, VideoFileImportPayload, VideoFilePayload } from './handlers/video-file'
-import { ActivitypubFollowPayload, processActivityPubFollow } from './handlers/activitypub-follow'
-import { processVideoImport, VideoImportPayload } from './handlers/video-import'
-import { processVideosViews } from './handlers/video-views'
-import { refreshAPObject, RefreshPayload } from './handlers/activitypub-refresher'
-
-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: VideoFileImportPayload } |
- { type: 'video-file', payload: VideoFilePayload } |
+ { type: 'video-transcoding', payload: VideoTranscodingPayload } |
{ type: 'email', payload: EmailPayload } |
{ type: 'video-import', payload: VideoImportPayload } |
{ type: 'activitypub-refresher', payload: RefreshPayload } |
- { type: 'videos-views', payload: {} }
+ { 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: Bull.Job) => Promise<any>} = {
- 'activitypub-http-broadcast': processActivityPubHttpBroadcast,
+const handlers: { [id in JobType]: (job: Job) => Promise<any> } = {
+ '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': processVideoFileImport,
- 'video-file': processVideoFile,
+ 'video-transcoding': processVideoTranscoding,
'email': processEmail,
'video-import': processVideoImport,
- 'videos-views': processVideosViews,
- 'activitypub-refresher': refreshAPObject
+ '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<any> } = {
+ 'move-to-object-storage': onMoveToObjectStorageFailure
}
const jobTypes: JobType[] = [
'activitypub-follow',
'activitypub-http-broadcast',
+ 'activitypub-http-broadcast-parallel',
'activitypub-http-fetcher',
'activitypub-http-unicast',
+ 'activitypub-cleaner',
'email',
- 'video-file',
+ 'video-transcoding',
'video-file-import',
'video-import',
- 'videos-views',
- 'activitypub-refresher'
+ '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<JobType>([ 'activitypub-http-unicast' ])
+
class JobQueue {
private static instance: JobQueue
- private queues: { [ id in JobType ]?: Bull.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 = 'bull-' + CONFIG.WEBSERVER.HOST
- const queueOptions = {
+ this.jobRedisPrefix = 'bull-' + WEBSERVER.HOST
+
+ for (const handlerName of (Object.keys(handlers) as JobType[])) {
+ 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()
+ }
+
+ private buildWorker (handlerName: JobType) {
+ const workerOptions: WorkerOptions = {
+ autorun: false,
+ concurrency: this.getJobConcurrency(handlerName),
prefix: this.jobRedisPrefix,
- redis: Redis.getRedisClient(),
- settings: {
- maxStalledCount: 10 // transcoding could be long, so jobs can often be interrupted by restarts
+ 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<any>) => {
+ 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 }))
}
+ })
+
+ worker.on('error', err => { logger.error('Error in job worker %s.', handlerName, { err }) })
+
+ this.workers[handlerName] = worker
+ }
+
+ private buildQueue (handlerName: JobType) {
+ const queueOptions: QueueOptions = {
+ connection: Redis.getRedisClientOptions('Queue'),
+ prefix: this.jobRedisPrefix
+ }
+
+ 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
}
- for (const handlerName of Object.keys(handlers)) {
- const queue = new Bull(handlerName, queueOptions)
- const handler = handlers[handlerName]
+ const queueScheduler = new QueueScheduler(handlerName, queueSchedulerOptions)
+ queueScheduler.on('error', err => { logger.error('Error in job queue scheduler %s.', handlerName, { err }) })
- queue.process(JOB_CONCURRENCY[handlerName], handler)
- .catch(err => logger.error('Error in job queue processor %s.', handlerName, { err }))
+ this.queueSchedulers[handlerName] = queueScheduler
+ }
+
+ private buildQueueEvent (handlerName: JobType) {
+ const queueEventsOptions: QueueEventsOptions = {
+ autorun: false,
+ connection: Redis.getRedisClientOptions('QueueEvent'),
+ prefix: this.jobRedisPrefix
+ }
- queue.on('failed', (job, err) => {
- logger.error('Cannot execute job %d in queue %s.', job.id, handlerName, { payload: job.data, err })
+ 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()
+ ])
})
- queue.on('error', err => {
- logger.error('Error in job queue %s.', handlerName, { err })
+ 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()
+ ])
})
- this.queues[handlerName] = queue
- }
+ return Promise.all(promises)
+ }
- this.addRepeatableJobs()
+ async pause () {
+ for (const handlerName of Object.keys(this.workers)) {
+ const worker: Worker = this.workers[handlerName]
+
+ await worker.pause()
+ }
}
- terminate () {
- for (const queueName of Object.keys(this.queues)) {
- const queue = this.queues[queueName]
- queue.close()
+ resume () {
+ for (const handlerName of Object.keys(this.workers)) {
+ const worker: Worker = this.workers[handlerName]
+
+ worker.resume()
}
}
- createJob (obj: CreateJobArgument) {
- const queue = this.queues[obj.type]
+ // ---------------------------------------------------------------------------
+
+ 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.', obj.type)
- throw Error('Unknown queue, cannot create job')
+ logger.error('Unknown queue %s: cannot create job.', options.type)
+ return
}
- const jobArgs: Bull.JobOptions = {
- backoff: { delay: 60 * 1000, type: 'exponential' },
- attempts: JOB_ATTEMPTS[obj.type],
- timeout: JOB_TTL[obj.type]
+ 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 queue.add(obj.payload, jobArgs)
+ return this.flowProducer.add(lastJob)
}
- async listForApi (state: JobState, start: number, count: number, asc?: boolean): Promise<Bull.Job[]> {
- let results: Bull.Job[] = []
+ createJobWithChildren (parent: CreateJobArgument & CreateJobOptions, children: (CreateJobArgument & CreateJobOptions)[]) {
+ return this.flowProducer.add({
+ ...this.buildJobFlowOption(parent),
+
+ children: children.map(c => this.buildJobFlowOption(c))
+ })
+ }
+
+ 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' ]))
+ }
+ }
+
+ private buildJobOptions (type: JobType, options: CreateJobOptions = {}): JobsOptions {
+ return {
+ backoff: { delay: 60 * 1000, type: 'exponential' },
+ attempts: JOB_ATTEMPTS[type],
+ priority: options.priority,
+ delay: options.delay,
+
+ ...this.buildJobRemovalOptions(type)
+ }
+ }
+
+ // ---------------------------------------------------------------------------
+
+ async listForApi (options: {
+ state?: JobState
+ start: number
+ count: number
+ asc?: boolean
+ jobType: JobType
+ }): Promise<Job[]> {
+ 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]
- // TODO: optimize
- for (const jobType of jobTypes) {
- const queue = this.queues[ jobType ]
if (queue === undefined) {
logger.error('Unknown queue %s to list jobs.', jobType)
continue
}
- // FIXME: Bull queue typings does not have getJobs method
- const jobs = await (queue as any).getJobs(state, 0, start + count, asc)
+ const jobs = await queue.getJobs(states, 0, start + count, asc)
results = results.concat(jobs)
}
return results.slice(start, start + count)
}
- async count (state: JobState): Promise<number> {
+ async count (state: JobState, jobType?: JobType): Promise<number> {
+ const states = state ? [ state ] : jobStates
+ const filteredJobTypes = this.buildTypeFilter(jobType)
+
let total = 0
- for (const type of jobTypes) {
- const queue = this.queues[ type ]
+ for (const type of filteredJobTypes) {
+ const queue = this.queues[type]
if (queue === undefined) {
logger.error('Unknown queue %s to count jobs.', type)
continue
const counts = await queue.getJobCounts()
- total += counts[ state ]
+ for (const s of states) {
+ total += counts[s]
+ }
}
return total
}
- removeOldJobs () {
+ private buildStateFilter (state?: JobState) {
+ if (!state) return jobStates
+
+ const states = [ state ]
+
+ // Include parent if filtering on waiting
+ if (state === 'waiting') states.push('waiting-children')
+
+ return states
+ }
+
+ 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)
+ }
+
+ // ---------------------------------------------------------------------------
+
+ async removeOldJobs () {
for (const key of Object.keys(this.queues)) {
- const queue = this.queues[key]
- queue.clean(JOB_COMPLETED_LIFETIME, 'completed')
+ 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'].add({}, {
- repeat: REPEAT_JOBS['videos-views']
- })
+ 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 () {
// ---------------------------------------------------------------------------
export {
+ jobTypes,
JobQueue
}
projects / github / Chocobozzz / PeerTube.git / blobdiff