Merge pull request #1455 from RedisInsight/be/feature/RI-3775-dummy_auth_middleware

#RI-3775 add dummy auth middleware + Session object + ClientMetadata …

Author: arthosofteq

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/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,8 +7,6 @@ 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';
 
 export const mockDatabaseId = 'a77b23c1-7816-4ea4-b61f-d37795a0f805-db-id';
@@ -115,11 +113,6 @@ export const mockClusterDatabaseWithTlsAuthEntity = Object.assign(new DatabaseEn
   nodes: JSON.stringify(mockClusterNodes),
 });
 
-export const mockClientMetadata: ClientMetadata = {
-  databaseId: mockDatabase.id,
-  namespace: AppTool.Common,
-};
-
 export const mockDatabaseOverview: DatabaseOverview = {
   version: '6.2.4',
   usedMemory: 1,

redisinsight/api/src/app.module.ts

@@ -19,6 +19,7 @@ import { ServerModule } from 'src/modules/server/server.module';
 import { LocalDatabaseModule } from 'src/local-database.module';
 import { CoreModule } from 'src/core.module';
 import { AutodiscoveryModule } from 'src/modules/autodiscovery/autodiscovery.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';
@@ -97,6 +98,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';

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

@@ -2,3 +2,5 @@ export * from './redis-string';
 export * from './zset-score';
 export * from './default';
 export * from './data-as-json-string.decorator';
+export * from './session';
+export * from './client-metadata';

redisinsight/api/src/common/decorators/session/index.ts

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