[error] Jest did not exit one second after the test run has completed. 해결

저번에 진행한 원티드 백엔드 프리온보딩코스 4번째 과제의 테스트코드 작성 중 발견한 에러이다.

 

e2e test를 실행했을 때, test종료 후에 아래와 같은 노란 경고 메세지가 등장했다!

너는 누구냐!

메세지를 그대로 해석해보면 

Jest did not exit one second after the test run has completed.

→ Jest가 test가 완료되고 1초 후에도 exit되지 않았다. 

→ Jest가 안끝난다!! (뭔가 종료되지 않고 남아있다)

 

This usally means that there are asynchronous operations that weren't stopped in your tests. Consider running Jest with '--detectOpenHandles' to troubleshoot this issue.

→ test안에 종료되지 않은 비동기 작업이 있을 때 발생하더라. --detectOpenHandles 옵션 사용을 고려해봐라. 

 

그래서 '친절하게 해결방법도 알려주는구나' 하고 --detectOpenHandles 옵션을 사용하려고 했다. 

 

그러나 JEST --detectOpenHandles 공식 문서를 읽어보니

Attempt to collect and print open handles preventing Jest from exiting cleanly. Use this in cases where you need to use --forceExit in order for Jest to exit to potentially track down the reason. This implies --runInBand, making tests run serially. Implemented using async_hooks. This option has a significant performance penalty and should only be used for debugging.

내가 이해한 바는 다음과 같다.
실행중인게 있으면 Jest가 완벽히 종료되지 않으니, 강제종료가 필요할 때 이 옵션을 사용해라.
그렇지만 이 옵션은 성능이 많이 저하되니 디버깅에만 사용해라. 

그래서 이 옵션 말고 다른 방법을 찾아봤다.

 

종료되지 않은 비동기 작업이 무엇인지 찾아서, 걔를 종료해주면 될 것이다!

 

커뮤니티를 뒤져보니 test 종료후에 DB connection을 close해보라는 의견이 굉장히 많았는데,

우리 코드에서는 명시적으로 connection을 만들어 사용하지 않아서, 어떻게 close를 하라는건지 한참 헤맸다.

 

답은 TypeormModule.forRoot() 안에 옵션으로 설정한 keepConnectionAlive 를 false로 바꿔주는 것이었다.

keepConnectionAlive: true 옵션은 어플리케이션 종료 후에도 연결이 종료되지 않도록 해준다.

그래서 문제가 되었던 것이다!

 

그렇지만 keepConnectionAlive: false로 바꾸자 다른 에러가 발생했다.

띠용 "defalut" 라는 이름의 커넥션을 중복생성할 수 없다!

 이 에러를 마주하자 문득 프로젝트 수행 당시의 기억이 떠올랐다.

keepConnectionAlive 옵션은 기본 값이 false이다. 그런데 프로젝트 진행중에 위와 같은 에러가 생겨서, 저 에러를 해결하기 위해 keepConnectionAlive: true을 추가했던 것 같다.

 

그렇다면, 이 중복 커넥션 에러는 왜 발생하는 것일까? 

 

답은 e2e test 코드에 있었다.

app.init을 beforeEach 즉, 매 test마다 하고 있었기 때문이다.

매 test마다 init을 하니, default 커넥션이 중복되어 문제가 되었던 것이다.

beforeEach를 beforeAll로 바꾸어 문제를 해결할 수 있었다.

beforeEach(async () => {
    const moduleFixture: TestingModule = await Test.createTestingModule({
        imports: [AppModule]
    }).compile();

    app = moduleFixture.createNestApplication();
    await app.init();
});

 

소감 열 마디 

프로젝트 진행 당시에, default connection 중복 에러가 발생했을 때

무작정 keepConnectionAlive: true을 추가하기보다

왜 저런 에러가 발생했을까를 먼저 이해했으면 좋지 않았을까 하는 생각이 들었다.

 

검색으로 웬만한 error의 해결방식을 찾을 수 있지만, 이렇게 검색으로 error를 해결해나가는게 좋은 태도인가는 생각해볼 필요가 있을 것 같다.

검색이 나쁘다는 것이 아니다.

무작정 해결하려 하기보단 먼저 왜 이런 에러가 발생했는지를 충분히 이해해야 한다는 것이다.

 

한편으로는, 프로젝트 진행 당시보다 Nest 및 test코드 작성에 능숙해져서 해결할 수 있지 않았나하는 생각도 든다.

시간에 쫓기지 않으니 느긋하게 error를 탐구할 수 있어 좋다. 

 

e2e test를 진행하면서 발견한 error가 하나 더 있는데, 그것도 어서 해결해보고 싶다!