라이브러리를 죽여버릴 수야 없겠지만

상황

Nest.js 서버에서 jest를 사용한 테스트 코드를 작성하고 있었다. 평소에는 아래와 같이 ConfigService를 모의하여 configService.get으로 환경 변수를 처리했다. 그런데 이런 방식이 마음에 들지 않았다. 가장 큰 이유는 필요한 문자열이 하드코딩 되어있어 환경 변수를 바꾸거나 바뀌어야 할 때마다 수작업을 해야 했기 때문이다.

{
  provide: ConfigService,
  useValue: {
    get: jest.fn((key: string) => {
      if (key === 'jwt.accessSecret') return 'accessSecret';
      if (key === 'jwt.refreshSecret') return 'refreshSecret';
      return null;
    }),
  },
},

따라서 나는 ConfigModule을 사용해 테스트 모듈이 직접 .env.test의 값을 가져다 쓰도록 했다. 이렇게 하면 혹시 모를 보안 사고를 예방할 수 있고, 뭔가를 바꿔야 할 때마다 테스트 코드를 만지는 대신 .env.test만 수정하면 된다. 이론상 모든 것이 완벽했다.

describe('BookResolver', () => {
  let resolver: BookResolver;
  let jwt: ConfigType<typeof jwtConfig>;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      imports: [
        ConfigModule.forRoot({
          envFilePath: '.env.test',
        }),
      ],
      providers: [
        BookResolver,
        {
          provide: jwtConfig.KEY,
          useValue: jwtConfig(),
        },
      ],
    }).compile();

    resolver = module.get(BookResolver);
    jwt = module.get(jwtConfig.KEY);
  });
});

문제

하지만 현실은 시궁창이고, ConfigModule은 .env.test가 아닌 .env의 값을 가져오고 있었다. 뭔가 잘못됐나 싶어서 이리저리 코드를 바꿔보았지만 달라지는 게 없었다. 이 과정에서 한 가지 특이한 현상을 발견할 수 있었다. 루트 디렉토리에 .env가 없으면 .env.test의 값을 제대로 가져오지만, 루트 디렉토리에 .env가 있으면 무조건 .env의 값을 가져오는 것이 아닌가.

따라서 src/config에 .env와 .env.test를 두면 문제 자체는 해결할 수 있을 것이다. 그러나 원인을 모르는 채 현상만을 해결하는 게 영 마음에 들지 않았다. 나는 이 문제의 원인을 찾는데 꼬박 하루가 걸렸다.

일단은 새로운 Nest.js 프로젝트를 하나 만들고 거기서 ConfigModule을 테스트해보았다. 여기서는 루트 디렉토리에 .env가 있어도 문제 없이 .env.test의 값을 가져오고 있었다. 이를 근거로 나는 '어떤 라이브러리가 루트 디렉토리의 .env를 process.env에 덮어쓰고 있다'고 판단했다.

확인해보기 위해 AppModule에 import 되어있는 모듈을 모두 주석처리 해보았다. 그랬더니 .env가 루트 디렉토리에 있어도 테스트 코드는 .env.test의 값을 가져오는 것이 아닌가! 내 가설은 증명되었다. 그러나 추가로 설치한 수많은 라이브러리 중에서 어떤 놈이 문제를 일으키고 있는 건지는 알 수가 없었다.

나는 새로운 모듈을 만들어 라이브러리를 하나씩 추가해보기로 했다. 추가할 때마다 테스트를 돌려서 ConfigModule이 .env 값을 가져오는지 확인했다. 이 지난한 노가다 끝에 나는 범인을 색출할 수 있었다. 처음에는 dotenv가 범인이지 않을까 싶었는데, 놀랍게도 진범은 따로 있었다.

해결

prisma가 문제였다. 이놈이 루트 디렉토리의 .env를 process.env에 덮어씌워버리는 것이다! 이 키워드를 가지고 구글에 검색해보니 이미 이 문제를 겪은 다른 개발자분의 블로그 포스트 Prisma는 process.env를 강제로 덮어씌운다 를 찾을 수 있었다. 라이브러리를 죽여버릴 수야 없겠지만, 꼬박 하루를 이 문제에 쏟아부은 탓에, 나도 모르게 prisma를 죽여버리고 싶다는 생각을 해버릴 정도였다.

해결 방법은 간단하다. 처음 찾았던 것처럼 루트 디렉토리에 .env를 쓰지 않으면 그만이다. 그런데 prisma는 루트 디렉토리에 .env가 없으면 제대로 동작하지 않는다. 따라서 dotenv-cli를 사용해 CLI 명령어 실행 전에 환경 변수를 로드해주어야 한다.

dotenv -e .env.local -- npx prisma generate