Skip to content

fix: Error when using paths with non-ASCII characters for file watching on Unix/MacOS #1498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rubenporras merged 1 commit into from
Feb 19, 2026
Merged

fix: Error when using paths with non-ASCII characters for file watching on Unix/MacOS #1498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion org.eclipse.lsp4e.test/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Tests for language server bundle (Incubation)
Bundle-SymbolicName: org.eclipse.lsp4e.test;singleton:=true
Bundle-Version: 0.16.7.qualifier
Bundle-Version: 0.16.8.qualifier
Fragment-Host: org.eclipse.lsp4e
Bundle-Vendor: Eclipse LSP4E
Bundle-RequiredExecutionEnvironment: JavaSE-21
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.lsp4e.test/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
</parent>
<artifactId>org.eclipse.lsp4e.test</artifactId>
<packaging>eclipse-test-plugin</packaging>
<version>0.16.7-SNAPSHOT</version>
<version>0.16.8-SNAPSHOT</version>

<properties>
<os-jvm-flags /> <!-- for the default case -->
Expand Down
9 changes: 8 additions & 1 deletion org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/edit/LSPEclipseUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,6 @@ public void testUNCwindowsURI() {
public void testToUri_WindowsUNC() {
File unc = new File("\\\\localhost\\c$\\Windows");
URI uri = LSPEclipseUtils.toUri(unc);
System.err.println(uri.toString());
assertTrue(uri.toString().startsWith("file://localhost/c$/Windows"));

File uncWithSpaces = new File("\\\\server-name\\shared folder\\dir with space");
Expand All @@ -339,6 +338,14 @@ public void testToUri_WindowsUNC() {
// Ensure there is an authority and no malformed quadruple slashes
assertFalse(uriWithSpaces.toString().startsWith("file:////"));
}

@Test
void testFileUriWithNonAsciiPath() throws Exception {
// File name contains a German Eszett and a Japanese Kana
String fileName = "foo ßア";
IFile targetFile = project.getFile(fileName);
assertEquals(fileName, Paths.get(LSPEclipseUtils.toUri(targetFile)).getFileName().toString());
}

@Test
public void testToWorkspaceFolder() {
Expand Down
13 changes: 12 additions & 1 deletion org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/files/FileSystemWatcherManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
*******************************************************************************/
package org.eclipse.lsp4e.test.files;

import static org.junit.jupiter.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.net.URI;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;

import org.eclipse.lsp4e.LSPEclipseUtils;
import org.eclipse.lsp4e.internal.files.FileSystemWatcherManager;
import org.eclipse.lsp4j.FileSystemWatcher;
import org.eclipse.lsp4j.WatchKind;
Expand Down Expand Up @@ -128,6 +130,15 @@ void watcherKindFiltering() {
assertNoMatchFile(deleteUri, WatchKind.Change);
assertMatchFile(deleteUri, WatchKind.Delete);
}

@Test
void nonAsciiFile() {
registerWatchers("watcher-kind", List.of(
new FileSystemWatcher(Either.forLeft("*.txt"), null)));
// We use LSPEclipseUtils.toUri because this is also used to create the URI to check
URI createUri = LSPEclipseUtils.toUri(projectDir.resolve("fooß.txt").toFile());
assertMatchFile(createUri, WatchKind.Create);
}

@Test
void globMatchingSimple() {
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.lsp4e/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Language Server Protocol client for Eclipse IDE (Incubation)
Bundle-SymbolicName: org.eclipse.lsp4e;singleton:=true
Bundle-Version: 0.19.7.qualifier
Bundle-Version: 0.19.8.qualifier
Bundle-RequiredExecutionEnvironment: JavaSE-21
Require-Bundle: org.eclipse.core.runtime;bundle-version="3.12.0",
org.eclipse.equinox.common;bundle-version="3.8.0",
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.lsp4e/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</parent>
<artifactId>org.eclipse.lsp4e</artifactId>
<packaging>eclipse-plugin</packaging>
<version>0.19.7-SNAPSHOT</version>
<version>0.19.8-SNAPSHOT</version>

<build>
<plugins>
Expand Down
18 changes: 2 additions & 16 deletions org.eclipse.lsp4e/src/org/eclipse/lsp4e/LSPEclipseUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
import java.io.OutputStream;
import java.lang.reflect.Method;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
Expand Down Expand Up @@ -1354,21 +1353,8 @@ public static URI toUri(IPath absolutePath) {
}

public static URI toUri(File file) {
// URI scheme specified by language server protocol and LSP
try {
final var path = file.getAbsoluteFile().toURI().getPath();
if (path.startsWith("//")) { // UNC path like //localhost/c$/Windows/ //$NON-NLS-1$
// split: authority = "localhost", absPath = "/c$/Windows/"
final int slash = path.indexOf('/', 2);
final String authority = slash > 2 ? path.substring(2, slash) : path.substring(2);
final String absPath = slash > 2 ? path.substring(slash) : "/"; //$NON-NLS-1$
return new URI(FILE_SCHEME, authority, absPath, null);
}
return new URI(FILE_SCHEME, "", path, null); //$NON-NLS-1$
} catch (URISyntaxException e) {
LanguageServerPlugin.logError(e);
return file.getAbsoluteFile().toURI();
}
// Perform one round-trip to make sure all non-ASCII characters are properly encoded.
return URI.create((file.toPath().toUri()).toASCIIString());
}

public static @Nullable IFile getFile(@Nullable IDocument document) {
Expand Down
Loading