[NestJs] 트러블슈팅: Redis Cache-manager v5 Error 해결 (ver.2023)

 
작성일 : 2023.1.13.
추가 수정일: 2023.1.20. (해결방법 1 메서드 사용 관련 설명 추가, 해결 방법 2 추가)

개요

Redis를 사용하기 위해서 공식문서 대로 따라 했는데도, 계속 에러가 발생하였다.
Nest 공식문서에서는 redis가 버전업 되면서 오류가 난다고 주의 표시를 해뒀다.

공식문서에 명시된 대로 redis 관련 라이브러리를 낮은 버전으로 설치를 했었는데도 여전히 에러가 발생하여서 공식문서가 전혀 도움이 안되었다.

NestJs Caching With Redis - Code with Vlad (22년 5월 문서)
How to add Redis cache to a NestJS app - LogRocket Blog (22년 7월 문서)
그래서 저 위 문서를 참고하면서 해봤는데도 여전히 오류가 났다.

이를 해결하기 위해서 시도했던 과정과 새로 알게 된 것에 대해서 기록해보고자 한다.

에러 발생

1. 타입 오류 로그

cache-manager.interface.d.ts(63, 5): 
The expected type comes from property 'store' 
	which is declared here on type 
	'CacheModuleOptions<{ 
    	store: (
        	config: RedisClientOptions<RedisModules, RedisFunctions, RedisScripts> 
            		& Config) => Promise<...>; 
            host: string;
            port: number; 
     }>'

Type 'RedisStore' is not comparable to type 'CacheStore' 
'CacheModuleAsyncOptions<
	RedisClientOptions<RedisModules, RedisFunctions, RedisScripts>>'

여러 시도를 해봐도 이런 타입 오류가 발생하였다.

1. redis 내 메서드 사용 오류 로그

[Nest] 24171 - 01/12/2023, 3:58:21 PM ERROR [ExceptionsHandler] 
this.cacheManager.set is not a function

이후 타입 관련 오류를 해결하고 나서 실행해보니 redis cacheManager 가 제대로 작동하지 않았다.
(디버깅해보니까 driver가 postgre로 찍혀있고, 호출한 메서드들이 모두 undefined로 나와있었다.)
 
 
 
 

해결방법 1 (nest js @9.2.1 이하인 경우)

2023.1.20. (메서드 관련 내용 추가)

이렇게 따로 글로벌 모듈 파일을 만들어주었다.
 
 

해당 모듈을 사용하는 방법은 이렇게 생성자 주입을 해주면 된다.

메서드 사용할 때 또 공식문서랑 다르게 해주어야한다. 메서드 사용 관련해서는 해당 글을 참고하였다.
 
package.json 버전은 다음과 같다.
(이 방법은 문서 나와있는 라이브러리들 버전 패치까지 꼼꼼히 따질 필요 없이 적당히 yarn, npm 가지고 최신버전으로 유지해줘도 된다.)

"dependencies": {
    "@nestjs/common": "^9.2.0",
    "@nestjs/config": "^2.2.0",
    "@nestjs/core": "^9.0.0",
    "cache-manager": "^5.1.4",
    "cache-manager-redis-store": "^3.0.1",
    "redis": "^4.3.1",
  },
  "devDependencies": {
    "@nestjs/cli": "^9.0.0",
    "@types/cache-manager": "^4.0.2",
    "@types/express": "^4.17.13",
    "@types/node": "^16.0.0",
  },

 
 
 
 

해결방법 2 (nestjs @9.2.1 이상)

 
2023.1.20. (추가):
잡소리: 해결방법 1 기준으로 메서드 사용 관련해서 문제가 생겨서 추가적으로 찾아보다가 정말 최근에 (4일전) 올라온 괜찮아 보이는 해결법을 찾아서 추가로 정리하였다.
 
해결 방법 1 커스텀 모듈을 만드는 것보다 이 방법이 좀 더 라이브러리 구조대로 잘 따르는 것 같아서 이 방법을 적용하였다.
 
cache-manager-redis-yet 라이브러리를 설치해준다.
 

