NestJS is unable to resolve the dependencies for JWT_MODULE_OPTIONS

Question

NestJS is unable to resolve the dependencies for JWT_MODULE_OPTIONS

My compilation failed with the following error message:

Nest can't resolve dependencies of the JWT_MODULE_OPTIONS (?). Please ensure that the argument at index [0] is available in the JwtModule context. +52ms

I encountered similar issues regarding dependencies with modules and services, but the suggested solutions didn't work for me. I am using JwtModule in my auth.module.ts:

import { JwtModule } from '@nestjs/jwt';
@Module({
    imports: [
        TypeOrmModule.forFeature([User, Role]),
        ConfigModule,
        PassportModule.register({ defaultStrategy: 'jwt' }),
        JwtModule.registerAsync({
            inject: [ConfigService],
            useFactory: async (configService: ConfigService) => ({
                secretOrPrivateKey: config.jwtSecret,
                type: configService.dbType as any,
                host: configService.dbHost,
                port: configService.dbPort,
                username: configService.dbUsername,
                password: configService.dbPassword,
                database: configService.dbName,
                entities: ['./src/data/entities/*.ts'],
                signOptions: {
                    expiresIn: config.expiresIn,
                },
            }),
        }),

    ],
    providers: [AuthService, JwtStrategy],
    controllers: [AuthController],
})
export class AuthModule { }

I am unsure how to resolve this bug... Currently using jwt 6.1.1

Edit: In my previous project, I utilized jwt 6.0.0, therefore I downgraded it, however, the issue persisted.

typescript module nestjs

Answer 1

Answer №1

First off, there seems to be a mix-up in the configuration between TypeORMModule and JWTModule.

Based on the source code for @nestjs/jwt (link) and the corresponding documentation, it appears that only secretOrPrivateKey and signOptions are related to the JWTModule configuration. The other parameters should belong to the TypeORMModule configuration.

Additionally, the ConfigService (which is a dependency of the JWT module) is not being imported anywhere in your code. This lack of import means that the module where ConfigService is defined is missing from your project.

As a result, the error you're encountering is likely due to this missing dependency not being able to load correctly.

To resolve this issue, make sure to include the necessary import for the module containing ConfigService (e.g., ConfigModule as shown below). Without this import, the ConfigService cannot be injected into the JWT module.

JwtModule.registerAsync({
  imports: [ConfigModule], // Don't forget this
  useFactory: async (configService: ConfigService) => ({
    signOptions: {
       expiresIn: config.expiresIn,
    },
    secretOrPrivateKey: config.jwtSecret,
  }),
  inject: [ConfigService], 
}),

Answer 2

First off, there seems to be a mix-up in the configuration between TypeORMModule and JWTModule.

Based on the source code for @nestjs/jwt (link) and the corresponding documentation, it appears that only secretOrPrivateKey and signOptions are related to the JWTModule configuration. The other parameters should belong to the TypeORMModule configuration.

Additionally, the ConfigService (which is a dependency of the JWT module) is not being imported anywhere in your code. This lack of import means that the module where ConfigService is defined is missing from your project.

As a result, the error you're encountering is likely due to this missing dependency not being able to load correctly.

To resolve this issue, make sure to include the necessary import for the module containing ConfigService (e.g., ConfigModule as shown below). Without this import, the ConfigService cannot be injected into the JWT module.

JwtModule.registerAsync({
  imports: [ConfigModule], // Don't forget this
  useFactory: async (configService: ConfigService) => ({
    signOptions: {
       expiresIn: config.expiresIn,
    },
    secretOrPrivateKey: config.jwtSecret,
  }),
  inject: [ConfigService], 
}),

Answer 3

Answer №2

After some trial and error, I managed to solve the issue by including the following code:

JwtModule.registerAsync({
  imports: [ConfigModule], // This was crucial
  useFactory: async (configService: ConfigService) => ({
    signOptions: {
       expiresIn: config.expiresIn,
    },
    secretOrPrivateKey: config.jwtSecret,
  }),
  inject: [ConfigService], 
}),

within both app.module.ts and auth.module.ts

Answer 4

After some trial and error, I managed to solve the issue by including the following code:

