Merge pull request #1671 from 1c-syntax/feature/force-close-on-parent-process-crash

Author: nixel2007

src/main/java/com/github/_1c_syntax/bsl/languageserver/ParentProcessWatcher.java

@@ -0,0 +1,77 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright © 2018-2021
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <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;
+
+import com.github._1c_syntax.bsl.languageserver.events.LanguageServerInitializeRequestReceivedEvent;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.eclipse.lsp4j.services.LanguageServer;
+import org.springframework.context.event.EventListener;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+/**
+ * Наблюдатель за жизнью родительского процесса, запустившего Language Server.
+ */
+@Component
+@Slf4j
+@RequiredArgsConstructor
+public class ParentProcessWatcher {
+
+  private final LanguageServer languageServer;
+  private long parentProcessId;
+
+  /**
+   * Обработчик события {@link LanguageServerInitializeRequestReceivedEvent}.
+   * <p>
+   * Анализирует параметры запроса и подготавливает данные для слежения за родительским процессом.
+   *
+   * @param event Событие
+   */
+  @EventListener
+  public void handleEvent(LanguageServerInitializeRequestReceivedEvent event) {
+    var processId = event.getParams().getProcessId();
+    if (processId == null) {
+      return;
+    }
+    parentProcessId = processId;
+  }
+
+  /**
+   * Фоновая процедура, отслеживающая родительский процесс.
+   */
+  @Scheduled(fixedDelay = 30000L)
+  public void watch() {
+    if (parentProcessId == 0) {
+      return;
+    }
+
+    boolean processIsAlive = ProcessHandle.of(parentProcessId)
+      .map(ProcessHandle::isAlive)
+      .orElse(false);
+
+    if (!processIsAlive) {
+      LOGGER.error("Parent process with pid {} is not found. Closing application...", parentProcessId);
+      languageServer.exit();
+    }
+  }
+}

src/main/java/com/github/_1c_syntax/bsl/languageserver/aop/EventPublisherAspect.java

@@ -25,11 +25,14 @@
 import com.github._1c_syntax.bsl.languageserver.configuration.events.LanguageServerConfigurationChangedEvent;
 import com.github._1c_syntax.bsl.languageserver.context.DocumentContext;
 import com.github._1c_syntax.bsl.languageserver.context.events.DocumentContextContentChangedEvent;
+import com.github._1c_syntax.bsl.languageserver.events.LanguageServerInitializeRequestReceivedEvent;
 import lombok.NoArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
 import org.aspectj.lang.annotation.AfterReturning;
 import org.aspectj.lang.annotation.Aspect;
+import org.eclipse.lsp4j.InitializeParams;
+import org.eclipse.lsp4j.services.LanguageServer;
 import org.springframework.context.ApplicationEvent;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.ApplicationEventPublisherAware;
@@ -71,6 +74,15 @@ public void documentContextRebuild(JoinPoint joinPoint) {
     publishEvent(new DocumentContextContentChangedEvent((DocumentContext) joinPoint.getThis()));
   }
 