yarn add cache-manager
yarn add cache-manager-redis-store-yet redis
yarn add -D @types/cache-manager

 
 

* 주의: nest js default ttl 값 (5초)이 자동으로 적용이 안되므로, ttl 설정을 반드시 해주어야한다.
 
* 주의: @CacheTTL(x) 글로벌 ttl 오버라이딩하는거 제대로 작동안됨
(cache-manager 버전이 5로 올라가면서 또 뭔가 이슈가 생김..) 여기 문서 참고하면 된다.
 
* 반드시 nest Js 9.2.1 버전 이상이어야 한다.
(왜 그렇냐면 nestJs 패치 버전 기록을 확인해보면 9.2.1 패치 때 관련 버그가 해결되었기 때문이다.)
 
* 공식문서에서는 ttl이 sec 단위라고 했지만, cache-manager 라이브러리가 5로 업글되면서 ms 단위로 바뀌었다.
 
* 나머지 사용법이나, 설정은 공식문서 대로 설정해주면 된다. (keys 이런 메서드 쓰고 싶으면 .store 불러서 쓰면 됨)
 
의존성 관련 package.json 버전 및 네스트 버전은 다음과 같다.
 

# dependencies
"cache-manager": "^5.1.4",
"cache-manager-redis-yet": "^4.1.0",
"redis": "^4.5.1",

# devDependencies
 "@types/cache-manager": "^4.0.2",

 
참고 문서: https://github.com/dabroek/node-cache-manager-redis-store/issues/40#issuecomment-1383193211
 
 

Nest Js 9.2.1 패치 내용

 

fix(cache): use passed store object by Leichtwind · Pull Request #10591 · nestjs/nest (github.com)



나는 Nest를 cli 를 사용하여 업데이트를 했었는데, 해당 버그를 수정한 패치가 적용이 안된 9.2.0 로 업데이트가 되어있었다.
당연히 가장 최근 버전으로 패치될 줄 알았는데 아니었다. 
package.json으로 버전 확실하게 명시해서 업뎃하길 추천..

Comparing 37764e717b400f3aa523f3755d83fea01263c9f7..3be19e694fc7491d45dd7b3c541c91fd9171014e · nestjs/nest (github.com)

해당 커밋을 보면 이렇게 수정되었다.

근데 여전히 라이브러리 호환문제에 대응해서 제대로 수정되지 못한 것 같다.
 
 

문제 해결 과정

삽질하면서 알게 된 정보를 정리해보려 한다.
(에러 무시하게 하는 주석을 추가하는 방법은 사이드 이펙트가 클 것 같아서 시도하지 않았다.)

시도 1: create 메서드를 통해 객체를 반환

CacheModule 내 설정을 다음과 같이 적어주었다.
 
 

 
이렇게 시도한 이유는 Nest 에서 store 프로퍼티를 타입별로 다르게 처리하는데, 라이브러리에서 주는 객체를 제대로 읽어오게끔 반환타입을 맞추어주기 위해서였다.
추가: 깃허브 돌아다니다가 다른 사람 코드 봤는데  (CacheModule.registerAsync<RedisClientOptions | any>({ ... }) ) 이렇게 써도 돌아가긴 하는 것 같다.


더 자세히 설명하자면, 라이브러리에서 새롭게 업데이트되면서

1. 해당 코드를 cache-manager-redis-store 라이브러리가 업데이트 되면서 redisStore() 비동기 함수를 가져와서 자체적으로 오브젝트를 만든다. (거기에 config 값도 socket 내에서 설정하는 것으로 업데이트되었다.)

 

export function redisStore(config: RedisClientOptions & StoreConfig): Promise<RedisStore>;

1. redisStore 함수의 인자 값으로 설정 옵션들을 넣고 redisStore라는 자체 오브젝트를 반환한다.

그런데 이때 nest에서는

1. store 가 object일 경우, store 객체 내 create라는 function 이 존재하는지 확인한다.
2. 이를 위해서 nestjs 가 인식할 수 있게끔 타입을 맞추어 주었다.

