Display install @types telemetry in an Eclipse console. See

#116

Author: angelozerr

core/ts.core/META-INF/MANIFEST.MF

@@ -18,6 +18,7 @@ Export-Package: ts,
  ts.client.configure,
  ts.client.diagnostics,
  ts.client.format,
+ ts.client.installtypes,
  ts.client.navbar,
  ts.client.occurrences,
  ts.client.projectinfo,

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

@@ -22,6 +22,7 @@
 import ts.client.configure.ConfigureRequestArguments;
 import ts.client.diagnostics.DiagnosticEvent;
 import ts.client.diagnostics.DiagnosticEventBody;
+import ts.client.installtypes.IInstallTypesListener;
 import ts.client.navbar.NavigationBarItem;
 import ts.client.occurrences.OccurrencesResponseItem;
 import ts.client.projectinfo.ProjectInfo;
@@ -264,6 +265,10 @@ CompletableFuture<List<CodeAction>> getCodeFixes(String fileName, IPositionProvi
 
 	void removeClientListener(ITypeScriptClientListener listener);
 
+	void addInstallTypesListener(IInstallTypesListener listener);
+
+	void removeInstallTypesListener(IInstallTypesListener listener);
+
 	void addInterceptor(IInterceptor interceptor);
 
 	void removeInterceptor(IInterceptor interceptor);

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

@@ -35,6 +35,9 @@
 import ts.client.diagnostics.Diagnostic;
 import ts.client.diagnostics.DiagnosticEvent;
 import ts.client.diagnostics.DiagnosticEventBody;
+import ts.client.installtypes.BeginInstallTypesEventBody;
+import ts.client.installtypes.EndInstallTypesEventBody;
+import ts.client.installtypes.IInstallTypesListener;
 import ts.client.navbar.NavigationBarItem;
 import ts.client.occurrences.OccurrencesResponseItem;
 import ts.client.projectinfo.ProjectInfo;
@@ -78,7 +81,6 @@
 import ts.nodejs.INodejsProcessListener;
 import ts.nodejs.NodejsProcessAdapter;
 import ts.nodejs.NodejsProcessManager;
-import ts.utils.FileUtils;
 
 /**
  * TypeScript service client implementation.
@@ -92,6 +94,7 @@ public class TypeScriptServiceClient implements ITypeScriptServiceClient {
 	private INodejsProcess process;
 	private List<INodejsProcessListener> nodeListeners;
 	private final List<ITypeScriptClientListener> listeners;
+	private final List<IInstallTypesListener> installTypesListener;
 	private final ReentrantReadWriteLock stateLock;
 	private boolean dispose;
 
@@ -147,21 +150,30 @@ private static class PendingRequestEventInfo {
 	}
 
 	public TypeScriptServiceClient(final File projectDir, File tsserverFile, File nodeFile) throws TypeScriptException {
+		this(projectDir, tsserverFile, nodeFile, false);
+	}
+
+	public TypeScriptServiceClient(final File projectDir, File tsserverFile, File nodeFile, boolean enableTelemetry)
+			throws TypeScriptException {
 		this(NodejsProcessManager.getInstance().create(projectDir, tsserverFile, nodeFile,
 				new INodejsLaunchConfiguration() {
 
 					@Override
 					public List<String> createNodeArgs() {
 						List<String> args = new ArrayList<String>();
-						args.add("-p");
-						args.add(FileUtils.getPath(projectDir));
+						// args.add("-p");
+						// args.add(FileUtils.getPath(projectDir));
+						if (enableTelemetry) {
+							args.add("--enableTelemetry");
+						}
 						return args;
 					}
 				}, TSSERVER_FILE_TYPE));
 	}
 
 	public TypeScriptServiceClient(INodejsProcess process) {
 		this.listeners = new ArrayList<>();
+		this.installTypesListener = new ArrayList<>();
 		this.stateLock = new ReentrantReadWriteLock();
 		this.dispose = false;
 		this.sentRequestMap = new LinkedHashMap<>();
@@ -212,6 +224,27 @@ private void dispatchMessage(String message) {
 					if (pendingRequestEventInfo != null) {
 						pendingRequestEventInfo.eventHandler.accept(response);
 					}
+				} else if ("telemetry".equals(event)) {
+					// TelemetryEventBody telemetryData =
+					// GsonHelper.DEFAULT_GSON.fromJson(json,
+					// TelemetryEvent.class)
+					// .getBody();
+					//
+					JsonObject telemetryData = json.get("body").getAsJsonObject();
+					JsonObject payload = telemetryData.has("payload") ? telemetryData.get("payload").getAsJsonObject()
+							: null;
+					if (payload != null) {
+						String telemetryEventName = telemetryData.get("telemetryEventName").getAsString();
+						fireLogTelemetry(telemetryEventName, payload);
+					}
+				} else if ("beginInstallTypes".equals(event)) {
+					BeginInstallTypesEventBody data = GsonHelper.DEFAULT_GSON.fromJson(json,
+							BeginInstallTypesEventBody.class);
+					fireBeginInstallTypes(data);
+				} else if ("endInstallTypes".equals(event)) {
+					EndInstallTypesEventBody data = GsonHelper.DEFAULT_GSON.fromJson(json,
+							EndInstallTypesEventBody.class);
+					fireEndInstallTypes(data);
 				}
 				break;
 			default:
@@ -320,8 +353,8 @@ public CompletableFuture<List<DiagnosticEvent>> geterr(String[] files, int delay
 	}
 
 	@Override
-	public CompletableFuture<List<DiagnosticEvent>> geterrForProject(String file, int delay,
-			ProjectInfo projectInfo) throws TypeScriptException {
+	public CompletableFuture<List<DiagnosticEvent>> geterrForProject(String file, int delay, ProjectInfo projectInfo)
+			throws TypeScriptException {
 		return execute(new GeterrForProjectRequest(file, delay, projectInfo), true);
 	}
 
@@ -381,13 +414,14 @@ public CompletableFuture<DiagnosticEventBody> syntacticDiagnosticsSync(String fi
 	// Since 2.0.5
 
 	@Override
-	public CompletableFuture<Boolean> compileOnSaveEmitFile(String fileName, Boolean forced) throws TypeScriptException {
+	public CompletableFuture<Boolean> compileOnSaveEmitFile(String fileName, Boolean forced)
+			throws TypeScriptException {
 		return execute(new CompileOnSaveEmitFileRequest(fileName, forced), true);
 	}
-	
+
 	@Override
-	public CompletableFuture<List<CompileOnSaveAffectedFileListSingleProject>> compileOnSaveAffectedFileList(String fileName)
-			throws TypeScriptException {
+	public CompletableFuture<List<CompileOnSaveAffectedFileListSingleProject>> compileOnSaveAffectedFileList(
+			String fileName) throws TypeScriptException {
 		return execute(new CompileOnSaveAffectedFileListRequest(fileName), true);
 	}
 
@@ -497,22 +531,60 @@ public void removeClientListener(ITypeScriptClientListener listener) {
 		}
 	}
 
-	protected void fireStartServer() {
+	private void fireStartServer() {
 		synchronized (listeners) {
 			for (ITypeScriptClientListener listener : listeners) {
 				listener.onStart(this);
 			}
 		}
 	}
 
-	protected void fireEndServer() {
+	private void fireEndServer() {
 		synchronized (listeners) {
 			for (ITypeScriptClientListener listener : listeners) {
 				listener.onStop(this);
 			}
 		}
 	}
 
+	@Override
+	public void addInstallTypesListener(IInstallTypesListener listener) {
+		synchronized (installTypesListener) {
+			installTypesListener.add(listener);
+		}
+	}
+
+	@Override
+	public void removeInstallTypesListener(IInstallTypesListener listener) {
+		synchronized (installTypesListener) {
+			installTypesListener.remove(listener);
+		}
+	}
+
+	private void fireBeginInstallTypes(BeginInstallTypesEventBody body) {
+		synchronized (installTypesListener) {
+			for (IInstallTypesListener listener : installTypesListener) {
+				listener.onBegin(body);
+			}
+		}
+	}
+
+	private void fireEndInstallTypes(EndInstallTypesEventBody body) {
+		synchronized (installTypesListener) {
+			for (IInstallTypesListener listener : installTypesListener) {
+				listener.onEnd(body);
+			}
+		}
+	}
+
+	private void fireLogTelemetry(String telemetryEventName, JsonObject payload) {
+		synchronized (installTypesListener) {
+			for (IInstallTypesListener listener : installTypesListener) {
+				listener.logTelemetry(telemetryEventName, payload);
+			}
+		}
+	}
+
 	@Override
 	public void addInterceptor(IInterceptor interceptor) {
 		beginWriteState();

core/ts.core/src/ts/client/installtypes/BeginInstallTypesEventBody.java

@@ -0,0 +1,5 @@
+package ts.client.installtypes;
+
+public class BeginInstallTypesEventBody extends InstallTypesEventBody {
+
+}

core/ts.core/src/ts/client/installtypes/EndInstallTypesEventBody.java

@@ -0,0 +1,13 @@
+package ts.client.installtypes;
+
+public class EndInstallTypesEventBody extends InstallTypesEventBody {
+
+	/**
+	 * true if installation succeeded, otherwise false
+	 */
+	private boolean success;
+
+	public boolean isSuccess() {
+		return success;
+	}
+}

