#RI-4815 get a portion of the string [skip ci]

Author: irinaAbramova-dev

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

@@ -14,6 +14,7 @@ export enum BrowserToolKeysCommands {
 export enum BrowserToolStringCommands {
   Set = 'set',
   Get = 'get',
+  Getrange = 'getrange',
   StrLen = 'strlen',
 }
 

redisinsight/api/src/modules/browser/controllers/string/string.controller.ts

@@ -3,7 +3,7 @@ import {
   Controller,
   HttpCode,
   Post,
-  Put,
+  Put, Res,
 } from '@nestjs/common';
 import {
   ApiBody, ApiOkResponse, ApiOperation, ApiTags,
@@ -12,13 +12,15 @@ import { ApiRedisParams } from 'src/decorators/api-redis-params.decorator';
 import {
   SetStringDto,
   GetStringValueResponse,
-  SetStringWithExpireDto,
+  SetStringWithExpireDto, GetStringInfoDto,
 } from 'src/modules/browser/dto/string.dto';
 import { GetKeyInfoDto } from 'src/modules/browser/dto';
 import { BaseController } from 'src/modules/browser/controllers/base.controller';
 import { BrowserClientMetadata } from 'src/modules/browser/decorators/browser-client-metadata.decorator';
 import { ApiQueryRedisStringEncoding } from 'src/common/decorators';
 import { ClientMetadata } from 'src/common/models';
+import { ApiEndpoint } from 'src/decorators/api-endpoint.decorator';
+import { Response } from 'express';
 import { StringBusinessService } from '../../services/string-business/string-business.service';
 
 @ApiTags('String')
@@ -45,19 +47,43 @@ export class StringController extends BaseController {
   @HttpCode(200)
   @ApiOperation({ description: 'Get string value' })
   @ApiRedisParams()
-  @ApiBody({ type: GetKeyInfoDto })
+  @ApiBody({ type: GetStringInfoDto })
   @ApiOkResponse({
     description: 'String value',
     type: GetStringValueResponse,
   })
   @ApiQueryRedisStringEncoding()
   async getStringValue(
     @BrowserClientMetadata() clientMetadata: ClientMetadata,
-      @Body() dto: GetKeyInfoDto,
+      @Body() dto: GetStringInfoDto,
   ): Promise<GetStringValueResponse> {
     return this.stringBusinessService.getStringValue(clientMetadata, dto);
   }
 
+  @ApiEndpoint({
+    description: 'Endpoint do download string value',
+    statusCode: 200,
+  })
+  @Post('/download-value')
+  @ApiRedisParams()
+  @ApiBody({ type: GetKeyInfoDto })
+  @ApiQueryRedisStringEncoding()
+  async downloadStringFile(
+    @Res() res: Response,
+      @BrowserClientMetadata() clientMetadata: ClientMetadata,
+      @Body() dto: GetKeyInfoDto,
+  ): Promise<void> {
+    const { stream } = await this.stringBusinessService.downloadStringValue(clientMetadata, dto);
+
+    res.setHeader('Content-Type', 'application/octet-stream');
+    res.setHeader('Content-Disposition', 'attachment;filename="string_value.txt"');
+    res.setHeader('Access-Control-Expose-Headers', 'Content-Disposition');
+
+    stream
+      .on('error', () => res.status(404).send())
+      .pipe(res);
+  }
+
   @Put('')
   @ApiOperation({ description: 'Update string value' })
   @ApiRedisParams()

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

@@ -1,11 +1,26 @@
 import {
   ApiProperty, IntersectionType,
 } from '@nestjs/swagger';
-import { IsDefined } from 'class-validator';
+import {
+  IsDefined, IsInt, IsOptional, Min,
+} from 'class-validator';
 import { RedisString } from 'src/common/constants';
 import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import { Type } from 'class-transformer';
 import { KeyDto, KeyResponse, KeyWithExpireDto } from './keys.dto';
 
+export class GetStringInfoDto extends KeyDto {
+  @ApiProperty({
+    description: 'Max length of string',
+    type: Number,
+  })
+  @IsOptional()
+  @IsInt({ always: true })
+  @Type(() => Number)
+  @Min(1)
+  stringMaxLen?: number;
+}
+
 export class SetStringDto extends KeyDto {
   @ApiProperty({
     description: 'Key value',

redisinsight/api/src/modules/browser/services/string-business/string-business.service.ts

@@ -9,6 +9,7 @@ import { RECOMMENDATION_NAMES, RedisErrorCodes } from 'src/constants';
 import ERROR_MESSAGES from 'src/constants/error-messages';
 import { catchAclError } from 'src/utils';
 import {
+  GetStringInfoDto,
   GetStringValueResponse,
   SetStringDto,
   SetStringWithExpireDto,
@@ -22,6 +23,8 @@ import { plainToClass } from 'class-transformer';
 import { GetKeyInfoDto } from 'src/modules/browser/dto';
 import { ClientMetadata } from 'src/common/models';
 import { DatabaseRecommendationService } from 'src/modules/database-recommendation/database-recommendation.service';
+import { Readable } from 'stream';
+import { RedisString } from 'src/common/constants';
 
 @Injectable()
 export class StringBusinessService {
@@ -66,20 +69,22 @@ export class StringBusinessService {
     this.logger.log('Succeed to set string key type.');
   }
 
-  public async getStringValue(
+  private async getStringValueFromClient(
     clientMetadata: ClientMetadata,
-    dto: GetKeyInfoDto,
+    keyName: RedisString,
+    args = [],
+    toolCommand = BrowserToolStringCommands.Get,
   ): Promise<GetStringValueResponse> {
     this.logger.log('Getting string value.');
 
-    const { keyName } = dto;
+    const scanArgs = [keyName, ...args];
     let result: GetStringValueResponse;
 
     try {
       const value = await this.browserTool.execCommand(
         clientMetadata,
-        BrowserToolStringCommands.Get,
-        [keyName],
+        toolCommand,
+        scanArgs,
       );
       result = { value, keyName };
     } catch (error) {
@@ -89,20 +94,51 @@ export class StringBusinessService {
       }
       catchAclError(error);
     }
+
     if (result.value === null) {
       this.logger.error(
         `Failed to get string value. Not Found key: ${keyName}.`,
       );
       throw new NotFoundException();
-    } else {
-      this.recommendationService.check(
-        clientMetadata,
-        RECOMMENDATION_NAMES.STRING_TO_JSON,
-        { value: result.value, keyName: result.keyName },
-      );
-      this.logger.log('Succeed to get string value.');
-      return plainToClass(GetStringValueResponse, result);
     }
+
+    this.recommendationService.check(
+      clientMetadata,
+      RECOMMENDATION_NAMES.STRING_TO_JSON,
+      { value: result.value, keyName: result.keyName },
+    );
+    this.logger.log('Succeed to get string value.');
+
+    return result;
+  }
+
+  public async getStringValue(
+    clientMetadata: ClientMetadata,
+    dto: GetStringInfoDto,
+  ): Promise<GetStringValueResponse> {
+    const { keyName, stringMaxLen } = dto;
+    const result: GetStringValueResponse = await this.getStringValueFromClient(
+      clientMetadata,
+      keyName,
+      stringMaxLen ? ['0', `${(stringMaxLen - 1)}`] : [],
+      stringMaxLen ? BrowserToolStringCommands.Getrange : BrowserToolStringCommands.Get,
+    );
+
+    return plainToClass(GetStringValueResponse, result);
+  }
+
+  public async downloadStringValue(
+    clientMetadata: ClientMetadata,
+    dto: GetKeyInfoDto,
+  ): Promise<{ stream: Readable }> {
+    const { keyName } = dto;
+    const result = await this.getStringValueFromClient(
+      clientMetadata,
+      keyName,
+    );
+
+    const stream = Readable.from(`"${result.value}"`);
+    return { stream };
   }
 
   public async updateStringValue(

redisinsight/api/test/api/string/POST-databases-id-string-get_value.test.ts

@@ -48,6 +48,17 @@ describe('POST /databases/:instanceId/string/get-value', () => {
           value: constants.TEST_STRING_VALUE_BIN_UTF8_1,
         },
       },
+      {
+        name: 'Should return part of value in utf8 (specified length)',
+        data: {
+          keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
+          stringMaxLen: constants.TEST_STRING_KEY_LENGTH
+        },
+        responseBody: {
+          keyName: constants.TEST_STRING_KEY_BIN_UTF8_1,
+          value: constants.TEST_STRING_VALUE_BIN_UTF8_1.slice(0, constants.TEST_STRING_KEY_LENGTH),
+        },
+      },
       {
         name: 'Should return value in utf8',
         query: {

redisinsight/api/test/helpers/constants.ts

@@ -160,6 +160,7 @@ export const constants = {
   TEST_STRING_KEY_ASCII_UNICODE: TEST_RUN_ID + '_str_ascii_€' + CLUSTER_HASH_SLOT,
   TEST_STRING_KEY_ASCII_VALUE: TEST_RUN_ID + '_value_ascii',
   TEST_STRING_KEY_BIN_BUFFER_1: Buffer.concat([Buffer.from(TEST_RUN_ID), Buffer.from('strk'), unprintableBuf]),
+  TEST_STRING_KEY_LENGTH: 10,
   get TEST_STRING_KEY_BIN_BUF_OBJ_1() { return { type: 'Buffer', data: [...this.TEST_STRING_KEY_BIN_BUFFER_1] } },
   get TEST_STRING_KEY_BIN_ASCII_1() { return getASCIISafeStringFromBuffer(this.TEST_STRING_KEY_BIN_BUFFER_1) },
   get TEST_STRING_KEY_BIN_UTF8_1() { return this.TEST_STRING_KEY_BIN_BUFFER_1.toString('utf-8') },