Merge pull request #755 from rocket-admin/backend_refactoring

Backend refactoring
rocket-admin · Jul 25, 2024 · 04843cc · 04843cc
2 parents f5b6219 + 886a8ca
commit 04843cc
Show file tree

Hide file tree

Showing 26 changed files with 266 additions and 401 deletions.
diff --git a/backend/.eslintrc.cjs b/backend/.eslintrc.cjs
@@ -4,11 +4,7 @@ module.exports = {
     sourceType: 'module',
   },
   plugins: ['@typescript-eslint/eslint-plugin', 'security'],
-  extends: [
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier',
-  ],
+  extends: ['plugin:@typescript-eslint/eslint-recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
   root: true,
   env: {
     node: true,
@@ -19,7 +15,6 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/camelcase': 'off',
 
-
     'security/detect-buffer-noassert': 'error',
     'security/detect-child-process': 'error',
     'security/detect-disable-mustache-escape': 'error',
@@ -33,5 +28,15 @@ module.exports = {
     'security/detect-possible-timing-attacks': 'error',
     'security/detect-pseudoRandomBytes': 'error',
     'security/detect-unsafe-regex': 'error',
+
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        argsIgnorePattern: '^_[^_].*$|^_$',
+        varsIgnorePattern: '^_[^_].*$|^_$',
+        caughtErrorsIgnorePattern: '^_[^_].*$|^_$',
+      },
+    ],
   },
 };
