Правило "Обработчик регламентного задания" - ГОТОВО

docs/diagnostics/ScheduledJobHandler.md

@@ -0,0 +1,31 @@
+# Обработчик регламентного задания (ScheduledJobHandler)
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Описание диагностики
+<!-- Описание диагностики заполняется вручную. Необходимо понятным языком описать смысл и схему работу -->
+К обработчикам регламентных заданий предъявляются определенные требования.
+В качестве метода регламентного задания может выступать любая экспортная процедура или функция неглобального общего серверного модуля. Если методом регламентного задания является функция, то ее возвращаемое значение игнорируется.
+
+Если регламентное задание является предопределенным, то у его обработчика не должно быть параметров.
+Если нет, тогда параметрами подобного регламентного задания могут быть любые значения, которые разрешено передавать на сервер. Параметры регламентного задания должны в точности соответствовать параметрам той процедуры или функции, которую оно вызывает.
+
+Правило проверяет следующие признаки валидности метода-обработчика регламентного задания:
+- существует и общий модуль и метод общего модуля, указанные как обработчик
+- общий модуль является серверным
+- метод является экспортным
+- у метода нет параметров, если регламентное задание является предопределенным.
+- задано тело метода
+- нет двух и более регламентных заданий, которые ссылаются на один и тот же метод-обработчик
+
+## Примеры
+<!-- В данном разделе приводятся примеры, на которые диагностика срабатывает, а также можно привести пример, как можно исправить ситуацию -->
+
+## Источники
+<!-- Необходимо указывать ссылки на все источники, из которых почерпнута информация для создания диагностики -->
+<!-- Примеры источников
+
+* Источник: [Стандарт: Тексты модулей](https://its.1c.ru/db/v8std#content:456:hdoc)
+* Полезная информация: [Отказ от использования модальных окон](https://its.1c.ru/db/metod8dev#content:5272:hdoc)
+* Источник: [Cognitive complexity, ver. 1.4](https://www.sonarsource.com/docs/CognitiveComplexity.pdf) -->
+- [Набор статей "Регламентные задания" - стандарт 1С ](https://its.1c.ru/db/v8std#browse:13:-1:1:6)
+- [Статья "Регламентные задания" из руководства разработчика 1С 8.3](https://its.1c.ru/db/v8322doc#bookmark:dev:TI000000794)

docs/en/diagnostics/ScheduledJobHandler.md

@@ -0,0 +1,16 @@
+# Scheduled job handler (ScheduledJobHandler)
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Description
+<!-- Описание диагностики заполняется вручную. Необходимо понятным языком описать смысл и схему работу -->
+
+## Examples
+<!-- В данном разделе приводятся примеры, на которые диагностика срабатывает, а также можно привести пример, как можно исправить ситуацию -->
+
+## Sources
+<!-- Необходимо указывать ссылки на все источники, из которых почерпнута информация для создания диагностики -->
+<!-- Примеры источников
+
+* Источник: [Стандарт: Тексты модулей](https://its.1c.ru/db/v8std#content:456:hdoc)
+* Полезная информация: [Отказ от использования модальных окон](https://its.1c.ru/db/metod8dev#content:5272:hdoc)
+* Источник: [Cognitive complexity, ver. 1.4](https://www.sonarsource.com/docs/CognitiveComplexity.pdf) -->

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

@@ -108,18 +108,20 @@ protected void addDiagnostic(String message) {
  protected abstract void checkMetadata(AbstractMDObjectBase mdo);
 
  private void checkMetadataWithModules() {
- documentContext.getMdObject().ifPresent((AbstractMDObjectBase mdo) -> {
- if (mdo instanceof AbstractMDObjectBSL) {
- var modules = ((AbstractMDObjectBSL) mdo).getModules().stream()
- .filter(mdoModule -> OBJECT_MODULES.contains(mdoModule.getModuleType()))
- .collect(Collectors.toList());
-
- // чтобы не анализировать несколько раз, выберем только один модуль, например модуль менеджера
- if (modules.size() == 1 || documentContext.getModuleType() == ModuleType.ManagerModule) {
- checkMetadata(mdo);
- }
- }
- });
+ documentContext.getMdObject()
+ .filter(mdo -> filterMdoTypes.contains(mdo.getMdoType()))
+ .filter(AbstractMDObjectBSL.class::isInstance)
+ .filter(this::haveMatchingModule)
+ .ifPresent(this::checkMetadata);
+ }
+
+ private boolean haveMatchingModule(AbstractMDObjectBase mdo) {
+ var modules = ((AbstractMDObjectBSL) mdo).getModules().stream()
+ .filter(mdoModule -> OBJECT_MODULES.contains(mdoModule.getModuleType()))
+ .collect(Collectors.toList());
+
+ // чтобы не анализировать несколько раз, выберем только один модуль, например модуль менеджера
+ return modules.size() == 1 || documentContext.getModuleType() == ModuleType.ManagerModule;
  }
 
  /**

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

@@ -0,0 +1,179 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2022
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Fedkin <nixel2007@gmail.com> 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.context.DocumentContext;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticScope;
+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.references.ReferenceIndex;
+import com.github._1c_syntax.bsl.types.MDOType;
+import com.github._1c_syntax.bsl.types.ModuleType;
+import com.github._1c_syntax.mdclasses.mdo.AbstractMDObjectBase;
+import com.github._1c_syntax.mdclasses.mdo.MDCommonModule;
+import com.github._1c_syntax.mdclasses.mdo.MDScheduledJob;
+
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+@DiagnosticMetadata(
+ type = DiagnosticType.ERROR,
+ severity = DiagnosticSeverity.CRITICAL,
+ minutesToFix = 5,
+ tags = {
+ DiagnosticTag.ERROR
+ },
+ scope = DiagnosticScope.BSL
+)
+
+public class ScheduledJobHandlerDiagnostic extends AbstractMetadataDiagnostic {
+
+ private static final String DIAGNOSTIC_MESSAGE = "diagnosticMessage";
+ private static final String MISSING_MODULE_MESSAGE = "missingModule";
+ private static final String NON_SERVER_MODULE_MESSAGE = "nonServerModule";
+ private static final String NON_EXPORT_METHOD_MESSAGE = "nonExportMethod";
+ private static final String METHOD_WITH_PARAMETERS_MESSAGE = "methodWithParameters";
+ private static final String EMPTY_METHOD_MESSAGE = "emptyMethod";
+ private static final String DOUBLE_MESSAGE = "doubleMessage";
+
+ private final ReferenceIndex referenceIndex;
+ private final Map<String, List<MDScheduledJob>> scheduledJobHandlers = new HashMap<>();
+
+ private static String getFullName(MDCommonModule mdCommonModule, String methodName) {
+ return getFullName(mdCommonModule.getName(), methodName);
+ }
+
+ private static String getFullName(String commonModuleName, String methodName) {
+ return commonModuleName.concat(".").concat(methodName);
+ }
+
+ public ScheduledJobHandlerDiagnostic(ReferenceIndex referenceIndex) {
+ super(List.of(MDOType.SCHEDULED_JOB));
+ this.referenceIndex = referenceIndex;
+ }
+
+ @Override
+ protected void check() {
+ super.check();
+ checkHandlerDoubles();
+ }
+
+ private void checkHandlerDoubles() {
+ scheduledJobHandlers.values().stream()
+ .filter(mdScheduledJobs -> mdScheduledJobs.size() > 1)
+ .map((List<MDScheduledJob> mdScheduledJobs) -> {
+ mdScheduledJobs.sort(Comparator.comparing(AbstractMDObjectBase::getName));
+ return mdScheduledJobs;
+ })
+ .forEach(this::fireIssueForDoubles);
+ scheduledJobHandlers.clear();
+ }
+
+ private void fireIssueForDoubles(List<MDScheduledJob> mdScheduledJobs) {
+ final var scheduleJobNames = mdScheduledJobs.stream()
+ .map(AbstractMDObjectBase::getName)
+ .reduce((s, s2) -> s.concat(", ").concat(s2))
+ .orElseThrow();
+ final var mdScheduledJob = mdScheduledJobs.get(0).getHandler();
+ final var methodPath = getFullName(mdScheduledJob.getModuleName(), mdScheduledJob.getMethodName());
+
+ addDiagnostic(info.getResourceString(DOUBLE_MESSAGE, methodPath, scheduleJobNames));
+ }
+
+ @Override
+ protected void checkMetadata(AbstractMDObjectBase mdo) {
+ final var scheduleJob = (MDScheduledJob) mdo;
+ final var handler = scheduleJob.getHandler();
+ if (handler.isEmpty()) {
+ addDiagnostic(scheduleJob);
+ return;
+ }
+
+ final var moduleName = handler.getModuleName();
+
+ final var commonModuleOptional =
+ documentContext.getServerContext().getConfiguration().getCommonModule(moduleName);
+ if (commonModuleOptional.isEmpty()) {
+ addDiagnostic(MISSING_MODULE_MESSAGE, scheduleJob, moduleName);
+ return;
+ }
+ final var mdCommonModule = commonModuleOptional.orElseThrow();
+ if (!mdCommonModule.isServer()) {
+ addDiagnostic(NON_SERVER_MODULE_MESSAGE, scheduleJob, moduleName);
+ return;
+ }
+ checkMethod(scheduleJob, mdCommonModule, handler.getMethodName());
+ }
+
+ private void checkMethod(MDScheduledJob scheduleJob, MDCommonModule mdCommonModule, String methodName) {
+ final var fullName = getFullName(mdCommonModule, methodName);
+ scheduledJobHandlers.computeIfAbsent(fullName, k -> new ArrayList<>()).add(scheduleJob);
+
+ documentContext.getServerContext().getDocument(
+ mdCommonModule.getMdoReference().getMdoRef(), ModuleType.CommonModule)
+ .ifPresent((DocumentContext commonModuleContext) -> {
+ var method = commonModuleContext.getSymbolTree().getMethods().stream()
+ .filter(methodSymbol -> methodSymbol.getName().equalsIgnoreCase(methodName))
+ .findFirst();
+ if (method.isEmpty()) {
+ addDiagnostic(DIAGNOSTIC_MESSAGE, scheduleJob, fullName);
+ return;
+ }
+ method.ifPresent((MethodSymbol methodSymbol) -> checkMethod(scheduleJob, fullName, methodSymbol));
+ });
+ }
+
+ private void checkMethod(MDScheduledJob scheduleJob, String fullName, MethodSymbol methodSymbol) {
+ if (!methodSymbol.isExport()) {
+ addDiagnostic(NON_EXPORT_METHOD_MESSAGE, scheduleJob, fullName);
+ }
+ if (scheduleJob.isPredefined() && !methodSymbol.getParameters().isEmpty()) {
+ addDiagnostic(METHOD_WITH_PARAMETERS_MESSAGE, scheduleJob, fullName);
+ }
+ if (isEmptyMethodBody(methodSymbol)) {
+ addDiagnostic(EMPTY_METHOD_MESSAGE, scheduleJob, fullName);
+ }
+ }
+
+ private boolean isEmptyMethodBody(MethodSymbol methodSymbol) {
+ // В методе регламентного задания точно будут или переменные или вызов внешнего метода.
+ // Если их нет, значит, метод пустой
+ if (!methodSymbol.getChildren().isEmpty()) {
+ return false;
+ }
+ return referenceIndex.getReferencesFrom(methodSymbol).isEmpty();
+ }
+
+ private void addDiagnostic(String messageString, MDScheduledJob scheduleJob, String text) {
+ addDiagnostic(info.getResourceString(messageString, text, scheduleJob.getName()));
+ }
+
+ private void addDiagnostic(MDScheduledJob scheduleJob) {
+ addDiagnostic(info.getMessage("", scheduleJob.getName()));
+ }
+}

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json

@@ -1540,6 +1540,16 @@
  "title": "Same metadata object and child name",
  "$id": "#/definitions/SameMetadataObjectAndChildNames"
  },
+ "ScheduledJobHandler": {
+ "description": "Scheduled job handler",
+ "default": true,
+ "type": [
+ "boolean",
+ "object"
+ ],
+ "title": "Scheduled job handler",
+ "$id": "#/definitions/ScheduledJobHandler"
+ },
  "SelectTopWithoutOrderBy": {
  "description": "Using 'SELECT TOP' without 'ORDER BY'",
  "default": true,

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ScheduledJobHandlerDiagnostic_en.properties

@@ -0,0 +1,9 @@
+diagnosticMessage=Укажите существующий обработчик вместо несуществующего "%s" у регламентного задания "%s"
+diagnosticName=Scheduled job handler
+
+missingModule=Создайте общий модуль "%s" или исправьте некорректный обработчик регламентного задания "%s"
+nonServerModule=Установите флаг "Сервер" общему модулю "%s" или исправьте некорректный обработчик регламентного задания "%s"
+nonExportMethod=Добавьте "Экспорт" методу "%s" или исправьте некорректный обработчик регламентного задания "%s"
+methodWithParameters=Исправьте некорректный обработчик "%s" предопределенного регламентного задания "%s" - у метода не должно быть параметров
+emptyMethod=Добавьте код в тело обработчика "%s" регламентного задания "%s"
+doubleMessage=Исправьте дубли использования одного обработчика "%s" в разных регламентных заданиях. Задания: "%s"

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ScheduledJobHandlerDiagnostic_ru.properties

@@ -0,0 +1,9 @@
+diagnosticMessage=Укажите существующий обработчик вместо несуществующего "%s" у регламентного задания "%s"
+diagnosticName=Обработчик регламентного задания
+
+missingModule=Создайте общий модуль "%s" или исправьте некорректный обработчик регламентного задания "%s"
+nonServerModule=Установите флаг "Сервер" общему модулю "%s" или исправьте некорректный обработчик регламентного задания "%s"
+nonExportMethod=Добавьте "Экспорт" методу "%s" или исправьте некорректный обработчик регламентного задания "%s"
+methodWithParameters=Исправьте некорректный обработчик "%s" предопределенного регламентного задания "%s" - у метода не должно быть параметров
+emptyMethod=Добавьте код в тело обработчика "%s" регламентного задания "%s"
+doubleMessage=Исправьте дубли использования одного обработчика "%s" в разных регламентных заданиях. Задания: "%s"