+  @AfterReturning("Pointcuts.isLanguageServer() && Pointcuts.isInitializeCall() && args(initializeParams)")
+  public void languageServerInitialize(JoinPoint joinPoint, InitializeParams initializeParams) {
+    var event = new LanguageServerInitializeRequestReceivedEvent(
+      (LanguageServer) joinPoint.getThis(),
+      initializeParams
+    );
+    publishEvent(event);
+  }
+
   private void publishEvent(ApplicationEvent event) {
     if (!active) {
       LOGGER.warn("Trying to send event in not active event publisher.");

src/main/java/com/github/_1c_syntax/bsl/languageserver/aop/Pointcuts.java

@@ -26,6 +26,7 @@
 import com.github._1c_syntax.bsl.languageserver.context.ServerContext;
 import com.github._1c_syntax.bsl.languageserver.diagnostics.BSLDiagnostic;
 import org.aspectj.lang.annotation.Pointcut;
+import org.eclipse.lsp4j.services.LanguageServer;
 
 /**
  * Сборник общих Pointcut для AOP-слоя.
@@ -37,61 +38,86 @@ public class Pointcuts {
    */
   @Pointcut("within(com.github._1c_syntax.bsl.languageserver..*)")
   public void isBSLLanguageServerScope() {
+    // no-op
   }
 
   /**
    * Это обращение к классу {@link LanguageServerConfiguration}.
    */
   @Pointcut("within(com.github._1c_syntax.bsl.languageserver.configuration.LanguageServerConfiguration)")
   public void isLanguageServerConfiguration() {
+    // no-op
   }
 
   /**
    * Это обращение к классу {@link DocumentContext}.
    */
   @Pointcut("within(com.github._1c_syntax.bsl.languageserver.context.DocumentContext)")
   public void isDocumentContext() {
+    // no-op
+  }
+
+  /**
+   * Это обращение к реализации {@link LanguageServer}.
+   */
+  @Pointcut("within(org.eclipse.lsp4j.services.LanguageServer+)")
+  public void isLanguageServer() {
+    // no-op
   }
 
   /**
    * Это обращение к классу {@link ServerContext}.
    */
   @Pointcut("within(com.github._1c_syntax.bsl.languageserver.context.ServerContext)")
   public void isServerContext() {
+    // no-op
   }
 
   /**
    * Это обращение к реализации интерфейса {@link BSLDiagnostic}.
    */
   @Pointcut("within(com.github._1c_syntax.bsl.languageserver.diagnostics.BSLDiagnostic+)")
   public void isBSLDiagnostic() {
+    // no-op
   }
 
   /**
    * Это вызов метода rebuild.
    */
   @Pointcut("isBSLLanguageServerScope() && execution(* rebuild(..))")
   public void isRebuildCall() {
+    // no-op
   }
 
   /**
    * Это вызов метода update.
    */
   @Pointcut("isBSLLanguageServerScope() && execution(* update(..))")
   public void isUpdateCall() {
+    // no-op
   }
 
   /**
    * Это вызов метода reset.
    */
   @Pointcut("isBSLLanguageServerScope() && execution(* reset(..))")
   public void isResetCall() {
+    // no-op
   }
 
   /**
    * Это вызов метода getDiagnostics.
    */
   @Pointcut("isBSLLanguageServerScope() && execution(* getDiagnostics(..))")
   public void isGetDiagnosticsCall() {
+    // no-op
+  }
+
+  /**
+   * Это вызов метода initialize.
+   */
+  @Pointcut("isBSLLanguageServerScope() && execution(* initialize(..))")
+  public void isInitializeCall() {
+    // no-op
   }
 }

src/main/java/com/github/_1c_syntax/bsl/languageserver/events/LanguageServerInitializeRequestReceivedEvent.java

@@ -0,0 +1,53 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright © 2018-2021
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <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.events;
+
+import lombok.Getter;
+import org.eclipse.lsp4j.InitializeParams;
+import org.eclipse.lsp4j.services.LanguageServer;
+import org.springframework.context.ApplicationEvent;
+
+/**
+ * Описание события получения языковым сервером запроса initialize.
+ * <p>
+ * В качестве источника события содержит ссылку на {@link LanguageServer}.
+ */
+public class LanguageServerInitializeRequestReceivedEvent extends ApplicationEvent {
+
+  private static final long serialVersionUID = 7153531865051478056L;
+
+  /**
+   * Параметры вызванного запроса initialize.
+   */
+  @Getter
+  private final transient InitializeParams params;
+
+  public LanguageServerInitializeRequestReceivedEvent(LanguageServer source, InitializeParams params) {
+    super(source);
+    this.params = params;
+  }
+
+  @Override
+  public LanguageServer getSource() {
+    return (LanguageServer) super.getSource();
+  }
+}

src/main/java/com/github/_1c_syntax/bsl/languageserver/events/package-info.java

@@ -0,0 +1,28 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright © 2018-2021
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <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.
+ */
+/**
+ * События пакета com.github._1c_syntax.bsl.languageserver.
+ */
+@ParametersAreNonnullByDefault
+package com.github._1c_syntax.bsl.languageserver.events;
+
+import javax.annotation.ParametersAreNonnullByDefault;

src/test/java/com/github/_1c_syntax/bsl/languageserver/ParentProcessWatcherTest.java

@@ -0,0 +1,77 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright © 2018-2021
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <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;
+
+import com.github._1c_syntax.bsl.languageserver.events.LanguageServerInitializeRequestReceivedEvent;
+import org.eclipse.lsp4j.InitializeParams;
+import org.eclipse.lsp4j.services.LanguageServer;
+import org.junit.jupiter.api.Test;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.springframework.boot.test.context.SpringBootTest;
+
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+@SpringBootTest
+class ParentProcessWatcherTest {
+
+  @InjectMocks
+  private ParentProcessWatcher parentProcessWatcher;
+
+  @Mock
+  private LanguageServer languageServer;
+
+  @Test
+  void testParentProcessIsDead() {
+    // given
+    var params = new InitializeParams();
+    params.setProcessId(-1);
+
+    var event = new LanguageServerInitializeRequestReceivedEvent(languageServer, params);
+    parentProcessWatcher.handleEvent(event);
+
+    // when
+    parentProcessWatcher.watch();
+
+    // then
+    verify(languageServer, times(1)).exit();
+  }
+
+  @Test
+  void testParentProcessIsAlive() {
+    // given
+    var params = new InitializeParams();
+    params.setProcessId((int) ProcessHandle.current().pid());
+
+    var event = new LanguageServerInitializeRequestReceivedEvent(languageServer, params);
+    parentProcessWatcher.handleEvent(event);
+
+    // when
+    parentProcessWatcher.watch();
+
+    // then
+    verify(languageServer, never()).exit();
+  }
+
+}