diff --git a/backend/src/entities/connection/application/data-structures/found-one-connection.ds.ts b/backend/src/entities/connection/application/data-structures/found-one-connection.ds.ts
@@ -8,7 +8,7 @@ import {
 import { ApiProperty } from '@nestjs/swagger';
 
 export class FoundOneConnectionDs {
-  @ApiProperty()
+  @ApiProperty({ type: FoundDirectConnectionsDs })
   connection: FoundDirectConnectionsDs | FoundAgentConnectionsDs | FoundDirectConnectionsNonePermissionDs;
 
   @ApiProperty({ enum: AccessLevelEnum })
@@ -17,6 +17,6 @@ export class FoundOneConnectionDs {
   @ApiProperty()
   groupManagement: boolean;
 
-  @ApiProperty()
+  @ApiProperty({ type: FoundConnectionPropertiesDs })
   connectionProperties: FoundConnectionPropertiesDs;
 }
diff --git a/backend/src/entities/connection/application/data-structures/restored-connection.ds.ts b/backend/src/entities/connection/application/data-structures/restored-connection.ds.ts
@@ -1,7 +1,7 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { CreatedConnectionDs } from './created-connection.ds.js';
+import { CreatedConnectionDTO } from '../dto/created-connection.dto.js';
 
 export class RestoredConnectionDs {
   @ApiProperty()
-  connection: CreatedConnectionDs;
+  connection: CreatedConnectionDTO;
 }
diff --git a/.../data-structures/created-connection.ds.ts → ...application/dto/created-connection.dto.ts b/.../data-structures/created-connection.ds.ts → ...application/dto/created-connection.dto.ts
@@ -1,8 +1,22 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { ConnectionTypesEnum } from '@rocketadmin/shared-code/dist/src/data-access-layer/shared/enums/connection-types-enum.js';
-import { GroupEntity } from '../../../group/group.entity.js';
+import { FoundUserDs } from '../../../user/application/data-structures/found-user.ds.js';
 
-export class CreatedConnectionDs {
+export class CreatedGroupInConnectionDTO {
+  @ApiProperty()
+  id: string;
+
+  @ApiProperty()
+  title: string;
+
+  @ApiProperty()
+  isMain: boolean;
+
+  @ApiProperty({ isArray: true, type: FoundUserDs })
+  users: Array<FoundUserDs>;
+}
+
+export class CreatedConnectionDTO {
   @ApiProperty()
   id: string;
 
@@ -72,6 +86,6 @@ export class CreatedConnectionDs {
   @ApiProperty()
   authSource: string;
 
-  @ApiProperty({ isArray: true, type: GroupEntity })
-  groups: Array<GroupEntity>;
+  @ApiProperty({ isArray: true, type: CreatedGroupInConnectionDTO })
+  groups: Array<CreatedGroupInConnectionDTO>;
 }
diff --git a/backend/src/entities/connection/application/dto/updated-connection-responce.dto.ts b/backend/src/entities/connection/application/dto/updated-connection-responce.dto.ts
@@ -1,7 +1,7 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { CreatedConnectionDs } from '../data-structures/created-connection.ds.js';
+import { CreatedConnectionDTO } from './created-connection.dto.js';
 
 export class UpdatedConnectionResponseDTO {
   @ApiProperty()
-  connection: Omit<CreatedConnectionDs, 'groups'>;
+  connection: Omit<CreatedConnectionDTO, 'groups'>;
 }
diff --git a/backend/src/entities/connection/connection.controller.ts b/backend/src/entities/connection/connection.controller.ts
@@ -1,8 +1,8 @@
 import {
+  BadRequestException,
   Body,
   Controller,
   Get,
-  HttpStatus,
   Inject,
   Injectable,
   Post,
@@ -11,7 +11,6 @@ import {
   UseGuards,
   UseInterceptors,
 } from '@nestjs/common';
-import { HttpException } from '@nestjs/common/exceptions/http.exception.js';
 import validator from 'validator';
 import { IGlobalDatabaseContext } from '../../common/application/global-database-context.interface.js';
 import { BaseType, UseCaseType } from '../../common/data-injection.tokens.js';
@@ -34,12 +33,11 @@ import { FindUserDs } from '../user/application/data-structures/find-user.ds.js'
 import { FoundUserDs } from '../user/application/data-structures/found-user.ds.js';
 import { CreateConnectionDs } from './application/data-structures/create-connection.ds.js';
 import { CreateGroupInConnectionDs } from './application/data-structures/create-group-in-connection.ds.js';
-import { CreatedConnectionDs } from './application/data-structures/created-connection.ds.js';
+import { CreatedConnectionDTO } from './application/dto/created-connection.dto.js';
 import { DeleteConnectionDs } from './application/data-structures/delete-connection.ds.js';
 import { DeleteGroupInConnectionDs } from './application/data-structures/delete-group-in-connection.ds.js';
 import { FindOneConnectionDs } from './application/data-structures/find-one-connection.ds.js';
 import { FoundConnectionsDs } from './application/data-structures/found-connections.ds.js';
-import { FoundOneConnectionDs } from './application/data-structures/found-one-connection.ds.js';
 import { FoundUserGroupsInConnectionDs } from './application/data-structures/found-user-groups-in-connection.ds.js';
 import { GetGroupsInConnectionDs } from './application/data-structures/get-groups-in-connection.ds.js';
 import { GetPermissionsInConnectionDs } from './application/data-structures/get-permissions-in-connection.ds.js';
@@ -78,6 +76,8 @@ import { FoundPermissionsInConnectionDs } from './application/data-structures/fo
 import { TestConnectionResponseDTO } from './application/dto/test-connection-response.dto.js';
 import { ConnectionTokenResponseDTO } from './application/dto/new-connection-token-response.dto.js';
 import { UpdateMasterPasswordRequestBodyDto } from './application/dto/update-master-password-request-body.dto.js';
+import { FoundOneConnectionDs } from './application/data-structures/found-one-connection.ds.js';
+import { FoundGroupResponseDto } from '../group/dto/found-group-response.dto.js';
 
 @UseInterceptors(SentryInterceptor)
 @Controller()
@@ -202,37 +202,22 @@ export class ConnectionController {
   @ApiResponse({
     status: 201,
     description: 'Connection was created.',
-    type: CreatedConnectionDs,
+    type: CreatedConnectionDTO,
   })
   @Post('/connection')
   async create(
     @Body() createConnectionDto: CreateConnectionDto,
     @UserId() userId: string,
     @MasterPassword() masterPwd: string,
-  ): Promise<CreatedConnectionDs> {
+  ): Promise<CreatedConnectionDTO> {
     if (!createConnectionDto.password && !isConnectionTypeAgent(createConnectionDto.type)) {
-      throw new HttpException(
-        {
-          message: Messages.PASSWORD_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.PASSWORD_MISSING);
     }
     if (createConnectionDto.masterEncryption && !masterPwd) {
-      throw new HttpException(
-        {
-          message: Messages.MASTER_PASSWORD_REQUIRED,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.MASTER_PASSWORD_REQUIRED);
     }
     if (createConnectionDto.ssh && !createConnectionDto.privateSSHKey) {
-      throw new HttpException(
-        {
-          message: Messages.SSH_PASSWORD_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.SSH_PASSWORD_MISSING);
     }
     const createConnectionDs: CreateConnectionDs = {
       connection_parameters: {
@@ -284,12 +269,7 @@ export class ConnectionController {
       errors.push(Messages.MASTER_PASSWORD_REQUIRED);
     }
     if (errors.length > 0) {
-      throw new HttpException(
-        {
-          message: toPrettyErrorsMsg(errors),
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(toPrettyErrorsMsg(errors));
     }
     const connectionData: UpdateConnectionDs = {
       connection_parameters: {
@@ -329,7 +309,7 @@ export class ConnectionController {
   @ApiResponse({
     status: 200,
     description: 'Connection was deleted.',
-    type: CreatedConnectionDs,
+    type: CreatedConnectionDTO,
   })
   @UseGuards(ConnectionEditGuard)
   @Put('/connection/delete/:connectionId')
@@ -338,7 +318,7 @@ export class ConnectionController {
     @UserId() userId: string,
     @SlugUuid('connectionId') connectionId: string,
     @MasterPassword() masterPwd: string,
-  ): Promise<CreatedConnectionDs> {
+  ): Promise<CreatedConnectionDTO> {
     const inputData: DeleteConnectionDs = {
       connectionId: connectionId,
       cognitoUserName: userId,
@@ -367,22 +347,17 @@ export class ConnectionController {
   @ApiResponse({
     status: 200,
     description: 'Group was removed from connection.',
-    type: CreateDeleteGroupInConnectionResponseDTO,
+    type: FoundGroupResponseDto,
   })
   @UseGuards(ConnectionEditGuard)
   @Put('/connection/group/delete/:connectionId')
   async deleteGroupFromConnection(
     @BodyUuid('groupId') groupId: string,
     @SlugUuid('connectionId') connectionId: string,
     @UserId() userId: string,
-  ): Promise<CreateDeleteGroupInConnectionResponseDTO> {
+  ): Promise<FoundGroupResponseDto> {
     if (!groupId) {
-      throw new HttpException(
-        {
-          message: Messages.GROUP_ID_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.GROUP_ID_MISSING);
     }
     const inputData: DeleteGroupInConnectionDs = {
       groupId: groupId,
@@ -408,12 +383,7 @@ export class ConnectionController {
   ): Promise<Omit<GroupEntity, 'connection'>> {
     const { title } = groupData;
     if (!title) {
-      throw new HttpException(
-        {
-          message: Messages.GROUP_TITLE_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.GROUP_TITLE_MISSING);
     }
     const inputData: CreateGroupInConnectionDs = {
       group_parameters: {
@@ -439,12 +409,7 @@ export class ConnectionController {
     @SlugUuid('connectionId') connectionId: string,
   ): Promise<Array<FoundUserGroupsInConnectionDs>> {
     if (!connectionId) {
-      throw new HttpException(
-        {
-          message: Messages.ID_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.ID_MISSING);
     }
     const inputData: GetGroupsInConnectionDs = {
       connectionId: connectionId,
@@ -466,12 +431,7 @@ export class ConnectionController {
     @MasterPassword() masterPwd: string,
   ): Promise<IComplexPermission> {
     if (!connectionId || !groupId) {
-      throw new HttpException(
-        {
-          message: Messages.PARAMETER_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.PARAMETER_MISSING);
     }
     const inputData: GetPermissionsInConnectionDs = {
       groupId: groupId,
@@ -495,12 +455,7 @@ export class ConnectionController {
     @MasterPassword() masterPwd: string,
   ): Promise<IComplexPermission> {
     if (!connectionId || !groupId) {
-      throw new HttpException(
-        {
-          message: Messages.PARAMETER_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.PARAMETER_MISSING);
     }
     const inputData: GetPermissionsInConnectionDs = {
       groupId: groupId,
@@ -575,30 +530,15 @@ export class ConnectionController {
     @Body() passwordData: UpdateMasterPasswordRequestBodyDto,
   ): Promise<boolean> {
     if (!connectionId) {
-      throw new HttpException(
-        {
-          message: Messages.CONNECTION_ID_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.CONNECTION_ID_MISSING);
     }
     const { oldMasterPwd, newMasterPwd } = passwordData;
 
     if (!oldMasterPwd) {
-      throw new HttpException(
-        {
-          message: Messages.MASTED_OLD_PASSWORD_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.MASTED_OLD_PASSWORD_MISSING);
     }
     if (!newMasterPwd) {
-      throw new HttpException(
-        {
-          message: Messages.MASTED_NEW_PASSWORD_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.MASTED_NEW_PASSWORD_MISSING);
     }
     const inputData: UpdateMasterPasswordDs = {
       connectionId: connectionId,
@@ -661,12 +601,7 @@ export class ConnectionController {
     }
 
     if (errors.length > 0) {
-      throw new HttpException(
-        {
-          message: toPrettyErrorsMsg(errors),
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(toPrettyErrorsMsg(errors));
     }
     return await this.restoreConnectionUseCase.execute(connectionData, InTransactionEnum.ON);
   }
@@ -695,12 +630,7 @@ export class ConnectionController {
   @Get('/connection/token/refresh/:connectionId')
   async refreshConnectionAgentToken(@SlugUuid('connectionId') connectionId: string): Promise<{ token: string }> {
     if (!connectionId) {
-      throw new HttpException(
-        {
-          message: Messages.CONNECTION_ID_MISSING,
-        },
-        HttpStatus.BAD_REQUEST,
-      );
+      throw new BadRequestException(Messages.CONNECTION_ID_MISSING);
     }
     return await this.refreshConnectionAgentTokenUseCase.execute(connectionId, InTransactionEnum.ON);
   }