@nicnocquee/dataqueue 1.20.0 → 1.22.0

package/src/queue.ts

@@ -421,7 +421,7 @@ export const cancelAllUpcomingJobs = async (
   filters?: {
     jobType?: string;
     priority?: number;
-    runAt?: Date;
+    runAt?: Date | { gt?: Date; gte?: Date; lt?: Date; lte?: Date; eq?: Date };
     tags?: { values: string[]; mode?: TagQueryMode };
   },
 ): Promise<number> => {
@@ -443,8 +443,32 @@ export const cancelAllUpcomingJobs = async (
         params.push(filters.priority);
       }
       if (filters.runAt) {
-        query += ` AND run_at = $${paramIdx++}`;
-        params.push(filters.runAt);
+        if (filters.runAt instanceof Date) {
+          query += ` AND run_at = $${paramIdx++}`;
+          params.push(filters.runAt);
+        } else if (typeof filters.runAt === 'object') {
+          const ops = filters.runAt;
+          if (ops.gt) {
+            query += ` AND run_at > $${paramIdx++}`;
+            params.push(ops.gt);
+          }
+          if (ops.gte) {
+            query += ` AND run_at >= $${paramIdx++}`;
+            params.push(ops.gte);
+          }
+          if (ops.lt) {
+            query += ` AND run_at < $${paramIdx++}`;
+            params.push(ops.lt);
+          }
+          if (ops.lte) {
+            query += ` AND run_at <= $${paramIdx++}`;
+            params.push(ops.lte);
+          }
+          if (ops.eq) {
+            query += ` AND run_at = $${paramIdx++}`;
+            params.push(ops.eq);
+          }
+        }
       }
       if (
         filters.tags &&
@@ -661,3 +685,123 @@ export const getJobsByTags = async <
     client.release();
   }
 };
+
+export const getJobs = async <PayloadMap, T extends keyof PayloadMap & string>(
+  pool: Pool,
+  filters?: {
+    jobType?: string;
+    priority?: number;
+    runAt?: Date | { gt?: Date; gte?: Date; lt?: Date; lte?: Date; eq?: Date };
+    tags?: { values: string[]; mode?: TagQueryMode };
+  },
+  limit = 100,
+  offset = 0,
+): Promise<JobRecord<PayloadMap, T>[]> => {
+  const client = await pool.connect();
+  try {
+    let query = `SELECT id, job_type AS "jobType", payload, status, max_attempts AS "maxAttempts", attempts, priority, run_at AS "runAt", timeout_ms AS "timeoutMs", created_at AS "createdAt", updated_at AS "updatedAt", started_at AS "startedAt", completed_at AS "completedAt", last_failed_at AS "lastFailedAt", locked_at AS "lockedAt", locked_by AS "lockedBy", error_history AS "errorHistory", failure_reason AS "failureReason", next_attempt_at AS "nextAttemptAt", last_failed_at AS "lastFailedAt", last_retried_at AS "lastRetriedAt", last_cancelled_at AS "lastCancelledAt", pending_reason AS "pendingReason", tags FROM job_queue`;
+    const params: any[] = [];
+    let where: string[] = [];
+    let paramIdx = 1;
+    if (filters) {
+      if (filters.jobType) {
+        where.push(`job_type = $${paramIdx++}`);
+        params.push(filters.jobType);
+      }
+      if (filters.priority !== undefined) {
+        where.push(`priority = $${paramIdx++}`);
+        params.push(filters.priority);
+      }
+      if (filters.runAt) {
+        if (filters.runAt instanceof Date) {
+          where.push(`run_at = $${paramIdx++}`);
+          params.push(filters.runAt);
+        } else if (
+          typeof filters.runAt === 'object' &&
+          (filters.runAt.gt !== undefined ||
+            filters.runAt.gte !== undefined ||
+            filters.runAt.lt !== undefined ||
+            filters.runAt.lte !== undefined ||
+            filters.runAt.eq !== undefined)
+        ) {
+          const ops = filters.runAt as {
+            gt?: Date;
+            gte?: Date;
+            lt?: Date;
+            lte?: Date;
+            eq?: Date;
+          };
+          if (ops.gt) {
+            where.push(`run_at > $${paramIdx++}`);
+            params.push(ops.gt);
+          }
+          if (ops.gte) {
+            where.push(`run_at >= $${paramIdx++}`);
+            params.push(ops.gte);
+          }
+          if (ops.lt) {
+            where.push(`run_at < $${paramIdx++}`);
+            params.push(ops.lt);
+          }
+          if (ops.lte) {
+            where.push(`run_at <= $${paramIdx++}`);
+            params.push(ops.lte);
+          }
+          if (ops.eq) {
+            where.push(`run_at = $${paramIdx++}`);
+            params.push(ops.eq);
+          }
+        }
+      }
+      if (
+        filters.tags &&
+        filters.tags.values &&
+        filters.tags.values.length > 0
+      ) {
+        const mode = filters.tags.mode || 'all';
+        const tagValues = filters.tags.values;
+        switch (mode) {
+          case 'exact':
+            where.push(`tags = $${paramIdx++}`);
+            params.push(tagValues);
+            break;
+          case 'all':
+            where.push(`tags @> $${paramIdx++}`);
+            params.push(tagValues);
+            break;
+          case 'any':
+            where.push(`tags && $${paramIdx++}`);
+            params.push(tagValues);
+            break;
+          case 'none':
+            where.push(`NOT (tags && $${paramIdx++})`);
+            params.push(tagValues);
+            break;
+          default:
+            where.push(`tags @> $${paramIdx++}`);
+            params.push(tagValues);
+        }
+      }
+    }
+    if (where.length > 0) {
+      query += ` WHERE ${where.join(' AND ')}`;
+    }
+    // Always add LIMIT and OFFSET as the last parameters
+    paramIdx = params.length + 1;
+    query += ` ORDER BY created_at DESC LIMIT $${paramIdx++} OFFSET $${paramIdx}`;
+    params.push(limit, offset);
+    const result = await client.query(query, params);
+    log(`Found ${result.rows.length} jobs`);
+    return result.rows.map((job) => ({
+      ...job,
+      payload: job.payload,
+      timeoutMs: job.timeoutMs,
+      failureReason: job.failureReason,
+    }));
+  } catch (error) {
+    log(`Error getting jobs: ${error}`);
+    throw error;
+  } finally {
+    client.release();
+  }
+};

