]>
Commit | Line | Data |
---|---|---|
bcd1c9e1 | 1 | import { AsyncQueue, forever, queue } from 'async' |
69818c93 | 2 | import * as Sequelize from 'sequelize' |
571389d4 | 3 | import { JobCategory } from '../../../shared' |
65fcc311 | 4 | import { logger } from '../../helpers' |
571389d4 | 5 | import { database as db, JOB_STATES, JOBS_FETCH_LIMIT_PER_CYCLE, JOBS_FETCHING_INTERVAL } from '../../initializers' |
69818c93 | 6 | import { JobInstance } from '../../models' |
350e31d6 | 7 | import { error } from 'util' |
69818c93 | 8 | |
571389d4 C |
9 | export interface JobHandler<P, T> { |
10 | process (data: object, jobId: number): Promise<T> | |
e4f97bab | 11 | onError (err: Error, jobId: number) |
571389d4 | 12 | onSuccess (jobId: number, jobResult: T, jobScheduler: JobScheduler<P, T>) |
e4f97bab | 13 | } |
69818c93 | 14 | type JobQueueCallback = (err: Error) => void |
65fcc311 | 15 | |
571389d4 | 16 | class JobScheduler<P, T> { |
65fcc311 | 17 | |
e4f97bab C |
18 | constructor ( |
19 | private jobCategory: JobCategory, | |
571389d4 | 20 | private jobHandlers: { [ id: string ]: JobHandler<P, T> } |
e4f97bab | 21 | ) {} |
65fcc311 | 22 | |
f5028693 | 23 | async activate () { |
e4f97bab | 24 | const limit = JOBS_FETCH_LIMIT_PER_CYCLE[this.jobCategory] |
65fcc311 | 25 | |
e4f97bab | 26 | logger.info('Jobs scheduler %s activated.', this.jobCategory) |
65fcc311 | 27 | |
69818c93 | 28 | const jobsQueue = queue<JobInstance, JobQueueCallback>(this.processJob.bind(this)) |
65fcc311 C |
29 | |
30 | // Finish processing jobs from a previous start | |
31 | const state = JOB_STATES.PROCESSING | |
f5028693 | 32 | try { |
e4f97bab | 33 | const jobs = await db.Job.listWithLimitByCategory(limit, state, this.jobCategory) |
f5028693 C |
34 | |
35 | this.enqueueJobs(jobsQueue, jobs) | |
36 | } catch (err) { | |
37 | logger.error('Cannot list pending jobs.', err) | |
38 | } | |
39 | ||
40 | forever( | |
41 | async next => { | |
42 | if (jobsQueue.length() !== 0) { | |
43 | // Finish processing the queue first | |
44 | return setTimeout(next, JOBS_FETCHING_INTERVAL) | |
45 | } | |
46 | ||
47 | const state = JOB_STATES.PENDING | |
48 | try { | |
e4f97bab | 49 | const jobs = await db.Job.listWithLimitByCategory(limit, state, this.jobCategory) |
f5028693 C |
50 | |
51 | this.enqueueJobs(jobsQueue, jobs) | |
52 | } catch (err) { | |
53 | logger.error('Cannot list pending jobs.', err) | |
54 | } | |
55 | ||
56 | // Optimization: we could use "drain" from queue object | |
57 | return setTimeout(next, JOBS_FETCHING_INTERVAL) | |
58 | }, | |
59 | ||
60 | err => logger.error('Error in job scheduler queue.', err) | |
61 | ) | |
65fcc311 C |
62 | } |
63 | ||
571389d4 | 64 | createJob (transaction: Sequelize.Transaction, handlerName: string, handlerInputData: P) { |
65fcc311 C |
65 | const createQuery = { |
66 | state: JOB_STATES.PENDING, | |
571389d4 | 67 | category: this.jobCategory, |
65fcc311 C |
68 | handlerName, |
69 | handlerInputData | |
70 | } | |
571389d4 | 71 | |
65fcc311 C |
72 | const options = { transaction } |
73 | ||
6fcd19ba | 74 | return db.Job.create(createQuery, options) |
65fcc311 C |
75 | } |
76 | ||
6fcd19ba C |
77 | private enqueueJobs (jobsQueue: AsyncQueue<JobInstance>, jobs: JobInstance[]) { |
78 | jobs.forEach(job => jobsQueue.push(job)) | |
65fcc311 C |
79 | } |
80 | ||
f5028693 | 81 | private async processJob (job: JobInstance, callback: (err: Error) => void) { |
e4f97bab | 82 | const jobHandler = this.jobHandlers[job.handlerName] |
6fcd19ba | 83 | if (jobHandler === undefined) { |
350e31d6 C |
84 | const errorString = 'Unknown job handler ' + job.handlerName + ' for job ' + job.id |
85 | logger.error(errorString) | |
86 | ||
87 | const error = new Error(errorString) | |
88 | await this.onJobError(jobHandler, job, error) | |
89 | return callback(error) | |
6fcd19ba | 90 | } |
65fcc311 C |
91 | |
92 | logger.info('Processing job %d with handler %s.', job.id, job.handlerName) | |
93 | ||
94 | job.state = JOB_STATES.PROCESSING | |
f5028693 C |
95 | await job.save() |
96 | ||
97 | try { | |
571389d4 | 98 | const result: T = await jobHandler.process(job.handlerInputData, job.id) |
f5028693 C |
99 | await this.onJobSuccess(jobHandler, job, result) |
100 | } catch (err) { | |
101 | logger.error('Error in job handler %s.', job.handlerName, err) | |
102 | ||
103 | try { | |
104 | await this.onJobError(jobHandler, job, err) | |
105 | } catch (innerErr) { | |
106 | this.cannotSaveJobError(innerErr) | |
107 | return callback(innerErr) | |
108 | } | |
109 | } | |
110 | ||
350e31d6 | 111 | return callback(null) |
65fcc311 C |
112 | } |
113 | ||
571389d4 | 114 | private async onJobError (jobHandler: JobHandler<P, T>, job: JobInstance, err: Error) { |
65fcc311 C |
115 | job.state = JOB_STATES.ERROR |
116 | ||
f5028693 C |
117 | try { |
118 | await job.save() | |
350e31d6 | 119 | if (jobHandler) await jobHandler.onError(err, job.id) |
f5028693 C |
120 | } catch (err) { |
121 | this.cannotSaveJobError(err) | |
122 | } | |
65fcc311 C |
123 | } |
124 | ||
571389d4 | 125 | private async onJobSuccess (jobHandler: JobHandler<P, T>, job: JobInstance, jobResult: T) { |
65fcc311 C |
126 | job.state = JOB_STATES.SUCCESS |
127 | ||
f5028693 C |
128 | try { |
129 | await job.save() | |
571389d4 | 130 | jobHandler.onSuccess(job.id, jobResult, this) |
f5028693 C |
131 | } catch (err) { |
132 | this.cannotSaveJobError(err) | |
133 | } | |
65fcc311 C |
134 | } |
135 | ||
6fcd19ba | 136 | private cannotSaveJobError (err: Error) { |
ad0997ad | 137 | logger.error('Cannot save new job state.', err) |
65fcc311 C |
138 | } |
139 | } | |
140 | ||
141 | // --------------------------------------------------------------------------- | |
142 | ||
143 | export { | |
144 | JobScheduler | |
145 | } |