Merge pull request #1347 from RedisInsight/feature/RI-3751_command_execution_time

#RI-3751-add command execution time

Author: AlenaSY

redisinsight/api/migration/1667368983699-workbench-execution-time.ts

@@ -0,0 +1,24 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class workbenchExecutionTime1667368983699 implements MigrationInterface {
+    name = 'workbenchExecutionTime1667368983699'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP INDEX "IDX_5cd90dd6def1fd7c521e53fb2c"`);
+        await queryRunner.query(`CREATE TABLE "temporary_command_execution" ("id" varchar PRIMARY KEY NOT NULL, "databaseId" varchar NOT NULL, "command" text NOT NULL, "result" text NOT NULL, "role" varchar, "nodeOptions" varchar, "encryption" varchar, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "mode" varchar, "resultsMode" varchar, "summary" varchar, "executionTime" integer, CONSTRAINT "FK_ea8adfe9aceceb79212142206b8" FOREIGN KEY ("databaseId") REFERENCES "database_instance" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`);
+        await queryRunner.query(`INSERT INTO "temporary_command_execution"("id", "databaseId", "command", "result", "role", "nodeOptions", "encryption", "createdAt", "mode", "resultsMode", "summary") SELECT "id", "databaseId", "command", "result", "role", "nodeOptions", "encryption", "createdAt", "mode", "resultsMode", "summary" FROM "command_execution"`);
+        await queryRunner.query(`DROP TABLE "command_execution"`);
+        await queryRunner.query(`ALTER TABLE "temporary_command_execution" RENAME TO "command_execution"`);
+        await queryRunner.query(`CREATE INDEX "IDX_5cd90dd6def1fd7c521e53fb2c" ON "command_execution" ("createdAt") `);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP INDEX "IDX_5cd90dd6def1fd7c521e53fb2c"`);
+        await queryRunner.query(`ALTER TABLE "command_execution" RENAME TO "temporary_command_execution"`);
+        await queryRunner.query(`CREATE TABLE "command_execution" ("id" varchar PRIMARY KEY NOT NULL, "databaseId" varchar NOT NULL, "command" text NOT NULL, "result" text NOT NULL, "role" varchar, "nodeOptions" varchar, "encryption" varchar, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "mode" varchar, "resultsMode" varchar, "summary" varchar, CONSTRAINT "FK_ea8adfe9aceceb79212142206b8" FOREIGN KEY ("databaseId") REFERENCES "database_instance" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`);
+        await queryRunner.query(`INSERT INTO "command_execution"("id", "databaseId", "command", "result", "role", "nodeOptions", "encryption", "createdAt", "mode", "resultsMode", "summary") SELECT "id", "databaseId", "command", "result", "role", "nodeOptions", "encryption", "createdAt", "mode", "resultsMode", "summary" FROM "temporary_command_execution"`);
+        await queryRunner.query(`DROP TABLE "temporary_command_execution"`);
+        await queryRunner.query(`CREATE INDEX "IDX_5cd90dd6def1fd7c521e53fb2c" ON "command_execution" ("createdAt") `);
+    }
+
+}

redisinsight/api/migration/index.ts

@@ -19,6 +19,7 @@ import { workbenchMode1660664717573 } from './1660664717573-workbench-mode';
 import { workbenchGroupMode1663093411715 } from './1663093411715-workbench-group-mode';
 import { databaseAnalysis1664785208236 } from './1664785208236-database-analysis';
 import { databaseAnalysisExpirationGroups1664886479051 } from './1664886479051-database-analysis-expiration-groups';
