fix(): context id factory improvements

Author: kamilmysliwiec

packages/core/helpers/context-id-factory.ts

@@ -1,4 +1,5 @@
 import { ContextId } from '../injector/instance-wrapper';
+import { REQUEST_CONTEXT_ID } from '../router/request/request-constants';
 
 export function createContextId(): ContextId {
   /**
@@ -11,3 +12,31 @@ export function createContextId(): ContextId {
    */
   return { id: Math.random() };
 }
+
+export class ContextIdFactory {
+  /**
+   * Generates a context identifier based on the request object.
+   */
+  public static create(): ContextId {
+    return createContextId();
+  }
+
+  /**
+   * Generates a random identifier to track asynchronous execution context.
+   * @param request request object
+   */
+  public static getByRequest<T extends Record<any, any> = any>(
+    request: T,
+  ): ContextId {
+    if (!request) {
+      return createContextId();
+    }
+    if (request[REQUEST_CONTEXT_ID as any]) {
+      return request[REQUEST_CONTEXT_ID as any];
+    }
+    if (request.raw && request.raw[REQUEST_CONTEXT_ID]) {
+      return request.raw[REQUEST_CONTEXT_ID];
+    }
+    return createContextId();
+  }
+}

packages/core/middleware/middleware-module.ts

@@ -11,7 +11,7 @@ import { isUndefined, validatePath } from '@nestjs/common/utils/shared.utils';
 import { ApplicationConfig } from '../application-config';
 import { InvalidMiddlewareException } from '../errors/exceptions/invalid-middleware.exception';
 import { RuntimeException } from '../errors/exceptions/runtime.exception';
-import { createContextId } from '../helpers/context-id-factory';
+import { ContextIdFactory } from '../helpers';
 import { ExecutionContextHost } from '../helpers/execution-context-host';
 import { STATIC_CONTEXT } from '../injector/constants';
 import { NestContainer } from '../injector/container';
@@ -205,7 +205,7 @@ export class MiddlewareModule {
         next: () => void,
       ) => {
         try {
-          const contextId = req[REQUEST_CONTEXT_ID] || createContextId();
+          const contextId = ContextIdFactory.getByRequest(req);
           if (!req[REQUEST_CONTEXT_ID]) {
             Object.defineProperty(req, REQUEST_CONTEXT_ID, {
               value: contextId,

packages/core/router/router-explorer.ts

@@ -15,7 +15,7 @@ import { ApplicationConfig } from '../application-config';
 import { UnknownRequestMappingException } from '../errors/exceptions/unknown-request-mapping.exception';
 import { GuardsConsumer } from '../guards/guards-consumer';
 import { GuardsContextCreator } from '../guards/guards-context-creator';
-import { createContextId } from '../helpers/context-id-factory';
+import { ContextIdFactory } from '../helpers';
 import { ExecutionContextHost } from '../helpers/execution-context-host';
 import { ROUTE_MAPPED_MESSAGE } from '../helpers/messages';
 import { RouterMethodFactory } from '../helpers/router-method-factory';
@@ -287,8 +287,6 @@ export class RouterExplorer {
     ) => {
       try {
         const contextId = this.getContextId(req);
-        this.container.registerRequestProvider(req, contextId);
-
         const contextInstance = await this.injector.loadPerContext(
           instance,
           module,
@@ -325,12 +323,16 @@ export class RouterExplorer {
   private getContextId<T extends Record<any, any> = any>(
     request: T,
   ): ContextId {
-    if (request[REQUEST_CONTEXT_ID as any]) {
-      return request[REQUEST_CONTEXT_ID as any];
-    }
-    if (request.raw && request.raw[REQUEST_CONTEXT_ID]) {
-      return request.raw[REQUEST_CONTEXT_ID];
+    const contextId = ContextIdFactory.getByRequest(request);
+    if (!request[REQUEST_CONTEXT_ID as any]) {
+      Object.defineProperty(request, REQUEST_CONTEXT_ID, {
+        value: contextId,
+        enumerable: false,
+        writable: false,
+        configurable: false,
+      });
+      this.container.registerRequestProvider(request, contextId);
     }
-    return createContextId();
+    return contextId;
   }
 }

packages/microservices/listeners-controller.ts

@@ -1,5 +1,5 @@
 import { Controller } from '@nestjs/common/interfaces/controllers/controller.interface';
-import { createContextId } from '@nestjs/core/helpers/context-id-factory';
+import { ContextIdFactory } from '@nestjs/core';
 import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host';
 import { STATIC_CONTEXT } from '@nestjs/core/injector/constants';
 import { NestContainer } from '@nestjs/core/injector/container';
@@ -120,14 +120,19 @@ export class ListenersController {
     return async (...args: unknown[]) => {
       try {
         const [data, reqCtx] = args;
-        const contextId = createContextId();
-
-        const req = RequestContextHost.create(
+        const request = RequestContextHost.create(
           pattern,
           data,
           reqCtx as BaseRpcContext,
         );
-        this.container.registerRequestProvider(req, contextId);
+        const contextId = ContextIdFactory.getByRequest(request);
+        /**Object.defineProperty(request, REQUEST_CONTEXT_ID, {
+          value: contextId,
+          enumerable: false,
+          writable: false,
+          configurable: false,
+        });*/
+        this.container.registerRequestProvider(request, contextId);
 
         const contextInstance = await this.injector.loadPerContext(
           instance,