Для проверки ql-temp-table-index сделать параметр MAX_TOP параметризи…

…руемым (#1312)

* #1309 Доработана проверка ql-temp-table-index

Доработана проверка ql-temp-table-index. Параметр MAX_TOP теперь
настраиваемый.

CHANGELOG.md

@@ -31,6 +31,7 @@
 
 #### Запросы
 
+- Доработана проверка ql-temp-table-index: параметр MAX_TOP (Макс. кол-во строк в выборке) теперь настраиваемый.
 
 #### Права ролей
 

bundles/com.e1c.v8codestyle.ql/src/com/e1c/v8codestyle/ql/check/Messages.java

@@ -44,6 +44,7 @@ final class Messages
     public static String TempTableHasIndex_description;
     public static String TempTableHasIndex_Exclude_table_name_pattern;
     public static String TempTableHasIndex_New_temporary_table_should_have_indexes;
+    public static String TempTableHasIndex_Parameter_max_top;
     public static String TempTableHasIndex_title;
     public static String UsingForUpdateCheck_description;
     public static String UsingForUpdateCheck_title;

bundles/com.e1c.v8codestyle.ql/src/com/e1c/v8codestyle/ql/check/TempTableHasIndex.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2021, 1C-Soft LLC and others.
+ * Copyright (C) 2023, 1C-Soft LLC and others.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -34,6 +34,7 @@
  * This check may be enhanced in the future.
  *
  * @author Dmitriy Marmyshev
+ * @author Vadim Goncharov
  */
 public class TempTableHasIndex
     extends QlBasicDelegateCheck
@@ -43,7 +44,9 @@ public class TempTableHasIndex
 
     private static final String PARAMETER_EXCLUDE_TABLE_NAME_PATTERN = "excludeObjectNamePattern"; //$NON-NLS-1$
 
-    private static final int MAX_TOP = 1000;
+    private static final String PARAMETER_MAX_TOP = "maxTop"; //$NON-NLS-1$
+
+    private static final int MAX_TOP_DEFAULT = 1000;
 
     @Override
     public String getCheckId()
@@ -61,16 +64,20 @@ protected void configureCheck(CheckConfigurer builder)
             .issueType(IssueType.PERFORMANCE)
             .extension(new StandardCheckExtension(777, getCheckId(), CorePlugin.PLUGIN_ID))
             .delegate(QuerySchemaSelectQuery.class);
-        builder.parameter(PARAMETER_EXCLUDE_TABLE_NAME_PATTERN, String.class, StringUtils.EMPTY,
-            Messages.TempTableHasIndex_Exclude_table_name_pattern);
+        builder
+            .parameter(PARAMETER_EXCLUDE_TABLE_NAME_PATTERN, String.class, StringUtils.EMPTY,
+                Messages.TempTableHasIndex_Exclude_table_name_pattern)
+            .parameter(PARAMETER_MAX_TOP, Integer.class, Integer.toString(MAX_TOP_DEFAULT),
+                Messages.TempTableHasIndex_Parameter_max_top);
     }
 
     @Override
     protected void checkQlObject(EObject object, QueryOwner owner, IQlResultAcceptor resultAceptor,
         ICheckParameters parameters, IProgressMonitor monitor)
     {
         QuerySchemaSelectQuery selectQuery = (QuerySchemaSelectQuery)object;
-        if (selectQuery.getPlacementTable() == null || isTopLessThenThousand(selectQuery))
+        int maxTop = parameters.getInt(PARAMETER_MAX_TOP);
+        if (selectQuery.getPlacementTable() == null || isTopLessThenMaxTop(selectQuery, maxTop))
         {
             return;
         }
@@ -89,15 +96,15 @@ protected void checkQlObject(EObject object, QueryOwner owner, IQlResultAcceptor
         }
     }
 
