feat(scheduler): expose template data in getJobSchedulers

src/classes/job-scheduler.ts

@@ -11,7 +11,7 @@ import { Job } from './job';
 import { QueueBase } from './queue-base';
 import { RedisConnection } from './redis-connection';
 import { SpanKind, TelemetryAttributes } from '../enums';
-import { optsAsJSON, optsFromJSON } from '../utils';
+import { array2obj, optsAsJSON, optsFromJSON } from '../utils';
 
 export class JobScheduler extends QueueBase {
   private repeatStrategy: RepeatStrategy;
@@ -209,6 +209,14 @@ export class JobScheduler extends QueueBase {
   ): Promise<JobSchedulerJson<D>> {
     const jobData = await client.hgetall(this.toKey('repeat:' + key));
 
+    return this.transformSchedulerData<D>(key, jobData, next);
+  }
+
+  private async transformSchedulerData<D>(
+    key: string,
+    jobData: any,
+    next?: number,
+  ): Promise<JobSchedulerJson<D>> {
     if (jobData) {
       return {
         key,
@@ -244,30 +252,14 @@ export class JobScheduler extends QueueBase {
     };
   }
 
-  async getJobScheduler<D = any>(id: string): Promise<JobSchedulerJson<D>> {
-    const client = await this.client;
-    const schedulerAttributes = await client.hgetall(
-      this.toKey('repeat:' + id),
-    );
+  async getScheduler<D = any>(id: string): Promise<JobSchedulerJson<D>> {
+    const [rawJobData, next] = await this.scripts.getJobScheduler(id);
 
-    if (schedulerAttributes) {
-      return {
-        key: id,
-        name: schedulerAttributes.name,
-        endDate: parseInt(schedulerAttributes.endDate) || null,
-        tz: schedulerAttributes.tz || null,
-        pattern: schedulerAttributes.pattern || null,
-        every: schedulerAttributes.every || null,
-        ...(schedulerAttributes.data || schedulerAttributes.opts
-          ? {
-              template: this.getTemplateFromJSON<D>(
-                schedulerAttributes.data,
-                schedulerAttributes.opts,
-              ),
-            }
-          : {}),
-      };
-    }
+    return this.transformSchedulerData<D>(
+      id,
+      rawJobData ? array2obj(rawJobData) : null,
+      next ? parseInt(next) : null,
+    );
   }
 
   private getTemplateFromJSON<D = any>(

src/classes/queue.ts

@@ -573,7 +573,7 @@ export class Queue<
    * @param id - identifier of scheduler.
    */
   async getJobScheduler(id: string): Promise<JobSchedulerJson<DataType>> {
-    return (await this.jobScheduler).getJobScheduler<DataType>(id);
+    return (await this.jobScheduler).getScheduler<DataType>(id);
   }
 
   /**

src/classes/scripts.ts

@@ -1088,6 +1088,20 @@ export class Scripts {
     ]);
   }
 
+  getJobSchedulerArgs(id: string): string[] {
+    const keys: string[] = [this.queue.keys.repeat];
+
+    return keys.concat([id]);
+  }
+
+  async getJobScheduler(id: string): Promise<[any, string | null]> {
+    const client = await this.queue.client;
+
+    const args = this.getJobSchedulerArgs(id);
+
+    return this.execCommand(client, 'getJobScheduler', args);
+  }
+
   retryJobArgs(
     jobId: string,
     lifo: boolean,

src/commands/getJobScheduler-1.lua

@@ -0,0 +1,19 @@
+--[[
+  Get job scheduler record.
+
+  Input:
+    KEYS[1] 'repeat' key
+
+    ARGV[1] id
+]]
+
+local rcall = redis.call
+local jobSchedulerKey = KEYS[1] .. ":" .. ARGV[1]
+
+local score = rcall("ZSCORE", KEYS[1], ARGV[1])
+
+if score then
+  return {rcall("HGETALL", jobSchedulerKey), score} -- get job data
+end
+
+return {nil, nil}

tests/test_job_scheduler.ts

@@ -360,6 +360,7 @@ describe('Job Scheduler', function () {
       tz: null,
       pattern: '*/2 * * * * *',
       every: null,
+      next: 1486481042000,
       template: {
         data: {
           foo: 'bar',
@@ -698,6 +699,7 @@ describe('Job Scheduler', function () {
           key: 'rrule',
           name: 'rrule',
           endDate: null,
+          next: 1486481042000,
           tz: null,
           pattern: 'RRULE:FREQ=SECONDLY;INTERVAL=2;WKST=MO',
           every: null,
@@ -1424,6 +1426,8 @@ describe('Job Scheduler', function () {
 
   describe('when repeatable job fails', function () {
     it('should continue repeating', async function () {
+      const date = new Date('2024-12-08 9:24:00');
+      this.clock.setSystemTime(date);
       const repeatOpts = {
         pattern: '0 * 1 * *',
       };
@@ -1475,7 +1479,7 @@ describe('Job Scheduler', function () {
         tz: null,
         pattern: '0 * 1 * *',
         every: null,
-        next: 25200000,
+        next: 1735714800000,
         template: {
           data: {
             foo: 'bar',

tests/test_metrics.ts

@@ -28,7 +28,7 @@ describe('metrics', function () {
   });
 
   beforeEach(function () {
-    this.clock = sinon.useFakeTimers();
+    this.clock = sinon.useFakeTimers({ shouldClearNativeTimers: true });
   });
 
   beforeEach(async function () {