Показ прогресса иницициализации контекста

Author: nixel2007

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

@@ -0,0 +1,132 @@
+/*
+ * 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;
+
+import lombok.AllArgsConstructor;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import org.eclipse.lsp4j.ClientCapabilities;
+import org.eclipse.lsp4j.ProgressParams;
+import org.eclipse.lsp4j.WindowClientCapabilities;
+import org.eclipse.lsp4j.WorkDoneProgressBegin;
+import org.eclipse.lsp4j.WorkDoneProgressCreateParams;
+import org.eclipse.lsp4j.WorkDoneProgressEnd;
+import org.eclipse.lsp4j.WorkDoneProgressReport;
+import org.eclipse.lsp4j.jsonrpc.messages.Either;
+import org.eclipse.lsp4j.services.LanguageClient;
+import org.springframework.stereotype.Component;
+
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicInteger;
+
+@Component
+@RequiredArgsConstructor
+public class WorkDoneProgressHelper {
+
+  private final LanguageClientHolder languageClientHolder;
+  private final ClientCapabilitiesHolder clientCapabilitiesHolder;
+
+  private boolean isWorkDoneProgressSupported;
+
+  public WorkDoneProgressReporter createProgress(int size, String messagePostfix) {
+
+    isWorkDoneProgressSupported = clientCapabilitiesHolder.getCapabilities()
+      .map(ClientCapabilities::getWindow)
+      .map(WindowClientCapabilities::getWorkDoneProgress)
+      .orElse(false);
+
+    if (!isWorkDoneProgressSupported) {
+      return new WorkDoneProgressReporter("", 0, "");
+    }
+
+    var token = UUID.randomUUID().toString();
+    var createProgressParams = new WorkDoneProgressCreateParams(Either.forLeft(token));
+
+    languageClientHolder.execIfConnected(languageClient ->
+      languageClient.createProgress(createProgressParams)
+    );
+
+    return new WorkDoneProgressReporter(token, size, messagePostfix);
+  }
+
+
+  @AllArgsConstructor
+  public class WorkDoneProgressReporter {
+    private final String token;
+    @Setter
+    private int size;
+    private final String messagePostfix;
+
+    private final AtomicInteger counter = new AtomicInteger();
+
+    public void beginProgress(String title) {
+      if (!isWorkDoneProgressSupported) {
+        return;
+      }
+
+      languageClientHolder.execIfConnected((LanguageClient languageClient) -> {
+        var value = new WorkDoneProgressBegin();
+        value.setTitle(title);
+
+        var params = new ProgressParams(Either.forLeft(token), Either.forLeft(value));
+        languageClient.notifyProgress(params);
+      });
+    }
+
+    public void tick(String message, int percentage) {
+      if (!isWorkDoneProgressSupported) {
+        return;
+      }
+
+      languageClientHolder.execIfConnected((LanguageClient languageClient) -> {
+        var value = new WorkDoneProgressReport();
+        value.setMessage(message);
+        value.setCancellable(false);
+        value.setPercentage(percentage);
+
+        var params = new ProgressParams(Either.forLeft(token), Either.forLeft(value));
+        languageClient.notifyProgress(params);
+      });
+    }
+    public void tick() {
+      var currentCounter = counter.incrementAndGet();
+      var message = String.format("%d/%d%s", currentCounter, size, messagePostfix);
+      var percentage = currentCounter / size;
+
+      tick(message, percentage);
+    }
+
+    public void endProgress(String message) {
+      if (!isWorkDoneProgressSupported) {
+        return;
+      }
+
+      languageClientHolder.execIfConnected((LanguageClient languageClient) -> {
+        var value = new WorkDoneProgressEnd();
+        value.setMessage(message);
+
+        var params = new ProgressParams(Either.forLeft(token), Either.forLeft(value));
+        languageClient.notifyProgress(params);
+      });
+    }
+  }
+}

src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/AnalyzeCommand.java

@@ -45,7 +45,6 @@
 import java.nio.file.Path;
 import java.time.LocalDateTime;
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.Callable;
@@ -167,7 +166,7 @@ public Integer call() {
     var configurationPath = LanguageServerConfiguration.getCustomConfigurationRoot(configuration, srcDir);
     context.setConfigurationRoot(configurationPath);
 
-    Collection<File> files = FileUtils.listFiles(srcDir.toFile(), new String[]{"bsl", "os"}, true);
+    var files = (List<File>) FileUtils.listFiles(srcDir.toFile(), new String[]{"bsl", "os"}, true);
 
     context.populateContext(files);
 

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/ServerContext.java

@@ -21,6 +21,7 @@
  */
 package com.github._1c_syntax.bsl.languageserver.context;
 
+import com.github._1c_syntax.bsl.languageserver.WorkDoneProgressHelper;
 import com.github._1c_syntax.bsl.languageserver.utils.MdoRefBuilder;
 import com.github._1c_syntax.bsl.types.ModuleType;
 import com.github._1c_syntax.mdclasses.Configuration;
@@ -40,10 +41,10 @@
 import java.net.URI;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
-import java.util.Collection;
 import java.util.Collections;
 import java.util.EnumMap;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.ExecutionException;
@@ -55,6 +56,7 @@
 @Component
 @RequiredArgsConstructor
 public abstract class ServerContext {
+  private final WorkDoneProgressHelper workDoneProgressHelper;
   private final Map<URI, DocumentContext> documents = Collections.synchronizedMap(new HashMap<>());
   private final Lazy<Configuration> configurationMetadata = new Lazy<>(this::computeConfigurationMetadata);
   @CheckForNull
@@ -70,20 +72,31 @@ public void populateContext() {
       LOGGER.info("Can't populate server context. Configuration root is not defined.");
       return;
     }
+
+    var workDoneProgressReporter = workDoneProgressHelper.createProgress(0, "");
+    workDoneProgressReporter.beginProgress("Finding files to populate context...");
+
     LOGGER.debug("Finding files to populate context...");
-    Collection<File> files = FileUtils.listFiles(
+    var files = (List<File>) FileUtils.listFiles(
       configurationRoot.toFile(),
       new String[]{"bsl", "os"},
       true
     );
+    workDoneProgressReporter.endProgress("");
     populateContext(files);
   }
 
-  public void populateContext(Collection<File> uris) {
+  public void populateContext(List<File> uris) {
+    var workDoneProgressReporter = workDoneProgressHelper.createProgress(uris.size(), " files");
+    workDoneProgressReporter.beginProgress("Populating context...");
+
     LOGGER.debug("Populating context...");
     contextLock.writeLock().lock();
 
     uris.parallelStream().forEach((File file) -> {
+
+      workDoneProgressReporter.tick();
+
       var documentContext = getDocument(file.toURI());
       if (documentContext == null) {
         documentContext = createDocumentContext(file, 0);
@@ -93,6 +106,8 @@ public void populateContext(Collection<File> uris) {
     });
 
     contextLock.writeLock().unlock();
+
+    workDoneProgressReporter.endProgress("Context populated.");
     LOGGER.debug("Context populated.");
   }