feat(core): disable debug

Author: RozmarinUS

docs/docs/04_api/02_module-options.md

@@ -15,6 +15,8 @@ The `ClsModule.forRoot()` method takes the following **`ClsModuleOptions`**:
 
 - **_`global?:`_**`boolean`\*\* (default _`false`_)  
   Whether to make the module global, so you do not have to import `ClsModule.forFeature()` in other modules.
+- **_`disableDebug?:`_**`boolean`\*\* (default _`false`_)  
+  Whether disable debugging in the module
 
 - **_`proxyProviders?:`_**`Type[]`  
   Array of [Proxy Providers](../03_features-and-use-cases/06_proxy-providers.md) that should be registered in the root module. Currently only accepts sync class Proxy providers, use `ClsModule.forFeatureAsync()` for more complex use-cases.

packages/core/src/lib/cls-module/cls-root.module.ts

@@ -61,9 +61,11 @@ export class ClsRootModule implements NestModule, OnModuleInit {
         if (options.mount) {
             const adapter = this.adapterHost.httpAdapter;
             const mountPoint = getMiddlewareMountPoint(adapter);
-            ClsRootModule.logger.debug(
-                'Mounting ClsMiddleware to ' + mountPoint,
-            );
+            if (!options.disableDebug) {
+                ClsRootModule.logger.debug(
+                    'Mounting ClsMiddleware to ' + mountPoint,
+                );
+            }
             consumer.apply(ClsMiddleware).forRoutes(mountPoint);
         }
     }
@@ -215,9 +217,11 @@ export class ClsRootModule implements NestModule, OnModuleInit {
 
     private static clsGuardFactory(options: ClsGuardOptions): CanActivate {
         if (options.mount) {
-            ClsRootModule.logger.debug(
-                'ClsGuard will be automatically mounted',
-            );
+            if (!options.disableDebug) {
+                ClsRootModule.logger.debug(
+                    'ClsGuard will be automatically mounted',
+                );
+            }
             return new ClsGuard(options);
         }
         return {
@@ -229,9 +233,11 @@ export class ClsRootModule implements NestModule, OnModuleInit {
         options: ClsInterceptorOptions,
     ): NestInterceptor {
         if (options.mount) {
-            ClsRootModule.logger.debug(
-                'ClsInterceptor will be automatically mounted',
-            );
+            if (!options.disableDebug) {
+                ClsRootModule.logger.debug(
+                    'ClsInterceptor will be automatically mounted',
+                );
+            }
             return new ClsInterceptor(options);
         }
         return {

packages/core/src/lib/cls.options.ts

@@ -11,6 +11,11 @@ export class ClsModuleOptions {
      */
     global? = false;
 
+    /**
+     * whether to disable debugging in the module
+     */
+    disableDebug? = false;
+
     /**
      * An object with additional options for the `ClsMiddleware`
      */
@@ -113,6 +118,11 @@ export class ClsMiddlewareOptions extends ClsInitializerCommonOptions {
      */
     mount? = false;
 
+    /**
+     * whether to disable debugging in the middleware
+     */
+    disableDebug? = false;
+
     /**
      * the function to generate request ids for the CLS context
      */
@@ -155,6 +165,11 @@ export class ClsGuardOptions extends ClsInitializerCommonOptions {
      */
     mount? = false;
 
+    /**
+     * whether to disable debugging in the guard
+     */
+    disableDebug? = false;
+
     /**
      * the function to generate request ids inside the guard
      */
@@ -187,6 +202,11 @@ export class ClsInterceptorOptions extends ClsInitializerCommonOptions {
      */
     mount? = false;
 
+    /**
+     * whether to disable debugging in the interceptor
+     */
+    disableDebug? = false;
+
     /**
      * the function to generate request ids inside the interceptor
      */