#RI-3775 rework ClientMetadata decorators, fix tests

Author: Artem

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/common/decorators/client-metadata/client-metadata.decorator.ts

@@ -1,72 +1,56 @@
-import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+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 { API_PARAM_CLI_CLIENT_ID, API_PARAM_DATABASE_ID } from 'src/common/constants';
+import { Validator } from 'class-validator';
+import { API_PARAM_DATABASE_ID } from 'src/common/constants';
 
-export interface IClientMetadataDecoratorOptions {
-  paramPath?: string,
-  queryPath?: string,
-  bodyPath?: string,
+const validator = new Validator();
+
+export interface IClientMetadataParamOptions {
+  databaseIdParam?: string,
+  uniqueIdParam?: string,
   context?: ClientContext,
-  uniqueId?: string,
 }
 
-export const clientMetadataFromRequestFactory = (options: IClientMetadataDecoratorOptions, ctx: ExecutionContext) => {
-  const opts: IClientMetadataDecoratorOptions = {
+export const clientMetadataParamFactory = (
+  options: IClientMetadataParamOptions,
+  ctx: ExecutionContext,
+): ClientMetadata => {
+  const opts: IClientMetadataParamOptions = {
     context: ClientContext.Common,
+    databaseIdParam: API_PARAM_DATABASE_ID,
     ...options,
   };
 
-  const request = ctx.switchToHttp().getRequest();
+  const req = ctx.switchToHttp().getRequest();
 
   let databaseId;
-  if (opts.paramPath) {
-    databaseId = request.params?.[opts.paramPath];
-  } else if (opts.queryPath) {
-    // TBD
-  } else if (opts.bodyPath) {
-    // TBD
+  if (opts?.databaseIdParam) {
+    databaseId = req.params?.[opts.databaseIdParam];
   }
 
-  // todo: add validation
-  if (!databaseId) {
-    // todo: define proper error
-    throw new Error('No databaseId found');
+  let uniqueId;
+  if (opts?.uniqueIdParam) {
+    uniqueId = req.params?.[opts.uniqueIdParam];
   }
 
-  return plainToClass(ClientMetadata, {
+  const clientMetadata = plainToClass(ClientMetadata, {
     session: sessionFromRequestFactory(undefined, ctx),
     databaseId,
-    context: opts.context,
-    uniqueId: opts.uniqueId,
+    uniqueId,
+    context: opts?.context || ClientContext.Common,
   });
-};
-
-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);
+  const errors = validator.validateSync(clientMetadata, {
+    whitelist: false, // we need this to allow additional fields if needed for flexibility
+  });
 
-export const cliClientMetadataFactory = (
-  options = { databaseParam: API_PARAM_DATABASE_ID, uuidParam: API_PARAM_CLI_CLIENT_ID },
-  ctx: ExecutionContext,
-): ClientMetadata => {
-  const request = ctx.switchToHttp().getRequest();
+  if (errors?.length) {
+    throw new BadRequestException(Object.values(errors[0].constraints) || 'Bad request');
+  }
 
-  // todo: add validation
-  return clientMetadataFromRequestFactory({
-    paramPath: options.databaseParam,
-    context: ClientContext.CLI,
-    uniqueId: request.params?.[options.uuidParam],
-  }, ctx);
+  return clientMetadata;
 };
 
-export const CliClientMetadata = createParamDecorator(cliClientMetadataFactory);
+export const ClientMetadataParam = createParamDecorator(clientMetadataParamFactory);

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

@@ -1,11 +1,24 @@
-import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { BadRequestException, createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { Validator } from 'class-validator';
 import { plainToClass } from 'class-transformer';
 import { Session } from 'src/common/models';
 
+const validator = new Validator();
+
 export const sessionFromRequestFactory = (data: unknown, ctx: ExecutionContext): Session => {
   const request = ctx.switchToHttp().getRequest();
 
-  return plainToClass(Session, request.session);
+  const session = plainToClass(Session, request.session);
+
+  const errors = validator.validateSync(session, {
+    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 session;
 };
 
 export const SessionFromRequest = createParamDecorator(sessionFromRequestFactory);

redisinsight/api/src/common/models/client-metadata.ts

@@ -1,4 +1,8 @@
 import { Session } from 'src/common/models/session';
+import { Type } from 'class-transformer';
+import {
+  IsEnum, IsNotEmpty, IsOptional, IsString,
+} from 'class-validator';
 
 export enum ClientContext {
   Common = 'Common',
@@ -8,11 +12,19 @@ export enum ClientContext {
 }
 
 export class ClientMetadata {
+  @IsNotEmpty()
+  @Type(() => Session)
   session: Session;
 
+  @IsNotEmpty()
+  @IsString()
   databaseId: string;
 
+  @IsNotEmpty()
+  @IsEnum(ClientContext)
   context: ClientContext;
 
+  @IsOptional()
+  @IsString()
   uniqueId?: string;
 }

redisinsight/api/src/common/models/session.ts

@@ -1,13 +1,21 @@
+import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
 export interface ISession {
   userId: string;
   sessionId: string;
   uniqueId?: string;
 }
 
 export class Session implements ISession {
+  @IsNotEmpty()
+  @IsString()
   userId: string;
 
+  @IsNotEmpty()
+  @IsString()
   sessionId: string;
 
+  @IsOptional()
+  @IsString()
   uniqueId?: string;
 }

redisinsight/api/src/modules/browser/controllers/hash/hash.controller.ts

@@ -11,7 +11,8 @@ import {
 } from '@nestjs/swagger';
 import { ApiRedisParams } from 'src/decorators/api-redis-params.decorator';
 import { BaseController } from 'src/modules/browser/controllers/base.controller';
-import { ApiQueryRedisStringEncoding, BrowserClientMetadata } from 'src/common/decorators';
+import { BrowserClientMetadata } from 'src/modules/browser/decorators/browser-client-metadata.decorator';
+import { ApiQueryRedisStringEncoding } from 'src/common/decorators';
 import { ClientMetadata } from 'src/common/models';
 import {
   AddFieldsToHashDto,

redisinsight/api/src/modules/browser/controllers/keys/keys.controller.ts

@@ -13,7 +13,8 @@ import { KeysBusinessService } from 'src/modules/browser/services/keys-business/
 import { ApiRedisParams } from 'src/decorators/api-redis-params.decorator';
 import { RedisService } from 'src/modules/redis/redis.service';
 import { BaseController } from 'src/modules/browser/controllers/base.controller';
-import { ApiQueryRedisStringEncoding, BrowserClientMetadata } from 'src/common/decorators';
+import { BrowserClientMetadata } from 'src/modules/browser/decorators/browser-client-metadata.decorator';
+import { ApiQueryRedisStringEncoding } from 'src/common/decorators';
 import { ClientMetadata } from 'src/common/models';
 import {
   DeleteKeysDto,

redisinsight/api/src/modules/browser/controllers/list/list.controller.ts

@@ -30,7 +30,8 @@ import {
   DeleteListElementsResponse,
   PushListElementsResponse,
 } from 'src/modules/browser/dto';
-import { ApiQueryRedisStringEncoding, BrowserClientMetadata } from 'src/common/decorators';
+import { BrowserClientMetadata } from 'src/modules/browser/decorators/browser-client-metadata.decorator';
+import { ApiQueryRedisStringEncoding } from 'src/common/decorators';
 import { BaseController } from 'src/modules/browser/controllers/base.controller';
 import { ClientMetadata } from 'src/common/models';
 import { ListBusinessService } from '../../services/list-business/list-business.service';

redisinsight/api/src/modules/browser/controllers/redisearch/redisearch.controller.ts

@@ -11,7 +11,8 @@ import {
   ApiTags,
 } from '@nestjs/swagger';
 import { ApiRedisParams } from 'src/decorators/api-redis-params.decorator';
-import { ApiQueryRedisStringEncoding, BrowserClientMetadata } from 'src/common/decorators';
+import { BrowserClientMetadata } from 'src/modules/browser/decorators/browser-client-metadata.decorator';
+import { ApiQueryRedisStringEncoding } from 'src/common/decorators';
 import { BaseController } from 'src/modules/browser/controllers/base.controller';
 import {
   CreateRedisearchIndexDto,

redisinsight/api/src/modules/browser/controllers/rejson-rl/rejson-rl.controller.ts

@@ -19,7 +19,7 @@ import {
 } from 'src/modules/browser/dto';
 import { RejsonRlBusinessService } from 'src/modules/browser/services/rejson-rl-business/rejson-rl-business.service';
 import { ApiRedisInstanceOperation } from 'src/decorators/api-redis-instance-operation.decorator';
-import { BrowserClientMetadata } from 'src/common/decorators';
+import { BrowserClientMetadata } from 'src/modules/browser/decorators/browser-client-metadata.decorator';
 import { ClientMetadata } from 'src/common/models';
 
 @ApiTags('REJSON-RL')