WIP Add diagnostic for AttachIdleHandler

docs/diagnostics/AttachIdleHandler.md

@@ -0,0 +1,59 @@
+# Использование метода ПодключитьОбработчикОжидания (AttachIdleHandler)
+
+| Тип | Поддерживаются<br/>языки | Важность | Включена<br/>по умолчанию | Время на<br/>исправление (мин) | Тэги |
+| :-: | :-: | :-: | :-: | :-: | :-: |
+| `Ошибка` | `BSL`<br/>`OS` | `Информационный` | `Да` | `1` | `error`<br/>`unpredictable` |
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Описание диагностики
+Подключение или отключение обработчика ожидания с указанием несуществующего метода
+
+## Примеры
+Неправильно
+
+```Bsl
+
+&НаКлиенте
+Процедура НайтиСтрокуСОшибкой(Команда)
+
+    ПодключитьОбработчикОжидания("НеизвестныйМетод", 0.1, Истина);
+
+КонецПроцедуры
+
+```
+
+Правильно
+
+```Bsl
+&НаКлиенте
+Процедура НайтиСтроку(Команда)
+
+    ПодключитьОбработчикОжидания("ВыполнитьПоиск", 0.1, Истина);
+
+КонецПроцедуры
+
+&НаКлиенте
+Процедура ВыполнитьПоиск()
+
+КонецПроцедуры
+
+```
+## Источники
+
+* Полезная информация: [Отложенная обработка события элемента управления в форме](https://its.1c.ru/db/metod8dev/content/1820/hdoc)
+
+## Сниппеты
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Экранирование кода
+
+```bsl
+// BSLLS:AttachIdleHandler-off
+// BSLLS:AttachIdleHandler-on
+```
+
+### Параметр конфигурационного файла
+
+```json
+"AttachIdleHandler": false
+```

docs/diagnostics/index.md

@@ -8,15 +8,16 @@
 
 ## Список реализованных диагностик
 
-Общее количество: **113**
+Общее количество: **114**
 
 * Дефект кода: **71**
 * Уязвимость: **3**
-* Ошибка: **35**
+* Ошибка: **36**
 * Потенциальная уязвимость: **4**
 
 | Ключ | Название | Включена по умолчанию | Важность | Тип | Тэги |
 | --- | --- | :-: | --- | --- | --- |
+| [AttachIdleHandler](AttachIdleHandler.md) | Использование метода ПодключитьОбработчикОжидания | Да | Информационный | Ошибка | `error`<br/>`unpredictable` |
 | [BeginTransactionBeforeTryCatch](BeginTransactionBeforeTryCatch.md) | Нарушение правил работы с транзакциями для метода 'НачатьТранзакцию' | Да | Важный | Ошибка | `standard` |
 | [CachedPublic](CachedPublic.md) | Кеширование программного интерфейса | Да | Важный | Дефект кода | `standard`<br/>`design` |
 | [CanonicalSpellingKeywords](CanonicalSpellingKeywords.md) | Каноническое написание ключевых слов | Да | Информационный | Дефект кода | `standard` |

docs/en/diagnostics/AttachIdleHandler.md

@@ -0,0 +1,60 @@
+# Usage AttachIdleHandler (AttachIdleHandler)
+
+| Type | Scope | Severity | Activated<br/>by default | Minutes<br/>to fix | Tags |
+| :-: | :-: | :-: | :-: | :-: | :-: |
+| `Error` | `BSL`<br/>`OS` | `Info` | `Yes` | `1` | `error`<br/>`unpredictable` |
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Description
+Attach or detach idle handler with not existed method
+
+## Examples
+
+BAD
+
+```Bsl
+
+&НаКлиенте
+Процедура НайтиСтрокуСОшибкой(Команда)
+
+    ПодключитьОбработчикОжидания("НеизвестныйМетод", 0.1, Истина);
+
+КонецПроцедуры
+
+```
+
+GOOD
+
+```Bsl
+&НаКлиенте
+Процедура НайтиСтроку(Команда)
+
+    ПодключитьОбработчикОжидания("ВыполнитьПоиск", 0.1, Истина);
+
+КонецПроцедуры
+
+&НаКлиенте
+Процедура ВыполнитьПоиск()
+
+КонецПроцедуры
+
+```
+## Sources
+
+* Usage info: [Отложенная обработка события элемента управления в форме](https://its.1c.ru/db/metod8dev/content/1820/hdoc)
+
+## Snippets
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Diagnostic ignorance in code
+
+```bsl
+// BSLLS:AttachIdleHandler-off
+// BSLLS:AttachIdleHandler-on
+```
+
+### Parameter for config
+
+```json
+"AttachIdleHandler": false
+```

docs/en/diagnostics/index.md

@@ -8,15 +8,16 @@ To escape individual sections of code or files from triggering diagnostics, you
 
 ## Implemented diagnostics
 
-Total: **113**
+Total: **114**
 
-* Error: **35**
+* Error: **36**
 * Code smell: **71**
 * Vulnerability: **3**
 * Security Hotspot: **4**
 
 | Key | Name| Enabled by default | Severity | Type | Tags |
 | --- | --- | :-: | --- | --- | --- |
+| [AttachIdleHandler](AttachIdleHandler.md) | Usage AttachIdleHandler | Yes | Info | Error | `error`<br/>`unpredictable` |
 | [BeginTransactionBeforeTryCatch](BeginTransactionBeforeTryCatch.md) | Violating transaction rules for the 'BeginTransaction' method | Yes | Major | Error | `standard` |
 | [CachedPublic](CachedPublic.md) | Cached public methods | Yes | Major | Code smell | `standard`<br/>`design` |
 | [CanonicalSpellingKeywords](CanonicalSpellingKeywords.md) | Canonical keyword writing | Yes | Info | Code smell | `standard` |

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/AttachIdleHandlerDiagnostic.java

@@ -0,0 +1,120 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright © 2018-2020
+ * Alexey Sosnoviy <[email protected]>, Nikita Gryzlov <[email protected]> and contributors
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * BSL Language Server is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * BSL Language Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with BSL Language Server.
+ */
+package com.github._1c_syntax.bsl.languageserver.diagnostics;
+
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticInfo;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticSeverity;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticTag;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticType;
+import com.github._1c_syntax.bsl.languageserver.utils.variable.types.V8TypeHelper;
+import com.github._1c_syntax.bsl.parser.BSLParser;
+import com.github._1c_syntax.mdclasses.metadata.additional.ModuleType;
+import com.github._1c_syntax.utils.CaseInsensitivePattern;
+import org.antlr.v4.runtime.tree.ParseTree;
+
+import java.util.regex.Pattern;
+
+@DiagnosticMetadata(
+  type = DiagnosticType.ERROR,
+  severity = DiagnosticSeverity.INFO,
+  minutesToFix = 1,
+  modules = {
+    ModuleType.FormModule
+  },
+  tags = {
+    DiagnosticTag.ERROR,
+    DiagnosticTag.UNPREDICTABLE
+  }
+
+)
+public class AttachIdleHandlerDiagnostic extends AbstractVisitorDiagnostic {
+
+  private static final Pattern MESSAGE_PATTERN_ATTACH = CaseInsensitivePattern.compile(
+    "ПодключитьОбработчикОжидания|AttachIdleHandler"
+  );
+  private static final Pattern MESSAGE_PATTERN_DETACH = CaseInsensitivePattern.compile(
+    "ОтключитьОбработчикОжидания|DetachIdleHandler"
+  );
+
+  public AttachIdleHandlerDiagnostic(DiagnosticInfo info) {
+    super(info);
+  }
+
+  @Override
+  public ParseTree visitGlobalMethodCall(BSLParser.GlobalMethodCallContext ctx) {
+
+    if (checkGlobalMethodCall(ctx)) {
+      diagnosticStorage.addDiagnostic(ctx.methodName(), getMessage(ctx));
+    }
+
+    return super.visitGlobalMethodCall(ctx);
+  }
+
+  /**
+   * Получает сообщение диагностики для пользователя
+   *
+   * @param ctx контекст узла
+   * @return В случае если передан контекст метода, параметризованное сообщение,
+   * первым параметром которого <b>всегда</b> будет имя метода.
+   * В противном случае возвращается обычное сообщение без параметров.
+   */
+  protected String getMessage(BSLParser.GlobalMethodCallContext ctx) {
+    return ctx.methodName().getText();
+  }
+
+  protected boolean checkGlobalMethodCall(BSLParser.GlobalMethodCallContext ctx) {
+
+    boolean isAttachHandler = MESSAGE_PATTERN_ATTACH.matcher(ctx.methodName().getText()).matches();
+    if (!(isAttachHandler
+      || MESSAGE_PATTERN_DETACH.matcher(ctx.methodName().getText()).matches())) {
+      return false;
+    }
+
+    var callContext = ctx.doCall();
+    // Проверка на существование метода в текущем контексте без параметров
+    boolean hasError = V8TypeHelper.getStringConstantFromFirstParam(callContext)
+      .get().map(methodName -> documentContext.getSymbolTree().getMethods()
+        .stream()
+        .noneMatch(method -> method.getName().equalsIgnoreCase(methodName) && method.getParameters().size() == 0)
+      ).orElse(false);
+
+    if (!isAttachHandler) {
+      return hasError;
+    }
+
+    // Проверка что при таймауте меньше 1 секунды, третий параметр не равен Ложь
+    hasError = hasError || V8TypeHelper.getFloatNumberConstantFromParam(callContext, 1)
+      .get()
+      .filter(timeout -> timeout < 1.0f)
+      // TODO change while got context
+      .map(e -> V8TypeHelper.getBooleanConstantFromParam(callContext, 2, Boolean.FALSE)
+        // .map(e -> V8TypeHelper.get(Boolean.FALSE, (constValue) -> constValue.TRUE() != null).apply(callContext,2)
+        .get()
+        .map(be -> be.equals(Boolean.FALSE))
+        .orElse(false)
+      )
+      .orElse(false);
+    return hasError;
+  }
+}
+