Merge branch 'main' into feature/e2e-tree-view

Author: tanyatrayanava

.github/redisinsight_browser.png

@@ -23,6 +23,7 @@ RedisInsight is an intuitive and efficient GUI for Redis, allowing you to intera
 * Browse, filter and visualise your key-value Redis data structures
 * CRUD support for Lists, Hashes, Strings, Sets, Sorted Sets 
 * CRUD support for [RedisJSON](https://oss.redis.com/redisjson/)
+* Profiler - analyze every command sent to Redis in real-time 
 * Introducing Workbench - advanced command line interface with intelligent command auto-complete and complex data visualizations
 * Command auto-complete support for [RediSearch](https://oss.redis.com/redisearch/), [RedisJSON](https://oss.redis.com/redisjson/), [RedisGraph](https://oss.redis.com/redisgraph/), [RedisTimeSeries](https://oss.redis.com/redistimeseries/), [RedisAI](https://oss.redis.com/redisai/)
 * Visualizations of your [RediSearch](https://oss.redis.com/redisearch/) index, queries, and aggregations

README.md

@@ -15,7 +15,10 @@ export default async function bootstrap() {
   const port = process.env.API_PORT || serverConfig.port;
   const logger = WinstonModule.createLogger(LOGGER_CONFIG);
 
-  const options: NestApplicationOptions = {};
+  const options: NestApplicationOptions = {
+    logger,
+  };
+
   if (serverConfig.tls && serverConfig.tlsCert && serverConfig.tlsKey) {
     options.httpsOptions = {
       key: JSON.parse(`"${serverConfig.tlsKey}"`),
@@ -29,7 +32,6 @@ export default async function bootstrap() {
   app.use(bodyParser.urlencoded({ limit: '512mb', extended: true }));
   app.enableCors();
   app.setGlobalPrefix(serverConfig.globalPrefix);
-  app.useLogger(logger);
 
   if (process.env.APP_ENV !== 'electron') {
     SwaggerModule.setup(

redisinsight/api/src/main.ts

@@ -44,7 +44,7 @@ describe('Cli RawFormatterStrategy', () => {
           Buffer.from('"quoted key"'),
         ],
       ];
-      const mockResponse = ['0', ['key', '"quoted""key"', '"quoted key"']];
+      const mockResponse = ['0', ['key', '\\"quoted\\"\\"key\\"', '\\"quoted key\\"']];
       const output = strategy.format(input);
 
       expect(output).toEqual(mockResponse);
@@ -69,7 +69,7 @@ describe('Cli RawFormatterStrategy', () => {
       const input = Buffer.from(JSON.stringify(object));
       const output = strategy.format(input);
 
-      expect(output).toEqual(JSON.stringify(object));
+      expect(output).toEqual('{\\"key\\":\\"value\\"}');
     });
   });
 });

redisinsight/api/src/modules/cli/services/cli-business/output-formatter/strategies/raw-formatter.strategy.spec.ts

@@ -1,10 +1,11 @@
 import { isArray, isObject } from 'lodash';
+import { getASCIISafeStringFromBuffer } from 'src/utils/cli-helper';
 import { IOutputFormatterStrategy } from '../output-formatter.interface';
 
 export class RawFormatterStrategy implements IOutputFormatterStrategy {
   public format(reply: any): any {
     if (reply instanceof Buffer) {
-      return this.formatRedisBufferReply(reply);
+      return getASCIISafeStringFromBuffer(reply);
     }
     if (isArray(reply)) {
       return this.formatRedisArrayReply(reply);
@@ -29,10 +30,6 @@ export class RawFormatterStrategy implements IOutputFormatterStrategy {
     return result;
   }
 
-  private formatRedisBufferReply(reply: Buffer): string {
-    return reply.toString();
-  }
-
   private formatRedisObjectReply(reply: Object): object {
     const result = {};
     Object.keys(reply).forEach((key) => {

redisinsight/api/src/modules/cli/services/cli-business/output-formatter/strategies/raw-formatter.strategy.ts

@@ -16,12 +16,15 @@ import {
 import { CommandExecutionResult } from 'src/modules/workbench/models/command-execution-result';
 import { CreateCommandExecutionDto } from 'src/modules/workbench/dto/create-command-execution.dto';
 import { RedisToolService } from 'src/modules/shared/services/base/redis-tool.service';
+import { RawFormatterStrategy } from 'src/modules/cli/services/cli-business/output-formatter/strategies/raw-formatter.strategy';
 import { WorkbenchAnalyticsService } from '../services/workbench-analytics/workbench-analytics.service';
 
 @Injectable()
 export class WorkbenchCommandsExecutor {
   private logger = new Logger('WorkbenchCommandsExecutor');
 
+  private formatter = new RawFormatterStrategy();
+
   constructor(
     private redisTool: RedisToolService,
     private analyticsService: WorkbenchAnalyticsService,
@@ -60,7 +63,10 @@ export class WorkbenchCommandsExecutor {
 
     try {
       const [command, ...args] = splitCliCommandLine(commandLine);
-      const response = await this.redisTool.execCommand(clientOptions, command, args, 'utf-8');
+      const response = this.formatter.format(
+        await this.redisTool.execCommand(clientOptions, command, args),
+      );
+
       this.logger.log('Succeed to execute workbench command.');
 
       const result = { response, status: CommandExecutionStatus.Success };
@@ -100,7 +106,6 @@ export class WorkbenchCommandsExecutor {
         args,
         role,
         nodeAddress,
-        'utf-8',
       );
       if (result.error && checkRedirectionError(result.error) && nodeOptions.enableRedirection) {
         const { slot, address } = parseRedirectionError(result.error);
@@ -110,7 +115,6 @@ export class WorkbenchCommandsExecutor {
           args,
           role,
           address,
-          'utf-8',
         );
         result.slot = parseInt(slot, 10);
       }
@@ -119,7 +123,12 @@ export class WorkbenchCommandsExecutor {
       const {
         host, port, error, slot, ...rest
       } = result;
-      return { ...rest, node: { host, port, slot } };
+
+      return {
+        ...rest,
+        response: this.formatter.format(rest.response),
+        node: { host, port, slot },
+      };
     } catch (error) {
       this.logger.error('Failed to execute redis.cluster CLI command.', error);
       const result = { response: error.message, status: CommandExecutionStatus.Fail };
@@ -148,12 +157,16 @@ export class WorkbenchCommandsExecutor {
       const [command, ...args] = splitCliCommandLine(commandLine);
 
       return (
-        await this.redisTool.execCommandForNodes(clientOptions, command, args, role, 'utf-8')
+        await this.redisTool.execCommandForNodes(clientOptions, command, args, role)
       ).map((nodeExecReply) => {
         const {
           response, status, host, port,
         } = nodeExecReply;
-        const result = { response, status, node: { host, port } };
+        const result = {
+          response: this.formatter.format(response),
+          status,
+          node: { host, port },
+        };
         this.analyticsService.sendCommandExecutedEvent(clientOptions.instanceId, result, { command });
         return result;
       });

redisinsight/api/src/modules/workbench/providers/workbench-commands.executor.ts

@@ -4,6 +4,7 @@ import ERROR_MESSAGES from 'src/constants/error-messages';
 import { CommandParsingError, RedirectionParsingError } from 'src/modules/cli/constants/errors';
 import { ReplyError } from 'src/models';
 import { IRedirectionInfo } from 'src/modules/cli/services/cli-business/output-formatter/output-formatter.interface';
+import { IS_NON_PRINTABLE_ASCII_CHARACTER } from 'src/constants';
 
 const LOGGER_CONFIG = config.get('logger');
 const BLANK_LINE_REGEX = /^\s*\n/gm;
@@ -219,3 +220,43 @@ export const multilineCommandToOneLine = (text: string = '') => text
   .split(/(\r\n|\n|\r)+\s+/gm)
   .filter((line: string) => !(BLANK_LINE_REGEX.test(line) || isEmpty(line)))
   .join(' ');
+
+/**
+ * Produces an escaped string representation of a byte string.
+ * Ported from sdscatrepr() function in sds.c from Redis source code.
+ * This is the function redis-cli uses to escape strings for output.
+ * @param reply
+ */
+export const getASCIISafeStringFromBuffer = (reply: Buffer): string => {
+  let result = '';
+  reply.forEach((byte: number) => {
+    const char = Buffer.from([byte]).toString();
+    if (IS_NON_PRINTABLE_ASCII_CHARACTER.test(char)) {
+      result += `\\x${decimalToHexString(byte)}`;
+    } else {
+      switch (char) {
+        case '\u0007': // Bell character
+          result += '\\a';
+          break;
+        case '"':
+          result += `\\${char}`;
+          break;
+        case '\b':
+          result += '\\b';
+          break;
+        case '\t':
+          result += '\\t';
+          break;
+        case '\n':
+          result += '\\n';
+          break;
+        case '\r':
+          result += '\\r';
+          break;
+        default:
+          result += char;
+      }
+    }
+  });
+  return result;
+};

redisinsight/api/src/utils/cli-helper.ts

@@ -439,7 +439,7 @@ describe('POST /instance/:instanceId/workbench/command-executions', () => {
             expect(body.result).to.eql([
               {
                 status: 'success',
-                response: '"value"'
+                response: '\\"value\\"'
               },
             ]);
           }
@@ -750,7 +750,7 @@ describe('POST /instance/:instanceId/workbench/command-executions', () => {
               for (let i = 0; i < 10; i++) {
                 response.push(
                   `${constants.TEST_SEARCH_JSON_KEY_PREFIX_1}${i}`,
-                  ['$', `{"user":{"name":"John Smith${i}"}}`],
+                  ['$', `{\\"user\\":{\\"name\\":\\"John Smith${i}\\"}}`],
                 );
               }
 

redisinsight/api/test/api/workbench/POST-instance-id-workbench-command_executions.test.ts

@@ -14,15 +14,15 @@ const formatToText = (reply: any, command: string = ''): string => {
   } else if (isObject(reply)) {
     result = formatRedisArrayReply(flattenDeep(Object.entries(reply)))
   } else if (isFormattedCommand(command)) {
-    result = JSON.stringify(reply)
-  } else {
     result = reply
+  } else {
+    result = `"${reply}"`
   }
 
   return result
 }
 
-const isFormattedCommand = (commandLine: string = '') => !bulkReplyCommands?.find((command) =>
+const isFormattedCommand = (commandLine: string = '') => !!bulkReplyCommands?.find((command) =>
   commandLine?.trim().toUpperCase().startsWith(command))
 
 const formatRedisArrayReply = (reply: any | any[], level = 0): string => {
@@ -41,7 +41,7 @@ const formatRedisArrayReply = (reply: any | any[], level = 0): string => {
         .join('\n')
     }
   } else {
-    result = JSON.stringify(reply)
+    result = `"${reply}"`
   }
   return result
 }