LSP client stops working on file after renaming it

The LSP protocol requires that when a file is renamed the client
signals this to the server by sending a didClose for the old location
and after that a didOpen with the new location.

The change assumes, that the IDE always goes through the DataObject to
issue the rename/move. Changes through the raw FileObject are not
tracked.

Closes: #7806

Author: matthiasblaesing

ide/lsp.client/src/org/netbeans/modules/lsp/client/LSPBindings.java

@@ -45,6 +45,7 @@
 import java.util.Set;
 import java.util.WeakHashMap;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
@@ -143,7 +144,7 @@ public class LSPBindings {
     }
 
     private static final Map<FileObject, Map<BackgroundTask, RequestProcessor.Task>> backgroundTasks = new WeakHashMap<>();
-    private final Set<FileObject> openedFiles = new HashSet<>();
+    private final Map<FileObject, Boolean> openedFiles = new ConcurrentHashMap<>();
 
     public static synchronized LSPBindings getBindings(FileObject file) {
         for (Entry<FileObject, Map<String, LSPBindings>> e : workspace2Extension2Server.entrySet()) {
@@ -542,7 +543,7 @@ private static Map<BackgroundTask, Task> backgroundTasksMapFor(FileObject file)
         return backgroundTasks.computeIfAbsent(file, f -> new IdentityHashMap<>());
     }
 
-    public Set<FileObject> getOpenedFiles() {
+    public Map<FileObject, Boolean> getOpenedFiles() {
         return openedFiles;
     }
 

ide/lsp.client/src/org/netbeans/modules/lsp/client/Utils.java

@@ -57,6 +57,7 @@
 import org.openide.filesystems.URLMapper;
 import org.openide.loaders.DataFolder;
 import org.openide.loaders.DataObject;
+import org.openide.loaders.DataObjectNotFoundException;
 import org.openide.text.Line;
 import org.openide.text.NbDocument;
 import org.openide.util.Exceptions;
@@ -71,6 +72,23 @@ public static String toURI(FileObject file) {
         return file.toURI().toString().replace("file:/", "file:///");
     }
 
+    public static String uriReplaceFilename(String inputUriString, String filename) {
+        try {
+            URI inputUri = URI.create(inputUriString);
+            URI newUri = inputUri.resolve(new URI(null, null, filename, null));
+            if ("file".equals(newUri.getScheme())) {
+                // By default the java URI routines drop empty hostnames from
+                // file URIs. Normalize this to the empty hostname. See also
+                // #toURI
+                return new URI("file", "", newUri.getPath(), null).toString();
+            } else {
+                return newUri.toString();
+            }
+        } catch (URISyntaxException ex) {
+            throw new IllegalArgumentException(ex);
+        }
+    }
+
     public static Position createPosition(Document doc, int offset) throws BadLocationException {
          return new Position(LineDocumentUtils.getLineIndex((LineDocument) doc, offset),
                              offset - LineDocumentUtils.getLineStart((LineDocument) doc, offset));
@@ -137,7 +155,7 @@ public static void applyWorkspaceEdit(WorkspaceEdit edit) {
     private static void applyEdits(String uri, List<TextEdit> edits) {
         try {
             FileObject file = URLMapper.findFileObject(new URI(uri).toURL());
-            EditorCookie ec = file.getLookup().lookup(EditorCookie.class);
+            EditorCookie ec = lookupForFile(file, EditorCookie.class);
             Document doc = ec != null ? ec.openDocument() : null;
             if (doc == null) {
                 return ;
@@ -274,7 +292,7 @@ public static void open(String targetUri, Range targetRange) {
         FileObject targetFile = fromURI(targetUri);
 
         if (targetFile != null) {
-            LineCookie lc = targetFile.getLookup().lookup(LineCookie.class);
+            LineCookie lc = lookupForFile(targetFile, LineCookie.class);
 
             //TODO: expecting lc != null!
 
@@ -288,6 +306,25 @@ public static void open(String targetUri, Range targetRange) {
         }
     }
 
+    public static <T> T lookupForFile(FileObject targetFile, Class<T> clazz) {
+        if(targetFile == null) {
+            return null;
+        }
+        T lc = null;
+        try {
+            if (lc == null) {
+                DataObject dataObject = DataObject.find(targetFile);
+                lc = dataObject.getLookup().lookup(clazz);
+            }
+        } catch (DataObjectNotFoundException ex) {
+            // Ignore
+        }
+        if (lc == null) {
+            lc = targetFile.getLookup().lookup(clazz);
+        }
+        return lc;
+    }
+
     private static final Comparator<TextEdit> rangeReverseSort = (s1, s2) -> {
         int l1 = s1.getRange().getEnd().getLine();
         int l2 = s2.getRange().getEnd().getLine();

ide/lsp.client/src/org/netbeans/modules/lsp/client/bindings/FoldManagerImpl.java

@@ -110,7 +110,7 @@ public void release() {
 
     @Override
     public void run(LSPBindings bindings, FileObject file) {
-        EditorCookie ec = file.getLookup().lookup(EditorCookie.class);
+        EditorCookie ec = Utils.lookupForFile(file, EditorCookie.class);
         Document doc = ec != null ? ec.getDocument() : null;
         if (doc == null) {
             return;

ide/lsp.client/src/org/netbeans/modules/lsp/client/bindings/LanguageClientImpl.java

@@ -159,7 +159,7 @@ public void notifyProgress(ProgressParams params) {
     public void publishDiagnostics(PublishDiagnosticsParams pdp) {
         try {
             FileObject file = URLMapper.findFileObject(new URI(pdp.getUri()).toURL());
-            EditorCookie ec = file != null ? file.getLookup().lookup(EditorCookie.class) : null;
+            EditorCookie ec = Utils.lookupForFile(file, EditorCookie.class);
             Document doc = ec != null ? ec.getDocument() : null;
             if (doc == null) {
                 return ; //ignore...

ide/lsp.client/src/org/netbeans/modules/lsp/client/bindings/LspStructureNavigatorPanel.java

@@ -18,32 +18,24 @@
  */
 package org.netbeans.modules.lsp.client.bindings;
 
-import java.awt.BorderLayout;
-import java.awt.EventQueue;
 import java.util.Collection;
 import java.util.logging.Level;
-import java.util.logging.Logger;
 import javax.swing.Action;
-import javax.swing.JComponent;
-import javax.swing.JPanel;
 import javax.swing.text.StyledDocument;
 import org.netbeans.api.actions.Openable;
 import org.netbeans.api.editor.mimelookup.MimeLookup;
 import org.netbeans.api.lsp.StructureElement;
+import org.netbeans.modules.lsp.client.Utils;
 import org.netbeans.spi.lsp.StructureProvider;
-import org.netbeans.spi.navigator.NavigatorPanel;
 import org.openide.awt.Actions;
 import org.openide.cookies.EditorCookie;
 import org.openide.cookies.LineCookie;
-import org.openide.explorer.ExplorerManager;
-import org.openide.explorer.view.BeanTreeView;
 import org.openide.filesystems.FileObject;
 import org.openide.nodes.AbstractNode;
 import org.openide.nodes.Children;
 import org.openide.nodes.Node;
 import org.openide.text.Line;
 import org.openide.text.NbDocument;
-import org.openide.util.Lookup;
 import org.openide.util.NbBundle;
 import org.openide.util.RequestProcessor;
 import org.openide.util.lookup.AbstractLookup;
@@ -75,7 +67,7 @@ void removeBackgroundTask(FileObject fo) {
 
     void refreshStructure(FileObject fo) {
         LOG.log(Level.INFO, "panelActivated: {0}", fo);
-        EditorCookie ec = fo.getLookup().lookup(EditorCookie.class);
+        EditorCookie ec = Utils.lookupForFile(fo, EditorCookie.class);
         if (ec != null) {
             StyledDocument doc = ec.getDocument();
             if (doc != null) {
@@ -130,12 +122,12 @@ private StructureElementNode(StructureElement e, FileObject fo, InstanceContent
             setShortDescription(e.getDetail());
             setIconBaseWithExtension(Icons.getSymbolIconBase(e.getKind()));
             Openable open = () -> {
-                EditorCookie ec = fo.getLookup().lookup(EditorCookie.class);
+                EditorCookie ec = Utils.lookupForFile(fo, EditorCookie.class);
                 if (ec != null) {
                     StyledDocument doc = ec.getDocument();
                     if (doc != null) {
                         int lineNumber = NbDocument.findLineNumber(doc, e.getSelectionStartOffset());
-                        LineCookie lines = fo.getLookup().lookup(LineCookie.class);
+                        LineCookie lines = Utils.lookupForFile(fo, LineCookie.class);
                         if (lines != null) {
                             Line at = lines.getLineSet().getOriginal(lineNumber);
                             if (at != null) {