Merge pull request #1776 from RedisInsight/feature/RI-4141_Data_decompressors

#RI-4141 - Data decompressors

Author: vlad-dargel

jest.config.js

@@ -54,10 +54,10 @@ module.exports = {
   ],
   coverageThreshold: {
     global: {
-      statements: 77,
-      branches: 55,
-      functions: 65,
-      lines: 75,
+      statements: 78,
+      branches: 61,
+      functions: 70,
+      lines: 79,
     },
     // './redisinsight/ui/src/slices/**/*.ts': {
     //   statements: 90,

package.json

@@ -118,6 +118,7 @@
     "@types/electron-store": "^3.2.0",
     "@types/express": "^4.17.3",
     "@types/file-saver": "^2.0.5",
+    "@types/gzip-js": "^0.3.3",
     "@types/html-entities": "^1.3.4",
     "@types/ioredis": "^4.26.0",
     "@types/is-glob": "^4.0.2",
@@ -217,6 +218,7 @@
     "@elastic/eui": "34.6.0",
     "@msgpack/msgpack": "^2.7.2",
     "@reduxjs/toolkit": "^1.6.2",
+    "@stablelib/snappy": "^1.0.2",
     "axios": "^0.25.0",
     "buffer": "^6.0.3",
     "classnames": "^2.3.1",
@@ -230,12 +232,15 @@
     "electron-updater": "^5.0.5",
     "file-saver": "^2.0.5",
     "formik": "^2.2.9",
+    "fzstd": "^0.1.0",
+    "gzip-js": "^0.3.2",
     "html-entities": "^2.3.2",
     "html-react-parser": "^1.2.4",
     "java-object-serialization": "^0.1.1",
     "jpickle": "^0.4.1",
     "jsonpath": "^1.1.1",
     "lodash": "^4.17.21",
+    "lz4js": "^0.2.0",
     "php-serialize": "^4.0.2",
     "rawproto": "^0.7.6",
     "react": "^18.2.0",

redisinsight/api/migration/1678182722874-database-compressor.ts

@@ -0,0 +1,20 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class databaseCompressor1678182722874 implements MigrationInterface {
+    name = 'databaseCompressor1678182722874'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TABLE "temporary_database_instance" ("id" varchar PRIMARY KEY NOT NULL, "host" varchar NOT NULL, "port" integer NOT NULL, "name" varchar NOT NULL, "username" varchar, "password" varchar, "tls" boolean, "verifyServerCert" boolean, "lastConnection" datetime, "caCertId" varchar, "clientCertId" varchar, "connectionType" varchar NOT NULL DEFAULT ('STANDALONE'), "nodes" varchar DEFAULT ('[]'), "nameFromProvider" varchar, "sentinelMasterName" varchar, "sentinelMasterUsername" varchar, "sentinelMasterPassword" varchar, "provider" varchar DEFAULT ('UNKNOWN'), "modules" varchar NOT NULL DEFAULT ('[]'), "db" integer, "encryption" varchar, "tlsServername" varchar, "new" boolean, "ssh" boolean, "timeout" integer, "compressor" varchar NOT NULL DEFAULT ('NONE'), CONSTRAINT "FK_d1bc747b5938e22b4b708d8e9a5" FOREIGN KEY ("caCertId") REFERENCES "ca_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_3b9b625266c00feb2d66a9f36e4" FOREIGN KEY ("clientCertId") REFERENCES "client_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`);
+        await queryRunner.query(`INSERT INTO "temporary_database_instance"("id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername", "new", "ssh", "timeout") SELECT "id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername", "new", "ssh", "timeout" FROM "database_instance"`);
+        await queryRunner.query(`DROP TABLE "database_instance"`);
+        await queryRunner.query(`ALTER TABLE "temporary_database_instance" RENAME TO "database_instance"`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "database_instance" RENAME TO "temporary_database_instance"`);
+        await queryRunner.query(`CREATE TABLE "database_instance" ("id" varchar PRIMARY KEY NOT NULL, "host" varchar NOT NULL, "port" integer NOT NULL, "name" varchar NOT NULL, "username" varchar, "password" varchar, "tls" boolean, "verifyServerCert" boolean, "lastConnection" datetime, "caCertId" varchar, "clientCertId" varchar, "connectionType" varchar NOT NULL DEFAULT ('STANDALONE'), "nodes" varchar DEFAULT ('[]'), "nameFromProvider" varchar, "sentinelMasterName" varchar, "sentinelMasterUsername" varchar, "sentinelMasterPassword" varchar, "provider" varchar DEFAULT ('UNKNOWN'), "modules" varchar NOT NULL DEFAULT ('[]'), "db" integer, "encryption" varchar, "tlsServername" varchar, "new" boolean, "ssh" boolean, "timeout" integer, CONSTRAINT "FK_d1bc747b5938e22b4b708d8e9a5" FOREIGN KEY ("caCertId") REFERENCES "ca_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_3b9b625266c00feb2d66a9f36e4" FOREIGN KEY ("clientCertId") REFERENCES "client_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`);
+        await queryRunner.query(`INSERT INTO "database_instance"("id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername", "new", "ssh", "timeout") SELECT "id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername", "new", "ssh", "timeout" FROM "temporary_database_instance"`);
+        await queryRunner.query(`DROP TABLE "temporary_database_instance"`);
+    }
+
+}

redisinsight/api/migration/index.ts

@@ -27,6 +27,7 @@ import { workbenchAndAnalysisDbIndex1673934231410 } from './1673934231410-workbe
 import { browserHistory1674539211397 } from './1674539211397-browser-history';
 import { databaseAnalysisRecommendations1674660306971 } from './1674660306971-database-analysis-recommendations';
 import { databaseTimeout1675398140189 } from './1675398140189-database-timeout';
+import { databaseCompressor1678182722874 } from './1678182722874-database-compressor';
 
 export default [
   initialMigration1614164490968,
@@ -58,4 +59,5 @@ export default [
   databaseAnalysisRecommendations1674660306971,
   browserHistory1674539211397,
   databaseTimeout1675398140189,
+  databaseCompressor1678182722874,
 ];

redisinsight/api/src/__mocks__/databases.ts

@@ -1,7 +1,7 @@
 import { Database } from 'src/modules/database/models/database';
 import { mockCaCertificate, mockClientCertificate } from 'src/__mocks__/certificates';
 import { SentinelMaster } from 'src/modules/redis-sentinel/models/sentinel-master';
-import { ConnectionType, DatabaseEntity } from 'src/modules/database/entities/database.entity';
+import { Compressor, ConnectionType, DatabaseEntity } from 'src/modules/database/entities/database.entity';
 import { EncryptionStrategy } from 'src/modules/encryption/models';
 import { mockIORedisClient } from 'src/__mocks__/redis';
 import { mockSentinelMasterDto } from 'src/__mocks__/redis-sentinel';
@@ -34,6 +34,7 @@ export const mockDatabase = Object.assign(new Database(), {
   connectionType: ConnectionType.STANDALONE,
   timeout: 30_000,
   new: false,
+  compressor: Compressor.NONE,
 });
 
 export const mockDatabaseEntity = Object.assign(new DatabaseEntity(), {

redisinsight/api/src/modules/database/database.analytics.spec.ts

@@ -104,6 +104,7 @@ describe('DatabaseAnalytics', () => {
           numberOfModules: 0,
           timeout: mockDatabaseWithTlsAuth.timeout / 1_000, // milliseconds to seconds
           databaseIndex: 0,
+          useDecompression: mockDatabaseWithTlsAuth.compressor,
           ...DEFAULT_REDIS_MODULES_SUMMARY,
         },
       );
@@ -134,6 +135,7 @@ describe('DatabaseAnalytics', () => {
           numberOfModules: 0,
           timeout: mockDatabaseWithTlsAuth.timeout / 1_000, // milliseconds to seconds
           databaseIndex: 0,
+          useDecompression: mockDatabaseWithTlsAuth.compressor,
           ...DEFAULT_REDIS_MODULES_SUMMARY,
         },
       );
@@ -166,6 +168,7 @@ describe('DatabaseAnalytics', () => {
           numberOfModules: 2,
           timeout: mockDatabaseWithTlsAuth.timeout / 1_000, // milliseconds to seconds
           databaseIndex: 0,
+          useDecompression: mockDatabaseWithTlsAuth.compressor,
           ...DEFAULT_REDIS_MODULES_SUMMARY,
           RediSearch: {
             loaded: true,
@@ -204,6 +207,7 @@ describe('DatabaseAnalytics', () => {
           numberOfModules: 2,
           timeout: mockDatabaseWithTlsAuth.timeout / 1_000, // milliseconds to seconds
           databaseIndex: 2,
+          useDecompression: mockDatabaseWithTlsAuth.compressor,
           ...DEFAULT_REDIS_MODULES_SUMMARY,
           RediSearch: {
             loaded: true,
@@ -240,6 +244,7 @@ describe('DatabaseAnalytics', () => {
           useSNI: 'enabled',
           useSSH: 'disabled',
           timeout: mockDatabaseWithTlsAuth.timeout / 1_000, // milliseconds to seconds
+          useDecompression: mockDatabaseWithTlsAuth.compressor,
           previousValues: {
             connectionType: prev.connectionType,
             provider: prev.provider,
@@ -275,6 +280,7 @@ describe('DatabaseAnalytics', () => {
           useSNI: 'enabled',
           useSSH: 'disabled',
           timeout: mockDatabaseWithTlsAuth.timeout / 1_000, // milliseconds to seconds
+          useDecompression: mockDatabaseWithTlsAuth.compressor,
           previousValues: {
             connectionType: prev.connectionType,
             provider: prev.provider,

redisinsight/api/src/modules/database/database.analytics.ts

@@ -67,6 +67,7 @@ export class DatabaseAnalytics extends TelemetryBaseService {
           numberOfModules: instance.modules?.length || 0,
           timeout: instance.timeout / 1_000, // milliseconds to seconds
           databaseIndex: instance.db || 0,
+          useDecompression: instance.compressor || null,
           ...modulesSummary,
         },
       );
@@ -100,6 +101,7 @@ export class DatabaseAnalytics extends TelemetryBaseService {
             useSNI: cur?.tlsServername ? 'enabled' : 'disabled',
             useSSH: cur?.ssh ? 'enabled' : 'disabled',
             timeout: cur?.timeout / 1_000, // milliseconds to seconds
+            useDecompression: cur?.compressor || null,
             previousValues: {
               connectionType: prev.connectionType,
               provider: prev.provider,

redisinsight/api/src/modules/database/dto/create.database.dto.ts

@@ -23,7 +23,7 @@ import { sshOptionsTransformer } from 'src/modules/ssh/transformers/ssh-options.
 )
 export class CreateDatabaseDto extends PickType(Database, [
   'host', 'port', 'name', 'db', 'username', 'password', 'timeout', 'nameFromProvider', 'provider',
-  'tls', 'tlsServername', 'verifyServerCert', 'sentinelMaster', 'ssh',
+  'tls', 'tlsServername', 'verifyServerCert', 'sentinelMaster', 'ssh', 'compressor',
 ] as const) {
   @ApiPropertyOptional({
     description: 'CA Certificate',

redisinsight/api/src/modules/database/dto/update.database.dto.ts

@@ -1,6 +1,7 @@
 import { ApiPropertyOptional, getSchemaPath } from '@nestjs/swagger';
 import {
   IsBoolean,
+  IsEnum,
   IsInt, IsNotEmpty, IsNotEmptyObject, IsOptional, IsString, MaxLength, Min, ValidateIf, ValidateNested,
 } from 'class-validator';
 import { CreateCaCertificateDto } from 'src/modules/certificate/dto/create.ca-certificate.dto';
@@ -16,6 +17,7 @@ import { CreateDatabaseDto } from 'src/modules/database/dto/create.database.dto'
 import { CreateBasicSshOptionsDto } from 'src/modules/ssh/dto/create.basic-ssh-options.dto';
 import { CreateCertSshOptionsDto } from 'src/modules/ssh/dto/create.cert-ssh-options.dto';
 import { sshOptionsTransformer } from 'src/modules/ssh/transformers/ssh-options.transformer';
+import { Compressor } from '../entities/database.entity';
 
 export class UpdateDatabaseDto extends CreateDatabaseDto {
   @ValidateIf((object, value) => value !== undefined)
@@ -157,4 +159,14 @@ export class UpdateDatabaseDto extends CreateDatabaseDto {
   @ValidateNested()
   @Default(null)
   sshOptions?: CreateBasicSshOptionsDto | CreateCertSshOptionsDto;
+
+  @ApiPropertyOptional({
+    description: 'Database compressor',
+    default: Compressor.NONE,
+    enum: Compressor,
+  })
+  @Expose()
+  @IsEnum(Compressor)
+  @IsOptional()
+  compressor?: Compressor = Compressor.NONE;
 }

redisinsight/api/src/modules/database/entities/database.entity.ts

@@ -25,6 +25,14 @@ export enum ConnectionType {
   NOT_CONNECTED = 'NOT CONNECTED',
 }
 
+export enum Compressor {
+  NONE = 'NONE',
+  GZIP = 'GZIP',
+  ZSTD = 'ZSTD',
+  LZ4 = 'LZ4',
+  SNAPPY = 'SNAPPY',
+}
+
 @Entity('database_instance')
 export class DatabaseEntity {
   @Expose()
@@ -184,4 +192,11 @@ export class DatabaseEntity {
   )
   @Type(() => SshOptionsEntity)
   sshOptions: SshOptionsEntity;
+
+  @Expose()
+  @Column({
+    nullable: false,
+    default: Compressor.NONE,
+  })
+  compressor: Compressor;
 }