RI-6336 update naming based on feedback from the PR

KIvanow · KIvanow · commit 8f5a315ccb51 · 2025-01-22T14:39:29.000+02:00
diff --git a/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.dto.ts b/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.dto.ts
@@ -11,7 +11,7 @@ export class GetKeyInfoDto extends KeyDto {
     default: false,
   })
   @IsOptional()
-  getSize?: boolean;
+  includeSize?: boolean;
 }
 
 export class GetKeysInfoDto {
@@ -46,13 +46,13 @@ export class GetKeysInfoDto {
     default: true,
   })
   @IsOptional()
-  getSize?: boolean;
+  includeSize?: boolean;
 
   @ApiPropertyOptional({
     description: 'Flag to determine if TTL should be requested and shown in the response',
     type: Boolean,
     default: true,
   })
   @IsOptional()
-  getTtl?: boolean;
+  includeTTL?: boolean;
 }
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/hash.key-info.strategy.spec.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/hash.key-info.strategy.spec.ts
@@ -35,7 +35,7 @@ describe('HashKeyInfoStrategy', () => {
   describe('getInfo', () => {
     const key = getKeyInfoResponse.name;
 
-    describe('when getSize is true', () => {
+    describe('when includeSize is true', () => {
       it('should return all info in single pipeline', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
@@ -60,7 +60,7 @@ describe('HashKeyInfoStrategy', () => {
       });
     });
 
-    describe('when getSize is false', () => {
+    describe('when includeSize is false', () => {
       it('should return appropriate value', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/hash.key-info.strategy.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/hash.key-info.strategy.ts
@@ -12,11 +12,11 @@ export class HashKeyInfoStrategy extends KeyInfoStrategy {
     client: RedisClient,
     key: RedisString,
     type: string,
-    getSize: boolean,
+    includeSize: boolean,
   ): Promise<GetKeyInfoResponse> {
     this.logger.debug(`Getting ${RedisDataType.Hash} type info.`);
 
-    if (getSize !== false) {
+    if (includeSize !== false) {
       const [
         [, ttl = null],
         [, length = null],
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/key-info.strategy.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/key-info.strategy.ts
@@ -11,6 +11,6 @@ export abstract class KeyInfoStrategy {
     client: RedisClient,
     key: RedisString,
     type: string,
-    getSize: boolean,
+    includeSize: boolean,
   ): Promise<GetKeyInfoResponse>;
 }
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/list.key-info.strategy.spec.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/list.key-info.strategy.spec.ts
@@ -35,7 +35,7 @@ describe('ListKeyInfoStrategy', () => {
   describe('getInfo', () => {
     const key = getKeyInfoResponse.name;
 
-    describe('when getSize is true', () => {
+    describe('when includeSize is true', () => {
       it('should return all info in single pipeline', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
@@ -60,7 +60,7 @@ describe('ListKeyInfoStrategy', () => {
       });
     });
 
-    describe('when getSize is false', () => {
+    describe('when includeSize is false', () => {
       it('should return appropriate value', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/list.key-info.strategy.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/list.key-info.strategy.ts
@@ -12,11 +12,10 @@ export class ListKeyInfoStrategy extends KeyInfoStrategy {
     client: RedisClient,
     key: RedisString,
     type: string,
-    getSize: boolean,
+    includeSize: boolean,
   ): Promise<GetKeyInfoResponse> {
     this.logger.debug(`Getting ${RedisDataType.List} type info.`);
-    console.log('getSize getSize getSize')
-    if (getSize !== false) {
+    if (includeSize !== false) {
       const [
         [, ttl = null],
         [, length = null],
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/rejson-rl.key-info.strategy.spec.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/rejson-rl.key-info.strategy.spec.ts
@@ -37,7 +37,7 @@ describe('RejsonRlKeyInfoStrategy', () => {
     const key = getKeyInfoResponse.name;
     const path = '.';
 
-    describe('when getSize is true', () => {
+    describe('when includeSize is true', () => {
       it('should return all info in single pipeline for object type', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
@@ -74,7 +74,7 @@ describe('RejsonRlKeyInfoStrategy', () => {
       });
     });
 
-    describe('when getSize is false', () => {
+    describe('when includeSize is false', () => {
       it('should return appropriate value for key that store object', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/rejson-rl.key-info.strategy.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/rejson-rl.key-info.strategy.ts
@@ -12,11 +12,11 @@ export class RejsonRlKeyInfoStrategy extends KeyInfoStrategy {
     client: RedisClient,
     key: RedisString,
     type: string,
-    getSize: boolean,
+    includeSize: boolean,
   ): Promise<GetKeyInfoResponse> {
     this.logger.debug(`Getting ${RedisDataType.JSON} type info.`);
 
-    if (getSize !== false) {
+    if (includeSize !== false) {
       const [
         [, ttl = null],
         [, size = null],
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/set.key-info.strategy.spec.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/set.key-info.strategy.spec.ts
@@ -35,7 +35,7 @@ describe('SetKeyInfoStrategy', () => {
   describe('getInfo', () => {
     const key = getKeyInfoResponse.name;
 
-    describe('when getSize is true', () => {
+    describe('when includeSize is true', () => {
       it('should return all info in single pipeline', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
@@ -60,7 +60,7 @@ describe('SetKeyInfoStrategy', () => {
       });
     });
 
-    describe('when getSize is false', () => {
+    describe('when includeSize is false', () => {
       it('should return appropriate value', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/set.key-info.strategy.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/set.key-info.strategy.ts
@@ -12,11 +12,11 @@ export class SetKeyInfoStrategy extends KeyInfoStrategy {
     client: RedisClient,
     key: RedisString,
     type: string,
-    getSize: boolean,
+    includeSize: boolean,
   ): Promise<GetKeyInfoResponse> {
     this.logger.debug(`Getting ${RedisDataType.Set} type info.`);
 
-    if (getSize !== false) {
+    if (includeSize !== false) {
       const [
         [, ttl = null],
         [, length = null],
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/stream.key-info.strategy.spec.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/stream.key-info.strategy.spec.ts
@@ -35,7 +35,7 @@ describe('StreamKeyInfoStrategy', () => {
   describe('getInfo', () => {
     const key = getKeyInfoResponse.name;
 
-    describe('when getSize is true', () => {
+    describe('when includeSize is true', () => {
       it('should return all info in single pipeline', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
@@ -60,7 +60,7 @@ describe('StreamKeyInfoStrategy', () => {
       });
     });
 
-    describe('when getSize is false', () => {
+    describe('when includeSize is false', () => {
       it('should return appropriate value', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/stream.key-info.strategy.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/stream.key-info.strategy.ts
@@ -12,11 +12,11 @@ export class StreamKeyInfoStrategy extends KeyInfoStrategy {
     client: RedisClient,
     key: RedisString,
     type: string,
-    getSize: boolean,
+    includeSize: boolean,
   ): Promise<GetKeyInfoResponse> {
     this.logger.debug(`Getting ${RedisDataType.Stream} type info.`);
 
-    if (getSize !== false) {
+    if (includeSize !== false) {
       const [
         [, ttl = null],
         [, length = null],
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/z-set.key-info.strategy.spec.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/z-set.key-info.strategy.spec.ts
@@ -35,7 +35,7 @@ describe('ZSetKeyInfoStrategy', () => {
   describe('getInfo', () => {
     const key = getKeyInfoResponse.name;
 
-    describe('when getSize is true', () => {
+    describe('when includeSize is true', () => {
       it('should return all info in single pipeline', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
@@ -60,7 +60,7 @@ describe('ZSetKeyInfoStrategy', () => {
       });
     });
 
-    describe('when getSize is false', () => {
+    describe('when includeSize is false', () => {
       it('should return appropriate value', async () => {
         when(mockStandaloneRedisClient.sendPipeline)
           .calledWith([
diff --git a/redisinsight/api/src/modules/browser/keys/key-info/strategies/z-set.key-info.strategy.ts b/redisinsight/api/src/modules/browser/keys/key-info/strategies/z-set.key-info.strategy.ts
@@ -12,11 +12,11 @@ export class ZSetKeyInfoStrategy extends KeyInfoStrategy {
     client: RedisClient,
     key: RedisString,
     type: string,
-    getSize: boolean,
+    includeSize: boolean,
   ): Promise<GetKeyInfoResponse> {
     this.logger.debug(`Getting ${RedisDataType.ZSet} type info.`);
 
-    if (getSize !== false) {
+    if (includeSize !== false) {
       const [
         [, ttl = null],
         [, length = null],
diff --git a/redisinsight/api/src/modules/browser/keys/keys.controller.ts b/redisinsight/api/src/modules/browser/keys/keys.controller.ts
@@ -86,7 +86,7 @@ export class KeysController {
     @BrowserClientMetadata() clientMetadata: ClientMetadata,
     @Body() dto: GetKeyInfoDto,
   ): Promise<GetKeyInfoResponse> {
-    return await this.keysService.getKeyInfo(clientMetadata, dto.keyName, dto.getSize);
+    return await this.keysService.getKeyInfo(clientMetadata, dto.keyName, dto.includeSize);
   }
 
   @Delete('')
diff --git a/redisinsight/api/src/modules/browser/keys/keys.service.ts b/redisinsight/api/src/modules/browser/keys/keys.service.ts
@@ -103,7 +103,7 @@ export class KeysService {
     try {
       const client = await this.databaseClientFactory.getOrCreateClient(clientMetadata);
       const scanner = this.scanner.getStrategy(client.getConnectionType());
-      const result = await scanner.getKeysInfo(client, dto.keys, dto.type, dto.getSize, dto.getTtl);
+      const result = await scanner.getKeysInfo(client, dto.keys, dto.type, dto.includeSize, dto.includeTTL);
 
       this.recommendationService.check(
         clientMetadata,
@@ -121,7 +121,7 @@ export class KeysService {
   public async getKeyInfo(
     clientMetadata: ClientMetadata,
     key: RedisString,
-    getSize: boolean = false,
+    includeSize: boolean = false,
   ): Promise<GetKeyInfoResponse> {
     try {
       this.logger.debug('Getting key info.', clientMetadata);
@@ -144,7 +144,7 @@ export class KeysService {
         );
       }
 
-      const result = await this.keyInfoProvider.getStrategy(type).getInfo(client, key, type, getSize);
+      const result = await this.keyInfoProvider.getStrategy(type).getInfo(client, key, type, includeSize);
       this.logger.debug('Succeed to get key info', clientMetadata);
 
       this.recommendationService.checkMulti(
diff --git a/redisinsight/api/src/modules/browser/keys/scanner/scanner.interface.ts b/redisinsight/api/src/modules/browser/keys/scanner/scanner.interface.ts
@@ -31,5 +31,5 @@ export interface IScannerStrategy {
    */
   getKeys(client: RedisClient, args: IScannerGetKeysArgs): Promise<IScannerNodeKeys[]>;
 
-  getKeysInfo(client: RedisClient, keys: RedisString[], type?: RedisDataType, getSize?: boolean, getTtl?: boolean): Promise<GetKeyInfoResponse[]>;
+  getKeysInfo(client: RedisClient, keys: RedisString[], type?: RedisDataType, includeSize?: boolean, includeTTL?: boolean): Promise<GetKeyInfoResponse[]>;
 }
diff --git a/redisinsight/api/src/modules/browser/keys/scanner/strategies/cluster.scanner.strategy.ts b/redisinsight/api/src/modules/browser/keys/scanner/strategies/cluster.scanner.strategy.ts
@@ -182,8 +182,8 @@ export class ClusterScannerStrategy extends ScannerStrategy {
     client: RedisClient,
     keys: RedisString[],
     filterType?: RedisDataType,
-    getSize?: boolean,
-    getTtl?: boolean
+    includeSize?: boolean,
+    includeTTL?: boolean
   ): Promise<GetKeyInfoResponse[]> {
     return Promise.all(keys.map(async (key) => {
       const commands: RedisClientCommand[] = [];
@@ -193,12 +193,12 @@ export class ClusterScannerStrategy extends ScannerStrategy {
         type: null
       }
 
-      if (getTtl) {
+      if (includeTTL) {
         responseMap.ttl = commands.length
         commands.push([BrowserToolKeysCommands.Ttl, key]);
       }
 
-      if (getSize) {
+      if (includeSize) {
         responseMap.size = commands.length
         commands.push(['memory', 'usage', key, 'samples', '0']);
       }
diff --git a/redisinsight/api/src/modules/browser/keys/scanner/strategies/scanner.strategy.ts b/redisinsight/api/src/modules/browser/keys/scanner/strategies/scanner.strategy.ts
@@ -16,7 +16,7 @@ export abstract class ScannerStrategy implements IScannerStrategy {
     client: RedisClient,
     keys: RedisString[],
     filterType?: RedisDataType,
-    getSize?: boolean,
-    getTtl?: boolean
+    includeSize?: boolean,
+    includeTTL?: boolean
   ): Promise<GetKeyInfoResponse[]>;
 }
diff --git a/redisinsight/api/src/modules/browser/keys/scanner/strategies/standalone.scanner.strategy.spec.ts b/redisinsight/api/src/modules/browser/keys/scanner/strategies/standalone.scanner.strategy.spec.ts
@@ -511,8 +511,8 @@ describe('StandaloneScannerStrategy', () => {
         mockStandaloneRedisClient,
         keys,
         undefined,
-        true,   // getSize
-        true    // getTtl
+        true,   // includeSize
+        true    // includeTTL
       );
 
       const mockResult: GetKeyInfoResponse[] = keys.map((key) => ({
@@ -524,7 +524,7 @@ describe('StandaloneScannerStrategy', () => {
       expect(result).toEqual(mockResult);
     });
 
-    it('should not get TTL when getTtl is false', async () => {
+    it('should not get TTL when includeTTL is false', async () => {
       when(mockStandaloneRedisClient.sendPipeline)
         .calledWith(
           keys.map((key: string) => [BrowserToolKeysCommands.Type, key]),
@@ -536,8 +536,8 @@ describe('StandaloneScannerStrategy', () => {
         mockStandaloneRedisClient,
         keys,
         undefined,
-        false,  // getSize
-        false    // getTtl
+        false,  // includeSize
+        false    // includeTTL
       );
 
       const mockResult: GetKeyInfoResponse[] = keys.map((key) => ({
@@ -547,7 +547,7 @@ describe('StandaloneScannerStrategy', () => {
       expect(result).toEqual(mockResult);
     });
 
-    it('should not get size when getSize is false', async () => {
+    it('should not get size when includeSize is false', async () => {
       when(mockStandaloneRedisClient.sendPipeline)
         .calledWith(
           keys.map((key: string) => [BrowserToolKeysCommands.Ttl, key]),
@@ -565,8 +565,8 @@ describe('StandaloneScannerStrategy', () => {
         mockStandaloneRedisClient,
         keys,
         undefined,
-        false,  // getSize
-        true    // getTtl
+        false,  // includeSize
+        true    // includeTTL
       );
 
       const mockResult: GetKeyInfoResponse[] = keys.map((key) => ({
@@ -612,8 +612,8 @@ describe('StandaloneScannerStrategy', () => {
         mockStandaloneRedisClient,
         keys,
         undefined,
-        true,   // getSize
-        true    // getTtl
+        true,   // includeSize
+        true    // includeTTL
       );
 
       const mockResult: GetKeyInfoResponse[] = keys.map((key) => ({
diff --git a/redisinsight/api/src/modules/browser/keys/scanner/strategies/standalone.scanner.strategy.ts b/redisinsight/api/src/modules/browser/keys/scanner/strategies/standalone.scanner.strategy.ts
@@ -162,14 +162,14 @@ export class StandaloneScannerStrategy extends ScannerStrategy {
     client: RedisClient,
     keys: RedisString[],
     filterType?: RedisDataType,
-    getSize?: boolean,
-    getTtl?: boolean,
+    includeSize?: boolean,
+    includeTTL?: boolean,
   ): Promise<GetKeyInfoResponse[]> {
-    const sizeResults = getSize ? await this.getKeysSize(client, keys) : [];
+    const sizeResults = includeSize ? await this.getKeysSize(client, keys) : [];
     const typeResults = filterType
       ? Array(keys.length).fill(filterType)
       : await this.getKeysType(client, keys);
-    const ttlResults = getTtl ? await this.getKeysTtl(client, keys) : [];
+    const ttlResults = includeTTL ? await this.getKeysTtl(client, keys) : [];
 
     return keys.map(
       (key: string, index: number): GetKeyInfoResponse => {
@@ -178,10 +178,10 @@ export class StandaloneScannerStrategy extends ScannerStrategy {
           type: typeResults[index],
         }
 
-        if (getTtl) {
+        if (includeTTL) {
           data.ttl = ttlResults[index];
         }
-        if (getSize) {
+        if (includeSize) {
           data.size = sizeResults[index];
         }
         return data;
diff --git a/redisinsight/api/test/api/keys/POST-databases-id-keys-get_infos.test.ts b/redisinsight/api/test/api/keys/POST-databases-id-keys-get_infos.test.ts
diff --git a/redisinsight/desktop/src/lib/window/browserWindow.ts b/redisinsight/desktop/src/lib/window/browserWindow.ts
diff --git a/redisinsight/ui/src/pages/browser/components/key-list/KeyList.spec.tsx b/redisinsight/ui/src/pages/browser/components/key-list/KeyList.spec.tsx
diff --git a/redisinsight/ui/src/pages/browser/components/key-list/KeyList.tsx b/redisinsight/ui/src/pages/browser/components/key-list/KeyList.tsx
diff --git a/redisinsight/ui/src/pages/browser/components/virtual-tree/components/Node/Node.tsx b/redisinsight/ui/src/pages/browser/components/virtual-tree/components/Node/Node.tsx
diff --git a/redisinsight/ui/src/slices/browser/keys.ts b/redisinsight/ui/src/slices/browser/keys.ts
diff --git a/redisinsight/ui/src/slices/tests/browser/keys.spec.ts b/redisinsight/ui/src/slices/tests/browser/keys.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@ export abstract class KeyInfoStrategy {`
`11`	`11`	`client: RedisClient,`
`12`	`12`	`key: RedisString,`
`13`	`13`	`type: string,`
`14`		`- getSize: boolean,`
	`14`	`+ includeSize: boolean,`
`15`	`15`	`): Promise<GetKeyInfoResponse>;`
`16`	`16`	`}`