ClsPluginModule Error of Mongoose

[giwonn]

Hi, I got a some problem.

Please see the code below.

// mongo.module.ts
import { Global, Module } from '@nestjs/common';
import { getConnectionToken, MongooseModule } from '@nestjs/mongoose';
import { ClsModule } from 'nestjs-cls';
import { ClsPluginTransactional } from '@nestjs-cls/transactional';
import { TransactionalAdapterMongoose } from '@nestjs-cls/transactional-adapter-mongoose';
import { ConfigModule, ConfigService } from '@nestjs/config';

@Global()
@Module({
  imports: [
    // Mongoose configuration
    MongooseModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: async (configService: ConfigService) => ({
        uri: configService.get<string>('DATABASE_URI'),
      }),
      inject: [ConfigService],
    }),
    // nestjs-cls configuration
    ClsModule.forRootAsync({
      imports: [MongooseModule],
      useFactory: () => ({
        global: true,
        middleware: { mount: true },
        plugins: [
          new ClsPluginTransactional({
            adapter: new TransactionalAdapterMongoose({
              mongooseConnectionToken: getConnectionToken(),
            }),
          }),
        ],
      }),
    }),
  ],
  exports: [MongooseModule, ClsModule],
})
export class MongoModule {}

MongoModule is imported into AppModule.
So I used txHost below.

import { Injectable } from '@nestjs/common';
import { User, UserDocument } from '@/infra/schema/user';
import { Model } from 'mongoose';
import { InjectModel } from '@nestjs/mongoose';
import { TransactionHost } from '@nestjs-cls/transactional';
import { TransactionalAdapterMongoose } from '@nestjs-cls/transactional-adapter-mongoose';

@Injectable()
export class UserRepository {
  constructor(
    @InjectModel(User.name) private readonly userModel: Model<UserDocument>,
    private readonly txHost: TransactionHost<TransactionalAdapterMongoose>,
  ) {}

  async findByEmail(email: string): Promise<UserDocument | null> {
    return await this.userModel.findOne({ email }).session(this.txHost.tx);
  }

  async create(user: User): Promise<UserDocument> {
    return await this.userModel.create(user);
  }
}

But... I got a exception below.

Error: Nest can't resolve dependencies of the UserRepository (UserModel, ?). Please make sure that the argument TransactionHost at index [1] is available in the UserModule context.

Potential solutions:
- Is UserModule a valid NestJS module?
- If TransactionHost is a provider, is it part of the current UserModule?
- If TransactionHost is exported from a separate @Module, is that module imported within UserModule?
  @Module({
    imports: [ /* the Module containing TransactionHost */ ]
  })

I really don't know why it occurs...

I'm just considering making custom decorator, but I'd like to use the features provided by nestjs-cls if possible.

[Papooch]

Hi, I don't know if it's a bug in the method signature of the ClsModule (I'll need to double check), but the plugins array always goes to the root object (in both sync and async versions) and not in the factory.

The imports array needed for the plugin also goes into the plugin constructor, not in the imports of ClsModule.

Edit: the global flag also goes to the root, as with all other modules.