Nest 8 + redis bug

[herenickname]

[Nest] 2697522 - 07/09/2021, 12:43:37 AM ERROR [ExceptionHandler] Nest can't resolve dependencies of the RedisCoreModule (Symbol(REDIS_MODULE_OPTIONS), ?). Please make sure that the argument ModuleRef at index [1] is available in the RedisCoreModule context.

Potential solutions:

• If ModuleRef is a provider, is it part of the current RedisCoreModule?
• If ModuleRef is exported from a separate @module, is that module imported within RedisCoreModule?
  @module({
  imports: [ /* the Module containing ModuleRef */ ]
  })

[aoxiang78]

Stopped here, there is no way to continue, do you have a temporary solution?

[rares-lupascu]

i personally duplicated this module into my local nestjs project

[aoxiang78]

@rares-lupascu Which files have you updated? Can you share it? I haven't solved this problem

[rares-lupascu]

@aoxiang78 ok might sound weird but just add this to redis-core.module.ts:

1. import { ConfigModule } from '@nestjs/config';
2. in the module definition .... change this

@Module({
  providers: [RedisService],
  exports: [RedisService],
})

to this (line 20):

@Module({
    providers: [RedisService],
    exports: [RedisService],
    imports: [ConfigModule],
})

[aoxiang78]

Solved it your way, thank you for your help @rares-lupascu

[brandongit2]

@rares-lupascu That doesn't seem to be working for me. Could you explain how adding ConfigModule to the imports solves NestJS looking for ModuleRef? That part confuses me.

[rares-lupascu]

@brandongit2 what I did was to create a local Redis module copying the contents of this repo into it (the lib folder) and applying the change I did at the top ... hope this helps

[alikil]

I cannot use this solution at production build.
Still waiting for this library fix.

[PraveenKumarPalai]

@rares-lupascu Nice workaround for local 😎 !!

But for production, when can we expect a fix on this?

[bangbang93]

Keep watching. We are migrating to nestjs 8 and stuck on this.

[GyanendroKh]

Instead of using ModuleRef to get the RedisClient, the RedisClient could be directly injected using @Inject(REDIS_CLIENT). And this solves the problem. I opened a pull request #85.

For now I'm using the library by directly downloading it from my Github Repo. Hope it will be released soon.

{
  "dependencies": {
    "nestjs-redis": "git+https://github.com/GyanendroKh/nestjs-redis.git#nest8-fix",
  }
}

[cdlaiqi]

@rares-lupascu solved the problem, thank you

[nolawnchairs]

It's been over two years since the last release was published, so I personally consider this project abandoned.

[SampaioLeal]

It's been over two years since the last release was published, so I personally consider this project abandoned.

you mean the 1.3.3 4 months ago?

[Yurko-Fedoriv]

Adding here: actually, no code change is required, and lib just needs to be recompiled with updated dependencies.
If you simply copy lib/ into your src codebase and import from it instead of nestjs-redis app will work just fine.

That is why this "weird" solution works
And while this PR is valid, it is not needed too.

If you are using yarn, you probably can just install the package from github and import from lib/
npm will try to run prepublish and fail on non-existing yarn.
You can fiddle with postinstall command of your project to pull the dependency from gitlab.

I personally will just copy the lib/ into my codebase and hope the package will eventually get the update.

[MichaelTsengLZ]

This issue is still exist while installing with npm. Looks like you need to republish your npm package. Currently, I'm overcome this issue by changing the package.json

"nestjs-redis": "git+https://github.com/skunight/nestjs-redis.git",

[manlyman29]

@MichaelTsengLZ The issue is with CI/CD referring to github repo doesn't works and i couldn't find a workaround as of now. Really hope a contributor could raise the version and publish on npm, I am seriously stuck over this.

[lioralon326]

@MichaelTsengLZ The issue is with CI/CD referring to github repo doesn't works and i couldn't find a workaround as of now. Really hope a contributor could raise the version and publish on npm, I am seriously stuck over this.

Try upgrading to nest 8.0.9 and above, works there for me

[zackarychapple]

git+https://github.com/skunight/nestjs-redis.git

Confirmed that this worked for me as well. Hope to see this updated as using git+https is not as reliable for protecting against breaking changes.

[volodyad]

git+https://github.com/skunight/nestjs-redis.git

Confirmed that this worked for me as well. Hope to see this updated as using git+https is not as reliable for protecting against breaking changes.

You could connect to git commit "nestjs-redis": "git+https://github.com/skunight/nestjs-redis.git#939f33a7f9b252e872c6edb76a3a860ed053bacf", it will be safer at least

[pietrovismara]

@skunight any change of getting this fix in the latest on npm?

[Distortedlogic]

bump

[robertsLando]

Today this seems to still be a problem...

Solution: npm install @liaoliaots/nestjs-redis

[Distortedlogic]

@robertsLando src/index.ts(8,30): error TS2307: Cannot find module 'nestjs-redis' or its corresponding type declarations. your package did not work for me :/ but the git+https://github.com/skunight/nestjs-redis.git#939f33a7f9b252e872c6edb76a3a860ed053bacf one does work for me

[robertsLando]

@Distortedlogic you have to import @liaoliaots/nestjs-redis not nestjs-redis

[stefan030]

@Distortedlogic you have to import @liaoliaots/nestjs-redis not nestjs-redis

Still getting similar error after trying out liaoliaots' package.

Nest can't resolve dependencies of the Symbol(create-nestjs-middleware-module:options) (?, ConfigService). Please make sure that the argument RedisService at index [0] is available in the CoreModule context.

My nestjs version is 8.2.6

[stefan030]

As well as:
The redis client-provider 'Symbol(default)' was not found in the application context.

[Distortedlogic]

@stefan030 read the docs... this redis module cannot just be dropped inplace of the other. The config options have a different structure.. also, the module is global only! so u cannot import RedisModule into other modules without reinstantiating it with forRoot or whichever func, instead since its global just put in AppModule, n inject the service. hope this helps!

[robertsLando]

TLDR;

import { RedisModule } from '@liaoliaots/nestjs-redis';

/* ....  */
 RedisModule.forRoot({
      closeClient: true,
      config: {
        host: 'localhost',
        port: 6380,
      },
    }),

Docs: https://github.com/liaoliaots/nestjs-redis/blob/main/docs/v4/redis.md

[JustDoItSascha]

No release yet? Why is it closed? The error still exists...

[Halinen]

尝试用yarn更新了半天，最后直接把fix的版本clone了下来解决了- -

[JuKu]

@robertsLando Thank you very much! :)

[ymc9]

It turns out that for liaoliaots package RedisModule is by default global, you'll run into error if you import it into another module... Remove the import and the error is gone.

[Celleb]

@rares-lupascu Nice workaround for local 😎 !!

But for production, when can we expect a fix on this?

You can use https://www.npmjs.com/package/patch-package

npx patch-package nestj-redis

This will apply your changes every time you install or reinstall the package

[phillippelevidad]

This issue is still exist while installing with npm. Looks like you need to republish your npm package. Currently, I'm overcome this issue by changing the package.json

"nestjs-redis": "git+https://github.com/skunight/nestjs-redis.git",

This still seems to be the best solution in 2024 (NestJS v10, apparently not supported by liaoliaots).