chore: move finishedErrors back to the scripts class

taskforcesh · Oct 12, 2024 · 72d4896 · 72d4896
1 parent deaa75d
commit 72d4896
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 62 deletions.
diff --git a/src/classes/job.ts b/src/classes/job.ts
@@ -29,7 +29,6 @@ import {
   lengthInUtf8Bytes,
   parseObjectValues,
   tryCatch,
-  finishedErrors,
 } from '../utils';
 import { Backoffs } from './backoffs';
 import { Scripts, raw2NextJobData } from './scripts';
@@ -748,7 +747,7 @@ export class Job<
 
     const result = results[results.length - 1][1] as number;
     if (result < 0) {
-      throw finishedErrors({
+      throw this.scripts.finishedErrors({
         code: result,
         jobId: this.id,
         command,

diff --git a/src/classes/scripts.ts b/src/classes/scripts.ts
@@ -34,12 +34,7 @@ import {
   RedisJobOptions,
 } from '../types';
 import { ErrorCode } from '../enums';
-import {
-  array2obj,
-  finishedErrors,
-  getParentKey,
-  isRedisVersionLowerThan,
-} from '../utils';
+import { array2obj, getParentKey, isRedisVersionLowerThan } from '../utils';
 import { ChainableCommander } from 'ioredis';
 
 export type JobData = [JobJsonRaw | number, string?];
@@ -225,7 +220,7 @@ export class Scripts {
     }
 
     if (<number>result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: <number>result,
         parentKey: parentOpts.parentKey,
         command: 'addJob',
@@ -424,7 +419,7 @@ export class Scripts {
     const result = await (<any>client).removeJob(args);
 
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId,
         command: 'removeJob',
@@ -463,7 +458,7 @@ export class Scripts {
     const result = await (<any>client).updateData(keys.concat([dataJson]));
 
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId: job.id,
         command: 'updateData',
@@ -489,7 +484,7 @@ export class Scripts {
     );
 
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId,
         command: 'updateProgress',
@@ -514,7 +509,7 @@ export class Scripts {
     );
 
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId,
         command: 'addLog',
@@ -598,7 +593,7 @@ export class Scripts {
 
     const result = await (<any>client).moveToFinished(args);
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId,
         command: 'moveToFinished',
@@ -662,7 +657,7 @@ export class Scripts {
       case 1:
         return false;
       default:
-        throw finishedErrors({
+        throw this.finishedErrors({
           code: result,
           jobId,
           parentKey,
@@ -826,7 +821,7 @@ export class Scripts {
     const args = this.changeDelayArgs(jobId, delay);
     const result = await (<any>client).changeDelay(args);
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId,
         command: 'changeDelay',
@@ -863,7 +858,7 @@ export class Scripts {
     const args = this.changePriorityArgs(jobId, priority, lifo);
     const result = await (<any>client).changePriority(args);
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId,
         command: 'changePriority',
@@ -981,7 +976,7 @@ export class Scripts {
     const args = this.moveToDelayedArgs(jobId, timestamp, token, delay, opts);
     const result = await (<any>client).moveToDelayed(args);
     if (result < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code: result,
         jobId,
         command: 'moveToDelayed',
@@ -1017,7 +1012,7 @@ export class Scripts {
       case 1:
         return false;
       default:
-        throw finishedErrors({
+        throw this.finishedErrors({
           code: result,
           jobId,
           command: 'moveToWaitingChildren',
@@ -1176,7 +1171,7 @@ export class Scripts {
       case 1:
         return;
       default:
-        throw finishedErrors({
+        throw this.finishedErrors({
           code: result,
           jobId: job.id,
           command: 'reprocessJob',
@@ -1240,7 +1235,7 @@ export class Scripts {
 
     const code = await (<any>client).promote(keys.concat(args));
     if (code < 0) {
-      throw finishedErrors({
+      throw this.finishedErrors({
         code,
         jobId,
         command: 'promote',
@@ -1424,6 +1419,49 @@ export class Scripts {
       };
     }
   }
+
+  finishedErrors({
+    code,
+    jobId,
+    parentKey,
+    command,
+    state,
+  }: {
+    code: number;
+    jobId?: string;
+    parentKey?: string;
+    command: string;
+    state?: string;
+  }): Error {
+    switch (code) {
+      case ErrorCode.JobNotExist:
+        return new Error(`Missing key for job ${jobId}. ${command}`);
+      case ErrorCode.JobLockNotExist:
+        return new Error(`Missing lock for job ${jobId}. ${command}`);
+      case ErrorCode.JobNotInState:
+        return new Error(
+          `Job ${jobId} is not in the ${state} state. ${command}`,
+        );
+      case ErrorCode.JobPendingDependencies:
+        return new Error(`Job ${jobId} has pending dependencies. ${command}`);
+      case ErrorCode.ParentJobNotExist:
+        return new Error(`Missing key for parent job ${parentKey}. ${command}`);
+      case ErrorCode.JobLockMismatch:
+        return new Error(
+          `Lock mismatch for job ${jobId}. Cmd ${command} from ${state}`,
+        );
+      case ErrorCode.ParentJobCannotBeReplaced:
+        return new Error(
+          `The parent job ${parentKey} cannot be replaced. ${command}`,
+        );
+      case ErrorCode.JobBelongsToJobScheduler:
+        return new Error(
+          `Job ${jobId} belongs to a job scheduler and cannot be removed directly. ${command}`,
+        );
+      default:
+        return new Error(`Unknown code ${code} error for ${jobId}. ${command}`);
+    }
+  }
 }
 
 export function raw2NextJobData(raw: any[]) {

diff --git a/src/utils.ts b/src/utils.ts
@@ -252,47 +252,6 @@ export const toString = (value: any): string => {
 
 export const QUEUE_EVENT_SUFFIX = ':qe';
 
-export const finishedErrors = ({
-  code,
-  jobId,
-  parentKey,
-  command,
-  state,
-}: {
-  code: number;
-  jobId?: string;
-  parentKey?: string;
-  command: string;
-  state?: string;
-}): Error => {
-  switch (code) {
-    case ErrorCode.JobNotExist:
-      return new Error(`Missing key for job ${jobId}. ${command}`);
-    case ErrorCode.JobLockNotExist:
-      return new Error(`Missing lock for job ${jobId}. ${command}`);
-    case ErrorCode.JobNotInState:
-      return new Error(`Job ${jobId} is not in the ${state} state. ${command}`);
-    case ErrorCode.JobPendingDependencies:
-      return new Error(`Job ${jobId} has pending dependencies. ${command}`);
-    case ErrorCode.ParentJobNotExist:
-      return new Error(`Missing key for parent job ${parentKey}. ${command}`);
-    case ErrorCode.JobLockMismatch:
-      return new Error(
-        `Lock mismatch for job ${jobId}. Cmd ${command} from ${state}`,
-      );
-    case ErrorCode.ParentJobCannotBeReplaced:
-      return new Error(
-        `The parent job ${parentKey} cannot be replaced. ${command}`,
-      );
-    case ErrorCode.JobBelongsToJobScheduler:
-      return new Error(
-        `Job ${jobId} belongs to a job scheduler and cannot be removed directly. ${command}`,
-      );
-    default:
-      return new Error(`Unknown code ${code} error for ${jobId}. ${command}`);
-  }
-};
-
 export const readPackageJson: () => { name: string; version: string } = () => {
   const packageJsonPossiblePaths = [
     join(__dirname, '../package.json'),