Merge pull request #3518 from NativeScript/vladimirov/getting-started-analytics-2

rosen-vladimirov · web-flow · commit 16248fed2069 · 2018-04-04T21:06:53.000+03:00
feat: Improve Getting started - add analytics
diff --git a/lib/commands/run.ts b/lib/commands/run.ts
@@ -28,7 +28,7 @@ export class RunCommandBase implements ICommand {
 			this.platform = this.$devicePlatformsConstants.Android;
 		}
 
-		this.$liveSyncCommandHelper.validatePlatform(this.platform);
+		await this.$liveSyncCommandHelper.validatePlatform(this.platform);
 
 		return true;
 	}
diff --git a/lib/constants.ts b/lib/constants.ts
@@ -135,7 +135,10 @@ export const enum TrackActionNames {
 	CreateProject = "Create project",
 	Debug = "Debug",
 	Deploy = "Deploy",
-	LiveSync = "LiveSync"
+	LiveSync = "LiveSync",
+	RunSetupScript = "Run Setup Script",
+	CheckLocalBuildSetup = "Check Local Build Setup",
+	CheckEnvironmentRequirements = "Check Environment Requirements"
 }
 
 export const enum BuildStates {
diff --git a/lib/definitions/platform.d.ts b/lib/definitions/platform.d.ts
@@ -381,5 +381,5 @@ interface IUpdateAppOptions extends IOptionalFilesToSync, IOptionalFilesToRemove
 }
 
 interface IPlatformEnvironmentRequirements {
-	checkEnvironmentRequirements(platform: string): Promise<boolean>;
+	checkEnvironmentRequirements(platform?: string): Promise<boolean>;
 }
