Merge pull request #17 from yannbriancon/version-2.0.0

Version 2.0.0

Author: yannbriancon

CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0]
+### Added
+- Make autocomplete work for N+1 queries detection properties.
+- Add more precise detection to
+    - Avoid false positive with multiple calls to same method
+    - Detect undetected N+1 queries caused by eager fetching
+- Add a new method to clear Hibernate session state and avoid missed detection because of test setup 
+- Add new property to enable or disable N+1 queries detection
+
+### Changed
+- Rename N+1 queries detection properties.
+
+### Removed
+- Remove unused application properties
+
 ## [1.0.3] - 2020-05-10
 ### Added
 - Add back a more specific detection of N+1 queries due to missing lazy fetching.

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Update the [CHANGELOG][changelog-url] Unreleased section with details of all the changes you made
+2. Update the [README][readme-url] with important changes you made, this includes new environment 
+   variables, new feature or changes to the current features.
+3. You may merge the Pull Request once you have the sign-off of one of the maintainer, or if you 
+   do not have permission to do that, you may request the reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
+[changelog-url]: https://github.com/yannbriancon/spring-hibernate-query-utils/blob/master/CHANGELOG
+[readme-url]: https://github.com/yannbriancon/spring-hibernate-query-utils/blob/master/README

README.md