nest js 프레임워크가 실제로 어떻게 처리하는지 아래 코드와 설명을 함께 본다면 더 이해하기 쉬울 것이다.

• packages/common/cache/cache.providers.ts 

store 가 object일 경우, store 객체 내 create 라는 function 이 존재하는지 확인한다.
그리고 해당 객체 내에 있는 create 메서드를 통해서 값을 읽는다는 것을 알 수 있다.

• packages/common/cache/interfaces/cache-module.interface.ts   
  
  

CacheStoreFactory라는 interface를 확인해 보면, 이렇게 구현되어 있다.
(결론 파트에서 후술 하겠지만, cache-manager-redis-store 라이브러리가 버전 3으로 업데이트되면서, 더 이상 factory method를 통해서 store 가 인스턴스화 되지 않는다고 한다.)


결과는 여전히 타입 오류가 발생하였다.

Type 'RedisStore' is not comparable to type 'CacheStore' 
'CacheModuleAsyncOptions<RedisClientOptions<RedisModules, RedisFunctions, RedisScripts>>'

시도 2: 타입을 임의로 지정

 

 


이렇게 시도해 보았을 때, 타입 오류는 해결되었으나, redisStore에서 메서드를 못 읽어오는 문제가 발생했다.

[Nest] 24171 - 01/12/2023, 3:58:21 PM ERROR [ExceptionsHandler] 
this.cacheManager.set is not a function

이때 사용한 버전은 다음과 같다.

"@nestjs/core": "9.0.11",
"cache-manager": "4.1.0",
"cache-manager-redis-store": "3.0.1",

내 기억으로는 cache-manager-redis-store 버전 2.0.0 으로 낮추어도 오류가 났었던 것 같다.
(기억에 의존한 내용이라 이 부분은 확실한 것은 아니니 모듈 커스텀 설정 대신 다운그레이드 방식을 써볼 사람은 한번 시도해봐도 될 것 같다.)

3.0으로 했었던게 공식문서에서는 redis v3 쓰라고 적혀있었는데, 사용하는 redis 관련 라이브러리가 위 코드에 마지막 꺼 뿐이었고, 깃허브 이슈에서 사람들이 버전 명시를 저렇게 했는데 돌아간다고 해서 저렇게 설정했다. (그 외에 사람들이 해보란 대로 다 해봤는데 잘 안돌아갔다.)

시도 3: 라이브러리 버전을 공식 문서 기준으로 맞춰보기

Redis cashe 관련 공식문서에서 쓰인 예제코드의 dependencies는 다음과 같다.

"@nestjs/common": "9.0.1",
"@nestjs/core": "9.0.1",
"cache-manager": "4.1.0",
"cache-manager-redis-store": "2.0.0",
"redis": "3.1.0" // 예제 코드에는 없지만 공식문서에 적힌 대로 3.x.x 로 설치해봄

그러나 이렇게 버전을 맞춘 뒤에 공식문서 대로 진행했어도, 계속 에러가 발생하였다.
 
nest/sample/20-cache at master · nestjs/nest (github.com)
심지어 레디스 캐시 관련 기록 지워놓음;;; 커밋내역 뒤져서 확인했다.
 

 

이렇게 했는데도 여전히 타입 오류, import 오류가 떠서 정상적으로 실행이 안된다.

 

 


더 찾아보니까

• javascript - In Nest js, I added Redis as a cache manager. And can't find any added data in Redis after calling the set function. So, am I missing something? - Stack Overflow
• NestJS v9 incompatible with version 5 · Issue #210 · node-cache-manager/node-cache-manager · GitHub

Nest Js 버전 9 자체에서 호환이 안되는 오류였다고 한다.
단순 라이브러리 단에서 만의 문제가 아니었다.

또한 node-cache-manager version 5 또한 Nest version 8과 호환이 안된다고 한다.

nest@9.2에서 해결되었다는 글을 깃허브 issue란에서 보았었어서, nest js 프레임워크를 아예 최신 버전으로 업데이트도 해보았다.
또 프레임워크 최신 버전인 상태로 라이브러리도 예제 파일 package.json 대로 버전을 이리저리 바꾸어서 시도해 보았지만 모두 제대로 작동되지 않았다.