diff --git a/lib/services/analytics/analytics-service.ts b/lib/services/analytics/analytics-service.ts
@@ -73,7 +73,7 @@ export class AnalyticsService extends AnalyticsServiceBase {
 
 		// In some cases (like in case action is Build and platform is Android), we do not know if the deviceType is emulator or device.
 		// Just exclude the device_type in this case.
-		if (isForDevice !== null) {
+		if (isForDevice !== null && isForDevice !== undefined) {
 			const deviceType = isForDevice ? DeviceTypes.Device : (this.$mobileHelper.isAndroidPlatform(platform) ? DeviceTypes.Emulator : DeviceTypes.Simulator);
 			label = this.addDataToLabel(label, deviceType);
 		}
diff --git a/lib/services/analytics/google-analytics-provider.ts b/lib/services/analytics/google-analytics-provider.ts
@@ -4,7 +4,6 @@ import { AnalyticsClients } from "../../common/constants";
 
 export class GoogleAnalyticsProvider implements IGoogleAnalyticsProvider {
 	private static GA_TRACKING_ID = "UA-111455-44";
-	private static GA_CROSS_CLIENT_TRACKING_ID = "UA-111455-51";
 	private currentPage: string;
 
 	constructor(private clientId: string,
@@ -15,15 +14,12 @@ export class GoogleAnalyticsProvider implements IGoogleAnalyticsProvider {
 	}
 
 	public async trackHit(trackInfo: IGoogleAnalyticsData): Promise<void> {
-		const trackingIds = [GoogleAnalyticsProvider.GA_TRACKING_ID, GoogleAnalyticsProvider.GA_CROSS_CLIENT_TRACKING_ID];
 		const sessionId = uuid.v4();
 
-		for (const gaTrackingId of trackingIds) {
-			try {
-				await this.track(gaTrackingId, trackInfo, sessionId);
-			} catch (e) {
-				this.$logger.trace("Analytics exception: ", e);
-			}
+		try {
+			await this.track(GoogleAnalyticsProvider.GA_TRACKING_ID, trackInfo, sessionId);
+		} catch (e) {
+			this.$logger.trace("Analytics exception: ", e);
 		}
 	}
 
@@ -41,14 +37,7 @@ export class GoogleAnalyticsProvider implements IGoogleAnalyticsProvider {
 			}
 		});
 
-		switch (gaTrackingId) {
-			case GoogleAnalyticsProvider.GA_CROSS_CLIENT_TRACKING_ID:
-				this.setCrossClientCustomDimensions(visitor, sessionId);
-				break;
-			default:
-				await this.setCustomDimensions(visitor, trackInfo.customDimensions, sessionId);
-				break;
-		}
+		await this.setCustomDimensions(visitor, trackInfo.customDimensions, sessionId);
 
 		switch (trackInfo.googleAnalyticsDataType) {
 			case GoogleAnalyticsDataType.Page:
@@ -83,18 +72,6 @@ export class GoogleAnalyticsProvider implements IGoogleAnalyticsProvider {
 		});
 	}
 
-	private async setCrossClientCustomDimensions(visitor: ua.Visitor, sessionId: string): Promise<void> {
-		const customDimensions: IStringDictionary = {
-			[GoogleAnalyticsCrossClientCustomDimensions.sessionId]: sessionId,
-			[GoogleAnalyticsCrossClientCustomDimensions.clientId]: this.clientId,
-			[GoogleAnalyticsCrossClientCustomDimensions.crossClientId]: this.clientId,
-		};
-
-		_.each(customDimensions, (value, key) => {
-			visitor.set(key, value);
-		});
-	}
-
 	private trackEvent(visitor: ua.Visitor, trackInfo: IGoogleAnalyticsEventData): Promise<void> {
 		return new Promise<void>((resolve, reject) => {
 			visitor.event(trackInfo.category, trackInfo.action, trackInfo.label, trackInfo.value, { p: this.currentPage }, (err: Error) => {
diff --git a/lib/services/doctor-service.ts b/lib/services/doctor-service.ts
@@ -1,22 +1,19 @@
 import { EOL } from "os";
 import * as path from "path";
 import * as helpers from "../common/helpers";
+import { TrackActionNames } from "../constants";
 import { doctor, constants } from "nativescript-doctor";
 
 class DoctorService implements IDoctorService {
 	private static DarwinSetupScriptLocation = path.join(__dirname, "..", "..", "setup", "mac-startup-shell-script.sh");
-	private static DarwinSetupDocsLink = "https://docs.nativescript.org/start/ns-setup-os-x";
 	private static WindowsSetupScriptExecutable = "powershell.exe";
 	private static WindowsSetupScriptArguments = ["start-process", "-FilePath", "PowerShell.exe", "-NoNewWindow", "-Wait", "-ArgumentList", '"-NoProfile -ExecutionPolicy Bypass -Command iex ((new-object net.webclient).DownloadString(\'https://www.nativescript.org/setup/win\'))"'];
-	private static WindowsSetupDocsLink = "https://docs.nativescript.org/start/ns-setup-win";
-	private static LinuxSetupDocsLink = "https://docs.nativescript.org/start/ns-setup-linux";
 
 	constructor(private $analyticsService: IAnalyticsService,
 		private $hostInfo: IHostInfo,
 		private $logger: ILogger,
 		private $childProcess: IChildProcess,
-		private $opener: IOpener,
-		private $prompter: IPrompter,
+		private $injector: IInjector,
 		private $terminalSpinnerService: ITerminalSpinnerService,
 		private $versionsService: IVersionsService) { }
 
@@ -41,7 +38,6 @@ class DoctorService implements IDoctorService {
 
 		if (hasWarnings) {
 			this.$logger.info("There seem to be issues with your configuration.");
-			await this.promptForHelp();
 		} else {
 			this.$logger.out("No issues were detected.".bold);
 		}
@@ -51,61 +47,65 @@ class DoctorService implements IDoctorService {
 		} catch (err) {
 			this.$logger.error("Cannot get the latest versions information from npm. Please try again later.");
 		}
+
+		await this.$injector.resolve("platformEnvironmentRequirements").checkEnvironmentRequirements(null);
 	}
 
-	public runSetupScript(): Promise<ISpawnResult> {
+	public async runSetupScript(): Promise<ISpawnResult> {
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: TrackActionNames.RunSetupScript,
+			additionalData: "Starting",
+		});
+
 		if (this.$hostInfo.isLinux) {
+			await this.$analyticsService.trackEventActionInGoogleAnalytics({
+				action: TrackActionNames.RunSetupScript,
+				additionalData: "Skipped as OS is Linux",
+			});
 			return;
 		}
 
 		this.$logger.out("Running the setup script to try and automatically configure your environment.");
 
 		if (this.$hostInfo.isDarwin) {
-			return this.runSetupScriptCore(DoctorService.DarwinSetupScriptLocation, []);
+			await this.runSetupScriptCore(DoctorService.DarwinSetupScriptLocation, []);
 		}
 
 		if (this.$hostInfo.isWindows) {
-			return this.runSetupScriptCore(DoctorService.WindowsSetupScriptExecutable, DoctorService.WindowsSetupScriptArguments);
+			await this.runSetupScriptCore(DoctorService.WindowsSetupScriptExecutable, DoctorService.WindowsSetupScriptArguments);
 		}
+
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: TrackActionNames.RunSetupScript,
+			additionalData: "Finished",
+		});
 	}
 
 	public async canExecuteLocalBuild(platform?: string): Promise<boolean> {
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: TrackActionNames.CheckLocalBuildSetup,
+			additionalData: "Starting",
+		});
 		const infos = await doctor.getInfos({ platform });
 
 		const warnings = this.filterInfosByType(infos, constants.WARNING_TYPE_NAME);
-		if (warnings.length > 0) {
+		const hasWarnings = warnings.length > 0;
+		if (hasWarnings) {
+			await this.$analyticsService.trackEventActionInGoogleAnalytics({
+				action: TrackActionNames.CheckLocalBuildSetup,
+				additionalData: `Warnings:${warnings.map(w => w.message).join("__")}`,
+			});
 			this.printInfosCore(infos);
 		} else {
 			infos.map(info => this.$logger.trace(info.message));
 		}
-		return warnings.length === 0;
-	}
-
-	private async promptForDocs(link: string): Promise<void> {
-		if (await this.$prompter.confirm("Do you want to visit the official documentation?", () => helpers.isInteractive())) {
-			this.$opener.open(link);
-		}
-	}
-
-	private async promptForSetupScript(executablePath: string, setupScriptArgs: string[]): Promise<void> {
-		if (await this.$prompter.confirm("Do you want to run the setup script?", () => helpers.isInteractive())) {
-			await this.runSetupScriptCore(executablePath, setupScriptArgs);
-		}
-	}
 
-	private async promptForHelp(): Promise<void> {
-		if (this.$hostInfo.isDarwin) {
-			await this.promptForHelpCore(DoctorService.DarwinSetupDocsLink, DoctorService.DarwinSetupScriptLocation, []);
-		} else if (this.$hostInfo.isWindows) {
-			await this.promptForHelpCore(DoctorService.WindowsSetupDocsLink, DoctorService.WindowsSetupScriptExecutable, DoctorService.WindowsSetupScriptArguments);
-		} else {
-			await this.promptForDocs(DoctorService.LinuxSetupDocsLink);
-		}
-	}
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: TrackActionNames.CheckLocalBuildSetup,
+			additionalData: `Finished: Is setup correct: ${!hasWarnings}`,
+		});
 
-	private async promptForHelpCore(link: string, setupScriptExecutablePath: string, setupScriptArgs: string[]): Promise<void> {
-		await this.promptForDocs(link);
-		await this.promptForSetupScript(setupScriptExecutablePath, setupScriptArgs);
+		return !hasWarnings;
 	}
 
 	private async runSetupScriptCore(executablePath: string, setupScriptArgs: string[]): Promise<ISpawnResult> {
diff --git a/lib/services/platform-environment-requirements.ts b/lib/services/platform-environment-requirements.ts
diff --git a/lib/services/platform-service.ts b/lib/services/platform-service.ts
diff --git a/test/services/platform-environment-requirements.ts b/test/services/platform-environment-requirements.ts

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export class RunCommandBase implements ICommand {`
`28`	`28`	`this.platform = this.$devicePlatformsConstants.Android;`
`29`	`29`	`}`
`30`	`30`
`31`		`- this.$liveSyncCommandHelper.validatePlatform(this.platform);`
	`31`	`+ await this.$liveSyncCommandHelper.validatePlatform(this.platform);`
`32`	`32`
`33`	`33`	`return true;`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -381,5 +381,5 @@ interface IUpdateAppOptions extends IOptionalFilesToSync, IOptionalFilesToRemove`
`381`	`381`	`}`
`382`	`382`
`383`	`383`	`interface IPlatformEnvironmentRequirements {`
`384`		`- checkEnvironmentRequirements(platform: string): Promise<boolean>;`
	`384`	`+ checkEnvironmentRequirements(platform?: string): Promise<boolean>;`
`385`	`385`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ export class AnalyticsService extends AnalyticsServiceBase {`
`73`	`73`
`74`	`74`	`// In some cases (like in case action is Build and platform is Android), we do not know if the deviceType is emulator or device.`
`75`	`75`	`// Just exclude the device_type in this case.`
`76`		`- if (isForDevice !== null) {`
	`76`	`+ if (isForDevice !== null && isForDevice !== undefined) {`
`77`	`77`	`const deviceType = isForDevice ? DeviceTypes.Device : (this.$mobileHelper.isAndroidPlatform(platform) ? DeviceTypes.Emulator : DeviceTypes.Simulator);`
`78`	`78`	`label = this.addDataToLabel(label, deviceType);`
`79`	`79`	`}`