feat(adapters): accept job class matchers for assertion

Author: RomainLanz

.changelog/queue-fake.md

@@ -21,7 +21,7 @@ const fake = QueueManager.fake()
 
 await SendEmailJob.dispatch({ to: 'user@example.com' })
 
-fake.assertPushed('SendEmailJob', {
+fake.assertPushed(SendEmailJob, {
   queue: 'default',
   payload: { to: 'user@example.com' },
 })

README.md

@@ -233,8 +233,8 @@ const adapter = QueueManager.fake()
 
 await SendEmailJob.dispatch({ to: 'user@example.com' })
 
-adapter.assertPushed('SendEmailJob')
-adapter.assertPushed('SendEmailJob', {
+adapter.assertPushed(SendEmailJob)
+adapter.assertPushed(SendEmailJob, {
   queue: 'default',
   payload: (payload) => payload.to === 'user@example.com',
 })

src/drivers/fake_adapter.ts

@@ -5,6 +5,7 @@ import { CronExpressionParser } from 'cron-parser'
 import type { Adapter, AcquiredJob } from '../contracts/adapter.js'
 import type {
   JobData,
+  JobClass,
   JobRecord,
   JobRetention,
   ScheduleConfig,
@@ -13,6 +14,7 @@ import type {
 } from '../types/main.js'
 import { DEFAULT_PRIORITY } from '../constants.js'
 import { parse } from '../utils.js'
+import { Job } from '../job.js'
 
 interface ActiveJob {
   job: JobData
@@ -33,7 +35,7 @@ export interface FakeJobRecord {
   pushedAt: number
 }
 
-export type FakeJobMatcher = string | ((job: JobData) => boolean)
+export type FakeJobMatcher = string | JobClass | ((job: JobData) => boolean)
 export type FakePayloadMatcher =
   | ((payload: any) => boolean)
   | object
@@ -539,7 +541,11 @@ export class FakeAdapter implements Adapter {
     }
 
     const matchesJob =
-      typeof matcher === 'string' ? record.job.name === matcher : matcher(record.job)
+      typeof matcher === 'string'
+        ? record.job.name === matcher
+        : this.#isJobClass(matcher)
+          ? record.job.name === this.#getJobClassName(matcher)
+          : matcher(record.job)
 
     if (!matchesJob) {
       return false
@@ -575,8 +581,9 @@ export class FakeAdapter implements Adapter {
   #formatFailure(prefix: string, matcher: FakeJobMatcher, query?: FakeJobQuery): string {
     const parts = [prefix]
 
-    if (typeof matcher === 'string') {
-      parts.push(`for "${matcher}"`)
+    const matcherName = this.#getMatcherName(matcher)
+    if (matcherName) {
+      parts.push(`for "${matcherName}"`)
     }
 
     if (query?.queue) {
@@ -597,4 +604,24 @@ export class FakeAdapter implements Adapter {
 
     return `${parts.join(' ')}. ${suffix}.`
   }
+
+  #getMatcherName(matcher: FakeJobMatcher): string | undefined {
+    if (typeof matcher === 'string') {
+      return matcher
+    }
+
+    if (this.#isJobClass(matcher)) {
+      return this.#getJobClassName(matcher)
+    }
+
+    return undefined
+  }
+
+  #isJobClass(matcher: FakeJobMatcher): matcher is JobClass {
+    return typeof matcher === 'function' && matcher.prototype instanceof Job
+  }
+
+  #getJobClassName(JobClass: JobClass): string {
+    return JobClass.options?.name || JobClass.name
+  }
 }

src/queue_manager.ts

@@ -197,7 +197,7 @@ class QueueManagerSingleton {
    *
    * await SendEmailJob.dispatch({ to: 'user@example.com' })
    *
-   * fake.assertPushed('SendEmailJob')
+   * fake.assertPushed(SendEmailJob)
    * QueueManager.restore()
    * ```
    */

tests/fake_adapter.spec.ts

@@ -1,5 +1,6 @@
 import { setTimeout } from 'node:timers/promises'
 import { test } from '@japa/runner'
+import { Job } from '../src/job.js'
 import { fake } from '../src/drivers/fake_adapter.js'
 
 test.group('FakeAdapter', () => {
@@ -87,6 +88,44 @@ test.group('FakeAdapter', () => {
     await adapter.destroy()
   })
 
+  test('should support job class matchers', async ({ assert }) => {
+    const adapter = fake()()
+
+    class SendEmailJob extends Job<{ to: string }> {
+      async execute() {}
+    }
+
+    class CustomNamedJob extends Job {
+      static options = { name: 'CustomJob' }
+      async execute() {}
+    }
+
+    await adapter.pushOn('default', {
+      id: 'job-1',
+      name: 'SendEmailJob',
+      payload: { to: 'user@example.com' },
+      attempts: 0,
+    })
+
+    await adapter.pushOn('default', {
+      id: 'job-2',
+      name: 'CustomJob',
+      payload: null,
+      attempts: 0,
+    })
+
+    adapter.assertPushed(SendEmailJob)
+    adapter.assertPushed(CustomNamedJob)
+
+    class MissingJob extends Job {
+      async execute() {}
+    }
+
+    assert.throws(() => adapter.assertPushed(MissingJob))
+
+    await adapter.destroy()
+  })
+
   test('should recover stalled jobs only for targeted queue', async ({ assert }) => {
     const adapter = fake()()