Merge pull request #179 from AlvaroDavi5/develop

Develop

Author: AlvaroDavi5

package-lock.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json.schemastore.org/package.json",
 	"name": "node_backend_boilerplate",
-	"version": "6.3.3",
+	"version": "6.4.0",
 	"description": "Node.js Boilerplate for Back-End using TypeScript",
 	"license": "MIT",
 	"private": false,

package.json

@@ -5,7 +5,7 @@ import UsersModel from '@core/infra/database/models/Users.model';
 import UserPreferencesModel from '@core/infra/database/models/UserPreferences.model';
 
 
-async function getConnection() {
+async function getConnection(): Promise<DataSource> {
 	const connection = new DataSource(dbConfig);
 
 	const isInitialized = await testConnection(connection, console);
@@ -29,7 +29,7 @@ function getRepositories(connection: DataSource) {
 	};
 }
 
-async function seedDatabase() {
+async function seedDatabase(): Promise<void> {
 	const connection = await getConnection();
 	const { userRepository, userPreferenceRepository } = getRepositories(connection);
 

scripts/seed.ts

@@ -5,7 +5,7 @@ import {
 	Get, Post, Put, Patch, Delete,
 	UseGuards, UseFilters, UseInterceptors,
 } from '@nestjs/common';
-import { ApiOperation, ApiTags, ApiProduces, ApiConsumes, ApiOkResponse, ApiCreatedResponse, ApiNoContentResponse } from '@nestjs/swagger';
+import { ApiOperation, ApiTags, ApiParam, ApiProduces, ApiConsumes, ApiOkResponse, ApiCreatedResponse, ApiNoContentResponse } from '@nestjs/swagger';
 import { ModuleRef } from '@nestjs/core';
 import Exceptions from '@core/errors/Exceptions';
 import UserEntity, { IViewUser } from '@domain/entities/User.entity';
@@ -157,6 +157,7 @@ export default class UserController implements OnModuleInit {
 		deprecated: false,
 	})
 	@Get('/:userId')
+	@ApiParam({ name: 'userId', required: true, example: 'f0805007-af7a-4845-9c72-4f9d3f855380' })
 	@ApiOkResponse({ type: UserEntity })
 	@ApiConsumes('application/json')
 	@ApiProduces('application/json')
@@ -179,6 +180,7 @@ export default class UserController implements OnModuleInit {
 		deprecated: false,
 	})
 	@Patch('/:userId')
+	@ApiParam({ name: 'userId', required: true, example: 'f0805007-af7a-4845-9c72-4f9d3f855380' })
 	@ApiOkResponse({ type: UserEntity })
 	@ApiConsumes('application/json')
 	@ApiProduces('application/json')
@@ -202,6 +204,7 @@ export default class UserController implements OnModuleInit {
 		deprecated: false,
 	})
 	@Delete('/:userId')
+	@ApiParam({ name: 'userId', required: true, example: 'f0805007-af7a-4845-9c72-4f9d3f855380' })
 	@ApiNoContentResponse({})
 	@ApiConsumes('application/json')
 	@ApiProduces('application/json')

src/modules/app/user/api/controllers/User.controller.ts

