refactor: namespaces

README.md

@@ -13,7 +13,7 @@ A continuation-local storage module compatible with [NestJS](https://nestjs.com/
 -   [API](#api)
 -   [Request ID](#request-id)
 -   [Custom CLS Middleware](#custom-cls-middleware)
--   [Namespaces](#namespaces) (currently unsupported)
+-   [Namespaces](#namespaces) (experimental)
 
 # Install
 
@@ -283,9 +283,9 @@ export class HelloClsMiddleware implements NestMiddleware {
 
 > Note: Middleware options passed to `ClsModule.register` do not apply here, so you will need to implement any custom logic (like the generation of request ids) manually.
 
-# (Namespaces)
+# Namespaces (experimental)
 
-> Warning: Namespace support is currently not ready and has no tests. This section serves as a documentation of the future API and can change any time.
+> Warning: Namespace support is currently experimental no tests. This section serves as a documentation of the future API and can change any time.
 
 The default CLS namespace that the `ClsService` provides should be enough for most application, but should you need it, this package provides (will provide) a way to use multiple CLS namespaces in order to be fully compatible with `cls-hooked`.
 

src/index.ts

@@ -1,4 +1,6 @@
+export * from './lib/cls-service-manager';
 export * from './lib/cls.constants';
 export * from './lib/cls.middleware';
 export * from './lib/cls.module';
 export * from './lib/cls.service';
+export * from './lib/cls.decorators';

src/lib/cls-service-manager.ts

@@ -1,6 +1,7 @@
 import { ClassProvider, ValueProvider } from '@nestjs/common';
 import { createNamespace, Namespace } from 'cls-hooked';
-import { ClsService } from '..';
+import { CLS_DEFAULT_NAMESPACE } from './cls.constants';
+import { ClsService } from './cls.service';
 
 export const getClsServiceToken = (namespace: string) =>
     `ClsService-${namespace}`;
@@ -9,27 +10,36 @@ export class ClsServiceManager {
     private static namespaces: Record<string, Namespace> = {};
 
     private static clsServices: Map<string | typeof ClsService, ClsService> =
-        new Map();
+        new Map([
+            [
+                ClsService,
+                new ClsService(this.resolveNamespace(CLS_DEFAULT_NAMESPACE)),
+            ],
+        ]);
 
     private static resolveNamespace(name: string) {
         if (!this.namespaces[name]) {
-            this.namespaces[name] = createNamespace(name);
+            this.namespaces[name] = createNamespace(
+                name ?? CLS_DEFAULT_NAMESPACE,
+            );
         }
         return this.namespaces[name];
     }
 
-    static setDefaultNamespace(name: string) {
-        this.clsServices.set(
-            ClsService,
-            new ClsService(this.resolveNamespace(name)),
-        );
-    }
+    // static setDefaultNamespace(name: string) {
+    //     this.clsServices.set(
+    //         ClsService,
+    //         new ClsService(this.resolveNamespace(name)),
+    //     );
+    // }
 
     static addClsService(name: string) {
+        const service = new ClsService(this.resolveNamespace(name));
         this.clsServices.set(
             getClsServiceToken(name),
             new ClsService(this.resolveNamespace(name)),
         );
+        return service;
     }
 
     static getClsService(name?: string) {

src/lib/cls.module.ts

@@ -64,7 +64,6 @@ export class ClsModule implements NestModule {
 
     static register(options?: ClsModuleOptions): DynamicModule {
         options = { ...new ClsModuleOptions(), ...options };
-        ClsServiceManager.setDefaultNamespace(options.namespaceName);
         ClsServiceManager.addClsService(options.namespaceName);
         const clsMiddlewareOptions = {
             ...new ClsMiddlewareOptions(),

src/lib/cls.service.spec.ts

@@ -1,5 +1,5 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import { createNamespace } from 'cls-hooked';
+import { ClsServiceManager, CLS_DEFAULT_NAMESPACE } from '..';
 import { ClsService } from './cls.service';
 
 describe('ClsService', () => {
@@ -10,7 +10,9 @@ describe('ClsService', () => {
             providers: [
                 {
                     provide: ClsService,
-                    useValue: new ClsService(createNamespace('test')),
+                    useValue: ClsServiceManager.addClsService(
+                        CLS_DEFAULT_NAMESPACE,
+                    ),
                 },
             ],
         }).compile();

test/http/http-fastify.spec.ts

@@ -10,7 +10,6 @@ import { TestHttpController, TestHttpService } from './http.app';
 @Module({
     imports: [
         ClsModule.register({
-            namespaceName: 'xxx',
             middleware: { mount: true },
         }),
     ],