package/src/types.ts

@@ -164,6 +164,25 @@ export interface Processor {
   start: () => Promise<number>;
 }
 
+export interface DatabaseSSLConfig {
+  /**
+   * CA certificate as PEM string or file path. If the value starts with 'file://', it will be loaded from file, otherwise treated as PEM string.
+   */
+  ca?: string;
+  /**
+   * Client certificate as PEM string or file path. If the value starts with 'file://', it will be loaded from file, otherwise treated as PEM string.
+   */
+  cert?: string;
+  /**
+   * Client private key as PEM string or file path. If the value starts with 'file://', it will be loaded from file, otherwise treated as PEM string.
+   */
+  key?: string;
+  /**
+   * Whether to reject unauthorized certificates (default: true)
+   */
+  rejectUnauthorized?: boolean;
+}
+
 export interface JobQueueConfig {
   databaseConfig: {
     connectionString?: string;
@@ -172,7 +191,7 @@ export interface JobQueueConfig {
     database?: string;
     user?: string;
     password?: string;
-    ssl?: any;
+    ssl?: DatabaseSSLConfig;
   };
   verbose?: boolean;
 }
@@ -225,6 +244,17 @@ export interface JobQueue<PayloadMap> {
     limit?: number,
     offset?: number,
   ) => Promise<JobRecord<PayloadMap, T>[]>;
+  /**
+   * Get jobs by filters.
+  /**
+   * Get jobs by filters.
+   */
+  getJobs: <T extends JobType<PayloadMap>>(filters?: {
+    jobType?: string;
+    priority?: number;
+    runAt?: Date | { gt?: Date; gte?: Date; lt?: Date; lte?: Date; eq?: Date };
+    tags?: { values: string[]; mode?: TagQueryMode };
+  }) => Promise<JobRecord<PayloadMap, T>[]>;
   /**
    * Retry a job given its ID.
    * - This will set the job status back to 'pending', clear the locked_at and locked_by, and allow it to be picked up by other workers.
@@ -253,13 +283,13 @@ export interface JobQueue<PayloadMap> {
    * - The filters are:
    *   - jobType: The job type to cancel.
    *   - priority: The priority of the job to cancel.
-   *   - runAt: The time the job is scheduled to run at.
+   *   - runAt: The time the job is scheduled to run at (now supports gt/gte/lt/lte/eq).
    *   - tags: An object with 'values' (string[]) and 'mode' (TagQueryMode) for tag-based cancellation.
    */
   cancelAllUpcomingJobs: (filters?: {
     jobType?: string;
     priority?: number;
-    runAt?: Date;
+    runAt?: Date | { gt?: Date; gte?: Date; lt?: Date; lte?: Date; eq?: Date };
     tags?: { values: string[]; mode?: TagQueryMode };
   }) => Promise<number>;
   /**