#RI-3742-resolve comments

Author: AmirAllayarovSofteq

redisinsight/api/src/constants/telemetry-events.ts

@@ -61,3 +61,5 @@ export enum CommandType {
   Core = 'core',
   Module = 'module',
 }
+
+export const unknownCommand = 'unknown';

redisinsight/api/src/modules/cli/services/cli-business/cli-business.service.spec.ts

@@ -28,6 +28,7 @@ import {
   CommandParsingError,
   WrongDatabaseTypeError,
 } from 'src/modules/cli/constants/errors';
+import { unknownCommand } from 'src/constants';
 import { CliAnalyticsService } from 'src/modules/cli/services/cli-analytics/cli-analytics.service';
 import { KeytarUnavailableException } from 'src/modules/encryption/exceptions';
 import { RedisToolService } from 'src/modules/redis/redis-tool.service';
@@ -330,6 +331,7 @@ describe('CliBusinessService', () => {
           ERROR_MESSAGES.CLI_UNTERMINATED_QUOTES(),
         ),
         {
+          command: unknownCommand,
           outputFormat: CliOutputFormatterTypes.Raw,
         },
       );
@@ -591,6 +593,7 @@ describe('CliBusinessService', () => {
         mockClientOptions.instanceId,
         new CommandParsingError(ERROR_MESSAGES.CLI_UNTERMINATED_QUOTES()),
         {
+          command: unknownCommand,
           outputFormat: CliOutputFormatterTypes.Raw,
         },
       );
@@ -920,6 +923,7 @@ describe('CliBusinessService', () => {
         mockClientOptions.instanceId,
         new CommandParsingError(ERROR_MESSAGES.CLI_UNTERMINATED_QUOTES()),
         {
+          command: unknownCommand,
           outputFormat: CliOutputFormatterTypes.Raw,
         },
       );

redisinsight/api/src/modules/cli/services/cli-business/cli-business.service.ts

@@ -5,6 +5,7 @@ import {
   Logger,
 } from '@nestjs/common';
 import { IFindRedisClientInstanceByOptions } from 'src/modules/redis/redis.service';
+import { unknownCommand } from 'src/constants';
 import { CommandsService } from 'src/modules/commands/commands.service';
 import {
   ClusterNodeRole,
@@ -143,7 +144,7 @@ export class CliBusinessService {
   ): Promise<SendCommandResponse> {
     this.logger.log('Executing redis CLI command.');
     const { command: commandLine } = dto;
-    let command: string;
+    let command: string = unknownCommand;
     let args: string[] = [];
 
     const outputFormat = dto.outputFormat || CliOutputFormatterTypes.Raw;
@@ -229,7 +230,7 @@ export class CliBusinessService {
     outputFormat: CliOutputFormatterTypes = CliOutputFormatterTypes.Raw,
   ): Promise<SendClusterCommandResponse[]> {
     this.logger.log(`Executing redis.cluster CLI command for [${role}] nodes.`);
-    let command: string;
+    let command: string = unknownCommand;
     let args: string[] = [];
 
     try {
@@ -298,7 +299,7 @@ export class CliBusinessService {
     outputFormat: CliOutputFormatterTypes = CliOutputFormatterTypes.Raw,
   ): Promise<SendClusterCommandResponse> {
     this.logger.log(`Executing redis.cluster CLI command for single node ${JSON.stringify(nodeOptions)}`);
-    let command: string;
+    let command: string = unknownCommand;
     let args: string[] = [];
 
     try {

redisinsight/api/src/modules/workbench/providers/workbench-commands.executor.spec.ts

@@ -5,6 +5,8 @@ import {
   mockDatabase,
   mockWorkbenchAnalyticsService,
 } from 'src/__mocks__';
+import ERROR_MESSAGES from 'src/constants/error-messages';
+import { unknownCommand } from 'src/constants';
 import { IFindRedisClientInstanceByOptions } from 'src/modules/redis/redis.service';
 import { WorkbenchCommandsExecutor } from 'src/modules/workbench/providers/workbench-commands.executor';
 import {
@@ -17,6 +19,7 @@ import { CommandExecutionStatus } from 'src/modules/cli/dto/cli.dto';
 import { BadRequestException, InternalServerErrorException, ServiceUnavailableException } from '@nestjs/common';
 import {
   CommandNotSupportedError,
+  CommandParsingError,
   ClusterNodeNotFoundError,
   WrongDatabaseTypeError,
 } from 'src/modules/cli/constants/errors';
@@ -49,6 +52,7 @@ const mockCliNodeResponse: ICliExecResultFromNode = {
 };
 
 const mockSetCommand = 'set';
+const mockGetEscapedKeyCommand = 'get "\\\\key';
 const mockCreateCommandExecutionDto: CreateCommandExecutionDto = {
   command: `${mockSetCommand} foo bar`,
   nodeOptions: {
@@ -564,5 +568,35 @@ describe('WorkbenchCommandsExecutor', () => {
         }
       });
     });
+    describe('CommandParsingError', () => {
+      it('should return response with [CLI_UNTERMINATED_QUOTES] error for sendCommandForNodes', async () => {
+        const mockResult = [
+          {
+            response: ERROR_MESSAGES.CLI_UNTERMINATED_QUOTES(),
+            status: CommandExecutionStatus.Fail,
+          },
+        ];
+
+        const result = await service.sendCommand(mockClientOptions, {
+          command: mockGetEscapedKeyCommand,
+          role: mockCreateCommandExecutionDto.role,
+          mode: RunQueryMode.ASCII,
+        });
+
+        expect(result).toEqual(mockResult);
+        expect(mockAnalyticsService.sendCommandExecutedEvent).toHaveBeenCalledWith(
+          mockClientOptions.instanceId,
+          {
+            response: ERROR_MESSAGES.CLI_UNTERMINATED_QUOTES(),
+            error: new CommandParsingError(ERROR_MESSAGES.CLI_UNTERMINATED_QUOTES()),
+            status: CommandExecutionStatus.Fail,
+          },
+          {
+            command: unknownCommand,
+            rawMode: false,
+          },
+        );
+      });
+    });
   });
 });

redisinsight/api/src/modules/workbench/providers/workbench-commands.executor.ts

@@ -18,6 +18,7 @@ import {
   ClusterNodeNotFoundError,
   WrongDatabaseTypeError,
 } from 'src/modules/cli/constants/errors';
+import { unknownCommand } from 'src/constants';
 import { CommandExecutionResult } from 'src/modules/workbench/models/command-execution-result';
 import { CreateCommandExecutionDto, RunQueryMode } from 'src/modules/workbench/dto/create-command-execution.dto';
 import { RedisToolService } from 'src/modules/redis/redis-tool.service';
@@ -62,18 +63,17 @@ export class WorkbenchCommandsExecutor {
     dto: CreateCommandExecutionDto,
   ): Promise<CommandExecutionResult[]> {
     let result;
+    let command = unknownCommand;
+    let commandArgs: string[] = [];
 
     const {
       command: commandLine,
       role,
       nodeOptions,
       mode,
     } = dto;
-    let command = commandLine;
-
     try {
-      const [parsedCommand, ...commandArgs] = splitCliCommandLine(commandLine);
-      command = parsedCommand;
+      [command, ...commandArgs] = splitCliCommandLine(commandLine);
 
       if (nodeOptions) {
         result = [await this.sendCommandForSingleNode(