Chore: release v2.3.0 – normalization utilities, APM decorators & RabbitMQ env-config

.env.example

@@ -33,6 +33,7 @@ DB_PASSWORD=
 DB_PORT=
 
 # MONGO
+MONGO_ENABLED=true
 MONGO_USER=
 MONGO_PASSWORD=
 MONGO_HOST=
@@ -41,6 +42,8 @@ MONGO_NAME=
 MONGO_AUTH_SOURCE=
 
 # RABBIT
+RABBIT_ENABLED=
+RABBIT_OPTIONS=
 RABBIT_USER=
 RABBIT_PASSWORD=
 RABBIT_HOST=

CHANGELOG.md

@@ -5,6 +5,42 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.3.0] - 2025-05-06
+
+### Added
+
+- New `normalize` and `normalizeOptions` utilities for payload normalization in the reprocessing module.  
+- APM decorators for handlers, enabling instrumentation.  
+- Functionality to extract RabbitMQ options from the `RABBIT_OPTIONS` environment variable.  
+
+### Changed
+
+- Renamed non-standard folder from `utils` to `util`.  
+- Improved application startup and shutdown process.  
+- Enhanced MemCached connection process and added connection timeout.  
+- Updated the `.env.example` file.  
+- Adjusted when Elastic is started.  
+- Added protocol adaptation for new RabbitMQ implementations.  
+- Improved handler processing logic to prevent subsequent handlers from executing prematurely.  
+- Optimized APM decorators.  
+
+### Fixed
+
+- Added normalization before message validation in the reprocessing module.  
+- Optimized `searchLabels` to prevent maximum call stack overflow.  
+
+### Deprecated
+
+- _No deprecations._  
+
+### Removed
+
+- _No removals._  
+
+### Security
+
+- _No security fixes.
+
 ## [2.2.0] - 2025-03-19
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "template-microservice",
-  "version": "1.0.0",
+  "version": "2.3.0",
   "scripts": {
     "helm:gen": "NODE_NO_WARNINGS=1 node script/helm/index.mjs",
     "helm:gen:production": "NODE_NO_WARNINGS=1 node script/helm/index.mjs -e production --scan-routes",

src/data/protocols/mq/publish-in-exchange.ts

@@ -4,5 +4,5 @@ export interface PublishInExchangeService {
     message: object,
     routingKey: string,
     headers?: object
-  ): Promise<void>;
+  ): Promise<boolean>;
 }

src/data/protocols/mq/publish-in-queue.ts

@@ -1,3 +1,7 @@
 export interface PublishInQueueService {
-  publishInQueue(queue: string, message: object, headers?: object): void;
+  publishInQueue(
+    queue: string,
+    message: object,
+    headers?: object
+  ): Promise<boolean>;
 }

src/data/usecases/elasticsearch/es-create-event.ts

@@ -1,6 +1,6 @@
 import { GetAPMTransactionIds } from '@/data/protocols/apm';
 import { CreateDocumentService } from '@/data/protocols/elasticsearch';
-import { FormatDate } from '@/data/protocols/utils';
+import { FormatDate } from '@/data/protocols/util';
 import { CreateEvent } from '@/domain/usecases/event';
 
 export class EsCreateEvent implements CreateEvent {

src/data/usecases/elasticsearch/es-update-event.ts

@@ -3,7 +3,7 @@ import {
   GetDocumentByIdService,
   UpdateDocumentService
 } from '@/data/protocols/elasticsearch';
-import { FormatDate, Merge } from '@/data/protocols/utils';
+import { FormatDate, Merge } from '@/data/protocols/util';
 import { UpdateEvent } from '@/domain/usecases/event';
 
 export class EsUpdateEvent implements UpdateEvent {

src/infra/cache/cache-server.ts

@@ -21,6 +21,10 @@ export class CacheServer {
   private connectionString!: string;
   private connected: boolean = false;
 
+  private CONNECTION_TIMEOUT = 10000;
+  private CONNECTION_RETIES = 5;
+  private RETIES_TIMEOUT = 2;
+
   public Error = {
     CONNECTION_ERROR: 'Server not connected!',
     CREDENTIALS_NOT_DEFINED: 'Server credentials not defined!',
@@ -77,12 +81,15 @@ export class CacheServer {
     if (!this.connectionString)
       throw new Error(this.Error.CREDENTIALS_NOT_DEFINED);
     if (this.connected) return;
-    this.server = memjs.Client.create(this.connectionString);
+    this.server = memjs.Client.create(this.connectionString, {
+      timeout: this.CONNECTION_TIMEOUT,
+      retries: this.CONNECTION_RETIES,
+      retry_delay: this.RETIES_TIMEOUT
+    });
     this.connected = true;
   }
 
   public disconnect() {
-    if (!this.connected) return;
     this.server.close();
     this.connected = false;
   }

src/infra/http/util/web-server/web-server.ts

@@ -15,6 +15,7 @@ import { SharedState } from '@/presentation/protocols/shared-state';
 import { internalImplementationError, serverError } from '@/presentation/utils';
 import {
   DICTIONARY,
+  apmSpan,
   convertCamelCaseKeysToSnakeCase,
   convertSnakeCaseKeysToCamelCase,
   logger
@@ -245,17 +246,8 @@ export class WebServer {
       }
     }
 
-    return new Promise((resolve, reject) => {
-      this.fastify.server.close((error) => {
-        if (error) {
-          reject(error);
-          return;
-        }
-
-        logger.log({ level: 'info', message: 'Shutting down server' });
-        resolve(null);
-      });
-    });
+    await this.fastify.close();
+    logger.log({ level: 'info', message: 'Shutting down server' });
   }
 
   public setBaseUrl(url: string) {
@@ -395,9 +387,51 @@ export class WebServer {
           this.makeSetStateInRequest(state)
         ];
 
-        const response = await (typeof middleware !== 'function'
-          ? middleware.handle(request, stateHook, next)
-          : middleware(request, reply, next, stateHook));
+        function handler() {
+          const decoratorOptions = {
+            options: {
+              name: '',
+              subType: 'handler'
+            },
+            params: {}
+          };
+
+          if (typeof middleware === 'function') {
+            decoratorOptions.options.name = middleware.name;
+            decoratorOptions.params = { stateHook: 3 };
+            const decorator = apmSpan(decoratorOptions);
+            const proto = {};
+
+            const methodName = middleware.name;
+
+            const desc: PropertyDescriptor = {
+              value: middleware.bind(null),
+              writable: true,
+              configurable: true,
+              enumerable: false
+            };
+
+            const newDesc = decorator(proto, methodName, desc);
+
+            return newDesc.value(request, reply, next, stateHook);
+          }
+
+          decoratorOptions.options.name = middleware.constructor.name;
+          decoratorOptions.params = { stateHook: 1 };
+          const decorator = apmSpan(decoratorOptions);
+
+          const proto = middleware.constructor.prototype;
+          const methodName = 'handle';
+          const desc = Object.getOwnPropertyDescriptor(proto, methodName)!;
+
+          const newDesc = decorator(proto, methodName, desc);
+
+          Object.defineProperty(proto, methodName, newDesc);
+
+          return middleware.handle(request, stateHook, next);
+        }
+
+        const response = await handler();
 
         if (!response) return;