Expose enable/disable debugging

Expose enable/disable debugging when CLI is required as a library.
Includes:
* Unify `debug-livesync-service` and `livesync-service` into one class. Enable said class to attach a debugger at runtime during LiveSync
* Remove redundant `debugLivesync` property from `$config` and its every usage
* Remove redundant `debugStop` code in `android-debug-service`
* Raise events in the event of inability to start/stop the app on iOS

Author: Dimitar Kerezov

lib/bootstrap.ts

@@ -106,7 +106,6 @@ $injector.requireCommand("platform|clean", "./commands/platform-clean");
 
 $injector.requirePublicClass("liveSyncService", "./services/livesync/livesync-service");
 $injector.require("liveSyncCommandHelper", "./services/livesync/livesync-command-helper");
-$injector.require("debugLiveSyncService", "./services/livesync/debug-livesync-service");
 $injector.require("androidLiveSyncService", "./services/livesync/android-livesync-service");
 $injector.require("iOSLiveSyncService", "./services/livesync/ios-livesync-service");
 $injector.require("usbLiveSyncService", "./services/livesync/livesync-service"); // The name is used in https://github.com/NativeScript/nativescript-dev-typescript

lib/commands/debug.ts

@@ -16,31 +16,29 @@ export class DebugPlatformCommand implements ICommand {
 		protected $logger: ILogger,
 		protected $errors: IErrors,
 		private $debugDataService: IDebugDataService,
-		private $debugLiveSyncService: IDebugLiveSyncService,
-		private $config: IConfiguration,
+		private $liveSyncService: IDebugLiveSyncService,
 		private $prompter: IPrompter,
 		private $liveSyncCommandHelper: ILiveSyncCommandHelper) {
 	}
 
 	public async execute(args: string[]): Promise<void> {
-		const debugOptions = this.$options;
+		const debugOptions = <IDebugOptions>_.cloneDeep(this.$options.argv);
 
 		let debugData = this.$debugDataService.createDebugData(this.$projectData, this.$options);
 
 		await this.$platformService.trackProjectType(this.$projectData);
-
 		const selectedDeviceForDebug = await this.getDeviceForDebug();
 		debugData.deviceIdentifier = selectedDeviceForDebug.deviceInfo.identifier;
 
 		if (this.$options.start) {
-			return this.$debugLiveSyncService.printDebugInformation(await this.debugService.debug(debugData, debugOptions));
+			return this.$liveSyncService.printDebugInformation(await this.debugService.debug(debugData, debugOptions));
 		}
 
-		this.$config.debugLivesync = true;
-
 		await this.$devicesService.detectCurrentlyAttachedDevices({ shouldReturnImmediateResult: false, platform: this.platform });
 
-		await this.$liveSyncCommandHelper.executeLiveSyncOperation([selectedDeviceForDebug], this.$debugLiveSyncService, this.platform);
+		await this.$liveSyncCommandHelper.executeLiveSyncOperation([selectedDeviceForDebug], this.platform, {
+			[selectedDeviceForDebug.deviceInfo.identifier]: true
+		});
 	}
 
 	public async getDeviceForDebug(): Promise<Mobile.IDevice> {
@@ -104,6 +102,10 @@ export class DebugPlatformCommand implements ICommand {
 			this.$errors.fail(`Applications for platform ${this.platform} can not be built on this OS`);
 		}
 
+		if (this.$options.release) {
+			this.$errors.fail("--release flag is not applicable to this command");
+		}
+
 		const platformData = this.$platformsData.getPlatformData(this.platform, this.$projectData);
 		const platformProjectService = platformData.platformProjectService;
 		await platformProjectService.validate(this.$projectData);

lib/commands/run.ts

@@ -59,7 +59,7 @@ export class RunCommandBase implements ICommand {
 		await this.$devicesService.detectCurrentlyAttachedDevices({ shouldReturnImmediateResult: false, platform: this.platform });
 		let devices = this.$devicesService.getDeviceInstances();
 		devices = devices.filter(d => !this.platform || d.deviceInfo.platform.toLowerCase() === this.platform.toLowerCase());
-		await this.$liveSyncCommandHelper.executeLiveSyncOperation(devices, this.$liveSyncService, this.platform);
+		await this.$liveSyncCommandHelper.executeLiveSyncOperation(devices, this.platform);
 	}
 }
 

lib/common

