Refactor BackendResultInfoDto to separate success and error subclasses

Author: tacxou

src/backend-runner/_dto/backend-result-info.dto.ts

@@ -1,10 +1,7 @@
 import { IsEnum, IsObject, IsOptional, IsString } from 'class-validator';
-import { BackendCodesEnum } from '../_interfaces/backend-codes.enum';
+import { BackendCodesEnumError, BackendCodesEnumSuccess } from '../_interfaces/backend-codes.enum';
 
 export class BackendResultInfoDto {
-  @IsEnum(BackendCodesEnum)
-  public status: number;
-
   @IsString()
   @IsOptional()
   public message?: string;
@@ -13,3 +10,13 @@ export class BackendResultInfoDto {
   @IsOptional()
   public data?: object;
 }
+
+export class BackendResultInfoSuccessDto extends BackendResultInfoDto {
+  @IsEnum(BackendCodesEnumSuccess)
+  public status: number;
+}
+
+export class BackendResultInfoErrorDto extends BackendResultInfoDto {
+  @IsEnum(BackendCodesEnumError)
+  public status: number;
+}

src/backend-runner/_executors/catch-all.executor.ts

@@ -5,10 +5,10 @@ import { join } from 'path';
 import { Job } from 'bullmq';
 import { BackendConfigV1Dto } from '../_dto/backend-config-v1.dto';
 import { BackendResultInfoInterface, BackendResultInterface } from '../_interfaces/backend-result.interface';
-import { BackendCodesEnum } from '../_interfaces/backend-codes.enum';
 import { ValidationError, validateOrReject } from 'class-validator';
-import { BackendResultInfoDto } from '../_dto/backend-result-info.dto';
+import { BackendResultInfoErrorDto, BackendResultInfoSuccessDto } from '../_dto/backend-result-info.dto';
 import { plainToInstance } from 'class-transformer';
+import { BackendCodesEnumError } from '../_interfaces/backend-codes.enum';
 
 interface ValidationRecursive {
   [key: string]: string;
@@ -58,7 +58,7 @@ export class CatchAllExecutor implements ExecutorInterface {
       if (process.status !== 0) {
         this.service.logger.error(`Error executing backend ${backend.name}`);
         const error = this.extractLastJsonImproved(process.error || process.output);
-        const errorSchema = plainToInstance(BackendResultInfoDto, error);
+        const errorSchema = plainToInstance(BackendResultInfoErrorDto, error);
         await validateOrReject(errorSchema);
 
         return {
@@ -70,7 +70,7 @@ export class CatchAllExecutor implements ExecutorInterface {
 
       this.service.logger.log(`Backend ${backend.name} executed successfully`);
       const output = this.extractLastJsonImproved(process.output);
-      const outputSchema = plainToInstance(BackendResultInfoDto, output);
+      const outputSchema = plainToInstance(BackendResultInfoSuccessDto, output);
       await validateOrReject(outputSchema);
 
       return {
@@ -89,10 +89,10 @@ export class CatchAllExecutor implements ExecutorInterface {
 
       return {
         backend: backend.name,
-        status: BackendCodesEnum.INVALID_JSON_RESPONSE,
+        status: BackendCodesEnumError.INVALID_JSON_RESPONSE,
         message: `Erreur de validation : ${Object.keys(validations).join(', ')}`.trim(),
         error: {
-          status: BackendCodesEnum.INVALID_JSON_RESPONSE,
+          status: BackendCodesEnumError.INVALID_JSON_RESPONSE,
           message: `Erreur de validation : ${Object.keys(validations).join(', ')}`.trim(),
           data: validations,
         },
@@ -102,7 +102,7 @@ export class CatchAllExecutor implements ExecutorInterface {
 
   private extractLastJsonImproved(stdout: string): BackendResultInfoInterface {
     if (!stdout) return {
-      status: BackendCodesEnum.INVALID_JSON_RESPONSE,
+      status: BackendCodesEnumError.INVALID_JSON_RESPONSE,
       message: 'No output',
     }
 
@@ -138,7 +138,7 @@ export class CatchAllExecutor implements ExecutorInterface {
     }
 
     if (jsonCandidates.length === 0) return {
-      status: BackendCodesEnum.INVALID_JSON_RESPONSE,
+      status: BackendCodesEnumError.INVALID_JSON_RESPONSE,
       message: 'No JSON output',
     }
 

src/backend-runner/_interfaces/backend-codes.enum.ts

@@ -6,12 +6,15 @@
  * @see https://www.linuxdoc.org/LDP/abs/html/exitcodes.html
  * @see https://www.gnu.org/software/libc/manual/html_node/Exit-Status.html
  */
-export enum BackendCodesEnum {
-  OK = 0,
+export enum BackendCodesEnumError {
   GENERIC_ERROR = 1 << 0,
   GENERIC_STOPPED = 1 << 1,
   CONNECTION_ERROR = 1 << 2,
   INVALID_LOGIN = 1 << 3,
   INVALID_CREDENTIALS = 1 << 4,
   INVALID_JSON_RESPONSE = 1 << 5,
 }
+
+export enum BackendCodesEnumSuccess {
+  OK = 0,
+}