Merge pull request #1285 from RedisInsight/bugfix/RI-3612_infinity_score_zset

#RI-3612-zset infinity score

Author: AlenaSY

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

@@ -1 +1,2 @@
 export * from './redis-string';
+export * from './zset-score';

redisinsight/api/src/common/decorators/zset-score/index.ts

@@ -0,0 +1 @@
+export * from './zset-score.decorator';

redisinsight/api/src/common/decorators/zset-score/zset-score.decorator.ts

@@ -0,0 +1,17 @@
+import {
+  registerDecorator,
+  ValidationOptions,
+} from 'class-validator';
+import { ZSetScoreValidator } from 'src/common/validators';
+
+export function isZSetScore(validationOptions?: ValidationOptions) {
+  return (object: any, propertyName: string) => {
+    registerDecorator({
+      name: 'isZSetScore',
+      target: object.constructor,
+      propertyName,
+      options: validationOptions,
+      validator: ZSetScoreValidator,
+    });
+  };
+}

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

@@ -1 +1,2 @@
 export * from './redis-string.validator';
+export * from './zset-score.validator';

redisinsight/api/src/common/validators/zset-score.validator.ts

@@ -0,0 +1,17 @@
+import { isNumber } from 'lodash';
+import {
+  ValidationArguments,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
+
+@ValidatorConstraint({ name: 'RedisStringValidator', async: true })
+export class ZSetScoreValidator implements ValidatorConstraintInterface {
+  async validate(value: any) {
+    return value === 'inf' || value === '-inf' || isNumber(value);
+  }
+
+  defaultMessage(args: ValidationArguments) {
+    return `${args.property || 'field'} must be a string or a number`;
+  }
+}

redisinsight/api/src/modules/browser/__mocks__/z-set.ts

@@ -8,12 +8,21 @@ import { SortOrder } from 'src/constants';
 
 export const mockZSetMemberDto: ZSetMemberDto = {
   name: Buffer.from('member1'),
-  score: 0,
+  score: '-inf',
 };
 export const mockZSetMemberDto2: ZSetMemberDto = {
   name: Buffer.from('member2'),
+  score: 0,
+};
+export const mockZSetMemberDto3: ZSetMemberDto = {
+  name: Buffer.from('member3'),
   score: 2,
 };
+
+export const mockZSetMemberDto4: ZSetMemberDto = {
+  name: Buffer.from('member4'),
+  score: 'inf',
+};
 export const mockGetMembersDto: GetZSetMembersDto = {
   keyName: Buffer.from('zSet'),
   offset: 0,
@@ -28,7 +37,7 @@ export const mockSearchMembersDto: SearchZSetMembersDto = {
 };
 export const mockAddMembersDto: AddMembersToZSetDto = {
   keyName: mockGetMembersDto.keyName,
-  members: [mockZSetMemberDto, mockZSetMemberDto2],
+  members: [mockZSetMemberDto, mockZSetMemberDto2, mockZSetMemberDto3, mockZSetMemberDto4],
 };
 export const mockUpdateMemberDto: UpdateMemberInZSetDto = {
   keyName: mockGetMembersDto.keyName,
@@ -39,10 +48,14 @@ export const mockMembersForZAddCommand = [
   mockZSetMemberDto.name,
   mockZSetMemberDto2.score,
   mockZSetMemberDto2.name,
+  mockZSetMemberDto3.score,
+  mockZSetMemberDto3.name,
+  mockZSetMemberDto4.score,
+  mockZSetMemberDto4.name,
 ];
 export const mockDeleteMembersDto: DeleteMembersFromZSetDto = {
   keyName: mockAddMembersDto.keyName,
-  members: [mockZSetMemberDto.name, mockZSetMemberDto2.name],
+  members: [mockZSetMemberDto.name, mockZSetMemberDto2.name, mockZSetMemberDto3.name, mockZSetMemberDto4.name],
 };
 export const getZSetMembersInAscResponse = {
   keyName: mockGetMembersDto.keyName,

redisinsight/api/src/modules/browser/dto/z-set.dto.ts

@@ -9,7 +9,7 @@ import {
   IsNotEmptyObject,
   IsNumber, IsString,
   Min,
-  ValidateNested
+  ValidateNested,
 } from 'class-validator';
 import { Type } from 'class-transformer';
 import { SortOrder } from 'src/constants';
@@ -18,7 +18,7 @@ import {
   DeleteMembersFromSetResponse,
 } from 'src/modules/browser/dto/set.dto';
 import { RedisString } from 'src/common/constants';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import { IsRedisString, RedisStringType, isZSetScore } from 'src/common/decorators';
 import {
   KeyDto, KeyResponse, KeyWithExpireDto, ScanDataTypeDto,
 } from './keys.dto';
@@ -77,13 +77,12 @@ export class ZSetMemberDto {
 
   @ApiProperty({
     description: 'Member score value.',
-    type: Number,
+    type: Number || String,
     default: 1,
   })
   @IsDefined()
-  @IsNumber({ maxDecimalPlaces: 15 })
-  @Type(() => Number)
-  score: number;
+  @isZSetScore()
+  score: number | 'inf' | '-inf';
 }
 
 export class AddMembersToZSetDto extends KeyDto {

redisinsight/api/src/modules/browser/services/z-set-business/z-set-business.service.spec.ts

@@ -184,7 +184,7 @@ describe('ZSetBusinessService', () => {
           BrowserToolZSetCommands.ZRange,
           expect.anything(),
         )
-        .mockResolvedValue(['member1', '0', 'member2', '2']);
+        .mockResolvedValue(['member1', '-inf', 'member2', '0', 'member3', '2', 'member4', 'inf']);
 
       const result = await service.getMembers(
         mockClientOptions,
@@ -199,7 +199,7 @@ describe('ZSetBusinessService', () => {
           BrowserToolZSetCommands.ZRevRange,
           expect.anything(),
         )
-        .mockResolvedValue(['member2', '2', 'member1', '0']);
+        .mockResolvedValue(['member4', 'inf', 'member3', '2', 'member2', '0', 'member1', '-inf']);
 
       const result = await service.getMembers(mockClientOptions, {
         ...mockGetMembersDto,
@@ -485,7 +485,7 @@ describe('ZSetBusinessService', () => {
           BrowserToolZSetCommands.ZScan,
           expect.anything(),
         )
-        .mockResolvedValue([0, ['member1', '0', 'member2', '2']]);
+        .mockResolvedValue([0, ['member1', '-inf', 'member2', '0', 'member3', '2', 'member4', 'inf']]);
 
       const result = await service.searchMembers(
         mockClientOptions,

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

@@ -5,7 +5,7 @@ import {
   Logger,
   NotFoundException,
 } from '@nestjs/common';
-import { isNull } from 'lodash';
+import { isNull, isNaN } from 'lodash';
 import * as isGlob from 'is-glob';
 import config from 'src/utils/config';
 import { catchAclError, catchTransactionError, unescapeGlob } from 'src/utils';
@@ -277,8 +277,10 @@ export class ZSetBusinessService {
           BrowserToolZSetCommands.ZScore,
           [keyName, member],
         );
+        const formattedScore = isNaN(parseFloat(score)) ? String(score) : parseFloat(score);
+
         if (!isNull(score)) {
-          result.members.push(plainToClass(ZSetMemberDto, { name: member, score }));
+          result.members.push(plainToClass(ZSetMemberDto, { name: member, score: formattedScore }));
         }
       } else {
         const scanResult = await this.scanZSet(clientOptions, dto);
@@ -375,7 +377,6 @@ export class ZSetBusinessService {
       nextCursor: null,
       members: [],
     };
-
     while (result.nextCursor !== 0 && result.members.length < count) {
       const scanResult = await this.browserTool.execCommand(
         clientOptions,
@@ -406,11 +407,13 @@ export class ZSetBusinessService {
     const result: ZSetMemberDto[] = [];
     while (reply.length) {
       const member = reply.splice(0, 2);
+      const score = isNaN(parseFloat(member[1])) ? String(member[1]) : parseFloat(member[1]);
       result.push(plainToClass(ZSetMemberDto, {
         name: member[0],
-        score: parseFloat(member[1]),
+        score,
       }));
     }
+
     return result;
   }
 

redisinsight/api/test/api/z-set/PATCH-instance-id-zSet.test.ts

@@ -22,9 +22,9 @@ const dataSchema = Joi.object({
   member: Joi.object().keys({
     name: Joi.string().required(),
     // todo: allow(true) - is incorrect but will be transformed to number by BE. Investigate/fix it
-    score: Joi.number().required().allow(true),
+    score: Joi.number().required().allow('inf', '-inf').label('.score'),
   }).messages({
-    'number.base': '{#lavel} must be a number',
+    'number.base': '{#lavel} must be a string or a number',
   }),
 }).strict();