Merge pull request #1149 from RedisInsight/feature/RI-2509-wb-group-mode

Feature/ri 2509 wb group mode

Author: AlenaSY

redisinsight/api/migration/1663093411715-workbench-group-mode.ts

@@ -0,0 +1,24 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class workbenchGroupMode1663093411715 implements MigrationInterface {
+    name = 'workbenchGroupMode1663093411715'
+
+    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, 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") SELECT "id", "databaseId", "command", "result", "role", "nodeOptions", "encryption", "createdAt", "mode" 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, 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") SELECT "id", "databaseId", "command", "result", "role", "nodeOptions", "encryption", "createdAt", "mode" 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

@@ -16,6 +16,7 @@ import { sni1650278664000 } from "./1650278664000-sni";
 import { notification1655821010349 } from './1655821010349-notification';
 import { notificationCategory1659687030433 } from './1659687030433-notification-category';
 import { workbenchMode1660664717573 } from './1660664717573-workbench-mode';
+import { workbenchGroupMode1663093411715 } from './1663093411715-workbench-group-mode';
 
 export default [
   initialMigration1614164490968,
@@ -36,4 +37,5 @@ export default [
   notification1655821010349,
   notificationCategory1659687030433,
   workbenchMode1660664717573,
+  workbenchGroupMode1663093411715,
 ];

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

@@ -16,6 +16,11 @@ export enum RunQueryMode {
   ASCII = 'ASCII',
 }
 
+export enum ResultsMode {
+  Default = 'DEFAULT',
+  GroupMode = 'GROUP_MODE',
+}
+
 export class CreateCommandExecutionDto {
   @ApiProperty({
     type: String,
@@ -38,6 +43,19 @@ export class CreateCommandExecutionDto {
   })
   mode?: RunQueryMode = RunQueryMode.ASCII;
 
+  @ApiPropertyOptional({
+    description: 'Workbench group mode',
+    default: ResultsMode.Default,
+    enum: ResultsMode,
+  })
+  @IsOptional()
+  @IsEnum(ResultsMode, {
+    message: `resultsMode must be a valid enum value. Valid values: ${Object.values(
+      ResultsMode,
+    )}.`,
+  })
+  resultsMode?: ResultsMode;
+
   @ApiPropertyOptional({
     description: 'Execute command for nodes with defined role',
     default: ClusterNodeRole.All,

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

@@ -4,7 +4,7 @@ import {
 } from 'class-validator';
 import { Type } from 'class-transformer';
 import { ClusterSingleNodeOptions } from 'src/modules/cli/dto/cli.dto';
-import { ClusterNodeRole, RunQueryMode } from './create-command-execution.dto';
+import { ClusterNodeRole, RunQueryMode, ResultsMode } from './create-command-execution.dto';
 
 export class CreateCommandExecutionsDto {
   @ApiProperty({
@@ -29,6 +29,14 @@ export class CreateCommandExecutionsDto {
   })
   mode?: RunQueryMode = RunQueryMode.ASCII;
 
+  @IsOptional()
+  @IsEnum(ResultsMode, {
+    message: `resultsMode must be a valid enum value. Valid values: ${Object.values(
+      ResultsMode,
+    )}.`,
+  })
+  resultsMode?: ResultsMode;
+
   @ApiPropertyOptional({
     description: 'Execute command for nodes with defined role',
     default: ClusterNodeRole.All,

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

@@ -2,7 +2,7 @@ import {
   Column, CreateDateColumn, Entity, ManyToOne, PrimaryGeneratedColumn, JoinColumn, Index,
 } from 'typeorm';
 import { DatabaseInstanceEntity } from 'src/modules/core/models/database-instance.entity';
-import { RunQueryMode } from 'src/modules/workbench/dto/create-command-execution.dto';
+import { RunQueryMode, ResultsMode } from 'src/modules/workbench/dto/create-command-execution.dto';
 import { Transform } from 'class-transformer';
 
 @Entity('command_execution')
@@ -43,6 +43,20 @@ export class CommandExecutionEntity {
   @Column({ nullable: true })
   role?: string;
 
+  @Column({ nullable: true })
+  resultsMode?: string = ResultsMode.Default;
+
+  @Column({ nullable: true })
+  @Transform((object) => JSON.stringify(object), { toClassOnly: true })
+  @Transform((string) => {
+    try {
+      return JSON.parse(string);
+    } catch (e) {
+      return undefined;
+    }
+  }, { toPlainOnly: true })
+  summary?: string;
+
   @Column({ nullable: true })
   @Transform((object) => JSON.stringify(object), { toClassOnly: true })
   @Transform((string) => {

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

@@ -1,9 +1,33 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsDefined } from 'class-validator';
 import { CommandExecutionResult } from 'src/modules/workbench/models/command-execution-result';
-import { ClusterNodeRole, RunQueryMode } from 'src/modules/workbench/dto/create-command-execution.dto';
+import { ClusterNodeRole, RunQueryMode, ResultsMode } from 'src/modules/workbench/dto/create-command-execution.dto';
 import { ClusterSingleNodeOptions } from 'src/modules/cli/dto/cli.dto';
 import { Expose } from 'class-transformer';
 
+export class ResultsSummary {
+  @ApiProperty({
+    description: 'Total number of commands executed',
+    type: Number,
+  })
+  @IsDefined()
+  total: number;
+
+  @ApiProperty({
+    description: 'Total number of successful commands executed',
+    type: Number,
+  })
+  @IsDefined()
+  success: number;
+
+  @ApiProperty({
+    description: 'Total number of failed commands executed',
+    type: Number,
+  })
+  @IsDefined()
+  fail: number;
+}
+
 export class CommandExecution {
   @ApiProperty({
     description: 'Command execution id',
@@ -34,6 +58,21 @@ export class CommandExecution {
   @Expose()
   mode?: RunQueryMode = RunQueryMode.ASCII;
 
+  @ApiPropertyOptional({
+    description: 'Workbench result mode',
+    default: ResultsMode.Default,
+    enum: ResultsMode,
+  })
+  @Expose()
+  resultsMode?: ResultsMode = ResultsMode.Default;
+
+  @ApiPropertyOptional({
+    description: 'Workbench executions summary',
+    type: () => ResultsSummary,
+  })
+  @Expose()
+  summary?: ResultsSummary;
+
   @ApiProperty({
     description: 'Command execution result',
     type: () => CommandExecutionResult,
@@ -42,6 +81,13 @@ export class CommandExecution {
   @Expose()
   result: CommandExecutionResult[];
 
+  @ApiPropertyOptional({
+    description: 'Result did not stored in db',
+    type: Boolean,
+  })
+  @Expose()
+  isNotStored?: boolean;
+
   @ApiPropertyOptional({
     description: 'Nodes roles where command was executed',
     default: ClusterNodeRole.All,

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

@@ -7,6 +7,7 @@ import {
   ClusterNodeRole,
   CreateCommandExecutionDto,
   RunQueryMode,
+  ResultsMode,
 } from 'src/modules/workbench/dto/create-command-execution.dto';
 import { CommandExecutionResult } from 'src/modules/workbench/models/command-execution-result';
 import { CommandExecutionStatus } from 'src/modules/cli/dto/cli.dto';
@@ -34,6 +35,7 @@ const mockCreateCommandExecutionDto: CreateCommandExecutionDto = {
   },
   role: ClusterNodeRole.All,
   mode: RunQueryMode.ASCII,
+  resultsMode: ResultsMode.Default,
 };
 
 const mockCommandExecutionResults: CommandExecutionResult[] = [

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

@@ -140,6 +140,33 @@ describe('CommandExecutionProvider', () => {
         }),
       ]));
     });
+    it('should return with flag isNotStored="true" even if size limit exceeded', async () => {
+      repository.save.mockReturnValueOnce([mockCommandExecutionEntity]);
+      encryptionService.encrypt.mockReturnValue(mockEncryptResult);
+
+      const executionResult = [new CommandExecutionResult({
+        status: CommandExecutionStatus.Success,
+        response: `${Buffer.alloc(WORKBENCH_CONFIG.maxResultSize, 'a').toString()}`,
+      })];
+
+      expect(await service.createMany([{
+        ...mockCommandExecutionPartial,
+        result: executionResult,
+      }])).toEqual([new CommandExecution({
+        ...mockCommandExecutionPartial,
+        id: mockCommandExecutionEntity.id,
+        createdAt: mockCommandExecutionEntity.createdAt,
+        result: executionResult,
+        isNotStored: true,
+      })]);
+
+      expect(encryptionService.encrypt).toHaveBeenLastCalledWith(JSON.stringify([
+        new CommandExecutionResult({
+          status: CommandExecutionStatus.Success,
+          response: 'Results have been deleted since they exceed 1 MB. Re-run the command to see new results.',
+        }),
+      ]));
+    })
   });
   describe('getList', () => {
     it('should return list (2) of command execution', async () => {

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) => {
+    let entities = await Promise.all(commandExecutions.map(async (commandExecution, idx) => {
       const entity = plainToClass(CommandExecutionEntity, commandExecution);
 
       // Do not store command execution result that exceeded limitation
@@ -42,6 +42,8 @@ export class CommandExecutionProvider {
             response: ERROR_MESSAGES.WORKBENCH_RESPONSE_TOO_BIG(),
           },
         ]);
+        // Hack, do not store isNotStored. Send once to show warning
+        entity['isNotStored'] = true;
       }
 
       return this.encryptEntity(entity);
@@ -58,6 +60,7 @@ export class CommandExecutionProvider {
           mode: commandExecutions[idx].mode,
           result: commandExecutions[idx].result,
           nodeOptions: commandExecutions[idx].nodeOptions,
+          summary: commandExecutions[idx].summary,
         },
       )),
     );
@@ -81,7 +84,18 @@ export class CommandExecutionProvider {
     const entities = await this.commandExecutionRepository
       .createQueryBuilder('e')
       .where({ databaseId })
-      .select(['e.id', 'e.command', 'e.databaseId', 'e.createdAt', 'e.encryption', 'e.role', 'e.nodeOptions', 'e.mode'])
+      .select([
+        'e.id',
+        'e.command',
+        'e.databaseId',
+        'e.createdAt',
+        'e.encryption',
+        'e.role',
+        'e.nodeOptions',
+        'e.mode',
+        'e.summary',
+        'e.resultsMode',
+      ])
       .orderBy('e.createdAt', 'DESC')
       .limit(WORKBENCH_CONFIG.maxItemsPerDb)
       .getMany();

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

@@ -20,8 +20,8 @@ import { PluginCommandsWhitelistProvider } from 'src/modules/workbench/providers
 import { PluginsController } from 'src/modules/workbench/plugins.controller';
 import { PluginStateProvider } from 'src/modules/workbench/providers/plugin-state.provider';
 import { PluginStateEntity } from 'src/modules/workbench/entities/plugin-state.entity';
-import { WorkbenchAnalyticsService } from './services/workbench-analytics/workbench-analytics.service';
 import config from 'src/utils/config';
+import { WorkbenchAnalyticsService } from './services/workbench-analytics/workbench-analytics.service';
 
 const COMMANDS_CONFIGS = config.get('commands');
 
@@ -52,7 +52,7 @@ const COMMANDS_CONFIGS = config.get('commands');
       provide: CommandsService,
       useFactory: () => new CommandsService(
         COMMANDS_CONFIGS.map(({ name, url }) => new CommandsJsonProvider(name, url)),
-      ) 
+      ),
     },
     PluginsService,
     PluginCommandsWhitelistProvider,