1 import * as kue from 'kue'
2 import { JobState, JobType } from '../../../shared/models'
3 import { logger } from '../../helpers/logger'
4 import { CONFIG, JOB_ATTEMPTS, JOB_COMPLETED_LIFETIME, JOB_CONCURRENCY, JOB_REQUEST_TTL } from '../../initializers'
5 import { Redis } from '../redis'
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, processVideoImport, VideoFilePayload, VideoImportPayload } from './handlers/video-file'
11 import { ActivitypubFollowPayload, processActivityPubFollow } from './handlers/activitypub-follow'
13 type CreateJobArgument =
14 { type: 'activitypub-http-broadcast', payload: ActivitypubHttpBroadcastPayload } |
15 { type: 'activitypub-http-unicast', payload: ActivitypubHttpUnicastPayload } |
16 { type: 'activitypub-http-fetcher', payload: ActivitypubHttpFetcherPayload } |
17 { type: 'activitypub-follow', payload: ActivitypubFollowPayload } |
18 { type: 'video-file-import', payload: VideoImportPayload } |
19 { type: 'video-file', payload: VideoFilePayload } |
20 { type: 'email', payload: EmailPayload }
22 const handlers: { [ id in JobType ]: (job: kue.Job) => Promise<any>} = {
23 'activitypub-http-broadcast': processActivityPubHttpBroadcast,
24 'activitypub-http-unicast': processActivityPubHttpUnicast,
25 'activitypub-http-fetcher': processActivityPubHttpFetcher,
26 'activitypub-follow': processActivityPubFollow,
27 'video-file-import': processVideoImport,
28 'video-file': processVideoFile,
32 const jobsWithTLL: JobType[] = [
33 'activitypub-http-broadcast',
34 'activitypub-http-unicast',
35 'activitypub-http-fetcher',
41 private static instance: JobQueue
43 private jobQueue: kue.Queue
44 private initialized = false
45 private jobRedisPrefix: string
47 private constructor () {}
50 // Already initialized
51 if (this.initialized === true) return
52 this.initialized = true
54 this.jobRedisPrefix = 'q-' + CONFIG.WEBSERVER.HOST
56 this.jobQueue = kue.createQueue({
57 prefix: this.jobRedisPrefix,
59 host: CONFIG.REDIS.HOSTNAME,
60 port: CONFIG.REDIS.PORT,
61 auth: CONFIG.REDIS.AUTH,
66 this.jobQueue.setMaxListeners(20)
68 this.jobQueue.on('error', err => {
69 logger.error('Error in job queue.', { err })
72 this.jobQueue.watchStuckJobs(5000)
74 await this.reactiveStuckJobs()
76 for (const handlerName of Object.keys(handlers)) {
77 this.jobQueue.process(handlerName, JOB_CONCURRENCY[handlerName], async (job, done) => {
79 const res = await handlers[ handlerName ](job)
80 return done(null, res)
88 createJob (obj: CreateJobArgument, priority = 'normal') {
89 return new Promise((res, rej) => {
90 let job = this.jobQueue
91 .create(obj.type, obj.payload)
93 .attempts(JOB_ATTEMPTS[obj.type])
94 .backoff({ delay: 60 * 1000, type: 'exponential' })
96 if (jobsWithTLL.indexOf(obj.type) !== -1) {
97 job = job.ttl(JOB_REQUEST_TTL)
100 return job.save(err => {
101 if (err) return rej(err)
108 async listForApi (state: JobState, start: number, count: number, sort: 'ASC' | 'DESC'): Promise<kue.Job[]> {
109 const jobStrings = await Redis.Instance.listJobs(this.jobRedisPrefix, state, 'alpha', sort, start, count)
111 const jobPromises = jobStrings
112 .map(s => s.split('|'))
113 .map(([ , jobId ]) => this.getJob(parseInt(jobId, 10)))
115 return Promise.all(jobPromises)
118 count (state: JobState) {
119 return new Promise<number>((res, rej) => {
120 this.jobQueue[state + 'Count']((err, total) => {
121 if (err) return rej(err)
129 const now = new Date().getTime()
130 kue.Job.rangeByState('complete', 0, -1, 'asc', (err, jobs) => {
132 logger.error('Cannot get jobs when removing old jobs.', { err })
136 for (const job of jobs) {
137 if (now - job.created_at > JOB_COMPLETED_LIFETIME) {
144 private reactiveStuckJobs () {
145 const promises: Promise<any>[] = []
147 this.jobQueue.active((err, ids) => {
150 for (const id of ids) {
151 kue.Job.get(id, (err, job) => {
154 const p = new Promise((res, rej) => {
155 job.inactive(err => {
156 if (err) return rej(err)
166 return Promise.all(promises)
169 private getJob (id: number) {
170 return new Promise<kue.Job>((res, rej) => {
171 kue.Job.get(id, (err, job) => {
172 if (err) return rej(err)
179 static get Instance () {
180 return this.instance || (this.instance = new this())
184 // ---------------------------------------------------------------------------