AnalyzeSql annotation: in case of N+1 select suspicion, the JDBC roundtrip message is now displayed after the N+1 select message

Author: jeanbisutti

sql/sql-annotations/src/main/java/org/quickperf/sql/analyze/SqlReport.java

@@ -16,6 +16,7 @@
 import org.quickperf.sql.SqlExecutions;
 import org.quickperf.sql.bindparams.AllParametersAreBoundExtractor;
 import org.quickperf.sql.execution.SqlAnalysis;
+import org.quickperf.sql.framework.JdbcSuggestion;
 import org.quickperf.sql.like.ContainsLikeWithLeadingWildcardExtractor;
 import org.quickperf.sql.select.analysis.SelectAnalysis;
 import org.quickperf.time.ExecutionTime;
@@ -77,8 +78,12 @@ private int numberOf(SqlExecutions sqlExecutions, QueryType queryType) {
 
     private String buildNPlusOneMessage(SqlAnalysis sqlAnalysis) {
         if (sqlAnalysis.getSelectAnalysis().getSameSelectTypesWithDifferentParamValues().evaluate()) {
-          return this.addSeparationString() + ALERT_MESSAGE
-                    + sqlAnalysis.getSelectAnalysis().getSameSelectTypesWithDifferentParamValues().getSuggestionToFixIt()
+            SelectAnalysis.SameSelectTypesWithDifferentParamValues sameSelectTypesWithDifferentParamValues = sqlAnalysis.getSelectAnalysis().getSameSelectTypesWithDifferentParamValues();
+            return addSeparationString() + ALERT_MESSAGE
+                    + SelectAnalysis.getNPlusOneFrameworkMessage()
+                    + System.lineSeparator()
+                    + System.lineSeparator()
+                    + JdbcSuggestion.SERVER_ROUND_TRIPS.getMessage()
                     + System.lineSeparator()
                     + System.lineSeparator();
         }

sql/sql-annotations/src/main/java/org/quickperf/sql/select/MaxOfSelectsPerfIssueVerifier.java

@@ -47,7 +47,7 @@ private PerfIssue buildPerfIssue(Count measuredCount, Count expectedCount, Selec
                                                                     , "select");
 
         if (measuredCount.isGreaterThan(Count.ONE) && !selectAnalysis.hasOnlySameSelects()) {
-            description += SelectAnalysis.getSuggestionToFIxNPlusOneSelect();
+            description += SelectAnalysis.getNPlusOneSelectAlert();
         }
 
         return new PerfIssue(description);

sql/sql-annotations/src/main/java/org/quickperf/sql/select/SelectNumberPerfIssueVerifier.java

@@ -46,7 +46,7 @@ private PerfIssue buildPerfIssue(Count executedSelectNumber, Count expectedSelec
            && executedSelectNumber.isGreaterThan(expectedSelectNumber)
            && !selectAnalysis.hasOnlySameSelects()
           ) {
-            description += SelectAnalysis.getSuggestionToFIxNPlusOneSelect();
+            description += SelectAnalysis.getNPlusOneSelectAlert();
         }
 
         return new PerfIssue(description);

sql/sql-annotations/src/main/java/org/quickperf/sql/select/analysis/SelectAnalysis.java

@@ -20,6 +20,8 @@
 import org.quickperf.unit.Count;
 import org.quickperf.unit.NoUnit;
 
+import static java.lang.System.*;
+
 public class SelectAnalysis implements PerfMeasure {
 
     private final Count selectNumber;
@@ -41,33 +43,32 @@ public boolean evaluate() {
         }
 
         public String getSuggestionToFixIt() {
-            return getSuggestionToFIxNPlusOneSelect();
+            return getNPlusOneSelectAlert();
         }
 
     }
 
-    public static String getSuggestionToFIxNPlusOneSelect() {
+    public static String getNPlusOneSelectAlert() {
 
         if(SystemProperties.SIMPLIFIED_SQL_DISPLAY.evaluate()) {
             return "";
         }
 
-        String suggestion =  System.lineSeparator()
-                           + System.lineSeparator()
-                           + JdbcSuggestion.SERVER_ROUND_TRIPS.getMessage();
+        return lineSeparator()
+             + lineSeparator()
+             + JdbcSuggestion.SERVER_ROUND_TRIPS.getMessage()
+             + getNPlusOneFrameworkMessage();
+
+    }
 
+    public static String getNPlusOneFrameworkMessage() {
         if(ClassPath.INSTANCE.containsHibernate()) {
-            suggestion += System.lineSeparator()
-                        + HibernateSuggestion.N_PLUS_ONE_SELECT.getMessage();
+            return lineSeparator() + HibernateSuggestion.N_PLUS_ONE_SELECT.getMessage();
         }
-
         if(ClassPath.INSTANCE.containsMicronautData()) {
-            suggestion += System.lineSeparator()
-                        + MicronautSuggestion.N_PLUS_ONE_SELECT.getMessage();
+            return lineSeparator() + MicronautSuggestion.N_PLUS_ONE_SELECT.getMessage();
         }
-
-        return suggestion;
-
+        return "";
     }
 
     public SelectAnalysis(int selectNumber

sql/sql-memory-test/src/test/java/AnalyzeSqlTest.java

@@ -28,6 +28,7 @@
 import java.nio.file.Paths;
 import java.util.stream.Collectors;
 
+import static java.lang.System.*;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.experimental.results.PrintableResult.testResult;
 
@@ -51,7 +52,7 @@ private static String findTargetPath() {
 
     private static String getFileContent(String filePath) throws IOException {
         return Files.lines(Paths.get(filePath))
-                    .collect(Collectors.joining(System.lineSeparator()));
+                    .collect(Collectors.joining(lineSeparator()));
     }
 
     @RunWith(QuickPerfJUnitRunner.class)
@@ -423,8 +424,17 @@ public void execute_two_same_select_types_with_two_diff_param_values() {
         // THEN
         assertThat(printableResult.failureCount()).isZero();
         assertThat(getFileContent(DETECT_N_PLUS_ONE))
-                .contains("JDBC roundtrips")
-                .contains("N+1");
+                .contains("N+1")
+                // The JDBC roundtrip message has to be displayed after the N+1 select message
+                // , just before displaying the queries in this test case.
+                .contains("You may have even more select statements with production data." + lineSeparator()
+                        + "Be careful with the cost of JDBC roundtrips: https://blog.jooq.org/2017/12/18/the-cost-of-jdbc-server-roundtrips/"
+                        + lineSeparator()
+                        + lineSeparator()
+                        + "                                            * * * * *"
+                        + lineSeparator()
+                        + "QUERIES"
+                    );
 
     }
 
@@ -506,4 +516,5 @@ public void should_alert_if_no_bind_parameters_where_found() throws IOException
                 .contains("Query without bind parameters");
 
     }
+
 }