Merge pull request #1719 from rocket-admin/backend_pg_proxy

Backend pg proxy

Author: Artuomka

backend/src/common/data-injection.tokens.ts

@@ -119,6 +119,7 @@ export enum UseCaseType {
 	SAAS_DELETE_CONNECTION_FOR_HOSTED_DB = 'SAAS_DELETE_CONNECTION_FOR_HOSTED_DB',
 	SAAS_UPDATE_HOSTED_CONNECTION_PASSWORD = 'SAAS_UPDATE_HOSTED_CONNECTION_PASSWORD',
 	SAAS_GET_CONNECTIONS_INFO_BY_IDS = 'SAAS_GET_CONNECTIONS_INFO_BY_IDS',
+	SAAS_GET_HOSTED_CONNECTION_CREDENTIALS = 'SAAS_GET_HOSTED_CONNECTION_CREDENTIALS',
 
 	INVITE_USER_IN_COMPANY_AND_CONNECTION_GROUP = 'INVITE_USER_IN_COMPANY_AND_CONNECTION_GROUP',
 	VERIFY_INVITE_USER_IN_COMPANY_AND_CONNECTION_GROUP = 'VERIFY_INVITE_USER_IN_COMPANY_AND_CONNECTION_GROUP',

backend/src/microservices/saas-microservice/data-structures/get-hosted-connection-credentials.dto.ts

@@ -0,0 +1,9 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class GetHostedConnectionCredentialsDto {
+	@ApiProperty()
+	@IsString()
+	@IsNotEmpty()
+	hostedDatabaseId: string;
+}

backend/src/microservices/saas-microservice/data-structures/hosted-connection-credentials.ro.ts

@@ -0,0 +1,24 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class HostedConnectionCredentialsRO {
+	@ApiProperty()
+	connectionId: string;
+
+	@ApiProperty()
+	host: string;
+
+	@ApiProperty()
+	port: number;
+
+	@ApiProperty()
+	database: string;
+
+	@ApiProperty()
+	username: string;
+
+	@ApiProperty()
+	password: string;
+
+	@ApiProperty()
+	is_frozen: boolean;
+}

backend/src/microservices/saas-microservice/saas.controller.ts

@@ -29,6 +29,8 @@ import { CreateConnectionForHostedDbDto } from './data-structures/create-connect
 import { DeleteConnectionForHostedDbDto } from './data-structures/delete-connection-for-hosted-db.dto.js';
 import { FoundConnectionInfoRO } from './data-structures/found-connection-info.ro.js';
 import { GetConnectionsInfoByIdsDS } from './data-structures/get-connections-info-by-ids.ds.js';
+import { GetHostedConnectionCredentialsDto } from './data-structures/get-hosted-connection-credentials.dto.js';
+import { HostedConnectionCredentialsRO } from './data-structures/hosted-connection-credentials.ro.js';
 import { RegisterCompanyWebhookDS } from './data-structures/register-company.ds.js';
 import { RegisteredCompanyDS } from './data-structures/registered-company.ds.js';
 import { SaasRegisterUserWithGithub } from './data-structures/saas-register-user-with-github.js';
@@ -41,6 +43,7 @@ import {
 	IDeleteConnectionForHostedDb,
 	IFreezeConnectionsInCompany,
 	IGetConnectionsInfoByIds,
+	IGetHostedConnectionCredentials,
 	IGetUserInfo,
 	ILoginUserWithGitHub,
 	ILoginUserWithGoogle,
@@ -100,6 +103,8 @@ export class SaasController {
 		private readonly updateHostedConnectionPasswordUseCase: IUpdateHostedConnectionPassword,
 		@Inject(UseCaseType.SAAS_GET_CONNECTIONS_INFO_BY_IDS)
 		private readonly getConnectionsInfoByIdsUseCase: IGetConnectionsInfoByIds,
+		@Inject(UseCaseType.SAAS_GET_HOSTED_CONNECTION_CREDENTIALS)
+		private readonly getHostedConnectionCredentialsUseCase: IGetHostedConnectionCredentials,
 	) {}
 
 	@ApiOperation({ summary: 'Company registered webhook' })
@@ -344,4 +349,17 @@ export class SaasController {
 	): Promise<Array<FoundConnectionInfoRO>> {
 		return await this.getConnectionsInfoByIdsUseCase.execute(connectionsData);
 	}
+
+	@ApiOperation({ summary: 'Get decrypted credentials for a hosted connection' })
+	@ApiBody({ type: GetHostedConnectionCredentialsDto })
+	@ApiResponse({
+		status: 200,
+		type: HostedConnectionCredentialsRO,
+	})
+	@Post('/connection/hosted/credentials')
+	async getHostedConnectionCredentials(
+		@Body() data: GetHostedConnectionCredentialsDto,
+	): Promise<HostedConnectionCredentialsRO> {
+		return await this.getHostedConnectionCredentialsUseCase.execute(data);
+	}
 }

backend/src/microservices/saas-microservice/saas.module.ts

@@ -12,6 +12,7 @@ import { DeleteConnectionForHostedDbUseCase } from './use-cases/delete-connectio
 import { FreezeConnectionsInCompanyUseCase } from './use-cases/freeze-connections-in-company.use.case.js';
 import { GetConnectionsInfoByIdsUseCase } from './use-cases/get-connections-info-by-ids.use.case.js';
 import { GetFullCompanyInfoByUserIdUseCase } from './use-cases/get-full-company-info-by-user-id.use.case.js';
+import { GetHostedConnectionCredentialsUseCase } from './use-cases/get-hosted-connection-credentials.use.case.js';
 import { GetUserInfoUseCase } from './use-cases/get-user-info.use.case.js';
 import { GetUsersCountInCompanyByIdUseCase } from './use-cases/get-users-count-in-company.use.case.js';
 import { GetUsersInfosByEmailUseCase } from './use-cases/get-users-infos-by-email.use.case.js';
@@ -105,6 +106,10 @@ import { UpdateHostedConnectionPasswordUseCase } from './use-cases/update-hosted
 			provide: UseCaseType.SAAS_GET_CONNECTIONS_INFO_BY_IDS,
 			useClass: GetConnectionsInfoByIdsUseCase,
 		},
