com.github._1c_syntax.bsl.languageserver.diagnostics.WrongHttpServiceHandlerDiagnostic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bsl-language-server Show documentation
Language Server Protocol implementation for 1C (BSL) - 1C:Enterprise 8 and OneScript languages.
There is a newer version: 0.24.0-rc.1
/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2024
 * Alexey Sosnoviy , Nikita Fedkin  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.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.utils.Ranges;
import com.github._1c_syntax.bsl.mdo.HTTPService;
import com.github._1c_syntax.bsl.mdo.children.HTTPServiceMethod;
import com.github._1c_syntax.bsl.types.ModuleType;
import org.eclipse.lsp4j.Range;

@DiagnosticMetadata(
  type = DiagnosticType.ERROR,
  severity = DiagnosticSeverity.CRITICAL,
  minutesToFix = 10,
  tags = {
    DiagnosticTag.SUSPICIOUS,
    DiagnosticTag.ERROR
  },
  scope = DiagnosticScope.BSL,
  modules = {
    ModuleType.HTTPServiceModule
  }

)
public class WrongHttpServiceHandlerDiagnostic extends AbstractDiagnostic {

  private Range diagnosticRange;

  @Override
  protected void check() {

    //todo может ли не быть модуля http-сервиса? тогда непонятно, на какой модуль вешать замечания

    diagnosticRange = documentContext.getSymbolTree().getModule().getSelectionRange();
    if (!Ranges.isEmpty(diagnosticRange)) {
      processModule();
    }
  }

  private void processModule() {
    documentContext.getMdObject()
      .filter(HTTPService.class::isInstance)
      .map(HTTPService.class::cast)
      .ifPresent(this::checkService);
  }

  private void checkService(HTTPService httpService) {
    httpService.getUrlTemplates().stream()
      .flatMap(httpServiceURLTemplate -> httpServiceURLTemplate.getMethods().stream())
      .forEach((HTTPServiceMethod service) -> {
        final var serviceName = service.getMdoReference().getMdoRef();
        if (service.getHandler().isEmpty()) {
          addMissingHandlerDiagnostic(serviceName);
          return;
        }
        checkMethod(serviceName, service.getHandler());
      });
  }

  private void checkMethod(String serviceName, String handlerName) {
    documentContext.getSymbolTree().getMethodSymbol(handlerName)
      .ifPresentOrElse(
        methodSymbol -> checkMethodParams(serviceName, handlerName, methodSymbol),
        () -> addDefaultDiagnostic(serviceName, handlerName));
  }

  private void checkMethodParams(String serviceName, String handlerName, MethodSymbol methodSymbol) {
    if (methodSymbol.getParameters().size() != 1) {
      addIncorrectHandlerDiagnostic(methodSymbol.getSubNameRange(), serviceName, handlerName);
    }
  }

  private void addDefaultDiagnostic(String serviceName, String handlerName) {
    diagnosticStorage.addDiagnostic(
      diagnosticRange,
      info.getMessage(handlerName, serviceName));
  }

  private void addMissingHandlerDiagnostic(String serviceName) {
    diagnosticStorage.addDiagnostic(
      diagnosticRange,
      info.getResourceString("missingHandler", serviceName));
  }

  private void addIncorrectHandlerDiagnostic(Range range, String serviceName, String handlerName) {
    diagnosticStorage.addDiagnostic(
      range,
      info.getResourceString("incorrectHandler", handlerName, serviceName));
  }
}