Merge pull request #3516 from RedisInsight/feature/RI-5749_cover_422_error

#RI-5749 - cover 422 error

Author: AmirAllayarovSofteq

redisinsight/api/src/constants/custom-error-codes.ts

@@ -57,5 +57,5 @@ export enum CustomErrorCodes {
   RdiDeployPipelineFailure = 11_401,
   RdiUnauthorized = 11_402,
   RdiInternalServerError = 11_403,
-
+  RdiValidationError = 11_404,
 }

redisinsight/api/src/constants/error-messages.ts

@@ -110,4 +110,5 @@ export default {
 
   RDI_DEPLOY_PIPELINE_FAILURE: 'Failed to deploy pipeline',
   RDI_TIMEOUT_ERROR: 'Encountered a timeout error while attempting to retrieve data',
+  RDI_VALIDATION_ERROR: 'Validation error',
 };

redisinsight/api/src/modules/rdi/client/api.rdi.client.ts

@@ -1,7 +1,6 @@
 import axios, { AxiosInstance } from 'axios';
 import { plainToClass } from 'class-transformer';
 import { decode } from 'jsonwebtoken';
-import { Request } from 'express';
 
 import { RdiClient } from 'src/modules/rdi/client/rdi.client';
 import {
@@ -14,10 +13,10 @@ import {
 import {
   RdiDryRunJobDto,
   RdiDryRunJobResponseDto,
+  RdiTemplateResponseDto,
   RdiTestConnectionsResponseDto,
 } from 'src/modules/rdi/dto';
 import {
-  RdiPipelineDeployFailedException,
   RdiPipelineInternalServerErrorException,
   wrapRdiPipelineError,
 } from 'src/modules/rdi/exceptions';
@@ -29,8 +28,7 @@ import {
 } from 'src/modules/rdi/models';
 import { convertKeysToCamelCase } from 'src/utils/base.helper';
 import { RdiPipelineTimeoutException } from 'src/modules/rdi/exceptions/rdi-pipeline.timeout-error.exception';
-
-const RDI_DEPLOY_FAILED_STATUS = 'failed';
+import * as https from 'https';
 
 export class ApiRdiClient extends RdiClient {
   protected readonly client: AxiosInstance;
@@ -42,6 +40,9 @@ export class ApiRdiClient extends RdiClient {
     this.client = axios.create({
       baseURL: rdi.url,
       timeout: RDI_TIMEOUT,
+      httpsAgent: new https.Agent({
+        rejectUnauthorized: false,
+      }),
     });
   }
 
@@ -72,25 +73,32 @@ export class ApiRdiClient extends RdiClient {
     }
   }
 
-  async getTemplate(options: object): Promise<object> {
+  async getConfigTemplate(pipelineType: string, dbType: string): Promise<RdiTemplateResponseDto> {
     try {
-      const response = await this.client.get(RdiUrl.GetTemplate, { params: options });
+      const response = await this.client.get(`${RdiUrl.GetConfigTemplate}/${pipelineType}/${dbType}`);
       return response.data;
     } catch (error) {
       throw wrapRdiPipelineError(error);
     }
   }
 
-  async deploy(pipeline: RdiPipeline): Promise<void> {
-    let response;
+  async getJobTemplate(pipelineType: string): Promise<RdiTemplateResponseDto> {
     try {
-      response = await this.client.post(RdiUrl.Deploy, { ...pipeline });
+      const response = await this.client.get(`${RdiUrl.GetJobTemplate}/${pipelineType}`);
+      return response.data;
     } catch (error) {
-      throw wrapRdiPipelineError(error, error.response.data.message);
+      throw wrapRdiPipelineError(error);
     }
+  }
 
-    if (response.data?.status === RDI_DEPLOY_FAILED_STATUS) {
-      throw new RdiPipelineDeployFailedException(undefined, { error: response.data?.error });
+  async deploy(pipeline: RdiPipeline): Promise<void> {
+    try {
+      const response = await this.client.post(RdiUrl.Deploy, { ...pipeline });
+      const actionId = response.data.action_id;
+
+      return this.pollActionStatus(actionId);
+    } catch (error) {
+      throw wrapRdiPipelineError(error, error.response.data.message);
     }
   }
 
@@ -103,21 +111,14 @@ export class ApiRdiClient extends RdiClient {
     }
   }
 
-  async testConnections(config: string, req: Request): Promise<RdiTestConnectionsResponseDto> {
+  async testConnections(config: object): Promise<RdiTestConnectionsResponseDto> {
     try {
-      const abortController = new AbortController();
-      req.socket.on('close', () => {
-        abortController.abort();
-      });
       const response = await this.client.post(
         RdiUrl.TestConnections,
         config,
-        { signal: abortController.signal },
       );
 
-      const actionId = response.data.action_id;
-
-      return this.pollActionStatus(actionId, abortController.signal);
+      return response.data;
     } catch (e) {
       throw wrapRdiPipelineError(e);
     }
@@ -147,7 +148,7 @@ export class ApiRdiClient extends RdiClient {
 
   async getJobFunctions(): Promise<object> {
     try {
-      const response = await this.client.post(RdiUrl.JobFunctions);
+      const response = await this.client.get(RdiUrl.JobFunctions);
       return response.data;
     } catch (e) {
       throw wrapRdiPipelineError(e);
@@ -178,10 +179,10 @@ export class ApiRdiClient extends RdiClient {
     }
   }
 
-  private async pollActionStatus(actionId: string, abortSignal: AbortSignal): Promise<any> {
+  private async pollActionStatus(actionId: string, abortSignal?: AbortSignal): Promise<any> {
     const startTime = Date.now();
     while (true) {
-      if (abortSignal.aborted) {
+      if (abortSignal?.aborted) {
         throw new RdiPipelineInternalServerErrorException();
       }
       if (Date.now() - startTime > MAX_POLLING_TIME) {

redisinsight/api/src/modules/rdi/client/rdi.client.ts

@@ -1,10 +1,9 @@
-import { Request } from 'express';
 import {
   Rdi,
   RdiClientMetadata, RdiPipeline, RdiStatisticsResult,
 } from 'src/modules/rdi/models';
 import {
-  RdiDryRunJobDto, RdiDryRunJobResponseDto, RdiTestConnectionsResponseDto,
+  RdiDryRunJobDto, RdiDryRunJobResponseDto, RdiTemplateResponseDto, RdiTestConnectionsResponseDto,
 } from 'src/modules/rdi/dto';
 import { IDLE_TRESHOLD } from 'src/modules/rdi/constants';
 
@@ -28,16 +27,17 @@ export abstract class RdiClient {
 
   abstract getPipeline(): Promise<RdiPipeline>;
 
-  // TODO validate options and response
-  abstract getTemplate(options: object): Promise<unknown>;
+  abstract getConfigTemplate(pipelineType: string, dbType: string): Promise<RdiTemplateResponseDto>;
+
+  abstract getJobTemplate(pipelineType: string): Promise<RdiTemplateResponseDto>;
 
   abstract getStrategies(): Promise<object>;
 
   abstract deploy(pipeline: RdiPipeline): Promise<void>;
 
   abstract dryRunJob(data: RdiDryRunJobDto): Promise<RdiDryRunJobResponseDto>;
 
-  abstract testConnections(config: string, req: Request): Promise<RdiTestConnectionsResponseDto>;
+  abstract testConnections(config: object): Promise<RdiTestConnectionsResponseDto>;
 
   abstract getStatistics(sections?: string): Promise<RdiStatisticsResult>;
 

redisinsight/api/src/modules/rdi/constants/index.ts

@@ -2,7 +2,8 @@ export enum RdiUrl {
   GetSchema = 'api/v1/schemas',
   GetPipeline = 'api/v1/pipelines',
   GetStrategies = 'api/v1/pipelines/strategies',
-  GetTemplate = 'deployments/templates',
+  GetConfigTemplate = 'api/v1/pipelines/config/templates',
+  GetJobTemplate = 'api/v1/pipelines/jobs/templates',
   DryRunJob = 'api/v1/pipelines/jobs/dry-run',
   JobFunctions = '/api/v1/pipelines/jobs/functions',
   Deploy = 'api/v1/pipelines',

redisinsight/api/src/modules/rdi/dto/index.ts

@@ -3,3 +3,4 @@ export * from './update.rdi.dto';
 export * from './rdi.dry-run.job.dto';
 export * from './rdi.dry-run.job.response.dto';
 export * from './rdi-test-connections.response.dto';
+export * from './rdi-template.response.dto';

redisinsight/api/src/modules/rdi/dto/rdi-template.response.dto.ts

@@ -0,0 +1,11 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Expose } from 'class-transformer';
+
+export class RdiTemplateResponseDto {
+  @ApiProperty({
+    description: 'Template for rdi file',
+    type: String,
+  })
+  @Expose()
+  template: string;
+}

redisinsight/api/src/modules/rdi/exceptions/index.ts

@@ -3,3 +3,4 @@ export * from './rdi-pipiline.error.handler';
 export * from './rdi-pipeline.internal-server-error.exception';
 export * from './rdi-pipeline.not-found.exception';
 export * from './rdi-pipeline.unauthorized.exception';
+export * from './rdi-pipeline.validation.exception';

redisinsight/api/src/modules/rdi/exceptions/rdi-pipeline.validation.exception.ts

@@ -0,0 +1,20 @@
+import { HttpException, HttpExceptionOptions, HttpStatus } from '@nestjs/common';
+import { CustomErrorCodes } from 'src/constants';
+import ERROR_MESSAGES from 'src/constants/error-messages';
+
+export class RdiPipelineValidationException extends HttpException {
+  constructor(
+    message = ERROR_MESSAGES.RDI_VALIDATION_ERROR,
+    options?: HttpExceptionOptions & { details?: unknown },
+  ) {
+    const response = {
+      message,
+      statusCode: HttpStatus.UNPROCESSABLE_ENTITY,
+      error: 'RdiValidationError',
+      errorCode: CustomErrorCodes.RdiValidationError,
+      details: options,
+    };
+
+    super(response, response.statusCode, options);
+  }
+}

redisinsight/api/src/modules/rdi/exceptions/rdi-pipiline.error.handler.ts

@@ -2,7 +2,7 @@ import { AxiosError } from 'axios';
 import { HttpException } from '@nestjs/common';
 import {
   RdiPipelineInternalServerErrorException,
-  RdiPipelineUnauthorizedException, RdiPipelineNotFoundException,
+  RdiPipelineUnauthorizedException, RdiPipelineNotFoundException, RdiPipelineValidationException,
 } from 'src/modules/rdi/exceptions';
 
 export const wrapRdiPipelineError = (error: AxiosError<any>, message?: string): HttpException => {
@@ -11,11 +11,14 @@ export const wrapRdiPipelineError = (error: AxiosError<any>, message?: string):
   }
 
   const { response } = error;
+
   if (response) {
     const errorOptions = response?.data?.detail;
     switch (response?.status) {
       case 401:
         return new RdiPipelineUnauthorizedException(message, errorOptions);
+      case 422:
+        return new RdiPipelineValidationException(message, errorOptions);
       default:
         return new RdiPipelineNotFoundException(message, errorOptions);
     }