+import { workbenchExecutionTime1667368983699 } from './1667368983699-workbench-execution-time';
 
 export default [
   initialMigration1614164490968,
@@ -42,4 +43,5 @@ export default [
   workbenchGroupMode1663093411715,
   databaseAnalysis1664785208236,
   databaseAnalysisExpirationGroups1664886479051,
+  workbenchExecutionTime1667368983699,
 ];

redisinsight/api/src/modules/workbench/dto/create-command-executions.dto.ts

@@ -1,6 +1,6 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import {
-  IsEnum, IsArray, IsNotEmptyObject, IsOptional, ArrayNotEmpty, ValidateNested,
+  IsEnum, IsArray, IsNotEmptyObject, IsDefined, IsOptional, IsString, ArrayNotEmpty, ValidateNested,
 } from 'class-validator';
 import { Type } from 'class-transformer';
 import { ClusterSingleNodeOptions } from 'src/modules/cli/dto/cli.dto';
@@ -9,11 +9,13 @@ import { ClusterNodeRole, RunQueryMode, ResultsMode } from './create-command-exe
 export class CreateCommandExecutionsDto {
   @ApiProperty({
     isArray: true,
+    type: String,
     description: 'Redis commands',
   })
   @IsArray()
   @ArrayNotEmpty()
-  @Type(() => String)
+  @IsDefined()
+  @IsString({ each: true })
   commands: string[];
 
   @ApiPropertyOptional({

redisinsight/api/src/modules/workbench/entities/command-execution.entity.ts

@@ -71,6 +71,9 @@ export class CommandExecutionEntity {
   @Column({ nullable: true })
   encryption: string;
 
+  @Column({ nullable: true })
+  executionTime?: number;
+
   @CreateDateColumn()
   @Index()
   createdAt: Date;

redisinsight/api/src/modules/workbench/models/command-execution.ts

@@ -110,6 +110,13 @@ export class CommandExecution {
   @Expose()
   createdAt: Date;
 
+  @ApiPropertyOptional({
+    description: 'Workbench command execution time',
+    type: Number,
+  })
+  @Expose()
+  executionTime?: number;
+
   constructor(partial: Partial<CommandExecution> = {}) {
     Object.assign(this, partial);
   }

redisinsight/api/src/modules/workbench/providers/command-execution.provider.ts

@@ -31,7 +31,7 @@ export class CommandExecutionProvider {
    */
   async createMany(commandExecutions: Partial<CommandExecution>[]): Promise<CommandExecution[]> {
     // todo: limit by 30 max to insert
-    let entities = await Promise.all(commandExecutions.map(async (commandExecution, idx) => {
+    let entities = await Promise.all(commandExecutions.map(async (commandExecution) => {
       const entity = plainToClass(CommandExecutionEntity, commandExecution);
 
       // Do not store command execution result that exceeded limitation
@@ -61,6 +61,7 @@ export class CommandExecutionProvider {
           result: commandExecutions[idx].result,
           nodeOptions: commandExecutions[idx].nodeOptions,
           summary: commandExecutions[idx].summary,
+          executionTime: commandExecutions[idx].executionTime,
         },
       )),
     );
@@ -95,6 +96,7 @@ export class CommandExecutionProvider {
         'e.mode',
         'e.summary',
         'e.resultsMode',
+        'e.executionTime',
       ])
       .orderBy('e.createdAt', 'DESC')
       .limit(WORKBENCH_CONFIG.maxItemsPerDb)

redisinsight/api/src/modules/workbench/workbench.service.spec.ts

@@ -136,8 +136,10 @@ describe('WorkbenchService', () => {
 
   describe('createCommandExecution', () => {
     it('should successfully execute command and save it', async () => {
-      expect(await service.createCommandExecution(mockClientOptions, mockCreateCommandExecutionDto))
-        .toEqual(mockCommandExecutionToRun);
+      const result = await service.createCommandExecution(mockClientOptions, mockCreateCommandExecutionDto);
+      // can't predict execution time
+      expect(result).toMatchObject(mockCommandExecutionToRun);
+      expect(result.executionTime).toBeGreaterThan(0);
     });
     it('should save result as unsupported command message', async () => {
       workbenchCommandsExecutor.sendCommand.mockResolvedValueOnce(mockCommandExecutionResults);

redisinsight/api/src/modules/workbench/workbench.service.ts

@@ -46,7 +46,10 @@ export class WorkbenchService {
         },
       ];
     } else {
+      const startCommandExecutionTime = process.hrtime.bigint();
       commandExecution.result = await this.commandsExecutor.sendCommand(clientOptions, { ...dto, command });
+      const endCommandExecutionTime = process.hrtime.bigint();
+      commandExecution.executionTime = Math.round((Number(endCommandExecutionTime - startCommandExecutionTime) / 1000));
     }
 
     return commandExecution;
@@ -67,6 +70,9 @@ export class WorkbenchService {
       ...dto,
       databaseId: clientOptions.instanceId,
     };
+    let executionTimeInNanoseconds = BigInt(0);
+
+    const startCommandExecutionTime = process.hrtime.bigint();
 
     const executionResults = await Promise.all(commands.map(async (singleCommand) => {
       const command = multilineCommandToOneLine(singleCommand);
@@ -79,9 +85,16 @@ export class WorkbenchService {
         });
       }
       const result = await this.commandsExecutor.sendCommand(clientOptions, { ...dto, command });
+      const endCommandExecutionTime = process.hrtime.bigint();
+
+      executionTimeInNanoseconds += (endCommandExecutionTime - startCommandExecutionTime);
       return ({ ...result[0], command });
     }));
 
+    if (Number(executionTimeInNanoseconds) !== 0) {
+      commandExecution.executionTime = Math.round(Number(executionTimeInNanoseconds) / 1000);
+    }
+
     const successCommands = executionResults.filter(
       (command) => command.status === CommandExecutionStatus.Success,
     );

redisinsight/api/test/api/workbench/GET-instance-id-workbench-command_executions-id.test.ts

@@ -32,6 +32,7 @@ const responseSchema = Joi.object().keys({
   mode: Joi.string().required(),
   summary: Joi.string().allow(null),
   resultsMode: Joi.string().allow(null),
+  executionTime: Joi.number().allow(null),
   nodeOptions: Joi.object().keys({
     host: Joi.string().required(),
     port: Joi.number().required(),

redisinsight/api/test/api/workbench/GET-instance-id-workbench-command_executions.test.ts

@@ -20,6 +20,7 @@ const responseSchema = Joi.array().items(Joi.object().keys({
   mode: Joi.string().required(),
   summary: Joi.string().allow(null),
   resultsMode: Joi.string().allow(null),
+  executionTime: Joi.number().allow(null),
   nodeOptions: Joi.object().keys({
     host: Joi.string().required(),
     port: Joi.number().required(),