feat(worker): passing token in processor function

taskforcesh · Apr 21, 2021 · 2249724 · 2249724
1 parent 0faf083
commit 2249724
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 2 deletions.
diff --git a/src/classes/worker.ts b/src/classes/worker.ts
@@ -331,7 +331,7 @@ export class Worker<
 
     lockExtender();
     try {
-      const result = await this.processFn(job);
+      const result = await this.processFn(job, token);
       return await handleCompleted(result);
     } catch (err) {
       return handleFailed(err);

diff --git a/src/commands/getState-7.lua b/src/commands/getState-7.lua
@@ -17,6 +17,7 @@
     'delayed'
     'active'
     'waiting'
+    'waiting-children'
     'unknown'
 ]]
 if redis.call("ZSCORE", KEYS[1], ARGV[1]) ~= false then

diff --git a/src/commands/getStateV2-7.lua b/src/commands/getStateV2-7.lua
@@ -17,6 +17,7 @@
     'delayed'
     'active'
     'waiting'
+    'waiting-children'
     'unknown'
 ]]
 if redis.call("ZSCORE", KEYS[1], ARGV[1]) ~= false then

diff --git a/src/interfaces/worker-options.ts b/src/interfaces/worker-options.ts
@@ -6,6 +6,7 @@ import { AdvancedOptions, QueueBaseOptions, RateLimiterOptions } from './';
  */
 export type Processor<T = any, R = any, N extends string = string> = (
   job: Job<T, R, N>,
+  token: string,
 ) => Promise<R>;
 
 export interface WorkerOptions extends QueueBaseOptions {

diff --git a/src/test/test_worker.ts b/src/test/test_worker.ts
@@ -40,7 +40,8 @@ describe('workers', function() {
 
   describe('auto job removal', () => {
     it('should remove job after completed if removeOnComplete', async () => {
-      const worker = new Worker(queueName, async job => {
+      const worker = new Worker(queueName, async (job, token) => {
+        expect(token).to.be.string;
         expect(job.data.foo).to.be.equal('bar');
       });
       await worker.waitUntilReady();