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