JwtModule.registerAsync({
  imports: [ConfigModule], // This was crucial
  useFactory: async (configService: ConfigService) => ({
    signOptions: {
       expiresIn: config.expiresIn,
    },
    secretOrPrivateKey: config.jwtSecret,
  }),
  inject: [ConfigService], 
}),

within both app.module.ts and auth.module.ts

Answer 5

Answer №3

To create a dedicated module for this functionality, you can implement SharedModule.

Ensure that the following dependencies are installed:

npm i --save @nestjs/jwt
npm i --save @nestjs/passport

(optional, if opting for MongoDB/Mongoose)

npm i --save @nestjs/mongoose

shared.module.ts

@NgModule({
   imports: [
      PassportModule.register({
          defaultStrategy: 'jwt',
        }),
        JwtModule.register({
          secret: process.env.JWT_SECRET_KEY,
          signOptions: {
            expiresIn: '2 days',
          },
        }),
    
   ],
   providers: [JwtStrategy],
   exports: [JwtStrategy, PassportModule]
})

jwt.strategy.ts

@Injectable()
export class JwtStrategy extends PassportStrategy(Strategy) {
  constructor(@InjectModel('User') private collection: Model<User>) {
    super({
      jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
      secretOrKey: process.env.JWT_SECRET_KEY,
    });
  }

  async validate(payload: JwtPayload): Promise<User> {
    const { username } = payload;
    const user = await this.collection.findOne({ username });

    if (!user) {
      throw new UnauthorizedException('JwtStrategy unauthorized');
    }

    return user;
  }
}

After importing it in your SharedModule, decorate your controllers as follows

@UseGuards(AuthGuard())

Answer 6

To create a dedicated module for this functionality, you can implement SharedModule.

Ensure that the following dependencies are installed:

npm i --save @nestjs/jwt
npm i --save @nestjs/passport

(optional, if opting for MongoDB/Mongoose)

npm i --save @nestjs/mongoose

shared.module.ts

@NgModule({
   imports: [
      PassportModule.register({
          defaultStrategy: 'jwt',
        }),
        JwtModule.register({
          secret: process.env.JWT_SECRET_KEY,
          signOptions: {
            expiresIn: '2 days',
          },
        }),
    
   ],
   providers: [JwtStrategy],
   exports: [JwtStrategy, PassportModule]
})

jwt.strategy.ts

@Injectable()
export class JwtStrategy extends PassportStrategy(Strategy) {
  constructor(@InjectModel('User') private collection: Model<User>) {
    super({
      jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
      secretOrKey: process.env.JWT_SECRET_KEY,
    });
  }

  async validate(payload: JwtPayload): Promise<User> {
    const { username } = payload;
    const user = await this.collection.findOne({ username });

    if (!user) {
      throw new UnauthorizedException('JwtStrategy unauthorized');
    }

    return user;
  }
}

After importing it in your SharedModule, decorate your controllers as follows

@UseGuards(AuthGuard())

NestJS is unable to resolve the dependencies for JWT_MODULE_OPTIONS

Answer №1

Answer №2

Answer №3

Similar questions

What steps should I take to create a TypeScript generic class that is limited to only accepting types that are arrays of objects?

Is the parent component not triggering the function properly?

What about numerical inputs lacking spinners?

Utilizing feature flags for Angular modules to enable lazy loading

Developing a structure or definition for a Map

Display a modal dialog using HttpInterceptor

Is there a workaround in TypeScript to add extra details to a route?

What is the best way to perform unit testing on a function component that includes React.useState() using jest and enzyme?

Errors in Compiling Dependencies for d3.js Using Typescript

Error: Axios encountered an issue with resolving the address for the openapi.debank.com endpoint

An in-depth guide on implementing Highcharts.Tooltip functionality in a TypeScript environment

What is the best way to pass a URL as a prop in Next.js without encountering the issue of it being undefined

I attempted to use an `if` statement as my type guard, but TypeScript decided to overlook it

How can we initiate an AJAX request in React when a button is clicked?

What is the process for implementing a decorator pattern using typescript?

A reflective key error has occurred because the token was not properly defined!

Express.js/Typescript: TypeScript Error TS2339: The property 'send' is not found on the type 'Response'

Angular is utilized to create a dynamic multiple slide carousel that features repeating items

To successfully navigate to another component view using routerLink in Angular 5, what specific requirements must be met?

Cannot proceed with module import: Type 'ModuleWithProviders<T>' must have a single type argument