Merge pull request #1801 from rocket-admin/backend_config

refactor: migrate environment variable access to appConfig…

Author: Artuomka

backend/src/app.module.ts

@@ -46,12 +46,14 @@ import { SaaSGatewayModule } from './microservices/gateways/saas-gateway.ts/saas
 import { SaasModule } from './microservices/saas-microservice/saas.module.js';
 import { AppLoggerMiddleware } from './middlewares/logging-middleware/app-logger-middlewate.js';
 import { SelfHostedOperationsModule } from './selfhosted-operations/selhosted-operations.module.js';
+import { ConfigModule } from './shared/config/config.module.js';
 import { DatabaseModule } from './shared/database/database.module.js';
 import { SharedModule } from './shared/shared.module.js';
 import { GetHelloUseCase } from './use-cases-app/get-hello.use.case.js';
 
 @Module({
 	imports: [
+		ConfigModule,
 		ScheduleModule.forRoot(),
 		ThrottlerModule.forRoot({
 			throttlers: [

backend/src/authorization/auth-with-api.middleware.ts

@@ -19,6 +19,7 @@ import { Messages } from '../exceptions/text/messages.js';
 import { Constants } from '../helpers/constants/constants.js';
 import { Encryptor } from '../helpers/encryption/encryptor.js';
 import { isObjectEmpty } from '../helpers/is-object-empty.js';
+import { appConfig } from '../shared/config/app-config.js';
 import { IRequestWithCognitoInfo } from './cognito-decoded.interface.js';
 
 @Injectable()
@@ -60,7 +61,7 @@ export class AuthWithApiMiddleware implements NestMiddleware {
 
 	private async authenticateWithToken(tokenFromCookie: string, req: IRequestWithCognitoInfo): Promise<void> {
 		try {
-			const jwtSecret = process.env.JWT_SECRET;
+			const jwtSecret = appConfig.auth.jwtSecret;
 			const data = jwt.verify(tokenFromCookie, jwtSecret) as jwt.JwtPayload;
 			const userId = data.id;
 

backend/src/authorization/auth.middleware.ts

@@ -15,8 +15,10 @@ import { LogOutEntity } from '../entities/log-out/log-out.entity.js';
 import { JwtScopesEnum } from '../entities/user/enums/jwt-scopes.enum.js';
 import { UserEntity } from '../entities/user/user.entity.js';
 import { Messages } from '../exceptions/text/messages.js';
+import { isTest } from '../helpers/app/is-test.js';
 import { Constants } from '../helpers/constants/constants.js';
 import { isObjectEmpty } from '../helpers/is-object-empty.js';
+import { appConfig } from '../shared/config/app-config.js';
 import { IRequestWithCognitoInfo } from './cognito-decoded.interface.js';
 
 @Injectable()
@@ -32,7 +34,7 @@ export class AuthMiddleware implements NestMiddleware {
 		try {
 			token = req.cookies[Constants.JWT_COOKIE_KEY_NAME];
 		} catch (_e) {
-			if (process.env.NODE_ENV !== 'test') {
+			if (!isTest()) {
 				throw new UnauthorizedException('JWT verification failed');
 			}
 		}
@@ -47,7 +49,7 @@ export class AuthMiddleware implements NestMiddleware {
 		}
 
 		try {
-			const jwtSecret = process.env.JWT_SECRET;
+			const jwtSecret = appConfig.auth.jwtSecret;
 			const data = jwt.verify(token, jwtSecret) as jwt.JwtPayload;
 			const userId = data.id;
 

backend/src/authorization/basic-auth.middleware.ts

@@ -2,12 +2,13 @@ import { Injectable, NestMiddleware, UnauthorizedException } from '@nestjs/commo
 import auth from 'basic-auth';
 import { Request, Response } from 'express';
 import { Messages } from '../exceptions/text/messages.js';
+import { appConfig } from '../shared/config/app-config.js';
 
 @Injectable()
 export class BasicAuthMiddleware implements NestMiddleware {
 	use(req: Request, _res: Response, next: (err?: any, res?: any) => void): void {
-		const basicAuthLogin = process.env.BASIC_AUTH_LOGIN;
-		const basicAuthPassword = process.env.BASIC_AUTH_PWD;
+		const basicAuthLogin = appConfig.auth.basicAuthLogin;
+		const basicAuthPassword = appConfig.auth.basicAuthPassword;
 		const userCredentials = auth(req);
 		if (!userCredentials) {
 			throw new UnauthorizedException(Messages.AUTHORIZATION_REQUIRED);

backend/src/authorization/non-scoped-auth.middleware.ts

@@ -12,8 +12,10 @@ import jwt from 'jsonwebtoken';
 import { Repository } from 'typeorm';
 import { LogOutEntity } from '../entities/log-out/log-out.entity.js';
 import { Messages } from '../exceptions/text/messages.js';
+import { isTest } from '../helpers/app/is-test.js';
 import { Constants } from '../helpers/constants/constants.js';
 import { isObjectEmpty } from '../helpers/is-object-empty.js';
+import { appConfig } from '../shared/config/app-config.js';
 import { IRequestWithCognitoInfo } from './cognito-decoded.interface.js';
 
 @Injectable()
@@ -28,7 +30,7 @@ export class NonScopedAuthMiddleware implements NestMiddleware {
 		try {
 			token = req.cookies[Constants.JWT_COOKIE_KEY_NAME];
 		} catch (_e) {
-			if (process.env.NODE_ENV !== 'test') {
+			if (!isTest()) {
 				throw new UnauthorizedException('JWT verification failed');
 			}
 		}
@@ -43,7 +45,7 @@ export class NonScopedAuthMiddleware implements NestMiddleware {
 		}
 
 		try {
-			const jwtSecret = process.env.JWT_SECRET;
+			const jwtSecret = appConfig.auth.jwtSecret;
 			const data = jwt.verify(token, jwtSecret) as jwt.JwtPayload;
 			const userId = data.id;
 			if (!userId) {

backend/src/authorization/saas-auth.middleware.ts

@@ -2,6 +2,7 @@ import { Injectable, NestMiddleware, UnauthorizedException } from '@nestjs/commo
 import { Response } from 'express';
 import jwt from 'jsonwebtoken';
 import { Messages } from '../exceptions/text/messages.js';
+import { appConfig } from '../shared/config/app-config.js';
 import { IRequestWithCognitoInfo } from './cognito-decoded.interface.js';
 import { extractTokenFromHeader } from './utils/extract-token-from-header.js';
 
@@ -14,7 +15,7 @@ export class SaaSAuthMiddleware implements NestMiddleware {
 			throw new UnauthorizedException('Token is missing');
 		}
 		try {
-			const jwtSecret = process.env.MICROSERVICE_JWT_SECRET;
+			const jwtSecret = appConfig.auth.microserviceJwtSecret;
 			const data = jwt.verify(token, jwtSecret) as jwt.JwtPayload;
 			const requestId = data.request_id;
 

backend/src/authorization/temporary-auth.middleware.ts

@@ -13,8 +13,10 @@ import { Repository } from 'typeorm';
 import { LogOutEntity } from '../entities/log-out/log-out.entity.js';
 import { UserEntity } from '../entities/user/user.entity.js';
 import { Messages } from '../exceptions/text/messages.js';
+import { isTest } from '../helpers/app/is-test.js';
 import { Constants } from '../helpers/constants/constants.js';
 import { isObjectEmpty } from '../helpers/is-object-empty.js';
+import { appConfig } from '../shared/config/app-config.js';
 import { IRequestWithCognitoInfo } from './cognito-decoded.interface.js';
 
 @Injectable()
@@ -30,7 +32,7 @@ export class TemporaryAuthMiddleware implements NestMiddleware {
 		try {
 			token = req.cookies[Constants.JWT_COOKIE_KEY_NAME];
 		} catch (_e) {
-			if (process.env.NODE_ENV !== 'test') {
+			if (!isTest()) {
 				throw new UnauthorizedException('JWT verification failed');
 			}
 		}
@@ -45,7 +47,7 @@ export class TemporaryAuthMiddleware implements NestMiddleware {
 		}
 
 		try {
-			const jwtSecret = process.env.TEMPORARY_JWT_SECRET;
+			const jwtSecret = appConfig.auth.temporaryJwtSecret;
 			const data = jwt.verify(token, jwtSecret) as jwt.JwtPayload;
 			const userId = data.id;
 			if (!userId) {

backend/src/entities/agent/repository/custom-agent-repository-extension.ts

@@ -1,5 +1,6 @@
 import { ConnectionTypeTestEnum } from '@rocketadmin/shared-code/dist/src/shared/enums/connection-types-enum.js';
 import { nanoid } from 'nanoid';
+import { isTest } from '../../../helpers/app/is-test.js';
 import { ConnectionEntity } from '../../connection/connection.entity.js';
 import { AgentEntity } from '../agent.entity.js';
 import { IAgentRepository } from './agent.repository.interface.js';
@@ -12,7 +13,7 @@ export const customAgentRepositoryExtension: IAgentRepository = {
 
 	async createNewAgentForConnection(connection: ConnectionEntity): Promise<AgentEntity> {
 		const agent = new AgentEntity();
-		const token = process.env.NODE_ENV !== 'test' ? nanoid(64) : this.getTestAgentToken(connection.type);
+		const token = !isTest() ? nanoid(64) : this.getTestAgentToken(connection.type);
 		agent.setToken(token);
 		agent.connection = connection;
 		const savedAgent = await this.save(agent);
@@ -41,7 +42,7 @@ export const customAgentRepositoryExtension: IAgentRepository = {
 	},
 
 	getTestAgentToken(connectionType: ConnectionTypeTestEnum): string {
-		if (process.env.NODE_ENV !== 'test') throw new Error('Test agent token can only be used in test environment');
+		if (!isTest()) throw new Error('Test agent token can only be used in test environment');
 		switch (connectionType) {
 			case ConnectionTypeTestEnum.agent_oracledb:
 				return 'ORACLE-TEST-AGENT-TOKEN';

backend/src/entities/ai/user-ai-requests-v2.controller.ts

@@ -21,6 +21,7 @@ import { UserId } from '../../decorators/user-id.decorator.js';
 import { InTransactionEnum } from '../../enums/in-transaction.enum.js';
 import { ConnectionEditGuard } from '../../guards/connection-edit.guard.js';
 import { TableAiRequestGuard } from '../../guards/table-ai-request.guard.js';
+import { isTest } from '../../helpers/app/is-test.js';
 import { ValidationHelper } from '../../helpers/validators/validation-helper.js';
 import { SentryInterceptor } from '../../interceptors/sentry.interceptor.js';
 import { IAISettingsAndWidgetsCreation, IRequestInfoFromTableV2 } from './ai-use-cases.interface.js';
@@ -51,7 +52,7 @@ export class UserAIRequestsControllerV2 {
 	@ApiBody({ type: RequestInfoFromTableBodyDTO })
 	@ApiQuery({ name: 'tableName', required: true, type: String })
 	@ApiQuery({ name: 'threadId', required: false, type: String })
-	@Timeout(process.env.NODE_ENV !== 'test' ? TimeoutDefaults.AI : TimeoutDefaults.AI_TEST)
+	@Timeout(!isTest() ? TimeoutDefaults.AI : TimeoutDefaults.AI_TEST)
 	@Post('/ai/v4/request/:connectionId')
 	public async requestInfoFromTableWithAIWithHistory(
 		@SlugUuid('connectionId') connectionId: string,
@@ -90,7 +91,7 @@ export class UserAIRequestsControllerV2 {
 		description: 'AI settings and widgets creation job has been queued.',
 	})
 	@UseGuards(ConnectionEditGuard)
-	@Timeout(process.env.NODE_ENV !== 'test' ? TimeoutDefaults.AI : TimeoutDefaults.AI_TEST)
+	@Timeout(!isTest() ? TimeoutDefaults.AI : TimeoutDefaults.AI_TEST)
 	@Get('/ai/v2/setup/:connectionId')
 	public async requestAISettingsAndWidgetsCreation(
 		@SlugUuid('connectionId') connectionId: string,

backend/src/entities/amplitude/amplitude.service.ts

@@ -3,6 +3,8 @@ import { Injectable, OnModuleInit } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
 import { AmplitudeEventTypeEnum } from '../../enums/amplitude-event-type.enum.js';
+import { isTest } from '../../helpers/app/is-test.js';
+import { appConfig } from '../../shared/config/app-config.js';
 import { UserEntity } from '../user/user.entity.js';
 
 export interface AmplitudeLogOptions {
@@ -23,8 +25,9 @@ export class AmplitudeService implements OnModuleInit {
 	) {}
 
 	public onModuleInit(): void {
-		if (process.env.AMPLITUDE_API_KEY) {
-			this.client = Amplitude.init(process.env.AMPLITUDE_API_KEY);
+		const amplitudeApiKey = appConfig.thirdParty.amplitudeApiKey;
+		if (amplitudeApiKey) {
+			this.client = Amplitude.init(amplitudeApiKey);
 		}
 	}
 
@@ -34,7 +37,7 @@ export class AmplitudeService implements OnModuleInit {
 		options?: AmplitudeLogOptions,
 	): Promise<void> {
 		try {
-			if (process.env.NODE_ENV === 'test') return;
+			if (isTest()) return;
 			let user_email = (await this.userRepository.findOne({ where: { id: user_id } }))?.email;
 			if (!user_email && options) {
 				user_email = options.user_email;