+		{
+			provide: UseCaseType.SAAS_GET_HOSTED_CONNECTION_CREDENTIALS,
+			useClass: GetHostedConnectionCredentialsUseCase,
+		},
 		SignInAuditService,
 	],
 	controllers: [SaasController],
@@ -131,6 +136,7 @@ export class SaasModule {
 				{ path: 'saas/connection/hosted', method: RequestMethod.POST },
 				{ path: 'saas/connection/hosted/delete', method: RequestMethod.POST },
 				{ path: 'saas/connection/hosted/password', method: RequestMethod.POST },
+				{ path: 'saas/connection/hosted/credentials', method: RequestMethod.POST },
 				{ path: 'saas/connections/info', method: RequestMethod.POST },
 			);
 	}

backend/src/microservices/saas-microservice/use-cases/get-hosted-connection-credentials.use.case.ts

@@ -0,0 +1,40 @@
+import { Inject, Injectable, NotFoundException, Scope } from '@nestjs/common';
+import AbstractUseCase from '../../../common/abstract-use.case.js';
+import { IGlobalDatabaseContext } from '../../../common/application/global-database-context.interface.js';
+import { BaseType } from '../../../common/data-injection.tokens.js';
+import { Messages } from '../../../exceptions/text/messages.js';
+import { GetHostedConnectionCredentialsDto } from '../data-structures/get-hosted-connection-credentials.dto.js';
+import { HostedConnectionCredentialsRO } from '../data-structures/hosted-connection-credentials.ro.js';
+import { IGetHostedConnectionCredentials } from './saas-use-cases.interface.js';
+
+@Injectable({ scope: Scope.REQUEST })
+export class GetHostedConnectionCredentialsUseCase
+	extends AbstractUseCase<GetHostedConnectionCredentialsDto, HostedConnectionCredentialsRO>
+	implements IGetHostedConnectionCredentials
+{
+	constructor(
+		@Inject(BaseType.GLOBAL_DB_CONTEXT)
+		protected _dbContext: IGlobalDatabaseContext,
+	) {
+		super();
+	}
+
+	protected async implementation(inputData: GetHostedConnectionCredentialsDto): Promise<HostedConnectionCredentialsRO> {
+		const connection = await this._dbContext.connectionRepository.findOne({
+			where: { id: inputData.hostedDatabaseId },
+		});
+		if (!connection) {
+			throw new NotFoundException(Messages.CONNECTION_NOT_FOUND);
+		}
+
+		return {
+			connectionId: connection.id,
+			host: connection.host,
+			port: connection.port,
+			database: connection.database,
+			username: connection.username,
+			password: connection.password,
+			is_frozen: connection.is_frozen,
+		};
+	}
+}

backend/src/microservices/saas-microservice/use-cases/saas-use-cases.interface.ts

@@ -11,6 +11,8 @@ import { DeleteConnectionForHostedDbDto } from '../data-structures/delete-connec
 import { FoundConnectionInfoRO } from '../data-structures/found-connection-info.ro.js';
 import { FreezeConnectionsInCompanyDS } from '../data-structures/freeze-connections-in-company.ds.js';
 import { GetConnectionsInfoByIdsDS } from '../data-structures/get-connections-info-by-ids.ds.js';
+import { GetHostedConnectionCredentialsDto } from '../data-structures/get-hosted-connection-credentials.dto.js';
+import { HostedConnectionCredentialsRO } from '../data-structures/hosted-connection-credentials.ro.js';
 import { GetUserInfoByIdDS } from '../data-structures/get-user-info.ds.js';
 import { GetUsersInfosByEmailDS } from '../data-structures/get-users-infos-by-email.ds.js';
 import { RegisterCompanyWebhookDS } from '../data-structures/register-company.ds.js';
