Merge pull request #42 from hemicharly/feature/tracer

Feature: Merge feature/tracer into Develop

Author: hemicharly

README.md

@@ -37,7 +37,6 @@ timesheet-in-transit-api/
 │-- app/
 │   │-- src/
 │   │   │-- app.module.ts
-│   │   │-- config.env.ts
 │   │   │-- database.module.ts
 │   │   │-- index.ts
 │   │   │-- main.ts
@@ -47,7 +46,7 @@ timesheet-in-transit-api/
 │   │   │   │-- config/
 │   │   │   │-- consumers/
 │   │   │   │-- web/
-│   │   │   │   │-- common/
+│   │   │   │   │-- shared/
 │   │   │   │   │-- config/
 │   │   │   │   │-- rest/
 │   │   │-- core/
@@ -67,6 +66,9 @@ timesheet-in-transit-api/
 │   │   │   │-- integrations/
 │   │   │   │-- queue/
 │   │   │   │-- repositories/
+│   │   │-- shared/
+│   │   │   │-- audit/
+│   │   │   │-- config/
 ```
 
 ### **modules**

README.pt-br.md

@@ -37,7 +37,6 @@ timesheet-in-transit-api/
 │-- app/
 │   │-- src/
 │   │   │-- app.module.ts
-│   │   │-- config.env.ts
 │   │   │-- database.module.ts
 │   │   │-- index.ts
 │   │   │-- main.ts
@@ -47,7 +46,7 @@ timesheet-in-transit-api/
 │   │   │   │-- config/
 │   │   │   │-- consumers/
 │   │   │   │-- web/
-│   │   │   │   │-- common/
+│   │   │   │   │-- shared/
 │   │   │   │   │-- config/
 │   │   │   │   │-- rest/
 │   │   │-- core/
@@ -67,6 +66,9 @@ timesheet-in-transit-api/
 │   │   │   │-- integrations/
 │   │   │   │-- queue/
 │   │   │   │-- repositories/
+│   │   │-- shared/
+│   │   │   │-- audit/
+│   │   │   │-- config/
 ```
 
 ### **modules**

app/src/core/usecases/notification/impl/notification.order.register.usecase.impl.ts

@@ -1,7 +1,7 @@
 import { NotificationOrderCoreEntity } from 'src/core/domain/entities/notifications';
 import { NotificationOrderRegisterUsecase } from '@core/usecases/notification';
