#RI-4815 change implementation

Author: irinaAbramova-dev

redisinsight/api/src/common/decorators/index.ts

@@ -6,3 +6,4 @@ export * from './session';
 export * from './client-metadata';
 export * from './object-as-map.decorator';
 export * from './is-multi-number.decorator';
+export * from './is-bigger-than.decorator';

redisinsight/api/src/common/decorators/is-bigger-than.decorator.ts

@@ -0,0 +1,18 @@
+import {
+  registerDecorator,
+  ValidationOptions,
+} from 'class-validator';
+import { BiggerThan } from 'src/common/validators/bigger-than.validator';
+
+export function IsBiggerThan(property: string, validationOptions?: ValidationOptions) {
+  return (object: any, propertyName: string) => {
+    registerDecorator({
+      name: 'IsBiggerThan',
+      target: object.constructor,
+      propertyName,
+      constraints: [property],
+      options: validationOptions,
+      validator: BiggerThan,
+    });
+  };
+}

redisinsight/api/src/common/validators/bigger-than.validator.ts

@@ -0,0 +1,18 @@
+import {
+  ValidationArguments,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
+
+@ValidatorConstraint({ name: 'BiggerThan', async: true })
+export class BiggerThan implements ValidatorConstraintInterface {
+  validate(value: any, args: ValidationArguments) {
+    const [relatedPropertyName] = args.constraints;
+    const relatedValue = (args.object as any)[relatedPropertyName];
+    return typeof value === 'number' && typeof relatedValue === 'number' && value > relatedValue;
+  }
+
+  defaultMessage(args: ValidationArguments) {
+    return `${args.property} must be a greater than ${args.constraints.join(', ')}`;
+  }
+}

redisinsight/api/src/common/validators/index.ts

@@ -1,3 +1,4 @@
 export * from './redis-string.validator';
 export * from './zset-score.validator';
 export * from './multi-number.validator';
+export * from './bigger-than.validator';

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

@@ -76,7 +76,7 @@ export class StringController extends BaseController {
     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('Content-Disposition', 'attachment;filename="string_value"');
     res.setHeader('Access-Control-Expose-Headers', 'Content-Disposition');
 
     stream

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

@@ -5,20 +5,32 @@ import {
   IsDefined, IsInt, IsOptional, Min,
 } from 'class-validator';
 import { RedisString } from 'src/common/constants';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import { IsRedisString, RedisStringType, IsBiggerThan } 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',
+    description: 'Start of string',
+    type: Number,
+    default: 0,
+  })
+  @IsOptional()
+  @IsInt({ always: true })
+  @Type(() => Number)
+  @Min(0)
+  start?: number = 0;
+
+  @ApiProperty({
+    description: 'End of string',
     type: Number,
   })
   @IsOptional()
   @IsInt({ always: true })
   @Type(() => Number)
   @Min(1)
