Feature/Redis Monitor

configs/webpack.config.base.js

@@ -61,12 +61,12 @@ export default {
           // 'swagger-ui-express',
           // 'class-transformer',
           // 'class-transformer/storage',
-          '@nestjs/websockets',
+          // '@nestjs/websockets',
           // '@nestjs/core/adapters/http-adapter',
           // '@nestjs/core/helpers/router-method-factory',
           // '@nestjs/core/metadata-scanner',
           '@nestjs/microservices/microservices-module',
-          '@nestjs/websockets/socket-module',
+          // '@nestjs/websockets/socket-module',
         ];
         if (!lazyImports.includes(resource)) {
           return false;

configs/webpack.config.web.common.babel.js

@@ -97,9 +97,9 @@ export default {
           'reflect-metadata',
           'swagger-ui-express',
           'class-transformer/storage',
-          '@nestjs/websockets',
+          // '@nestjs/websockets',
           '@nestjs/microservices/microservices-module',
-          '@nestjs/websockets/socket-module',
+          // '@nestjs/websockets/socket-module',
         ];
         if (!lazyImports.includes(resource)) {
           return false;

electron-builder.json

@@ -24,7 +24,7 @@
     "gatekeeperAssess": false
   },
   "dmg": {
-    "artifactName": "${productName}-${os}-x64.${ext}",
+    "artifactName": "${productName}-${os}-${arch}.${ext}",
     "contents": [
       {
         "x": 130,

package.json

@@ -206,6 +206,7 @@
     "rimraf": "^3.0.2",
     "sass-loader": "^10.1.0",
     "skip-postinstall": "^1.0.0",
+    "socket.io-mock": "^1.3.2",
     "source-map-support": "^0.5.19",
     "style-loader": "^2.0.0",
     "supertest": "^4.0.2",
@@ -255,6 +256,7 @@
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",
     "remark-rehype": "^10.0.1",
+    "socket.io-client": "^4.4.0",
     "unified": "^10.1.1",
     "unist-util-visit": "^4.1.0"
   },

redisinsight/api/config/default.ts

@@ -45,6 +45,10 @@ export default {
     appVersion: process.env.APP_VERSION || '2.0.0',
     requestTimeout: parseInt(process.env.REQUEST_TIMEOUT, 10) || 10000,
   },
+  sockets: {
+    cors: process.env.SOCKETS_CORS ? process.env.SOCKETS_CORS === 'true' : false,
+    serveClient: process.env.SOCKETS_SERVE_CLIENT ? process.env.SOCKETS_SERVE_CLIENT === 'true' : false,
+  },
   db: {
     database: join(homedir, 'redisinsight.db'),
     synchronize: process.env.DB_SYNC ? process.env.DB_SYNC === 'true' : false,

redisinsight/api/config/development.ts

@@ -2,6 +2,9 @@ export default {
   server: {
     tls: process.env.SERVER_TLS ? process.env.SERVER_TLS === 'true' : false,
   },
+  sockets: {
+    cors: true,
+  },
   db: {
     synchronize: process.env.DB_SYNC ? process.env.DB_SYNC === 'true' : true,
     migrationsRun: process.env.DB_MIGRATIONS ? process.env.DB_MIGRATIONS === 'true' : false,

redisinsight/api/config/test.ts

@@ -1,18 +1,6 @@
-import { join } from 'path';
-
-const homedir = join(__dirname, '..');
-
-module.exports = {
-  dir_path: {
-    homedir,
-    logs: join(homedir, 'logs'),
-    caCertificates: join(homedir, 'ca_certificates'),
-    clientCertificates: join(homedir, 'client_certificates'),
-  },
+export default {
   server: {
     env: 'test',
-    tls: !!process.env.SERVER_TLS || true,
-    tlsCert: process.env.SERVER_TLS_CERT,
-    tlsKey: process.env.SERVER_TLS_KEY,
+    requestTimeout: 1000,
   },
 };

redisinsight/api/package.json

@@ -23,9 +23,9 @@
     "start:debug": "nest start --debug --watch",
     "start:stage": "cross-env NODE_ENV=staging SERVER_STATIC_CONTENT=true node dist/src/main",
     "start:prod": "cross-env NODE_ENV=production node dist/src/main",
-    "test": "./node_modules/.bin/jest -w 1",
-    "test:watch": "jest --watch -w 1",
-    "test:cov": "./node_modules/.bin/jest --coverage -w 1",
+    "test": "cross-env NODE_ENV=test ./node_modules/.bin/jest -w 1",
+    "test:watch": "cross-env NODE_ENV=test jest --watch -w 1",
+    "test:cov": "cross-env NODE_ENV=test ./node_modules/.bin/jest --coverage -w 1",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand -w 1",
     "test:e2e": "jest --config ./test/jest-e2e.json -w 1",
     "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config ./config/ormconfig.ts",
@@ -40,9 +40,11 @@
     "@nestjs/core": "^7.0.0",
     "@nestjs/event-emitter": "^1.0.0",
     "@nestjs/platform-express": "^7.0.0",
+    "@nestjs/platform-socket.io": "^8.2.3",
     "@nestjs/serve-static": "^2.1.3",
     "@nestjs/swagger": "^4.6.1",
     "@nestjs/typeorm": "^7.1.5",
+    "@nestjs/websockets": "^8.2.3",
     "adm-zip": "^0.5.9",
     "analytics-node": "^4.0.1",
     "axios": "^0.21.0",
@@ -60,6 +62,7 @@
     "nest-winston": "^1.4.0",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^6.6.7",
+    "socket.io": "^4.4.0",
     "source-map-support": "^0.5.19",
     "sqlite3": "^5.0.2",
     "swagger-ui-express": "^4.1.4",
@@ -79,6 +82,7 @@
     "@types/jest": "^26.0.15",
     "@types/lodash": "^4.14.167",
     "@types/node": "14.14.10",
+    "@types/socket.io": "^3.0.2",
     "@types/supertest": "^2.0.8",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
@@ -101,6 +105,7 @@
     "nyc": "^15.1.0",
     "object-diff": "^0.0.4",
     "rimraf": "^3.0.2",
+    "socket.io-mock": "^1.3.2",
     "supertest": "^4.0.2",
     "ts-jest": "^26.1.0",
     "ts-loader": "^6.2.1",

redisinsight/api/src/__mocks__/monitor.ts

@@ -0,0 +1,36 @@
+import { v4 as uuidv4 } from 'uuid';
+import { IClientMonitorObserver } from 'src/modules/monitor/helpers/client-monitor-observer';
+import { IMonitorObserver, IShardObserver, MonitorObserverStatus } from 'src/modules/monitor/helpers/monitor-observer';
+
+export const mockClientMonitorObserver: IClientMonitorObserver = {
+  id: uuidv4(),
+  handleOnData: jest.fn(),
+  handleOnDisconnect: jest.fn(),
+};
+
+export const mockMonitorObserver: IMonitorObserver = {
+  status: MonitorObserverStatus.Wait,
+  subscribe: jest.fn(),
+  unsubscribe: jest.fn(),
+  getSize: jest.fn(),
+  clear: jest.fn(),
+};
+
+export const mockRedisMonitorObserver: IShardObserver = {
+  addListener: jest.fn(),
+  eventNames: jest.fn(),
+  getMaxListeners: jest.fn(),
+  listenerCount: jest.fn(),
+  listeners: jest.fn(),
+  prependListener: jest.fn(),
+  prependOnceListener: jest.fn(),
+  removeAllListeners: jest.fn(),
+  removeListener: jest.fn(),
+  rawListeners: jest.fn(),
+  setMaxListeners: jest.fn(),
+  on: jest.fn(),
+  emit: jest.fn(),
+  off: jest.fn(),
+  once: jest.fn(),
+  disconnect: jest.fn(),
+};

redisinsight/api/src/app.module.ts

@@ -15,6 +15,7 @@ import { InstancesModule } from './modules/instances/instances.module';
 import { BrowserModule } from './modules/browser/browser.module';
 import { RedisEnterpriseModule } from './modules/redis-enterprise/redis-enterprise.module';
 import { RedisSentinelModule } from './modules/redis-sentinel/redis-sentinel.module';
+import { MonitorModule } from './modules/monitor/monitor.module';
 import { CliModule } from './modules/cli/cli.module';
 import { SettingsController } from './controllers/settings.controller';
 import { ServerInfoController } from './controllers/server-info.controller';
@@ -37,6 +38,7 @@ const PATH_CONFIG = config.get('dir_path');
     WorkbenchModule,
     PluginModule,
     CommandsModule,
+    MonitorModule,
     EventEmitterModule.forRoot(),
     ...(SERVER_CONFIG.staticContent
       ? [

redisinsight/api/src/constants/app-events.ts

@@ -2,3 +2,7 @@ export enum AppAnalyticsEvents {
   Initialize = 'analytics.initialize',
   Track = 'analytics.track',
 }
+
+export enum AppRedisInstanceEvents {
+  Deleted = 'instance.deleted',
+}

redisinsight/api/src/modules/core/core.module.ts

@@ -2,14 +2,14 @@ import { DynamicModule, Global, Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { CaCertificateEntity } from 'src/modules/core/models/ca-certificate.entity';
 import { ClientCertificateEntity } from 'src/modules/core/models/client-certificate.entity';
+import { PlainEncryptionStrategy } from 'src/modules/core/encryption/strategies/plain-encryption.strategy';
 import { AgreementsRepository } from './repositories/agreements.repository';
 import { ServerRepository } from './repositories/server.repository';
 import { SettingsRepository } from './repositories/settings.repository';
 import settingsOnPremiseFactory from './providers/settings-on-premise';
 import serverOnPremiseFactory from './providers/server-on-premise';
 import { EncryptionService } from 'src/modules/core/encryption/encryption.service';
 import { KeytarEncryptionStrategy } from 'src/modules/core/encryption/strategies/keytar-encryption.strategy';
-import { PlainEncryptionStrategy } from 'src/modules/core/encryption/strategies/plain-encryption.strategy';
 import { CaCertBusinessService } from './services/certificates/ca-cert-business/ca-cert-business.service';
 import { ClientCertBusinessService } from './services/certificates/client-cert-business/client-cert-business.service';
 import { RedisService } from './services/redis/redis.service';

redisinsight/api/src/modules/monitor/constants/events.ts

@@ -0,0 +1,8 @@
+export enum MonitorGatewayClientEvents {
+  Monitor = 'monitor',
+}
+
+export enum MonitorGatewayServerEvents {
+  Data = 'monitorData',
+  Exception = 'exception',
+}

redisinsight/api/src/modules/monitor/helpers/client-monitor-observer/client-monitor-observer.interface.ts

@@ -0,0 +1,15 @@
+import IORedis from 'ioredis';
+
+export interface IOnDatePayload {
+  time: string;
+  args: string[];
+  source: string;
+  database: number;
+  shardOptions: IORedis.RedisOptions
+}
+
+export interface IClientMonitorObserver {
+  id: string;
+  handleOnData: (data: IOnDatePayload) => void;
+  handleOnDisconnect: () => void;
+}

redisinsight/api/src/modules/monitor/helpers/client-monitor-observer/client-monitor-observer.spec.ts

@@ -0,0 +1,49 @@
+import { WsException } from '@nestjs/websockets';
+import * as MockedSocket from 'socket.io-mock';
+import ERROR_MESSAGES from 'src/constants/error-messages';
+import { MonitorGatewayServerEvents } from 'src/modules/monitor/constants/events';
+import ClientMonitorObserver from './client-monitor-observer';
+import { IOnDatePayload } from './client-monitor-observer.interface';
+
+describe('ClientMonitorObserver', () => {
+  let socketClient;
+
+  beforeEach(() => {
+    socketClient = new MockedSocket();
+    socketClient.id = '123';
+    socketClient.emit = jest.fn();
+  });
+
+  it.only('should be defined', () => {
+    const client = new ClientMonitorObserver(socketClient.id, socketClient);
+
+    expect(client.id).toEqual(socketClient.id);
+  });
+  it.only('should emit event on monitorData', async () => {
+    const client = new ClientMonitorObserver(socketClient.id, socketClient);
+    const monitorData = {
+      // unix timestamp
+      time: `${(new Date()).getTime() / 1000}`,
+      source: '127.0.0.1:58612',
+      database: 0,
+      args: ['set', 'foo', 'bar'],
+    };
+    const payload: IOnDatePayload = { ...monitorData, shardOptions: { host: '127.0.0.1', port: 6379 } };
+
+    client.handleOnData(payload);
+
+    await new Promise((r) => setTimeout(r, 500));
+
+    expect(socketClient.emit).toHaveBeenCalledWith(MonitorGatewayServerEvents.Data, [monitorData]);
+  });
+  it.only('should emit exception event', () => {
+    const client = new ClientMonitorObserver(socketClient.id, socketClient);
+
+    client.handleOnDisconnect();
+
+    expect(socketClient.emit).toHaveBeenCalledWith(
+      MonitorGatewayServerEvents.Exception,
+      new WsException(ERROR_MESSAGES.NO_CONNECTION_TO_REDIS_DB),
+    );
+  });
+});

redisinsight/api/src/modules/monitor/helpers/client-monitor-observer/client-monitor-observer.ts

@@ -0,0 +1,52 @@
+import { Socket } from 'socket.io';
+import { MonitorGatewayServerEvents } from 'src/modules/monitor/constants/events';
+import { WsException } from '@nestjs/websockets';
+import ERROR_MESSAGES from 'src/constants/error-messages';
+import { debounce } from 'lodash';
+import { IClientMonitorObserver, IOnDatePayload } from './client-monitor-observer.interface';
+
+class ClientMonitorObserver implements IClientMonitorObserver {
+  public readonly id: string;
+
+  private readonly client: Socket;
+
+  private filters: any[];
+
+  private readonly debounce: any;
+
+  private items: any[];
+
+  constructor(id: string, client: Socket) {
+    this.id = id;
+    this.client = client;
+    this.items = [];
+    this.debounce = debounce(() => {
+      if (this.items.length) {
+        this.client.emit(MonitorGatewayServerEvents.Data, this.items);
+        this.items = [];
+      }
+    }, 10, {
+      maxWait: 50,
+    });
+  }
+
+  public handleOnData(payload: IOnDatePayload) {
+    const {
+      time, args, source, database,
+    } = payload;
+
+    this.items.push({
+      time, args, source, database,
+    });
+
+    this.debounce();
+  }
+
+  public handleOnDisconnect() {
+    this.client.emit(
+      MonitorGatewayServerEvents.Exception,
+      new WsException(ERROR_MESSAGES.NO_CONNECTION_TO_REDIS_DB),
+    );
+  }
+}
+export default ClientMonitorObserver;

redisinsight/api/src/modules/monitor/helpers/client-monitor-observer/index.ts

@@ -0,0 +1,2 @@
+export * from './client-monitor-observer'
+export * from './client-monitor-observer.interface'

redisinsight/api/src/modules/monitor/helpers/monitor-observer/index.ts

@@ -0,0 +1,3 @@
+export * from './monitor-observer.interface';
+export * from './monitor-observer';
+export * from './shard-obsever.interface';

redisinsight/api/src/modules/monitor/helpers/monitor-observer/monitor-observer.interface.ts

@@ -0,0 +1,16 @@
+import { IClientMonitorObserver } from '../client-monitor-observer';
+
+export enum MonitorObserverStatus {
+  Wait = 'wait',
+  Ready = 'ready',
+  End = 'end',
+  Error = 'error',
+}
+
+export interface IMonitorObserver {
+  status: MonitorObserverStatus;
+  subscribe: (client: IClientMonitorObserver) => Promise<void>;
+  unsubscribe: (id: string) => void;
+  getSize: () => number;
+  clear: () => void;
+}