perf(scheduler): do not save offset value when every is provided

Author: roggervalf

src/classes/job-scheduler.ts

@@ -93,19 +93,19 @@ export class JobScheduler extends QueueBase {
     }
 
     let nextMillis: number;
-    let newOffset = offset || 0;
+    let newOffset = 0;
 
     if (every) {
       const prevSlot = Math.floor(startMillis / every) * every;
       const nextSlot = prevSlot + every;
-      if (prevMillis || offset) {
+      newOffset = startMillis - prevSlot;
+      // newOffset should always be positive, but we do an extra safety check
+      newOffset = newOffset < 0 ? 0 : newOffset;
+
+      if (prevMillis) {
         nextMillis = nextSlot;
       } else {
         nextMillis = prevSlot;
-        newOffset = startMillis - prevSlot;
-
-        // newOffset should always be positive, but we do an extra safety check
-        newOffset = newOffset < 0 ? 0 : newOffset;
       }
     } else if (pattern) {
       nextMillis = await this.repeatStrategy(now, repeatOpts, jobName);
@@ -246,7 +246,6 @@ export class JobScheduler extends QueueBase {
     mergedOpts.repeat = {
       ...opts.repeat,
       count: currentCount,
-      offset,
       endDate: opts.repeat?.endDate
         ? new Date(opts.repeat.endDate).getTime()
         : undefined,
@@ -255,51 +254,6 @@ export class JobScheduler extends QueueBase {
     return mergedOpts;
   }
 
-  private createNextJob<T = any, R = any, N extends string = string>(
-    client: RedisClient,
-    name: N,
-    nextMillis: number,
-    offset: number,
-    jobSchedulerId: string,
-    opts: JobsOptions,
-    data: T,
-    currentCount: number,
-    // The job id of the job that produced this next iteration
-    producerId?: string,
-  ) {
-    //
-    // Generate unique job id for this iteration.
-    //
-    const jobId = this.getSchedulerNextJobId({
-      jobSchedulerId,
-      nextMillis,
-    });
-
-    const now = Date.now();
-    const delay = nextMillis + offset - now;
-
-    const mergedOpts = {
-      ...opts,
-      jobId,
-      delay: delay < 0 ? 0 : delay,
-      timestamp: now,
-      prevMillis: nextMillis,
-      repeatJobKey: jobSchedulerId,
-    };
-
-    mergedOpts.repeat = { ...opts.repeat, count: currentCount };
-
-    const job = new this.Job<T, R, N>(this, name, data, mergedOpts, jobId);
-    job.addJob(client);
-
-    if (producerId) {
-      const producerJobKey = this.toKey(producerId);
-      client.hset(producerJobKey, 'nrjid', job.id);
-    }
-
-    return job;
-  }
-
   async removeJobScheduler(jobSchedulerId: string): Promise<number> {
     return this.scripts.removeJobScheduler(jobSchedulerId);
   }

src/classes/scripts.ts

@@ -376,7 +376,7 @@ export class Scripts {
     nextMillis: number,
     templateData: string,
     delayedJobOpts: JobsOptions,
-    // The job id of the job that produced this next iteration
+    // The job id of the job that produced this next iteration - TODO: remove in next breaking change
     producerId?: string,
   ): Promise<string | null> {
     const client = await this.queue.client;

src/interfaces/repeat-options.ts

@@ -42,6 +42,7 @@ export interface RepeatOptions extends Omit<ParserOptions, 'iterator'> {
   count?: number;
 
   /**
+   * TODO: remove this property in favor of `key`
    * Offset in milliseconds to affect the next iteration time
    *
    * */

src/interfaces/repeatable-options.ts

@@ -5,4 +5,5 @@ export type RepeatableOptions = {
   limit?: number;
   pattern?: string;
   every?: number;
+  offset?: number;
 };