-  stringMaxLen?: number;
+  @IsBiggerThan('start')
+  end?: number;
 }
 
 export class SetStringDto extends KeyDto {

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

@@ -69,24 +69,31 @@ export class StringBusinessService {
     this.logger.log('Succeed to set string key type.');
   }
 
-  private async getStringValueFromClient(
+  public async getStringValue(
     clientMetadata: ClientMetadata,
-    keyName: RedisString,
-    args = [],
-    toolCommand = BrowserToolStringCommands.Get,
+    dto: GetStringInfoDto,
   ): Promise<GetStringValueResponse> {
     this.logger.log('Getting string value.');
 
-    const scanArgs = [keyName, ...args];
+    const { keyName, start, end } = dto;
     let result: GetStringValueResponse;
 
     try {
-      const value = await this.browserTool.execCommand(
-        clientMetadata,
-        toolCommand,
-        scanArgs,
-      );
-      result = { value, keyName };
+      if (end) {
+        const value = await this.browserTool.execCommand(
+          clientMetadata,
+          BrowserToolStringCommands.Getrange,
+          [keyName, `${start}`, `${end}`],
+        );
+        result = { value, keyName };
+      } else {
+        const value = await this.browserTool.execCommand(
+          clientMetadata,
+          BrowserToolStringCommands.Get,
+          [keyName],
+        );
+        result = { value, keyName };
+      }
     } catch (error) {
       this.logger.error('Failed to get string value.', error);
       if (error.message.includes(RedisErrorCodes.WrongType)) {
@@ -109,35 +116,19 @@ export class StringBusinessService {
     );
     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(
+    const result = await this.getStringValue(
       clientMetadata,
-      keyName,
+      dto,
     );
 
-    const stream = Readable.from(`"${result.value}"`);
+    const stream = Readable.from(result.value);
     return { stream };
   }
 

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

@@ -7,7 +7,7 @@ import {
   generateInvalidDataTestCases,
   validateInvalidDataTestCase,
   getMainCheckFn
-} from '../deps';
+} from '../deps'
 const { server, request, constants, rte } = deps;
 
 // endpoint to test
@@ -27,7 +27,7 @@ const mainCheckFn = getMainCheckFn(endpoint);
 
 describe('POST /databases/:instanceId/string/download-value', () => {
   describe('Main', () => {
-    before(() => rte.data.generateKeys(true));
+    before(() => rte.data.generateBinKeys(true));
 
     describe('Validation', () => {
       generateInvalidDataTestCases(dataSchema, validInputData).map(
@@ -40,19 +40,19 @@ describe('POST /databases/:instanceId/string/download-value', () => {
         {
           name: 'Should download value',
           data: {
-            keyName: constants.TEST_STRING_KEY_1,
+            keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
           },
           responseHeaders: {
             'content-type': 'application/octet-stream',
-            'content-disposition': 'attachment;filename="string_value.txt"',
+            'content-disposition': 'attachment;filename="string_value"',
             'access-control-expose-headers': 'Content-Disposition',
           },
-          responseBody: Buffer.from(`"${constants.TEST_STRING_VALUE_1}"`),
+          responseBody: constants.TEST_STRING_VALUE_BIN_BUFFER_1,
         },
         {
           name: 'Should return an error when incorrect type',
           data: {
-            keyName: constants.TEST_LIST_KEY_1,
+            keyName: constants.TEST_LIST_KEY_BIN_BUF_OBJ_1,
           },
           statusCode: 400,
           responseBody: {
@@ -64,7 +64,7 @@ describe('POST /databases/:instanceId/string/download-value', () => {
           name: 'Should return NotFound error if instance id does not exists',
           endpoint: () => endpoint(constants.TEST_NOT_EXISTED_INSTANCE_ID),
           data: {
-            keyName: constants.TEST_STRING_KEY_1,
+            keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
           },
           statusCode: 404,
           responseBody: {
@@ -85,14 +85,14 @@ describe('POST /databases/:instanceId/string/download-value', () => {
           name: 'Should download value',
           endpoint: () => endpoint(constants.TEST_INSTANCE_ACL_ID),
           data: {
-            keyName: constants.TEST_STRING_KEY_1,
+            keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
           },
           responseHeaders: {
             'content-type': 'application/octet-stream',
-            'content-disposition': 'attachment;filename="string_value.txt"',
+            'content-disposition': 'attachment;filename="string_value"',
             'access-control-expose-headers': 'Content-Disposition',
           },
-          responseBody: Buffer.from(`"${constants.TEST_STRING_VALUE_1}"`),
+          responseBody: constants.TEST_STRING_VALUE_BIN_BUFFER_1,
         },
         {
           name: 'Should throw error if no permissions for "set" command',

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

@@ -1,14 +1,12 @@
 import {
-  expect,
   describe,
-  it,
   before,
   Joi,
   deps,
   requirements,
   generateInvalidDataTestCases,
   validateInvalidDataTestCase,
-  validateApiCall, getMainCheckFn, JoiRedisString
+  getMainCheckFn, JoiRedisString
 } from '../deps';
 const { server, request, constants, rte } = deps;
 
@@ -87,6 +85,36 @@ describe('POST /databases/:instanceId/string/get-value', () => {
           value: constants.TEST_STRING_VALUE_BIN_BUF_OBJ_1,
         },
       },
+      {
+        name: 'Should return part of value in buffer (only "end")',
+        query: {
+          encoding: 'buffer',
+        },
+        data: {
+          keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
+          end: constants.TEST_STRING_KEY_END
+        },
+        responseBody: {
+          keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
+          value: constants.TEST_STRING_PARTIAL_VALUE_BIN_BUF_OBJ_1,
+        },
+        statusCode: 404,
+      },
+      {
+        name: 'Should return part of value in buffer ("start" & "end")',
+        query: {
+          encoding: 'buffer',
+        },
+        data: {
+          keyName: constants.TEST_STRING_KEY_BIN_ASCII_1,
+          start: constants.TEST_STRING_KEY_START_2,
+          end: constants.TEST_STRING_KEY_END
+        },
+        responseBody: {
+          keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
+          value: constants.TEST_STRING_PARTIAL_VALUE_BIN_BUF_OBJ_2,
+        },
+      },
       {
         name: 'Should return error when send unicode with unprintable chars',
         query: {
@@ -122,14 +150,14 @@ describe('POST /databases/:instanceId/string/get-value', () => {
           },
         },
         {
-          name: 'Should get part of value (specified length)',
+          name: 'Should get part of value',
           data: {
             keyName: constants.TEST_STRING_KEY_1,
-            stringMaxLen: constants.TEST_STRING_KEY_LENGTH
+            end: constants.TEST_STRING_KEY_END
           },
           responseBody: {
             keyName: constants.TEST_STRING_KEY_1,
-            value: constants.TEST_STRING_VALUE_1.slice(0, constants.TEST_STRING_KEY_LENGTH),
+            value: constants.TEST_STRING_VALUE_1.slice(constants.TEST_STRING_KEY_START_1, constants.TEST_STRING_KEY_END + 1),
           },
         },
         {
@@ -145,10 +173,23 @@ describe('POST /databases/:instanceId/string/get-value', () => {
           },
         },
         {
-          name: 'Should return an error when incorrect string length',
+          name: 'Should return an error when incorrect end of string',
+          data: {
+            keyName: constants.TEST_STRING_KEY_1,
+            end: 0
+          },
+          statusCode: 400,
+          responseBody: {
+            statusCode: 400,
+            error: 'Bad Request',
+          },
+        },
+        {
+          name: 'Should return an error when start of string greater than end',
           data: {
             keyName: constants.TEST_STRING_KEY_1,
-            stringMaxLen: 0
+            start: 10,
+            end: 9
           },
           statusCode: 400,
           responseBody: {

redisinsight/api/test/helpers/constants.ts

@@ -160,14 +160,18 @@ 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,
+  TEST_STRING_VALUE_BIN_BUFFER_1: Buffer.concat([Buffer.from(TEST_RUN_ID), Buffer.from('strv'), unprintableBuf]),
+  TEST_STRING_KEY_START_1: 0,
+  TEST_STRING_KEY_START_2: 2,
+  TEST_STRING_KEY_END: 9,
   get TEST_STRING_KEY_BIN_BUF_OBJ_1() { return { type: 'Buffer', data: [...this.TEST_STRING_KEY_BIN_BUFFER_1] } },
+  get TEST_STRING_VALUE_BIN_BUF_OBJ_1() { return { type: 'Buffer', data: [...this.TEST_STRING_VALUE_BIN_BUFFER_1] } },
+  get TEST_STRING_PARTIAL_VALUE_BIN_BUF_OBJ_1() { return { type: 'Buffer', data: [...this.TEST_STRING_VALUE_BIN_BUFFER_1.slice(this.TEST_STRING_KEY_START_1, this.TEST_STRING_KEY_END + 1)] } },
+  get TEST_STRING_PARTIAL_VALUE_BIN_BUF_OBJ_2() { return { type: 'Buffer', data: [...this.TEST_STRING_VALUE_BIN_BUFFER_1.slice(this.TEST_STRING_KEY_START_2, this.TEST_STRING_KEY_END + 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') },
-  TEST_STRING_VALUE_BIN_BUFFER_1:  Buffer.concat([Buffer.from(TEST_RUN_ID), Buffer.from('strv'), unprintableBuf]),
   get TEST_STRING_VALUE_BIN_ASCII_1() { return getASCIISafeStringFromBuffer(this.TEST_STRING_VALUE_BIN_BUFFER_1) },
   get TEST_STRING_VALUE_BIN_UTF8_1() { return this.TEST_STRING_VALUE_BIN_BUFFER_1.toString('utf-8') },
-  get TEST_STRING_VALUE_BIN_BUF_OBJ_1() { return { type: 'Buffer', data: [...this.TEST_STRING_VALUE_BIN_BUFFER_1] } },
 
   // Redis List
   TEST_LIST_TYPE: 'list',