@@ -43,7 +43,10 @@
 * [Usage](#usage)
   * [N+1 Queries Detection](#n1-queries-detection)
     * [Detection](#detection)
+      * [Detection in test with fixtures](#detection-in-test-with-fixtures)
     * [Configuration](#configuration)
+      * [Enable](#enable)
+      * [Error level](#error-level)
   * [Query Count](#query-count)
 * [Changelog](#changelog)
 * [License](#license)
@@ -82,12 +85,12 @@ This library provides several benefits:
 ### Installation
 ##### Maven
 
-Add the dependency to your project inside your `pom.xml` file
+Add the dependency to your project inside your `pom.xml` file with the right version
 ```xml
 <dependency>
     <groupId>com.yannbriancon</groupId>
     <artifactId>spring-hibernate-query-utils</artifactId>
-    <version>1.0.3</version>
+    <version>X.X.X</version>
 </dependency>
 ```
 
@@ -105,9 +108,9 @@ Each time N+1 queries are detected in a transaction, a log of level error will b
 
 Two types of N+1 queries are detected:
 
-- N+1 queries caused by a field needed but not eager fetched on a specific query
+- N+1 queries triggered on a getter caused by a field needed but not eager fetched on a specific query
 
-- N+1 queries caused by an entity field not configured to be fetched lazily
+- N+1 queries triggered on a query caused by an entity field not configured to be fetched lazily
 
 Here is an example catching the error log for the first type of N+1 queries:
 
@@ -146,27 +149,71 @@ class NPlusOneQueriesLoggingTest {
 
         LoggingEvent loggingEvent = loggingEventCaptor.getAllValues().get(0);
         assertThat(loggingEvent.getMessage())
-                .isEqualTo("N+1 queries detected on a getter of the entity com.yannbriancon.utils.entity.User\n" +
+                .contains("N+1 queries detected on a getter of the entity com.yannbriancon.utils.entity.User\n" +
                         "    at com.yannbriancon.interceptor.NPlusOneQueriesLoggingTest." +
-                        "lambda$hibernateQueryInterceptor_isDetectingNPlusOneQueriesWhenMissingEagerFetchingOnQuery$0" +
-                        "(NPlusOneQueriesLoggingTest.java:61)\n" +
-                        "    Hint: Missing Eager fetching configuration on the query that fetched the object of type" +
-                        " com.yannbriancon.utils.entity.User\n");
+                        "lambda$hibernateQueryInterceptor_isDetectingNPlusOneQueriesWhenMissingEagerFetchingOnQuery$0");
         assertThat(Level.ERROR).isEqualTo(loggingEvent.getLevel());
     }
 }
 ```
 
+##### Detection in test with fixtures
+
+If a setup is present in your test to add the data necessary for testing, Hibernate will load all the data in its 
+state. This will hide potential N+1 queries in the method you test.
+
+To avoid this, a method is available to clear the Hibernate state and the N+1 queries detection state.
+
+Here is an example:
+
+```java
+@Test
+void nPlusOneQueriesDetection_throwsExceptionWhenSessionIsCleared() {
+    User author = new User("author");
+    userRepository.saveAndFlush(author);
+    Message newMessage = new Message("text", author);
+    messageRepository.saveAndFlush(newMessage);
+
+    // Test a method that should return a N+1 query
+    // The method does not return an exception because we just created the message so it is loaded in the Session
+    getMessageAuthorNameWithNPlusOneQuery(newMessage.getId());
+
+    // Clear the session to be able to correctly detect the N+1 queries in the tests
+    hibernateQueryInterceptor.clearNPlusOneQuerySession(entityManager);
+
+    try {
+        // Test a method that should return a N+1 query
+        // This time the Session is empty and the N+1 query is detected
+        getMessageAuthorNameWithNPlusOneQuery(newMessage.getId());
+        assert false;
+    } catch (NPlusOneQueriesException exception) {
+        assertThat(exception.getMessage())
+                .contains("N+1 queries detected on a getter of the entity com.yannbriancon.utils.entity.User\n" +
+                        "    at com.yannbriancon.interceptor.NPlusOneQueriesExceptionTest" +
+                        ".getMessageAuthorNameWithNPlusOneQuery");
+    }
+}
+```
+
 #### Configuration
 
+##### Enable
+
+By default the detection of N+1 queries is enabled for every profile.
+
+To disable it, you can set the property `spring-hibernate-query-utils.n-plus-one-queries-detection.error-level` to false.
+
+
+##### Error level
+
 By default the detection of N+1 queries logs an error to avoid breaking your code. 
 
 However, my advice is to override the default error level to throw exceptions for your test profile. 
 
 Now you will easily detect which tests are failing and be able to flag them and set the error level to error logs only on 
 those tests while you are fixing them.
 
-To do this, you can configure the error level when N+1 queries is detected using the property `hibernate.query.interceptor.error-level`. 
+To do this, you can configure the error level when N+1 queries is detected using the property `spring-hibernate-query-utils.n-plus-one-queries-detection.error-level`. 
 
 4 levels are available to handle the detection of N+1 queries:
 
@@ -237,6 +284,11 @@ public class NotificationResourceIntTest {
 
 See [`CHANGELOG`][changelog-url] for more information.
 
+<!-- CONTRIBUTING -->
+## Contributing
+
+See [`CONTRIBUTING`][contributing] for more information.
+
 
 <!-- LICENSE -->
 ## License
@@ -266,3 +318,4 @@ Project Link: [https://github.com/yannbriancon/spring-hibernate-query-utils](htt
 [license-shield]: https://img.shields.io/github/license/yannbriancon/spring-hibernate-query-utils.svg?style=flat-square
 [license-url]: https://github.com/yannbriancon/spring-hibernate-query-utils/blob/master/LICENSE
 [changelog-url]: https://github.com/yannbriancon/spring-hibernate-query-utils/blob/master/CHANGELOG
+[contributing]: https://github.com/yannbriancon/spring-hibernate-query-utils/blob/master/CONTRIBUTING

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>com.yannbriancon</groupId>
     <artifactId>spring-hibernate-query-utils</artifactId>
-    <version>1.0.3</version>
+    <version>2.0.0</version>
     <packaging>jar</packaging>
 
     <name>spring-hibernate-query-utils</name>

src/main/java/com/yannbriancon/config/NPlusOneQueriesDetectionProperties.java

@@ -0,0 +1,41 @@
+package com.yannbriancon.config;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+import java.io.Serializable;
+
+@ConfigurationProperties("spring-hibernate-query-utils.n-plus-one-queries-detection")
+public class NPlusOneQueriesDetectionProperties implements Serializable {
+    public enum ErrorLevel {
+        INFO,
+        WARN,
+        ERROR,
+        EXCEPTION
+    }
+
+    /**
+     * Error level for the N+1 queries detection
+     */
+    private ErrorLevel errorLevel = ErrorLevel.valueOf("ERROR");
+
+    /**
+     * Boolean allowing to enable or disable the N+1 queries detection
+     */
+    private boolean enabled = true;
+
+    public ErrorLevel getErrorLevel() {
+        return errorLevel;
+    }
+
+    public void setErrorLevel(ErrorLevel errorLevel) {
+        this.errorLevel = errorLevel;
+    }
+
+    public boolean isEnabled() {
+        return enabled;
+    }
+
+    public void setEnabled(boolean enabled) {
+        this.enabled = enabled;
+    }
+}

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

@@ -1,5 +1,6 @@
 package com.yannbriancon.interceptor;
 
+import com.yannbriancon.config.NPlusOneQueriesDetectionProperties;
 import com.yannbriancon.exception.NPlusOneQueriesException;
 import org.hibernate.EmptyInterceptor;
 import org.hibernate.Transaction;
@@ -18,7 +19,7 @@
 import java.util.function.Supplier;
 
 @Component
-@EnableConfigurationProperties(HibernateQueryInterceptorProperties.class)
+@EnableConfigurationProperties(NPlusOneQueriesDetectionProperties.class)
 public class HibernateQueryInterceptor extends EmptyInterceptor {
 
     private transient ThreadLocal<Long> threadQueryCount = new ThreadLocal<>();
@@ -31,15 +32,15 @@ public class HibernateQueryInterceptor extends EmptyInterceptor {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(HibernateQueryInterceptor.class);
 
-    private final HibernateQueryInterceptorProperties hibernateQueryInterceptorProperties;
+    private final NPlusOneQueriesDetectionProperties NPlusOneQueriesDetectionProperties;
 
     private static final String HIBERNATE_PROXY_PREFIX = "org.hibernate.proxy";
     private static final String PROXY_METHOD_PREFIX = "com.sun.proxy";
 
     public HibernateQueryInterceptor(
-            HibernateQueryInterceptorProperties hibernateQueryInterceptorProperties
+            NPlusOneQueriesDetectionProperties NPlusOneQueriesDetectionProperties
     ) {
-        this.hibernateQueryInterceptorProperties = hibernateQueryInterceptorProperties;
+        this.NPlusOneQueriesDetectionProperties = NPlusOneQueriesDetectionProperties;
     }
 
     /**
@@ -85,7 +86,7 @@ public Long getQueryCount() {
      */
     @Override
     public String onPrepareStatement(String sql) {
-        if (hibernateQueryInterceptorProperties.isnPlusOneDetectionEnabled()) {
+        if (NPlusOneQueriesDetectionProperties.isEnabled()) {
             updateSelectQueriesInfoPerProxyMethod(sql);
         }
         Long count = threadQueryCount.get();
@@ -114,7 +115,7 @@ public void afterTransactionCompletion(Transaction tx) {
      */
     @Override
     public Object getEntity(String entityName, Serializable id) {
-        if (hibernateQueryInterceptorProperties.isnPlusOneDetectionEnabled()) {
+        if (NPlusOneQueriesDetectionProperties.isEnabled()) {
             detectNPlusOneQueriesFromMissingEagerFetchingOnAQuery(entityName, id);
             detectNPlusOneQueriesFromClassFieldEagerFetching(entityName);
         }
@@ -278,7 +279,7 @@ private Optional<String> getProxyMethodName() {
      * @param errorMessage Error message for the N+1 queries detected
      */
     private void logDetectedNPlusOneQueries(String errorMessage) {
-        switch (hibernateQueryInterceptorProperties.getErrorLevel()) {
+        switch (NPlusOneQueriesDetectionProperties.getErrorLevel()) {
             case INFO:
                 LOGGER.info(errorMessage);
                 break;
@@ -288,8 +289,10 @@ private void logDetectedNPlusOneQueries(String errorMessage) {
             case ERROR:
                 LOGGER.error(errorMessage);
                 break;
-            default:
+            case EXCEPTION:
                 throw new NPlusOneQueriesException(errorMessage);
+            default:
+                break;
         }
     }
 }