refactor!: replace static jobName with options.name

Author: RomainLanz

README.md

@@ -39,15 +39,13 @@ Create a job by extending the `Job` class:
 
 ```typescript
 import { Job } from '@boringnode/queue'
-import type { JobContext, JobOptions } from '@boringnode/queue/types'
+import type { JobOptions } from '@boringnode/queue/types'
 
 interface SendEmailPayload {
   to: string
 }
 
 export default class SendEmailJob extends Job<SendEmailPayload> {
-  static readonly jobName = 'SendEmailJob'
-
   static options: JobOptions = {
     queue: 'email',
   }
@@ -58,6 +56,10 @@ export default class SendEmailJob extends Job<SendEmailPayload> {
 }
 ```
 
+> **Note**: The job name defaults to the class name (`SendEmailJob`). You can override it with `name: 'CustomName'` in options if needed.
+>
+> **Warning**: If you minify your code in production, class names may be mangled. In that case, always specify `name` explicitly in your job options.
+
 ### 2. Configure the Queue Manager
 
 ```typescript
@@ -250,8 +252,6 @@ Jobs with lower priority numbers are processed first:
 
 ```typescript
 export default class UrgentJob extends Job<Payload> {
-  static readonly jobName = 'UrgentJob'
-
   static options: JobOptions = {
     priority: 1, // Processed before default priority (5)
   }
@@ -270,8 +270,6 @@ Configure automatic retries with backoff strategies:
 import { exponentialBackoff, linearBackoff, fixedBackoff } from '@boringnode/queue'
 
 export default class ReliableJob extends Job<Payload> {
-  static readonly jobName = 'ReliableJob'
-
   static options: JobOptions = {
     maxRetries: 5,
     retry: {
@@ -303,8 +301,6 @@ Set a maximum execution time for jobs:
 
 ```typescript
 export default class LimitedJob extends Job<Payload> {
-  static readonly jobName = 'LimitedJob'
-
   static options: JobOptions = {
     timeout: '30s', // Maximum execution time
     failOnTimeout: false, // Retry on timeout (default)
@@ -332,8 +328,6 @@ Jobs have access to an abort signal via `this.signal` to handle timeouts gracefu
 
 ```typescript
 export default class LongRunningJob extends Job<Payload> {
-  static readonly jobName = 'LongRunningJob'
-
   static options: JobOptions = {
     timeout: '30s',
   }
@@ -418,8 +412,6 @@ interface SendEmailPayload {
 }
 
 export default class SendEmailJob extends Job<SendEmailPayload> {
-  static readonly jobName = 'SendEmailJob'
-
   constructor(
     private mailer: MailerService, // Injected by IoC container
     private logger: Logger // Injected by IoC container
@@ -540,10 +532,11 @@ const config = {
 Jobs must:
 
 - Extend the `Job` class
-- Have a static `jobName` property
 - Implement the `execute` method
 - Be exported as default
 
+The job name is automatically derived from the class name, or can be explicitly set via `static options = { name: 'CustomName' }`.
+
 ## Logging
 
 You can pass a logger to the queue manager for debugging or monitoring. The logger must be compatible with the [pino](https://github.com/pinojs/pino) interface.

examples/jobs/metrics_job.ts

@@ -17,8 +17,6 @@ interface MetricsJobPayload {
  * ```
  */
 export default class MetricsJob extends Job<MetricsJobPayload> {
-  static readonly jobName = 'MetricsJob'
-
   static options: JobOptions = {
     queue: 'metrics',
   }

examples/jobs/send_email_job.ts

@@ -6,8 +6,6 @@ interface SendEmailPayload {
 }
 
 export default class SendEmailJob extends Job<SendEmailPayload> {
-  static readonly jobName = 'SendEmailJob'
-
   static options: JobOptions = {
     queue: 'email',
   }

examples/jobs/sync_job.ts

@@ -7,8 +7,6 @@ interface SyncJobPayload {
 }
 
 export default class SyncJob extends Job<SyncJobPayload> {
-  static readonly jobName = 'SyncJob'
-
   static options: JobOptions = {
     adapter: 'sync',
   }

src/job.ts

@@ -173,21 +173,21 @@ export abstract class Job<Payload = any> {
     this: new (...args: any[]) => T,
     payload: T extends Job<infer P> ? P : never
   ): JobDispatcher<T extends Job<infer P> ? P : never> {
-    const dispatcher = new JobDispatcher<T extends Job<infer P> ? P : never>(
-      (this as any).jobName,
-      payload
-    )
+    const options = (this as any).options || {}
+    const jobName = options.name || this.name
 
-    if ((this as any).options.queue) {
-      dispatcher.toQueue((this as any).options.queue)
+    const dispatcher = new JobDispatcher<T extends Job<infer P> ? P : never>(jobName, payload)
+
+    if (options.queue) {
+      dispatcher.toQueue(options.queue)
     }
 
-    if ((this as any).options.adapter) {
-      dispatcher.with((this as any).options.adapter)
+    if (options.adapter) {
+      dispatcher.with(options.adapter)
     }
 
-    if ((this as any).options.priority !== undefined) {
-      dispatcher.priority((this as any).options.priority)
+    if (options.priority !== undefined) {
+      dispatcher.priority(options.priority)
     }
 
     return dispatcher
@@ -222,7 +222,10 @@ export abstract class Job<Payload = any> {
     this: new (...args: any[]) => T,
     payload: T extends Job<infer P> ? P : never
   ): ScheduleBuilder {
-    return new ScheduleBuilder((this as any).jobName, payload)
+    const options = (this as any).options || {}
+    const jobName = options.name || this.name
+
+    return new ScheduleBuilder(jobName, payload)
   }
 
   /**

src/locator.ts

@@ -80,8 +80,9 @@ class LocatorSingleton {
           const module = await import(`file://${absolutePath}`)
           const JobClass = module.default as JobClass
 
-          if (JobClass && typeof JobClass === 'function' && JobClass.name) {
-            this.register(JobClass.name, JobClass)
+          if (JobClass && typeof JobClass === 'function') {
+            const jobName = JobClass.options?.name || JobClass.name
+            this.register(jobName, JobClass)
             registered++
           }
         } catch (error) {

src/types/main.ts

@@ -88,6 +88,7 @@ export interface JobData {
  * ```typescript
  * class SendEmailJob extends Job<EmailPayload> {
  *   static options: JobOptions = {
+ *     name: 'SendEmailJob',
  *     queue: 'emails',
  *     maxRetries: 3,
  *     timeout: '30s',
@@ -96,6 +97,15 @@ export interface JobData {
  * ```
  */
 export interface JobOptions {
+  /**
+   * Unique name for this job class.
+   *
+   * Used to identify the job when dispatching and processing.
+   *
+   * @default constructor.name
+   */
+  name?: string
+
   /**
    * Queue name for this job.
    *

tests/_utils/register_worker_concurrency_suite.ts

@@ -21,8 +21,6 @@ export function registerWorkerConcurrencyTestSuite(options: WorkerConcurrencyTes
     const jobExecutions: Map<string, number> = new Map()
 
     class TrackingJob extends Job<{ jobId: string }> {
-      static jobName = 'TrackingJob'
-
       async execute() {
         const count = jobExecutions.get(this.payload.jobId) || 0
         jobExecutions.set(this.payload.jobId, count + 1)
@@ -31,7 +29,7 @@ export function registerWorkerConcurrencyTestSuite(options: WorkerConcurrencyTes
     }
 
     const adapter = await options.createAdapter()
-    Locator.register('TrackingJob', TrackingJob)
+    Locator.register(TrackingJob.name, TrackingJob)
 
     cleanup(() => Locator.clear())
 
@@ -78,8 +76,6 @@ export function registerWorkerConcurrencyTestSuite(options: WorkerConcurrencyTes
     const jobExecutions: Map<string, number> = new Map()
 
     class TrackingJob extends Job<{ jobId: string }> {
-      static jobName = 'TrackingJob'
-
       async execute() {
         const count = jobExecutions.get(this.payload.jobId) || 0
         jobExecutions.set(this.payload.jobId, count + 1)
@@ -88,7 +84,7 @@ export function registerWorkerConcurrencyTestSuite(options: WorkerConcurrencyTes
     }
 
     const adapter = await options.createAdapter()
-    Locator.register('TrackingJob', TrackingJob)
+    Locator.register(TrackingJob.name, TrackingJob)
 
     cleanup(() => Locator.clear())
 
@@ -137,8 +133,6 @@ export function registerWorkerConcurrencyTestSuite(options: WorkerConcurrencyTes
     const executionOrder: string[] = []
 
     class TrackingJob extends Job<{ jobId: string }> {
-      static jobName = 'TrackingJob'
-
       async execute() {
         executionOrder.push(this.payload.jobId)
         const count = jobExecutions.get(this.payload.jobId) || 0
@@ -149,7 +143,7 @@ export function registerWorkerConcurrencyTestSuite(options: WorkerConcurrencyTes
     }
 
     const adapter = await options.createAdapter()
-    Locator.register('TrackingJob', TrackingJob)
+    Locator.register(TrackingJob.name, TrackingJob)
 
     cleanup(() => Locator.clear())
 

tests/locator.spec.ts

@@ -5,8 +5,6 @@ import * as errors from '../src/exceptions.js'
 import SendEmailJob from '../examples/jobs/send_email_job.js'
 
 class TestJob extends Job<{ message: string }> {
-  static jobName = 'TestJob'
-
   execute(): Promise<void> {
     return Promise.resolve()
   }
@@ -17,8 +15,6 @@ class TestJob extends Job<{ message: string }> {
 }
 
 class AnotherTestJob extends Job<{ value: number }> {
-  static jobName = 'AnotherTestJob'
-
   execute(): Promise<void> {
     return Promise.resolve()
   }
@@ -28,6 +24,16 @@ class AnotherTestJob extends Job<{ value: number }> {
   }
 }
 
+class JobWithCustomName extends Job<{ data: string }> {
+  static options = {
+    name: 'CustomNamedJob',
+  }
+
+  execute(): Promise<void> {
+    return Promise.resolve()
+  }
+}
+
 test.group('Locator', (group) => {
   group.each.setup(() => {
     Locator.clear()
@@ -97,4 +103,20 @@ test.group('Locator', (group) => {
       assert.equal(error.message, 'Requested job "NonExistentJob" is not registered')
     }
   })
+
+  test('should use constructor.name as default job name when registering from glob', async ({
+    assert,
+  }) => {
+    await Locator.registerFromGlob(['./examples/jobs/*.ts'])
+
+    // SendEmailJob has no options.name, so it should use the class name
+    assert.equal(Locator.get('SendEmailJob'), SendEmailJob)
+  })
+
+  test('should use options.name when provided', async ({ assert }) => {
+    Locator.register(JobWithCustomName.options.name!, JobWithCustomName)
+
+    assert.equal(Locator.get('CustomNamedJob'), JobWithCustomName)
+    assert.isUndefined(Locator.get('JobWithCustomName'))
+  })
 })

tests/schedule.spec.ts

@@ -386,15 +386,14 @@ test.group('Schedule', (group) => {
 
 test.group('Job.schedule()', (group) => {
   class TestScheduleJob extends Job<{ value: string }> {
-    static readonly jobName = 'TestScheduleJob'
     async execute() {}
   }
 
   group.each.setup(async () => {
     const sharedAdapter = memory()()
 
     // Register the job
-    Locator.register('TestScheduleJob', TestScheduleJob)
+    Locator.register(TestScheduleJob.name, TestScheduleJob)
 
     await QueueManager.init({
       default: 'memory',