Fix livesync + debug on iOS Simulator (#3334)

When `tns debug ios` is used, each change of application's code will trigger restart of app and Chrome DevTools will be disconnected. CLI prints the "new" URL and in case you copy it and paste it immediately in the browser, you'll receive empty DevTools. The problem is that the URL is printed before application is launched successfully on simulator.
In order to resolve this issue, try connection on port 18181 - the connection will be successfull only when the application is running. Wait 10 seconds to connect and throw error in case we are unable to connect for this time.

Also fix incorrect behavior of connectionError event - the thrown error should contain the deviceIdentifier, but it was missing.

Author: rosen-vladimirov

PublicAPI.md

@@ -424,7 +424,7 @@ Provides methods for debugging applications on devices. The service is also even
 * Usage:
 ```JavaScript
 tns.debugService.on("connectionError", errorData => {
-	console.log(`Unable to start debug operation on device ${errorData.deviceId}. Error is: ${errorData.message}.`);
+	console.log(`Unable to start debug operation on device ${errorData.deviceIdentifier}. Error is: ${errorData.message}.`);
 });
 ```
 
@@ -522,7 +522,7 @@ interface IDebugOptions {
 * Usage:
 ```JavaScript
 tns.debugService.on("connectionError", errorData => {
-	console.log(`Unable to start debug operation on device ${errorData.deviceId}. Error is: ${errorData.message}.`);
+	console.log(`Unable to start debug operation on device ${errorData.deviceIdentifier}. Error is: ${errorData.message}.`);
 });
 
 const debugData = {
@@ -903,4 +903,4 @@ CLI is designed as command line tool and when it is used as a library, it does n
 For example the `$options` injected module contains information about all `--` options passed on the terminal. When the CLI is used as a library, the options are not populated. Before adding method to public API, make sure its implementation does not rely on `$options`.
 
 More information how to add a method to public API is available [here](https://github.com/telerik/mobile-cli-lib#how-to-make-a-method-public).
-After that add each method that you've exposed to the tests in `tests/nativescript-cli-lib.ts` file. There you'll find an object describing each publicly available module and the methods that you can call.
+After that add each method that you've exposed to the tests in `tests/nativescript-cli-lib.ts` file. There you'll find an object describing each publicly available module and the methods that you can call.

lib/common

@@ -544,7 +544,7 @@ interface IAndroidToolsInfoData {
 
 interface ISocketProxyFactory extends NodeJS.EventEmitter {
 	createTCPSocketProxy(factory: () => Promise<any>): Promise<any>;
-	createWebSocketProxy(factory: () => Promise<any>): Promise<any>;
+	createWebSocketProxy(factory: () => Promise<any>, deviceIdentifier: string): Promise<any>;
 }
 
 interface IiOSNotification {

lib/declarations.d.ts

@@ -72,7 +72,7 @@ export class SocketProxyFactory extends EventEmitter implements ISocketProxyFact
 		return server;
 	}
 
-	public async createWebSocketProxy(factory: () => Promise<net.Socket>): Promise<ws.Server> {
+	public async createWebSocketProxy(factory: () => Promise<net.Socket>, deviceIdentifier: string): Promise<ws.Server> {
 		// NOTE: We will try to provide command line options to select ports, at least on the localhost.
 		const localPort = await this.$net.getAvailablePortInRange(41000);
 
@@ -92,6 +92,7 @@ export class SocketProxyFactory extends EventEmitter implements ISocketProxyFact
 				try {
 					_socket = await factory();
 				} catch (err) {
+					err.deviceIdentifier = deviceIdentifier;
 					this.$logger.trace(err);
 					this.emit(CONNECTION_ERROR_EVENT_NAME, err);
 					this.$errors.failWithoutHelp("Cannot connect to device socket.");

lib/device-sockets/ios/socket-proxy-factory.ts

@@ -23,7 +23,7 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 	constructor(protected device: Mobile.IDevice,
 		protected $devicesService: Mobile.IDevicesService,
 		private $platformService: IPlatformService,
-		private $iOSEmulatorServices: Mobile.IEmulatorPlatformServices,
+		private $iOSEmulatorServices: Mobile.IiOSSimulatorService,
 		private $childProcess: IChildProcess,
 		private $hostInfo: IHostInfo,
 		private $logger: ILogger,
@@ -125,24 +125,27 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 		const lineStream = byline(child_process.stdout);
 		this._childProcess = child_process;
 
-		lineStream.on('data', (line: NodeBuffer) => {
-			const lineText = line.toString();
-			if (lineText && _.startsWith(lineText, debugData.applicationIdentifier)) {
-				const pid = getPidFromiOSSimulatorLogs(debugData.applicationIdentifier, lineText);
-				if (!pid) {
-					this.$logger.trace(`Line ${lineText} does not contain PID of the application ${debugData.applicationIdentifier}.`);
-					return;
+		await new Promise((resolve: () => void, reject) => {
+			lineStream.on('data', (line: NodeBuffer) => {
+				const lineText = line.toString();
+				if (lineText && _.startsWith(lineText, debugData.applicationIdentifier)) {
+					const pid = getPidFromiOSSimulatorLogs(debugData.applicationIdentifier, lineText);
+					if (!pid) {
+						this.$logger.trace(`Line ${lineText} does not contain PID of the application ${debugData.applicationIdentifier}.`);
+						return;
+					}
+
+					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.connectToApplicationOnEmulator(debugData.deviceIdentifier).then(resolve, reject);
+				} else {
+					process.stdout.write(line + "\n");
 				}
-
-				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");
-			} else {
-				process.stdout.write(line + "\n");
-			}
+			});
 		});
 
 		return this.wireDebuggerClient(debugData, debugOptions);
@@ -153,11 +156,21 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 
 		const attachRequestMessage = this.$iOSNotification.getAttachRequest(debugData.applicationIdentifier);
 
-		const iOSEmulator = <Mobile.IiOSSimulatorService>this.$iOSEmulatorServices;
-		await iOSEmulator.postDarwinNotification(attachRequestMessage);
+		const iOSEmulatorService = <Mobile.IiOSSimulatorService>this.$iOSEmulatorServices;
+		await iOSEmulatorService.postDarwinNotification(attachRequestMessage);
+		await this.connectToApplicationOnEmulator(debugData.deviceIdentifier);
 		return result;
 	}
 
+	private async connectToApplicationOnEmulator(deviceIdentifier: string): Promise<void> {
+		const socket = await this.$iOSEmulatorServices.connectToPort({ port: inspectorBackendPort });
+		if (!socket) {
+			const error = <Mobile.IDeviceError>new Error("Unable to connect to application. Ensure application is running on simulator.");
+			error.deviceIdentifier = deviceIdentifier;
+			throw error;
+		}
+	}
+
 	private async deviceDebugBrk(debugData: IDebugData, debugOptions: IDebugOptions): Promise<string> {
 		await this.$devicesService.initialize({ platform: this.platform, deviceId: debugData.deviceIdentifier });
 		const action = async (device: iOSDevice.IOSDevice): Promise<string> => {
@@ -212,7 +225,8 @@ 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.");
 			}
 
-			this._socketProxy = await this.$socketProxyFactory.createWebSocketProxy(this.getSocketFactory(device));
+			const deviceIdentifier = device ? device.deviceInfo.identifier : debugData.deviceIdentifier;
+			this._socketProxy = await this.$socketProxyFactory.createWebSocketProxy(this.getSocketFactory(device), deviceIdentifier);
 			return this.getChromeDebugUrl(debugOptions, this._socketProxy.options.port);
 		}
 	}

lib/services/ios-debug-service.ts

@@ -1,4 +1,3 @@
-import * as helpers from "../../common/helpers";
 import * as constants from "../../constants";
 import * as minimatch from "minimatch";
 import * as net from "net";
@@ -30,10 +29,8 @@ export class IOSDeviceLiveSyncService extends DeviceLiveSyncServiceBase implemen
 
 		if (this.device.isEmulator) {
 			await this.$iOSEmulatorServices.postDarwinNotification(this.$iOSNotification.getAttachRequest(projectId));
-			try {
-				this.socket = await helpers.connectEventuallyUntilTimeout(() => net.connect(IOSDeviceLiveSyncService.BACKEND_PORT), 5000);
-			} catch (e) {
-				this.$logger.debug(e);
+			this.socket = await this.$iOSEmulatorServices.connectToPort({ port: IOSDeviceLiveSyncService.BACKEND_PORT });
+			if (!this.socket) {
 				return false;
 			}
 		} else {

lib/services/livesync/ios-device-livesync-service.ts

@@ -203,7 +203,7 @@ describe("debugService", () => {
 					const debugData = getDebugData();
 					await assert.isFulfilled(debugService.debug(debugData, null));
 
-					const expectedErrorData = { deviceId: "deviceId", message: "my message", code: 2048 };
+					const expectedErrorData = { deviceIdentifier: "deviceId", message: "my message", code: 2048 };
 					const platformDebugService = testInjector.resolve<IPlatformDebugService>(`${platform}DebugService`);
 					platformDebugService.emit(CONNECTION_ERROR_EVENT_NAME, expectedErrorData);
 					assert.deepEqual(dataRaisedForConnectionError, expectedErrorData);

test/services/debug-service.ts

@@ -8,7 +8,7 @@ const expectedDevToolsCommitSha = "02e6bde1bbe34e43b309d4ef774b1168d25fd024";
 class IOSDebugServiceInheritor extends IOSDebugService {
 	constructor(protected $devicesService: Mobile.IDevicesService,
 		$platformService: IPlatformService,
-		$iOSEmulatorServices: Mobile.IEmulatorPlatformServices,
+		$iOSEmulatorServices: Mobile.IiOSSimulatorService,
 		$childProcess: IChildProcess,
 		$hostInfo: IHostInfo,
 		$logger: ILogger,