Revert "Feature/cls-interceptor (#6)"

This reverts commit a281248.

package.json

@@ -16,7 +16,6 @@
         "cls",
         "continuation-local-storage",
         "als",
-        "AsyncLocalStorage",
         "async_hooks",
         "request context"
     ],

src/index.ts

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

src/lib/cls.constants.ts

@@ -4,4 +4,3 @@ export const CLS_ID = 'CLS_ID';
 export const CLS_DEFAULT_NAMESPACE = 'CLS_DEFAULT_NAMESPACE';
 export const CLS_MIDDLEWARE_OPTIONS = 'ClsMiddlewareOptions';
 export const CLS_GUARD_OPTIONS = 'ClsGuardOptions';
-export const CLS_INTERCEPTOR_OPTIONS = 'ClsInterceptorOptions';

src/lib/cls.interfaces.ts

@@ -25,11 +25,6 @@ export class ClsModuleOptions {
      * Cls guard options
      */
     guard?: ClsGuardOptions = null;
-
-    /**
-     * Cls interceptor options
-     */
-    interceptor?: ClsInterceptorOptions = null;
 }
 
 export class ClsMiddlewareOptions {
@@ -108,32 +103,3 @@ export class ClsGuardOptions {
 
     readonly namespaceName?: string;
 }
-
-export class ClsInterceptorOptions {
-    /**
-     * whether to mount the interceptor globally
-     */
-    mount?: boolean; // default false
-
-    /**
-     * whether to automatically generate request ids
-     */
-    generateId?: boolean; // default false
-
-    /**
-     * the function to generate request ids inside the interceptor
-     */
-    idGenerator?: (context: ExecutionContext) => string | Promise<string> =
-        () => Math.random().toString(36).slice(-8);
-
-    /**
-     * Function that executes after the CLS context has been initialised.
-     * It can be used to put additional variables in the CLS context.
-     */
-    setup?: (
-        cls: ClsService,
-        context: ExecutionContext,
-    ) => void | Promise<void>;
-
-    readonly namespaceName?: string;
-}

src/lib/cls.module.ts

@@ -6,23 +6,12 @@ import {
     NestModule,
     Provider,
 } from '@nestjs/common';
-import {
-    APP_GUARD,
-    APP_INTERCEPTOR,
-    HttpAdapterHost,
-    ModuleRef,
-} from '@nestjs/core';
-import { ClsInterceptor } from '..';
+import { APP_GUARD, HttpAdapterHost, ModuleRef } from '@nestjs/core';
 import { ClsServiceManager, getClsServiceToken } from './cls-service-manager';
-import {
-    CLS_GUARD_OPTIONS,
-    CLS_INTERCEPTOR_OPTIONS,
-    CLS_MIDDLEWARE_OPTIONS,
-} from './cls.constants';
+import { CLS_GUARD_OPTIONS, CLS_MIDDLEWARE_OPTIONS } from './cls.constants';
 import { ClsGuard } from './cls.guard';
 import {
     ClsGuardOptions,
-    ClsInterceptorOptions,
     ClsMiddlewareOptions,
     ClsModuleOptions,
 } from './cls.interfaces';
@@ -91,11 +80,6 @@ export class ClsModule implements NestModule {
             ...options.guard,
             namespaceName: options.namespaceName,
         };
-        const clsInterceptorOptions = {
-            ...new ClsInterceptorOptions(),
-            ...options.interceptor,
-            namespaceName: options.namespaceName,
-        };
         const providers: Provider[] = [
             ...ClsServiceManager.getClsServicesAsProviders(),
             {
@@ -106,28 +90,18 @@ export class ClsModule implements NestModule {
                 provide: CLS_GUARD_OPTIONS,
                 useValue: clsGuardOptions,
             },
-            {
-                provide: CLS_INTERCEPTOR_OPTIONS,
-                useValue: clsInterceptorOptions,
-            },
         ];
-        const enhancerArr = [];
+        const guardArr = [];
         if (clsGuardOptions.mount) {
-            enhancerArr.push({
+            guardArr.push({
                 provide: APP_GUARD,
                 useClass: ClsGuard,
             });
         }
-        if (clsInterceptorOptions.mount) {
-            enhancerArr.push({
-                provide: APP_INTERCEPTOR,
-                useClass: ClsInterceptor,
-            });
-        }
 
         return {
             module: ClsModule,
-            providers: providers.concat(...enhancerArr),
+            providers: providers.concat(...guardArr),
             exports: providers,
             global: options.global,
         };

src/lib/cls.service.spec.ts

@@ -1,6 +1,5 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import { ClsServiceManager } from './cls-service-manager';
-import { CLS_DEFAULT_NAMESPACE } from './cls.constants';
+import { ClsServiceManager, CLS_DEFAULT_NAMESPACE } from '..';
 import { ClsService } from './cls.service';
 
 describe('ClsService', () => {

src/lib/cls.service.ts

@@ -50,7 +50,7 @@ export class ClsService<S = Record<string, any>> {
     }
 
     /**
-     * Run the callback with a shared CLS context.
+     * Run the callback in a shared CLS context.
      * @param callback function to run
      * @returns whatever the callback returns
      */
@@ -59,30 +59,12 @@ export class ClsService<S = Record<string, any>> {
     }
 
     /**
-     * Run the callbacks with a shared CLS context.
-     * @param store the default context contents
-     * @param callback function to run
-     * @returns whatever the callback returns
-     */
-    runWith<T = any>(store: any, callback: () => T) {
-        return this.namespace.run(store ?? {}, callback);
-    }
-
-    /**
-     * Run any following code with a shared CLS context.
+     * Run any following code in a shared CLS context.
      */
     enter() {
         return this.namespace.enterWith({});
     }
 
-    /**
-     * Run any following code with a shared ClS context
-     * @param store the default context contents
-     */
-    enterWith(store: any = {}) {
-        return this.namespace.enterWith(store);
-    }
-
     /**
      * Run the callback outside of a shared CLS context
      * @param callback function to run

test/common/test.guard.ts

@@ -9,7 +9,7 @@ export class TestGuard implements CanActivate {
     canActivate(
         context: ExecutionContext,
     ): boolean | Promise<boolean> | Observable<boolean> {
-        if (this.cls.isActive()) this.cls.set('FROM_GUARD', this.cls.getId());
-        return true;
+        this.cls.set('FROM_GUARD', this.cls.getId());
+        return this.cls.isActive();
     }
 }

test/gql/expect-ids-gql.ts

@@ -1,10 +1,7 @@
 import { INestApplication } from '@nestjs/common';
 import request from 'supertest';
 
-export const expectOkIdsGql = (
-    app: INestApplication,
-    options = { skipGuard: false },
-) =>
+export const expectIdsGql = (app: INestApplication) =>
     request(app.getHttpServer())
         .post('/graphql')
         .send({
@@ -22,36 +19,8 @@ export const expectOkIdsGql = (
         .expect(200)
         .then((r) => {
             const body = r.body.data?.items[0];
-            const id = body.id ?? 'no-id';
-            if (!options.skipGuard) expect(body.fromGuard).toEqual(id);
-            expect(body.fromInterceptor).toEqual(id);
-            expect(body.fromInterceptorAfter).toEqual(id);
-            expect(body.fromResolver).toEqual(id);
-            expect(body.fromService).toEqual(id);
-        });
-
-export const expectErrorIdsGql = (
-    app: INestApplication,
-    options = { skipGuard: false },
-) =>
-    request(app.getHttpServer())
-        .post('/graphql')
-        .send({
-            query: `query {
-                error {
-                    id
-                    fromGuard
-                    fromInterceptor
-                    fromInterceptorAfter
-                    fromResolver
-                    fromService
-                }
-            }`,
-        })
-        .then((r) => {
-            const body = r.body.errors?.[0].extensions.exception?.response;
-            const id = body.id ?? 'no-id';
-            if (!options.skipGuard) expect(body.fromGuard).toEqual(id);
+            const id = body.id;
+            expect(body.fromGuard).toEqual(id);
             expect(body.fromInterceptor).toEqual(id);
             expect(body.fromInterceptorAfter).toEqual(id);
             expect(body.fromResolver).toEqual(id);