server/lib/job-queue/job-queue.ts

   1 import {
   2   FlowJob,
   3   FlowProducer,
   4   Job,
   5   JobsOptions,
   6   Queue,
   7   QueueEvents,
   8   QueueEventsOptions,
   9   QueueOptions,
  10   Worker,
  11   WorkerOptions
  12 } from 'bullmq'
  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'
  18 import {
  19   ActivitypubFollowPayload,
  20   ActivitypubHttpBroadcastPayload,
  21   ActivitypubHttpFetcherPayload,
  22   ActivitypubHttpUnicastPayload,
  23   ActorKeysPayload,
  24   AfterVideoChannelImportPayload,
  25   DeleteResumableUploadMetaFilePayload,
  26   EmailPayload,
  27   FederateVideoPayload,
  28   JobState,
  29   JobType,
  30   ManageVideoTorrentPayload,
  31   MoveObjectStoragePayload,
  32   NotifyPayload,
  33   RefreshPayload,
  34   TranscodingJobBuilderPayload,
  35   VideoChannelImportPayload,
  36   VideoFileImportPayload,
  37   VideoImportPayload,
  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'
  68
  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 }
  95
  96 export type CreateJobOptions = {
  97   delay?: number
  98   priority?: number
  99   failParentOnFailure?: boolean
 100 }
 101
 102 const handlers: { [id in JobType]: (job: Job) => Promise<any> } = {
 103   'activitypub-cleaner': processActivityPubCleaner,
 104   'activitypub-follow': processActivityPubFollow,
 105   'activitypub-http-broadcast-parallel': processActivityPubParallelHttpBroadcast,
 106   'activitypub-http-broadcast': processActivityPubHttpSequentialBroadcast,
 107   'activitypub-http-fetcher': processActivityPubHttpFetcher,
 108   'activitypub-http-unicast': processActivityPubHttpUnicast,
 109   'activitypub-refresher': refreshAPObject,
 110   'actor-keys': processActorKeys,
 111   'after-video-channel-import': processAfterVideoChannelImport,
 112   'email': processEmail,
 113   'federate-video': processFederateVideo,
 114   'transcoding-job-builder': processTranscodingJobBuilder,
 115   'manage-video-torrent': processManageVideoTorrent,
 116   'move-to-object-storage': processMoveToObjectStorage,
 117   'notify': processNotify,
 118   'video-channel-import': processVideoChannelImport,
 119   'video-file-import': processVideoFileImport,
 120   'video-import': processVideoImport,
 121   'video-live-ending': processVideoLiveEnding,
 122   'video-redundancy': processVideoRedundancy,
 123   'video-studio-edition': processVideoStudioEdition,
 124   'video-transcoding': processVideoTranscoding,
 125   'videos-views-stats': processVideosViewsStats
 126 }
 127
 128 const errorHandlers: { [id in JobType]?: (job: Job, err: any) => Promise<any> } = {
 129   'move-to-object-storage': onMoveToObjectStorageFailure
 130 }
 131
 132 const jobTypes: JobType[] = [
 133   'activitypub-cleaner',
 134   'activitypub-follow',
 135   'activitypub-http-broadcast-parallel',
 136   'activitypub-http-broadcast',
 137   'activitypub-http-fetcher',
 138   'activitypub-http-unicast',
 139   'activitypub-refresher',
 140   'actor-keys',
 141   'after-video-channel-import',
 142   'email',
 143   'federate-video',
 144   'transcoding-job-builder',
 145   'manage-video-torrent',
 146   'move-to-object-storage',
 147   'notify',
 148   'video-channel-import',
 149   'video-file-import',
 150   'video-import',
 151   'video-live-ending',
 152   'video-redundancy',
 153   'video-studio-edition',
 154   'video-transcoding',
 155   'videos-views-stats'
 156 ]
 157
 158 const silentFailure = new Set<JobType>([ 'activitypub-http-unicast' ])
 159
 160 class JobQueue {
 161
 162   private static instance: JobQueue
 163
 164   private workers: { [id in JobType]?: Worker } = {}
 165   private queues: { [id in JobType]?: Queue } = {}
 166   private queueEvents: { [id in JobType]?: QueueEvents } = {}
 167
 168   private flowProducer: FlowProducer
 169
 170   private initialized = false
 171   private jobRedisPrefix: string
 172
 173   private constructor () {
 174   }
 175
 176   init () {
 177     // Already initialized
 178     if (this.initialized === true) return
 179     this.initialized = true
 180
 181     this.jobRedisPrefix = 'bull-' + WEBSERVER.HOST
 182
 183     for (const handlerName of Object.keys(handlers)) {
 184       this.buildWorker(handlerName)
 185       this.buildQueue(handlerName)
 186       this.buildQueueEvent(handlerName)
 187     }
 188
 189     this.flowProducer = new FlowProducer({
 190       connection: Redis.getRedisClientOptions('FlowProducer'),
 191       prefix: this.jobRedisPrefix
 192     })
 193     this.flowProducer.on('error', err => { logger.error('Error in flow producer', { err }) })
 194
 195     this.addRepeatableJobs()
 196   }
 197
 198   private buildWorker (handlerName: JobType) {
 199     const workerOptions: WorkerOptions = {
 200       autorun: false,
 201       concurrency: this.getJobConcurrency(handlerName),
 202       prefix: this.jobRedisPrefix,
 203       connection: Redis.getRedisClientOptions('Worker'),
 204       maxStalledCount: 10
 205     }
 206
 207     const handler = function (job: Job) {
 208       const timeout = JOB_TTL[handlerName]
 209       const p = handlers[handlerName](job)
 210
 211       if (!timeout) return p
 212
 213       return timeoutPromise(p, timeout)
 214     }
 215
 216     const processor = async (jobArg: Job<any>) => {
 217       const job = await Hooks.wrapObject(jobArg, 'filter:job-queue.process.params', { type: handlerName })
 218
 219       return Hooks.wrapPromiseFun(handler, job, 'filter:job-queue.process.result')
 220     }
 221
 222     const worker = new Worker(handlerName, processor, workerOptions)
 223
 224     worker.on('failed', (job, err) => {
 225       const logLevel = silentFailure.has(handlerName)
 226         ? 'debug'
 227         : 'error'
 228
 229       logger.log(logLevel, 'Cannot execute job %s in queue %s.', job.id, handlerName, { payload: job.data, err })
 230
 231       if (errorHandlers[job.name]) {
 232         errorHandlers[job.name](job, err)
 233           .catch(err => logger.error('Cannot run error handler for job failure %d in queue %s.', job.id, handlerName, { err }))
 234       }
 235     })
 236
 237     worker.on('error', err => { logger.error('Error in job worker %s.', handlerName, { err }) })
 238
 239     this.workers[handlerName] = worker
 240   }
 241
 242   private buildQueue (handlerName: JobType) {
 243     const queueOptions: QueueOptions = {
 244       connection: Redis.getRedisClientOptions('Queue'),
 245       prefix: this.jobRedisPrefix
 246     }
 247
 248     const queue = new Queue(handlerName, queueOptions)
 249     queue.on('error', err => { logger.error('Error in job queue %s.', handlerName, { err }) })
 250
 251     this.queues[handlerName] = queue
 252   }
 253
 254   private buildQueueEvent (handlerName: JobType) {
 255     const queueEventsOptions: QueueEventsOptions = {
 256       autorun: false,
 257       connection: Redis.getRedisClientOptions('QueueEvent'),
 258       prefix: this.jobRedisPrefix
 259     }
 260
 261     const queueEvents = new QueueEvents(handlerName, queueEventsOptions)
 262     queueEvents.on('error', err => { logger.error('Error in job queue events %s.', handlerName, { err }) })
 263
 264     this.queueEvents[handlerName] = queueEvents
 265   }
 266
 267   // ---------------------------------------------------------------------------
 268
 269   async terminate () {
 270     const promises = Object.keys(this.workers)
 271       .map(handlerName => {
 272         const worker: Worker = this.workers[handlerName]
 273         const queue: Queue = this.queues[handlerName]
 274         const queueEvent: QueueEvents = this.queueEvents[handlerName]
 275
 276         return Promise.all([
 277           worker.close(false),
 278           queue.close(),
 279           queueEvent.close()
 280         ])
 281       })
 282
 283     return Promise.all(promises)
 284   }
 285
 286   start () {
 287     const promises = Object.keys(this.workers)
 288       .map(handlerName => {
 289         const worker: Worker = this.workers[handlerName]
 290         const queueEvent: QueueEvents = this.queueEvents[handlerName]
 291
 292         return Promise.all([
 293           worker.run(),
 294           queueEvent.run()
 295         ])
 296       })
 297
 298     return Promise.all(promises)
 299   }
 300
 301   async pause () {
 302     for (const handlerName of Object.keys(this.workers)) {
 303       const worker: Worker = this.workers[handlerName]
 304
 305       await worker.pause()
 306     }
 307   }
 308
 309   resume () {
 310     for (const handlerName of Object.keys(this.workers)) {
 311       const worker: Worker = this.workers[handlerName]
 312
 313       worker.resume()
 314     }
 315   }
 316
 317   // ---------------------------------------------------------------------------
 318
 319   createJobAsync (options: CreateJobArgument & CreateJobOptions): void {
 320     this.createJob(options)
 321         .catch(err => logger.error('Cannot create job.', { err, options }))
 322   }
 323
 324   createJob (options: CreateJobArgument & CreateJobOptions) {
 325     const queue: Queue = this.queues[options.type]
 326     if (queue === undefined) {
 327       logger.error('Unknown queue %s: cannot create job.', options.type)
 328       return
 329     }
 330
 331     const jobOptions = this.buildJobOptions(options.type as JobType, pick(options, [ 'priority', 'delay' ]))
 332
 333     return queue.add('job', options.payload, jobOptions)
 334   }
 335
 336   createSequentialJobFlow (...jobs: ((CreateJobArgument & CreateJobOptions) | undefined)[]) {
 337     let lastJob: FlowJob
 338
 339     for (const job of jobs) {
 340       if (!job) continue
 341
 342       lastJob = {
 343         ...this.buildJobFlowOption(job),
 344
 345         children: lastJob
 346           ? [ lastJob ]
 347           : []
 348       }
 349     }
 350
 351     return this.flowProducer.add(lastJob)
 352   }
 353
 354   createJobWithChildren (parent: CreateJobArgument & CreateJobOptions, children: (CreateJobArgument & CreateJobOptions)[]) {
 355     return this.flowProducer.add({
 356       ...this.buildJobFlowOption(parent),
 357
 358       children: children.map(c => this.buildJobFlowOption(c))
 359     })
 360   }
 361
 362   private buildJobFlowOption (job: CreateJobArgument & CreateJobOptions): FlowJob {
 363     return {
 364       name: 'job',
 365       data: job.payload,
 366       queueName: job.type,
 367       opts: {
 368         failParentOnFailure: true,
 369
 370         ...this.buildJobOptions(job.type as JobType, pick(job, [ 'priority', 'delay', 'failParentOnFailure' ]))
 371       }
 372     }
 373   }
 374
 375   private buildJobOptions (type: JobType, options: CreateJobOptions = {}): JobsOptions {
 376     return {
 377       backoff: { delay: 60 * 1000, type: 'exponential' },
 378       attempts: JOB_ATTEMPTS[type],
 379       priority: options.priority,
 380       delay: options.delay,
 381
 382       ...this.buildJobRemovalOptions(type)
 383     }
 384   }
 385
 386   // ---------------------------------------------------------------------------
 387
 388   async listForApi (options: {
 389     state?: JobState
 390     start: number
 391     count: number
 392     asc?: boolean
 393     jobType: JobType
 394   }): Promise<Job[]> {
 395     const { state, start, count, asc, jobType } = options
 396
 397     const states = this.buildStateFilter(state)
 398     const filteredJobTypes = this.buildTypeFilter(jobType)
 399
 400     let results: Job[] = []
 401
 402     for (const jobType of filteredJobTypes) {
 403       const queue: Queue = this.queues[jobType]
 404
 405       if (queue === undefined) {
 406         logger.error('Unknown queue %s to list jobs.', jobType)
 407         continue
 408       }
 409
 410       const jobs = await queue.getJobs(states, 0, start + count, asc)
 411       results = results.concat(jobs)
 412     }
 413
 414     results.sort((j1: any, j2: any) => {
 415       if (j1.timestamp < j2.timestamp) return -1
 416       else if (j1.timestamp === j2.timestamp) return 0
 417
 418       return 1
 419     })
 420
 421     if (asc === false) results.reverse()
 422
 423     return results.slice(start, start + count)
 424   }
 425
 426   async count (state: JobState, jobType?: JobType): Promise<number> {
 427     const states = state ? [ state ] : jobStates
 428     const filteredJobTypes = this.buildTypeFilter(jobType)
 429
 430     let total = 0
 431
 432     for (const type of filteredJobTypes) {
 433       const queue = this.queues[type]
 434       if (queue === undefined) {
 435         logger.error('Unknown queue %s to count jobs.', type)
 436         continue
 437       }
 438
 439       const counts = await queue.getJobCounts()
 440
 441       for (const s of states) {
 442         total += counts[s]
 443       }
 444     }
 445
 446     return total
 447   }
 448
 449   private buildStateFilter (state?: JobState) {
 450     if (!state) return jobStates
 451
 452     const states = [ state ]
 453
 454     // Include parent if filtering on waiting
 455     if (state === 'waiting') states.push('waiting-children')
 456
 457     return states
 458   }
 459
 460   private buildTypeFilter (jobType?: JobType) {
 461     if (!jobType) return jobTypes
 462
 463     return jobTypes.filter(t => t === jobType)
 464   }
 465
 466   async getStats () {
 467     const promises = jobTypes.map(async t => ({ jobType: t, counts: await this.queues[t].getJobCounts() }))
 468
 469     return Promise.all(promises)
 470   }
 471
 472   // ---------------------------------------------------------------------------
 473
 474   async removeOldJobs () {
 475     for (const key of Object.keys(this.queues)) {
 476       const queue: Queue = this.queues[key]
 477       await queue.clean(parseDurationToMs('7 days'), 1000, 'completed')
 478       await queue.clean(parseDurationToMs('7 days'), 1000, 'failed')
 479     }
 480   }
 481
 482   private addRepeatableJobs () {
 483     this.queues['videos-views-stats'].add('job', {}, {
 484       repeat: REPEAT_JOBS['videos-views-stats'],
 485
 486       ...this.buildJobRemovalOptions('videos-views-stats')
 487     }).catch(err => logger.error('Cannot add repeatable job.', { err }))
 488
 489     if (CONFIG.FEDERATION.VIDEOS.CLEANUP_REMOTE_INTERACTIONS) {
 490       this.queues['activitypub-cleaner'].add('job', {}, {
 491         repeat: REPEAT_JOBS['activitypub-cleaner'],
 492
 493         ...this.buildJobRemovalOptions('activitypub-cleaner')
 494       }).catch(err => logger.error('Cannot add repeatable job.', { err }))
 495     }
 496   }
 497
 498   private getJobConcurrency (jobType: JobType) {
 499     if (jobType === 'video-transcoding') return CONFIG.TRANSCODING.CONCURRENCY
 500     if (jobType === 'video-import') return CONFIG.IMPORT.VIDEOS.CONCURRENCY
 501
 502     return JOB_CONCURRENCY[jobType]
 503   }
 504
 505   private buildJobRemovalOptions (queueName: string) {
 506     return {
 507       removeOnComplete: {
 508         // Wants seconds
 509         age: (JOB_REMOVAL_OPTIONS.SUCCESS[queueName] || JOB_REMOVAL_OPTIONS.SUCCESS.DEFAULT) / 1000,
 510
 511         count: JOB_REMOVAL_OPTIONS.COUNT
 512       },
 513       removeOnFail: {
 514         // Wants seconds
 515         age: (JOB_REMOVAL_OPTIONS.FAILURE[queueName] || JOB_REMOVAL_OPTIONS.FAILURE.DEFAULT) / 1000,
 516
 517         count: JOB_REMOVAL_OPTIONS.COUNT / 1000
 518       }
 519     }
 520   }
 521
 522   static get Instance () {
 523     return this.instance || (this.instance = new this())
 524   }
 525 }
 526
 527 // ---------------------------------------------------------------------------
 528
 529 export {
 530   jobTypes,
 531   JobQueue
 532 }