refactor(types): reduce internal any usage and tighten dispatcher typing

Author: RomainLanz

src/drivers/fake_adapter.ts

@@ -37,7 +37,7 @@ export interface FakeJobRecord {
 
 export type FakeJobMatcher = string | JobClass | ((job: JobData) => boolean)
 export type FakePayloadMatcher =
-  | ((payload: any) => boolean)
+  | ((payload: unknown) => boolean)
   | object
   | string
   | number

src/drivers/knex_adapter.ts

@@ -22,6 +22,24 @@ export interface KnexAdapterOptions {
 }
 
 type KnexConfig = Knex | Knex.Config
+type DbRow = Record<string, unknown>
+
+interface ScheduleRow extends DbRow {
+  id: string
+  name: string
+  payload: unknown
+  cron_expression: string | null
+  every_ms: number | string | null
+  timezone: string | null
+  from_date: Date | string | number | null
+  to_date: Date | string | number | null
+  run_limit: number | string | null
+  run_count: number | string | null
+  next_run_at: Date | string | number | null
+  last_run_at: Date | string | number | null
+  status: string
+  created_at: Date | string | number | null
+}
 
 /**
  * Create a new Knex adapter factory.
@@ -516,9 +534,9 @@ export class KnexAdapter implements Adapter {
   }
 
   async getSchedule(id: string): Promise<ScheduleData | null> {
-    const row = await this.#connection(this.#schedulesTable)
+    const row = (await this.#connection(this.#schedulesTable)
       .where('id', id)
-      .first()
+      .first()) as ScheduleRow | undefined
     if (!row) return null
 
     return this.#rowToScheduleData(row)
@@ -531,15 +549,15 @@ export class KnexAdapter implements Adapter {
       query = query.where('status', options.status)
     }
 
-    const rows = await query
-    return rows.map((row: any) => this.#rowToScheduleData(row))
+    const rows = (await query) as ScheduleRow[]
+    return rows.map((row) => this.#rowToScheduleData(row))
   }
 
   async updateSchedule(
     id: string,
     updates: Partial<Pick<ScheduleData, 'status' | 'nextRunAt' | 'lastRunAt' | 'runCount'>>
   ): Promise<void> {
-    const data: Record<string, any> = {}
+    const data: Record<string, unknown> = {}
 
     if (updates.status !== undefined) data.status = updates.status
     if (updates.nextRunAt !== undefined) data.next_run_at = updates.nextRunAt
@@ -581,12 +599,12 @@ export class KnexAdapter implements Adapter {
         query = query.forUpdate().skipLocked()
       }
 
-      const row = await query.first()
+      const row = (await query.first()) as ScheduleRow | undefined
       if (!row) return null
 
       // Calculate next run time
       let nextRunAt: Date | null = null
-      const newRunCount = (row.run_count ?? 0) + 1
+      const newRunCount = Number(row.run_count ?? 0) + 1
 
       if (row.every_ms) {
         nextRunAt = new Date(now.getTime() + Number(row.every_ms))
@@ -601,7 +619,7 @@ export class KnexAdapter implements Adapter {
       }
 
       // Check if limit will be reached
-      if (row.run_limit !== null && newRunCount >= row.run_limit) {
+      if (row.run_limit !== null && newRunCount >= Number(row.run_limit)) {
         nextRunAt = null
       }
 
@@ -624,7 +642,7 @@ export class KnexAdapter implements Adapter {
     })
   }
 
-  #rowToScheduleData(row: any): ScheduleData {
+  #rowToScheduleData(row: ScheduleRow): ScheduleData {
     return {
       id: row.id,
       name: row.name,
@@ -638,7 +656,7 @@ export class KnexAdapter implements Adapter {
       runCount: Number(row.run_count ?? 0),
       nextRunAt: row.next_run_at ? new Date(row.next_run_at) : null,
       lastRunAt: row.last_run_at ? new Date(row.last_run_at) : null,
-      status: row.status === 'cancelled' ? 'paused' : row.status,
+      status: row.status === 'paused' || row.status === 'cancelled' ? 'paused' : 'active',
       createdAt: row.created_at ? new Date(row.created_at) : new Date(),
     }
   }

src/drivers/sync_adapter.ts

@@ -142,7 +142,7 @@ export class SyncAdapter implements Adapter {
     return Promise.resolve(null)
   }
 
-  async #execute(jobName: string, payload: any, queue: string = 'default'): Promise<any> {
+  async #execute(jobName: string, payload: unknown, queue: string = 'default'): Promise<void> {
     const JobClass = Locator.get(jobName)
 
     if (!JobClass) {

src/job.ts

@@ -171,10 +171,11 @@ export abstract class Job<Payload = any> {
    * ```
    */
   static dispatch<T extends Job>(
-    this: new (...args: any[]) => T,
+    this: new (...args: unknown[]) => T,
     payload: T extends Job<infer P> ? P : never
   ): JobDispatcher<T extends Job<infer P> ? P : never> {
-    const options = (this as any).options || {}
+    const jobClass = this as unknown as { options?: JobOptions; name: string }
+    const options = jobClass.options || {}
     const jobName = options.name || this.name
 
     const dispatcher = new JobDispatcher<T extends Job<infer P> ? P : never>(jobName, payload)
@@ -222,10 +223,11 @@ export abstract class Job<Payload = any> {
    * ```
    */
   static dispatchMany<T extends Job>(
-    this: new (...args: any[]) => T,
+    this: new (...args: unknown[]) => T,
     payloads: (T extends Job<infer P> ? P : never)[]
   ): JobBatchDispatcher<T extends Job<infer P> ? P : never> {
-    const options = (this as any).options || {}
+    const jobClass = this as unknown as { options?: JobOptions; name: string }
+    const options = jobClass.options || {}
     const jobName = options.name || this.name
 
     const dispatcher = new JobBatchDispatcher<T extends Job<infer P> ? P : never>(jobName, payloads)
@@ -271,13 +273,14 @@ export abstract class Job<Payload = any> {
    * ```
    */
   static schedule<T extends Job>(
-    this: new (...args: any[]) => T,
+    this: new (...args: unknown[]) => T,
     payload: T extends Job<infer P> ? P : never
-  ): ScheduleBuilder {
-    const options = (this as any).options || {}
+  ): ScheduleBuilder<T extends Job<infer P> ? P : never> {
+    const jobClass = this as unknown as { options?: JobOptions; name: string }
+    const options = jobClass.options || {}
     const jobName = options.name || this.name
 
-    return new ScheduleBuilder(jobName, payload)
+    return new ScheduleBuilder<T extends Job<infer P> ? P : never>(jobName, payload)
   }
 
   /**

src/job_batch_dispatcher.ts

@@ -172,10 +172,10 @@ export class JobBatchDispatcher<T> {
    * @param onRejected - Error callback
    * @returns Promise resolving to the DispatchManyResult
    */
-  then(
-    onFulfilled?: (value: DispatchManyResult) => any,
-    onRejected?: (reason: any) => any
-  ): Promise<any> {
+  then<TResult1 = DispatchManyResult, TResult2 = never>(
+    onFulfilled?: ((value: DispatchManyResult) => TResult1 | PromiseLike<TResult1>) | null,
+    onRejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
+  ): Promise<TResult1 | TResult2> {
     return this.run().then(onFulfilled, onRejected)
   }
 

src/job_dispatcher.ts

@@ -216,10 +216,10 @@ export class JobDispatcher<T> {
    * @param onRejected - Error callback
    * @returns Promise resolving to the DispatchResult
    */
-  then(
-    onFulfilled?: (value: DispatchResult) => any,
-    onRejected?: (reason: any) => any
-  ): Promise<any> {
+  then<TResult1 = DispatchResult, TResult2 = never>(
+    onFulfilled?: ((value: DispatchResult) => TResult1 | PromiseLike<TResult1>) | null,
+    onRejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
+  ): Promise<TResult1 | TResult2> {
     return this.run().then(onFulfilled, onRejected)
   }
 

src/schedule.ts

@@ -36,7 +36,7 @@ export class Schedule {
     return this.#data.name
   }
 
-  get payload(): any {
+  get payload(): unknown {
     return this.#data.payload
   }
 

src/schedule_builder.ts

@@ -22,9 +22,9 @@ import * as errors from './exceptions.js'
  *   .run()
  * ```
  */
-export class ScheduleBuilder implements PromiseLike<ScheduleResult> {
+export class ScheduleBuilder<TPayload = unknown> implements PromiseLike<ScheduleResult> {
   #name: string
-  #payload: any
+  #payload: TPayload
   #id?: string
   #cronExpression?: string
   #everyMs?: number
@@ -33,7 +33,7 @@ export class ScheduleBuilder implements PromiseLike<ScheduleResult> {
   #to?: Date
   #limit?: number
 
-  constructor(name: string, payload: any) {
+  constructor(name: string, payload: TPayload) {
     this.#name = name
     this.#payload = payload
   }
@@ -202,7 +202,7 @@ export class ScheduleBuilder implements PromiseLike<ScheduleResult> {
    */
   then<TResult1 = ScheduleResult, TResult2 = never>(
     onfulfilled?: ((value: ScheduleResult) => TResult1 | PromiseLike<TResult1>) | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
+    onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
   ): Promise<TResult1 | TResult2> {
     return this.run().then(onfulfilled, onrejected)
   }

src/types/main.ts

@@ -257,7 +257,7 @@ export interface JobContext {
  * The constructor accepts any arguments for dependency injection.
  * Payload and context are provided separately via `$hydrate()`.
  */
-export type JobClass<T extends Job = Job> = (new (...args: any[]) => T) & {
+export type JobClass<T extends Job = Job> = (new (...args: unknown[]) => T) & {
   options?: JobOptions
 }
 
@@ -303,7 +303,7 @@ export interface BackoffConfig {
 
 export interface QueueConfig {
   adapter?: string
-  retry?: any
+  retry?: RetryConfig
   defaultJobOptions?: JobOptions
 }
 
@@ -364,8 +364,8 @@ export interface WorkerConfig {
 }
 
 export type WorkerCycle =
-  | { type: 'started'; queue: string; job: any }
-  | { type: 'completed'; queue: string; job: any }
+  | { type: 'started'; queue: string; job: JobData }
+  | { type: 'completed'; queue: string; job: JobData }
   | { type: 'idle'; suggestedDelay: Duration }
   | { type: 'error'; error: Error; suggestedDelay: Duration }
 

src/worker.ts

@@ -394,7 +394,7 @@ export class Worker {
     options: JobOptions
     timeout: number | undefined
     context: JobContext
-    payload: any
+    payload: unknown
   }> {
     try {
       const JobClass = Locator.getOrThrow(job.name)
@@ -437,7 +437,7 @@ export class Worker {
 
   async #executeWithTimeout(
     instance: Job,
-    payload: any,
+    payload: unknown,
     context: JobContext,
     timeout?: number
   ): Promise<void> {