#RI-2939 BE Delete Consumer Group

Author: Artem

redisinsight/api/src/modules/browser/constants/browser-tool-commands.ts

@@ -84,6 +84,7 @@ export enum BrowserToolStreamCommands {
   XPending = 'xpending',
   XGroupCreate = 'xgroup create',
   XGroupSetId = 'xgroup setid',
+  XGroupDestroy = 'xgroup destroy',
 }
 
 export enum BrowserToolTSCommands {

redisinsight/api/src/modules/browser/controllers/stream/consumer-group.controller.ts

@@ -1,6 +1,6 @@
 import {
   Body,
-  Controller,
+  Controller, Delete,
   Param, Patch,
   Post,
   UsePipes,
@@ -9,7 +9,11 @@ import {
 import { ApiTags } from '@nestjs/swagger';
 import { ApiRedisInstanceOperation } from 'src/decorators/api-redis-instance-operation.decorator';
 import {
-  ConsumerGroupDto, CreateConsumerGroupsDto, UpdateConsumerGroupDto,
+  ConsumerGroupDto,
+  CreateConsumerGroupsDto,
+  DeleteConsumerGroupsDto,
+  DeleteConsumerGroupsResponse,
+  UpdateConsumerGroupDto,
 } from 'src/modules/browser/dto/stream.dto';
 import { ConsumerGroupService } from 'src/modules/browser/services/stream/consumer-group.service';
 import { KeyDto } from 'src/modules/browser/dto';
@@ -63,4 +67,23 @@ export class ConsumerGroupController {
   ): Promise<void> {
     return this.service.updateGroup({ instanceId }, dto);
   }
+
+  @Delete('')
+  @ApiRedisInstanceOperation({
+    description: 'Delete Consumer Group',
+    statusCode: 200,
+    responses: [
+      {
+        status: 200,
+        description: 'Returns number of affected consumer groups.',
+        type: DeleteConsumerGroupsResponse,
+      },
+    ],
+  })
+  async deleteGroup(
+    @Param('dbInstance') instanceId: string,
+      @Body() dto: DeleteConsumerGroupsDto,
+  ): Promise<DeleteConsumerGroupsResponse> {
+    return this.service.deleteGroup({ instanceId }, dto);
+  }
 }

redisinsight/api/src/modules/browser/dto/stream.dto.ts

@@ -258,6 +258,7 @@ export class CreateConsumerGroupsDto extends KeyDto {
   })
   @ValidateNested()
   @IsArray()
+  @ArrayNotEmpty()
   @Type(() => CreateConsumerGroupDto)
   consumerGroups: CreateConsumerGroupDto[];
 }
@@ -266,3 +267,25 @@ export class UpdateConsumerGroupDto extends IntersectionType(
   KeyDto,
   CreateConsumerGroupDto,
 ) {}
+
+export class DeleteConsumerGroupsDto extends KeyDto {
+  @ApiProperty({
+    description: 'Consumer group names',
+    type: String,
+    isArray: true,
+    example: ['Group-1', 'Group-1'],
+  })
+  @IsDefined()
+  @IsArray()
+  @ArrayNotEmpty()
+  @Type(() => String)
+  consumerGroups: string[];
+}
+
+export class DeleteConsumerGroupsResponse {
+  @ApiProperty({
+    description: 'Number of deleted consumer groups',
+    type: Number,
+  })
+  affected: number;
+}

redisinsight/api/src/modules/browser/services/stream/consumer-group.service.ts

@@ -11,7 +11,12 @@ import {
 import { BrowserToolService } from 'src/modules/browser/services/browser-tool/browser-tool.service';
 import { KeyDto } from 'src/modules/browser/dto';
 import ERROR_MESSAGES from 'src/constants/error-messages';
-import {ConsumerGroupDto, CreateConsumerGroupsDto, UpdateConsumerGroupDto} from 'src/modules/browser/dto/stream.dto';
+import {
+  ConsumerGroupDto,
+  CreateConsumerGroupsDto,
+  DeleteConsumerGroupsDto, DeleteConsumerGroupsResponse,
+  UpdateConsumerGroupDto
+} from 'src/modules/browser/dto/stream.dto';
 
 @Injectable()
 export class ConsumerGroupService {
@@ -196,6 +201,63 @@ export class ConsumerGroupService {
     }
   }
 
+  /**
+   * Delete consumer groups in batch
+   * @param clientOptions
+   * @param dto
+   */
+  async deleteGroup(
+    clientOptions: IFindRedisClientInstanceByOptions,
+    dto: DeleteConsumerGroupsDto,
+  ): Promise<DeleteConsumerGroupsResponse> {
+    try {
+      this.logger.log('Deleting consumer group.');
+
+      const exists = await this.browserTool.execCommand(
+        clientOptions,
+        BrowserToolKeysCommands.Exists,
+        [dto.keyName],
+      );
+
+      if (!exists) {
+        return Promise.reject(new NotFoundException(ERROR_MESSAGES.KEY_NOT_EXIST));
+      }
+
+      const toolCommands: Array<[
+        toolCommand: BrowserToolCommands,
+        ...args: Array<string | number>,
+      ]> = dto.consumerGroups.map((group) => (
+        [
+          BrowserToolStreamCommands.XGroupDestroy,
+          dto.keyName,
+          group,
+        ]
+      ));
+
+      const [
+        transactionError,
+        transactionResults,
+      ] = await this.browserTool.execMulti(clientOptions, toolCommands);
+      catchTransactionError(transactionError, transactionResults);
+
+      this.logger.log('Consumer group(s) successfully deleted.');
+
+      return {
+        affected: toolCommands.length,
+      };
+    } catch (error) {
+      if (error instanceof NotFoundException) {
+        throw error;
+      }
+
+      if (error?.message.includes(RedisErrorCodes.WrongType)) {
+        throw new BadRequestException(error.message);
+      }
+
+      throw catchAclError(error);
+    }
+  }
+
   /**
    * Converts RESP response from Redis
    * [