Merge pull request #4168 from RedisInsight/be/feature/RIVS-31_Logical_databases

Author: egor-zalenski

redisinsight/api/src/__mocks__/databases.ts

@@ -17,6 +17,7 @@ import {
 import { CloudDatabaseDetailsEntity } from 'src/modules/cloud/database/entities/cloud-database-details.entity';
 import { mockCloudDatabaseDetails, mockCloudDatabaseDetailsEntity } from 'src/__mocks__/cloud-database';
 import { mockRedisClientListResult } from 'src/__mocks__/database-info';
+import { DatabaseOverviewKeyspace } from 'src/modules/database/constants/overview';
 
 export const mockDatabaseId = 'a77b23c1-7816-4ea4-b61f-d37795a0f805-db-id';
 
@@ -220,6 +221,8 @@ export const mockDatabaseOverview: DatabaseOverview = {
   cpuUsagePercentage: null,
 };
 
+export const mockDatabaseOverviewCurrentKeyspace = DatabaseOverviewKeyspace.Current;
+
 export const mockRedisServerInfoDto = {
   redis_version: '7.0.5',
   redis_mode: 'standalone',

redisinsight/api/src/modules/database/constants/overview.ts

@@ -0,0 +1,4 @@
+export enum DatabaseOverviewKeyspace {
+  Full = 'full',
+  Current = 'current',
+}

redisinsight/api/src/modules/database/database-info.controller.ts

@@ -1,6 +1,6 @@
-import { ApiTags } from '@nestjs/swagger';
+import { ApiQuery, ApiTags } from '@nestjs/swagger';
 import {
-  Controller, Get, Param, UseInterceptors, UsePipes, ValidationPipe,
+  Controller, Get, Param, Query, UseInterceptors, UsePipes, ValidationPipe,
 } from '@nestjs/common';
 import { ApiEndpoint } from 'src/decorators/api-endpoint.decorator';
 import { TimeoutInterceptor } from 'src/common/interceptors/timeout.interceptor';
@@ -10,6 +10,7 @@ import { RedisDatabaseInfoResponse } from 'src/modules/database/dto/redis-info.d
 import { ClientMetadata, DatabaseIndex } from 'src/common/models';
 import { ClientMetadataParam } from 'src/common/decorators';
 import { DbIndexValidationPipe } from 'src/common/pipes';
+import { DatabaseOverviewKeyspace } from './constants/overview';
 
 @ApiTags('Database Instances')
 @Controller('databases')
@@ -54,13 +55,19 @@ export class DatabaseInfoController {
       },
     ],
   })
+  @ApiQuery({
+    name: 'keyspace',
+    required: false,
+    enum: DatabaseOverviewKeyspace,
+  })
   async getDatabaseOverview(
     @ClientMetadataParam({
       databaseIdParam: 'id',
       ignoreDbIndex: false, // do not ignore db index to calculate current (selected) keys in db
     }) clientMetadata: ClientMetadata,
+      @Query() { keyspace = DatabaseOverviewKeyspace.Current }: { keyspace: DatabaseOverviewKeyspace },
   ): Promise<DatabaseOverview> {
-    return this.databaseInfoService.getOverview(clientMetadata);
+    return this.databaseInfoService.getOverview(clientMetadata, keyspace);
   }
 
   @Get(':id/db/:index')

redisinsight/api/src/modules/database/database-info.service.spec.ts

