Merge pull request #3955 from RedisInsight/be/feature/api-packages

move to newest class-transformer and class-validator

Author: ArtemHoruzhenko

redisinsight/api/package.json

@@ -63,8 +63,8 @@
     "axios": "^1.7.4",
     "body-parser": "^1.20.3",
     "busboy": "^1.6.0",
-    "class-transformer": "^0.2.3",
-    "class-validator": "^0.14.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "combined-stream": "^1.0.8",
     "connect-timeout": "^1.9.0",
     "date-fns": "^2.29.3",

redisinsight/api/src/__mocks__/browser-history.ts

@@ -1,4 +1,4 @@
-import { plainToClass } from 'class-transformer';
+import { plainToInstance } from 'class-transformer';
 import { v4 as uuidv4 } from 'uuid';
 import {
   mockDatabase,
@@ -26,7 +26,7 @@ export const mockBrowserHistoryRepository = jest.fn(() => ({
 
 export const mockCreateBrowserHistoryDto: CreateBrowserHistoryDto = {
   mode: BrowserHistoryMode.Pattern,
-  filter: plainToClass(ScanFilter, {
+  filter: plainToInstance(ScanFilter, {
     type: RedisDataType.String,
     match: 'key*',
   }),

redisinsight/api/src/__mocks__/cloud-user.ts

@@ -7,7 +7,7 @@ import {
   ICloudCapiAccount,
 } from 'src/modules/cloud/user/models';
 import config, { Config } from 'src/utils/config';
-import { classToPlain } from 'class-transformer';
+import { instanceToPlain } from 'class-transformer';
 import { mockCloudApiCapiAccessKey, mockCloudCapiAuthDto, mockCloudCapiKey } from 'src/__mocks__/cloud-capi-key';
 import { mockCloudApiAuthDto, mockCloudSession } from 'src/__mocks__/cloud-session';
 
@@ -102,7 +102,7 @@ export const mockCloudUser = Object.assign(new CloudUser(), {
   capiKey: mockCloudCapiKey,
 });
 
-export const mockCloudUserSafe = classToPlain(mockCloudUser); // omits all data in the "security" group
+export const mockCloudUserSafe = instanceToPlain(mockCloudUser); // omits all data in the "security" group
 
 export const mockCloudApiAccount: ICloudApiAccount = {
   id: mockCloudCapiAccount.id,

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

@@ -1,5 +1,5 @@
 import { BadRequestException, createParamDecorator, ExecutionContext } from '@nestjs/common';
-import { plainToClass } from 'class-transformer';
+import { plainToInstance } from 'class-transformer';
 import { ClientContext, ClientMetadata } from 'src/common/models';
 import { Validator } from 'class-validator';
 import { API_HEADER_DATABASE_INDEX, API_PARAM_DATABASE_ID } from 'src/common/constants';
@@ -31,7 +31,7 @@ export const clientMetadataParamFactory = (
     uniqueId = req.params?.[options.uniqueIdParam];
   }
 
-  const clientMetadata = plainToClass(ClientMetadata, {
+  const clientMetadata = plainToInstance(ClientMetadata, {
     sessionMetadata: sessionMetadataFromRequestExecutionContext(undefined, ctx),
     databaseId,
     uniqueId,

redisinsight/api/src/common/decorators/data-as-json-string.decorator.ts

@@ -3,13 +3,16 @@ import { Transform } from 'class-transformer';
 
 export function DataAsJsonString() {
   return applyDecorators(
-    Transform((object) => JSON.stringify(object), { toClassOnly: true }),
-    Transform((string) => {
-      try {
-        return JSON.parse(string);
-      } catch (e) {
-        return undefined;
-      }
-    }, { toPlainOnly: true }),
+    Transform(({ value }) => JSON.stringify(value), { toClassOnly: true }),
+    Transform(
+      ({ value }) => {
+        try {
+          return JSON.parse(value);
+        } catch (e) {
+          return undefined;
+        }
+      },
+      { toPlainOnly: true },
+    ),
   );
 }

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

@@ -2,5 +2,5 @@ import { Transform } from 'class-transformer';
 import { cloneDeep } from 'lodash';
 
 export function Default(defaultValue: unknown): PropertyDecorator {
-  return Transform((value: unknown) => value ?? cloneDeep(defaultValue));
+  return Transform(({ value }) => value ?? cloneDeep(defaultValue));
 }

redisinsight/api/src/common/decorators/hidden-field.decorator.ts

@@ -1,7 +1,7 @@
 import { Transform } from 'class-transformer';
 
 export function HiddenField(field: any): PropertyDecorator {
-  return Transform((value: string) => (value ? field : undefined), {
+  return Transform(({ value }) => (value ? field : undefined), {
     toPlainOnly: true,
   });
 }

redisinsight/api/src/common/decorators/object-as-map.decorator.ts

@@ -1,35 +1,41 @@
 import { forEach } from 'lodash';
 import { applyDecorators } from '@nestjs/common';
-import { classToPlain, plainToClass, Transform } from 'class-transformer';
-import { ClassType } from 'class-transformer/ClassTransformer';
+import { instanceToPlain, plainToInstance, Transform } from 'class-transformer';
+import { ClassConstructor } from 'class-transformer/types/interfaces';
 
-export function ObjectAsMap<T>(targetClass: ClassType<T>) {
+export function ObjectAsMap<T>(targetClass: ClassConstructor<T>) {
   return applyDecorators(
-    Transform((object = {}): Map<string, T> => {
-      const result = new Map();
+    Transform(
+      ({ value: object }): Map<string, T> => {
+        const result = new Map();
 
-      try {
-        forEach(object, (value, key) => {
-          result.set(key, plainToClass(targetClass, value));
-        });
+        try {
+          forEach(object, (value, key) => {
+            result.set(key, plainToInstance(targetClass, value));
+          });
 
-        return result;
-      } catch (e) {
-        return result;
-      }
-    }, { toClassOnly: true }),
-    Transform((map): object => {
-      try {
-        const result = {};
+          return result;
+        } catch (e) {
+          return result;
+        }
+      },
+      { toClassOnly: true },
+    ),
+    Transform(
+      ({ value: map }): object => {
+        try {
+          const result = {};
 
-        forEach(Array.from(map), ([key, value]) => {
-          result[key] = classToPlain(value);
-        });
+          forEach(Array.from(map), ([key, value]) => {
+            result[key] = instanceToPlain(value);
+          });
 
-        return result;
-      } catch (e) {
-        return undefined;
-      }
-    }, { toPlainOnly: true }),
+          return result;
+        } catch (e) {
+          return undefined;
+        }
+      },
+      { toPlainOnly: true },
+    ),
   );
 }

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

@@ -1,5 +1,5 @@
 import { BadRequestException, createParamDecorator, ExecutionContext } from '@nestjs/common';
-import { plainToClass } from 'class-transformer';
+import { plainToInstance } from 'class-transformer';
 import { Validator } from 'class-validator';
 import { Request } from 'express';
 import { SessionMetadata } from 'src/common/models';
@@ -16,7 +16,7 @@ export const sessionMetadataFromRequest = (request: Request): SessionMetadata =>
   };
 
   // todo: do not forget to deal with session vs sessionMetadata property
-  const session = plainToClass(SessionMetadata, requestSession);
+  const session = plainToInstance(SessionMetadata, requestSession);
 
   const errors = validator.validateSync(session, {
     whitelist: false, // we need this to allow additional fields if needed for flexibility

redisinsight/api/src/common/middlewares/single-user-auth.middleware.ts

@@ -6,7 +6,7 @@ import { NextFunction, Request, Response } from 'express';
 import { ISessionMetadata, Session, SessionMetadata } from 'src/common/models/session';
 import { DEFAULT_SESSION_ID, DEFAULT_USER_ID } from 'src/common/constants';
 import { SessionService } from 'src/modules/session/session.service';
-import { plainToClass } from 'class-transformer';
+import { plainToInstance } from 'class-transformer';
 
 @Injectable()
 export class SingleUserAuthMiddleware implements NestMiddleware {
@@ -16,7 +16,7 @@ export class SingleUserAuthMiddleware implements NestMiddleware {
 
   async use(req: Request, res: Response, next: NextFunction): Promise<any> {
     if (!await this.sessionService.getSession(DEFAULT_SESSION_ID)) {
-      await this.sessionService.createSession(plainToClass(Session, {
+      await this.sessionService.createSession(plainToInstance(Session, {
         id: DEFAULT_SESSION_ID,
         userId: DEFAULT_USER_ID,
         data: {
@@ -30,7 +30,7 @@ export class SingleUserAuthMiddleware implements NestMiddleware {
     }
 
     res.locals.session = {
-      data: <ISessionMetadata>Object.freeze(plainToClass(SessionMetadata, {
+      data: <ISessionMetadata>Object.freeze(plainToInstance(SessionMetadata, {
         userId: DEFAULT_USER_ID,
         sessionId: DEFAULT_SESSION_ID,
       })),