@@ -43,7 +43,7 @@ export async function syncConnection(connection: DataSource, logger?: Logger | L
 
 export const DATABASE_CONNECTION_PROVIDER = Symbol('DatabaseConnectionProvider');
 
-const databaseConnectionProvider: Provider = {
+const DatabaseConnectionProvider: Provider = {
 	provide: DATABASE_CONNECTION_PROVIDER,
 	scope: Scope.DEFAULT,
 
@@ -79,4 +79,4 @@ const databaseConnectionProvider: Provider = {
 	durable: false,
 };
 
-export default databaseConnectionProvider;
+export default DatabaseConnectionProvider;

src/modules/core/infra/database/connection.ts

@@ -1,5 +1,7 @@
 import { DataSource, DataSourceOptions } from 'typeorm';
 import envsConfig from '@core/configs/envs.config';
+import UsersModel from './models/Users.model';
+import UserPreferencesModel from './models/UserPreferences.model';
 
 
 function getDialect(dialect: string): 'mysql' | 'postgres' | 'sqlite' | 'mssql' {
@@ -30,7 +32,10 @@ export const dbConfig: DataSourceOptions = {
 	charset: db.charset,
 	timezone: db.timezone,
 	logging: app.showExternalLogs,
-	entities: ['build/modules/core/infra/database/models/**/*.js'],
+	entities: [
+		UsersModel,
+		UserPreferencesModel,
+	],
 	migrations: ['build/modules/core/infra/database/migrations/**/*.js'],
 	subscribers: [],
 	pool: {

src/modules/core/infra/database/db.config.ts

@@ -16,6 +16,7 @@ import { ConfigsInterface } from '@core/configs/envs.config';
 import { EmitterEventsEnum } from '@domain/enums/events.enum';
 import WebSocketServer from '@events/websocket/server/WebSocket.server';
 import EventEmitterClient from '@events/emitter/EventEmitter.client';
+import EventsQueueConsumer from '@events/queue/consumers/EventsQueue.consumer';
 import { EnvironmentsEnum } from '@common/enums/environments.enum';
 import { ProcessExitStatusEnum } from '@common/enums/processEvents.enum';
 
@@ -24,6 +25,7 @@ import { ProcessExitStatusEnum } from '@common/enums/processEvents.enum';
 export default class LifecycleService implements OnModuleInit, OnApplicationBootstrap, OnModuleDestroy, BeforeApplicationShutdown, OnApplicationShutdown {
 	private readonly appConfigs: ConfigsInterface['application'];
 	private eventEmitterClient!: EventEmitterClient;
+	private eventsQueueConsumer!: EventsQueueConsumer;
 
 	constructor(
 		private readonly moduleRef: ModuleRef,
@@ -45,6 +47,7 @@ export default class LifecycleService implements OnModuleInit, OnApplicationBoot
 
 	public onModuleInit(): void {
 		this.eventEmitterClient = this.moduleRef.get(EventEmitterClient, { strict: false });
+		this.eventsQueueConsumer = this.moduleRef.get(EventsQueueConsumer, { strict: false });
 
 		this.logger.debug('Builded host module');
 	}
@@ -56,13 +59,14 @@ export default class LifecycleService implements OnModuleInit, OnApplicationBoot
 	}
 
 	public onModuleDestroy(): void {
-		this.logger.warn('Closing HTTP server, disconnecting websocket clients, stopping crons and destroying cloud integrations');
+		this.logger.warn('Closing HTTP server, disconnecting websocket clients, stopping crons and consumers and destroying cloud integrations');
 
 		try {
 			// NOTE - gracefull shutdown
 			this.httpAdapterHost.httpAdapter.close();
 			this.webSocketServer.disconnectAllSockets();
 			this.webSocketServer.disconnect();
+			this.eventsQueueConsumer.disable();
 			this.syncCronJob.stopCron();
 			this.cognitoClient.destroy();
 			this.sqsClient.destroy();

src/modules/core/start/Lifecycle.service.ts

@@ -24,6 +24,7 @@ export default abstract class AbstractQueueConsumer {
 	protected queueName: QueueNamesEnum;
 	protected queueUrl: string;
 	private errorsCount = 0;
+	private disabled = false;
 
 	constructor(
 		consumerName: string,
@@ -53,8 +54,26 @@ export default abstract class AbstractQueueConsumer {
 		this.logger.debug(`Created ${this.consumerName} to consume ${this.queueName} queue`);
 	}
 
+	public disable(): void {
+		this.logger.warn(`Disabling consumer ${this.consumerName}`);
+		this.disabled = true;
+	}
+
+	public enable(): void {
+		this.logger.info(`Enabling consumer ${this.consumerName}`);
+		this.disabled = false;
+	}
+
 	protected async handleMessage(message: Message): Promise<void> {
 		this.logger.info(`New message received from ${this.queueName}`);
+
+		if (this.disabled) {
+			throw this.exceptions.internal({
+				message: `Consumer ${this.consumerName} is disabled`,
+				details: `MessageId: ${message.MessageId}`,
+			});
+		}
+
 		const done = await this.messageHandler.execute(message);
 		if (done)
 			await this.deleteMessage(message);

src/modules/events/queue/consumers/AbstractConsumer.consumer.ts

@@ -39,7 +39,7 @@ export default class EventsQueueConsumer extends AbstractQueueConsumer {
 	@SqsMessageHandler(EVENTS_QUEUE_NAME, true)
 	public async handleMessageBatch(messages: Message[]): Promise<void> {
 		for (const message of messages) {
-			this.handleMessage(message);
+			await this.handleMessage(message);
 		}
 	}
 

src/modules/events/queue/consumers/EventsQueue.consumer.ts

@@ -12,6 +12,7 @@ import S3Client from '@core/infra/integration/aws/S3.client';
 import CognitoClient from '@core/infra/integration/aws/Cognito.client';
 import LoggerService from '@core/logging/Logger.service';
 import EventEmitterClient from '@events/emitter/EventEmitter.client';
+import EventsQueueConsumer from '@events/queue/consumers/EventsQueue.consumer';
 import WebSocketServer from '@events/websocket/server/WebSocket.server';
 import { configServiceMock } from '@dev/mocks/mockedModules';
 import { mockObservable } from 'tests/integration/support/mocks/mockObservable';
@@ -53,6 +54,9 @@ describe('Modules :: Core :: Start :: LifecycleService', () => {
 	const awsClientMock = {
 		destroy: jest.fn((...args: unknown[]): void => { args.forEach((arg) => console.log(arg)); }),
 	};
+	const eventsQueueConsumerMock = {
+		disable: jest.fn((): void => { console.log('Disabled consumer'); }),
+	};
 
 	// ? build test app
 	beforeAll(async () => {
@@ -69,6 +73,7 @@ describe('Modules :: Core :: Start :: LifecycleService', () => {
 				{ provide: SnsClient, useValue: awsClientMock },
 				{ provide: S3Client, useValue: awsClientMock },
 				{ provide: CognitoClient, useValue: awsClientMock },
+				{ provide: EventsQueueConsumer, useValue: eventsQueueConsumerMock },
 				LoggerService,
 				EventEmitterClient,
 				LifecycleService,
@@ -87,11 +92,12 @@ describe('Modules :: Core :: Start :: LifecycleService', () => {
 
 			expect(mockObservable.call).toHaveBeenCalledWith('Builded host module');
 			expect(mockObservable.call).toHaveBeenCalledWith(
-				'Closing HTTP server, disconnecting websocket clients, stopping crons and destroying cloud integrations'
+				'Closing HTTP server, disconnecting websocket clients, stopping crons and consumers and destroying cloud integrations'
 			);
 			expect(httpAdapterHostMock.httpAdapter.close).toHaveBeenCalledTimes(1);
 			expect(webSocketServerMock.disconnectAllSockets).toHaveBeenCalledTimes(1);
 			expect(webSocketServerMock.disconnect).toHaveBeenCalledTimes(1);
+			expect(eventsQueueConsumerMock.disable).toHaveBeenCalledTimes(1);
 			expect(syncCronJobMock.stopCron).toHaveBeenCalledTimes(1);
 			expect(mockObservable.call).toHaveBeenCalledWith('Closing cache and databases connections');
 			expect(mongoClientMock.disconnect).toHaveBeenCalledTimes(1);