@@ -5,6 +5,7 @@ import {
   mockDatabaseInfoProvider,
   mockDatabaseOverview,
   mockDatabaseOverviewProvider,
+  mockDatabaseOverviewCurrentKeyspace,
   mockDatabaseRecommendationService,
   mockDatabaseService,
   mockDBSize,
@@ -71,7 +72,9 @@ describe('DatabaseInfoService', () => {
 
   describe('getOverview', () => {
     it('should create client and get overview', async () => {
-      expect(await service.getOverview(mockCommonClientMetadata)).toEqual(mockDatabaseOverview);
+      expect(
+        await service.getOverview(mockCommonClientMetadata, mockDatabaseOverviewCurrentKeyspace),
+      ).toEqual(mockDatabaseOverview);
     });
   });
 

redisinsight/api/src/modules/database/database-info.service.ts

@@ -9,6 +9,7 @@ import { DatabaseClientFactory } from 'src/modules/database/providers/database.c
 import { RedisClient } from 'src/modules/redis/client';
 import { DatabaseInfoProvider } from 'src/modules/database/providers/database-info.provider';
 import { DatabaseService } from './database.service';
+import { DatabaseOverviewKeyspace } from './constants/overview';
 
 @Injectable()
 export class DatabaseInfoService {
@@ -38,16 +39,20 @@ export class DatabaseInfoService {
    * Get redis database overview
    *
    * @param clientMetadata
+   * @param keyspace
    */
-  public async getOverview(clientMetadata: ClientMetadata): Promise<DatabaseOverview> {
+  public async getOverview(
+    clientMetadata: ClientMetadata,
+    keyspace: DatabaseOverviewKeyspace,
+  ): Promise<DatabaseOverview> {
     this.logger.log(`Getting database overview for: ${clientMetadata.databaseId}`);
 
     const client: RedisClient = await this.databaseClientFactory.getOrCreateClient({
       ...clientMetadata,
       db: undefined, // connect to default db index
     });
 
-    return this.databaseOverviewProvider.getOverview(clientMetadata, client);
+    return this.databaseOverviewProvider.getOverview(clientMetadata, client, keyspace);
   }
 
   /**

redisinsight/api/src/modules/database/providers/database-overview.provider.spec.ts

@@ -9,6 +9,7 @@ import {
 import { DatabaseOverview } from 'src/modules/database/models/database-overview';
 import { DatabaseOverviewProvider } from 'src/modules/database/providers/database-overview.provider';
 import * as Utils from 'src/modules/redis/utils/keys.util';
+import { DatabaseOverviewKeyspace } from 'src/modules/database/constants/overview';
 
 const mockServerInfo = {
   redis_version: '6.2.4',
@@ -32,6 +33,7 @@ const mockCpu = {
 const standaloneClientsInfo = {
   connected_clients: '1',
 };
+const mockCurrentKeyspace = DatabaseOverviewKeyspace.Current;
 const mockKeyspace = {
   db0: 'keys=1,expires=0,avg_ttl=0',
   db1: 'keys=0,expires=0,avg_ttl=0',
@@ -93,7 +95,7 @@ describe('OverviewService', () => {
           .calledWith(['info'], { replyEncoding: 'utf8' })
           .mockResolvedValue(mockStandaloneRedisInfoReply);
 
-        const result = await service.getOverview(mockClientMetadata, standaloneClient);
+        const result = await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace);
 
         expect(result).toEqual({
           ...mockDatabaseOverview,
@@ -116,7 +118,7 @@ describe('OverviewService', () => {
           },
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           totalKeys: 0,
           totalKeysPerDb: undefined,
@@ -133,7 +135,7 @@ describe('OverviewService', () => {
           },
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           totalKeys: 3,
           totalKeysPerDb: undefined,
@@ -150,7 +152,7 @@ describe('OverviewService', () => {
           clients: undefined,
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           totalKeys: undefined,
           usedMemory: undefined,
@@ -173,11 +175,11 @@ describe('OverviewService', () => {
           },
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           cpuUsagePercentage: 50,
         });
@@ -197,11 +199,11 @@ describe('OverviewService', () => {
           },
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           cpuUsagePercentage: 100,
         });
@@ -220,11 +222,23 @@ describe('OverviewService', () => {
           },
         });
 
-        expect(await service.getOverview(mockClientMetadata, standaloneClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           cpuUsagePercentage: undefined,
         });
       });
+      it('should full data of keyspace if query keyspace = "full" ', async () => {
+        spyGetNodeInfo.mockResolvedValueOnce(mockNodeInfo);
+
+        expect(await service.getOverview(mockClientMetadata, standaloneClient, DatabaseOverviewKeyspace.Full)).toEqual({
+          ...mockDatabaseOverview,
+          totalKeysPerDb: {
+            db0: 1,
+            db1: 0,
+            db2: 1,
+          },
+        });
+      });
     });
     describe('Cluster', () => {
       it('Should calculate overview and ignore replica where needed', async () => {
@@ -260,7 +274,7 @@ describe('OverviewService', () => {
           replication: { role: 'slave' },
         });
 
-        expect(await service.getOverview(mockClientMetadata, clusterClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, clusterClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           connectedClients: 1,
           totalKeys: 6,
@@ -315,7 +329,7 @@ describe('OverviewService', () => {
           cpu: { ...mockNodeInfo.cpu, used_cpu_sys: '1.5', used_cpu_user: '1.5' },
         });
 
-        expect(await service.getOverview(mockClientMetadata, clusterClient)).toEqual({
+        expect(await service.getOverview(mockClientMetadata, clusterClient, mockCurrentKeyspace)).toEqual({
           ...mockDatabaseOverview,
           connectedClients: 1,
           totalKeys: 6,

redisinsight/api/src/modules/database/providers/database-overview.provider.ts

@@ -15,6 +15,7 @@ import { getTotalKeys, convertMultilineReplyToObject } from 'src/modules/redis/u
 import { DatabaseOverview } from 'src/modules/database/models/database-overview';
 import { ClientMetadata } from 'src/common/models';
 import { RedisClient, RedisClientConnectionType, RedisClientNodeRole } from 'src/modules/redis/client';
+import { DatabaseOverviewKeyspace } from '../constants/overview';
 
 @Injectable()
 export class DatabaseOverviewProvider {
@@ -24,10 +25,12 @@ export class DatabaseOverviewProvider {
    * Calculates redis database metrics based on connection type (eg Cluster or Standalone)
    * @param clientMetadata
    * @param client
+   * @param keyspace
    */
   async getOverview(
     clientMetadata: ClientMetadata,
     client: RedisClient,
+    keyspace: DatabaseOverviewKeyspace,
   ): Promise<DatabaseOverview> {
     let nodesInfo = [];
     let totalKeys;
@@ -42,7 +45,10 @@ export class DatabaseOverviewProvider {
       totalKeys = await this.calculateNodesTotalKeys(client);
     } else {
       nodesInfo = [await this.getNodeInfo(client)];
-      const [calculatedTotalKeys, calculatedTotalKeysPerDb] = this.calculateTotalKeys(nodesInfo, currentDbIndex);
+      const [
+        calculatedTotalKeys,
+        calculatedTotalKeysPerDb,
+      ] = this.calculateTotalKeys(nodesInfo, currentDbIndex, keyspace);
       totalKeys = calculatedTotalKeys;
       totalKeysPerDb = calculatedTotalKeysPerDb;
     }
@@ -209,9 +215,14 @@ export class DatabaseOverviewProvider {
    * In case when shard has multiple logical databases shard total keys = sum of all dbs keys
    * @param nodes
    * @param index
+   * @param keyspace
    * @private
    */
-  private calculateTotalKeys(nodes = [], index: number): [number, Record<string, number>] {
+  private calculateTotalKeys(
+    nodes = [],
+    index: number,
+    keyspace: DatabaseOverviewKeyspace,
+  ): [number, Record<string, number>] {
     try {
       const masterNodes = DatabaseOverviewProvider.getMasterNodesToWorkWith(nodes);
 
@@ -238,7 +249,11 @@ export class DatabaseOverviewProvider {
 
       const totalKeys = totalKeysPerDb ? sum(Object.values(totalKeysPerDb)) : undefined;
       const dbIndexKeys = totalKeysPerDb[`db${index}`] || 0;
-      return [totalKeys, dbIndexKeys === totalKeys ? undefined : { [`db${index}`]: dbIndexKeys }];
+      const calculatedTotalKeysPerDb = keyspace === DatabaseOverviewKeyspace.Full
+        ? totalKeysPerDb
+        : { [`db${index}`]: dbIndexKeys };
+
+      return [totalKeys, dbIndexKeys === totalKeys ? undefined : calculatedTotalKeysPerDb];
     } catch (e) {
       return [null, null];
     }