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

   1 import * as Bull from 'bull'
   2 import { jobStates } from '@server/helpers/custom-validators/jobs'
   3 import { CONFIG } from '@server/initializers/config'
   4 import { processVideoRedundancy } from '@server/lib/job-queue/handlers/video-redundancy'
   5 import {
   6   ActivitypubFollowPayload,
   7   ActivitypubHttpBroadcastPayload,
   8   ActivitypubHttpFetcherPayload,
   9   ActivitypubHttpUnicastPayload,
  10   ActorKeysPayload,
  11   EmailPayload,
  12   JobState,
  13   JobType,
  14   MoveObjectStoragePayload,
  15   RefreshPayload,
  16   VideoFileImportPayload,
  17   VideoImportPayload,
  18   VideoLiveEndingPayload,
  19   VideoRedundancyPayload,
  20   VideoTranscodingPayload
  21 } from '../../../shared/models'
  22 import { logger } from '../../helpers/logger'
  23 import { JOB_ATTEMPTS, JOB_COMPLETED_LIFETIME, JOB_CONCURRENCY, JOB_TTL, REPEAT_JOBS, WEBSERVER } from '../../initializers/constants'
  24 import { Redis } from '../redis'
  25 import { processActivityPubCleaner } from './handlers/activitypub-cleaner'
  26 import { processActivityPubFollow } from './handlers/activitypub-follow'
  27 import { processActivityPubHttpBroadcast } from './handlers/activitypub-http-broadcast'
  28 import { processActivityPubHttpFetcher } from './handlers/activitypub-http-fetcher'
  29 import { processActivityPubHttpUnicast } from './handlers/activitypub-http-unicast'
  30 import { refreshAPObject } from './handlers/activitypub-refresher'
  31 import { processActorKeys } from './handlers/actor-keys'
  32 import { processEmail } from './handlers/email'
  33 import { processVideoFileImport } from './handlers/video-file-import'
  34 import { processVideoImport } from './handlers/video-import'
  35 import { processVideoLiveEnding } from './handlers/video-live-ending'
  36 import { processVideoTranscoding } from './handlers/video-transcoding'
  37 import { processVideosViews } from './handlers/video-views'
  38 import { processMoveToObjectStorage } from './handlers/move-to-object-storage'
  39
  40 type CreateJobArgument =
  41   { type: 'activitypub-http-broadcast', payload: ActivitypubHttpBroadcastPayload } |
  42   { type: 'activitypub-http-unicast', payload: ActivitypubHttpUnicastPayload } |
  43   { type: 'activitypub-http-fetcher', payload: ActivitypubHttpFetcherPayload } |
  44   { type: 'activitypub-http-cleaner', payload: {} } |
  45   { type: 'activitypub-follow', payload: ActivitypubFollowPayload } |
  46   { type: 'video-file-import', payload: VideoFileImportPayload } |
  47   { type: 'video-transcoding', payload: VideoTranscodingPayload } |
  48   { type: 'email', payload: EmailPayload } |
  49   { type: 'video-import', payload: VideoImportPayload } |
  50   { type: 'activitypub-refresher', payload: RefreshPayload } |
  51   { type: 'videos-views', payload: {} } |
  52   { type: 'video-live-ending', payload: VideoLiveEndingPayload } |
  53   { type: 'actor-keys', payload: ActorKeysPayload } |
  54   { type: 'video-redundancy', payload: VideoRedundancyPayload } |
  55   { type: 'move-to-object-storage', payload: MoveObjectStoragePayload }
  56
  57 export type CreateJobOptions = {
  58   delay?: number
  59   priority?: number
  60 }
  61
  62 const handlers: { [id in JobType]: (job: Bull.Job) => Promise<any> } = {
  63   'activitypub-http-broadcast': processActivityPubHttpBroadcast,
  64   'activitypub-http-unicast': processActivityPubHttpUnicast,
  65   'activitypub-http-fetcher': processActivityPubHttpFetcher,
  66   'activitypub-cleaner': processActivityPubCleaner,
  67   'activitypub-follow': processActivityPubFollow,
  68   'video-file-import': processVideoFileImport,
  69   'video-transcoding': processVideoTranscoding,
  70   'email': processEmail,
  71   'video-import': processVideoImport,
  72   'videos-views': processVideosViews,
  73   'activitypub-refresher': refreshAPObject,
  74   'video-live-ending': processVideoLiveEnding,
  75   'actor-keys': processActorKeys,
  76   'video-redundancy': processVideoRedundancy,
  77   'move-to-object-storage': processMoveToObjectStorage
  78 }
  79
  80 const jobTypes: JobType[] = [
  81   'activitypub-follow',
  82   'activitypub-http-broadcast',
  83   'activitypub-http-fetcher',
  84   'activitypub-http-unicast',
  85   'activitypub-cleaner',
  86   'email',
  87   'video-transcoding',
  88   'video-file-import',
  89   'video-import',
  90   'videos-views',
  91   'activitypub-refresher',
  92   'video-redundancy',
  93   'actor-keys',
  94   'video-live-ending',
  95   'move-to-object-storage'
  96 ]
  97
  98 class JobQueue {
  99
 100   private static instance: JobQueue
 101
 102   private queues: { [id in JobType]?: Bull.Queue } = {}
 103   private initialized = false
 104   private jobRedisPrefix: string
 105
 106   private constructor () {
 107   }
 108
 109   init () {
 110     // Already initialized
 111     if (this.initialized === true) return
 112     this.initialized = true
 113
 114     this.jobRedisPrefix = 'bull-' + WEBSERVER.HOST
 115     const queueOptions = {
 116       prefix: this.jobRedisPrefix,
 117       redis: Redis.getRedisClientOptions(),
 118       settings: {
 119         maxStalledCount: 10 // transcoding could be long, so jobs can often be interrupted by restarts
 120       }
 121     }
 122
 123     for (const handlerName of (Object.keys(handlers) as JobType[])) {
 124       const queue = new Bull(handlerName, queueOptions)
 125       const handler = handlers[handlerName]
 126
 127       queue.process(this.getJobConcurrency(handlerName), handler)
 128            .catch(err => logger.error('Error in job queue processor %s.', handlerName, { err }))
 129
 130       queue.on('failed', (job, err) => {
 131         logger.error('Cannot execute job %d in queue %s.', job.id, handlerName, { payload: job.data, err })
 132       })
 133
 134       queue.on('error', err => {
 135         logger.error('Error in job queue %s.', handlerName, { err })
 136       })
 137
 138       this.queues[handlerName] = queue
 139     }
 140
 141     this.addRepeatableJobs()
 142   }
 143
 144   terminate () {
 145     for (const queueName of Object.keys(this.queues)) {
 146       const queue = this.queues[queueName]
 147       queue.close()
 148     }
 149   }
 150
 151   createJob (obj: CreateJobArgument, options: CreateJobOptions = {}): void {
 152     this.createJobWithPromise(obj, options)
 153         .catch(err => logger.error('Cannot create job.', { err, obj }))
 154   }
 155
 156   createJobWithPromise (obj: CreateJobArgument, options: CreateJobOptions = {}) {
 157     const queue = this.queues[obj.type]
 158     if (queue === undefined) {
 159       logger.error('Unknown queue %s: cannot create job.', obj.type)
 160       return
 161     }
 162
 163     const jobArgs: Bull.JobOptions = {
 164       backoff: { delay: 60 * 1000, type: 'exponential' },
 165       attempts: JOB_ATTEMPTS[obj.type],
 166       timeout: JOB_TTL[obj.type],
 167       priority: options.priority,
 168       delay: options.delay
 169     }
 170
 171     return queue.add(obj.payload, jobArgs)
 172   }
 173
 174   async listForApi (options: {
 175     state?: JobState
 176     start: number
 177     count: number
 178     asc?: boolean
 179     jobType: JobType
 180   }): Promise<Bull.Job[]> {
 181     const { state, start, count, asc, jobType } = options
 182
 183     const states = state ? [ state ] : jobStates
 184     let results: Bull.Job[] = []
 185
 186     const filteredJobTypes = this.filterJobTypes(jobType)
 187
 188     for (const jobType of filteredJobTypes) {
 189       const queue = this.queues[jobType]
 190       if (queue === undefined) {
 191         logger.error('Unknown queue %s to list jobs.', jobType)
 192         continue
 193       }
 194
 195       const jobs = await queue.getJobs(states, 0, start + count, asc)
 196       results = results.concat(jobs)
 197     }
 198
 199     results.sort((j1: any, j2: any) => {
 200       if (j1.timestamp < j2.timestamp) return -1
 201       else if (j1.timestamp === j2.timestamp) return 0
 202
 203       return 1
 204     })
 205
 206     if (asc === false) results.reverse()
 207
 208     return results.slice(start, start + count)
 209   }
 210
 211   async count (state: JobState, jobType?: JobType): Promise<number> {
 212     const states = state ? [ state ] : jobStates
 213     let total = 0
 214
 215     const filteredJobTypes = this.filterJobTypes(jobType)
 216
 217     for (const type of filteredJobTypes) {
 218       const queue = this.queues[type]
 219       if (queue === undefined) {
 220         logger.error('Unknown queue %s to count jobs.', type)
 221         continue
 222       }
 223
 224       const counts = await queue.getJobCounts()
 225
 226       for (const s of states) {
 227         total += counts[s]
 228       }
 229     }
 230
 231     return total
 232   }
 233
 234   async removeOldJobs () {
 235     for (const key of Object.keys(this.queues)) {
 236       const queue = this.queues[key]
 237       await queue.clean(JOB_COMPLETED_LIFETIME, 'completed')
 238     }
 239   }
 240
 241   private addRepeatableJobs () {
 242     this.queues['videos-views'].add({}, {
 243       repeat: REPEAT_JOBS['videos-views']
 244     }).catch(err => logger.error('Cannot add repeatable job.', { err }))
 245
 246     if (CONFIG.FEDERATION.VIDEOS.CLEANUP_REMOTE_INTERACTIONS) {
 247       this.queues['activitypub-cleaner'].add({}, {
 248         repeat: REPEAT_JOBS['activitypub-cleaner']
 249       }).catch(err => logger.error('Cannot add repeatable job.', { err }))
 250     }
 251   }
 252
 253   private filterJobTypes (jobType?: JobType) {
 254     if (!jobType) return jobTypes
 255
 256     return jobTypes.filter(t => t === jobType)
 257   }
 258
 259   private getJobConcurrency (jobType: JobType) {
 260     if (jobType === 'video-transcoding') return CONFIG.TRANSCODING.CONCURRENCY
 261     if (jobType === 'video-import') return CONFIG.IMPORT.VIDEOS.CONCURRENCY
 262
 263     return JOB_CONCURRENCY[jobType]
 264   }
 265
 266   static get Instance () {
 267     return this.instance || (this.instance = new this())
 268   }
 269 }
 270
 271 // ---------------------------------------------------------------------------
 272
 273 export {
 274   jobTypes,
 275   JobQueue
 276 }