Querydsl의 transform 사용시 HikariCP Connection Leak

😭 이슈 발생

---

어느 날 팀원분이 PinPoint 모니터링 중 병목이 발생한다고 말씀을 해주셨는데, 일단 구체적인 원인을 모르니 상황을 조금 더 지켜보기로 했습니다. 병목이 발생한 타이밍이 필자가 RabbitMQ 설정을 추가적으로 설정한 탓에 발생한 건가?라는 생각을 했었는데 추후에 RabbitMQ 설정을 원래대로 설정을 하고 배포를 했는데도 불구하고 계속하여 문제가 발생을 하였습니다. 

RabbitMQ와 관련이 없구나 생각한 후 aws Cloudwatch의 로그를 보던 중 특정 API 호출 후 문제가 발생하는 것 같은 느낌을 받아 특정 API의 소스코드를 보았는데 QueryDSL의 메서드 중 transform 메서드를 확인하고 이게 어떤 역할을 하는지부터 찾아보게 되었습니다. 그리고 이녀석이 문제였구나 알게된 과정을 공유하겠습니다.

 

💡 버전 정보

querydsl-jpa: 5.0.0 version
hibernate-core: 5.6.14 final version

 

💡 HikariCP 로깅 활성화

 

• application.yml에 DB Connection을 보기 위해 다음을 추가합니다.

logging:
  level:
    com.zaxxer.hikari: trace
    com.zaxxer.HikariConfig: DEBUG

 

로직을 살펴보자.

---

아래 로직을 보면 QueryDSL을 사용중이고 하나의 메서드는 fetch 메서드를 다른 하나의 메서드는 transform 메서드를 사용하는 것을 볼 수 있습니다. 또 중요한 점은 바로 해당 클래스 어디에도 @Transactional 어노테이션이 선언되어 있지 않다는 점입니다.

 

 

💡 transform 메서드와 fetch 메서드의 차이

 

• transform 메서드는 내부적으로 iterate를 반환합니다.
• fetch 메서드는 내부적으로 getResultList를 반환합니다.
• 하지만 두 메서드 모두 this.createQuery() 메서드를 호출하고 있습니다.

 

 

fetch 메서드를 살펴보자.

---

fetch 메서드는 AbstractJPAQuery 클래스의 createQuery 메서드를 호출하고 내부적으로 자신 클래스의 createQuery 메서드를 호출하고 있습니다. 이때 this.entityManager로 SharedEntityManagerCreator 클래스의 내부 클래스인 SharedEntityManagerInvocationHandler 클래스의 invoke 메서드가 호출됩니다.

 

AbstractJPAQuery.class의 일부

 

위에서 entityManager의 호출로 인해 SharedEntityManagerCreator 클래스의 내부 클래스인 SharedEntityManagerInvocationHandler 클래스가 호출된다고 하였습니다. 여기서 중요한 몇가지가 나오는데 살펴봅시다.

 

1. 현재 트랜잭션에 참여하고 있다면 target은 null이 아니게 됩니다. 다만 트랜잭션에 참여하고 있지 않다면 null이 됩니다. 우리는 지금 트랜잭션에 참여하고 있지 않기 때문에 target은 null이 됩니다. 
2. target은 null이므로 if 조건문에 해당하여 target에는 새로운 entityManager가 생성되고 isNewEm 변수는 true가 됩니다.
3. isNewEm 변수가 true이기 때문에 if 조건문에 해당하여 result는 DeferredQueryInvocationHandler 프록시를 반환하게 됩니다.

SharedEntityManagerInvocationHandler class의 일부

 

지금까지 createQuery 메서드에 의해 entityManager가 생성되는 과정을 살펴봤습니다. 그렇다면 이제 fetch 메서드가 반환하는 getResultList 메서드에 대해 살펴보겠습니다.

 

1. DeferredQueryInvocationHandler 클래스의 invoke 메서드의 finally 메서드에서 if문에 만족하는 메서드의 이름인 경우 최종적으로 자신이 사용한 entityManager를 close하고 null 처리를 하고 있는 과정을 살펴볼 수 있습니다. 근데 어떤 메서드의 이름인 경우에만 해당 if 문에 해당하는 걸까?

 

💡 자동으로 close해주는 메서드의 종류

 

 

transform 메서드를 살펴보자.

---

transform 메서드는 내부적으로 iterate를 반환한다고 하였습니다. 또한 아래 로직을 보면 iterate를 사용하여 Tuple을 만든 후 결과값을 반환하는 로직을 볼 수 있습니다. 또한 transform은 내부적으로 SharedEntityManagerCreator 클래스의 queryTerminationMethods가 실행되지 않기 때문에 entityManager가 close 되지 않습니다. 따라서 자신이 사용한 entityManager는 언젠간 close 되며 Leak이 발생하게 됩니다.

 

GroupByMap class의 일부

 

결론.

---

@Transactional 어노테이션을 사용하여 transform 메서드 호출 시 트랜잭션에 참여하도록 하여 entityManager를 close할 수 있도록 해주자 입니다.

 

 

 

참고자료

• https://colin-d.medium.com/querydsl-%EC%97%90%EC%84%9C-db-connection-leak-%EC%9D%B4%EC%8A%88-40d426fd4337