Use openExternalProject to keep project live in tsserver

The server can now correctly handle files that are not open, including
finding references, etc.
The performance should also be better, since the project is not
recreated on the server each time the "first" file is opened.

Closes angelozerr#142

Author: lorenzodallavecchia

core/ts.core/src/ts/client/CommandNames.java

@@ -7,6 +7,7 @@
  *
  *  Contributors:
  *  Angelo Zerr <[email protected]> - initial API and implementation
+ *  Lorenzo Dalla Vecchia <[email protected]> - openExternalProject
  */
 package ts.client;
 
@@ -36,6 +37,7 @@ public enum CommandNames {
 	Configure("configure"),
 	ProjectInfo("projectInfo"),
 	Rename("rename"),
+	OpenExternalProject("openExternalProject"),
 
 	// 2.0.3
 	SemanticDiagnosticsSync("semanticDiagnosticsSync", "2.0.3"), 

core/ts.core/src/ts/client/ITypeScriptServiceClient.java

@@ -7,7 +7,7 @@
  *
  *  Contributors:
  *  Angelo Zerr <[email protected]> - initial API and implementation
- *  Lorenzo Dalla Vecchia <[email protected]> - adjusted usage of CompletableFuture
+ *  Lorenzo Dalla Vecchia <[email protected]> - adjusted usage of CompletableFuture, openExternalProject
  */
 package ts.client;
 
@@ -198,6 +198,16 @@ CompletableFuture<RenameResponseBody> rename(String file, int line, int offset,
 
 	CompletableFuture<ProjectInfo> projectInfo(String file, String projectFileName, boolean needFileNameList);
 
+	/**
+	 * Defines a TypeScript project that is "handled by the client" and
+	 * therefore never closed automatically by the server.
+	 * 
+	 * @param projectFileName
+	 * @param rootFileNames
+	 * @return
+	 */
+	CompletableFuture<Void> openExternalProject(String projectFileName, List<String> rootFileNames);
+
 	// Since 2.0.3
 
 	/**

core/ts.core/src/ts/client/TypeScriptServiceClient.java

@@ -7,7 +7,7 @@
  *
  *  Contributors:
  *  Angelo Zerr <[email protected]> - initial API and implementation
- *  Lorenzo Dalla Vecchia <[email protected]> - adjusted usage of CompletableFuture, added required requests
+ *  Lorenzo Dalla Vecchia <[email protected]> - adjusted usage of CompletableFuture, added required requests, openExternalProject
  */
 package ts.client;
 
@@ -72,6 +72,7 @@
 import ts.internal.client.protocol.NavBarRequest;
 import ts.internal.client.protocol.NavTreeRequest;
 import ts.internal.client.protocol.OccurrencesRequest;
+import ts.internal.client.protocol.OpenExternalProjectRequest;
 import ts.internal.client.protocol.OpenRequest;
 import ts.internal.client.protocol.ProjectInfoRequest;
 import ts.internal.client.protocol.QuickInfoRequest;
@@ -230,7 +231,10 @@ private void dispatchMessage(String message) {
 					// message " + json);
 					return;
 				}
-				Response responseMessage = pendingRequestInfo.requestMessage.parseResponse(json);
+				Response<?> responseMessage = pendingRequestInfo.requestMessage.parseResponse(json);
+				if (responseMessage == null) {
+					responseMessage = GsonHelper.DEFAULT_GSON.fromJson(json, Response.class);
+				}
 				try {
 					handleResponse(responseMessage, message, pendingRequestInfo.startTime);
 					pendingRequestInfo.responseHandler.accept(responseMessage);
@@ -414,6 +418,11 @@ public CompletableFuture<ProjectInfo> projectInfo(String file, String projectFil
 		return execute(new ProjectInfoRequest(file, needFileNameList));
 	}
 
+	@Override
+	public CompletableFuture<Void> openExternalProject(String projectFileName, List<String> rootFileNames) {
+		return executeCausingWait(new OpenExternalProjectRequest(projectFileName, rootFileNames));
+	}
+
 	// Since 2.0.3
 
 	@Override

core/ts.core/src/ts/client/external/ExternalFile.java

@@ -0,0 +1,30 @@
+/**
+ *  Copyright (c) 2015-2017 Angelo ZERR.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  Contributors:
+ *  Lorenzo Dalla Vecchia <[email protected]> - initial API and implementation
+ */
+package ts.client.external;
+
+/**
+ * Represents a file in external project.
+ */
+public class ExternalFile {
+	/**
+	 * Name of file
+	 */
+	private String fileName;
+
+	public ExternalFile(String fileName) {
+		this.fileName = fileName;
+	}
+
+	public String getFileName() {
+		return fileName;
+	}
+
+}

core/ts.core/src/ts/client/external/ExternalProject.java

@@ -0,0 +1,51 @@
+/**
+ *  Copyright (c) 2015-2017 Angelo ZERR.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  Contributors:
+ *  Lorenzo Dalla Vecchia <[email protected]> - initial API and implementation
+ */
+package ts.client.external;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Represents an external project
+ */
+public class ExternalProject {
+	/**
+	 * Project name
+	 */
+	private String projectFileName;
+	/**
+	 * List of root files in project
+	 */
+	private List<ExternalFile> rootFiles;
+	/**
+	 * Compiler options for the project
+	 */
+	private ExternalProjectCompilerOptions options;
+
+	public ExternalProject(String projectFileName, List<ExternalFile> rootFiles) {
+		this.projectFileName = projectFileName;
+		this.rootFiles = new ArrayList<ExternalFile>(rootFiles);
+	}
+
+	public String getProjectFileName() {
+		return projectFileName;
+	}
+
+	public List<ExternalFile> getRootFiles() {
+		return Collections.unmodifiableList(rootFiles);
+	}
+
+	public ExternalProjectCompilerOptions getOptions() {
+		return options;
+	}
+
+}

core/ts.core/src/ts/client/external/ExternalProjectCompilerOptions.java

@@ -0,0 +1,19 @@
+/**
+ *  Copyright (c) 2015-2017 Angelo ZERR.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  Contributors:
+ *  Lorenzo Dalla Vecchia <[email protected]> - initial API and implementation
+ */
+package ts.client.external;
+
+/**
+ * For external projects, some of the project settings are sent together with
+ * compiler settings.
+ */
+public class ExternalProjectCompilerOptions {
+
+}

core/ts.core/src/ts/internal/client/protocol/OpenExternalProjectRequest.java

@@ -0,0 +1,43 @@
+/**
+ *  Copyright (c) 2015-2017 Angelo ZERR.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  Contributors:
+ *  Lorenzo Dalla Vecchia <[email protected]> - initial API and implementation
+ */
+package ts.internal.client.protocol;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import com.google.gson.JsonObject;
+
+import ts.client.CommandNames;
+import ts.client.external.ExternalFile;
+import ts.client.external.ExternalProject;
+
+/**
+ * A request to open or update external project.
+ * 
+ * @see https://github.com/Microsoft/TypeScript/blob/master/src/server/protocol.ts
+ */
+public class OpenExternalProjectRequest extends Request<ExternalProject> {
+
+	public OpenExternalProjectRequest(String projectFileName, List<String> rootFileNames) {
+		super(CommandNames.OpenExternalProject.getName(),
+				new ExternalProject(projectFileName, createExternalFileList(rootFileNames)));
+	}
+
+	private static List<ExternalFile> createExternalFileList(List<String> fileNames) {
+		return fileNames.stream().map(ExternalFile::new).collect(Collectors.toList());
+	}
+
+	@Override
+	public Response<Boolean> parseResponse(JsonObject json) {
+		return GsonHelper.DEFAULT_GSON.fromJson(json, OpenExternalProjectResponse.class);
+	}
+
+}

core/ts.core/src/ts/internal/client/protocol/OpenExternalProjectResponse.java

@@ -0,0 +1,21 @@
+/**
+ *  Copyright (c) 2015-2017 Angelo ZERR.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  Contributors:
+ *  Lorenzo Dalla Vecchia <[email protected]> - initial API and implementation
+ */
+package ts.internal.client.protocol;
+
+/**
+ * Response to OpenExternalProjectRequest request. This is just an
+ * acknowledgement, so no body field is required.
+ * 
+ * @see https://github.com/Microsoft/TypeScript/blob/master/src/server/protocol.ts
+ */
+public class OpenExternalProjectResponse extends Response<Boolean> {
+
+}

core/ts.core/src/ts/resources/TypeScriptProject.java

@@ -7,11 +7,13 @@
  *
  *  Contributors:
  *  Angelo Zerr <[email protected]> - initial API and implementation
+ *  Lorenzo Dalla Vecchia <[email protected]> - openExternalProject
  */
 package ts.resources;
 
 import java.io.File;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -85,6 +87,20 @@ public File getProjectDir() {
 		return projectDir;
 	}
 
+	/**
+	 * Gets the paths of the tsconfig.json files to take into account for this
+	 * project. This is called each time a new server is started for this
+	 * project.
+	 * <p>
+	 * The default implementation returns an empty list.
+	 * 
+	 * @return tsconfigFilePaths list of tsconfig.json paths, relative to the
+	 *         project directory.
+	 */
+	protected List<String> getTsconfigFilePaths() {
+		return Collections.emptyList();
+	}
+
 	void openFile(ITypeScriptFile tsFile) throws TypeScriptException {
 		String name = tsFile.getName();
 		String contents = tsFile.getContents();
@@ -134,13 +150,20 @@ public final ITypeScriptServiceClient getClient() throws TypeScriptException {
 					this.client = createServiceClient(getProjectDir());
 					copyListeners();
 					onCreateClient(client);
+					// determine root files and project name
+					String projectName = projectDir.getCanonicalPath();
+					List<String> rootFiles = new ArrayList<>();
+					for (String tsconfigFilePath : getTsconfigFilePaths()) {
+						rootFiles.add(new File(projectDir, tsconfigFilePath).getCanonicalPath());
+					}
+					// opens or updates the external project
+					client.openExternalProject(projectName, rootFiles);
 				} catch (Exception e) {
 					if (e instanceof TypeScriptException) {
 						throw (TypeScriptException) e;
 					}
 					throw new TypeScriptException(e);
 				}
-
 			}
 			return client;
 		}

eclipse/ts.eclipse.ide.core/src/ts/eclipse/ide/internal/core/resources/IDETypeScriptProject.java

@@ -7,6 +7,7 @@
  *
  *  Contributors:
  *  Angelo Zerr <[email protected]> - initial API and implementation
+ *  Lorenzo Dalla Vecchia <[email protected]> - openExternalProject
  */
 package ts.eclipse.ide.internal.core.resources;
 
@@ -351,6 +352,17 @@ public void disposeBuildPath() {
 		IDEResourcesManager.getInstance().fireBuildPathChanged(this, oldBuildPath, newBuildPath);
 	}
 
+	@Override
+	protected List<String> getTsconfigFilePaths() {
+		ITsconfigBuildPath[] tsconfigBuildPaths = getTypeScriptBuildPath().getTsconfigBuildPaths();
+		List<String> result = new ArrayList<>(tsconfigBuildPaths.length);
+		for (ITsconfigBuildPath tsconfigBuildPath : tsconfigBuildPaths) {
+			IFile tsconfigFile = tsconfigBuildPath.getTsconfigFile();
+			result.add(tsconfigFile.getLocation().makeRelativeTo(tsconfigFile.getProject().getLocation()).toString());
+		}
+		return result;
+	}
+
 	@Override
 	public IIDETypeScriptCompiler getCompiler() throws TypeScriptException {
 		return (IIDETypeScriptCompiler) super.getCompiler();