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

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/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/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,72 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { plainToClass } from 'class-transformer';
+import { ClientContext, ClientMetadata } from 'src/common/models';
+import { sessionFromRequestFactory } from 'src/common/decorators';
+import { API_PARAM_CLI_CLIENT_ID, API_PARAM_DATABASE_ID } from 'src/common/constants';
+
+export interface IClientMetadataDecoratorOptions {
+  paramPath?: string,
+  queryPath?: string,
+  bodyPath?: string,
+  context?: ClientContext,
+  uniqueId?: string,
+}
+
+export const clientMetadataFromRequestFactory = (options: IClientMetadataDecoratorOptions, ctx: ExecutionContext) => {
+  const opts: IClientMetadataDecoratorOptions = {
+    context: ClientContext.Common,
+    ...options,
+  };
+
+  const request = ctx.switchToHttp().getRequest();
+
+  let databaseId;
+  if (opts.paramPath) {
+    databaseId = request.params?.[opts.paramPath];
+  } else if (opts.queryPath) {
+    // TBD
+  } else if (opts.bodyPath) {
+    // TBD
+  }
+
+  // todo: add validation
+  if (!databaseId) {
+    // todo: define proper error
+    throw new Error('No databaseId found');
+  }
+
+  return plainToClass(ClientMetadata, {
+    session: sessionFromRequestFactory(undefined, ctx),
+    databaseId,
+    context: opts.context,
+    uniqueId: opts.uniqueId,
+  });
+};
+
+export const ClientMetadataFromRequest = createParamDecorator(clientMetadataFromRequestFactory);
+
+export const browserClientMetadataFactory = (
+  param = API_PARAM_DATABASE_ID,
+  ctx: ExecutionContext,
+): ClientMetadata => clientMetadataFromRequestFactory({
+  paramPath: param,
+  context: ClientContext.Browser,
+}, ctx);
+
+export const BrowserClientMetadata = createParamDecorator(browserClientMetadataFactory);
+
+export const cliClientMetadataFactory = (
+  options = { databaseParam: API_PARAM_DATABASE_ID, uuidParam: API_PARAM_CLI_CLIENT_ID },
+  ctx: ExecutionContext,
+): ClientMetadata => {
+  const request = ctx.switchToHttp().getRequest();
+
+  // todo: add validation
+  return clientMetadataFromRequestFactory({
+    paramPath: options.databaseParam,
+    context: ClientContext.CLI,
+    uniqueId: request.params?.[options.uuidParam],
+  }, ctx);
+};
+
+export const CliClientMetadata = createParamDecorator(cliClientMetadataFactory);

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';

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

@@ -0,0 +1,11 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { plainToClass } from 'class-transformer';
+import { Session } from 'src/common/models';
+
+export const sessionFromRequestFactory = (data: unknown, ctx: ExecutionContext): Session => {
+  const request = ctx.switchToHttp().getRequest();
+
+  return plainToClass(Session, request.session);
+};
+
+export const SessionFromRequest = createParamDecorator(sessionFromRequestFactory);