#RI-2941 BE Delete consumers from the group

Author: Artem

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

@@ -88,6 +88,7 @@ export enum BrowserToolStreamCommands {
   XGroupCreate = 'xgroup create',
   XGroupSetId = 'xgroup setid',
   XGroupDestroy = 'xgroup destroy',
+  XGroupDelConsumer = 'xgroup delconsumer',
 }
 
 export enum BrowserToolTSCommands {

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

@@ -1,6 +1,6 @@
 import {
   Body,
-  Controller,
+  Controller, Delete,
   Param,
   Post,
   UsePipes,
@@ -11,7 +11,7 @@ import { ApiRedisInstanceOperation } from 'src/decorators/api-redis-instance-ope
 import {
   AckPendingEntriesDto, AckPendingEntriesResponse, ClaimPendingEntriesResponse, ClaimPendingEntryDto,
   ConsumerDto,
-  ConsumerGroupDto,
+  ConsumerGroupDto, DeleteConsumersDto,
   GetConsumersDto, GetPendingEntriesDto, PendingEntryDto,
 } from 'src/modules/browser/dto/stream.dto';
 import { ConsumerService } from 'src/modules/browser/services/stream/consumer.service';
@@ -41,6 +41,18 @@ export class ConsumerController {
     return this.service.getConsumers({ instanceId }, dto);
   }
 
+  @Delete('')
+  @ApiRedisInstanceOperation({
+    description: 'Delete Consumer(s) from the Consumer Group',
+    statusCode: 200,
+  })
+  async deleteConsumers(
+    @Param('dbInstance') instanceId: string,
+      @Body() dto: DeleteConsumersDto,
+  ): Promise<void> {
+    return this.service.deleteConsumers({ instanceId }, dto);
+  }
+
   @Post('/pending-messages/get')
   @ApiRedisInstanceOperation({
     description: 'Get pending entries list',

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

@@ -325,6 +325,20 @@ export class GetConsumersDto extends KeyDto {
   groupName: string;
 }
 
+export class DeleteConsumersDto extends GetConsumersDto {
+  @ApiProperty({
+    description: 'Names of consumers to delete',
+    type: String,
+    isArray: true,
+    example: ['consumer-1', 'consumer-2'],
+  })
+  @IsDefined()
+  @IsArray()
+  @ArrayNotEmpty()
+  @Type(() => String)
+  consumerNames: string[];
+}
+
 export class PendingEntryDto {
   @ApiProperty({
     type: String,

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

@@ -3,15 +3,16 @@ import {
 } from '@nestjs/common';
 import { IFindRedisClientInstanceByOptions } from 'src/modules/core/services/redis/redis.service';
 import { RedisErrorCodes } from 'src/constants';
-import { catchAclError, convertStringsArrayToObject } from 'src/utils';
+import {catchAclError, catchTransactionError, convertStringsArrayToObject} from 'src/utils';
 import {
+  BrowserToolCommands,
   BrowserToolKeysCommands, BrowserToolStreamCommands,
 } from 'src/modules/browser/constants/browser-tool-commands';
 import { BrowserToolService } from 'src/modules/browser/services/browser-tool/browser-tool.service';
 import ERROR_MESSAGES from 'src/constants/error-messages';
 import {
   AckPendingEntriesDto, AckPendingEntriesResponse, ClaimPendingEntriesResponse, ClaimPendingEntryDto,
-  ConsumerDto,
+  ConsumerDto, DeleteConsumersDto,
   GetConsumersDto, GetPendingEntriesDto, PendingEntryDto,
 } from 'src/modules/browser/dto/stream.dto';
 
@@ -61,6 +62,60 @@ export class ConsumerService {
     }
   }
 
+  /**
+   * Get consumers list inside particular group
+   * @param clientOptions
+   * @param dto
+   */
+  async deleteConsumers(
+    clientOptions: IFindRedisClientInstanceByOptions,
+    dto: DeleteConsumersDto,
+  ): Promise<void> {
+    try {
+      this.logger.log('Deleting consumers from the 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.consumerNames.map((consumerName) => (
+        [
+          BrowserToolStreamCommands.XGroupDelConsumer,
+          dto.keyName,
+          dto.groupName,
+          consumerName,
+        ]
+      ));
+
+      const [
+        transactionError,
+        transactionResults,
+      ] = await this.browserTool.execMulti(clientOptions, toolCommands);
+      catchTransactionError(transactionError, transactionResults);
+
+      return undefined;
+    } catch (error) {
+      if (error instanceof NotFoundException) {
+        throw error;
+      }
+
+      if (error?.message.includes(RedisErrorCodes.WrongType)) {
+        throw new BadRequestException(error.message);
+      }
+
+      throw catchAclError(error);
+    }
+  }
+
   /**
    * Get list of pending entries info for particular consumer
    * @param clientOptions