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

   1 import * as Bull from 'bull'
   2 import { JobState, JobType } from '../../../shared/models'
   3 import { logger } from '../../helpers/logger'
   4 import { Redis } from '../redis'
   5 import { CONFIG, JOB_ATTEMPTS, JOB_COMPLETED_LIFETIME, JOB_CONCURRENCY, JOB_REQUEST_TTL } from '../../initializers'
   6 import { ActivitypubHttpBroadcastPayload, processActivityPubHttpBroadcast } from './handlers/activitypub-http-broadcast'
   7 import { ActivitypubHttpFetcherPayload, processActivityPubHttpFetcher } from './handlers/activitypub-http-fetcher'
   8 import { ActivitypubHttpUnicastPayload, processActivityPubHttpUnicast } from './handlers/activitypub-http-unicast'
   9 import { EmailPayload, processEmail } from './handlers/email'
  10 import { processVideoFile, processVideoFileImport, VideoFileImportPayload, VideoFilePayload } from './handlers/video-file'
  11 import { ActivitypubFollowPayload, processActivityPubFollow } from './handlers/activitypub-follow'
  12 import { processVideoImport, VideoImportPayload } from './handlers/video-import'
  13
  14 type CreateJobArgument =
  15   { type: 'activitypub-http-broadcast', payload: ActivitypubHttpBroadcastPayload } |
  16   { type: 'activitypub-http-unicast', payload: ActivitypubHttpUnicastPayload } |
  17   { type: 'activitypub-http-fetcher', payload: ActivitypubHttpFetcherPayload } |
  18   { type: 'activitypub-follow', payload: ActivitypubFollowPayload } |
  19   { type: 'video-file-import', payload: VideoFileImportPayload } |
  20   { type: 'video-file', payload: VideoFilePayload } |
  21   { type: 'email', payload: EmailPayload } |
  22   { type: 'video-import', payload: VideoImportPayload }
  23
  24 const handlers: { [ id in JobType ]: (job: Bull.Job) => Promise<any>} = {
  25   'activitypub-http-broadcast': processActivityPubHttpBroadcast,
  26   'activitypub-http-unicast': processActivityPubHttpUnicast,
  27   'activitypub-http-fetcher': processActivityPubHttpFetcher,
  28   'activitypub-follow': processActivityPubFollow,
  29   'video-file-import': processVideoFileImport,
  30   'video-file': processVideoFile,
  31   'email': processEmail,
  32   'video-import': processVideoImport
  33 }
  34
  35 const jobsWithRequestTimeout: { [ id in JobType ]?: boolean } = {
  36   'activitypub-http-broadcast': true,
  37   'activitypub-http-unicast': true,
  38   'activitypub-http-fetcher': true,
  39   'activitypub-follow': true
  40 }
  41
  42 const jobTypes: JobType[] = [
  43   'activitypub-follow',
  44   'activitypub-http-broadcast',
  45   'activitypub-http-fetcher',
  46   'activitypub-http-unicast',
  47   'email',
  48   'video-file',
  49   'video-file-import',
  50   'video-import'
  51 ]
  52
  53 class JobQueue {
  54
  55   private static instance: JobQueue
  56
  57   private queues: { [ id in JobType ]?: Bull.Queue } = {}
  58   private initialized = false
  59   private jobRedisPrefix: string
  60
  61   private constructor () {}
  62
  63   async init () {
  64     // Already initialized
  65     if (this.initialized === true) return
  66     this.initialized = true
  67
  68     this.jobRedisPrefix = 'bull-' + CONFIG.WEBSERVER.HOST
  69     const queueOptions = {
  70       prefix: this.jobRedisPrefix,
  71       redis: Redis.getRedisClient(),
  72       settings: {
  73         maxStalledCount: 10 // transcoding could be long, so jobs can often be interrupted by restarts
  74       }
  75     }
  76
  77     for (const handlerName of Object.keys(handlers)) {
  78       const queue = new Bull(handlerName, queueOptions)
  79       const handler = handlers[handlerName]
  80
  81       queue.process(JOB_CONCURRENCY[handlerName], handler)
  82         .catch(err => logger.error('Cannot execute job queue %s.', handlerName, { err }))
  83
  84       queue.on('error', err => {
  85         logger.error('Error in job queue %s.', handlerName, { err })
  86         process.exit(-1)
  87       })
  88
  89       this.queues[handlerName] = queue
  90     }
  91   }
  92
  93   terminate () {
  94     for (const queueName of Object.keys(this.queues)) {
  95       const queue = this.queues[queueName]
  96       queue.close()
  97     }
  98   }
  99
 100   createJob (obj: CreateJobArgument) {
 101     const queue = this.queues[obj.type]
 102     if (queue === undefined) {
 103       logger.error('Unknown queue %s: cannot create job.', obj.type)
 104       throw Error('Unknown queue, cannot create job')
 105     }
 106
 107     const jobArgs: Bull.JobOptions = {
 108       backoff: { delay: 60 * 1000, type: 'exponential' },
 109       attempts: JOB_ATTEMPTS[obj.type]
 110     }
 111
 112     if (jobsWithRequestTimeout[obj.type] === true) {
 113       jobArgs.timeout = JOB_REQUEST_TTL
 114     }
 115
 116     return queue.add(obj.payload, jobArgs)
 117   }
 118
 119   async listForApi (state: JobState, start: number, count: number, asc?: boolean): Promise<Bull.Job[]> {
 120     let results: Bull.Job[] = []
 121
 122     // TODO: optimize
 123     for (const jobType of jobTypes) {
 124       const queue = this.queues[ jobType ]
 125       if (queue === undefined) {
 126         logger.error('Unknown queue %s to list jobs.', jobType)
 127         continue
 128       }
 129
 130       // FIXME: Bull queue typings does not have getJobs method
 131       const jobs = await (queue as any).getJobs(state, 0, start + count, asc)
 132       results = results.concat(jobs)
 133     }
 134
 135     results.sort((j1: any, j2: any) => {
 136       if (j1.timestamp < j2.timestamp) return -1
 137       else if (j1.timestamp === j2.timestamp) return 0
 138
 139       return 1
 140     })
 141
 142     if (asc === false) results.reverse()
 143
 144     return results.slice(start, start + count)
 145   }
 146
 147   async count (state: JobState): Promise<number> {
 148     let total = 0
 149
 150     for (const type of jobTypes) {
 151       const queue = this.queues[ type ]
 152       if (queue === undefined) {
 153         logger.error('Unknown queue %s to count jobs.', type)
 154         continue
 155       }
 156
 157       const counts = await queue.getJobCounts()
 158
 159       total += counts[ state ]
 160     }
 161
 162     return total
 163   }
 164
 165   removeOldJobs () {
 166     for (const key of Object.keys(this.queues)) {
 167       const queue = this.queues[key]
 168       queue.clean(JOB_COMPLETED_LIFETIME, 'completed')
 169     }
 170   }
 171
 172   static get Instance () {
 173     return this.instance || (this.instance = new this())
 174   }
 175 }
 176
 177 // ---------------------------------------------------------------------------
 178
 179 export {
 180   JobQueue
 181 }