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'
44 import { JOB_ATTEMPTS, JOB_COMPLETED_LIFETIME, JOB_CONCURRENCY, JOB_TTL, REPEAT_JOBS, WEBSERVER } from '../../initializers/constants'
45 import { Hooks } from '../plugins/hooks'
46 import { processActivityPubCleaner } from './handlers/activitypub-cleaner'
47 import { processActivityPubFollow } from './handlers/activitypub-follow'
48 import { processActivityPubHttpBroadcast } from './handlers/activitypub-http-broadcast'
49 import { processActivityPubHttpFetcher } from './handlers/activitypub-http-fetcher'
50 import { processActivityPubHttpUnicast } from './handlers/activitypub-http-unicast'
51 import { refreshAPObject } from './handlers/activitypub-refresher'
52 import { processActorKeys } from './handlers/actor-keys'
53 import { processEmail } from './handlers/email'
54 import { processFederateVideo } from './handlers/federate-video'
55 import { processManageVideoTorrent } from './handlers/manage-video-torrent'
56 import { onMoveToObjectStorageFailure, processMoveToObjectStorage } from './handlers/move-to-object-storage'
57 import { processNotify } from './handlers/notify'
58 import { processVideoChannelImport } from './handlers/video-channel-import'
59 import { processVideoFileImport } from './handlers/video-file-import'
60 import { processVideoImport } from './handlers/video-import'
61 import { processVideoLiveEnding } from './handlers/video-live-ending'
62 import { processVideoStudioEdition } from './handlers/video-studio-edition'
63 import { processVideoTranscoding } from './handlers/video-transcoding'
64 import { processVideosViewsStats } from './handlers/video-views-stats'
65 import { processAfterVideoChannelImport } from './handlers/after-video-channel-import'
67 export type CreateJobArgument =
68 { type: 'activitypub-http-broadcast', payload: ActivitypubHttpBroadcastPayload } |
69 { type: 'activitypub-http-broadcast-parallel', payload: ActivitypubHttpBroadcastPayload } |
70 { type: 'activitypub-http-unicast', payload: ActivitypubHttpUnicastPayload } |
71 { type: 'activitypub-http-fetcher', payload: ActivitypubHttpFetcherPayload } |
72 { type: 'activitypub-http-cleaner', payload: {} } |
73 { type: 'activitypub-follow', payload: ActivitypubFollowPayload } |
74 { type: 'video-file-import', payload: VideoFileImportPayload } |
75 { type: 'video-transcoding', payload: VideoTranscodingPayload } |
76 { type: 'email', payload: EmailPayload } |
77 { type: 'video-import', payload: VideoImportPayload } |
78 { type: 'activitypub-refresher', payload: RefreshPayload } |
79 { type: 'videos-views-stats', payload: {} } |
80 { type: 'video-live-ending', payload: VideoLiveEndingPayload } |
81 { type: 'actor-keys', payload: ActorKeysPayload } |
82 { type: 'video-redundancy', payload: VideoRedundancyPayload } |
83 { type: 'delete-resumable-upload-meta-file', payload: DeleteResumableUploadMetaFilePayload } |
84 { type: 'video-studio-edition', payload: VideoStudioEditionPayload } |
85 { type: 'manage-video-torrent', payload: ManageVideoTorrentPayload } |
86 { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } |
87 { type: 'video-channel-import', payload: VideoChannelImportPayload } |
88 { type: 'after-video-channel-import', payload: AfterVideoChannelImportPayload } |
89 { type: 'notify', payload: NotifyPayload } |
90 { type: 'move-to-object-storage', payload: MoveObjectStoragePayload } |
91 { type: 'federate-video', payload: FederateVideoPayload }
93 export type CreateJobOptions = {
98 const handlers: { [id in JobType]: (job: Job) => Promise<any> } = {
99 'activitypub-http-broadcast': processActivityPubHttpBroadcast,
100 'activitypub-http-broadcast-parallel': processActivityPubHttpBroadcast,
101 'activitypub-http-unicast': processActivityPubHttpUnicast,
102 'activitypub-http-fetcher': processActivityPubHttpFetcher,
103 'activitypub-cleaner': processActivityPubCleaner,
104 'activitypub-follow': processActivityPubFollow,
105 'video-file-import': processVideoFileImport,
106 'video-transcoding': processVideoTranscoding,
107 'email': processEmail,
108 'video-import': processVideoImport,
109 'videos-views-stats': processVideosViewsStats,
110 'activitypub-refresher': refreshAPObject,
111 'video-live-ending': processVideoLiveEnding,
112 'actor-keys': processActorKeys,
113 'video-redundancy': processVideoRedundancy,
114 'move-to-object-storage': processMoveToObjectStorage,
115 'manage-video-torrent': processManageVideoTorrent,
116 'video-studio-edition': processVideoStudioEdition,
117 'video-channel-import': processVideoChannelImport,
118 'after-video-channel-import': processAfterVideoChannelImport,
119 'notify': processNotify,
120 'federate-video': processFederateVideo
123 const errorHandlers: { [id in JobType]?: (job: Job, err: any) => Promise<any> } = {
124 'move-to-object-storage': onMoveToObjectStorageFailure
127 const jobTypes: JobType[] = [
128 'activitypub-follow',
129 'activitypub-http-broadcast',
130 'activitypub-http-broadcast-parallel',
131 'activitypub-http-fetcher',
132 'activitypub-http-unicast',
133 'activitypub-cleaner',
138 'videos-views-stats',
139 'activitypub-refresher',
143 'move-to-object-storage',
144 'manage-video-torrent',
145 'video-studio-edition',
146 'video-channel-import',
147 'after-video-channel-import',
152 const silentFailure = new Set<JobType>([ 'activitypub-http-unicast' ])
156 private static instance: JobQueue
158 private workers: { [id in JobType]?: Worker } = {}
159 private queues: { [id in JobType]?: Queue } = {}
160 private queueSchedulers: { [id in JobType]?: QueueScheduler } = {}
161 private queueEvents: { [id in JobType]?: QueueEvents } = {}
163 private flowProducer: FlowProducer
165 private initialized = false
166 private jobRedisPrefix: string
168 private constructor () {
171 init (produceOnly = false) {
172 // Already initialized
173 if (this.initialized === true) return
174 this.initialized = true
176 this.jobRedisPrefix = 'bull-' + WEBSERVER.HOST
178 for (const handlerName of (Object.keys(handlers) as JobType[])) {
179 this.buildWorker(handlerName, produceOnly)
180 this.buildQueue(handlerName)
181 this.buildQueueScheduler(handlerName, produceOnly)
182 this.buildQueueEvent(handlerName, produceOnly)
185 this.flowProducer = new FlowProducer({
186 connection: this.getRedisConnection(),
187 prefix: this.jobRedisPrefix
190 this.addRepeatableJobs()
193 private buildWorker (handlerName: JobType, produceOnly: boolean) {
194 const workerOptions: WorkerOptions = {
195 autorun: !produceOnly,
196 concurrency: this.getJobConcurrency(handlerName),
197 prefix: this.jobRedisPrefix,
198 connection: this.getRedisConnection()
201 const handler = function (job: Job) {
202 const timeout = JOB_TTL[handlerName]
203 const p = handlers[handlerName](job)
205 if (!timeout) return p
207 return timeoutPromise(p, timeout)
210 const processor = async (jobArg: Job<any>) => {
211 const job = await Hooks.wrapObject(jobArg, 'filter:job-queue.process.params', { type: handlerName })
213 return Hooks.wrapPromiseFun(handler, job, 'filter:job-queue.process.result')
216 const worker = new Worker(handlerName, processor, workerOptions)
218 worker.on('failed', (job, err) => {
219 const logLevel = silentFailure.has(handlerName)
223 logger.log(logLevel, 'Cannot execute job %s in queue %s.', job.id, handlerName, { payload: job.data, err })
225 if (errorHandlers[job.name]) {
226 errorHandlers[job.name](job, err)
227 .catch(err => logger.error('Cannot run error handler for job failure %d in queue %s.', job.id, handlerName, { err }))
231 worker.on('error', err => {
232 logger.error('Error in job queue %s.', handlerName, { err })
235 this.workers[handlerName] = worker
238 private buildQueue (handlerName: JobType) {
239 const queueOptions: QueueOptions = {
240 connection: this.getRedisConnection(),
241 prefix: this.jobRedisPrefix
244 this.queues[handlerName] = new Queue(handlerName, queueOptions)
247 private buildQueueScheduler (handlerName: JobType, produceOnly: boolean) {
248 const queueSchedulerOptions: QueueSchedulerOptions = {
249 autorun: !produceOnly,
250 connection: this.getRedisConnection(),
251 prefix: this.jobRedisPrefix,
254 this.queueSchedulers[handlerName] = new QueueScheduler(handlerName, queueSchedulerOptions)
257 private buildQueueEvent (handlerName: JobType, produceOnly: boolean) {
258 const queueEventsOptions: QueueEventsOptions = {
259 autorun: !produceOnly,
260 connection: this.getRedisConnection(),
261 prefix: this.jobRedisPrefix
263 this.queueEvents[handlerName] = new QueueEvents(handlerName, queueEventsOptions)
266 private getRedisConnection () {
268 password: CONFIG.REDIS.AUTH,
270 host: CONFIG.REDIS.HOSTNAME,
271 port: CONFIG.REDIS.PORT,
272 path: CONFIG.REDIS.SOCKET
276 // ---------------------------------------------------------------------------
279 const promises = Object.keys(this.workers)
280 .map(handlerName => {
281 const worker: Worker = this.workers[handlerName]
282 const queue: Queue = this.queues[handlerName]
283 const queueScheduler: QueueScheduler = this.queueSchedulers[handlerName]
284 const queueEvent: QueueEvents = this.queueEvents[handlerName]
289 queueScheduler.close(),
294 return Promise.all(promises)
298 for (const handlerName of Object.keys(this.workers)) {
299 const worker: Worker = this.workers[handlerName]
306 for (const handlerName of Object.keys(this.workers)) {
307 const worker: Worker = this.workers[handlerName]
313 // ---------------------------------------------------------------------------
315 createJobAsync (options: CreateJobArgument & CreateJobOptions): void {
316 this.createJob(options)
317 .catch(err => logger.error('Cannot create job.', { err, options }))
320 createJob (options: CreateJobArgument & CreateJobOptions) {
321 const queue: Queue = this.queues[options.type]
322 if (queue === undefined) {
323 logger.error('Unknown queue %s: cannot create job.', options.type)
327 const jobOptions = this.buildJobOptions(options.type as JobType, pick(options, [ 'priority', 'delay' ]))
329 return queue.add('job', options.payload, jobOptions)
332 createSequentialJobFlow (...jobs: ((CreateJobArgument & CreateJobOptions) | undefined)[]) {
335 for (const job of jobs) {
339 ...this.buildJobFlowOption(job),
347 return this.flowProducer.add(lastJob)
350 createJobWithChildren (parent: CreateJobArgument & CreateJobOptions, children: (CreateJobArgument & CreateJobOptions)[]) {
351 return this.flowProducer.add({
352 ...this.buildJobFlowOption(parent),
354 children: children.map(c => this.buildJobFlowOption(c))
358 private buildJobFlowOption (job: CreateJobArgument & CreateJobOptions) {
363 opts: this.buildJobOptions(job.type as JobType, pick(job, [ 'priority', 'delay' ]))
367 private buildJobOptions (type: JobType, options: CreateJobOptions = {}): JobsOptions {
369 backoff: { delay: 60 * 1000, type: 'exponential' },
370 attempts: JOB_ATTEMPTS[type],
371 priority: options.priority,
376 // ---------------------------------------------------------------------------
378 async listForApi (options: {
385 const { state, start, count, asc, jobType } = options
387 const states = this.buildStateFilter(state)
388 const filteredJobTypes = this.buildTypeFilter(jobType)
390 let results: Job[] = []
392 for (const jobType of filteredJobTypes) {
393 const queue: Queue = this.queues[jobType]
395 if (queue === undefined) {
396 logger.error('Unknown queue %s to list jobs.', jobType)
400 const jobs = await queue.getJobs(states, 0, start + count, asc)
401 results = results.concat(jobs)
404 results.sort((j1: any, j2: any) => {
405 if (j1.timestamp < j2.timestamp) return -1
406 else if (j1.timestamp === j2.timestamp) return 0
411 if (asc === false) results.reverse()
413 return results.slice(start, start + count)
416 async count (state: JobState, jobType?: JobType): Promise<number> {
417 const states = state ? [ state ] : jobStates
418 const filteredJobTypes = this.buildTypeFilter(jobType)
422 for (const type of filteredJobTypes) {
423 const queue = this.queues[type]
424 if (queue === undefined) {
425 logger.error('Unknown queue %s to count jobs.', type)
429 const counts = await queue.getJobCounts()
431 for (const s of states) {
439 private buildStateFilter (state?: JobState) {
440 if (!state) return jobStates
442 const states = [ state ]
444 // Include parent if filtering on waiting
445 if (state === 'waiting') states.push('waiting-children')
450 private buildTypeFilter (jobType?: JobType) {
451 if (!jobType) return jobTypes
453 return jobTypes.filter(t => t === jobType)
457 const promises = jobTypes.map(async t => ({ jobType: t, counts: await this.queues[t].getJobCounts() }))
459 return Promise.all(promises)
462 // ---------------------------------------------------------------------------
464 async removeOldJobs () {
465 for (const key of Object.keys(this.queues)) {
466 const queue: Queue = this.queues[key]
467 await queue.clean(JOB_COMPLETED_LIFETIME, 100, 'completed')
471 private addRepeatableJobs () {
472 this.queues['videos-views-stats'].add('job', {}, {
473 repeat: REPEAT_JOBS['videos-views-stats']
474 }).catch(err => logger.error('Cannot add repeatable job.', { err }))
476 if (CONFIG.FEDERATION.VIDEOS.CLEANUP_REMOTE_INTERACTIONS) {
477 this.queues['activitypub-cleaner'].add('job', {}, {
478 repeat: REPEAT_JOBS['activitypub-cleaner']
479 }).catch(err => logger.error('Cannot add repeatable job.', { err }))
483 private getJobConcurrency (jobType: JobType) {
484 if (jobType === 'video-transcoding') return CONFIG.TRANSCODING.CONCURRENCY
485 if (jobType === 'video-import') return CONFIG.IMPORT.VIDEOS.CONCURRENCY
487 return JOB_CONCURRENCY[jobType]
490 static get Instance () {
491 return this.instance || (this.instance = new this())
495 // ---------------------------------------------------------------------------