11 QueueSchedulerOptions,
15 import { jobStates } from '@server/helpers/custom-validators/jobs'
16 import { CONFIG } from '@server/initializers/config'
17 import { processVideoRedundancy } from '@server/lib/job-queue/handlers/video-redundancy'
18 import { pick, timeoutPromise } from '@shared/core-utils'
20 ActivitypubFollowPayload,
21 ActivitypubHttpBroadcastPayload,
22 ActivitypubHttpFetcherPayload,
23 ActivitypubHttpUnicastPayload,
25 AfterVideoChannelImportPayload,
26 DeleteResumableUploadMetaFilePayload,
31 ManageVideoTorrentPayload,
32 MoveObjectStoragePayload,
35 VideoChannelImportPayload,
36 VideoFileImportPayload,
38 VideoLiveEndingPayload,
39 VideoRedundancyPayload,
40 VideoStudioEditionPayload,
41 VideoTranscodingPayload
42 } from '../../../shared/models'
43 import { logger } from '../../helpers/logger'
51 } from '../../initializers/constants'
52 import { Hooks } from '../plugins/hooks'
53 import { Redis } from '../redis'
54 import { processActivityPubCleaner } from './handlers/activitypub-cleaner'
55 import { processActivityPubFollow } from './handlers/activitypub-follow'
56 import { processActivityPubHttpSequentialBroadcast, processActivityPubParallelHttpBroadcast } from './handlers/activitypub-http-broadcast'
57 import { processActivityPubHttpFetcher } from './handlers/activitypub-http-fetcher'
58 import { processActivityPubHttpUnicast } from './handlers/activitypub-http-unicast'
59 import { refreshAPObject } from './handlers/activitypub-refresher'
60 import { processActorKeys } from './handlers/actor-keys'
61 import { processAfterVideoChannelImport } from './handlers/after-video-channel-import'
62 import { processEmail } from './handlers/email'
63 import { processFederateVideo } from './handlers/federate-video'
64 import { processManageVideoTorrent } from './handlers/manage-video-torrent'
65 import { onMoveToObjectStorageFailure, processMoveToObjectStorage } from './handlers/move-to-object-storage'
66 import { processNotify } from './handlers/notify'
67 import { processVideoChannelImport } from './handlers/video-channel-import'
68 import { processVideoFileImport } from './handlers/video-file-import'
69 import { processVideoImport } from './handlers/video-import'
70 import { processVideoLiveEnding } from './handlers/video-live-ending'
71 import { processVideoStudioEdition } from './handlers/video-studio-edition'
72 import { processVideoTranscoding } from './handlers/video-transcoding'
73 import { processVideosViewsStats } from './handlers/video-views-stats'
74 import { parseDurationToMs } from '@server/helpers/core-utils'
76 export type CreateJobArgument =
77 { type: 'activitypub-http-broadcast', payload: ActivitypubHttpBroadcastPayload } |
78 { type: 'activitypub-http-broadcast-parallel', payload: ActivitypubHttpBroadcastPayload } |
79 { type: 'activitypub-http-unicast', payload: ActivitypubHttpUnicastPayload } |
80 { type: 'activitypub-http-fetcher', payload: ActivitypubHttpFetcherPayload } |
81 { type: 'activitypub-http-cleaner', payload: {} } |
82 { type: 'activitypub-follow', payload: ActivitypubFollowPayload } |
83 { type: 'video-file-import', payload: VideoFileImportPayload } |
84 { type: 'video-transcoding', payload: VideoTranscodingPayload } |
85 { type: 'email', payload: EmailPayload } |
86 { type: 'video-import', payload: VideoImportPayload } |
87 { type: 'activitypub-refresher', payload: RefreshPayload } |
88 { type: 'videos-views-stats', payload: {} } |
89 { type: 'video-live-ending', payload: VideoLiveEndingPayload } |
90 { type: 'actor-keys', payload: ActorKeysPayload } |
91 { type: 'video-redundancy', payload: VideoRedundancyPayload } |
92 { type: 'delete-resumable-upload-meta-file', payload: DeleteResumableUploadMetaFilePayload } |
93 { type: 'video-studio-edition', payload: VideoStudioEditionPayload } |
94 { type: 'manage-video-torrent', payload: ManageVideoTorrentPayload } |
95 { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } |
96 { type: 'video-channel-import', payload: VideoChannelImportPayload } |
97 { type: 'after-video-channel-import', payload: AfterVideoChannelImportPayload } |
98 { type: 'notify', payload: NotifyPayload } |
99 { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } |
100 { type: 'federate-video', payload: FederateVideoPayload }
102 export type CreateJobOptions = {
107 const handlers: { [id in JobType]: (job: Job) => Promise<any> } = {
108 'activitypub-http-broadcast': processActivityPubHttpSequentialBroadcast,
109 'activitypub-http-broadcast-parallel': processActivityPubParallelHttpBroadcast,
110 'activitypub-http-unicast': processActivityPubHttpUnicast,
111 'activitypub-http-fetcher': processActivityPubHttpFetcher,
112 'activitypub-cleaner': processActivityPubCleaner,
113 'activitypub-follow': processActivityPubFollow,
114 'video-file-import': processVideoFileImport,
115 'video-transcoding': processVideoTranscoding,
116 'email': processEmail,
117 'video-import': processVideoImport,
118 'videos-views-stats': processVideosViewsStats,
119 'activitypub-refresher': refreshAPObject,
120 'video-live-ending': processVideoLiveEnding,
121 'actor-keys': processActorKeys,
122 'video-redundancy': processVideoRedundancy,
123 'move-to-object-storage': processMoveToObjectStorage,
124 'manage-video-torrent': processManageVideoTorrent,
125 'video-studio-edition': processVideoStudioEdition,
126 'video-channel-import': processVideoChannelImport,
127 'after-video-channel-import': processAfterVideoChannelImport,
128 'notify': processNotify,
129 'federate-video': processFederateVideo
132 const errorHandlers: { [id in JobType]?: (job: Job, err: any) => Promise<any> } = {
133 'move-to-object-storage': onMoveToObjectStorageFailure
136 const jobTypes: JobType[] = [
137 'activitypub-follow',
138 'activitypub-http-broadcast',
139 'activitypub-http-broadcast-parallel',
140 'activitypub-http-fetcher',
141 'activitypub-http-unicast',
142 'activitypub-cleaner',
147 'videos-views-stats',
148 'activitypub-refresher',
152 'move-to-object-storage',
153 'manage-video-torrent',
154 'video-studio-edition',
155 'video-channel-import',
156 'after-video-channel-import',
161 const silentFailure = new Set<JobType>([ 'activitypub-http-unicast' ])
165 private static instance: JobQueue
167 private workers: { [id in JobType]?: Worker } = {}
168 private queues: { [id in JobType]?: Queue } = {}
169 private queueSchedulers: { [id in JobType]?: QueueScheduler } = {}
170 private queueEvents: { [id in JobType]?: QueueEvents } = {}
172 private flowProducer: FlowProducer
174 private initialized = false
175 private jobRedisPrefix: string
177 private constructor () {
181 // Already initialized
182 if (this.initialized === true) return
183 this.initialized = true
185 this.jobRedisPrefix = 'bull-' + WEBSERVER.HOST
187 for (const handlerName of Object.keys(handlers)) {
188 this.buildWorker(handlerName)
189 this.buildQueue(handlerName)
190 this.buildQueueScheduler(handlerName)
191 this.buildQueueEvent(handlerName)
194 this.flowProducer = new FlowProducer({
195 connection: Redis.getRedisClientOptions('FlowProducer'),
196 prefix: this.jobRedisPrefix
198 this.flowProducer.on('error', err => { logger.error('Error in flow producer', { err }) })
200 this.addRepeatableJobs()
203 private buildWorker (handlerName: JobType) {
204 const workerOptions: WorkerOptions = {
206 concurrency: this.getJobConcurrency(handlerName),
207 prefix: this.jobRedisPrefix,
208 connection: Redis.getRedisClientOptions('Worker')
211 const handler = function (job: Job) {
212 const timeout = JOB_TTL[handlerName]
213 const p = handlers[handlerName](job)
215 if (!timeout) return p
217 return timeoutPromise(p, timeout)
220 const processor = async (jobArg: Job<any>) => {
221 const job = await Hooks.wrapObject(jobArg, 'filter:job-queue.process.params', { type: handlerName })
223 return Hooks.wrapPromiseFun(handler, job, 'filter:job-queue.process.result')
226 const worker = new Worker(handlerName, processor, workerOptions)
228 worker.on('failed', (job, err) => {
229 const logLevel = silentFailure.has(handlerName)
233 logger.log(logLevel, 'Cannot execute job %s in queue %s.', job.id, handlerName, { payload: job.data, err })
235 if (errorHandlers[job.name]) {
236 errorHandlers[job.name](job, err)
237 .catch(err => logger.error('Cannot run error handler for job failure %d in queue %s.', job.id, handlerName, { err }))
241 worker.on('error', err => { logger.error('Error in job worker %s.', handlerName, { err }) })
243 this.workers[handlerName] = worker
246 private buildQueue (handlerName: JobType) {
247 const queueOptions: QueueOptions = {
248 connection: Redis.getRedisClientOptions('Queue'),
249 prefix: this.jobRedisPrefix
252 const queue = new Queue(handlerName, queueOptions)
253 queue.on('error', err => { logger.error('Error in job queue %s.', handlerName, { err }) })
255 this.queues[handlerName] = queue
258 private buildQueueScheduler (handlerName: JobType) {
259 const queueSchedulerOptions: QueueSchedulerOptions = {
261 connection: Redis.getRedisClientOptions('QueueScheduler'),
262 prefix: this.jobRedisPrefix,
266 const queueScheduler = new QueueScheduler(handlerName, queueSchedulerOptions)
267 queueScheduler.on('error', err => { logger.error('Error in job queue scheduler %s.', handlerName, { err }) })
269 this.queueSchedulers[handlerName] = queueScheduler
272 private buildQueueEvent (handlerName: JobType) {
273 const queueEventsOptions: QueueEventsOptions = {
275 connection: Redis.getRedisClientOptions('QueueEvent'),
276 prefix: this.jobRedisPrefix
279 const queueEvents = new QueueEvents(handlerName, queueEventsOptions)
280 queueEvents.on('error', err => { logger.error('Error in job queue events %s.', handlerName, { err }) })
282 this.queueEvents[handlerName] = queueEvents
285 // ---------------------------------------------------------------------------
288 const promises = Object.keys(this.workers)
289 .map(handlerName => {
290 const worker: Worker = this.workers[handlerName]
291 const queue: Queue = this.queues[handlerName]
292 const queueScheduler: QueueScheduler = this.queueSchedulers[handlerName]
293 const queueEvent: QueueEvents = this.queueEvents[handlerName]
298 queueScheduler.close(),
303 return Promise.all(promises)
307 const promises = Object.keys(this.workers)
308 .map(handlerName => {
309 const worker: Worker = this.workers[handlerName]
310 const queueScheduler: QueueScheduler = this.queueSchedulers[handlerName]
311 const queueEvent: QueueEvents = this.queueEvents[handlerName]
315 queueScheduler.run(),
320 return Promise.all(promises)
324 for (const handlerName of Object.keys(this.workers)) {
325 const worker: Worker = this.workers[handlerName]
332 for (const handlerName of Object.keys(this.workers)) {
333 const worker: Worker = this.workers[handlerName]
339 // ---------------------------------------------------------------------------
341 createJobAsync (options: CreateJobArgument & CreateJobOptions): void {
342 this.createJob(options)
343 .catch(err => logger.error('Cannot create job.', { err, options }))
346 createJob (options: CreateJobArgument & CreateJobOptions) {
347 const queue: Queue = this.queues[options.type]
348 if (queue === undefined) {
349 logger.error('Unknown queue %s: cannot create job.', options.type)
353 const jobOptions = this.buildJobOptions(options.type as JobType, pick(options, [ 'priority', 'delay' ]))
355 return queue.add('job', options.payload, jobOptions)
358 createSequentialJobFlow (...jobs: ((CreateJobArgument & CreateJobOptions) | undefined)[]) {
361 for (const job of jobs) {
365 ...this.buildJobFlowOption(job),
373 return this.flowProducer.add(lastJob)
376 createJobWithChildren (parent: CreateJobArgument & CreateJobOptions, children: (CreateJobArgument & CreateJobOptions)[]) {
377 return this.flowProducer.add({
378 ...this.buildJobFlowOption(parent),
380 children: children.map(c => this.buildJobFlowOption(c))
384 private buildJobFlowOption (job: CreateJobArgument & CreateJobOptions): FlowJob {
389 opts: this.buildJobOptions(job.type as JobType, pick(job, [ 'priority', 'delay' ]))
393 private buildJobOptions (type: JobType, options: CreateJobOptions = {}): JobsOptions {
395 backoff: { delay: 60 * 1000, type: 'exponential' },
396 attempts: JOB_ATTEMPTS[type],
397 priority: options.priority,
398 delay: options.delay,
400 ...this.buildJobRemovalOptions(type)
404 // ---------------------------------------------------------------------------
406 async listForApi (options: {
413 const { state, start, count, asc, jobType } = options
415 const states = this.buildStateFilter(state)
416 const filteredJobTypes = this.buildTypeFilter(jobType)
418 let results: Job[] = []
420 for (const jobType of filteredJobTypes) {
421 const queue: Queue = this.queues[jobType]
423 if (queue === undefined) {
424 logger.error('Unknown queue %s to list jobs.', jobType)
428 const jobs = await queue.getJobs(states, 0, start + count, asc)
429 results = results.concat(jobs)
432 results.sort((j1: any, j2: any) => {
433 if (j1.timestamp < j2.timestamp) return -1
434 else if (j1.timestamp === j2.timestamp) return 0
439 if (asc === false) results.reverse()
441 return results.slice(start, start + count)
444 async count (state: JobState, jobType?: JobType): Promise<number> {
445 const states = state ? [ state ] : jobStates
446 const filteredJobTypes = this.buildTypeFilter(jobType)
450 for (const type of filteredJobTypes) {
451 const queue = this.queues[type]
452 if (queue === undefined) {
453 logger.error('Unknown queue %s to count jobs.', type)
457 const counts = await queue.getJobCounts()
459 for (const s of states) {
467 private buildStateFilter (state?: JobState) {
468 if (!state) return jobStates
470 const states = [ state ]
472 // Include parent if filtering on waiting
473 if (state === 'waiting') states.push('waiting-children')
478 private buildTypeFilter (jobType?: JobType) {
479 if (!jobType) return jobTypes
481 return jobTypes.filter(t => t === jobType)
485 const promises = jobTypes.map(async t => ({ jobType: t, counts: await this.queues[t].getJobCounts() }))
487 return Promise.all(promises)
490 // ---------------------------------------------------------------------------
492 async removeOldJobs () {
493 for (const key of Object.keys(this.queues)) {
494 const queue: Queue = this.queues[key]
495 await queue.clean(parseDurationToMs('7 days'), 1000, 'completed')
496 await queue.clean(parseDurationToMs('7 days'), 1000, 'failed')
500 private addRepeatableJobs () {
501 this.queues['videos-views-stats'].add('job', {}, {
502 repeat: REPEAT_JOBS['videos-views-stats'],
504 ...this.buildJobRemovalOptions('videos-views-stats')
505 }).catch(err => logger.error('Cannot add repeatable job.', { err }))
507 if (CONFIG.FEDERATION.VIDEOS.CLEANUP_REMOTE_INTERACTIONS) {
508 this.queues['activitypub-cleaner'].add('job', {}, {
509 repeat: REPEAT_JOBS['activitypub-cleaner'],
511 ...this.buildJobRemovalOptions('activitypub-cleaner')
512 }).catch(err => logger.error('Cannot add repeatable job.', { err }))
516 private getJobConcurrency (jobType: JobType) {
517 if (jobType === 'video-transcoding') return CONFIG.TRANSCODING.CONCURRENCY
518 if (jobType === 'video-import') return CONFIG.IMPORT.VIDEOS.CONCURRENCY
520 return JOB_CONCURRENCY[jobType]
523 private buildJobRemovalOptions (queueName: string) {
527 age: (JOB_REMOVAL_OPTIONS.SUCCESS[queueName] || JOB_REMOVAL_OPTIONS.SUCCESS.DEFAULT) / 1000,
529 count: JOB_REMOVAL_OPTIONS.COUNT
533 age: (JOB_REMOVAL_OPTIONS.FAILURE[queueName] || JOB_REMOVAL_OPTIONS.FAILURE.DEFAULT) / 1000,
535 count: JOB_REMOVAL_OPTIONS.COUNT / 1000
540 static get Instance () {
541 return this.instance || (this.instance = new this())
545 // ---------------------------------------------------------------------------