-    private boolean isTopLessThenThousand(QuerySchemaSelectQuery selectQuery)
+    private boolean isTopLessThenMaxTop(QuerySchemaSelectQuery selectQuery, int maxTop)
     {
         if (!selectQuery.getOperators().isEmpty() && selectQuery.getOperators().get(0).getGetRecordsCount() != null)
         {
             String count = selectQuery.getOperators().get(0).getGetRecordsCount();
             try
             {
                 int top = Integer.parseInt(count);
-                return top < MAX_TOP;
+                return top < maxTop;
             }
             catch (NumberFormatException e)
             {

bundles/com.e1c.v8codestyle.ql/src/com/e1c/v8codestyle/ql/check/messages.properties

@@ -56,6 +56,8 @@ TempTableHasIndex_New_temporary_table_should_have_indexes = New temporary table
 
 TempTableHasIndex_description = Temporary table should have indexes
 
+TempTableHasIndex_Parameter_max_top = Max rows in query
+
 TempTableHasIndex_title = Temporary table should have indexes
 
 UsingForUpdateCheck_description = Check if query contains "FOR UPDATE"

bundles/com.e1c.v8codestyle.ql/src/com/e1c/v8codestyle/ql/check/messages_ru.properties

@@ -57,6 +57,8 @@ TempTableHasIndex_New_temporary_table_should_have_indexes = Новая врем
 
 TempTableHasIndex_description = Временная таблица должна содержать индексы
 
+TempTableHasIndex_Parameter_max_top = Макс. количество строк в запросе
+
 TempTableHasIndex_title = Временная таблица должна содержать индексы
 
 UsingForUpdateCheck_description = Проверка наличия конструкции "ДЛЯ ИЗМЕНЕНИЯ" в запросе

tests/com.e1c.v8codestyle.ql.itests/src/com/e1c/v8codestyle/ql/check/itests/TempTableHasIndexTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2021, 1C-Soft LLC and others.
+ * Copyright (C) 2023, 1C-Soft LLC and others.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -38,6 +38,7 @@
  * Test {@link TempTableHasIndex} class that checks selection query that put to new temporary table and has indexes.
  *
  * @author Dmitriy Marmyshev
+ * @author Vadim Goncharov
  */
 public class TempTableHasIndexTest
     extends SingleProjectReadOnlyCheckTestBase
@@ -49,11 +50,15 @@ public class TempTableHasIndexTest
 
     private static final String PARAMETER_EXCLUDE_TABLE_NAME_PATTERN = "excludeObjectNamePattern";
 
+    private static final String PARAMETER_MAX_TOP = "maxTop";
+
+    private static final int MAX_TOP_DEFAULT = 1000;
+
     private TestingCheckResultAcceptor resultAcceptor;
 
     private TestingQlResultAcceptor qlResultAcceptor;
 
-    private TestingCheckParameters emptyParameters;
+    private TestingCheckParameters defaultParameters;
 
     private TempTableHasIndex check;
 
@@ -68,7 +73,8 @@ public void setupCheck() throws Exception
     {
         resultAcceptor = new TestingCheckResultAcceptor();
         qlResultAcceptor = new TestingQlResultAcceptor();
-        emptyParameters = new TestingCheckParameters(Map.of(PARAMETER_EXCLUDE_TABLE_NAME_PATTERN, ""));
+        defaultParameters = new TestingCheckParameters(
+            Map.of(PARAMETER_EXCLUDE_TABLE_NAME_PATTERN, "", PARAMETER_MAX_TOP, MAX_TOP_DEFAULT));
         QlBasicDelegateCheck.setResultAcceptor((o, f) -> qlResultAcceptor);
         check = new TempTableHasIndex();
     }
@@ -90,13 +96,13 @@ public void testTempTableWithoutIndex() throws Exception
         EObject selectQuery = querySchema.getQueries().get(1);
         assertTrue(selectQuery instanceof QuerySchemaSelectQuery);
 
-        check.check(selectQuery, resultAcceptor, emptyParameters, new NullProgressMonitor());
+        check.check(selectQuery, resultAcceptor, defaultParameters, new NullProgressMonitor());
 
         assertTrue(qlResultAcceptor.getMarkers().isEmpty());
 
         selectQuery = querySchema.getQueries().get(0);
         assertTrue(selectQuery instanceof QuerySchemaSelectQuery);
-        check.check(selectQuery, resultAcceptor, emptyParameters, new NullProgressMonitor());
+        check.check(selectQuery, resultAcceptor, defaultParameters, new NullProgressMonitor());
 
         assertFalse(qlResultAcceptor.getMarkers().isEmpty());
 
@@ -119,16 +125,23 @@ public void testTempTableWithoutIndexWithRecordCount() throws Exception
         EObject selectQuery = querySchema.getQueries().get(1);
         assertTrue(selectQuery instanceof QuerySchemaSelectQuery);
 
-        check.check(selectQuery, resultAcceptor, emptyParameters, new NullProgressMonitor());
+        check.check(selectQuery, resultAcceptor, defaultParameters, new NullProgressMonitor());
 
         assertTrue(qlResultAcceptor.getMarkers().isEmpty());
 
         selectQuery = querySchema.getQueries().get(0);
         assertTrue(selectQuery instanceof QuerySchemaSelectQuery);
-        check.check(selectQuery, resultAcceptor, emptyParameters, new NullProgressMonitor());
+        check.check(selectQuery, resultAcceptor, defaultParameters, new NullProgressMonitor());
 
         assertFalse(qlResultAcceptor.getMarkers().isEmpty());
 
+        qlResultAcceptor.getMarkers().clear();
+        TestingCheckParameters newParameters =
+            new TestingCheckParameters(Map.of(PARAMETER_EXCLUDE_TABLE_NAME_PATTERN, "", PARAMETER_MAX_TOP, 110000));
+        check.check(selectQuery, resultAcceptor, newParameters, new NullProgressMonitor());
+
+        assertTrue(qlResultAcceptor.getMarkers().isEmpty());
+
     }
 
     @Test
@@ -147,13 +160,13 @@ public void testTempTableWithIndex() throws Exception
         EObject selectQuery = querySchema.getQueries().get(1);
         assertTrue(selectQuery instanceof QuerySchemaSelectQuery);
 
-        check.check(selectQuery, resultAcceptor, emptyParameters, new NullProgressMonitor());
+        check.check(selectQuery, resultAcceptor, defaultParameters, new NullProgressMonitor());
 
         assertTrue(qlResultAcceptor.getMarkers().isEmpty());
 
         selectQuery = querySchema.getQueries().get(0);
         assertTrue(selectQuery instanceof QuerySchemaSelectQuery);
-        check.check(selectQuery, resultAcceptor, emptyParameters, new NullProgressMonitor());
+        check.check(selectQuery, resultAcceptor, defaultParameters, new NullProgressMonitor());
 
         assertTrue(qlResultAcceptor.getMarkers().isEmpty());
     }