No CLS context available, please make sure that a ClsMiddleware/Guard/Interceptor has set up the context

[qgxpagamentos]

I have a repository called chain-sdk-node, which contains two interceptors that all my microservices use.

Repository: chain-sdk-node

chain-sdk-node
  - src
     - interceptors
         - client-name.interceptor.ts
         - business-unit.interceptor.ts
    - library.module.ts

Files:
client-name.interceptor.ts

import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable } from 'rxjs';
import { ClsService } from 'nestjs-cls';

@Injectable()
export class ClientNameInterceptor implements NestInterceptor {
  constructor(private readonly cls: ClsService) {}
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    return this.cls.run(() => {
      this.cls.set('client_name', 'ola_cliente');
      return next.handle();
    });
  }
}

library.module.ts

import {
  DynamicModule,
  Global,
  MiddlewareConsumer,
  Module,
  NestModule,
  Provider,
  Type,
} from '@nestjs/common';
import { DataSource } from 'typeorm';
import { AnyExceptionFilter } from './filters';
import {
  BusinessUnitInterceptor,
  ClientNameInterceptor,
  ResponseInterceptor,
} from './interceptors';
import { ClientIdMiddleware, UUIDMiddleware } from './middlewares';
import { ChainRepository } from './repository';
import { ClsModule } from 'nestjs-cls';

@Global()
@Module({})
export class LibraryModule {
  static forRoot(dataSource: Type<DataSource>): DynamicModule {
    const repositoryProvider: Provider = {
      provide: ChainRepository,
      useFactory: (ds: DataSource) => new ChainRepository(ds),
      inject: [dataSource],
    };
    return {
      module: LibraryModule,
      providers: [
        repositoryProvider,
        AnyExceptionFilter,
        BusinessUnitInterceptor,
        ClientNameInterceptor,
        ResponseInterceptor,
        ClientIdMiddleware,
        UUIDMiddleware,
      ],
      exports: [
        repositoryProvider,
        AnyExceptionFilter,
        BusinessUnitInterceptor,
        ClientNameInterceptor,
        ResponseInterceptor,
        ClientIdMiddleware,
        UUIDMiddleware,
        ClsModule,
      ],
      imports: [ClsModule],
    };
  }
}

I have a microservice that imports this repository in its package.json.

import { Module } from '@nestjs/common';
import { HealthModule } from './health/health.module';
import { APP_FILTER, RouterModule } from '@nestjs/core';
import { AnyExceptionFilter, LibraryModule } from 'chain-sdk-node';
import { AdminConfigModule } from './admin-config/admin-config.module';
import { DatabaseModule } from './database/database.module';
import { DataSource } from 'typeorm';
import { ClsModule } from 'nestjs-cls';
@Module({
  imports: [
    HealthModule,
    ClsModule.forRoot({
      global: true,
      middleware: { mount: true },
      interceptor: { mount: true },
    }),
    DatabaseModule,
    AdminConfigModule,
    RouterModule.register([
      {
        path: 'admin-config',
        module: AdminConfigModule,
      },
    ]),
    LibraryModule.forRoot(DataSource),
  ],
  controllers: [],
  providers: [
    {
      provide: APP_FILTER,
      useClass: AnyExceptionFilter,
    },
  ],
})
export class AppModule {}

When executing the REST API, I get the following error:

{"level":"error","message":"Cannot set the key \"client_name\". No CLS context available, please make sure that a ClsMiddleware/Guard/Interceptor has set up the context, or wrap any calls that depend on CLS with \"ClsService#run\"","stack":"Error: Cannot set the key \"client_name\". No CLS context available, please make sure that a ClsMiddleware/Guard/Interceptor has set up the context, or wrap any calls that depend on CLS with \"ClsService#run\"\n    at ClsService.set (/Users/arthurstockler/development/fanpulse/chain-sdk-node/node_modules/nestjs-cls/dist/src/lib/cls.service.js:56:19)\n    at /Users/arthurstockler/development/fanpulse/chain-sdk-node/dist/interceptors/client-name.interceptor.js:39:26\n    at doInnerSub (/Users/arthurstockler/development/fanpulse/chain-sdk-node/node_modules/rxjs/src/internal/operators/mergeInternals.ts:71:15)\n    at outerNext (/Users/arthurstockler/development/fanpulse/chain-sdk-node/node_modules/rxjs/src/internal/operators/mergeInternals.ts:53:58)\n    at OperatorSubscriber.OperatorSubscriber._this._next (/Users/arthurstockler/development/fanpulse/chain-sdk-node/node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts:70:13)\n    at OperatorSubscriber.Subscriber.next (/Users/arthurstockler/development/fanpulse/chain-sdk-node/node_modules/rxjs/src/internal/Subscriber.ts:75:12)\n    at <anonymous> (/Users/arthurstockler/development/fanpulse/chain-sdk-node/node_modules/rxjs/src/internal/observable/innerFrom.ts:90:24)\n    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)","timestamp":"2025-03-04T19:21:58"}

[Papooch]

Two things here - if you want to rely on ClsMiddleware or ClsInterceptor to initialize the context, then don't manually call cls.run. The ClientNameInterceptor could simply call cls.set(xx, yy) without the wrapping.

Since you use middleware: { mount: true }, then the context should have already been set-up by the time the interceptor runs.

If it does not, then the issue is likely related to the way you use the external library and how the dependencies are all wired together. This often causes issues for Nest-related packages.

Chances are, since there's an external library involved, that there exist two copies of nestjs-cls and therefore the context initialized by your application is not the same that the library's code is trying to use (especially if you try to locally link the library).

Please see this issue for a possible solution: #163