Fix watched files registration to work with paths outside workspace.

- Changes notifications for certain files (eg. `java.settings.url`) were
  not triggered when they existed outside the workspace

Signed-off-by: Roland Grunberg <[email protected]>

Author: rgrunber

org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/ResourceUtils.java

@@ -47,6 +47,8 @@
 import org.eclipse.core.runtime.URIUtil;
 import org.eclipse.jdt.core.IJavaModelMarker;
 import org.eclipse.jdt.core.compiler.IProblem;
+import org.eclipse.lsp4j.RelativePattern;
+import org.eclipse.lsp4j.jsonrpc.messages.Either;
 
 import com.google.common.io.CharStreams;
 
@@ -288,7 +290,7 @@ public String lookup(String key) {
 	 *            the path to convert
 	 * @return a glob pattern prefixed with the path
 	 */
-	public static String toGlobPattern(IPath path) {
+	public static Either<String, RelativePattern> toGlobPattern(IPath path) {
 		if (path == null) {
 			return null;
 		}
@@ -306,11 +308,15 @@ public static String toGlobPattern(IPath path) {
 	 *            whether to end the glob with "/**"
 	 * @return a glob pattern prefixed with the path
 	 */
-	public static String toGlobPattern(IPath path, boolean recursive) {
+	public static Either<String, RelativePattern> toGlobPattern(IPath path, boolean recursive) {
 		if (path == null) {
 			return null;
 		}
 
+		if (path.isAbsolute() && !recursive) {
+			return Either.forRight(new RelativePattern(Either.forRight(path.removeLastSegments(1).toPortableString()), path.lastSegment()));
+		}
+
 		String globPattern = path.toPortableString();
 		if (path.getDevice() != null) {
 			//This seems pretty hack-ish: need to remove device as it seems to break
@@ -328,7 +334,7 @@ public static String toGlobPattern(IPath path, boolean recursive) {
 			}
 		}
 
-		return globPattern;
+		return Either.forLeft(globPattern);
 	}
 
 	public static String dos2Unix(String str) {

org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/managers/StandardProjectsManager.java

@@ -99,6 +99,7 @@
 import org.eclipse.lsp4j.DidChangeWatchedFilesRegistrationOptions;
 import org.eclipse.lsp4j.FileSystemWatcher;
 import org.eclipse.lsp4j.MessageType;
+import org.eclipse.lsp4j.RelativePattern;
 import org.eclipse.lsp4j.TextDocumentIdentifier;
 import org.eclipse.lsp4j.WatchKind;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
@@ -107,7 +108,7 @@
 public class StandardProjectsManager extends ProjectsManager {
 	private final static String FORMATTER_OPTION_PREFIX = JavaCore.PLUGIN_ID + ".formatter"; //$NON-NLS-1$
 	protected static final String BUILD_SUPPORT_EXTENSION_POINT_ID = "buildSupport";
-	private static final Set<String> watchers = new LinkedHashSet<>();
+	private static final Set<Either<String, RelativePattern>> watchers = new LinkedHashSet<>();
 	private PreferenceManager preferenceManager;
 	private boolean buildFinished;
 	private boolean shouldUpdateProjects;
@@ -123,12 +124,12 @@ public void setShouldUpdateProjects(boolean shouldUpdateProjects) {
 	}
 
 	//@formatter:off
-	private static final List<String> basicWatchers = Arrays.asList(
-			"**/*.java",
-			"**/.project",
-			"**/.classpath",
-			"**/.settings/*.prefs",
-			"**/src/**"
+	private static final List<Either<String, RelativePattern>> basicWatchers = Arrays.asList(
+			Either.forLeft("**/*.java"),
+			Either.forLeft("**/.project"),
+			Either.forLeft("**/.classpath"),
+			Either.forLeft("**/.settings/*.prefs"),
+			Either.forLeft("**/src/**")
 	);
 	//@formatter:on
 
@@ -465,8 +466,8 @@ public void registerWatchers(boolean runInJob) {
 	public List<FileSystemWatcher> registerWatchers() {
 		logInfo(">> registerWatchers'");
 		if (preferenceManager.getClientPreferences().isWorkspaceChangeWatchedFilesDynamicRegistered()) {
-			Set<String> patterns = new LinkedHashSet<>(basicWatchers);
-			buildSupports().forEach(e -> e.getWatchPatterns().forEach(patterns::add));
+			Set<Either<String, RelativePattern>> patterns = new LinkedHashSet<>(basicWatchers);
+			buildSupports().forEach(e -> e.getWatchPatterns().forEach(p -> patterns.add(Either.forLeft(p))));
 			Set<IPath> sources = new HashSet<>();
 			IProject[] projects = ResourcesPlugin.getWorkspace().getRoot().getProjects();
 			try {
@@ -519,9 +520,9 @@ public List<FileSystemWatcher> registerWatchers() {
 							IPath projectFolder = ProjectUtils.getProjectRealFolder(project);
 							Set<String> libraries = preferenceManager.getPreferences().getReferencedLibraries().getInclude();
 							for (String pattern: libraries) {
-								patterns.add(ProjectUtils.resolveGlobPath(projectFolder, pattern).toPortableString());
+								patterns.add(Either.forLeft(ProjectUtils.resolveGlobPath(projectFolder, pattern).toPortableString()));
 							}
-							patterns.add("**/.settings");
+							patterns.add(Either.forLeft("**/.settings"));
 						}
 					}
 				}
@@ -550,14 +551,14 @@ public List<FileSystemWatcher> registerWatchers() {
 				addWatcher(settings, sources);
 			}
 			patterns.addAll(sources.stream().map(p -> ResourceUtils.toGlobPattern(p, false)).collect(Collectors.toList()));
-			for (String pattern : patterns) {
-				FileSystemWatcher watcher = new FileSystemWatcher(Either.forLeft(pattern));
+			for (Either<String, RelativePattern> pattern : patterns) {
+				FileSystemWatcher watcher = new FileSystemWatcher(pattern);
 				fileWatchers.add(watcher);
 			}
 			// Watch on project root folders.
 			for (IProject project : projects) {
 				if (ProjectUtils.isVisibleProject(project) && project.exists()) {
-					FileSystemWatcher watcher = new FileSystemWatcher(Either.forLeft(ResourceUtils.toGlobPattern(project.getLocation(), false)), WatchKind.Delete);
+					FileSystemWatcher watcher = new FileSystemWatcher(ResourceUtils.toGlobPattern(project.getLocation(), false), WatchKind.Delete);
 					fileWatchers.add(watcher);
 				}
 			}

org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/syntaxserver/SyntaxProjectsManager.java

@@ -54,17 +54,18 @@
 import org.eclipse.jdt.ls.core.internal.preferences.Preferences;
 import org.eclipse.lsp4j.DidChangeWatchedFilesRegistrationOptions;
 import org.eclipse.lsp4j.FileSystemWatcher;
+import org.eclipse.lsp4j.RelativePattern;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 
 public class SyntaxProjectsManager extends ProjectsManager {
 	//@formatter:off
-	private static final List<String> basicWatchers = Arrays.asList(
-			"**/*.java"
+	private static final List<Either<String, RelativePattern>> basicWatchers = Arrays.asList(
+			Either.forLeft("**/*.java")
 			// "**/src/**"
 	);
 	//@formatter:on
 
-	private final Set<String> watchers = new LinkedHashSet<>();
+	private final Set<Either<String, RelativePattern>> watchers = new LinkedHashSet<>();
 
 	private Job registerWatcherJob = new Job("Register Watchers") {
 
@@ -137,14 +138,14 @@ public List<FileSystemWatcher> registerWatchers() {
 				JavaLanguageServerPlugin.logException(e.getMessage(), e);
 			}
 			List<FileSystemWatcher> fileWatchers = new ArrayList<>();
-			Set<String> patterns = new LinkedHashSet<>(basicWatchers);
+			Set<Either<String, RelativePattern>> patterns = new LinkedHashSet<>(basicWatchers);
 			patterns.addAll(Stream.of(sources).map(ResourceUtils::toGlobPattern).collect(Collectors.toList()));
 
-			for (String pattern : patterns) {
-				FileSystemWatcher watcher = new FileSystemWatcher(Either.forLeft(pattern));
+			for (Either<String, RelativePattern> pattern : patterns) {
+				FileSystemWatcher watcher = new FileSystemWatcher(pattern);
 				fileWatchers.add(watcher);
 			}
-	
+
 			if (!patterns.equals(watchers)) {
 				JavaLanguageServerPlugin.logInfo(">> registerFeature 'workspace/didChangeWatchedFiles'");
 				DidChangeWatchedFilesRegistrationOptions didChangeWatchedFilesRegistrationOptions = new DidChangeWatchedFilesRegistrationOptions(fileWatchers);

org.eclipse.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/ResourceUtilsTest.java

@@ -21,18 +21,20 @@
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.Path;
 import org.eclipse.core.runtime.Platform;
+import org.eclipse.lsp4j.RelativePattern;
+import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.junit.Test;
 
 public class ResourceUtilsTest {
 
 	@Test
 	public void testToGlobPattern() {
 		assertNull(toGlobPattern(null));
-		assertEquals("/foo/bar/**", toGlobPattern(Path.forPosix("/foo/bar")));
-		assertEquals("/foo/bar/**", toGlobPattern(Path.forPosix("/foo/bar/")));
-		assertEquals("**/foo/bar/**", toGlobPattern(Path.forWindows("c:/foo/bar/")));
-		assertEquals("**/foo/bar/**", toGlobPattern(Path.forWindows("c:\\foo\\bar")));
-		assertEquals("/foo/bar/foo.jar", toGlobPattern(Path.forPosix("/foo/bar/foo.jar")));
+		assertEquals(Either.forLeft("/foo/bar/**"), toGlobPattern(Path.forPosix("/foo/bar")));
+		assertEquals(Either.forLeft("/foo/bar/**"), toGlobPattern(Path.forPosix("/foo/bar/")));
+		assertEquals(Either.forLeft("**/foo/bar/**"), toGlobPattern(Path.forWindows("c:/foo/bar/")));
+		assertEquals(Either.forLeft("**/foo/bar/**"), toGlobPattern(Path.forWindows("c:\\foo\\bar")));
+		assertEquals(Either.forRight(new RelativePattern(Either.forRight("/foo/bar"), "foo.jar")), toGlobPattern(Path.forPosix("/foo/bar/foo.jar")));
 	}
 
 	@Test

org.eclipse.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/handlers/InitHandlerTest.java

@@ -326,10 +326,10 @@ public void testWatchers() throws Exception {
 		// 8 basic + 3 project roots
 		assertEquals("Unexpected watchers:\n" + toString(watchers), 12, watchers.size());
 		List<FileSystemWatcher> projectWatchers = watchers.subList(9, 12);
-		assertTrue(projectWatchers.get(0).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("/TestProject"));
+		assertTrue(projectWatchers.get(0).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("TestProject"));
 		assertTrue(WatchKind.Delete == projectWatchers.get(0).getKind());
-		assertTrue(projectWatchers.get(1).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("/maven/salut"));
-		assertTrue(projectWatchers.get(2).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("/gradle/simple-gradle"));
+		assertTrue(projectWatchers.get(1).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("salut"));
+		assertTrue(projectWatchers.get(2).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("simple-gradle"));
 
 		watchers = watchers.subList(0, 9);
 		Collections.sort(watchers, Comparator.comparing(fileSystemWatcher -> fileSystemWatcher.getGlobPattern().map(Function.identity(), RelativePattern::getPattern)));
@@ -373,9 +373,9 @@ public void testWatchers() throws Exception {
 		verify(client, times(1)).registerCapability(any());
 		assertEquals("Unexpected watchers:\n" + toString(watchers), 12, newWatchers.size());
 		projectWatchers = newWatchers.subList(9, 12);
-		assertTrue(projectWatchers.get(0).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("/TestProject"));
-		assertTrue(projectWatchers.get(1).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("/maven/salut"));
-		assertTrue(projectWatchers.get(2).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("/gradle/simple-gradle"));
+		assertTrue(projectWatchers.get(0).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("TestProject"));
+		assertTrue(projectWatchers.get(1).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("salut"));
+		assertTrue(projectWatchers.get(2).getGlobPattern().map(Function.identity(), RelativePattern::getPattern).endsWith("simple-gradle"));
 
 		newWatchers = watchers.subList(0, 9);
 		Collections.sort(newWatchers, Comparator.comparing(fileSystemWatcher -> fileSystemWatcher.getGlobPattern().map(Function.identity(), RelativePattern::getPattern)));