최후의 수단으로 프레임워크 자체 버전을 8로 낮췄더니 function이 아니라는 에러 메시지는 안 떴지만, redis DB에는 값이 제대로 들어오지 않았다.

 

시도 4: spread 연산자 사용해서 인터페이스 노출시키는 방법

orlein.github.io/2022-10-23-nestjs-redis-cache.md at a08be1dd9f29e367baa87ce3fa684cfa1be5698d · orlein/orlein.github.io
 
 
여기 문서 참고해서 따라해봤는데, 이것도 타입 오류는 해결되었긴 한데 여전히 안된다. 

CACHE_MODULE_OPTIONS 의존성 오류가 뜨는데, 근본적으로는 Nest Js 프레임워크 자체 문제라서 그냥 글로벌 모듈을 따로 만들어 주거나 네스트@9.2.1 이상 업데이트해서 적용하는 방법이 현재로서는 최선인 것 같다.

시도 5: 라이브러리 사용

구글링 해보니까, @liaoliaots/nestjs-redis - npm 해당 라이브러리가 다운로드 수도 괜찮은 것 같고, 설명을 읽어보니 Nest v9에서도 잘 호환이 된다 하여서 사용해 보았다.

근데... value 값으로 string만 지원한다.
redis를 쓰는 이유가 다양한 자료구조를 보장하기 때문인데 쓸모가 없었다.
심지어 Json.stringfy()를 써서 적용해 볼까 하다가, 이것도 오류가 발생하길래 사용하지 않았다.
 
 

 

 

---

에러 이유 분석 및 결론

에러 이유 분석

1.  CacheStoreFactory 관련 호환 문제

nest js (버전 9.2.1 이하)는 CacheStoreFactory 객체 내 create 메서드나, 함수를 통해서 반환된 cashStore 객체를 기대하지만, cache-manager 라이브러리에서는 버전 5으로 업데이트를 하면서 그런 방식을 완전히 버렸다.  
 
해당 설명은 여기 글에서 삽질 1 부분을 보면 된다.
 
 

2. store 객체 타입 호환 문제

또한 둘 다 최신 버전 기준으로 (nest 가장 최신버전: 9.2 , cache-manager v5) store 객체 타입이 서로 타입 호환이 안되어있다. (2023.1.13. 기준)



cache-manager-redis-store 라이브러리에서 정의된 RedisStore interface는 다음과 같다.
코드 출처: dabroek/node-cache-manager-redis-store · GitHub
 

 
RedisStore 는 Store 라는 인터페이스를 상속받고 오버라이딩한다.



nest js 프레임워크에서 정의된 CacheStore interface는 다음과 같다.
코드 출처: nestjs/nest/cache-manager.interface.ts · GitHub
 

 
따라서 서로 타입이 호환되지 않는다.



공식문서에서는 CacheModule에서 cacheStore를 읽어오기 위해서

    CacheModule.register<ClientOpts>({
      store: redisStore,

      // Store-specific configuration:
      host: 'localhost',
      port: 6379,
    }),

라고 하는데, 당연히 될 턱이 없다.

심지어, 애초에 ClientOpts 라는 타입도 없고, 타입들이 완전히 바뀌었다.
nest js는 CacheStoreFactory 객체 내 create 메서드나, 함수를 통해서 반환된 cashStore 객체를 기대하지만, 라이브러리에서는 그런 방식을 완전히 버렸다. (그래서 억지로 타입을 맞춰주어도 오류가 발생한 것 같다.)

결론

결국은 프레임워크 - 라이브러리끼리 서로 호환이 안된 총체적 난국이었다.
오류가 나기 시작한 버전 기준으로 라이브러리와 프레임워크 업데이트 된 날짜를 확인해 보니

• NestJs v9.0.0 - 2022.07.08.
  Releases · nestjs/nest
