forked from Automattic/kue
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathkue.js
More file actions
executable file
·444 lines (373 loc) · 9.95 KB
/
Copy pathkue.js
File metadata and controls
executable file
·444 lines (373 loc) · 9.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
/*!
* kue
* Copyright (c) 2011 LearnBoost <tj@learnboost.com>
* MIT Licensed
*/
/**
* Module dependencies.
*/
var EventEmitter = require('events').EventEmitter
, Worker = require('./queue/worker')
, events = require('./queue/events')
, Job = require('./queue/job')
, redis = require('./redis');
/**
* Expose `Queue`.
*/
exports = module.exports = Queue;
/**
* Library version.
*/
exports.version = require('../package.json').version;
/**
* Expose `Job`.
*/
exports.Job = Job;
/**
* Server instance (that is lazily required)
*/
var app;
/**
* Expose the server.
*/
Object.defineProperty(exports, 'app', {
get: function () {
return app || (app = require('./http'));
}
});
/**
* Expose the RedisClient factory.
*/
exports.redis = redis;
/**
* Create a new `Queue`.
*
* @return {Queue}
* @api public
*/
exports.createQueue = function ( options ) {
if (!Queue.singleton) {
Queue.singleton = new Queue( options );
}
events.subscribe();
return Queue.singleton;
};
/**
* Store workers
*/
exports.workers = [];
/**
* Initialize a new job `Queue`.
*
* @api public
*/
function Queue( options ) {
options = options || {};
var prefix = options.prefix || 'q';
// guarantee that redis._client has not been populated.
// may warrant some more testing - i was running into cases where shutdown
// would call redis.reset but an event would be emitted after the reset
// which would re-create the client and cache it in the redis module.
redis.reset();
// use custom createClient if specific redis options or queue prefix
if( options.redis || options.prefix ){
if( !options.redis ) {
// case where prefix is provided but no specific redis options.
// set this to empty hash to avoid errors below
options.redis = {};
}
redis.createClient = function() {
var self = this;
// redis.debug_mode = true;
var port = options.redis.port || 6379;
var host = options.redis.host || '127.0.0.1';
var client = require('redis').createClient( port , host, options.redis.options );
if (options.redis.auth) {
client.auth(options.redis.auth);
}
client.on('error', function (err) {
self.emit('error', err);
});
client.prefix = prefix;
// redefine getKey to use the configured prefix
client.getKey = function (key) {
return this.prefix + ':' + key;
};
return client;
}.bind(this);
}
//TODO test with this.client = redis.createClient();
// this.client = redis.createClient();
this.client = Worker.client = Job.client = redis.createClient();
this.promoter = null;
this.workers = exports.workers;
this.prefix = prefix;
Job.disableSearch = options.disableSearch;
}
/**
* Inherit from `EventEmitter.prototype`.
*/
Queue.prototype.__proto__ = EventEmitter.prototype;
/**
* Create a `Job` with the given `type` and `data`.
*
* @param {String} type
* @param {Object} data
* @return {Job}
* @api public
*/
Queue.prototype.create =
Queue.prototype.createJob = function (type, data) {
return new Job(type, data);
};
/**
* Proxy to auto-subscribe to events.
*
* @api public
*/
var on = EventEmitter.prototype.on;
Queue.prototype.on = function (event) {
if (0 == event.indexOf('job')) events.subscribe();
return on.apply(this, arguments);
};
/**
* Promote delayed jobs, checking every `ms`,
* defaulting to 5 seconds.
*
* @params {Number} ms
* @api public
*/
Queue.prototype.promote = function (ms, l) {
var client = this.client
, ms = ms || 5000
, limit = l || 200;
clearInterval(this.promoter);
this.promoter = setInterval(function () {
client.sort(client.getKey('jobs:delayed')
, 'by', client.getKey('job:*->delay')
, 'get', '#'
, 'get', client.getKey('job:*->delay')
, 'get', client.getKey('job:*->created_at')
, 'get', client.getKey('job:*->failed_at')
, 'limit', 0, limit, function (err, jobs) {
if (err || !jobs.length) return;
// iterate jobs with [id, delay, created_at]
while (jobs.length) {
var job = jobs.slice(0, 4)
, id = parseInt(job[0], 10)
, delay = parseInt(job[1], 10)
, creation = parseInt(job[2], 10)
, failed_at = parseInt(job[3], 10)
, promote = !Math.max((failed_at||creation) + delay - Date.now(), 0);
// if it's due for activity
// "promote" the job by marking
// it as inactive.
if (promote) {
Job.get(id, function (err, job) {
if (err) return;
events.emit(id, 'promotion');
job.inactive();
});
}
jobs = jobs.slice(4);
}
});
}, ms);
};
/**
* Get setting `name` and invoke `fn(err, res)`.
*
* @param {String} name
* @param {Function} fn
* @return {Queue} for chaining
* @api public
*/
Queue.prototype.setting = function (name, fn) {
this.client.hget(this.client.getKey('settings'), name, fn);
return this;
};
/**
* Process jobs with the given `type`, invoking `fn(job)`.
*
* @param {String} type
* @param {Number|Function} n
* @param {Function} fn
* @api public
*/
Queue.prototype.process = function (type, n, fn) {
var self = this;
if ('function' == typeof n) fn = n, n = 1;
while (n--) {
var worker = new Worker(this, type).start(fn);
worker.id = [process.pid,type,self.workers.length+1].join('-');
worker.on('error', function (err) {
self.emit('error', err);
});
worker.on('job complete', function (job) {
// guard against emit after shutdown
if (self.client) {
self.client.incrby(self.client.getKey('stats:work-time'), job.duration);
}
});
// Save worker so we can access it later
self.workers.push(worker);
}
};
/**
* Graceful shutdown
*
* @param {Function} fn callback
* @return {Queue} for chaining
* @api public
*/
Queue.prototype.shutdown = function (fn, timeout, type) {
var origFn = fn || function () {
}
, self = this
, n = self.workers.length
, type = type || '';
cleanup = function () {
if (type == '') {
self.client = null;
self.workers = [];
exports.workers = [];
self.removeAllListeners();
Queue.singleton = null;
events.unsubscribe();
// destroy redis client and pubsub
redis.reset();
}
};
// Wrap `fn` to only call after all workers finished
fn = function (err) {
if (err) return origFn(err);
if (!--n) {
cleanup();
origFn.apply(null, arguments);
}
};
// shut down promoter interval
if (type == '') {
if( self.promoter ) {
clearInterval( self.promoter );
self.promoter = null;
}
}
if (!self.workers.length) {
cleanup();
origFn();
} else {
// Shut down workers 1 by 1
self.workers.forEach(function (worker) {
if (type == '' || worker.type == type) {
worker.shutdown(fn, timeout);
} else {
fn && fn();
}
});
}
return this;
};
/**
* Get the job types present and callback `fn(err, types)`.
*
* @param {Function} fn
* @return {Queue} for chaining
* @api public
*/
Queue.prototype.types = function (fn) {
this.client.smembers(this.client.getKey('job:types'), fn);
return this;
};
/**
* Return job ids with the given `state`, and callback `fn(err, ids)`.
*
* @param {String} state
* @param {Function} fn
* @return {Queue} for chaining
* @api public
*/
Queue.prototype.state = function (state, fn) {
this.client.zrange(this.client.getKey('jobs:' + state), 0, -1, fn);
return this;
};
/**
* Get queue work time in milliseconds and invoke `fn(err, ms)`.
*
* @param {Function} fn
* @return {Queue} for chaining
* @api public
*/
Queue.prototype.workTime = function (fn) {
this.client.get(this.client.getKey('stats:work-time'), function (err, n) {
if (err) return fn(err);
fn(null, parseInt(n, 10));
});
return this;
};
/**
* Get cardinality of `state` and callback `fn(err, n)`.
*
* @param {String} state
* @param {Function} fn
* @return {Queue} for chaining
* @api public
*/
Queue.prototype.card = function (state, fn) {
this.client.zcard(this.client.getKey('jobs:' + state), fn);
return this;
};
/**
* Completed jobs.
*/
Queue.prototype.complete = function (fn) {
return this.state('complete', fn);
};
/**
* Failed jobs.
*/
Queue.prototype.failed = function (fn) {
return this.state('failed', fn);
};
/**
* Inactive jobs (queued).
*/
Queue.prototype.inactive = function (fn) {
return this.state('inactive', fn);
};
/**
* Active jobs (mid-process).
*/
Queue.prototype.active = function (fn) {
return this.state('active', fn);
};
/**
* Completed jobs count.
*/
Queue.prototype.completeCount = function (fn) {
return this.card('complete', fn);
};
/**
* Failed jobs count.
*/
Queue.prototype.failedCount = function (fn) {
return this.card('failed', fn);
};
/**
* Inactive jobs (queued) count.
*/
Queue.prototype.inactiveCount = function (fn) {
return this.card('inactive', fn);
};
/**
* Active jobs (mid-process).
*/
Queue.prototype.activeCount = function (fn) {
return this.card('active', fn);
};
/**
* Delayed jobs.
*/
Queue.prototype.delayedCount = function (fn) {
return this.card('delayed', fn);
};