Merge pull request #3390 from NativeScript/fatme/doctor-package-integration

feat(doctor): Integrate nativescript-doctor package

Author: Fatme

lib/common

@@ -153,7 +153,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 
 		this.$androidToolsInfo.validateAndroidHomeEnvVariable({ showWarningsAsErrors: true });
 
-		const javaCompilerVersion = await this.$sysInfo.getJavaCompilerVersion();
+		const javaCompilerVersion = (await this.$sysInfo.getSysInfo()).javacVersion;
 
 		this.$androidToolsInfo.validateJavacVersion(javaCompilerVersion, { showWarningsAsErrors: true });
 

lib/services/android-project-service.ts

@@ -1,11 +1,9 @@
 import { EOL } from "os";
-import * as semver from "semver";
 import * as path from "path";
 import * as helpers from "../common/helpers";
+import { doctor, constants } from "nativescript-doctor";
 
 class DoctorService implements IDoctorService {
-	private static PROJECT_NAME_PLACEHOLDER = "__PROJECT_NAME__";
-	private static MIN_SUPPORTED_POD_VERSION = "1.0.0";
 	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";
@@ -14,104 +12,32 @@ class DoctorService implements IDoctorService {
 	private static LinuxSetupDocsLink = "https://docs.nativescript.org/start/ns-setup-linux";
 
 	constructor(private $analyticsService: IAnalyticsService,
-		private $androidToolsInfo: IAndroidToolsInfo,
-		private $cocoapodsService: ICocoaPodsService,
 		private $hostInfo: IHostInfo,
 		private $logger: ILogger,
-		private $progressIndicator: IProgressIndicator,
-		private $staticConfig: IStaticConfig,
-		private $sysInfo: ISysInfo,
 		private $childProcess: IChildProcess,
-		private $config: IConfiguration,
-		private $npm: INodePackageManager,
 		private $opener: IOpener,
 		private $prompter: IPrompter,
-		private $fs: IFileSystem,
-		private $versionsService: IVersionsService,
-		private $xcprojService: IXcprojService) { }
+		private $versionsService: IVersionsService) { }
 
 	public async printWarnings(configOptions?: { trackResult: boolean }): Promise<boolean> {
-		let result = false;
-		const sysInfo = await this.$sysInfo.getSysInfo(this.$staticConfig.pathToPackageJson);
-
-		if (!sysInfo.adbVer) {
-			this.$logger.warn("WARNING: adb from the Android SDK is not installed or is not configured properly.");
-			this.$logger.out("For Android-related operations, the NativeScript CLI will use a built-in version of adb." + EOL
-				+ "To avoid possible issues with the native Android emulator, Genymotion or connected" + EOL
-				+ "Android devices, verify that you have installed the latest Android SDK and" + EOL
-				+ "its dependencies as described in http://developer.android.com/sdk/index.html#Requirements" + EOL);
-
-			this.printPackageManagerTip();
-			result = true;
-		}
-
-		if (!sysInfo.emulatorInstalled) {
-			this.$logger.warn("WARNING: The Android SDK is not installed or is not configured properly.");
-			this.$logger.out("You will not be able to build your projects for Android and run them in the native emulator." + EOL
-				+ "To be able to build for Android and run apps in the native emulator, verify that you have" + EOL
-				+ "installed the latest Android SDK and its dependencies as described in http://developer.android.com/sdk/index.html#Requirements" + EOL
-			);
+		const warnings = await doctor.getWarnings();
+		const hasWarnings = warnings.length > 0;
 
+		const hasAndroidWarnings = warnings.filter(warning => _.includes(warning.platforms, constants.ANDROID_PLATFORM_NAME)).length > 0;
+		if (hasAndroidWarnings) {
 			this.printPackageManagerTip();
-			result = true;
 		}
 
-		if (this.$hostInfo.isDarwin) {
-			if (!sysInfo.xcodeVer) {
-				this.$logger.warn("WARNING: Xcode is not installed or is not configured properly.");
-				this.$logger.out("You will not be able to build your projects for iOS or run them in the iOS Simulator." + EOL
-					+ "To be able to build for iOS and run apps in the native emulator, verify that you have installed Xcode." + EOL);
-				result = true;
-			}
-
-			if (!sysInfo.xcodeprojLocation) {
-				this.$logger.warn("WARNING: xcodeproj gem is not installed or is not configured properly.");
-				this.$logger.out("You will not be able to build your projects for iOS." + EOL
-					+ "To be able to build for iOS and run apps in the native emulator, verify that you have installed xcodeproj." + EOL);
-				result = true;
-			}
-
-			if (!sysInfo.cocoapodVer) {
-				this.$logger.warn("WARNING: CocoaPods is not installed or is not configured properly.");
-				this.$logger.out("You will not be able to build your projects for iOS if they contain plugin with CocoaPod file." + EOL
-					+ "To be able to build such projects, verify that you have installed CocoaPods.");
-				result = true;
-			}
-
-			if (sysInfo.xcodeVer && sysInfo.cocoapodVer) {
-				const problemWithCocoaPods = await this.verifyCocoaPods();
-				if (problemWithCocoaPods) {
-					this.$logger.warn("WARNING: There was a problem with CocoaPods");
-					this.$logger.out("Verify that CocoaPods are configured properly.");
-					result = true;
-				}
-			}
-
-			if (sysInfo.cocoapodVer && semver.valid(sysInfo.cocoapodVer) && semver.lt(sysInfo.cocoapodVer, DoctorService.MIN_SUPPORTED_POD_VERSION)) {
-				this.$logger.warn(`WARNING: Your current CocoaPods version is earlier than ${DoctorService.MIN_SUPPORTED_POD_VERSION}.`);
-				this.$logger.out("You will not be able to build your projects for iOS if they contain plugin with CocoaPod file." + EOL
-					+ `To be able to build such projects, verify that you have at least ${DoctorService.MIN_SUPPORTED_POD_VERSION} version installed.`);
-				result = true;
-			}
-
-			if (sysInfo.xcodeVer && sysInfo.cocoapodVer && await this.$xcprojService.verifyXcproj(false)) {
-				result = true;
-			}
-		} else {
-			this.$logger.out("NOTE: You can develop for iOS only on Mac OS X systems.");
-			this.$logger.out("To be able to work with iOS devices and projects, you need Mac OS X Mavericks or later." + EOL);
-		}
-
-		const androidToolsIssues = this.$androidToolsInfo.validateInfo();
-		const javaCompilerVersionIssue = this.$androidToolsInfo.validateJavacVersion(sysInfo.javacVersion);
-		const pythonIssues = await this.validatePythonPackages();
-		const doctorResult = result || androidToolsIssues || javaCompilerVersionIssue || pythonIssues;
-
 		if (!configOptions || configOptions.trackResult) {
-			await this.$analyticsService.track("DoctorEnvironmentSetup", doctorResult ? "incorrect" : "correct");
+			await this.$analyticsService.track("DoctorEnvironmentSetup", hasWarnings ? "incorrect" : "correct");
 		}
 
-		if (doctorResult) {
+		if (hasWarnings) {
+			warnings.map(warning => {
+				this.$logger.warn(warning.warning);
+				this.$logger.out(warning.additionalInformation);
+			});
+
 			this.$logger.info("There seem to be issues with your configuration.");
 			if (this.$hostInfo.isDarwin) {
 				await this.promptForHelp(DoctorService.DarwinSetupDocsLink, DoctorService.DarwinSetupScriptLocation, []);
@@ -128,7 +54,7 @@ class DoctorService implements IDoctorService {
 			this.$logger.error("Cannot get the latest versions information from npm. Please try again later.");
 		}
 
-		return doctorResult;
+		return hasWarnings;
 	}
 
 	private async promptForDocs(link: string): Promise<void> {
@@ -152,81 +78,5 @@ class DoctorService implements IDoctorService {
 			this.$logger.out("TIP: To avoid setting up the necessary environment variables, you can use the Homebrew package manager to install the Android SDK and its dependencies." + EOL);
 		}
 	}
-
-	private async verifyCocoaPods(): Promise<boolean> {
-		this.$logger.out("Verifying CocoaPods. This may take more than a minute, please be patient.");
-
-		const temp = require("temp");
-		temp.track();
-		const projDir = temp.mkdirSync("nativescript-check-cocoapods");
-		const packageJsonData = {
-			"name": "nativescript-check-cocoapods",
-			"version": "0.0.1"
-		};
-		this.$fs.writeJson(path.join(projDir, "package.json"), packageJsonData);
-
-		const spinner = this.$progressIndicator.getSpinner("Installing iOS runtime.");
-		try {
-			spinner.start();
-			await this.$npm.install("tns-ios", projDir, {
-				global: false,
-				production: true,
-				save: true,
-				disableNpmInstall: false,
-				frameworkPath: null,
-				ignoreScripts: true
-			});
-			spinner.stop();
-			const iosDir = path.join(projDir, "node_modules", "tns-ios", "framework");
-			this.$fs.writeFile(
-				path.join(iosDir, "Podfile"),
-				`${this.$cocoapodsService.getPodfileHeader(DoctorService.PROJECT_NAME_PLACEHOLDER)}pod 'AFNetworking', '~> 1.0'${this.$cocoapodsService.getPodfileFooter()}`
-			);
-
-			spinner.message("Verifying CocoaPods. This may take some time, please be patient.");
-			spinner.start();
-			const future = this.$childProcess.spawnFromEvent(
-				this.$config.USE_POD_SANDBOX ? "sandbox-pod" : "pod",
-				["install"],
-				"exit",
-				{ cwd: iosDir },
-				{ throwError: false }
-			);
-
-			const result = await this.$progressIndicator.showProgressIndicator(future, 5000);
-			if (result.exitCode) {
-				this.$logger.out(result.stdout, result.stderr);
-				return true;
-			}
-
-			return !(this.$fs.exists(path.join(iosDir, `${DoctorService.PROJECT_NAME_PLACEHOLDER}.xcworkspace`)));
-		} catch (err) {
-			this.$logger.trace(`verifyCocoaPods error: ${err}`);
-			return true;
-		} finally {
-			spinner.stop();
-		}
-	}
-
-	private async validatePythonPackages(): Promise<boolean> {
-		let hasInvalidPackages = false;
-		if (this.$hostInfo.isDarwin) {
-			try {
-				await this.$childProcess.exec(`python -c "import six"`);
-			} catch (error) {
-				// error.code = 1 so the Python is present, but we don't have six.
-				if (error.code === 1) {
-					hasInvalidPackages = true;
-					this.$logger.warn("The Python 'six' package not found.");
-					this.$logger.out("This package is required by the Debugger library (LLDB) for iOS. You can install it by running 'pip install six' from the terminal.");
-				} else {
-					this.$logger.warn("Couldn't retrieve installed python packages.");
-					this.$logger.out("We cannot verify your python installation is setup correctly. Please, make sure you have both 'python' and 'pip' installed.");
-					this.$logger.trace(`Error while validating Python packages. Error is: ${error.message}`);
-				}
-			}
-		}
-		return hasInvalidPackages;
-	}
 }
 $injector.register("doctorService", DoctorService);

lib/services/doctor-service.ts

@@ -365,7 +365,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		const installedPlugins = await (<IPluginsService>this.$injector.resolve("pluginsService")).getAllInstalledPlugins(projectData);
 		for (const pluginData of installedPlugins) {
 			const pluginsFolderExists = this.$fs.exists(path.join(pluginData.pluginPlatformsFolderPath(this.$devicePlatformsConstants.iOS.toLowerCase()), "Podfile"));
-			const cocoaPodVersion = await this.$sysInfo.getCocoapodVersion();
+			const cocoaPodVersion = (await this.$sysInfo.getSysInfo()).cocoaPodsVer;
 			if (pluginsFolderExists && !cocoaPodVersion) {
 				this.$errors.failWithoutHelp(`${pluginData.name} has Podfile and you don't have Cocoapods installed or it is not configured correctly. Please verify Cocoapods can work on your machine.`);
 			}

lib/services/ios-project-service.ts

@@ -30,7 +30,7 @@ class XcprojService implements IXcprojService {
 
 	public async getXcprojInfo(): Promise<IXcprojInfo> {
 		if (!this.xcprojInfoCache) {
-			let cocoapodVer = await this.$sysInfo.getCocoapodVersion();
+			let cocoapodVer = (await this.$sysInfo.getSysInfo()).cocoaPodsVer;
 			const xcodeVersion = await this.$xcodeSelectService.getXcodeVersion();
 
 			if (cocoapodVer && !semver.valid(cocoapodVer)) {

lib/services/xcproj-service.ts

@@ -1,23 +1,18 @@
-import { SysInfoBase } from "./common/sys-info-base";
 import * as path from "path";
+import { sysInfo } from "nativescript-doctor";
 
-export class SysInfo extends SysInfoBase {
-	constructor(protected $childProcess: IChildProcess,
-		protected $hostInfo: IHostInfo,
-		protected $iTunesValidator: Mobile.IiTunesValidator,
-		protected $logger: ILogger,
-		protected $winreg: IWinReg,
-		protected $androidEmulatorServices: Mobile.IAndroidEmulatorServices,
-		private $androidToolsInfo: IAndroidToolsInfo) {
-		super($childProcess, $hostInfo, $iTunesValidator, $logger, $winreg, $androidEmulatorServices);
-	}
+export class SysInfo implements ISysInfo {
+	private sysInfo: ISysInfoData = null;
+
+	public async getSysInfo(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.ISysInfoData> {
+		if (!this.sysInfo) {
+			const pathToNativeScriptCliPackageJson = (config && config.pathToNativeScriptCliPackageJson) || path.join(__dirname, "..", "package.json");
+			const androidToolsInfo = config && config.androidToolsInfo;
 
-	public async getSysInfo(pathToPackageJson: string, androidToolsInfo?: { pathToAdb: string }): Promise<ISysInfoData> {
-		const defaultAndroidToolsInfo = {
-			pathToAdb: await this.$androidToolsInfo.getPathToAdbFromAndroidHome()
-		};
+			this.sysInfo = await sysInfo.getSysInfo({pathToNativeScriptCliPackageJson, androidToolsInfo});
+		}
 
-		return super.getSysInfo(pathToPackageJson || await path.join(__dirname, "..", "package.json"), androidToolsInfo || defaultAndroidToolsInfo);
+		return this.sysInfo;
 	}
 }
 $injector.register("sysInfo", SysInfo);