Nestjs mailer module cannot find SMTP user and password problem

Nestjs mailer 모듈을 사용해 이메일을 보낼때 SMTP user, password 인증이 되지 않았던 이슈를 해결한 troubleshooting 기록입니다.

상황

Nestjs 로 RestAPI 서버를 만들던 중 회원가입을 한 유저에게 확인 이메일을 보내야 하는 작업을 하고 있었다. nestjs mailer 모듈을 설치해서 구현하던 중 env 파일에 SMTP_USER 와 SMTP_PASSWORD 를 넣은 것이 읽히지 않아 mailer module 을 실행할 때 에러가 나 메일이 보내지지 않았다.

기존 코드

 /src/mail/mail.module.ts

import { MailerModule } from '@nestjs-modules/mailer';
import { EjsAdapter } from '@nestjs-modules/mailer/dist/adapters/ejs.adapter';
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';

import * as path from 'path';

@Module({
  imports: [
    MailerModule.forRootAsync({
      imports: [ConfigModule],
      inject: [ConfigService],
      useFactory: (configService: ConfigService) => ({
        transport: {
          host: 'smtp.gmail.com',
          port: 587,
          secure: false,
          auth: {
            user: configService.get<string>('SMTP_AUTH_USER'),
            pass: configService.get<string>('SMTP_AUTH_PW'),
          },
        },
        defaults: {
          from: process.env.SUPPORT_EMAIL,
        },
        template: {
          dir: `${path.resolve(__dirname, '../../templates')}`,
          adapter: new EjsAdapter(),
          options: {
            strict: true,
          },
        },
      }),
    }),
  ],
})
export class MailModule {}

.env

SMTP_AUTH_USER=my-email@mail.com
SMTP_AUTH_PW=abcd@$!

configService.get<string>('SMTP_AUTH_USER'), configService.get<string>('SMTP_AUTH_PW') 이 제대로 동작하지 않아 user, pass 가 비어서 들어가서 smtp.google.com 을 사용할 수 없는 것이 문제였다.

env 에는 분명히 잘 넣었고 mail.module.ts 에서 env 도 잘 읽히는데 어떤 것이 잘못인지 몰라 헤맸다.

삽질끝에 알게된 원인은 바로 SMTP_AUTH_PW 에 있던 $ 였다.

https://docs.nestjs.com/techniques/configuration#expandable-variables

@nestjs/config 모듈을 사용해서 env 환경 변수들을 읽어오고 있는데, 이 모듈은 문서에 보니 expandable 변수라는 것을 지원하고 있다.

APP_URL=mywebsite.com
SUPPORT_EMAIL=support@${APP_URL}

${} 안에 변수를 넣으면 변수처럼 사용할 수 있는 기능인데,

@nestjs/config 가 내부적으로 사용하고 있다는 dotenv-expand 모듈에 들어가보니

PASSWORD="s1mpl3"
DB_PASS=$PASSWORD

dotenv-expand 모듈에서는 $ 표시만으로도 변수라고 인식하고 있었다.

SMTP_AUTH_PW=abcd@$!

이렇게 $ 표시를 넣어버렸기 때문에, 뒤에 ! 가 변수로 인식되어서 인증에 실패했던 것이다.

그래서 앞뒤에 ‘ 를 붙여 string 으로 변환해 해결하였다.

solution

SMTP_AUTH_PW='abcd@$!'

nestjs request dto and response dto

google social login 한 유저의 생년월일 가져오기

TypeORM soft delete on cascade

typeORM entity 에서 비밀번호 hash 하기