Merge pull request #13 from ekennedy247/eugene/master/addEnabledPropertyForNPlusOneDetection

Add enabled property for N+1 detection

Author: yannbriancon

src/main/java/com/yannbriancon/interceptor/HibernateQueryInterceptor.java

@@ -92,9 +92,10 @@ public void afterTransactionCompletion(Transaction tx) {
      */
     @Override
     public Object getEntity(String entityName, Serializable id) {
-        detectNPlusOneQueriesOfMissingQueryEagerFetching(entityName, id);
-
-        detectNPlusOneQueriesOfMissingEntityFieldLazyFetching(entityName, id);
+        if (hibernateQueryInterceptorProperties.isnPlusOneDetectionEnabled()) {
+            detectNPlusOneQueriesOfMissingQueryEagerFetching(entityName, id);
+            detectNPlusOneQueriesOfMissingEntityFieldLazyFetching(entityName, id);
+        }
 
         Set<String> previouslyLoadedEntities = threadPreviouslyLoadedEntities.get();
 

src/main/java/com/yannbriancon/interceptor/HibernateQueryInterceptorProperties.java

@@ -18,11 +18,21 @@ enum ErrorLevel {
      */
     private ErrorLevel errorLevel = ErrorLevel.ERROR;
 
+    private boolean nPlusOneDetectionEnabled = true;
+
     public ErrorLevel getErrorLevel() {
         return errorLevel;
     }
 
     public void setErrorLevel(String errorLevel) {
         this.errorLevel = ErrorLevel.valueOf(errorLevel);
     }
+
+    public boolean isnPlusOneDetectionEnabled() {
+        return nPlusOneDetectionEnabled;
+    }
+
+    public void setnPlusOneDetectionEnabled(boolean nPlusOneDetectionEnabled) {
+        this.nPlusOneDetectionEnabled = nPlusOneDetectionEnabled;
+    }
 }

src/test/java/com/yannbriancon/interceptor/NPlusOneQueriesDisabledTest.java

@@ -0,0 +1,44 @@
+package com.yannbriancon.interceptor;
+
+import com.yannbriancon.utils.entity.Message;
+import com.yannbriancon.utils.repository.MessageRepository;
+
+import org.junit.jupiter.api.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest(properties = { "hibernate.query.interceptor.error-level=EXCEPTION", "hibernate.query.interceptor.n-plus-one-detection-enabled=false" })
+@Transactional
+class NPlusOneQueriesDisabledTest {
+
+    @Autowired
+    private MessageRepository messageRepository;
+
+    @Autowired
+    private HibernateQueryInterceptor hibernateQueryInterceptor;
+
+    @Test
+    void nPlusOneQueriesDetection_whenDisabled_stillCountsQueries_doesNotThrowException() {
+        // Fetch the 2 messages without the authors
+        List<Message> messages = messageRepository.findAll();
+
+        hibernateQueryInterceptor.startQueryCount();
+
+        // Trigger N+1 queries, if this WAS enabled, it would throw an exception and fail the test.
+        messages.stream()
+            .map(message -> message.getAuthor().getName())
+            .collect(Collectors.toList());
+
+        //Assert that counting still runs when n+1 detection is disabled
+        assertThat(hibernateQueryInterceptor.getQueryCount()).isEqualTo(2);
+    }
+}