-
-
Notifications
You must be signed in to change notification settings - Fork 151
/
queue.ts
680 lines (590 loc) · 19 KB
/
queue.ts
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
import { EventEmitter } from "events";
import * as os from "os";
import { ErrorPayload, Jobs } from "..";
import { QueueOptions } from "../types/options";
import { Connection } from "./connection";
import { RunPlugins } from "./pluginRunner";
export type ParsedJob = {
class: string;
queue: string;
args: Array<any>;
pluginOptions?: { [key: string]: any };
};
export type ParsedWorkerPayload = {
run_at: string;
queue: string;
worker: string;
payload: ParsedJob;
};
export type ParsedFailedJobPayload = {
worker: string;
queue: string;
payload: ParsedJob;
failed_at: string;
exception: string;
error: string;
backtrace: string[];
};
function arrayify<T>(o: T): T[] {
if (Array.isArray(o)) {
return o;
} else {
return [o];
}
}
export declare interface Queue {
connection: Connection;
options: QueueOptions;
jobs: Jobs;
on(event: "error", cb: (error: Error, queue: string) => void): this;
once(event: "error", cb: (error: Error, queue: string) => void): this;
}
export class Queue extends EventEmitter {
constructor(options: QueueOptions, jobs: Jobs = {}) {
super();
this.options = options;
this.jobs = jobs;
this.connection = new Connection(options.connection);
this.connection.on("error", (error) => {
this.emit("error", error);
});
}
async connect() {
return this.connection.connect();
}
async end() {
return this.connection.end();
}
encode(q: string, func: string, args: Array<any> = []) {
return JSON.stringify({
class: func,
queue: q,
args: args,
});
}
/**
* - Enqueue a named job (defined in `jobs` to be worked by a worker)
* - The job will be added to the `queueName` queue, and that queue will be worked down by available workers assigned to that queue
* - args is optional, but should be an array of arguments passed to the job. Order of arguments is maintained
*/
async enqueue(q: string, func: string, args: Array<any> = []) {
args = arrayify(args);
const job = this.jobs[func];
const toRun = await RunPlugins(this, "beforeEnqueue", func, q, job, args);
if (toRun === false) return toRun;
const response = await this.connection.redis
.multi()
.sadd(this.connection.key("queues"), q)
.rpush(this.connection.key("queue", q), this.encode(q, func, args))
.exec();
response.forEach((res) => {
if (res[0] !== null) {
throw res[0];
}
});
await RunPlugins(this, "afterEnqueue", func, q, job, args);
return toRun;
}
/**
* - In ms, the unix timestamp at which this job is able to start being worked on.
* - Depending on the number of other jobs in `queueName`, it is likely that this job will not be excecuted at exactly the time specified, but shortly thereafter.
* - other options the same as `queue.enqueue`
*/
async enqueueAt(
timestamp: number,
q: string,
func: string,
args: Array<any> = [],
suppressDuplicateTaskError = false,
) {
// Don't run plugins here, they should be run by scheduler at the enqueue step
args = arrayify(args);
const item = this.encode(q, func, args);
const rTimestamp = Math.round(timestamp / 1000); // assume timestamp is in ms
const match = "delayed:" + rTimestamp;
const foundMatch = await this.connection.redis.sismember(
this.connection.key("timestamps:" + item),
match,
);
if (foundMatch === 1) {
if (suppressDuplicateTaskError) {
return;
} else {
throw new Error(
"Job already enqueued at this time with same arguments",
);
}
}
const response = await this.connection.redis
.multi()
.rpush(this.connection.key("delayed:" + rTimestamp), item)
.sadd(this.connection.key("timestamps:" + item), "delayed:" + rTimestamp)
.zadd(
this.connection.key("delayed_queue_schedule"),
rTimestamp,
rTimestamp.toString(),
)
.exec();
response.forEach((res) => {
if (res[0] !== null) {
throw res[0];
}
});
}
/**
* - In ms, the number of ms to delay before this job is able to start being worked on.
* - Depending on the number of other jobs in `queueName`, it is likely that this job will not be excecuted at exactly the delay specified, but shortly thereafter.
* - other options the same as `queue.enqueue`
*/
async enqueueIn(
time: number,
q: string,
func: string,
args: Array<any> = [],
suppressDuplicateTaskError = false,
) {
const timestamp = new Date().getTime() + parseInt(time.toString(), 10);
return this.enqueueAt(timestamp, q, func, args, suppressDuplicateTaskError);
}
/**
* - queues is an Array with the names of all your queues
*/
async queues() {
return this.connection.redis.smembers(this.connection.key("queues"));
}
/**
* - delete a queue, and all jobs in that queue.
*/
async delQueue(q: string) {
const { redis } = this.connection;
const response = await redis
.multi()
.del(this.connection.key("queue", q))
.srem(this.connection.key("queues"), q)
.exec();
response.forEach((res) => {
if (res[0] !== null) {
throw res[0];
}
});
}
/**
* - length is an integer counting the length of the jobs in the queue
* - this does not include delayed jobs for this queue
*/
async length(q: string) {
return this.connection.redis.llen(this.connection.key("queue", q));
}
/**
* - jobs are deleted by those matching a `func` and argument collection within a given queue.
* - You might match none, or you might match many.
*/
async del(q: string, func: string, args: Array<any> = [], count: number = 0) {
args = arrayify(args);
return this.connection.redis.lrem(
this.connection.key("queue", q),
count,
this.encode(q, func, args),
);
}
/**
* delByFunction
* * will delete all jobs in the given queue of the named function/class
* * will not prevent new jobs from being added as this method is running
* * will not delete jobs in the delayed queues
* @param q - queue to look in
* @param func - function name to delete any jobs with
* @param start - optional place to start looking in list (default: beginning of list)
* @param stop - optional place to end looking in list (default: end of list)
* @returns number of jobs deleted from queue
*/
async delByFunction(
q: string,
func: string,
start: number = 0,
stop: number = -1,
) {
const jobs = await this.connection.redis.lrange(
this.connection.key("queue", q),
start,
stop,
);
let numJobsDeleted: number = 0;
const pipeline = this.connection.redis.multi();
for (let i = 0; i < jobs.length; i++) {
const jobEncoded = jobs[i];
const { class: jobFunc } = JSON.parse(jobEncoded) as ParsedJob;
if (jobFunc === func) {
pipeline.lrem(this.connection.key("queue", q), 0, jobEncoded);
numJobsDeleted++;
}
}
const response = await pipeline.exec();
response.forEach((res) => {
if (res[0] !== null) {
throw res[0];
}
});
return numJobsDeleted;
}
async delDelayed(q: string, func: string, args: Array<any> = []) {
const timestamps = [];
args = arrayify(args);
const search = this.encode(q, func, args);
const members = await this.connection.redis.smembers(
this.connection.key("timestamps:" + search),
);
const pipeline = this.connection.redis.multi();
for (const i in members) {
const key = members[i];
const count = await this.connection.redis.lrem(
this.connection.key(key),
0,
search,
);
if (count > 0) {
timestamps.push(key.split(":")[key.split(":").length - 1]);
pipeline.srem(this.connection.key("timestamps:" + search), key);
}
}
const response = await pipeline.exec();
response.forEach((res) => {
if (res[0] !== null) {
throw res[0];
}
});
return timestamps.map((t) => parseInt(t, 10));
}
/**
* - learn the timestamps at which a job is scheduled to be run.
* - `timestampsForJob` is an array of integers
*/
async scheduledAt(q: string, func: string, args: Array<any> = []) {
const timestamps: number[] = [];
args = arrayify(args);
const search = this.encode(q, func, args);
const members = await this.connection.redis.smembers(
this.connection.key("timestamps:" + search),
);
members.forEach((key) => {
timestamps.push(parseInt(key.split(":")[key.split(":").length - 1]));
});
return timestamps;
}
/**
* - `timestamps` is an array of integers for all timestamps which have at least one job scheduled in the future
*/
async timestamps() {
const results: number[] = [];
const timestamps = await this.connection.getKeys(
this.connection.key("delayed:*"),
);
timestamps.forEach((timestamp) => {
const parts = timestamp.split(":");
results.push(parseInt(parts[parts.length - 1]) * 1000);
});
results.sort();
return results;
}
/**
* - `jobsEnqueuedForThisTimestamp` is an array, matching the style of the response of `queue.queued`
*/
async delayedAt(timestamp: number) {
const rTimestamp = Math.round(timestamp / 1000); // assume timestamp is in ms
const items = await this.connection.redis.lrange(
this.connection.key("delayed:" + rTimestamp),
0,
-1,
);
const tasks = items.map((i) => {
return JSON.parse(i) as ParsedJob;
});
return { tasks, rTimestamp };
}
/**
* - list all the jobs (with their payloads) in a queue between start index and stop index.
* - jobs is an array containing the payload of the job enqueued
*/
async queued(q: string, start: number, stop: number) {
const items = await this.connection.redis.lrange(
this.connection.key("queue", q),
start,
stop,
);
const tasks = items.map(function (i) {
return JSON.parse(i);
});
return tasks;
}
/**
* - jobsHash is an object with its keys being timestamps, and the values are arrays of jobs at each time.
* - note that this operation can be very slow and very ram-heavy
*/
async allDelayed() {
const results: { [key: string]: any[] } = {};
const timestamps = await this.timestamps();
for (const i in timestamps) {
const timestamp = timestamps[i];
const { tasks, rTimestamp } = await this.delayedAt(timestamp);
results[(rTimestamp * 1000).toString(10)] = tasks;
}
return results;
}
/**
* - types of locks include queue and worker locks, as created by the plugins below
* - `locks` is a hash by type and timestamp
*/
async locks() {
let keys: Array<string> = [];
const data: { [key: string]: string } = {};
let _keys: Array<string>;
let values = [];
_keys = await this.connection.getKeys(this.connection.key("lock:*"));
keys = keys.concat(_keys);
_keys = await this.connection.getKeys(this.connection.key("workerslock:*"));
keys = keys.concat(_keys);
if (keys.length === 0) {
return data;
}
for (const i in keys) {
let value = await this.connection.redis.get(keys[i]);
values.push(value);
}
for (let i = 0; i < keys.length; i++) {
let k = keys[i];
k = k.replace(this.connection.key(""), "");
if (k[0] === ":") {
k = k.substr(1);
}
data[k] = values[i];
}
return data;
}
/**
* - `count` is an integer. You might delete more than one lock by the name.
*/
async delLock(key: string) {
return this.connection.redis.del(this.connection.key(key));
}
/**
* - returns a hash of the form: `{ 'host:pid': 'queue1, queue2', 'host:pid': 'queue1, queue2' }`
*/
async workers() {
const workers: { [key: string]: string } = {};
const results = await this.connection.redis.smembers(
this.connection.key("workers"),
);
results.forEach(function (r) {
const parts = r.split(":");
let name;
let queues: string;
if (parts.length === 1) {
name = parts[0];
workers[name] = null;
} else if (parts.length === 2) {
name = parts[0];
queues = parts[1];
workers[name] = queues;
} else {
name = parts.shift() + ":" + parts.shift();
queues = parts.join(":");
workers[name] = queues;
}
});
return workers;
}
/**
* - returns: `{"run_at":"Fri Dec 12 2014 14:01:16 GMT-0800 (PST)","queue":"test_queue","payload":{"class":"slowJob","queue":"test_queue","args":[null]},"worker":"workerA"}`
*/
async workingOn(workerName: string, queues: string) {
const fullWorkerName = workerName + ":" + queues;
return this.connection.redis.get(
this.connection.key("worker", fullWorkerName),
);
}
/**
* - returns a hash of the results of `queue.workingOn` with the worker names as keys.
*/
async allWorkingOn() {
const results: { [key: string]: ParsedWorkerPayload } = {};
const workers = await this.workers();
for (const i in Object.keys(workers)) {
const w = Object.keys(workers)[i];
//@ts-ignore
results[w] = "started";
let data = await this.workingOn(w, workers[w]);
if (data) {
let parsedData = JSON.parse(data) as ParsedWorkerPayload;
results[parsedData.worker] = parsedData;
}
}
return results;
}
async forceCleanWorker(workerName: string) {
let errorPayload: ErrorPayload;
const workers = await this.workers();
const queues = workers[workerName];
if (!queues) {
this.emit(
"error",
`force-cleaning worker ${workerName}, but cannot find queues`,
);
} else {
let workingOn = await this.workingOn(workerName, queues);
const message = "Worker Timeout (killed manually)";
if (workingOn) {
let parsedWorkingOn = JSON.parse(workingOn);
errorPayload = {
worker: workerName,
queue: parsedWorkingOn.queue,
payload: parsedWorkingOn.payload || {},
exception: message,
error: message,
backtrace: [
`killed by ${os.hostname} at ${new Date()}`,
"queue#forceCleanWorker",
"node-resque",
],
failed_at: new Date().toString(),
};
}
}
const pipeline = this.connection.redis
.multi()
.incr(this.connection.key("stat", "failed"))
.del(this.connection.key("stat", "failed", workerName))
.del(this.connection.key("stat", "processed", workerName))
.del(this.connection.key("worker", "ping", workerName))
.del(this.connection.key("worker", workerName, queues, "started"))
.del(this.connection.key("worker", workerName))
.srem(this.connection.key("workers"), workerName + ":" + queues);
if (errorPayload) {
pipeline.rpush(
this.connection.key("failed"),
JSON.stringify(errorPayload),
);
}
const response = await pipeline.exec();
response.forEach((res) => {
if (res[0] !== null) {
throw res[0];
}
});
return errorPayload;
}
async cleanOldWorkers(age: number) {
// note: this method will remove the data created by a 'stuck' worker and move the payload to the error queue
// however, it will not actually remove any processes which may be running. A job *may* be running that you have removed
const results: { [key: string]: any } = {};
const data = await this.allWorkingOn();
for (const i in Object.keys(data)) {
const workerName = Object.keys(data)[i];
const payload = data[workerName];
if (
typeof payload !== "string" &&
payload.run_at &&
Date.now() - Date.parse(payload.run_at) > age
) {
const errorPayload = await this.forceCleanWorker(workerName);
if (errorPayload && errorPayload.worker) {
results[errorPayload.worker] = errorPayload;
}
}
}
return results;
}
/**
* - `failedCount` is the number of jobs in the failed queue
*/
async failedCount() {
return this.connection.redis.llen(this.connection.key("failed"));
}
/**
* - `failedJobs` is an array listing the data of the failed jobs. Each element looks like:
* ```
* {"worker": "host:pid", "queue": "test_queue", "payload": {"class":"slowJob", "queue":"test_queue", "args":[null]}, "exception": "TypeError", "error": "MyImport is not a function", "backtrace": [' at Worker.perform (/path/to/worker:111:24)', ' at <anonymous>'], "failed_at": "Fri Dec 12 2014 14:01:16 GMT-0800 (PST)"}\
* ```
* - To retrieve all failed jobs, use arguments: `await queue.failed(0, -1)`
*/
async failed(start: number, stop: number) {
const data = await this.connection.redis.lrange(
this.connection.key("failed"),
start,
stop,
);
const results = data.map((i) => {
return JSON.parse(i) as ParsedFailedJobPayload;
});
return results;
}
async removeFailed(failedJob: ErrorPayload) {
return this.connection.redis.lrem(
this.connection.key("failed"),
1,
JSON.stringify(failedJob),
);
}
async retryAndRemoveFailed(failedJob: ErrorPayload) {
const countFailed = await this.removeFailed(failedJob);
if (countFailed < 1) {
throw new Error("This job is not in failed queue");
}
return this.enqueue(
failedJob.queue,
failedJob.payload.class,
failedJob.payload.args,
);
}
/**
* Look though the failed jobs to find those which were failed as a result of forceCleanWorker and re-enqueue them.
* This is potentially very slow if you have a lot of failed jobs
*/
async retryStuckJobs(upperLimit = Infinity) {
let start = 0;
let batchSize = 100;
let failedJobs: ParsedFailedJobPayload[] = [];
const loadFailedJobs = async () => {
failedJobs = await this.failed(start, start + batchSize);
start = start + batchSize;
};
await loadFailedJobs();
while (failedJobs.length > 0 && start < upperLimit) {
for (const i in failedJobs) {
const job = failedJobs[i];
if (job?.backtrace[1] === "queue#forceCleanWorker") {
await this.retryAndRemoveFailed(job);
}
}
await loadFailedJobs();
}
}
/**
* Return the currently elected leader
*/
async leader() {
return this.connection.redis.get(this.leaderKey());
}
/**
* - stats will be a hash containing details about all the queues in your redis, and how many jobs are in each, and who the leader is
*/
async stats() {
const data: { [key: string]: any } = {};
const keys = await this.connection.getKeys(this.connection.key("stat:*"));
if (keys.length === 0) {
return data;
}
const values = await this.connection.redis.mget(keys);
for (let i = 0; i < keys.length; i++) {
let k = keys[i];
k = k.replace(this.connection.key("stat:"), "");
data[k] = values[i];
}
return data;
}
/**
* The redis key which holds the currently elected leader
*/
leaderKey() {
return this.connection.key("resque_scheduler_leader_lock");
}
}