@@ -88,3 +90,7 @@ export interface IUpdateHostedConnectionPassword {
 export interface IGetConnectionsInfoByIds {
 	execute(inputData: GetConnectionsInfoByIdsDS): Promise<Array<FoundConnectionInfoRO>>;
 }
+
+export interface IGetHostedConnectionCredentials {
+	execute(inputData: GetHostedConnectionCredentialsDto): Promise<HostedConnectionCredentialsRO>;
+}

backend/test/ava-tests/saas-tests/hosted-connection-e2e.test.ts

@@ -79,6 +79,7 @@ test.serial(`${currentTest} should create a hosted postgres connection with admi
 			.send({
 				companyId: companyId,
 				userId: userId,
+				hostedDatabaseId: faker.string.uuid(),
 				databaseName: 'postgres',
 				hostname: 'testPg-e2e-testing',
 				port: 5432,
@@ -89,24 +90,14 @@ test.serial(`${currentTest} should create a hosted postgres connection with admi
 			.set('Content-Type', 'application/json')
 			.set('Accept', 'application/json');
 
-		t.is(createHostedConnectionResult.status, 201);
-
 		const createdConnection = JSON.parse(createHostedConnectionResult.text);
-		const connectionId = createdConnection.id;
+		console.log('🚀 ~ createdConnection:', createdConnection);
+
+		t.is(createHostedConnectionResult.status, 201);
+		const connectionId = createdConnection.connectionId;
 
 		// Verify connection was created
 		t.truthy(connectionId);
-		t.is(createdConnection.type, 'postgres');
-		t.is(createdConnection.database, 'postgres');
-		t.is(createdConnection.host, 'testPg-e2e-testing');
-		t.is(createdConnection.port, 5432);
-
-		// Verify admin group was created
-		t.truthy(createdConnection.groups);
-		t.is(createdConnection.groups.length, 1);
-		const adminGroup = createdConnection.groups[0];
-		t.truthy(adminGroup.id);
-		t.is(adminGroup.isMain, true);
 
 		// Verify connection is accessible via connection groups endpoint
 		const groupsResponse = await request(app.getHttpServer())
@@ -119,6 +110,7 @@ test.serial(`${currentTest} should create a hosted postgres connection with admi
 		const groups = JSON.parse(groupsResponse.text);
 		t.is(groups.length, 1);
 		t.is(groups[0].accessLevel, AccessLevelEnum.edit);
+		const adminGroup = groups[0];
 
 		// Verify tables endpoint works with this connection
 		const findTablesResponse = await request(app.getHttpServer())
@@ -132,8 +124,9 @@ test.serial(`${currentTest} should create a hosted postgres connection with admi
 		t.true(Array.isArray(tables));
 
 		// Verify user permissions - user should have full access
+		const groupId = adminGroup.group.id;
 		const permissionsResponse = await request(app.getHttpServer())
-			.get(`/connection/permissions?connectionId=${connectionId}&groupId=${adminGroup.id}`)
+			.get(`/connection/permissions?connectionId=${connectionId}&groupId=${groupId}`)
 			.set('Content-Type', 'application/json')
 			.set('Cookie', token)
 			.set('Accept', 'application/json');
@@ -177,6 +170,7 @@ test.serial(`${currentTest} should return error when userId does not exist`, asy
 			.send({
 				companyId: faker.string.uuid(),
 				userId: faker.string.uuid(),
+				hostedDatabaseId: faker.string.uuid(),
 				databaseName: 'postgres',
 				hostname: 'testPg-e2e-testing',
 				port: 5432,
@@ -187,6 +181,8 @@ test.serial(`${currentTest} should return error when userId does not exist`, asy
 			.set('Content-Type', 'application/json')
 			.set('Accept', 'application/json');
 
+		const responseBody = JSON.parse(result.text);
+		console.log('🚀 ~ responseBody:', responseBody);
 		t.is(result.status, 500);
 	} catch (e) {
 		console.error('Test error:', e);
@@ -219,6 +215,7 @@ test.serial(`${currentTest} should delete a hosted connection`, async (t) => {
 			.send({
 				companyId: companyId,
 				userId: userId,
+				hostedDatabaseId: faker.string.uuid(),
 				databaseName: 'postgres',
 				hostname: 'testPg-e2e-testing',
 				port: 5432,
@@ -229,9 +226,10 @@ test.serial(`${currentTest} should delete a hosted connection`, async (t) => {
 			.set('Content-Type', 'application/json')
 			.set('Accept', 'application/json');
 
-		t.is(createResult.status, 201);
 		const createdConnection = JSON.parse(createResult.text);
-		const connectionId = createdConnection.id;
+		console.log('🚀 ~ createdConnection:', createdConnection);
+		t.is(createResult.status, 201);
+		const connectionId = createdConnection.connectionId;
 
 		// Verify connection exists
 		const connectionsBeforeDelete = await request(app.getHttpServer())