#RI-2509-add wb group mode (#1122)

* #RI-2509-add wb group mode

Author: AmirAllayarovSofteq

redisinsight/api/migration/1662523634724-workbench-summary.ts

@@ -0,0 +1,24 @@
+import {MigrationInterface, QueryRunner} from "typeorm";
+
+export class workbenchSummary1662523634724 implements MigrationInterface {
+    name = 'workbenchSummary1662523634724'
+
+    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, "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 { workbenchSummary1662523634724 } from './1662523634724-workbench-summary';
 
 export default [
   initialMigration1614164490968,
@@ -36,4 +37,5 @@ export default [
   notification1655821010349,
   notificationCategory1659687030433,
   workbenchMode1660664717573,
+  workbenchSummary1662523634724,
 ];

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

@@ -1,6 +1,6 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import {
-  IsEnum, IsNotEmpty, IsNotEmptyObject, IsOptional, IsString, ValidateNested,
+  IsBoolean, IsEnum, IsNotEmpty, IsNotEmptyObject, IsOptional, IsString, ValidateNested,
 } from 'class-validator';
 import { Type } from 'class-transformer';
 import { ClusterSingleNodeOptions } from 'src/modules/cli/dto/cli.dto';
@@ -38,6 +38,14 @@ export class CreateCommandExecutionDto {
   })
   mode?: RunQueryMode = RunQueryMode.ASCII;
 
+  @ApiPropertyOptional({
+    description: 'Workbench group mode',
+    default: false,
+  })
+  @IsOptional()
+  @IsBoolean()
+  isGroupMode?: boolean;
+
   @ApiPropertyOptional({
     description: 'Execute command for nodes with defined role',
     default: ClusterNodeRole.All,

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,
+  IsBoolean, IsEnum, IsArray, IsNotEmptyObject, IsOptional, ArrayNotEmpty, ValidateNested,
 } from 'class-validator';
 import { Type } from 'class-transformer';
 import { ClusterSingleNodeOptions } from 'src/modules/cli/dto/cli.dto';
@@ -29,6 +29,14 @@ export class CreateCommandExecutionsDto {
   })
   mode?: RunQueryMode = RunQueryMode.ASCII;
 
+  @ApiPropertyOptional({
+    description: 'Workbench group mode',
+    default: false,
+  })
+  @IsOptional()
+  @IsBoolean()
+  isGroupMode?: boolean;
+
   @ApiPropertyOptional({
     description: 'Execute command for nodes with defined role',
     default: ClusterNodeRole.All,

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

@@ -43,6 +43,9 @@ export class CommandExecutionEntity {
   @Column({ nullable: true })
   role?: string;
 
+  @Column({ nullable: true })
+  summary?: string;
+
   @Column({ nullable: true })
   @Transform((object) => JSON.stringify(object), { toClassOnly: true })
   @Transform((string) => {

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

@@ -34,6 +34,13 @@ export class CommandExecution {
   @Expose()
   mode?: RunQueryMode = RunQueryMode.ASCII;
 
+  @ApiPropertyOptional({
+    description: 'Workbench executions summary',
+    type: String,
+  })
+  @Expose()
+  summary?: string;
+
   @ApiProperty({
     description: 'Command execution result',
     type: () => CommandExecutionResult,

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

@@ -81,7 +81,17 @@ 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',
+      ])
       .orderBy('e.createdAt', 'DESC')
       .limit(WORKBENCH_CONFIG.maxItemsPerDb)
       .getMany();

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

@@ -52,6 +52,57 @@ export class WorkbenchService {
     return commandExecution;
   }
 
+  /**
+   * Send redis command from workbench and save history
+   *
+   * @param clientOptions
+   * @param dto
+   */
+  async createCommandsExecution(
+    clientOptions: IFindRedisClientInstanceByOptions,
+    dto: Partial<CreateCommandExecutionDto>,
+    commands: string[],
+  ): Promise<Partial<CommandExecution>> {
+    const commandExecution: Partial<CommandExecution> = {
+      ...dto,
+      databaseId: clientOptions.instanceId,
+    };
+
+    const executionResults = await Promise.all(commands.map(async (singleCommand) => {
+      const command = multilineCommandToOneLine(singleCommand);
+      const deprecatedCommand = this.findCommandInBlackList(command);
+      if (deprecatedCommand) {
+        return {
+          [command]: [
+            {
+              response: ERROR_MESSAGES.WORKBENCH_COMMAND_NOT_SUPPORTED(deprecatedCommand.toUpperCase()),
+              status: CommandExecutionStatus.Fail,
+            },
+          ],
+        };
+      }
+      return ({ [command]: await this.commandsExecutor.sendCommand(clientOptions, { ...dto, command }) });
+    }));
+
+    const successCommands = executionResults.filter(
+      (command) => Object.values(command)[0][0].status === CommandExecutionStatus.Success,
+    );
+    const failedCommands = executionResults.filter(
+      (command) => Object.values(command)[0][0].status === CommandExecutionStatus.Fail,
+    );
+
+    commandExecution.summary = `
+      ${executionResults.length} Commands - ${successCommands.length} success, ${failedCommands.length} errors
+    `;
+    commandExecution.command = commands.join('\r\n');
+    commandExecution.result = [{
+      status: CommandExecutionStatus.Success,
+      response: executionResults,
+    }];
+
+    return commandExecution;
+  }
+
   /**
    * Send redis command from workbench and save history
    *
@@ -62,6 +113,11 @@ export class WorkbenchService {
     clientOptions: IFindRedisClientInstanceByOptions,
     dto: CreateCommandExecutionsDto,
   ): Promise<CommandExecution[]> {
+    if (dto.isGroupMode) {
+      return this.commandExecutionProvider.createMany(
+        [await this.createCommandsExecution(clientOptions, dto, dto.commands)],
+      );
+    }
     // todo: rework to support pipeline
     // prepare and execute commands
     const commandExecutions = await Promise.all(

redisinsight/ui/src/assets/img/icons/group_mode.svg

@@ -30,6 +30,7 @@ export interface Props {
   result: Maybe<CommandExecutionResult[]>
   activeMode: RunQueryMode
   mode: RunQueryMode
+  summary?: string
   createdAt?: Date
   loading?: boolean
   onQueryDelete: () => void
@@ -47,6 +48,7 @@ const QueryCard = (props: Props) => {
     result,
     activeMode,
     mode,
+    summary,
     isOpen,
     createdAt,
     onQueryOpen,
@@ -146,6 +148,7 @@ const QueryCard = (props: Props) => {
           selectedValue={selectedViewValue}
           activeMode={activeMode}
           mode={mode}
+          summary={summary}
           toggleOpen={toggleOpen}
           toggleFullScreen={toggleFullScreen}
           setSelectedValue={changeViewTypeSelected}
@@ -179,6 +182,7 @@ const QueryCard = (props: Props) => {
                     <QueryCardCliResult
                       loading={loading}
                       query={command}
+                      summary={summary}
                       result={result}
                     />
                   )}