-import { ProducerQueueProvider } from '@core/providers/queue/producer.queue.provider';
-import { configEnv } from '@src/config.env';
+import { ProducerQueueProvider } from '@core/providers/queue';
+import { configEnv } from '@shared/config';
 
 export class NotificationOrderRegisterUsecaseImpl implements NotificationOrderRegisterUsecase {
   constructor(private readonly sendQueueProvider: ProducerQueueProvider) {}

app/src/database.module.ts

@@ -1,6 +1,6 @@
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
-import { configEnv } from '@src/config.env';
+import { configEnv } from '@src/shared/config';
 
 @Module({
   imports: [

app/src/index.ts

@@ -1,5 +1,4 @@
 export * from './app.module';
-export * from './config.env';
 export * from './database.module';
 export * from './main';
 export * from './seed.module';

app/src/infrastructure/integrations/config/abstract/integration.config.module.ts

@@ -9,7 +9,7 @@ import { DynamicModule, Module, Type } from '@nestjs/common';
  * @example
  *
  * ```typescript
- * import { Module } from '@nestjs/common';
+ * import { Module } from '@nestjs/shared';
  * import { WebhookIntegrationClientProviderImpl } from '@infrastructure/integrations/webhook-client/impl';
  * import { IntegrationConfigModule } from 'src/infrastructure/integrations/config/abstract';
  * import { WebhookConfigModule } from '@infrastructure/integrations/webhook-client/config';

app/src/infrastructure/integrations/common/audit/index.ts renamed to app/src/infrastructure/integrations/shared/audit/index.ts

@@ -1,7 +1,8 @@
 import { HttpService } from '@nestjs/axios';
 import { Logger } from '@nestjs/common';
 import { AxiosError, AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
-import { IntegrationLoggerDto } from '@infrastructure/integrations/common/audit';
+import { IntegrationLoggerDto } from '@infrastructure/integrations/shared/audit';
+import { TracerContextAudit } from '@shared/audit';
 
 /**
  * Class responsible for managing API integration audit logs.
@@ -11,10 +12,10 @@ import { IntegrationLoggerDto } from '@infrastructure/integrations/common/audit'
  *
  * ```typescript
  * import { WebhookIntegrationClientProvider } from '@core/providers/integrations';
- * import { Injectable, Logger } from '@nestjs/common';
+ * import { Injectable, Logger } from '@nestjs/shared';
  * import { firstValueFrom } from 'rxjs';
  * import { HttpService } from '@nestjs/axios';
- * import { IntegrationAuditCommon } from '@infrastructure/integrations/common/audit';
+ * import { IntegrationAuditCommon } from '@infrastructure/integrations/shared/audit';
  *
  * @Injectable()
  * export class WebhookIntegrationClientProviderImpl implements WebhookIntegrationClientProvider {
@@ -83,6 +84,7 @@ export class IntegrationAuditCommon {
       config.headers = {};
     }
     config.headers['request-start-time'] = process.hrtime();
+    config.headers['x-tracer-id'] = TracerContextAudit.getContextTracerId();
     return config;
   }
 
@@ -126,7 +128,7 @@ export class IntegrationAuditCommon {
    */
   private logAudit(config: AxiosRequestConfig, responseData: any, status: number, startTime: [number, number], isError: boolean = false): void {
     const integrationLoggerDto = this.createIntegrationLoggerDto(config, responseData, status, startTime);
-    const logMessage = `[AUDIT LOG] ${JSON.stringify(integrationLoggerDto)}`;
+    const logMessage = JSON.stringify(integrationLoggerDto);
     if (isError) {
       this.logger.error(logMessage);
       return;
@@ -144,8 +146,9 @@ export class IntegrationAuditCommon {
    * @returns An `IntegrationLoggerDto` object containing the audit information.
    */
   private createIntegrationLoggerDto(config: AxiosRequestConfig, responseData: any, status: number, startTime: [number, number]): IntegrationLoggerDto {
+    const tracerId = <string>config.headers['x-tracer-id'];
     const method = `${config.method?.toUpperCase()} ${config.url}`;
-    return new IntegrationLoggerDto(this.application, method, config.headers, config.params, config.data, responseData, status, startTime);
+    return new IntegrationLoggerDto(tracerId, this.application, method, config.headers, config.params, config.data, responseData, status, startTime);
   }
 
   /**

app/src/infrastructure/integrations/common/audit/integration.audit.common.ts renamed to app/src/infrastructure/integrations/shared/audit/integration.audit.common.ts

@@ -26,6 +26,8 @@ const SENSITIVE_FIELDS = new Set([
  * @class IntegrationLoggerDto
  */
 export class IntegrationLoggerDto {
+  readonly tracerId: string;
+
   /**
    * Date and time when the log was created.
    * @type {string}
@@ -84,6 +86,7 @@ export class IntegrationLoggerDto {
    * Constructor for the `IntegrationLoggerDto` class.
    * Initializes the properties and masks sensitive fields from the provided data.
    *
+   * @param {string} tracerId The tracer id log.
    * @param {string} application The name of the application generating the log.
    * @param {string} endpoint The API endpoint called.
    * @param {any} headers The request headers.
@@ -93,7 +96,8 @@ export class IntegrationLoggerDto {
    * @param {number} statusCode The HTTP status code of the response.
    * @param {[number, number]} startTime The start time of the request for calculating duration.
    */
-  constructor(application: string, endpoint: string, headers: any, queryParameters: any, requestBody: any, responseBody: any, statusCode: number, startTime: [number, number]) {
+  constructor(tracerId: string, application: string, endpoint: string, headers: any, queryParameters: any, requestBody: any, responseBody: any, statusCode: number, startTime: [number, number]) {
+    this.tracerId = tracerId; // Sets the tracerId
     this.timestamp = new Date().toJSON(); // Marks the timestamp of the log
     this.application = application; // Sets the application name
     this.endpoint = endpoint; // Sets the accessed endpoint

app/src/infrastructure/integrations/common/audit/integration.logger.dto.ts renamed to app/src/infrastructure/integrations/shared/audit/integration.logger.dto.ts

@@ -1,6 +1,6 @@
 import { Module } from '@nestjs/common';
 import { HttpModule } from '@nestjs/axios';
-import { configEnv } from '@src/config.env';
+import { configEnv } from '@src/shared/config';
 
 @Module({
   imports: [