Fix LSP document synchronization

rascal-lsp/.vscode/launch.json

@@ -10,7 +10,8 @@
       "console": "internalConsole",
       "vmArgs": [
         "-Dlog4j2.level=TRACE",
-        "-Drascal.compilerClasspath=${workspaceFolder}/target/lib/rascal.jar"
+        "-Drascal.compilerClasspath=${workspaceFolder}/target/lib/rascal.jar",
+        "-Drascal.fallbackResolver=org.rascalmpl.vscode.lsp.uri.FallbackResolver"
       ]
     },
     {
@@ -22,7 +23,8 @@
       "console": "internalConsole",
       "vmArgs": [
         "-Dlog4j2.level=TRACE",
-        "-Drascal.compilerClasspath=${workspaceFolder}/target/lib/rascal.jar"
+        "-Drascal.compilerClasspath=${workspaceFolder}/target/lib/rascal.jar",
+        "-Drascal.fallbackResolver=org.rascalmpl.vscode.lsp.uri.FallbackResolver"
       ]
     }
   ]

rascal-lsp/src/main/java/org/rascalmpl/uri/resolvers.config

@@ -0,0 +1 @@
+org.rascalmpl.vscode.lsp.uri.LSPOpenFileResolver

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

@@ -48,6 +48,9 @@ public interface IBaseTextDocumentService extends TextDocumentService {
     void unregisterLanguage(LanguageParameter lang);
     CompletableFuture<IValue> executeCommand(String languageName, String command);
     LineColumnOffsetMap getColumnMap(ISourceLocation file);
+    TextDocumentState getDocumentState(ISourceLocation file);
+
+    boolean isManagingFile(ISourceLocation file);
 
     default void didRenameFiles(RenameFilesParams params, Set<ISourceLocation> workspaceFolders) {}
 }

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

@@ -51,6 +51,7 @@
 import org.rascalmpl.uri.URIResolverRegistry;
 import org.rascalmpl.uri.URIUtil;
 import org.rascalmpl.values.IRascalValueFactory;
+import org.rascalmpl.vscode.lsp.util.locations.Locations;
 
 import io.usethesource.vallang.ISourceLocation;
 import io.usethesource.vallang.IValueFactory;
