WorkspaceFolders: Fix interpretation of event flags

org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/AllCleanRule.java

@@ -11,17 +11,30 @@
  *******************************************************************************/
 package org.eclipse.lsp4e.test;
 
+import java.util.function.Supplier;
+
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.lsp4e.LanguageServiceAccessor;
 import org.eclipse.lsp4e.tests.mock.MockLanguageServer;
+import org.eclipse.lsp4j.ServerCapabilities;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.intro.IIntroPart;
 import org.junit.rules.TestWatcher;
 import org.junit.runner.Description;
 
 public class AllCleanRule extends TestWatcher {
+
+	private final Supplier<ServerCapabilities> serverConfigurer;
+
+	public AllCleanRule() {
+		this.serverConfigurer = MockLanguageServer::defaultServerCapabilities;
+	}
+
+	public AllCleanRule(final Supplier<ServerCapabilities> serverConfigurer) {
+		this.serverConfigurer = serverConfigurer;
+	}
 
 	@Override
 	protected void starting(Description description) {
@@ -49,6 +62,6 @@ private void clear() {
 			}
 		}
 		LanguageServiceAccessor.clearStartedServers();
-		MockLanguageServer.reset();
+		MockLanguageServer.reset(this.serverConfigurer);
 	}
 }

org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/AllTests.java

@@ -79,7 +79,8 @@
 	LanguageServerWrapperTest.class,
 	ColorTest.class,
 	LSPCodeMiningTest.class,
-	ShowMessageTest.class
+	ShowMessageTest.class,
+	WorkspaceFoldersTest.class
 })
 public class AllTests {
 

org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/TestUtils.java

@@ -23,6 +23,8 @@
 import java.nio.file.Path;
 import java.util.Arrays;
 import java.util.Set;
+import java.util.concurrent.BrokenBarrierException;
+import java.util.concurrent.CountDownLatch;
 import java.util.function.BooleanSupplier;
 
 import org.eclipse.core.resources.IFile;
@@ -31,7 +33,6 @@
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.jface.text.ITextViewer;
-import org.eclipse.ui.tests.harness.util.DisplayHelper;
 import org.eclipse.lsp4e.ContentTypeToLanguageServerDefinition;
 import org.eclipse.lsp4e.LanguageServersRegistry;
 import org.eclipse.lsp4e.tests.mock.MockLanguageServer;
@@ -48,6 +49,7 @@
 import org.eclipse.ui.PartInitException;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.part.FileEditorInput;
+import org.eclipse.ui.tests.harness.util.DisplayHelper;
 import org.eclipse.ui.texteditor.AbstractTextEditor;
 import org.eclipse.ui.texteditor.ITextEditor;
 
@@ -227,4 +229,30 @@ protected boolean condition() {
 			}
 		}.waitForCondition(PlatformUI.getWorkbench().getDisplay(), 1000));
 	}
+
+	public static class JobSynchronizer extends NullProgressMonitor {
+		private final CountDownLatch latch = new CountDownLatch(1);
+
+		@Override
+		public void done() {
+			latch.countDown();
+
+		}
+		@Override
+		public void setCanceled(boolean cancelled) {
+			super.setCanceled(cancelled);
+			if (cancelled) {
+				latch.countDown();
+			}
+		}
+
+		public void await() throws InterruptedException, BrokenBarrierException {
+			latch.await();
+		}
+
+		@Override
+		public void worked(int work) {
+			latch.countDown();
+		}
+	}
 }

org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/WorkspaceFoldersTest.java

