@nicnocquee/dataqueue 1.25.0 → 1.26.0-beta.20260223202259

package/src/index.ts

@@ -1,30 +1,37 @@
-import {
-  createWaitpoint,
-  completeWaitpoint,
-  getWaitpoint,
-  expireTimedOutWaitpoints,
-} from './queue.js';
+import { EventEmitter } from 'node:events';
 import { createProcessor } from './processor.js';
+import { createSupervisor } from './supervisor.js';
 import {
   JobQueueConfig,
   JobQueue,
   JobOptions,
+  AddJobOptions,
   ProcessorOptions,
+  SupervisorOptions,
   JobHandlers,
   JobType,
   PostgresJobQueueConfig,
   RedisJobQueueConfig,
+  CronScheduleOptions,
+  CronScheduleStatus,
+  EditCronScheduleOptions,
+  QueueEventMap,
+  QueueEventName,
+  QueueEmitFn,
 } from './types.js';
-import { QueueBackend } from './backend.js';
+import { QueueBackend, CronScheduleInput } from './backend.js';
 import { setLogContext } from './log-context.js';
 import { createPool } from './db-util.js';
 import { PostgresBackend } from './backends/postgres.js';
 import { RedisBackend } from './backends/redis.js';
+import { getNextCronOccurrence, validateCronExpression } from './cron.js';
 
 /**
  * Initialize the job queue system.
  *
  * Defaults to PostgreSQL when `backend` is omitted.
+ * For PostgreSQL, provide either `databaseConfig` or `pool` (bring your own).
+ * For Redis, provide either `redisConfig` or `client` (bring your own).
  */
 export const initJobQueue = <PayloadMap = any>(
   config: JobQueueConfig,
@@ -33,35 +40,124 @@ export const initJobQueue = <PayloadMap = any>(
   setLogContext(config.verbose ?? false);
 
   let backend: QueueBackend;
-  let pool: import('pg').Pool | undefined;
 
   if (backendType === 'postgres') {
     const pgConfig = config as PostgresJobQueueConfig;
-    pool = createPool(pgConfig.databaseConfig);
-    backend = new PostgresBackend(pool);
+    if (pgConfig.pool) {
+      backend = new PostgresBackend(pgConfig.pool);
+    } else if (pgConfig.databaseConfig) {
+      const pool = createPool(pgConfig.databaseConfig);
+      backend = new PostgresBackend(pool);
+    } else {
+      throw new Error(
+        'PostgreSQL backend requires either "databaseConfig" or "pool" to be provided.',
+      );
+    }
   } else if (backendType === 'redis') {
-    const redisConfig = (config as RedisJobQueueConfig).redisConfig;
-    // RedisBackend constructor will throw if ioredis is not installed
-    backend = new RedisBackend(redisConfig);
+    const redisConfig = config as RedisJobQueueConfig;
+    if (redisConfig.client) {
+      backend = new RedisBackend(
+        redisConfig.client as any,
+        redisConfig.keyPrefix,
+      );
+    } else if (redisConfig.redisConfig) {
+      backend = new RedisBackend(redisConfig.redisConfig);
+    } else {
+      throw new Error(
+        'Redis backend requires either "redisConfig" or "client" to be provided.',
+      );
+    }
   } else {
     throw new Error(`Unknown backend: ${backendType}`);
   }
 
-  const requirePool = () => {
-    if (!pool) {
-      throw new Error(
-        'Wait/Token features require the PostgreSQL backend. Configure with backend: "postgres" to use these features.',
+  const emitter = new EventEmitter();
+  const emit: QueueEmitFn = (event, data) => {
+    emitter.emit(event, data);
+  };
+
+  /**
+   * Enqueue due cron jobs. Shared by the public API and the processor hook.
+   */
+  const enqueueDueCronJobsImpl = async (): Promise<number> => {
+    const dueSchedules = await backend.getDueCronSchedules();
+    let count = 0;
+
+    for (const schedule of dueSchedules) {
+      // Overlap check: skip if allowOverlap is false and last job is still active
+      if (!schedule.allowOverlap && schedule.lastJobId !== null) {
+        const lastJob = await backend.getJob(schedule.lastJobId);
+        if (
+          lastJob &&
+          (lastJob.status === 'pending' ||
+            lastJob.status === 'processing' ||
+            lastJob.status === 'waiting')
+        ) {
+          // Still active — advance nextRunAt but don't enqueue
+          const nextRunAt = getNextCronOccurrence(
+            schedule.cronExpression,
+            schedule.timezone,
+          );
+          await backend.updateCronScheduleAfterEnqueue(
+            schedule.id,
+            new Date(),
+            schedule.lastJobId,
+            nextRunAt,
+          );
+          continue;
+        }
+      }
+
+      // Enqueue a new job instance
+      const jobId = await backend.addJob<any, any>({
+        jobType: schedule.jobType,
+        payload: schedule.payload,
+        maxAttempts: schedule.maxAttempts,
+        priority: schedule.priority,
+        timeoutMs: schedule.timeoutMs ?? undefined,
+        forceKillOnTimeout: schedule.forceKillOnTimeout,
+        tags: schedule.tags,
+        retryDelay: schedule.retryDelay ?? undefined,
+        retryBackoff: schedule.retryBackoff ?? undefined,
+        retryDelayMax: schedule.retryDelayMax ?? undefined,
+      });
+
+      // Advance to next occurrence
+      const nextRunAt = getNextCronOccurrence(
+        schedule.cronExpression,
+        schedule.timezone,
       );
+      await backend.updateCronScheduleAfterEnqueue(
+        schedule.id,
+        new Date(),
+        jobId,
+        nextRunAt,
+      );
+      count++;
     }
-    return pool;
+
+    return count;
   };
 
   // Return the job queue API
   return {
     // Job queue operations
     addJob: withLogContext(
-      (job: JobOptions<PayloadMap, any>) =>
-        backend.addJob<PayloadMap, any>(job),
+      async (job: JobOptions<PayloadMap, any>, options?: AddJobOptions) => {
+        const jobId = await backend.addJob<PayloadMap, any>(job, options);
+        emit('job:added', { jobId, jobType: job.jobType });
+        return jobId;
+      },
+      config.verbose ?? false,
+    ),
+    addJobs: withLogContext(
+      async (jobs: JobOptions<PayloadMap, any>[], options?: AddJobOptions) => {
+        const jobIds = await backend.addJobs<PayloadMap, any>(jobs, options);
+        for (let i = 0; i < jobIds.length; i++) {
+          emit('job:added', { jobId: jobIds[i], jobType: jobs[i].jobType });
+        }
+        return jobIds;
+      },
       config.verbose ?? false,
     ),
     getJob: withLogContext(
@@ -93,14 +189,18 @@ export const initJobQueue = <PayloadMap = any>(
       ) => backend.getJobs<PayloadMap, any>(filters, limit, offset),
       config.verbose ?? false,
     ),
-    retryJob: (jobId: number) => backend.retryJob(jobId),
-    cleanupOldJobs: (daysToKeep?: number) => backend.cleanupOldJobs(daysToKeep),
-    cleanupOldJobEvents: (daysToKeep?: number) =>
-      backend.cleanupOldJobEvents(daysToKeep),
-    cancelJob: withLogContext(
-      (jobId: number) => backend.cancelJob(jobId),
-      config.verbose ?? false,
-    ),
+    retryJob: async (jobId: number) => {
+      await backend.retryJob(jobId);
+      emit('job:retried', { jobId });
+    },
+    cleanupOldJobs: (daysToKeep?: number, batchSize?: number) =>
+      backend.cleanupOldJobs(daysToKeep, batchSize),
+    cleanupOldJobEvents: (daysToKeep?: number, batchSize?: number) =>
+      backend.cleanupOldJobEvents(daysToKeep, batchSize),
+    cancelJob: withLogContext(async (jobId: number) => {
+      await backend.cancelJob(jobId);
+      emit('job:cancelled', { jobId });
+    }, config.verbose ?? false),
     editJob: withLogContext(
       <T extends JobType<PayloadMap>>(
         jobId: number,
@@ -153,11 +253,24 @@ export const initJobQueue = <PayloadMap = any>(
       config.verbose ?? false,
     ),
 
-    // Job processing
+    // Job processing — automatically enqueues due cron jobs before each batch
     createProcessor: (
       handlers: JobHandlers<PayloadMap>,
       options?: ProcessorOptions,
-    ) => createProcessor<PayloadMap>(backend, handlers, options),
+    ) =>
+      createProcessor<PayloadMap>(
+        backend,
+        handlers,
+        options,
+        async () => {
+          await enqueueDueCronJobsImpl();
+        },
+        emit,
+      ),
+
+    // Background supervisor — automated maintenance
+    createSupervisor: (options?: SupervisorOptions) =>
+      createSupervisor(backend, options, emit),
 
     // Job events
     getJobEvents: withLogContext(
@@ -165,34 +278,148 @@ export const initJobQueue = <PayloadMap = any>(
       config.verbose ?? false,
     ),
 
-    // Wait / Token support (PostgreSQL-only for now)
+    // Wait / Token support (works with all backends)
     createToken: withLogContext(
       (options?: import('./types.js').CreateTokenOptions) =>
-        createWaitpoint(requirePool(), null, options),
+        backend.createWaitpoint(null, options),
       config.verbose ?? false,
     ),
     completeToken: withLogContext(
-      (tokenId: string, data?: any) =>
-        completeWaitpoint(requirePool(), tokenId, data),
+      (tokenId: string, data?: any) => backend.completeWaitpoint(tokenId, data),
       config.verbose ?? false,
     ),
     getToken: withLogContext(
-      (tokenId: string) => getWaitpoint(requirePool(), tokenId),
+      (tokenId: string) => backend.getWaitpoint(tokenId),
       config.verbose ?? false,
     ),
     expireTimedOutTokens: withLogContext(
-      () => expireTimedOutWaitpoints(requirePool()),
+      () => backend.expireTimedOutWaitpoints(),
       config.verbose ?? false,
     ),
 
+    // Cron schedule operations
+    addCronJob: withLogContext(
+      <T extends JobType<PayloadMap>>(
+        options: CronScheduleOptions<PayloadMap, T>,
+      ) => {
+        if (!validateCronExpression(options.cronExpression)) {
+          return Promise.reject(
+            new Error(`Invalid cron expression: "${options.cronExpression}"`),
+          );
+        }
+        const nextRunAt = getNextCronOccurrence(
+          options.cronExpression,
+          options.timezone ?? 'UTC',
+        );
+        const input: CronScheduleInput = {
+          scheduleName: options.scheduleName,
+          cronExpression: options.cronExpression,
+          jobType: options.jobType as string,
+          payload: options.payload,
+          maxAttempts: options.maxAttempts ?? 3,
+          priority: options.priority ?? 0,
+          timeoutMs: options.timeoutMs ?? null,
+          forceKillOnTimeout: options.forceKillOnTimeout ?? false,
+          tags: options.tags,
+          timezone: options.timezone ?? 'UTC',
+          allowOverlap: options.allowOverlap ?? false,
+          nextRunAt,
+          retryDelay: options.retryDelay ?? null,
+          retryBackoff: options.retryBackoff ?? null,
+          retryDelayMax: options.retryDelayMax ?? null,
+        };
+        return backend.addCronSchedule(input);
+      },
+      config.verbose ?? false,
+    ),
+    getCronJob: withLogContext(
+      (id: number) => backend.getCronSchedule(id),
+      config.verbose ?? false,
+    ),
+    getCronJobByName: withLogContext(
+      (name: string) => backend.getCronScheduleByName(name),
+      config.verbose ?? false,
+    ),
+    listCronJobs: withLogContext(
+      (status?: CronScheduleStatus) => backend.listCronSchedules(status),
+      config.verbose ?? false,
+    ),
+    removeCronJob: withLogContext(
+      (id: number) => backend.removeCronSchedule(id),
+      config.verbose ?? false,
+    ),
+    pauseCronJob: withLogContext(
+      (id: number) => backend.pauseCronSchedule(id),
+      config.verbose ?? false,
+    ),
+    resumeCronJob: withLogContext(
+      (id: number) => backend.resumeCronSchedule(id),
+      config.verbose ?? false,
+    ),
+    editCronJob: withLogContext(
+      async (id: number, updates: EditCronScheduleOptions) => {
+        if (
+          updates.cronExpression !== undefined &&
+          !validateCronExpression(updates.cronExpression)
+        ) {
+          throw new Error(
+            `Invalid cron expression: "${updates.cronExpression}"`,
+          );
+        }
+        let nextRunAt: Date | null | undefined;
+        if (
+          updates.cronExpression !== undefined ||
+          updates.timezone !== undefined
+        ) {
+          const existing = await backend.getCronSchedule(id);
+          const expr = updates.cronExpression ?? existing?.cronExpression ?? '';
+          const tz = updates.timezone ?? existing?.timezone ?? 'UTC';
+          nextRunAt = getNextCronOccurrence(expr, tz);
+        }
+        await backend.editCronSchedule(id, updates, nextRunAt);
+      },
+      config.verbose ?? false,
+    ),
+    enqueueDueCronJobs: withLogContext(
+      () => enqueueDueCronJobsImpl(),
+      config.verbose ?? false,
+    ),
+
+    // Event hooks
+    on: <K extends QueueEventName>(
+      event: K,
+      listener: (data: QueueEventMap[K]) => void,
+    ) => {
+      emitter.on(event, listener as (...args: any[]) => void);
+    },
+    once: <K extends QueueEventName>(
+      event: K,
+      listener: (data: QueueEventMap[K]) => void,
+    ) => {
+      emitter.once(event, listener as (...args: any[]) => void);
+    },
+    off: <K extends QueueEventName>(
+      event: K,
+      listener: (data: QueueEventMap[K]) => void,
+    ) => {
+      emitter.off(event, listener as (...args: any[]) => void);
+    },
+    removeAllListeners: (event?: QueueEventName) => {
+      if (event) {
+        emitter.removeAllListeners(event);
+      } else {
+        emitter.removeAllListeners();
+      }
+    },
+
     // Advanced access
     getPool: () => {
-      if (backendType !== 'postgres') {
+      if (!(backend instanceof PostgresBackend)) {
         throw new Error(
           'getPool() is only available with the PostgreSQL backend.',
         );
       }
-      return (backend as PostgresBackend).getPool();
+      return backend.getPool();
     },
     getRedisClient: () => {
       if (backendType !== 'redis') {
@@ -213,9 +440,10 @@ const withLogContext =
   };
 
 export * from './types.js';
-export { QueueBackend } from './backend.js';
+export { QueueBackend, CronScheduleInput } from './backend.js';
 export { PostgresBackend } from './backends/postgres.js';
 export {
   validateHandlerSerializable,
   testHandlerSerialization,
 } from './handler-validation.js';
+export { getNextCronOccurrence, validateCronExpression } from './cron.js';