core/ts.core/src/ts/client/installtypes/IInstallTypesListener.java

@@ -0,0 +1,13 @@
+package ts.client.installtypes;
+
+import com.google.gson.JsonObject;
+
+public interface IInstallTypesListener {
+
+	void onBegin(BeginInstallTypesEventBody body);
+
+	void logTelemetry(String telemetryEventName, JsonObject payload);
+
+	void onEnd(EndInstallTypesEventBody body);
+
+}

core/ts.core/src/ts/client/installtypes/InstallTypesEventBody.java

@@ -0,0 +1,24 @@
+package ts.client.installtypes;
+
+import java.util.List;
+
+public class InstallTypesEventBody {
+
+	/**
+	 * correlation id to match begin and end events
+	 */
+	int eventId;
+	
+	/**
+	 * list of packages to install
+	 */
+	List<String> packages;
+
+	public int getEventId() {
+		return eventId;
+	}
+
+	public List<String> getPackages() {
+		return packages;
+	}
+}

core/ts.core/src/ts/internal/client/protocol/installtypes/BeginInstallTypesEvent.java

@@ -0,0 +1,8 @@
+package ts.internal.client.protocol.installtypes;
+
+import ts.client.Event;
+import ts.client.installtypes.BeginInstallTypesEventBody;
+
+public class BeginInstallTypesEvent extends Event<BeginInstallTypesEventBody>{
+
+}

