Merge branch 'main' into feature/e2e-automatically-update

Author: tanyatrayanava

redisinsight/api/config/default.ts

@@ -1,4 +1,5 @@
 import { join } from 'path';
+import * as os from 'os';
 
 const homedir = join(__dirname, '..');
 
@@ -15,6 +16,7 @@ const defaultsDir = process.env.BUILD_TYPE === 'ELECTRON' && process['resourcesP
 
 export default {
   dir_path: {
+    tmpDir: os.tmpdir(),
     homedir,
     prevHomedir: homedir,
     staticDir,
@@ -87,10 +89,14 @@ export default {
   redis_cli: {
     unsupportedCommands: JSON.parse(process.env.CLI_UNSUPPORTED_COMMANDS || '[]'),
   },
+  profiler: {
+    logFileIdleThreshold: parseInt(process.env.PROFILER_LOG_FILE_IDLE_THRESHOLD, 10) || 1000 * 60, // 1min
+  },
   analytics: {
     writeKey: process.env.SEGMENT_WRITE_KEY || 'SOURCE_WRITE_KEY',
   },
   logger: {
+    logLevel: process.env.LOG_LEVEL || 'info', // log level
     stdout: process.env.STDOUT_LOGGER ? process.env.STDOUT_LOGGER === 'true' : false, // disabled by default
     files: process.env.FILES_LOGGER ? process.env.FILES_LOGGER === 'true' : true, // enabled by default
     omitSensitiveData: process.env.LOGGER_OMIT_DATA ? process.env.LOGGER_OMIT_DATA === 'true' : true,

redisinsight/api/config/development.ts

@@ -10,6 +10,7 @@ export default {
     migrationsRun: process.env.DB_MIGRATIONS ? process.env.DB_MIGRATIONS === 'true' : false,
   },
   logger: {
+    logLevel: process.env.LOG_LEVEL || 'debug',
     stdout: process.env.STDOUT_LOGGER ? process.env.STDOUT_LOGGER === 'true' : true, // enabled by default
     omitSensitiveData: process.env.LOGGER_OMIT_DATA ? process.env.LOGGER_OMIT_DATA === 'true' : false,
   },

redisinsight/api/config/logger.ts

@@ -58,6 +58,7 @@ if (LOGGER_CONFIG.files) {
 const logger: WinstonModuleOptions = {
   format: format.errors({ stack: true }),
   transports: transportsConfig,
+  level: LOGGER_CONFIG.logLevel,
 };
 
 export default logger;

redisinsight/api/config/test.ts

@@ -3,4 +3,7 @@ export default {
     env: 'test',
     requestTimeout: 1000,
   },
+  profiler: {
+    logFileIdleThreshold: parseInt(process.env.PROFILER_LOG_FILE_IDLE_THRESHOLD, 10) || 1000 * 3, // 3sec
+  },
 };

redisinsight/api/src/__mocks__/index.ts

@@ -8,3 +8,4 @@ export * from './redis-info';
 export * from './app-settings';
 export * from './autodiscovery-tools';
 export * from './analytics';
+export * from './profiler';

redisinsight/api/src/__mocks__/monitor.ts

@@ -0,0 +1,94 @@
+import { ILogsEmitter } from 'src/modules/profiler/interfaces/logs-emitter.interface';
+import { ProfilerClient } from 'src/modules/profiler/models/profiler.client';
+import { RedisObserver } from 'src/modules/profiler/models/redis.observer';
+import { IShardObserver } from 'src/modules/profiler/interfaces/shard-observer.interface';
+import { LogFile } from 'src/modules/profiler/models/log-file';
+import { ProfilerAnalyticsService } from 'src/modules/profiler/profiler-analytics.service';
+import { MockType } from 'src/__mocks__/common';
+import { TelemetryEvents } from 'src/constants';
+import * as MockedSocket from 'socket.io-mock';
+import { IMonitorData } from 'src/modules/profiler/interfaces/monitor-data.interface';
+
+export const mockMonitorDataItemEmitted = {
+  time: '14239988881.12341',
+  source: '127.0.0.1',
+  database: 0,
+  args: ['set', 'foo', 'bar'],
+};
+
+export const mockMonitorDataItem: IMonitorData = {
+  ...mockMonitorDataItemEmitted,
+  shardOptions: null,
+};
+
+export const mockSocket = new MockedSocket();
+mockSocket['emit'] = jest.fn();
+//
+// export const mockProfilerClient: MockType<ProfilerClient> = {
+//   id: uuidv4(),
+//   handleOnData: jest.fn(),
+//   handleOnDisconnect: jest.fn(),
+//   addLogsEmitter: jest.fn(),
+//   flushLogs: jest.fn(),
+//   destroy: jest.fn(),
+// };
+
+export const mockRedisObserver: Partial<RedisObserver> = {
+  // status: RedisObserverStatus.Wait,
+  init: jest.fn(),
+  subscribe: jest.fn(),
+  unsubscribe: jest.fn(),
+  getProfilerClientsSize: jest.fn(),
+  clear: jest.fn(),
+  removeShardsListeners: jest.fn(),
+};
+
+export const mockRedisShardObserver: 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(),
+};
+
+export const mockProfilerAnalyticsEvents = new Map();
+mockProfilerAnalyticsEvents.set(TelemetryEvents.ProfilerLogDownloaded, jest.fn());
+mockProfilerAnalyticsEvents.set(TelemetryEvents.ProfilerLogDeleted, jest.fn());
+
+export const mockProfilerAnalyticsService: MockType<ProfilerAnalyticsService> = {
+  sendLogDeleted: jest.fn(),
+  sendLogDownloaded: jest.fn(),
+  getEventsEmitters: jest.fn().mockImplementation(() => mockProfilerAnalyticsEvents),
+};
+
+export const mockLogEmitter: ILogsEmitter = {
+  id: 'test',
+  emit: jest.fn(),
+  addProfilerClient: jest.fn(),
+  removeProfilerClient: jest.fn(),
+  flushLogs: jest.fn(),
+};
+
+export const mockWriteStream = {
+  write: jest.fn(),
+};
+export const testLogFileId = 'test-log-file-id';
+export const mockLogFile: LogFile = new LogFile('instanceid', testLogFileId, mockProfilerAnalyticsEvents);
+mockLogFile['getWriteStream'] = jest.fn();
+mockLogFile['addProfilerClient'] = jest.fn();
+mockLogFile['removeProfilerClient'] = jest.fn();
+mockLogFile['destroy'] = jest.fn();
+
+export const mockProfilerClientId = 'profiler-client-id';
+export const mockProfilerClient: ProfilerClient = new ProfilerClient(mockProfilerClientId, mockSocket);

redisinsight/api/src/__mocks__/profiler.ts

@@ -16,7 +16,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 { ProfilerModule } from './modules/profiler/profiler.module';
 import { CliModule } from './modules/cli/cli.module';
 import { StaticsManagementModule } from './modules/statics-management/statics-management.module';
 import { SettingsController } from './controllers/settings.controller';
@@ -41,7 +41,7 @@ const PATH_CONFIG = config.get('dir_path');
     WorkbenchModule,
     PluginModule,
     CommandsModule,
-    MonitorModule,
+    ProfilerModule,
     EventEmitterModule.forRoot(),
     ...(SERVER_CONFIG.staticContent
       ? [

redisinsight/api/src/app.module.ts

@@ -2,6 +2,7 @@
 export default {
   INVALID_DATABASE_INSTANCE_ID: 'Invalid database instance id.',
   COMMAND_EXECUTION_NOT_FOUND: 'Command execution was not found.',
+  PROFILER_LOG_FILE_NOT_FOUND: 'Profiler log file was not found.',
   PLUGIN_STATE_NOT_FOUND: 'Plugin state was not found.',
   UNDEFINED_INSTANCE_ID: 'Undefined redis database instance id.',
   NO_CONNECTION_TO_REDIS_DB: 'No connection to the Redis Database.',

redisinsight/api/src/constants/error-messages.ts

@@ -37,4 +37,8 @@ export enum TelemetryEvents {
   WorkbenchCommandExecuted = 'WORKBENCH_COMMAND_EXECUTED',
   WorkbenchCommandErrorReceived = 'WORKBENCH_COMMAND_ERROR_RECEIVED',
   WorkbenchCommandDeleted = 'WORKBENCH_COMMAND_DELETE_COMMAND',
+
+  // Profiler
+  ProfilerLogDownloaded = 'PROFILER_LOG_DOWNLOADED',
+  ProfilerLogDeleted = 'PROFILER_LOG_DELETED',
 }