refactor: unify deviceId usage in ios-debug-service

Author: DimitarTachev

lib/definitions/debug.d.ts

@@ -1,3 +1,4 @@
+// TODO: remove IDeviceIdentifier
 /**
  * Describes information for starting debug process.
  */

lib/services/ios-debug-service.ts

@@ -11,6 +11,7 @@ const inspectorUiDir = "WebInspectorUI/";
 
 export class IOSDebugService extends DebugServiceBase implements IPlatformDebugService {
 	private _lldbProcess: ChildProcess;
+	private deviceIdentifier: string;
 
 	constructor(protected device: Mobile.IiOSDevice,
 		protected $devicesService: Mobile.IDevicesService,
@@ -26,25 +27,24 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 		private $socketProxyFactory: ISocketProxyFactory,
 		private $projectDataService: IProjectDataService,
 		private $deviceLogProvider: Mobile.IDeviceLogProvider) {
+
 		super(device, $devicesService);
 		this.$processService.attachToProcessExitSignals(this, this.debugStop);
 		this.$socketProxyFactory.on(CONNECTION_ERROR_EVENT_NAME, (e: Error) => this.emit(CONNECTION_ERROR_EVENT_NAME, e));
+		this.deviceIdentifier = this.device.deviceInfo.identifier;
 	}
 
 	public get platform(): string {
 		return "ios";
 	}
 
 	public async debug(debugData: IDebugData, debugOptions: IDebugOptions): Promise<string> {
-
-		if (debugOptions.debugBrk && debugOptions.start) {
-			this.$errors.failWithoutHelp("Expected exactly one of the --debug-brk or --start options.");
-		}
+		this.validateOptions(debugOptions);
 
 		await this.startDeviceLogProcess(debugData, debugOptions);
 		await this.$iOSDebuggerPortService.attachToDebuggerPortFoundEvent(this.device, debugData, debugOptions);
 
-		if (!debugOptions.start) { // not attach
+		if (!debugOptions.start) {
 			if (this.device.isEmulator) {
 				await this.startAppOnSimulator(debugData, debugOptions);
 			} else {
@@ -67,12 +67,7 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 
 	public async debugStop(): Promise<void> {
 		this.$socketProxyFactory.removeAllProxies();
-
-		if (this._lldbProcess) {
-			this._lldbProcess.stdin.write("process detach\n");
-			await this.killProcess(this._lldbProcess);
-			this._lldbProcess = undefined;
-		}
+		await this.stopAppDebuggerOnSimulator();
 	}
 
 	protected getChromeDebugUrl(debugOptions: IDebugOptions, port: number): string {
@@ -83,11 +78,17 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 		return chromeDebugUrl;
 	}
 
+	private validateOptions(debugOptions: IDebugOptions) {
+		if (debugOptions.debugBrk && debugOptions.start) {
+			this.$errors.failWithoutHelp("Expected exactly one of the --debug-brk or --start options.");
+		}
+	}
+
 	private async startDeviceLogProcess(debugData: IDebugData, debugOptions: IDebugOptions): Promise<void> {
 		if (debugOptions.justlaunch) {
 			// No logs should be printed on console when `--justlaunch` option is passed.
 			// On the other side we need to start log process in order to get debugger port from logs.
-			this.$deviceLogProvider.muteLogsForDevice(debugData.deviceIdentifier);
+			this.$deviceLogProvider.muteLogsForDevice(this.deviceIdentifier);
 		}
 
 		let projectName = debugData.projectName;
@@ -97,21 +98,12 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 		}
 
 		if (projectName) {
-			this.$deviceLogProvider.setProjectNameForDevice(debugData.deviceIdentifier, projectName);
+			this.$deviceLogProvider.setProjectNameForDevice(this.deviceIdentifier, projectName);
 		}
 
 		await this.device.openDeviceLogStream({ predicate: IOS_LOG_PREDICATE });
 	}
 
-	private async killProcess(childProcess: ChildProcess): Promise<void> {
-		if (childProcess) {
-			return new Promise<void>((resolve, reject) => {
-				childProcess.on("close", resolve);
-				childProcess.kill();
-			});
-		}
-	}
-
 	private async startAppOnSimulator(debugData: IDebugData, debugOptions: IDebugOptions): Promise<void> {
 		const args = debugOptions.debugBrk ? "--nativescript-debug-brk" : "--nativescript-debug-start";
 		const launchResult = await this.$iOSEmulatorServices.runApplicationOnEmulator(debugData.pathToAppPackage, {
@@ -120,38 +112,56 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 			args: args,
 			appId: debugData.applicationIdentifier,
 			skipInstall: true,
-			device: debugData.deviceIdentifier,
+			device: this.deviceIdentifier,
 			justlaunch: debugOptions.justlaunch,
 			timeout: debugOptions.timeout,
 			sdk: debugOptions.sdk
 		});
 		const pid = getPidFromiOSSimulatorLogs(debugData.applicationIdentifier, launchResult);
-		this._lldbProcess = this.$childProcess.spawn("lldb", ["-p", pid]);
-		if (log4js.levels.TRACE.isGreaterThanOrEqualTo(this.$logger.getLevel())) {
-			this._lldbProcess.stdout.pipe(process.stdout);
-		}
-		this._lldbProcess.stderr.pipe(process.stderr);
-		this._lldbProcess.stdin.write("process continue\n");
+		this.startAppDebuggerOnSimulator(pid);
 	}
 
 	private async startAppOnDevice(debugData: IDebugData, debugOptions: IDebugOptions): Promise<void> {
 		const runOptions: IRunPlatformOptions = {
-			device: debugData.deviceIdentifier,
+			device: this.deviceIdentifier,
 			emulator: this.device.isEmulator,
 			justlaunch: debugOptions.justlaunch
 		};
 		const projectData = this.$projectDataService.getProjectData(debugData.projectDir);
 		await this.$platformService.startApplication(this.platform, runOptions, { appId: debugData.applicationIdentifier, projectName: projectData.projectName });
 	}
 
+	private startAppDebuggerOnSimulator(pid: string) {
+		this._lldbProcess = this.$childProcess.spawn("lldb", ["-p", pid]);
+		if (log4js.levels.TRACE.isGreaterThanOrEqualTo(this.$logger.getLevel())) {
+			this._lldbProcess.stdout.pipe(process.stdout);
+		}
+		this._lldbProcess.stderr.pipe(process.stderr);
+		this._lldbProcess.stdin.write("process continue\n");
+	}
+
+	private async stopAppDebuggerOnSimulator() {
+		if (this._lldbProcess) {
+			this._lldbProcess.stdin.write("process detach\n");
+			await this.killProcess(this._lldbProcess);
+			this._lldbProcess = undefined;
+		}
+	}
+
+	private async killProcess(childProcess: ChildProcess): Promise<void> {
+		if (childProcess) {
+			return new Promise<void>((resolve, reject) => {
+				childProcess.on("close", resolve);
+				childProcess.kill();
+			});
+		}
+	}
+
 	private async wireDebuggerClient(debugData: IDebugData, debugOptions: IDebugOptions): Promise<string> {
-		// the VSCode Ext starts `tns debug ios --no-client` to start/attach to debug sessions
-		// check if --no-client is passed - default to opening a tcp socket (versus Chrome DevTools (websocket))
-		const deviceIdentifier = this.device ? this.device.deviceInfo.identifier : debugData.deviceIdentifier;
 		if ((debugOptions.inspector || !debugOptions.client) && this.$hostInfo.isDarwin) {
-			const existingTcpProxy = this.$socketProxyFactory.getTCPSocketProxy(deviceIdentifier);
+			const existingTcpProxy = this.$socketProxyFactory.getTCPSocketProxy(this.deviceIdentifier);
 			const getDeviceSocket = async () => await this.device.getDebugSocket(debugData.applicationIdentifier, debugData.projectDir);
-			const tcpSocketProxy = existingTcpProxy || await this.$socketProxyFactory.addTCPSocketProxy(getDeviceSocket, deviceIdentifier);
+			const tcpSocketProxy = existingTcpProxy || await this.$socketProxyFactory.addTCPSocketProxy(getDeviceSocket, this.deviceIdentifier);
 			if (!existingTcpProxy) {
 				await this.openAppInspector(tcpSocketProxy.address(), debugData, debugOptions);
 			}
@@ -162,9 +172,9 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 				this.$logger.info("'--chrome' is the default behavior. Use --inspector to debug iOS applications using the Safari Web Inspector.");
 			}
 
-			const existingWebProxy = this.$socketProxyFactory.getWebSocketProxy(deviceIdentifier);
+			const existingWebProxy = this.$socketProxyFactory.getWebSocketProxy(this.deviceIdentifier);
 			const getDeviceSocket = async () => await this.device.getDebugSocket(debugData.applicationIdentifier, debugData.projectDir);
-			const webSocketProxy = existingWebProxy || await this.$socketProxyFactory.addWebSocketProxy(getDeviceSocket, deviceIdentifier);
+			const webSocketProxy = existingWebProxy || await this.$socketProxyFactory.addWebSocketProxy(getDeviceSocket, this.deviceIdentifier);
 
 			return this.getChromeDebugUrl(debugOptions, webSocketProxy.options.port);
 		}