fix: Getting started prompter fails

The prompter for getting started changes fails in some cases, as we do not await the validation of the livesyncCommandHelper.validate call. So we try to execute some operations as we think the environment is setup correctly, but we are unable to do so and the code fails.

Also add additional option to prompter in case cloud extension is installed. This gives better visibility of the feature

Author: rosen-vladimirov

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;
 	}

lib/definitions/platform.d.ts

@@ -381,5 +381,5 @@ interface IUpdateAppOptions extends IOptionalFilesToSync, IOptionalFilesToRemove
 }
 
 interface IPlatformEnvironmentRequirements {
-	checkEnvironmentRequirements(platform: string): Promise<boolean>;
+	checkEnvironmentRequirements(platform: string, projectDir: string): Promise<boolean>;
 }

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);
 		}

lib/services/android-project-service.ts

@@ -133,7 +133,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		this.validatePackageName(projectData.projectId);
 		this.validateProjectName(projectData.projectName);
 
-		await this.$platformEnvironmentRequirements.checkEnvironmentRequirements(this.getPlatformData(projectData).normalizedPlatformName);
+		await this.$platformEnvironmentRequirements.checkEnvironmentRequirements(this.getPlatformData(projectData).normalizedPlatformName, projectData.projectDir);
 		this.$androidToolsInfo.validateTargetSdk({ showWarningsAsErrors: true });
 	}
 

lib/services/doctor-service.ts

@@ -53,32 +53,64 @@ class DoctorService implements IDoctorService {
 		}
 	}
 
-	public runSetupScript(): Promise<ISpawnResult> {
+	public async runSetupScript(): Promise<ISpawnResult> {
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: "Run setup script",
+			additionalData: "Start",
+		});
+
 		if (this.$hostInfo.isLinux) {
+			await this.$analyticsService.trackEventActionInGoogleAnalytics({
+				action: "Run setup script",
+				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: "Run setup script",
+			additionalData: "Finished",
+		});
 	}
 
 	public async canExecuteLocalBuild(platform?: string): Promise<boolean> {
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: "Check Local Build Setup",
+			additionalData: "Started",
+		});
 		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) {
+			// TODO: Separate the track per platform:
+			// Could be in two separate trackings or in the same, but with additional information, for example:
+			// Errors:<platform>__<warnings for platform>.join(--)$$<platform>__<warnings for platform>.join(--)...
+			await this.$analyticsService.trackEventActionInGoogleAnalytics({
+				action: "Check Local Build Setup",
+				additionalData: `Warnings:${warnings.map(w => w.message).join("__")}`,
+			});
 			this.printInfosCore(infos);
 		} else {
 			infos.map(info => this.$logger.trace(info.message));
 		}
-		return warnings.length === 0;
+
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: "Check Local Build Setup",
+			additionalData: `Finished: ${hasWarnings}`,
+		});
+
+		return !hasWarnings;
 	}
 
 	private async promptForDocs(link: string): Promise<void> {

lib/services/ios-project-service.ts

@@ -139,7 +139,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 			return;
 		}
 
-		await this.$platformEnvironmentRequirements.checkEnvironmentRequirements(this.getPlatformData(projectData).normalizedPlatformName);
+		await this.$platformEnvironmentRequirements.checkEnvironmentRequirements(this.getPlatformData(projectData).normalizedPlatformName, projectData.projectDir);
 
 		const xcodeBuildVersion = await this.getXcodeVersion();
 		if (helpers.versionCompare(xcodeBuildVersion, IOSProjectService.XCODEBUILD_MIN_VERSION) < 0) {

lib/services/platform-environment-requirements.ts

@@ -9,10 +9,12 @@ export class PlatformEnvironmentRequirements implements IPlatformEnvironmentRequ
 		private $logger: ILogger,
 		private $nativeScriptCloudExtensionService: INativeScriptCloudExtensionService,
 		private $prompter: IPrompter,
-		private $staticConfig: IStaticConfig) { }
+		private $staticConfig: IStaticConfig,
+		private $analyticsService: IAnalyticsService) { }
 
 	public static CLOUD_SETUP_OPTION_NAME = "Configure for Cloud Builds";
 	public static LOCAL_SETUP_OPTION_NAME = "Configure for Local Builds";
