Merge branch 'feature/RI-3637_databases-import' into feature/RI-3853-database_import_results

# Conflicts:
#	redisinsight/api/src/modules/database-import/database-import.service.ts

Author: Artem

redisinsight/api/config/default.ts

@@ -57,6 +57,7 @@ export default {
     appVersion: process.env.APP_VERSION || '2.0.0',
     requestTimeout: parseInt(process.env.REQUEST_TIMEOUT, 10) || 10000,
     excludeRoutes: [],
+    excludeAuthRoutes: [],
   },
   sockets: {
     cors: process.env.SOCKETS_CORS ? process.env.SOCKETS_CORS === 'true' : false,

redisinsight/api/migration/1670252337342-database-new.ts

@@ -0,0 +1,20 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class databaseNew1670252337342 implements MigrationInterface {
+    name = 'databaseNew1670252337342'
+
+    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, CONSTRAINT "FK_3b9b625266c00feb2d66a9f36e4" FOREIGN KEY ("clientCertId") REFERENCES "client_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_d1bc747b5938e22b4b708d8e9a5" FOREIGN KEY ("caCertId") REFERENCES "ca_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") SELECT "id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername" 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, CONSTRAINT "FK_3b9b625266c00feb2d66a9f36e4" FOREIGN KEY ("clientCertId") REFERENCES "client_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_d1bc747b5938e22b4b708d8e9a5" FOREIGN KEY ("caCertId") REFERENCES "ca_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") SELECT "id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername" FROM "temporary_database_instance"`);
+        await queryRunner.query(`DROP TABLE "temporary_database_instance"`);
+    }
+
+}

redisinsight/api/migration/index.ts

@@ -21,6 +21,7 @@ import { databaseAnalysis1664785208236 } from './1664785208236-database-analysis
 import { databaseAnalysisExpirationGroups1664886479051 } from './1664886479051-database-analysis-expiration-groups';
 import { workbenchExecutionTime1667368983699 } from './1667368983699-workbench-execution-time';
 import { database1667477693934 } from './1667477693934-database';
+import { databaseNew1670252337342 } from './1670252337342-database-new';
 
 export default [
   initialMigration1614164490968,
@@ -46,4 +47,5 @@ export default [
   databaseAnalysisExpirationGroups1664886479051,
   workbenchExecutionTime1667368983699,
   database1667477693934,
+  databaseNew1670252337342,
 ];

redisinsight/api/src/__mocks__/common.ts

@@ -1,3 +1,7 @@
+import { ClientContext, ClientMetadata, Session } from 'src/common/models';
+import { mockDatabase } from 'src/__mocks__/databases';
+import { v4 as uuidv4 } from 'uuid';
+
 export type MockType<T> = {
   [P in keyof T]: jest.Mock<any>;
 };
@@ -57,3 +61,33 @@ export const mockRepository = jest.fn(() => ({
   remove: jest.fn(),
   createQueryBuilder: mockCreateQueryBuilder,
 }));
+
+export const mockSession: Session = {
+  userId: uuidv4(),
+  sessionId: uuidv4(),
+};
+
+export const mockCliClientMetadata: ClientMetadata = {
+  session: mockSession,
+  databaseId: mockDatabase.id,
+  context: ClientContext.CLI,
+  uniqueId: uuidv4(),
+};
+
+export const mockWorkbenchClientMetadata: ClientMetadata = {
+  session: mockSession,
+  databaseId: mockDatabase.id,
+  context: ClientContext.Workbench,
+};
+
+export const mockBrowserClientMetadata: ClientMetadata = {
+  session: mockSession,
+  databaseId: mockDatabase.id,
+  context: ClientContext.Browser,
+};
+
+export const mockCommonClientMetadata: ClientMetadata = {
+  session: mockSession,
+  databaseId: mockDatabase.id,
+  context: ClientContext.Common,
+};

redisinsight/api/src/__mocks__/databases.ts

@@ -7,9 +7,8 @@ import { mockIORedisClient } from 'src/__mocks__/redis';
 import { mockSentinelMasterDto } from 'src/__mocks__/redis-sentinel';
 import { pick } from 'lodash';
 import { RedisDatabaseInfoResponse } from 'src/modules/database/dto/redis-info.dto';
-import { ClientMetadata } from 'src/modules/redis/models/client-metadata';
-import { AppTool } from 'src/models';
 import { DatabaseOverview } from 'src/modules/database/models/database-overview';
+import { ClientContext, ClientMetadata } from 'src/common/models';
 
 export const mockDatabaseId = 'a77b23c1-7816-4ea4-b61f-d37795a0f805-db-id';
 
@@ -27,6 +26,7 @@ export const mockDatabase = Object.assign(new Database(), {
   host: '127.0.100.1',
   port: 6379,
   connectionType: ConnectionType.STANDALONE,
+  new: false,
 });
 
 export const mockDatabaseEntity = Object.assign(new DatabaseEntity(), {
@@ -115,9 +115,15 @@ export const mockClusterDatabaseWithTlsAuthEntity = Object.assign(new DatabaseEn
   nodes: JSON.stringify(mockClusterNodes),
 });
 
+export const mockNewDatabase = Object.assign(new Database(), {
+  ...mockDatabase,
+  new: true,
+});
+
 export const mockClientMetadata: ClientMetadata = {
+  session: undefined,
   databaseId: mockDatabase.id,
-  namespace: AppTool.Common,
+  context: ClientContext.Common,
 };
 
 export const mockDatabaseOverview: DatabaseOverview = {

redisinsight/api/src/app.module.ts

@@ -20,6 +20,7 @@ import { LocalDatabaseModule } from 'src/local-database.module';
 import { CoreModule } from 'src/core.module';
 import { AutodiscoveryModule } from 'src/modules/autodiscovery/autodiscovery.module';
 import { DatabaseImportModule } from 'src/modules/database-import/database-import.module';
+import { DummyAuthMiddleware } from 'src/common/middlewares/dummy-auth.middleware';
 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';
@@ -99,6 +100,11 @@ export class AppModule implements OnModuleInit, NestModule {
   }
 
   configure(consumer: MiddlewareConsumer) {
+    consumer
+      .apply(DummyAuthMiddleware)
+      .exclude(...SERVER_CONFIG.excludeAuthRoutes)
+      .forRoutes('*');
+
     consumer
       .apply(ExcludeRouteMiddleware)
       .forRoutes(

redisinsight/api/src/common/constants/api.ts

@@ -0,0 +1,2 @@
+export const API_PARAM_DATABASE_ID = 'dbInstance';
+export const API_PARAM_CLI_CLIENT_ID = 'uuid';

redisinsight/api/src/common/constants/index.ts

@@ -1 +1,2 @@
 export * from './redis-string';
+export * from './api';

redisinsight/api/src/common/decorators/client-metadata/client-metadata.decorator.ts

@@ -0,0 +1,56 @@
+import { BadRequestException, createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { plainToClass } from 'class-transformer';
+import { ClientContext, ClientMetadata } from 'src/common/models';
+import { sessionFromRequestFactory } from 'src/common/decorators';
+import { Validator } from 'class-validator';
+import { API_PARAM_DATABASE_ID } from 'src/common/constants';
+
+const validator = new Validator();
+
+export interface IClientMetadataParamOptions {
+  databaseIdParam?: string,
+  uniqueIdParam?: string,
+  context?: ClientContext,
+}
+
+export const clientMetadataParamFactory = (
+  options: IClientMetadataParamOptions,
+  ctx: ExecutionContext,
+): ClientMetadata => {
+  const opts: IClientMetadataParamOptions = {
+    context: ClientContext.Common,
+    databaseIdParam: API_PARAM_DATABASE_ID,
+    ...options,
+  };
+
+  const req = ctx.switchToHttp().getRequest();
+
+  let databaseId;
+  if (opts?.databaseIdParam) {
+    databaseId = req.params?.[opts.databaseIdParam];
+  }
+
+  let uniqueId;
+  if (opts?.uniqueIdParam) {
+    uniqueId = req.params?.[opts.uniqueIdParam];
+  }
+
+  const clientMetadata = plainToClass(ClientMetadata, {
+    session: sessionFromRequestFactory(undefined, ctx),
+    databaseId,
+    uniqueId,
+    context: opts?.context || ClientContext.Common,
+  });
+
+  const errors = validator.validateSync(clientMetadata, {
+    whitelist: false, // we need this to allow additional fields if needed for flexibility
+  });
+
+  if (errors?.length) {
+    throw new BadRequestException(Object.values(errors[0].constraints) || 'Bad request');
+  }
+
+  return clientMetadata;
+};
+
+export const ClientMetadataParam = createParamDecorator(clientMetadataParamFactory);

redisinsight/api/src/common/decorators/client-metadata/index.ts

@@ -0,0 +1 @@
+export * from './client-metadata.decorator';