feat(scheduler): add getJobScheduler method (#2877) ref #2875

taskforcesh · Nov 2, 2024 · 956d98c · 956d98c
1 parent c97ed56
commit 956d98c
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 2 deletions.
diff --git a/src/classes/job-scheduler.ts b/src/classes/job-scheduler.ts
@@ -13,7 +13,7 @@ export interface JobSchedulerJson {
   tz: string | null;
   pattern: string | null;
   every?: string | null;
-  next: number;
+  next?: number;
 }
 
 export class JobScheduler extends QueueBase {
@@ -190,6 +190,22 @@ export class JobScheduler extends QueueBase {
     };
   }
 
+  async getJobScheduler(id: string): Promise<JobSchedulerJson> {
+    const client = await this.client;
+    const jobData = await client.hgetall(this.toKey('repeat:' + id));
+
+    if (jobData) {
+      return {
+        key: id,
+        name: jobData.name,
+        endDate: parseInt(jobData.endDate) || null,
+        tz: jobData.tz || null,
+        pattern: jobData.pattern || null,
+        every: jobData.every || null,
+      };
+    }
+  }
+
   async getJobSchedulers(
     start = 0,
     end = -1,

diff --git a/src/classes/queue.ts b/src/classes/queue.ts
@@ -468,6 +468,15 @@ export class Queue<
     return (await this.repeat).getRepeatableJobs(start, end, asc);
   }
 
+  /**
+   * Get Job Scheduler by id
+   *
+   * @param id - identifier of scheduler.
+   */
+  async getJobScheduler(id: string): Promise<RepeatableJob> {
+    return (await this.jobScheduler).getJobScheduler(id);
+  }
+
   /**
    * Get all Job Schedulers
    *

diff --git a/src/interfaces/repeatable-job.ts b/src/interfaces/repeatable-job.ts
@@ -1,3 +1,4 @@
+// TODO: remove this type in favor of JobSchedulerJson in next breaking change
 export type RepeatableJob = {
   key: string;
   name: string;
@@ -6,5 +7,5 @@ export type RepeatableJob = {
   tz: string | null;
   pattern: string | null;
   every?: string | null;
-  next: number;
+  next?: number;
 };
diff --git a/tests/test_job_scheduler.ts b/tests/test_job_scheduler.ts
@@ -307,6 +307,17 @@ describe('Job Scheduler', function () {
       { data: { foo: 'bar' } },
     );
 
+    const scheduler = await queue.getJobScheduler('test');
+
+    expect(scheduler).to.deep.equal({
+      key: 'test',
+      name: 'test',
+      endDate: null,
+      tz: null,
+      pattern: '*/2 * * * * *',
+      every: null,
+    });
+
     this.clock.tick(nextTick);
 
     let prev: any;