@@ -65,7 +66,7 @@ default CompletableFuture<SourceLocation> resolveLocation(SourceLocation loc) {
             try {
                 ISourceLocation tmp = loc.toRascalLocation();
 
-                ISourceLocation resolved = reg.logicalToPhysical(tmp);
+                ISourceLocation resolved = Locations.toClientLocation(tmp);
 
                 if (resolved == null) {
                     return loc;
@@ -77,10 +78,6 @@ default CompletableFuture<SourceLocation> resolveLocation(SourceLocation loc) {
                 IRascalFileSystemServices__logger.warn("Could not resolve location {} due to {}.", loc, e.getMessage());
                 return loc;
             }
-            catch (IOException e) {
-                // This is normal behavior (when its not a logical scheme)
-                return loc;
-            }
             catch (Throwable e) {
                 IRascalFileSystemServices__logger.warn("Could not resolve location {} due to {}.", loc, e.getMessage());
                 return loc;
@@ -130,7 +127,7 @@ private static boolean readonly(ISourceLocation loc) throws IOException {
             return false;
         }
         if (reg.getRegisteredLogicalSchemes().contains(loc.getScheme())) {
-            var resolved = reg.logicalToPhysical(loc);
+            var resolved = Locations.toClientLocation(loc);
             if (resolved != null && resolved != loc) {
                 return readonly(resolved);
             }

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

@@ -92,7 +92,7 @@ public void browse(URI uri, String title, int viewColumn) {
     @Override
     public void edit(ISourceLocation path) {
         try {
-            ISourceLocation physical = URIResolverRegistry.getInstance().logicalToPhysical(path);
+            ISourceLocation physical = Locations.toClientLocation(path);
             ShowDocumentParams params = new ShowDocumentParams(physical.getURI().toASCIIString());
             params.setTakeFocus(true);
 

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

@@ -55,10 +55,10 @@ public class TextDocumentState {
     @SuppressWarnings("java:S3077") // we are use volatile correctly
     private volatile CompletableFuture<Versioned<ITree>> currentTree;
 
-    public TextDocumentState(BiFunction<ISourceLocation, String, CompletableFuture<ITree>> parser, ISourceLocation file, int initialVersion, String initialContent) {
+    public TextDocumentState(BiFunction<ISourceLocation, String, CompletableFuture<ITree>> parser, ISourceLocation file, int initialVersion, String initialContent, long timestamp) {
         this.parser = parser;
         this.file = file;
-        this.currentContent = new Versioned<>(initialVersion, initialContent);
+        this.currentContent = new Versioned<>(initialVersion, initialContent, timestamp);
         this.currentTree = newTreeAsync(initialVersion, initialContent);
     }
 
@@ -72,8 +72,8 @@ public TextDocumentState(BiFunction<ISourceLocation, String, CompletableFuture<I
      * Thus, callers of `getCurrentTreeAsync` are guaranteed to obtain a
      * consistent <version, tree> pair.
      */
-    public CompletableFuture<Versioned<ITree>> update(int version, String content) {
-        currentContent = new Versioned<>(version, content);
+    public CompletableFuture<Versioned<ITree>> update(int version, String content, long timestamp) {
+        currentContent = new Versioned<>(version, content, timestamp);
         var newTree = newTreeAsync(version, content);
         currentTree = newTree;
         return newTree;
@@ -105,4 +105,8 @@ public ISourceLocation getLocation() {
     public Versioned<String> getCurrentContent() {
         return currentContent;
     }
+
+    public long getLastModified() {
+        return currentContent.getTimestamp();
+    }
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/ParametricTextDocumentService.java

@@ -106,6 +106,7 @@
 import org.rascalmpl.vscode.lsp.parametric.model.ParametricSummary;
 import org.rascalmpl.vscode.lsp.parametric.model.ParametricSummary.SummaryLookup;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.LanguageParameter;
+import org.rascalmpl.vscode.lsp.uri.FallbackResolver;
 import org.rascalmpl.vscode.lsp.util.CodeActions;
 import org.rascalmpl.vscode.lsp.util.Diagnostics;
 import org.rascalmpl.vscode.lsp.util.FoldingRanges;
@@ -149,6 +150,9 @@ public class ParametricTextDocumentService implements IBaseTextDocumentService,
     private final @Nullable LanguageParameter dedicatedLanguage;
 
     public ParametricTextDocumentService(ExecutorService exec, @Nullable LanguageParameter dedicatedLanguage) {
+        // The following call ensures that URIResolverRegistry is initialized before FallbackResolver is accessed
+        URIResolverRegistry.getInstance();
+
         this.ownExecuter = exec;
         this.files = new ConcurrentHashMap<>();
         this.columns = new ColumnMaps(this::getContents);
@@ -160,6 +164,7 @@ public ParametricTextDocumentService(ExecutorService exec, @Nullable LanguagePar
             this.dedicatedLanguageName = dedicatedLanguage.getName();
             this.dedicatedLanguage = dedicatedLanguage;
         }
+        FallbackResolver.getInstance().registerTextDocumentService(this);
     }
 
     @Override
@@ -226,15 +231,17 @@ public void connect(LanguageClient client) {
 
     @Override
     public void didOpen(DidOpenTextDocumentParams params) {
+        var timestamp = System.currentTimeMillis();
         logger.debug("Did Open file: {}", params.getTextDocument());
-        handleParsingErrors(open(params.getTextDocument()));
+        handleParsingErrors(open(params.getTextDocument(), timestamp));
         triggerAnalyzer(params.getTextDocument(), Duration.ofMillis(800));
     }
 
     @Override
     public void didChange(DidChangeTextDocumentParams params) {
+        var timestamp = System.currentTimeMillis();
         logger.debug("Did Change file: {}", params.getTextDocument().getUri());
-        updateContents(params.getTextDocument(), last(params.getContentChanges()).getText());
+        updateContents(params.getTextDocument(), last(params.getContentChanges()).getText(), timestamp);
         triggerAnalyzer(params.getTextDocument(), Duration.ofMillis(800));
     }
 
@@ -275,10 +282,10 @@ private void triggerBuilder(TextDocumentIdentifier doc) {
         fileFacts.calculateBuilder(location, getFile(doc).getCurrentTreeAsync());
     }
 
-    private TextDocumentState updateContents(VersionedTextDocumentIdentifier doc, String newContents) {
+    private TextDocumentState updateContents(VersionedTextDocumentIdentifier doc, String newContents, long timestamp) {
         TextDocumentState file = getFile(doc);
         logger.trace("New contents for {}", doc);
-        handleParsingErrors(file, file.update(doc.getVersion(), newContents));
+        handleParsingErrors(file, file.update(doc.getVersion(), newContents, timestamp));
         return file;
     }
 
@@ -439,9 +446,9 @@ private ParametricFileFacts facts(String doc) {
         throw new UnsupportedOperationException("Rascal Parametric LSP has no support for this file: " + doc);
     }
 
-    private TextDocumentState open(TextDocumentItem doc) {
+    private TextDocumentState open(TextDocumentItem doc, long timestamp) {
         return files.computeIfAbsent(Locations.toLoc(doc),
-            l -> new TextDocumentState(contributions(doc)::parsing, l, doc.getVersion(), doc.getText())
+            l -> new TextDocumentState(contributions(doc)::parsing, l, doc.getVersion(), doc.getText(), timestamp)
         );
     }
 
@@ -683,4 +690,14 @@ public CompletableFuture<IValue> executeCommand(String languageName, String comm
             return CompletableFuture.completedFuture(null);
         }
     }
+
+    @Override
+    public boolean isManagingFile(ISourceLocation file) {
+        return files.containsKey(file.top());
+    }
+
+    @Override
+    public TextDocumentState getDocumentState(ISourceLocation file) {
+        return files.get(file.top());
+    }
 }

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

@@ -102,6 +102,7 @@
 import org.rascalmpl.library.util.PathConfig;
 import org.rascalmpl.parser.gtd.exception.ParseError;
 import org.rascalmpl.uri.URIResolverRegistry;
+import org.rascalmpl.uri.URIUtil;
 import org.rascalmpl.values.parsetrees.ITree;
 import org.rascalmpl.values.parsetrees.ProductionAdapter;
 import org.rascalmpl.values.parsetrees.TreeAdapter;
@@ -113,6 +114,7 @@
 import org.rascalmpl.vscode.lsp.rascal.model.FileFacts;
 import org.rascalmpl.vscode.lsp.rascal.model.SummaryBridge;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.LanguageParameter;
+import org.rascalmpl.vscode.lsp.uri.FallbackResolver;
 import org.rascalmpl.vscode.lsp.util.CodeActions;
 import org.rascalmpl.vscode.lsp.util.Diagnostics;
 import org.rascalmpl.vscode.lsp.util.DocumentChanges;
@@ -143,9 +145,13 @@ public class RascalTextDocumentService implements IBaseTextDocumentService, Lang
     private @MonotonicNonNull BaseWorkspaceService workspaceService;
 
     public RascalTextDocumentService(ExecutorService exec) {
+        // The following call ensures that URIResolverRegistry is initialized before FallbackResolver is accessed
+        URIResolverRegistry.getInstance();
+
         this.ownExecuter = exec;
         this.documents = new ConcurrentHashMap<>();
         this.columns = new ColumnMaps(this::getContents);
+        FallbackResolver.getInstance().registerTextDocumentService(this);
     }
 
     @Override
@@ -200,15 +206,17 @@ public void connect(LanguageClient client) {
 
     @Override
     public void didOpen(DidOpenTextDocumentParams params) {
+        var timestamp = System.currentTimeMillis();
         logger.debug("Open: {}", params.getTextDocument());
-        TextDocumentState file = open(params.getTextDocument());
+        TextDocumentState file = open(params.getTextDocument(), timestamp);
         handleParsingErrors(file);
     }
 
     @Override
     public void didChange(DidChangeTextDocumentParams params) {
+        var timestamp = System.currentTimeMillis();
         logger.trace("Change: {}", params.getTextDocument());
-        updateContents(params.getTextDocument(), last(params.getContentChanges()).getText());
+        updateContents(params.getTextDocument(), last(params.getContentChanges()).getText(), timestamp);
     }
 
     @Override
@@ -230,10 +238,10 @@ public void didSave(DidSaveTextDocumentParams params) {
         }
     }
 
-    private TextDocumentState updateContents(VersionedTextDocumentIdentifier doc, String newContents) {
+    private TextDocumentState updateContents(VersionedTextDocumentIdentifier doc, String newContents, long timestamp) {
         TextDocumentState file = getFile(doc);
         logger.trace("New contents for {}", doc);
-        handleParsingErrors(file, file.update(doc.getVersion(), newContents));
+        handleParsingErrors(file, file.update(doc.getVersion(), newContents, timestamp));
         return file;
     }
 
@@ -419,9 +427,9 @@ private static <T> T last(List<T> l) {
         return l.get(l.size() - 1);
     }
 
-    private TextDocumentState open(TextDocumentItem doc) {
+    private TextDocumentState open(TextDocumentItem doc, long timestamp) {
         return documents.computeIfAbsent(Locations.toLoc(doc),
-            l -> new TextDocumentState((loc, input) -> rascalServices.parseSourceFile(loc, input), l, doc.getVersion(), doc.getText()));
+            l -> new TextDocumentState((loc, input) -> rascalServices.parseSourceFile(loc, input), l, doc.getVersion(), doc.getText(), timestamp));
     }
 
     private TextDocumentState getFile(TextDocumentIdentifier doc) {
@@ -567,6 +575,16 @@ private static <T> CompletableFuture<T> recoverExceptions(CompletableFuture<T> f
                 });
     }
 
+    @Override
+    public boolean isManagingFile(ISourceLocation file) {
+        return documents.containsKey(file.top());
+    }
+
+    @Override
+    public TextDocumentState getDocumentState(ISourceLocation file) {
+        return documents.get(file.top());
+    }
+
     public @MonotonicNonNull FileFacts getFileFacts() {
         return facts;
     }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/rascal/model/FileFacts.java

@@ -50,6 +50,8 @@
 import org.rascalmpl.vscode.lsp.util.concurrent.LazyUpdateableReference;
 import org.rascalmpl.vscode.lsp.util.concurrent.ReplaceableFuture;
 import org.rascalmpl.vscode.lsp.util.locations.ColumnMaps;
+import org.rascalmpl.vscode.lsp.util.locations.Locations;
+
 import io.usethesource.vallang.ISourceLocation;
 
 public class FileFacts {
@@ -87,7 +89,7 @@ public void reportParseErrors(ISourceLocation file, List<Diagnostic> msgs) {
     private FileFact getFile(ISourceLocation l) {
         ISourceLocation resolved = null;
         try {
-            resolved = URIResolverRegistry.getInstance().logicalToPhysical(l);
+            resolved = Locations.toClientLocation(l);
             if (resolved == null) {
                 resolved = l;
             }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/terminal/TerminalIDEClient.java

@@ -97,7 +97,7 @@ public void browse(URI uri, String title, int viewColumn) {
     @Override
     public void edit(ISourceLocation path) {
         try {
-            ISourceLocation physical = URIResolverRegistry.getInstance().logicalToPhysical(path);
+            ISourceLocation physical = Locations.toClientLocation(path);
             ShowDocumentParams params = new ShowDocumentParams(physical.getURI().toASCIIString());
             params.setTakeFocus(true);