• Cache-manager: v.5.0.0 - 2022년 10월
  (github에서는 버전 4 릴리즈가 안 나와있지만, 아래 라이브러리와 시기가 비슷할 것으로 추정된다.)
  Releases · cache-manager
• node-cache-manager-redis-store: v3.0.0 - 2022.10.15.
  Releases · node-cache-manager-redis-store

redis-store에서 버전 3으로 업데이트하면서 Breaking Changes에서 추가적인 정보를 알 수 있다.

The store needs to be instantiated before passing it to cache-manager and can no longer be instantiated with the factory method.

추가적으로 Nest 릴리즈 노트를 확인해보면 v 9.2.1 에서 해당 문제를 고치려는 PR 이 있긴 한데, 궁극적으로는 해결 안되었다.



종합하자면 다음과 같다.

1. 라이브러리 내 redisStore와 Nest에서 cacheStore 객체끼리 타입이 호환되지 않는다.
2. 해당 객체를 호출하는 방식도 달라졌다.
3. 이를 해결하기 위해서 자체적으로 모듈화를 하였다.

Incompatible with NestJS cache store · Issue #53 · dabroek/node-cache-manager-redis-store (github.com)
> 보면 1월 20일 기준 아직 안고쳐짐
 

---

업데이트 날짜를 보았을 때, 작년 말에 발생한 이슈라서 구글링 해도 제대로 해결방법이 나오지 않아서 꽤나 고생을 했다.
그러나 결국 스스로 도움없이 오류를 해결하고, 원인도 파악 할 수 있게 되었다.

왜 interface 와 타입을 명시하는게 정말 중요하다는 점도 알게 되었다.
만약 추상화가 되어있지 않았다면, 코드를 파악하기 어려웠을 것 같고, JS처럼 타입이 제대로 명시 되어 있지 않다면, 디버깅을 해도 원인을 못찾았을 것 같다.

이를 통해서 비슷한 에러가 발생했을 때 좀 더 시간을 단축할 수 있을 것이다.

공식문서만 믿고 갔었는데 처음 겪어본 예상하지 못한 문제가 발생해서 많이 당황했다.
사실 좀 더 나은 방법이 있을 것 같긴 하다.
이번에는 다운그레이드 해도 작동이 되지 않아서 이렇게 방법을 채택했다.
버전을 맞춰준다는게 사실 어디까지가 안정적으로 돌아가는 것인지 파악하기가 어려운 것 같다.
 
그리고 타입을 any, unknown을 사용하거나 에러 무시하게 하는 명령어를 추가하는 방법도 있는 것 같긴 한데, 아직 공부 단계인지라 이것저것 여러가지로 시도해보았다.

다운그레이드가 나은지, 모듈을 따로 만들어주는게 나은 것인지 선택했어야 하는데...
사실 안정적인 버전으로 다운그레이드 하는 것이 실무에서 더 많이 적용되는 방법일 것 같다는 생각이 들었다.
그래서 다음에 또 이런 의존성 문제를 만난다면, 최대한 가장 안정적인 버전이 무엇인지를 찾아볼 것에 중점을 둘 것 같다.
 
 
 

 또 Node js 자체가 비교적 신기술이라 그런건지 모르겠지만 가끔 이런 순간이 당혹스럽기도하다. (TypeOrm 이 아직도 0.xx 단계인 것도....) 






첨언:
cache-manager-redis-store-yet 이런 라이브러리가 있는 것 같은데, 어떻게 쓰는지 문서가 업데이트 안되어있고, 구글링 해봐도 안 나오고, github에 해당 라이브러리를 쓴 코드가 있는지 아무리 검색해 봐도 보이지 않아서 사용하지 않았다.
→ 2023.1.20. 추가: 해결방법 2에 사용되었음


참고: cach-manager v4에서는 ttl 시간 단위가 sec고, v5에서는 ms이다. (골 때림;)



 
 
 
+ 대박 짱 기분 조음 공식문서 업뎃된거 보니까 내가 분석한게 맞았음ㅎㅎ
Caching | NestJS - A progressive Node.js framework

찢었다