@@ -0,0 +1,221 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Cocotec Ltd and others.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Ahmed Hussain (Cocotec Ltd) - initial implementation
+ *  
+ *******************************************************************************/
+package org.eclipse.lsp4e.test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.net.URI;
+import java.util.Collection;
+import java.util.List;
+import java.util.function.Supplier;
+
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.lsp4e.LanguageServerWrapper;
+import org.eclipse.lsp4e.LanguageServiceAccessor;
+import org.eclipse.lsp4e.test.TestUtils.JobSynchronizer;
+import org.eclipse.lsp4e.tests.mock.MockLanguageServer;
+import org.eclipse.lsp4e.tests.mock.MockWorkspaceService;
+import org.eclipse.lsp4j.DidChangeWorkspaceFoldersParams;
+import org.eclipse.lsp4j.ServerCapabilities;
+import org.eclipse.lsp4j.WorkspaceFolder;
+import org.eclipse.lsp4j.WorkspaceFoldersOptions;
+import org.eclipse.lsp4j.WorkspaceServerCapabilities;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.ui.PlatformUI;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+
+public class WorkspaceFoldersTest implements Supplier<ServerCapabilities> {
+
+	@Rule public AllCleanRule clear = new AllCleanRule(this);
+	private IProject project;
+
+	@Before
+	public void setUp() throws CoreException {
+		MockLanguageServer.INSTANCE.getWorkspaceService().getWorkspaceFoldersEvents().clear();
+		project = TestUtils.createProject("WorkspaceFoldersTest" + System.currentTimeMillis());
+	}
+
+	@Test
+	public void testRecycleLSAfterInitialProjectGotDeletedIfWorkspaceFolders() throws Exception {
+		IFile testFile1 = TestUtils.createUniqueTestFile(project, "");
+
+		TestUtils.openEditor(testFile1);
+		LanguageServiceAccessor.getInitializedLanguageServers(testFile1, capabilities -> Boolean.TRUE).iterator()
+				.next();
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		Collection<LanguageServerWrapper> wrappers = LanguageServiceAccessor.getLSWrappers(testFile1,
+				c -> Boolean.TRUE);
+		LanguageServerWrapper wrapper1 = wrappers.iterator().next();
+		assertTrue(wrapper1.isActive());
+
+		PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().closeAllEditors(false);
+		new LSDisplayHelper(() -> !MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		project.delete(true, true, new NullProgressMonitor());
+
+		project = TestUtils.createProject("LanguageServiceAccessorTest2" + System.currentTimeMillis());
+		IFile testFile2 = TestUtils.createUniqueTestFile(project, "");
+
+		TestUtils.openEditor(testFile2);
+		LanguageServiceAccessor.getInitializedLanguageServers(testFile2, capabilities -> Boolean.TRUE).iterator()
+				.next();
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		wrappers = LanguageServiceAccessor.getLSWrappers(testFile2, c -> Boolean.TRUE);
+		LanguageServerWrapper wrapper2 = wrappers.iterator().next();
+		assertTrue(wrapper2.isActive());
+
+		// See corresponding LanguageServiceAccessorTest.testCreateNewLSAfterInitialProjectGotDeleted() - if WorkspaceFolders capability present 
+		// then can recycle the wrapper/server, otherwise a new one gets created
+		assertTrue(wrapper1 == wrapper2);
+	}
+
+	@Test
+	public void testPojectCreate() throws Exception {
+		IFile testFile1 = TestUtils.createUniqueTestFile(project, "");
+
+		TestUtils.openEditor(testFile1);
+		LanguageServiceAccessor.getInitializedLanguageServers(testFile1, capabilities -> Boolean.TRUE).iterator()
+				.next();
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		Collection<LanguageServerWrapper> wrappers = LanguageServiceAccessor.getLSWrappers(testFile1,
+				c -> Boolean.TRUE);
+		LanguageServerWrapper wrapper1 = wrappers.iterator().next();
+		assertTrue(wrapper1.isActive());
+
+		PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().closeAllEditors(false);
+		new LSDisplayHelper(() -> !MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		final MockWorkspaceService mockWorkspaceService = MockLanguageServer.INSTANCE.getWorkspaceService();
+		final List<DidChangeWorkspaceFoldersParams> events = mockWorkspaceService.getWorkspaceFoldersEvents();
+		assertEquals(1, events.size());
+		final List<WorkspaceFolder> added = events.get(0).getEvent().getAdded();
+		assertEquals(1, added.size());
+		assertEquals(new File(project.getLocationURI()), new File(new URI(added.get(0).getUri()).normalize()));
+	}
+
+	@Test
+	public void testProjectClose() throws Exception {
+		IFile testFile1 = TestUtils.createUniqueTestFile(project, "");
+
+		TestUtils.openEditor(testFile1);
+		LanguageServiceAccessor.getInitializedLanguageServers(testFile1, capabilities -> Boolean.TRUE).iterator()
+				.next();
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		final JobSynchronizer synchronizer = new JobSynchronizer();
+		project.close(synchronizer);
+		synchronizer.await();
+
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.getWorkspaceService().getWorkspaceFoldersEvents().size() == 2).waitForCondition(Display.getCurrent(), 5000,
+				300);
+		final MockWorkspaceService mockWorkspaceService = MockLanguageServer.INSTANCE.getWorkspaceService();
+		final List<DidChangeWorkspaceFoldersParams> events = mockWorkspaceService.getWorkspaceFoldersEvents();
+		assertEquals(2, events.size());
+		final List<WorkspaceFolder> removed = events.get(1).getEvent().getRemoved();
+		assertEquals(1, removed.size());
+		assertEquals(new File(project.getLocationURI()), new File(new URI(removed.get(0).getUri())));
+	}
+
+	@Test
+	public void testProjectDelete() throws Exception {
+		IFile testFile1 = TestUtils.createUniqueTestFile(project, "");
+
+		TestUtils.openEditor(testFile1);
+		LanguageServiceAccessor.getInitializedLanguageServers(testFile1, capabilities -> Boolean.TRUE).iterator()
+				.next();
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		Collection<LanguageServerWrapper> wrappers = LanguageServiceAccessor.getLSWrappers(testFile1,
+				c -> Boolean.TRUE);
+		LanguageServerWrapper wrapper1 = wrappers.iterator().next();
+		assertTrue(wrapper1.isActive());
+
+		// Grab this before deletion otherwise project.getLocationURI will be null...
+		final File expected = new File(project.getLocationURI());
+		final JobSynchronizer synchronizer = new JobSynchronizer();
+		project.delete(true, true, synchronizer);
+		synchronizer.await();
+		final MockWorkspaceService mockWorkspaceService = MockLanguageServer.INSTANCE.getWorkspaceService();
+		final List<DidChangeWorkspaceFoldersParams> events = mockWorkspaceService.getWorkspaceFoldersEvents();
+		assertEquals(2, events.size());
+		final List<WorkspaceFolder> removed = events.get(1).getEvent().getRemoved();
+		assertEquals(1, removed.size());
+
+		// Compare files to bodge round URI canonicalization problems
+		assertEquals(expected, new File(new URI(removed.get(0).getUri())));
+	}
+
+	public void projectReopenTest() throws Exception {
+		IFile testFile1 = TestUtils.createUniqueTestFile(project, "");
+
+		TestUtils.openEditor(testFile1);
+		LanguageServiceAccessor.getInitializedLanguageServers(testFile1, capabilities -> Boolean.TRUE).iterator()
+				.next();
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.isRunning()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		final JobSynchronizer synchronizer = new JobSynchronizer();
+		project.close(synchronizer);
+		synchronizer.await();
+
+		new LSDisplayHelper(() -> !project.isOpen()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		final JobSynchronizer synchronizer2 = new JobSynchronizer();
+		project.open(synchronizer2);
+		synchronizer2.await();
+
+		new LSDisplayHelper(() -> project.isOpen()).waitForCondition(Display.getCurrent(), 5000,
+				300);
+
+		new LSDisplayHelper(() -> MockLanguageServer.INSTANCE.getWorkspaceService().getWorkspaceFoldersEvents().size() == 3).waitForCondition(Display.getCurrent(), 5000,
+				300);
+		final MockWorkspaceService mockWorkspaceService = MockLanguageServer.INSTANCE.getWorkspaceService();
+		final List<DidChangeWorkspaceFoldersParams> events = mockWorkspaceService.getWorkspaceFoldersEvents();
+		final List<WorkspaceFolder> added = events.get(2).getEvent().getAdded();
+		assertEquals(1, added.size());
+		assertEquals(new File(project.getLocationURI()), new File(new URI(added.get(0).getUri())));
+	}
+
+	@Override
+	public ServerCapabilities get() {
+		// Enable workspace folders on the mock server (for this test only)
+		final ServerCapabilities base = MockLanguageServer.defaultServerCapabilities();
+
+		final WorkspaceServerCapabilities wsc = new WorkspaceServerCapabilities();
+		final WorkspaceFoldersOptions wso = new WorkspaceFoldersOptions();
+		wso.setSupported(true);
+		wso.setChangeNotifications(true);
+		wsc.setWorkspaceFolders(wso);
+		base.setWorkspace(wsc);
+		return base;
+	}
+
+}