13 import { parseDurationToMs } from '@server/helpers/core-utils'
14 import { jobStates } from '@server/helpers/custom-validators/jobs'
15 import { CONFIG } from '@server/initializers/config'
16 import { processVideoRedundancy } from '@server/lib/job-queue/handlers/video-redundancy'
17 import { pick, timeoutPromise } from '@shared/core-utils'
19 ActivitypubFollowPayload,
20 ActivitypubHttpBroadcastPayload,
21 ActivitypubHttpFetcherPayload,
22 ActivitypubHttpUnicastPayload,
24 AfterVideoChannelImportPayload,
25 DeleteResumableUploadMetaFilePayload,
30 ManageVideoTorrentPayload,
31 MoveObjectStoragePayload,
34 TranscodingJobBuilderPayload,
35 VideoChannelImportPayload,
36 VideoFileImportPayload,
38 VideoLiveEndingPayload,
39 VideoRedundancyPayload,
40 VideoStudioEditionPayload,
41 VideoTranscodingPayload
42 } from '../../../shared/models'
43 import { logger } from '../../helpers/logger'
44 import { JOB_ATTEMPTS, JOB_CONCURRENCY, JOB_REMOVAL_OPTIONS, JOB_TTL, REPEAT_JOBS, WEBSERVER } from '../../initializers/constants'
45 import { Hooks } from '../plugins/hooks'
46 import { Redis } from '../redis'
47 import { processActivityPubCleaner } from './handlers/activitypub-cleaner'
48 import { processActivityPubFollow } from './handlers/activitypub-follow'
49 import { processActivityPubHttpSequentialBroadcast, processActivityPubParallelHttpBroadcast } from './handlers/activitypub-http-broadcast'
50 import { processActivityPubHttpFetcher } from './handlers/activitypub-http-fetcher'
51 import { processActivityPubHttpUnicast } from './handlers/activitypub-http-unicast'
52 import { refreshAPObject } from './handlers/activitypub-refresher'
53 import { processActorKeys } from './handlers/actor-keys'
54 import { processAfterVideoChannelImport } from './handlers/after-video-channel-import'
55 import { processEmail } from './handlers/email'
56 import { processFederateVideo } from './handlers/federate-video'
57 import { processManageVideoTorrent } from './handlers/manage-video-torrent'
58 import { onMoveToObjectStorageFailure, processMoveToObjectStorage } from './handlers/move-to-object-storage'
59 import { processNotify } from './handlers/notify'
60 import { processTranscodingJobBuilder } from './handlers/transcoding-job-builder'
61 import { processVideoChannelImport } from './handlers/video-channel-import'
62 import { processVideoFileImport } from './handlers/video-file-import'
63 import { processVideoImport } from './handlers/video-import'
64 import { processVideoLiveEnding } from './handlers/video-live-ending'
65 import { processVideoStudioEdition } from './handlers/video-studio-edition'
66 import { processVideoTranscoding } from './handlers/video-transcoding'
67 import { processVideosViewsStats } from './handlers/video-views-stats'
69 export type CreateJobArgument =
70 { type: 'activitypub-http-broadcast', payload: ActivitypubHttpBroadcastPayload } |
71 { type: 'activitypub-http-broadcast-parallel', payload: ActivitypubHttpBroadcastPayload } |
72 { type: 'activitypub-http-unicast', payload: ActivitypubHttpUnicastPayload } |
73 { type: 'activitypub-http-fetcher', payload: ActivitypubHttpFetcherPayload } |
74 { type: 'activitypub-cleaner', payload: {} } |
75 { type: 'activitypub-follow', payload: ActivitypubFollowPayload } |
76 { type: 'video-file-import', payload: VideoFileImportPayload } |
77 { type: 'video-transcoding', payload: VideoTranscodingPayload } |
78 { type: 'email', payload: EmailPayload } |
79 { type: 'transcoding-job-builder', payload: TranscodingJobBuilderPayload } |
80 { type: 'video-import', payload: VideoImportPayload } |
81 { type: 'activitypub-refresher', payload: RefreshPayload } |
82 { type: 'videos-views-stats', payload: {} } |
83 { type: 'video-live-ending', payload: VideoLiveEndingPayload } |
84 { type: 'actor-keys', payload: ActorKeysPayload } |
85 { type: 'video-redundancy', payload: VideoRedundancyPayload } |
86 { type: 'delete-resumable-upload-meta-file', payload: DeleteResumableUploadMetaFilePayload } |
87 { type: 'video-studio-edition', payload: VideoStudioEditionPayload } |
88 { type: 'manage-video-torrent', payload: ManageVideoTorrentPayload } |
89 { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } |
90 { type: 'video-channel-import', payload: VideoChannelImportPayload } |
91 { type: 'after-video-channel-import', payload: AfterVideoChannelImportPayload } |
92 { type: 'notify', payload: NotifyPayload } |
93 { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } |
94 { type: 'federate-video', payload: FederateVideoPayload }
96 export type CreateJobOptions = {
101 const handlers: { [id in JobType]: (job: Job) => Promise<any> } = {
102 'activitypub-cleaner': processActivityPubCleaner,
103 'activitypub-follow': processActivityPubFollow,
104 'activitypub-http-broadcast-parallel': processActivityPubParallelHttpBroadcast,
105 'activitypub-http-broadcast': processActivityPubHttpSequentialBroadcast,
106 'activitypub-http-fetcher': processActivityPubHttpFetcher,
107 'activitypub-http-unicast': processActivityPubHttpUnicast,
108 'activitypub-refresher': refreshAPObject,
109 'actor-keys': processActorKeys,
110 'after-video-channel-import': processAfterVideoChannelImport,
111 'email': processEmail,
112 'federate-video': processFederateVideo,
113 'transcoding-job-builder': processTranscodingJobBuilder,
114 'manage-video-torrent': processManageVideoTorrent,
115 'move-to-object-storage': processMoveToObjectStorage,
116 'notify': processNotify,
117 'video-channel-import': processVideoChannelImport,
118 'video-file-import': processVideoFileImport,
119 'video-import': processVideoImport,
120 'video-live-ending': processVideoLiveEnding,
121 'video-redundancy': processVideoRedundancy,
122 'video-studio-edition': processVideoStudioEdition,
123 'video-transcoding': processVideoTranscoding,
124 'videos-views-stats': processVideosViewsStats
127 const errorHandlers: { [id in JobType]?: (job: Job, err: any) => Promise<any> } = {
128 'move-to-object-storage': onMoveToObjectStorageFailure
131 const jobTypes: JobType[] = [
132 'activitypub-cleaner',
133 'activitypub-follow',
134 'activitypub-http-broadcast-parallel',
135 'activitypub-http-broadcast',
136 'activitypub-http-fetcher',
137 'activitypub-http-unicast',
138 'activitypub-refresher',
140 'after-video-channel-import',
143 'transcoding-job-builder',
144 'manage-video-torrent',
145 'move-to-object-storage',
147 'video-channel-import',
152 'video-studio-edition',
157 const silentFailure = new Set<JobType>([ 'activitypub-http-unicast' ])
161 private static instance: JobQueue
163 private workers: { [id in JobType]?: Worker } = {}
164 private queues: { [id in JobType]?: Queue } = {}
165 private queueEvents: { [id in JobType]?: QueueEvents } = {}
167 private flowProducer: FlowProducer
169 private initialized = false
170 private jobRedisPrefix: string
172 private constructor () {
176 // Already initialized
177 if (this.initialized === true) return
178 this.initialized = true
180 this.jobRedisPrefix = 'bull-' + WEBSERVER.HOST
182 for (const handlerName of Object.keys(handlers)) {
183 this.buildWorker(handlerName)
184 this.buildQueue(handlerName)
185 this.buildQueueEvent(handlerName)
188 this.flowProducer = new FlowProducer({
189 connection: Redis.getRedisClientOptions('FlowProducer'),
190 prefix: this.jobRedisPrefix
192 this.flowProducer.on('error', err => { logger.error('Error in flow producer', { err }) })
194 this.addRepeatableJobs()
197 private buildWorker (handlerName: JobType) {
198 const workerOptions: WorkerOptions = {
200 concurrency: this.getJobConcurrency(handlerName),
201 prefix: this.jobRedisPrefix,
202 connection: Redis.getRedisClientOptions('Worker'),
206 const handler = function (job: Job) {
207 const timeout = JOB_TTL[handlerName]
208 const p = handlers[handlerName](job)
210 if (!timeout) return p
212 return timeoutPromise(p, timeout)
215 const processor = async (jobArg: Job<any>) => {
216 const job = await Hooks.wrapObject(jobArg, 'filter:job-queue.process.params', { type: handlerName })
218 return Hooks.wrapPromiseFun(handler, job, 'filter:job-queue.process.result')
221 const worker = new Worker(handlerName, processor, workerOptions)
223 worker.on('failed', (job, err) => {
224 const logLevel = silentFailure.has(handlerName)
228 logger.log(logLevel, 'Cannot execute job %s in queue %s.', job.id, handlerName, { payload: job.data, err })
230 if (errorHandlers[job.name]) {
231 errorHandlers[job.name](job, err)
232 .catch(err => logger.error('Cannot run error handler for job failure %d in queue %s.', job.id, handlerName, { err }))
236 worker.on('error', err => { logger.error('Error in job worker %s.', handlerName, { err }) })
238 this.workers[handlerName] = worker
241 private buildQueue (handlerName: JobType) {
242 const queueOptions: QueueOptions = {
243 connection: Redis.getRedisClientOptions('Queue'),
244 prefix: this.jobRedisPrefix
247 const queue = new Queue(handlerName, queueOptions)
248 queue.on('error', err => { logger.error('Error in job queue %s.', handlerName, { err }) })
250 this.queues[handlerName] = queue
253 private buildQueueEvent (handlerName: JobType) {
254 const queueEventsOptions: QueueEventsOptions = {
256 connection: Redis.getRedisClientOptions('QueueEvent'),
257 prefix: this.jobRedisPrefix
260 const queueEvents = new QueueEvents(handlerName, queueEventsOptions)
261 queueEvents.on('error', err => { logger.error('Error in job queue events %s.', handlerName, { err }) })
263 this.queueEvents[handlerName] = queueEvents
266 // ---------------------------------------------------------------------------
269 const promises = Object.keys(this.workers)
270 .map(handlerName => {
271 const worker: Worker = this.workers[handlerName]
272 const queue: Queue = this.queues[handlerName]
273 const queueEvent: QueueEvents = this.queueEvents[handlerName]
282 return Promise.all(promises)
286 const promises = Object.keys(this.workers)
287 .map(handlerName => {
288 const worker: Worker = this.workers[handlerName]
289 const queueEvent: QueueEvents = this.queueEvents[handlerName]
297 return Promise.all(promises)
301 for (const handlerName of Object.keys(this.workers)) {
302 const worker: Worker = this.workers[handlerName]
309 for (const handlerName of Object.keys(this.workers)) {
310 const worker: Worker = this.workers[handlerName]
316 // ---------------------------------------------------------------------------
318 createJobAsync (options: CreateJobArgument & CreateJobOptions): void {
319 this.createJob(options)
320 .catch(err => logger.error('Cannot create job.', { err, options }))
323 createJob (options: CreateJobArgument & CreateJobOptions) {
324 const queue: Queue = this.queues[options.type]
325 if (queue === undefined) {
326 logger.error('Unknown queue %s: cannot create job.', options.type)
330 const jobOptions = this.buildJobOptions(options.type as JobType, pick(options, [ 'priority', 'delay' ]))
332 return queue.add('job', options.payload, jobOptions)
335 createSequentialJobFlow (...jobs: ((CreateJobArgument & CreateJobOptions) | undefined)[]) {
338 for (const job of jobs) {
342 ...this.buildJobFlowOption(job),
350 return this.flowProducer.add(lastJob)
353 createJobWithChildren (parent: CreateJobArgument & CreateJobOptions, children: (CreateJobArgument & CreateJobOptions)[]) {
354 return this.flowProducer.add({
355 ...this.buildJobFlowOption(parent),
357 children: children.map(c => this.buildJobFlowOption(c))
361 private buildJobFlowOption (job: CreateJobArgument & CreateJobOptions): FlowJob {
366 opts: this.buildJobOptions(job.type as JobType, pick(job, [ 'priority', 'delay' ]))
370 private buildJobOptions (type: JobType, options: CreateJobOptions = {}): JobsOptions {
372 backoff: { delay: 60 * 1000, type: 'exponential' },
373 attempts: JOB_ATTEMPTS[type],
374 priority: options.priority,
375 delay: options.delay,
377 ...this.buildJobRemovalOptions(type)
381 // ---------------------------------------------------------------------------
383 async listForApi (options: {
390 const { state, start, count, asc, jobType } = options
392 const states = this.buildStateFilter(state)
393 const filteredJobTypes = this.buildTypeFilter(jobType)
395 let results: Job[] = []
397 for (const jobType of filteredJobTypes) {
398 const queue: Queue = this.queues[jobType]
400 if (queue === undefined) {
401 logger.error('Unknown queue %s to list jobs.', jobType)
405 const jobs = await queue.getJobs(states, 0, start + count, asc)
406 results = results.concat(jobs)
409 results.sort((j1: any, j2: any) => {
410 if (j1.timestamp < j2.timestamp) return -1
411 else if (j1.timestamp === j2.timestamp) return 0
416 if (asc === false) results.reverse()
418 return results.slice(start, start + count)
421 async count (state: JobState, jobType?: JobType): Promise<number> {
422 const states = state ? [ state ] : jobStates
423 const filteredJobTypes = this.buildTypeFilter(jobType)
427 for (const type of filteredJobTypes) {
428 const queue = this.queues[type]
429 if (queue === undefined) {
430 logger.error('Unknown queue %s to count jobs.', type)
434 const counts = await queue.getJobCounts()
436 for (const s of states) {
444 private buildStateFilter (state?: JobState) {
445 if (!state) return jobStates
447 const states = [ state ]
449 // Include parent if filtering on waiting
450 if (state === 'waiting') states.push('waiting-children')
455 private buildTypeFilter (jobType?: JobType) {
456 if (!jobType) return jobTypes
458 return jobTypes.filter(t => t === jobType)
462 const promises = jobTypes.map(async t => ({ jobType: t, counts: await this.queues[t].getJobCounts() }))
464 return Promise.all(promises)
467 // ---------------------------------------------------------------------------
469 async removeOldJobs () {
470 for (const key of Object.keys(this.queues)) {
471 const queue: Queue = this.queues[key]
472 await queue.clean(parseDurationToMs('7 days'), 1000, 'completed')
473 await queue.clean(parseDurationToMs('7 days'), 1000, 'failed')
477 private addRepeatableJobs () {
478 this.queues['videos-views-stats'].add('job', {}, {
479 repeat: REPEAT_JOBS['videos-views-stats'],
481 ...this.buildJobRemovalOptions('videos-views-stats')
482 }).catch(err => logger.error('Cannot add repeatable job.', { err }))
484 if (CONFIG.FEDERATION.VIDEOS.CLEANUP_REMOTE_INTERACTIONS) {
485 this.queues['activitypub-cleaner'].add('job', {}, {
486 repeat: REPEAT_JOBS['activitypub-cleaner'],
488 ...this.buildJobRemovalOptions('activitypub-cleaner')
489 }).catch(err => logger.error('Cannot add repeatable job.', { err }))
493 private getJobConcurrency (jobType: JobType) {
494 if (jobType === 'video-transcoding') return CONFIG.TRANSCODING.CONCURRENCY
495 if (jobType === 'video-import') return CONFIG.IMPORT.VIDEOS.CONCURRENCY
497 return JOB_CONCURRENCY[jobType]
500 private buildJobRemovalOptions (queueName: string) {
504 age: (JOB_REMOVAL_OPTIONS.SUCCESS[queueName] || JOB_REMOVAL_OPTIONS.SUCCESS.DEFAULT) / 1000,
506 count: JOB_REMOVAL_OPTIONS.COUNT
510 age: (JOB_REMOVAL_OPTIONS.FAILURE[queueName] || JOB_REMOVAL_OPTIONS.FAILURE.DEFAULT) / 1000,
512 count: JOB_REMOVAL_OPTIONS.COUNT / 1000
517 static get Instance () {
518 return this.instance || (this.instance = new this())
522 // ---------------------------------------------------------------------------