@@ -8,7 +8,6 @@ export class Configuration extends ConfigBase implements IConfiguration { // Use
 	TYPESCRIPT_COMPILER_OPTIONS = {};
 	ANDROID_DEBUG_UI: string = null;
 	USE_POD_SANDBOX: boolean = false;
-	debugLivesync: boolean = false;
 
 	/*don't require logger and everything that has logger as dependency in config.js due to cyclic dependency*/
 	constructor(protected $fs: IFileSystem) {

lib/config.ts

@@ -85,6 +85,8 @@ export const ANGULAR_NAME = "angular";
 export const TYPESCRIPT_NAME = "typescript";
 export const BUILD_OUTPUT_EVENT_NAME = "buildOutput";
 export const CONNECTION_ERROR_EVENT_NAME = "connectionError";
+export const USER_INTERACTION_NEEDED_EVENT_NAME = "userInteractionNeeded";
+export const DEBUGGER_ATTACHED_EVENT_NAME = "debuggerAttached";
 export const VERSION_STRING = "version";
 export const INSPECTOR_CACHE_DIRNAME = "ios-inspector";
 export const POST_INSTALL_COMMAND_NAME = "post-install-cli";

lib/constants.ts

@@ -311,7 +311,6 @@ interface IStaticConfig extends Config.IStaticConfig { }
 interface IConfiguration extends Config.IConfig {
 	ANDROID_DEBUG_UI: string;
 	USE_POD_SANDBOX: boolean;
-	debugLivesync: boolean;
 }
 
 interface IApplicationPackage {
@@ -405,8 +404,7 @@ interface IDeviceEmulator extends IEmulator, IDeviceIdentifier { }
 
 interface IRunPlatformOptions extends IJustLaunch, IDeviceEmulator { }
 
-interface IDeployPlatformOptions extends IAndroidReleaseOptions, IPlatformTemplate, IRelease, IClean, IDeviceEmulator, IProvision, ITeamIdentifier {
-	projectDir: string;
+interface IDeployPlatformOptions extends IAndroidReleaseOptions, IPlatformTemplate, IRelease, IClean, IDeviceEmulator, IProvision, ITeamIdentifier, IProjectDir {
 	forceInstall?: boolean;
 }
 

lib/declarations.d.ts

@@ -1,12 +1,7 @@
 /**
  * Describes information for starting debug process.
  */
-interface IDebugData {
-	/**
-	 * Id of the device on which the debug process will be started.
-	 */
-	deviceIdentifier: string;
-
+interface IDebugData extends Mobile.IDeviceIdentifier {
 	/**
 	 * Application identifier of the app that it will be debugged.
 	 */
@@ -116,13 +111,13 @@ interface IDebugServiceBase extends NodeJS.EventEmitter {
 }
 
 interface IDebugService {
-	getDebugService(device: Mobile.IDevice): IPlatformDebugService;
+	getDebugService(platform: string): IPlatformDebugService;
 }
 
 /**
  * Describes actions required for debugging on specific platform (Android or iOS).
  */
-interface IPlatformDebugService extends IDebugServiceBase {
+interface IPlatformDebugService extends IDebugServiceBase, IPlatform {
 	/**
 	 * Starts debug operation.
 	 * @param {IDebugData} debugData Describes information for device and application that will be debugged.
@@ -135,10 +130,5 @@ interface IPlatformDebugService extends IDebugServiceBase {
 	 * Stops debug operation.
 	 * @returns {Promise<void>}
 	 */
-	debugStop(): Promise<void>
-
-	/**
-	 * Mobile platform of the device - Android or iOS.
-	 */
-	platform: string;
+	debugStop(): Promise<void>;
 }

lib/definitions/debug.d.ts

@@ -1,7 +1,6 @@
-interface IEmulatorInfo {
+interface IEmulatorInfo extends IPlatform {
 	name: string;
 	version: string;
-	platform: string;
 	id: string;
 	type: string;
 	isRunning?: boolean;

lib/definitions/emulator-platform-service.d.ts

@@ -68,10 +68,19 @@ interface ILiveSyncProcessInfo {
 	currentSyncAction: Promise<any>;
 }
 
+interface IOptionalOutputPath {
+	/**
+	 * Path where the build result is located (directory containing .ipa, .apk or .zip).
+	 * This is required for initial checks where LiveSync will skip the rebuild in case there's already a build result and no change requiring rebuild is made since then.
+	 * In case it is not passed, the default output for local builds will be used.
+	 */
+	outputPath?: string;
+}
+
 /**
  * Describes information for LiveSync on a device.
  */
-interface ILiveSyncDeviceInfo {
+interface ILiveSyncDeviceInfo extends IOptionalOutputPath {
 	/**
 	 * Device identifier.
 	 */
@@ -84,16 +93,14 @@ interface ILiveSyncDeviceInfo {
 	buildAction: () => Promise<string>;
 
 	/**
-	 * Path where the build result is located (directory containing .ipa, .apk or .zip).
-	 * This is required for initial checks where LiveSync will skip the rebuild in case there's already a build result and no change requiring rebuild is made since then.
-	 * In case it is not passed, the default output for local builds will be used.
+	 * Whether to skip preparing the native platform.
 	 */
-	outputPath?: string;
+	skipNativePrepare?: boolean;
 
 	/**
-	 * Whether to skip preparing the native platform.
+	 * Whether debugging has been enabled for this device or not
 	 */
-	skipNativePrepare?: boolean;
+	debugggingEnabled?: boolean;
 
 	/**
 	 * Describes options specific for each platform, like provision for iOS, target sdk for Android, etc.
@@ -104,12 +111,7 @@ interface ILiveSyncDeviceInfo {
 /**
  * Describes a LiveSync operation.
  */
-interface ILiveSyncInfo {
-	/**
-	 * Directory of the project that will be synced.
-	 */
-	projectDir: string;
-
+interface ILiveSyncInfo extends IProjectDir, IOptionalDebuggingOptions {
 	/**
 	 * Defines if the watcher should be skipped. If not passed, fs.Watcher will be started.
 	 */
@@ -135,9 +137,11 @@ interface ILiveSyncInfo {
 
 interface ILatestAppPackageInstalledSettings extends IDictionary<IDictionary<boolean>> { /* empty */ }
 
-interface ILiveSyncBuildInfo {
-	platform: string;
+interface IIsEmulator {
 	isEmulator: boolean;
+}
+
+interface ILiveSyncBuildInfo extends IIsEmulator, IPlatform {
 	pathToBuildItem: string;
 }
 
@@ -206,6 +210,52 @@ interface IDebugLiveSyncService extends ILiveSyncService {
 	 * @returns {void}
 	 */
 	printDebugInformation(information: string): void;
+
+	/**
+	 * Enables debugging for a specified device
+	 * @param {IEnableDebuggingDeviceOptions[]} deviceOpts Settings used for enabling debugging for each device.
+	 * @param {IDebuggingAdditionalOptions} enableDebuggingOptions Settings used for enabling debugging.
+	 * @returns {Promise<void>[]}
+	 */
+	enableDebugging(deviceOpts: IEnableDebuggingDeviceOptions[], enableDebuggingOptions: IDebuggingAdditionalOptions): Promise<void>[];
+}
+
+/**
+ * Describes additional debugging settings.
+ */
+interface IDebuggingAdditionalOptions extends IProjectDir { }
+
+/**
+ * Describes settings used when disabling debugging.
+ */
+interface IDisableDebuggingDeviceOptions extends Mobile.IDeviceIdentifier { }
+
+interface IOptionalDebuggingOptions {
+	/**
+	 * Optional debug options - can be used to control the start of a debug process.
+	*/
+	debugOptions?: IDebugOptions;
+}
+
+/**
+ * Describes settings used when enabling debugging.
+ */
+interface IEnableDebuggingDeviceOptions extends Mobile.IDeviceIdentifier, IOptionalDebuggingOptions { }
+
+/**
+ * Describes settings passed to livesync service in order to control event emitting during refresh application.
+ */
+interface IShouldSkipEmitLiveSyncNotification {
+	/**
+ 	* Whether to skip emitting an event during refresh. Default is false.
+ 	*/
+	shouldSkipEmitLiveSyncNotification: boolean;
+}
+
+/**
+ * Describes settings used for attaching a debugger.
+ */
+interface IAttachDebuggerOptions extends IDebuggingAdditionalOptions, IEnableDebuggingDeviceOptions, IIsEmulator, IPlatform, IOptionalOutputPath {
 }
 
 interface ILiveSyncWatchInfo {
@@ -284,10 +334,10 @@ interface ILiveSyncCommandHelper {
 	/**
 	 * Method sets up configuration, before calling livesync and expects that devices are already discovered.
 	 * @param {Mobile.IDevice[]} devices List of discovered devices
-	 * @param {ILiveSyncService} liveSyncService Service expected to do the actual livesyncing
 	 * @param {string} platform The platform for which the livesync will be ran
+	 * @param {IDictionary<boolean>} deviceDebugMap @optional A map representing devices which have debugging enabled initially.
 	 * @returns {Promise<void>}
 	 */
-	executeLiveSyncOperation(devices: Mobile.IDevice[], liveSyncService: ILiveSyncService, platform: string): Promise<void>;
+	executeLiveSyncOperation(devices: Mobile.IDevice[], platform: string, deviceDebugMap?: IDictionary<boolean>): Promise<void>;
 	getPlatformsForOperation(platform: string): string[];
 }