Merge pull request #339 from NativeScript/cankov/ios-debug-emulator

Move the NativeScript iOS debug from common to the NativeScript CLI, add debug on emulator

Author: PanayotCankov

lib/bootstrap.ts

@@ -15,6 +15,9 @@ $injector.require("projectTemplatesService", "./services/project-templates-servi
 $injector.require("platformsData", "./platforms-data");
 $injector.require("platformService", "./services/platform-service");
 
+$injector.require("iOSDebugService", "./services/ios-debug-service");
+$injector.require("androidDebugService", "./services/android-debug-service");
+
 $injector.require("userSettingsService", "./services/user-settings-service");
 $injector.require("analyticsSettingsService", "./services/analytics-settings-service");
 
@@ -29,7 +32,10 @@ $injector.requireCommand("platform|update", "./commands/update-platform");
 $injector.requireCommand("library|add", "./commands/add-library");
 $injector.requireCommand("run|ios", "./commands/run"); 
 $injector.requireCommand("run|android", "./commands/run");
-$injector.requireCommand("debug", "./commands/debug");
+
+$injector.requireCommand("debug|ios", "./commands/debug");
+$injector.requireCommand("debug|android", "./commands/debug");
+
 $injector.requireCommand("prepare", "./commands/prepare");
 $injector.requireCommand("build|ios", "./commands/build");
 $injector.requireCommand("build|android", "./commands/build");

lib/commands/debug.ts

@@ -1,18 +1,26 @@
 ///<reference path="../.d.ts"/>
 "use strict";
 
-import helpers = require("./../common/helpers");
-import util = require("util")
+export class DebugPlatformCommand implements ICommand {
+	constructor(private debugService: IDebugService) { }
 
-export class DebugCommand implements ICommand {
-    constructor(private $platformService: IPlatformService,
-        private $platformCommandParameter: ICommandParameter) { }
+	execute(args: string[]): IFuture<void> {
+		return this.debugService.debug();
+	}
 
-    execute(args: string[]): IFuture<void> {
-        return this.$platformService.debugPlatform(args[0]);
-    }
+	allowedParameters: ICommandParameter[] = [];
+}
+
+export class DebugIOSCommand extends DebugPlatformCommand {
+	constructor(private $iOSDebugService: IDebugService) {
+		super($iOSDebugService);
+	}
+}
+$injector.registerCommand("debug|ios", DebugIOSCommand);
 
-    allowedParameters = [this.$platformCommandParameter];
+export class DebugAndroidCommand extends DebugPlatformCommand {
+	constructor(private $androidDebugService: IDebugService) {
+		super($androidDebugService);
+	}
 }
-$injector.registerCommand("debug", DebugCommand);
- 
+$injector.registerCommand("debug|android", DebugAndroidCommand);

lib/common

@@ -0,0 +1,3 @@
+interface IDebugService {
+	debug(): IFuture<void>;
+}

lib/definitions/debug.d.ts

@@ -6,14 +6,16 @@ interface IPlatformService {
 	removePlatforms(platforms: string[]): IFuture<void>;
 	updatePlatforms(platforms: string[]): IFuture<void>;
 	runPlatform(platform: string): IFuture<void>;
-	debugPlatform(platform: string): IFuture<void>;
 	preparePlatform(platform: string): IFuture<void>;
 	buildPlatform(platform: string): IFuture<void>;
 	deployOnDevice(platform: string): IFuture<void>;
 	deployOnEmulator(platform: string): IFuture<void>;
 	validatePlatformInstalled(platform: string): void;
 	validatePlatform(platform: string): void;
 	addLibrary(platform: string, libraryPath: string): IFuture<void>;
+
+	getLatestApplicationPackageForDevice(platformData: IPlatformData): IFuture<IApplicationPackage>;
+	getLatestApplicationPackageForEmulator(platformData: IPlatformData): IFuture<IApplicationPackage>;
 }
 
 interface IPlatformData {

lib/definitions/platform.d.ts

@@ -30,7 +30,6 @@ interface IPlatformProjectService {
 	buildProject(projectRoot: string): IFuture<void>;
 	isPlatformPrepared(projectRoot: string): IFuture<boolean>;
 	addLibrary(platformData: IPlatformData, libraryPath: string): IFuture<void>;
-	getDebugOnDeviceSetup(): Mobile.IDebugOnDeviceSetup;
 	canUpdatePlatform(currentVersion: string, newVersion: string): IFuture<boolean>;
 	updatePlatform(currentVersion: string, newVersion: string): IFuture<void>;
 }

lib/definitions/project.d.ts

@@ -6,14 +6,15 @@ import commonOptions = require("./common/options");
 import osenv = require("osenv");
 import hostInfo = require("./common/host-info");
 
-var knownOpts:any = {
+var knownOpts: any = {
 		"frameworkPath": String,
 		"copy-from": String,
 		"link-to": String,
 		"release": Boolean,
 		"emulator": Boolean,
 		"symlink": Boolean,
 		"for-device": Boolean,
+		"client": Boolean,
 		"keyStorePath": String,
 		"keyStorePassword": String,
 		"keyStoreAlias": String,

lib/options.ts

@@ -0,0 +1,53 @@
+import options = require("./../common/options");
+import iOSProxyServices = require("./../common/mobile/ios/ios-proxy-services");
+import iOSDevice = require("./../common/mobile/ios/ios-device");
+import net = require("net");
+
+class AndroidDebugService implements IDebugService {
+	constructor(private $devicesServices: Mobile.IDevicesServices,
+		private $platformService: IPlatformService,
+		private $platformsData: IPlatformsData,
+		private $projectData: IProjectData,
+		private $logger: ILogger) { }
+
+	private get platform() { return "android"; }
+
+	public debug(): IFuture<void> {
+		return options.emulator
+			? this.debugOnEmulator()
+			: this.debugOnDevice();
+	}
+
+	public debugOnEmulator(): IFuture<void> {
+		return (() => {
+			this.$platformService.deployOnEmulator(this.platform).wait();
+			this.debugOnDevice().wait();
+		}).future<void>()();
+	}
+
+	public debugOnDevice(): IFuture<void> {
+		return (() => {
+			var platformData = this.$platformsData.getPlatformData(this.platform);
+			var packageFile = "";
+			var platformData = this.$platformsData.getPlatformData(this.platform);
+
+			if (options["debug-brk"]) {
+				this.$platformService.preparePlatform(this.platform).wait();
+
+				var cachedDeviceOption = options.forDevice;
+				options.forDevice = true;
+				this.$platformService.buildPlatform(this.platform).wait();
+				options.forDevice = cachedDeviceOption;
+
+				packageFile = this.$platformService.getLatestApplicationPackageForDevice(platformData).wait().packageName;
+				this.$logger.out("Using ", packageFile);
+			}
+
+			this.$devicesServices.initialize({ platform: this.platform, deviceId: options.device}).wait();
+			var action = (device: Mobile.IAndroidDevice): IFuture<void> => { return device.debug(packageFile, this.$projectData.projectId) };
+			this.$devicesServices.execute(action).wait();
+
+		}).future<void>()();
+	}
+}
+$injector.register("androidDebugService", AndroidDebugService);

lib/services/android-debug-service.ts

@@ -140,7 +140,7 @@ class AndroidProjectService implements IPlatformProjectService {
 			return assetsDirectory;
 
 		}).future<string>()();
-    }
+	}
 
 	public getDebugOnDeviceSetup(): Mobile.IDebugOnDeviceSetup {
 		return { };
@@ -156,112 +156,112 @@ class AndroidProjectService implements IPlatformProjectService {
 		return (() => { }).future<void>()();
 	}
 
-    private updateMetadata(projectRoot: string): void {
-        var projMetadataDir = path.join(projectRoot, "assets", "metadata");
-        var libsmetadataDir = path.join(projectRoot, "../../lib", this.platformData.normalizedPlatformName, AndroidProjectService.METADATA_DIRNAME);
-        shell.cp("-f", path.join(libsmetadataDir, "*.dat"), projMetadataDir);
-    }
+	private updateMetadata(projectRoot: string): void {
+		var projMetadataDir = path.join(projectRoot, "assets", "metadata");
+		var libsmetadataDir = path.join(projectRoot, "../../lib", this.platformData.normalizedPlatformName, AndroidProjectService.METADATA_DIRNAME);
+		shell.cp("-f", path.join(libsmetadataDir, "*.dat"), projMetadataDir);
+	}
 
-    private generateMetadata(projectRoot: string): void {
-        var metadataGeneratorPath = path.join(__dirname, "../../resources/tools/metadata-generator.jar");
-        var libsFolder = path.join(projectRoot, "../../lib", this.platformData.normalizedPlatformName);
+	private generateMetadata(projectRoot: string): void {
+		var metadataGeneratorPath = path.join(__dirname, "../../resources/tools/metadata-generator.jar");
+		var libsFolder = path.join(projectRoot, "../../lib", this.platformData.normalizedPlatformName);
 		var metadataDirName = AndroidProjectService.METADATA_DIRNAME;
-        var outDir = path.join(libsFolder, metadataDirName);
-        this.$fs.ensureDirectoryExists(outDir).wait();
+		var outDir = path.join(libsFolder, metadataDirName);
+		this.$fs.ensureDirectoryExists(outDir).wait();
 
 		shell.cp("-f", path.join(__dirname, "../../resources/tools/android.jar"), libsFolder);
 		shell.cp("-f", path.join(__dirname, "../../resources/tools/android-support-v4.jar"), libsFolder);
 		shell.cp("-f", path.join(projectRoot, "libs/*.jar"), libsFolder);
 
 		this.spawn('java', ['-jar', metadataGeneratorPath, libsFolder, outDir]).wait();
-    }
+	}
 
 	public buildProject(projectRoot: string): IFuture<void> {
 		return (() => {
 			var buildConfiguration = options.release ? "release" : "debug";
-            var args = this.getAntArgs(buildConfiguration, projectRoot);
+			var args = this.getAntArgs(buildConfiguration, projectRoot);
 			var argsSaved = this.getAntArgs(buildConfiguration, projectRoot);
-            this.spawn('ant', args).wait();
-            this.generateMetadata(projectRoot);
-            this.updateMetadata(projectRoot);
-            // build the project again in order to include the newly generated metadata
+			this.spawn('ant', args).wait();
+			this.generateMetadata(projectRoot);
+			this.updateMetadata(projectRoot);
+			// build the project again in order to include the newly generated metadata
 			this.spawn('ant', argsSaved).wait();
 		}).future<void>()();
 	}
 
 	public isPlatformPrepared(projectRoot: string): IFuture<boolean> {
 		return this.$fs.exists(path.join(projectRoot, "assets", constants.APP_FOLDER_NAME));
-    }
+	}
 
-    private generateBuildFile(projDir: string, targetSdk: string): void {
-        this.$logger.info("Generate build.xml for %s", projDir);
-        var cmd = util.format("android update project -p %s --target %s --subprojects", projDir, targetSdk);
-        this.$childProcess.exec(cmd).wait();
-    }
+	private generateBuildFile(projDir: string, targetSdk: string): void {
+		this.$logger.info("Generate build.xml for %s", projDir);
+		var cmd = util.format("android update project -p %s --target %s --subprojects", projDir, targetSdk);
+		this.$childProcess.exec(cmd).wait();
+	}
 
-    private parseProjectProperties(projDir: string, destDir: string): void {
-        var projProp = path.join(projDir, "project.properties");
+	private parseProjectProperties(projDir: string, destDir: string): void {
+		var projProp = path.join(projDir, "project.properties");
 
-        if (!this.$fs.exists(projProp).wait()) {
-            this.$logger.warn("Warning: File %s does not exist", projProp);
-            return;
-        }
+		if (!this.$fs.exists(projProp).wait()) {
+			this.$logger.warn("Warning: File %s does not exist", projProp);
+			return;
+		}
 
 		var lines = this.$fs.readText(projProp, "utf-8").wait().split(os.EOL);
 
 		var regEx = /android\.library\.reference\.(\d+)=(.*)/;
-        lines.forEach(elem => {
-            var match = elem.match(regEx);
-            if (match) {
-                var libRef: ILibRef = { idx: parseInt(match[1]), path: match[2].trim() };
-                libRef.adjustedPath = this.$fs.isRelativePath(libRef.path) ? path.join(projDir, libRef.path) : libRef.path;
-                this.parseProjectProperties(libRef.adjustedPath, destDir);
-            }
-        });
-
-        this.$logger.info("Copying %s", projDir);
-        shell.cp("-Rf", projDir, destDir);
-
-        var targetDir = path.join(destDir, path.basename(projDir));
-        // TODO: parametrize targetSdk
-        var targetSdk = "android-17";
-        this.generateBuildFile(targetDir, targetSdk);
-    }
-
-    private getProjectReferences(projDir: string): ILibRef[]{
-        var projProp = path.join(projDir, "project.properties");
+		lines.forEach(elem => {
+			var match = elem.match(regEx);
+			if (match) {
+				var libRef: ILibRef = { idx: parseInt(match[1]), path: match[2].trim() };
+				libRef.adjustedPath = this.$fs.isRelativePath(libRef.path) ? path.join(projDir, libRef.path) : libRef.path;
+				this.parseProjectProperties(libRef.adjustedPath, destDir);
+			}
+		});
+
+		this.$logger.info("Copying %s", projDir);
+		shell.cp("-Rf", projDir, destDir);
+
+		var targetDir = path.join(destDir, path.basename(projDir));
+		// TODO: parametrize targetSdk
+		var targetSdk = "android-17";
+		this.generateBuildFile(targetDir, targetSdk);
+	}
+
+	private getProjectReferences(projDir: string): ILibRef[]{
+		var projProp = path.join(projDir, "project.properties");
 
 		var lines = this.$fs.readText(projProp, "utf-8").wait().split(os.EOL);
 
-        var refs: ILibRef[] = [];
+		var refs: ILibRef[] = [];
 
 		var regEx = /android\.library\.reference\.(\d+)=(.*)/;
-        lines.forEach(elem => {
-            var match = elem.match(regEx);
-            if (match) {
-                var libRef: ILibRef = { idx: parseInt(match[1]), path: match[2] };
-                libRef.adjustedPath = path.join(projDir, libRef.path);
-                refs.push(libRef);
-            }
-        });
-
-        return refs;
-    }
-
-    private updateProjectReferences(projDir: string, libraryPath: string): void {
-        var refs = this.getProjectReferences(projDir);
+		lines.forEach(elem => {
+			var match = elem.match(regEx);
+			if (match) {
+				var libRef: ILibRef = { idx: parseInt(match[1]), path: match[2] };
+				libRef.adjustedPath = path.join(projDir, libRef.path);
+				refs.push(libRef);
+			}
+		});
+
+		return refs;
+	}
+
+	private updateProjectReferences(projDir: string, libraryPath: string): void {
+		var refs = this.getProjectReferences(projDir);
 		var maxIdx = refs.length > 0 ? _.max(refs, r => r.idx).idx : 0;
 
-        var relLibDir = path.relative(projDir, libraryPath).split("\\").join("/");
+		var relLibDir = path.relative(projDir, libraryPath).split("\\").join("/");
 
-        var libRefExists = _.any(refs, r => path.normalize(r.path) === path.normalize(relLibDir));
+		var libRefExists = _.any(refs, r => path.normalize(r.path) === path.normalize(relLibDir));
 
-        if (!libRefExists) {
-            var projRef = util.format("%sandroid.library.reference.%d=%s", os.EOL, maxIdx + 1, relLibDir);
-            var projProp = path.join(projDir, "project.properties");
-            fs.appendFileSync(projProp, projRef, { encoding: "utf-8" });
-        }
-    }
+		if (!libRefExists) {
+			var projRef = util.format("%sandroid.library.reference.%d=%s", os.EOL, maxIdx + 1, relLibDir);
+			var projProp = path.join(projDir, "project.properties");
+			fs.appendFileSync(projProp, projRef, { encoding: "utf-8" });
+		}
+	}
 
 	public addLibrary(platformData: IPlatformData, libraryPath: string): IFuture<void> {
 		return (() => {
@@ -279,12 +279,12 @@ class AndroidProjectService implements IPlatformProjectService {
 
 			var targetLibPath = path.join(targetPath, path.basename(libraryPath));
 
-            var libProjProp = path.join(libraryPath, "project.properties");
-            if (this.$fs.exists(libProjProp).wait()) {
-                this.updateProjectReferences(platformData.projectRoot, targetLibPath);
-            }
+			var libProjProp = path.join(libraryPath, "project.properties");
+			if (this.$fs.exists(libProjProp).wait()) {
+				this.updateProjectReferences(platformData.projectRoot, targetLibPath);
+			}
 		}).future<void>()();
-    }
+	}
 
 	public getFrameworkFilesExtensions(): string[] {
 		return [".jar", ".dat"];