MongoDB 4.4에서 5.0으로 업그레이드 하기

한국그린데이터가 메인 DB 로 쓰는 MongoDB Atlas 를 4.4 에서 5.0 으로 올리고 NestJS 도 7.6 에서 8.2 로 함께 올린 기록이다. 정작 손이 많이 간 곳은 DB 자체가 아니라 mongoose 5 에서 6 으로 넘어가며 터진 옵션과 타입 에러 대응이었다.

핵심 포인트

Atlas 의 Shared cluster(M0/M2/M5) 는 강제 업그레이드 대상이었지만 이 팀은 Dedicated 라 영향이 없었고, 5.0 의 성능과 신기능을 쓰려고 자발적으로 올렸다.
의존성은 @nestjs/core 8.2.6 을 기준으로 호환 버전을 맞췄고, mongoose 는 6.1.2 에서 버그를 만나 6.1.7 로 바꿨다.
mongoose 6 부터 useNewUrlParser, useCreateIndex, useUnifiedTopology, useFindAndModify 옵션이 사라져 MongoParseError 가 난다.
_id 를 ObjectId 가 아닌 string 으로 쓰는 구조라, Native Driver 를 쓰는 마이그레이션 코드에서 타입 에러가 발생했다.
Atlas 는 한 번 업그레이드하면 다운그레이드가 불가능하므로 여유를 두고 신중히 진행해야 한다.

상세 정리

mongoose 6.1.2 와 6.1.7 은 둘 다 MongoDB Node.js Driver 4.2.2 를 쓰므로 MongoDB 5.2 까지 호환된다.
옵션 에러 대응: MongooseModule.forRoot 에 넘기던 deprecated 옵션 4종을 제거하면 된다. mongoose 6 은 그 동작을 기본값으로 내장한다.
bulkWrite 반환 타입이 BulkWriteOpResultObject 에서 BulkWriteResult 로 바뀌어, updateOne 과 조합해 만든 upsertBulk 구현부에서 타입 에러가 났다.
_id 를 string 으로 쓰는 이유는 API 로 넘어온 id 를 매번 ObjectId 로 변환해 조회하는 수고를 덜기 위해서다. 스키마에서 type String 에 default 로 ObjectId 를 문자열화해 넣는다.
다만 migrate-mongodb 패키지는 mongoose 가 아닌 Native MongoDB Driver 를 쓰므로 seed 삽입 코드에서 collection 호출에 _id 가 string 인 제네릭을 명시해야 타입 에러가 사라진다.
mongoose 6.1.2 에서는 aggregate 의 $group 사용 시 Property '_id' is incompatible with index signature 에러가 났다. 스펙 변경이 아니라 버그였고 6.1.3 에서 고쳐져 6.1.7 로 올려 해결했다.
개발 환경은 로컬 Docker 이미지를 mongo:5.0 으로 바꾸고, Dev 와 Prod 는 Atlas 클러스터의 Edit Configuration 에서 Additional Settings 의 버전을 5.0 으로 선택한다.
진행 순서는 로컬 검증, Dev 배포 후 최종 테스트, Prod 배포다. 인스턴스 종류와 용량에 따라 완료 시간이 달라진다.
@nestjs/microservices 는 MQTT 5 Shared Subscription 을 쓰려고 수정한 버전을 파일 경로로 물려 쓰고 있다.