+	public static TRY_CLOUD_OPERATION_OPTION_NAME = "Try Cloud Operation";
 	public static MANUALLY_SETUP_OPTION_NAME = "Skip Step and Configure Manually";
 	private static BOTH_CLOUD_SETUP_AND_LOCAL_SETUP_OPTION_NAME = "Configure for Both Local and Cloud Builds";
 	private static CHOOSE_OPTIONS_MESSAGE = "To continue, choose one of the following options: ";
@@ -27,14 +29,24 @@ export class PlatformEnvironmentRequirements implements IPlatformEnvironmentRequ
 		"deploy": "tns cloud deploy"
 	};
 
-	public async checkEnvironmentRequirements(platform: string): Promise<boolean> {
+	public async checkEnvironmentRequirements(platform: string, projectDir: string): Promise<boolean> {
 		if (process.env.NS_SKIP_ENV_CHECK) {
+			await this.$analyticsService.trackEventActionInGoogleAnalytics({
+				action: "Check Environment Requirements",
+				additionalData: "Skipped:NS_SKIP_ENV_CHECK is set",
+				projectDir
+			});
 			return true;
 		}
 
 		const canExecute = await this.$doctorService.canExecuteLocalBuild(platform);
 		if (!canExecute) {
 			if (!isInteractive()) {
+				await this.$analyticsService.trackEventActionInGoogleAnalytics({
+					action: "Check Environment Requirements",
+					additionalData: "Non-interactive terminal, unable to execute local builds.",
+					projectDir
+				});
 				this.fail(this.getNonInteractiveConsoleMessage(platform));
 			}
 
@@ -74,6 +86,11 @@ export class PlatformEnvironmentRequirements implements IPlatformEnvironmentRequ
 
 				this.processManuallySetup(platform);
 			}
+
+			if (selectedOption === PlatformEnvironmentRequirements.TRY_CLOUD_OPERATION_OPTION_NAME) {
+				const message = `You can use ${_.lowerFirst(this.getCloudBuildsMessage(platform))}`;
+				this.fail(message);
+			}
 		}
 
 		return true;
@@ -166,18 +183,25 @@ export class PlatformEnvironmentRequirements implements IPlatformEnvironmentRequ
 			]);
 	}
 
-	private promptForChoice(): Promise<string> {
+	private async promptForChoice(): Promise<string> {
 		const choices = this.$nativeScriptCloudExtensionService.isInstalled() ? [
+			PlatformEnvironmentRequirements.TRY_CLOUD_OPERATION_OPTION_NAME,
 			PlatformEnvironmentRequirements.LOCAL_SETUP_OPTION_NAME,
 			PlatformEnvironmentRequirements.MANUALLY_SETUP_OPTION_NAME,
 		] : [
-			PlatformEnvironmentRequirements.CLOUD_SETUP_OPTION_NAME,
-			PlatformEnvironmentRequirements.LOCAL_SETUP_OPTION_NAME,
-			PlatformEnvironmentRequirements.BOTH_CLOUD_SETUP_AND_LOCAL_SETUP_OPTION_NAME,
-			PlatformEnvironmentRequirements.MANUALLY_SETUP_OPTION_NAME,
-		];
-
-		return this.$prompter.promptForChoice(PlatformEnvironmentRequirements.CHOOSE_OPTIONS_MESSAGE, choices);
+				PlatformEnvironmentRequirements.CLOUD_SETUP_OPTION_NAME,
+				PlatformEnvironmentRequirements.LOCAL_SETUP_OPTION_NAME,
+				PlatformEnvironmentRequirements.BOTH_CLOUD_SETUP_AND_LOCAL_SETUP_OPTION_NAME,
+				PlatformEnvironmentRequirements.MANUALLY_SETUP_OPTION_NAME,
+			];
+
+		const selection = await this.$prompter.promptForChoice(PlatformEnvironmentRequirements.CHOOSE_OPTIONS_MESSAGE, choices);
+		await this.$analyticsService.trackEventActionInGoogleAnalytics({
+			action: "Check Environment Requirements",
+			additionalData: `User selected: ${selection}`
+			// consider passing projectDir here
+		});
+		return selection;
 	}
 
 	private getEnvVerificationMessage() {