feat(queue-events): pass debounceId as a param of debounced event (#2678

)
taskforcesh · Aug 1, 2024 · 97fb97a · 97fb97a
1 parent 0a72b19
commit 97fb97a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/src/classes/queue-events.ts b/src/classes/queue-events.ts
@@ -48,9 +48,9 @@ export interface QueueEventsListener extends IoredisListener {
   /**
    * Listen to 'debounced' event.
    *
-   * This event is triggered when a job is debounced because debouncedId still existed.
+   * This event is triggered when a job is debounced because debounceId still existed.
    */
-  debounced: (args: { jobId: string }, id: string) => void;
+  debounced: (args: { jobId: string; debounceId: string }, id: string) => void;
 
   /**
    * Listen to 'delayed' event.

diff --git a/src/commands/includes/debounceJob.lua b/src/commands/includes/debounceJob.lua
@@ -15,7 +15,7 @@ local function debounceJob(prefixKey, debounceOpts, jobId, debounceKey, eventsKe
     if debounceKeyExists then
       local currentDebounceJobId = rcall('GET', debounceKey)
       rcall("XADD", eventsKey, "MAXLEN", "~", maxEvents, "*", "event",
-        "debounced", "jobId", currentDebounceJobId)
+        "debounced", "jobId", currentDebounceJobId, "debounceId", debounceId)
       return currentDebounceJobId
     end
   end

diff --git a/tests/test_events.ts b/tests/test_events.ts
@@ -411,11 +411,13 @@ describe('events', function () {
 
         let debouncedCounter = 0;
         let secondJob;
-        queueEvents.on('debounced', ({ jobId }) => {
+        queueEvents.on('debounced', ({ jobId, debounceId }) => {
           if (debouncedCounter > 1) {
             expect(jobId).to.be.equal(secondJob.id);
+            expect(debounceId).to.be.equal('a1');
           } else {
             expect(jobId).to.be.equal(job.id);
+            expect(debounceId).to.be.equal('a1');
           }
           debouncedCounter++;
         });