core/ts.core/src/ts/internal/client/protocol/installtypes/EndInstallTypesEvent.java

@@ -0,0 +1,8 @@
+package ts.internal.client.protocol.installtypes;
+
+import ts.client.Event;
+import ts.client.installtypes.EndInstallTypesEventBody;
+
+public class EndInstallTypesEvent extends Event<EndInstallTypesEventBody>{
+
+}

core/ts.core/src/ts/internal/client/protocol/installtypes/TelemetryEvent.java

@@ -0,0 +1,7 @@
+package ts.internal.client.protocol.installtypes;
+
+import ts.client.Event;
+
+public class TelemetryEvent extends Event<TelemetryEventBody>{
+
+}

core/ts.core/src/ts/internal/client/protocol/installtypes/TelemetryEventBody.java

@@ -0,0 +1,16 @@
+package ts.internal.client.protocol.installtypes;
+
+public class TelemetryEventBody {
+
+	private String telemetryEventName;
+	
+	private Object paylod;
+	
+	public String getTelemetryEventName() {
+		return telemetryEventName;
+	}
+	
+	public Object getPaylod() {
+		return paylod;
+	}
+}

core/ts.core/src/ts/internal/client/protocol/installtypes/TypingsInstalledTelemetryEventBody.java

@@ -0,0 +1,5 @@
+package ts.internal.client.protocol.installtypes;
+
+public class TypingsInstalledTelemetryEventBody extends TelemetryEventBody{
+
+}

core/ts.core/src/ts/internal/client/protocol/installtypes/TypingsInstalledTelemetryEventPayload.java

@@ -0,0 +1,30 @@
+package ts.internal.client.protocol.installtypes;
+
+public class TypingsInstalledTelemetryEventPayload {
+
+	/**
+	 * Comma separated list of installed typing packages
+	 */
+	private String installedPackages;
+	/**
+	 * true if install request succeeded, otherwise - false
+	 */
+	private boolean installSuccess;
+
+	/**
+	 * version of typings installer
+	 */
+	private String typingsInstallerVersion;
+
+	public String getInstalledPackages() {
+		return installedPackages;
+	}
+
+	public boolean isInstallSuccess() {
+		return installSuccess;
+	}
+
+	public String getTypingsInstallerVersion() {
+		return typingsInstallerVersion;
+	}
+}

core/ts.core/src/ts/resources/BasicTypeScriptProjectSettings.java

@@ -32,6 +32,7 @@ public class BasicTypeScriptProjectSettings implements ITypeScriptProjectSetting
 	private final ITypeScriptRepository repository;
 	private ICompletionEntryMatcher completionEntryMatcher;
 	private TslintSettingsStrategy tslintStrategy;
+	private boolean enableTelemetry;
 
 	public BasicTypeScriptProjectSettings(File nodejsInstallPath, File typeScriptDir)
 			throws TypeScriptRepositoryException {
@@ -119,4 +120,13 @@ public FormatCodeSettings getFormatOptions() {
 	public String getTypeScriptVersion() {
 		return repository.getTypesScriptVersion();
 	}
+
+	@Override
+	public boolean isEnableTelemetry() {
+		return enableTelemetry;
+	}
+
+	public void setEnableTelemetry(boolean enableTelemetry) {
+		this.enableTelemetry = enableTelemetry;
+	}
 }

core/ts.core/src/ts/resources/ITypeScriptProjectSettings.java

@@ -94,4 +94,10 @@ public interface ITypeScriptProjectSettings {
 
 	FormatCodeSettings getFormatOptions();
 
+	/**
+	 * Returns true if telemetry must be enable and false otherwise.
+	 * 
+	 * @return true if telemetry must be enable and false otherwise.
+	 */
+	boolean isEnableTelemetry();
 }