Merge branch 'main' into feature/rename-refactoring/parametric

Author: PieterOlivier

.github/workflows/build.yaml

@@ -120,8 +120,9 @@ jobs:
         if: failure()
         with:
           name: screenshots-${{ matrix.os }}
-          path: ./rascal-vscode-extension/uitests/**/screenshots/*.png
+          path: ./rascal-vscode-extension/uitests/screenshots/**/*.png
           retention-days: 5
+          if-no-files-found: error
 
       - name: "cleanup before cache"
         shell: bash

CODE_OF_CONDUCT.md

@@ -36,11 +36,11 @@ We are committed to making participation in this community a harassment-free exp
 
 Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
 
-[Project Owners](/about/processes.html) have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Contributors who do not follow the Code of Conduct may be removed from the project team.
+[Project Owners](http://www.usethesource.io/about/processes.html) have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Contributors who do not follow the Code of Conduct may be removed from the project team.
 
 This code of conduct applies both within project spaces and in public spaces when an individual is representing the UseTheSource community or one of its projects.
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by [opening an issue](https://github.com/usethesource/usethesource.github.io/issues) or contacting one or more of the [Project Owners](/projects/).
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by [opening an issue](https://github.com/usethesource/usethesource.github.io/issues) or contacting one or more of the [Project Owners](http://www.usethesource.io/projects/).
 
 This Code of Conduct is adapted from the Contributor Covenant, version 1.1.0, available from <http://contributor-covenant.org/version/1/1/0/>
 

package.sh

@@ -3,4 +3,3 @@
 set -euxo pipefail
 
 (cd rascal-vscode-extension && npx vsce package )
-

rascal-lsp/META-INF/RASCAL.MF

@@ -1,2 +1,2 @@
 Project-Name: rascal-lsp
-Source: src/main/rascal
+Source: src/main/rascal/library,src/main/rascal/lsp/

rascal-lsp/pom.xml

@@ -35,7 +35,7 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <junit.version>4.13.2</junit.version>
     <maven-surefire-plugin.version>3.5.3</maven-surefire-plugin.version>
-    <log4j2.version>2.24.3</log4j2.version>
+    <log4j2.version>2.25.0</log4j2.version>
     <lsp4j.version>0.24.0</lsp4j.version>
     <sonar.organization>usethesource</sonar.organization>
     <sonar.host.url>https://sonarcloud.io</sonar.host.url>
@@ -63,7 +63,7 @@
     <dependency>
       <groupId>org.rascalmpl</groupId>
       <artifactId>rascal</artifactId>
-      <version>0.41.0-RC42</version>
+      <version>0.41.0-RC54</version>
     </dependency>
     <!-- Rascal tests require JUnit 4 -->
     <dependency>
@@ -165,12 +165,8 @@
                 <errorsAsWarnings>false</errorsAsWarnings>
                 <bin>${project.build.outputDirectory}</bin>
                 <srcs>
-                    <src>${project.basedir}/src/main/rascal</src>
+                    <src>${project.basedir}/src/main/rascal/library</src>
                 </srcs>
-                <ignores>
-                    <ignore>${project.basedir}/src/main/rascal/lang/rascal</ignore>
-                    <ignore>${project.basedir}/src/main/rascal/framework</ignore>
-                </ignores>
             </configuration>
           </execution>
           <execution>
@@ -198,7 +194,7 @@
                   <ignore>${project.basedir}/src/main/rascal/framework</ignore>
               </ignores>
             </configuration>
-          </execution> 
+          </execution>
         </executions>
       </plugin>
 
@@ -234,6 +230,13 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-shade-plugin</artifactId>
         <version>3.6.0</version>
+        <dependencies>
+          <dependency> <!-- correctly shade multiple log4j2 depencneis -->
+              <groupId>org.apache.logging.log4j</groupId>
+              <artifactId>log4j-transform-maven-shade-plugin-extensions</artifactId>
+              <version>0.2.0</version>
+          </dependency>
+        </dependencies>
         <executions>
           <execution>
             <phase>package</phase>
@@ -242,9 +245,12 @@
             </goals>
             <configuration>
               <transformers>
+                <transformer implementation="org.apache.logging.log4j.maven.plugins.shade.transformer.Log4j2PluginCacheFileTransformer"/>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                   <manifestEntries>
                     <Name>rascal-lsp</Name>
+                    <Multi-Release>true</Multi-Release>
                     <Main-Class>org.rascalmpl.vscode.lsp.RascalLanguageServer</Main-Class>
                     <Specification-Version>${project.version}</Specification-Version>
                     <Specification-Vendor>http://www.usethesource.io</Specification-Vendor>

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/BaseLanguageServer.java

@@ -51,7 +51,7 @@
 import org.eclipse.lsp4j.InitializeResult;
 import org.eclipse.lsp4j.ServerCapabilities;
 import org.eclipse.lsp4j.SetTraceParams;
-import org.eclipse.lsp4j.WorkspaceFolder;
+import org.eclipse.lsp4j.WorkDoneProgressCancelParams;
 import org.eclipse.lsp4j.jsonrpc.Launcher;
 import org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two;
 import org.eclipse.lsp4j.services.LanguageClient;
@@ -67,8 +67,6 @@
 import org.rascalmpl.uri.URIUtil;
 import org.rascalmpl.values.IRascalValueFactory;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.LanguageParameter;
-import org.rascalmpl.vscode.lsp.uri.ProjectURIResolver;
-import org.rascalmpl.vscode.lsp.uri.TargetURIResolver;
 import org.rascalmpl.vscode.lsp.uri.jsonrpc.impl.VSCodeVFSClient;
 import org.rascalmpl.vscode.lsp.uri.jsonrpc.messages.PathConfigParameter;
 import org.rascalmpl.vscode.lsp.uri.jsonrpc.messages.VFSRegister;
@@ -90,6 +88,7 @@ public abstract class BaseLanguageServer {
     private static final @Nullable PrintStream capturedOut;
     private static final @Nullable InputStream capturedIn;
     private static final boolean DEPLOY_MODE;
+    private static final String LOG_CONFIGURATION_KEY = "log4j2.configurationFactory";
 
     static {
         DEPLOY_MODE = System.getProperty("rascal.lsp.deploy", "false").equalsIgnoreCase("true");
@@ -105,6 +104,8 @@ public abstract class BaseLanguageServer {
             capturedOut = null;
         }
         System.setProperty("java.util.logging.manager", "org.apache.logging.log4j.jul.LogManager");
+        // Do not overwrite existing settings (e.g. passed by the extension)
+        System.setProperty(LOG_CONFIGURATION_KEY, System.getProperty(LOG_CONFIGURATION_KEY, LogRedirectConfiguration.class.getName()));
     }
 
     // hide implicit constructor
@@ -223,25 +224,6 @@ private ActualLanguageServer(Runnable onExit, IBaseTextDocumentService lspDocume
             this.onExit = onExit;
             this.lspDocumentService = lspDocumentService;
             this.lspWorkspaceService = lspWorkspaceService;
-            reg.registerLogical(new ProjectURIResolver(this::resolveProjectLocation));
-            reg.registerLogical(new TargetURIResolver(this::resolveProjectLocation));
-        }
-
-        private ISourceLocation resolveProjectLocation(ISourceLocation loc) {
-            try {
-                for (WorkspaceFolder folder : lspWorkspaceService.workspaceFolders()) {
-                    if (folder.getName().equals(loc.getAuthority())) {
-                        ISourceLocation root = URIUtil.createFromURI(folder.getUri());
-                        return URIUtil.getChildLocation(root, loc.getPath());
-                    }
-                }
-
-                return loc;
-            }
-            catch (URISyntaxException e) {
-                logger.catching(e);
-                return loc;
-            }
         }
 
         @Override
@@ -313,7 +295,7 @@ public CompletableFuture<Two<String, URI[]>[]> supplyPathConfig(PathConfigParame
                     result[0] = new Two<>("Sources", toURIArray(pcfg.getSrcs()));
                     result[1] = new Two<>("Libraries", toURIArray(pcfg.getLibs()));
                     return result;
-                } catch (IOException | URISyntaxException e) {
+                } catch (URISyntaxException e) {
                     logger.catching(e);
                     throw new CompletionException(e);
                 }
@@ -385,5 +367,10 @@ public void connect(LanguageClient client) {
         public void registerVFS(VFSRegister registration) {
             VSCodeVFSClient.buildAndRegister(registration.getPort());
         }
+
+        @Override
+        public void cancelProgress(WorkDoneProgressCancelParams params) {
+            lspDocumentService.cancelProgress(params.getToken().getLeft());
+        }
     }
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/IBaseTextDocumentService.java

@@ -26,6 +26,7 @@
  */
 package org.rascalmpl.vscode.lsp;
 
+import java.time.Duration;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 
@@ -40,6 +41,9 @@
 import io.usethesource.vallang.IValue;
 
 public interface IBaseTextDocumentService extends TextDocumentService {
+    static final Duration NO_DEBOUNCE = Duration.ZERO;
+    static final Duration NORMAL_DEBOUNCE = Duration.ofMillis(800);
+
     void initializeServerCapabilities(ServerCapabilities result);
     void shutdown();
     void connect(LanguageClient client);
@@ -53,4 +57,5 @@ public interface IBaseTextDocumentService extends TextDocumentService {
     boolean isManagingFile(ISourceLocation file);
 
     default void didRenameFiles(RenameFilesParams params, Set<ISourceLocation> workspaceFolders) {}
+    void cancelProgress(String progressId);
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/IRascalFileSystemServices.java

@@ -287,7 +287,7 @@ default CompletableFuture<String[]> fileSystemSchemes() {
     }
 
     @JsonNotification("rascal/filesystem/onDidChangeFile")
-    default void onDidChangeFile(FileChangeEvent event) { };
+    default void onDidChangeFile(FileChangeEvent event) { }
 
 
     public static class DeleteParameters {
@@ -468,7 +468,7 @@ public ISourceLocation getLocation() throws URISyntaxException {
         }
     }
 
-    public static enum FileChangeType {
+    public enum FileChangeType {
         Changed(1), Created(2), Deleted(3);
 
         private final int value;
@@ -481,7 +481,7 @@ private FileChangeType(int val) {
         public int getValue() {
             return value;
         }
-    };
+    }
 
     public static class FileStat {
         FileType type;
@@ -501,7 +501,7 @@ public FileStat(FileType type, long ctime, long mtime, long size, @Nullable File
 
     }
 
-    public static enum FileType {
+    public enum FileType {
         Unknown(0), File(1), Directory(2), SymbolicLink(64);
 
         private final int value;
@@ -514,11 +514,11 @@ private FileType(int val) {
         public int getValue() {
             return value;
         }
-    };
+    }
 
     // this enum models the enum inside vscode, which in the future might become an enum flag
     // in that case we have to solve that
-    public static enum FilePermission {
+    public enum FilePermission {
         Readonly(1);
         private final int value;
         private FilePermission(int val) {
@@ -632,6 +632,7 @@ private static ResponseError fileNotFound(Object data) {
         private static ResponseError noPermissions(Object data) {
             return new ResponseError(-5, "No permissions", data);
         }
+        @SuppressWarnings("unused")
         private static ResponseError unavailable(Object data) {
             return new ResponseError(-6, "Unavailable", data);
         }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/LSPIDEServices.java

@@ -26,7 +26,6 @@
  */
 package org.rascalmpl.vscode.lsp;
 
-import java.io.IOException;
 import java.io.PrintWriter;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -91,19 +90,15 @@ public void browse(URI uri, String title, int viewColumn) {
 
     @Override
     public void edit(ISourceLocation path) {
-        try {
-            ISourceLocation physical = Locations.toClientLocation(path);
-            ShowDocumentParams params = new ShowDocumentParams(physical.getURI().toASCIIString());
-            params.setTakeFocus(true);
-
-            if (physical.hasOffsetLength()) {
-                params.setSelection(Locations.toRange(physical, docService.getColumnMap(physical)));
-            }
+        ISourceLocation physical = Locations.toClientLocation(path);
+        ShowDocumentParams params = new ShowDocumentParams(physical.getURI().toASCIIString());
+        params.setTakeFocus(true);
 
-            languageClient.showDocument(params);
-        } catch (IOException e) {
-            logger.info("ignored edit of {}, because {}", path, e);
+        if (physical.hasOffsetLength()) {
+            params.setSelection(Locations.toRange(physical, docService.getColumnMap(physical)));
         }
+
+        languageClient.showDocument(params);
     }
 
     @Override
@@ -200,4 +195,8 @@ public void warning(String message, ISourceLocation src) {
         monitor.warning(message, src);
     }
 
+    public IRascalMonitor getMonitor() {
+        return monitor;
+    }
+
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/RascalLSPMonitor.java

@@ -26,8 +26,11 @@
  */
 package org.rascalmpl.vscode.lsp;
 
+import java.util.Map;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Function;
+
 import org.apache.logging.log4j.Logger;
 import org.eclipse.lsp4j.ProgressParams;
 import org.eclipse.lsp4j.WorkDoneProgressBegin;
@@ -37,6 +40,8 @@
 import org.eclipse.lsp4j.WorkDoneProgressReport;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.rascalmpl.debug.IRascalMonitor;
+import org.rascalmpl.vscode.lsp.util.concurrent.InterruptibleFuture;
+
 import io.usethesource.vallang.ISourceLocation;
 
 /**
@@ -78,7 +83,7 @@ public LSPProgressBar(String rootName, String progressId) {
 
             var msg = new WorkDoneProgressBegin();
             msg.setTitle(progressPrefix + rootName);
-            msg.setCancellable(false);
+            msg.setCancellable(activeFutures.containsKey(progressId));
             notifyProgress(msg);
         }
 
@@ -90,7 +95,7 @@ private void notifyProgress(WorkDoneProgressNotification value) {
         public void progress(String message) {
             var msg = new WorkDoneProgressReport();
             msg.setMessage(message);
-            msg.setCancellable(false);
+            msg.setCancellable(activeFutures.containsKey(progressId));
             notifyProgress(msg);
         }
 
@@ -126,6 +131,26 @@ private CompletableFuture<Void> retry(Throwable first, int retry, String id) {
     }
 
     private final ThreadLocal<LSPProgressBar> activeProgress = new ThreadLocal<>();
+    private final Map<String, InterruptibleFuture<? extends Object>> activeFutures = new ConcurrentHashMap<>();
+
+    /**
+     * Register a running {@link InterruptibleFuture}, so it can be interrupted later.
+     * Must be called from the same thread as the corresponding {@link jobStarted}.
+     * @param name The task name, equal to the one used for {@link jobStarted}.
+     * @param future The future doing the work.
+     */
+    public void registerActiveFuture(String name, InterruptibleFuture<?> future) {
+        activeFutures.put(generateProgressId(name), future);
+    }
+
+    /**
+     * Unregister an {@link InterruptibleFuture} that has finished.
+     * Must be called from the same thread as the corresponding {@link jobEnded}.
+     * @param name The task name, equal to the one used for {@link jobEnded}.
+     */
+    public void unregisterActiveFuture(String name) {
+        activeFutures.remove(generateProgressId(name));
+    }
 
     @Override
     public void jobStart(String name, int workShare, int totalWork) {
@@ -147,7 +172,6 @@ public void jobStart(String name, int workShare, int totalWork) {
     private static String generateProgressId(String topLevelName) {
         Thread t = Thread.currentThread();
         return "T" + Integer.toHexString(t.hashCode()) + "" + Long.toHexString(t.getId()) + "" + Integer.toHexString(System.identityHashCode(topLevelName));
-
     }
 
 
@@ -206,4 +230,15 @@ public boolean jobIsCanceled(String name) {
     public void warning(String message, ISourceLocation src) {
         logger.warn("{} : {}", src, message);
     }
+
+    /**
+     * Cancel the running {@link InterruptibleFuture} corresponding to a specific progress bar.
+     * @param progressId The identifier of the progress bar.
+     */
+    public void cancelProgress(String progressId) {
+        var future = activeFutures.get(progressId);
+        if (future != null) {
+            future.interrupt();
+        }
+    }
 }