Merge pull request #3540 from NativeScript/fatme/ios-debugger-port

Get debugger port from device logs

Author: Fatme

lib/bootstrap.ts

@@ -167,3 +167,5 @@ $injector.requireCommand("resources|generate|splashes", "./commands/generate-ass
 $injector.requirePublic("assetsGenerationService", "./services/assets-generation/assets-generation-service");
 
 $injector.require("filesHashService", "./services/files-hash-service");
+$injector.require("iOSLogParserService", "./services/ios-log-parser-service");
+$injector.require("iOSDebuggerPortService", "./services/ios-debugger-port-service");

lib/commands/debug.ts

@@ -143,13 +143,15 @@ export class DebugIOSCommand implements ICommand {
 		private $injector: IInjector,
 		private $projectData: IProjectData,
 		private $platformsData: IPlatformsData,
-		$iosDeviceOperations: IIOSDeviceOperations) {
+		$iosDeviceOperations: IIOSDeviceOperations,
+		$iOSSimulatorLogProvider: Mobile.IiOSSimulatorLogProvider) {
 		this.$projectData.initializeProjectData();
 		// Do not dispose ios-device-lib, so the process will remain alive and the debug application (NativeScript Inspector or Chrome DevTools) will be able to connect to the socket.
 		// In case we dispose ios-device-lib, the socket will be closed and the code will fail when the debug application tries to read/send data to device socket.
 		// That's why the `$ tns debug ios --justlaunch` command will not release the terminal.
 		// In case we do not set it to false, the dispose will be called once the command finishes its execution, which will prevent the debugging.
 		$iosDeviceOperations.setShouldDispose(false);
+		$iOSSimulatorLogProvider.setShouldDispose(false);
 	}
 
 	public execute(args: string[]): Promise<void> {

lib/common

@@ -645,7 +645,7 @@ interface ISocketProxyFactory extends NodeJS.EventEmitter {
 
 interface IiOSNotification {
 	getWaitForDebug(projectId: string): string;
-	getAttachRequest(projectId: string): string;
+	getAttachRequest(projectId: string, deviceId: string): string;
 	getAppLaunching(projectId: string): string;
 	getReadyForAttach(projectId: string): string;
 	getAttachAvailabilityQuery(projectId: string): string;

lib/declarations.d.ts

@@ -87,6 +87,10 @@ interface IDebugOptions {
 	 * Defines if the iOS App Inspector should be used instead of providing URL to debug the application with Chrome DevTools
 	 */
 	inspector?: boolean;
+	/**
+	 * Defines if should print all availableDevices
+	 */
+	availableDevices?: boolean;
 }
 
 /**

lib/definitions/debug.d.ts

@@ -0,0 +1,28 @@
+interface IIOSDebuggerPortInputData {
+	deviceId: string;
+	appId: string;
+}
+
+interface IIOSDebuggerPortData extends IIOSDebuggerPortInputData {
+	port: number;
+}
+
+interface IIOSDebuggerPortStoredData {
+	port: number;
+	timer?: NodeJS.Timer;
+}
+
+interface IIOSDebuggerPortService {
+	/**
+	 * Gets iOS debugger port for specified deviceId and appId
+	 * @param {IIOSDebuggerPortInputData} data - Describes deviceId and appId
+	 */
+	getPort(data: IIOSDebuggerPortInputData): Promise<number>;
+	/**
+	 * Attaches on DEBUGGER_PORT_FOUND event and STARTING_IOS_APPLICATION events
+	 * In case when DEBUGGER_PORT_FOUND event is emitted, stores the port and clears the timeout if such.
+	 * In case when STARTING_IOS_APPLICATION event is emiited, sets the port to null and add timeout for 5000 miliseconds which checks if port is null and prints a warning.
+	 * @param {Mobile.IDevice} device - Describes the device which logs should be parsed. 
+	 */
+	attachToDebuggerPortFoundEvent(device: Mobile.IDevice): void;
+}

lib/definitions/ios-debugger-port-service.d.ts

@@ -0,0 +1,7 @@
+interface IIOSLogParserService extends NodeJS.EventEmitter {
+	/**
+	 * Starts looking for debugger port. Attaches on device logs and processes them. In case when port is found, DEBUGGER_PORT_FOUND event is emitted.
+	 * @param {Mobile.IDevice} device - Describes the device which logs will be processed.
+	 */
+	startParsingLog(device: Mobile.IDevice): void;
+}

lib/definitions/ios-log-parser-service.d.ts

@@ -218,6 +218,7 @@ interface IProjectTemplatesService {
 
 interface IPlatformProjectServiceBase {
 	getPluginPlatformsFolderPath(pluginData: IPluginData, platform: string): string;
+	getFrameworkVersion(projectData: IProjectData): string;
 }
 
 interface IBuildForDevice {
@@ -270,7 +271,7 @@ interface ILocalBuildService {
 
 interface ICleanNativeAppData extends IProjectDir, IPlatform { }
 
-interface IPlatformProjectService extends NodeJS.EventEmitter {
+interface IPlatformProjectService extends NodeJS.EventEmitter, IPlatformProjectServiceBase {
 	getPlatformData(projectData: IProjectData): IPlatformData;
 	validate(projectData: IProjectData): Promise<void>;
 	createProject(frameworkDir: string, frameworkVersion: string, projectData: IProjectData, config: ICreateProjectOptions): Promise<void>;

lib/definitions/project.d.ts

@@ -1,4 +1,7 @@
-export class IOSNotification implements IiOSNotification {
+import { EventEmitter } from "events";
+import { ATTACH_REQUEST_EVENT_NAME } from "../../common/constants";
+
+export class IOSNotification extends EventEmitter implements IiOSNotification {
 	private static WAIT_FOR_DEBUG_NOTIFICATION_NAME = "WaitForDebugger";
 	private static ATTACH_REQUEST_NOTIFICATION_NAME = "AttachRequest";
 	private static APP_LAUNCHING_NOTIFICATION_NAME = "AppLaunching";
@@ -11,8 +14,9 @@ export class IOSNotification implements IiOSNotification {
 		return this.formatNotification(IOSNotification.WAIT_FOR_DEBUG_NOTIFICATION_NAME, projectId);
 	}
 
-	public getAttachRequest(projectId: string): string {
-		return this.formatNotification(IOSNotification.ATTACH_REQUEST_NOTIFICATION_NAME, projectId);
+	public getAttachRequest(appId: string, deviceId: string): string {
+		this.emit(ATTACH_REQUEST_EVENT_NAME, { deviceId, appId });
+		return this.formatNotification(IOSNotification.ATTACH_REQUEST_NOTIFICATION_NAME, appId);
 	}
 
 	public getAppLaunching(projectId: string): string {

lib/device-sockets/ios/notification.ts

@@ -61,7 +61,7 @@ export class IOSSocketRequestExecutor implements IiOSSocketRequestExecutor {
 			const readyForAttachSocket = await this.$iOSNotificationService.postNotification(deviceIdentifier, this.$iOSNotification.getReadyForAttach(projectId), constants.IOS_OBSERVE_NOTIFICATION_COMMAND_TYPE);
 			const readyForAttachPromise = this.$iOSNotificationService.awaitNotification(deviceIdentifier, +readyForAttachSocket, readyForAttachTimeout);
 
-			await this.$iOSNotificationService.postNotification(deviceIdentifier, this.$iOSNotification.getAttachRequest(projectId));
+			await this.$iOSNotificationService.postNotification(deviceIdentifier, this.$iOSNotification.getAttachRequest(projectId, deviceIdentifier));
 			await readyForAttachPromise;
 		} catch (e) {
 			this.$logger.trace("Launch request error:");
@@ -76,7 +76,7 @@ export class IOSSocketRequestExecutor implements IiOSSocketRequestExecutor {
 			// before we send the PostNotification.
 			const readyForAttachSocket = await this.$iOSNotificationService.postNotification(deviceIdentifier, this.$iOSNotification.getReadyForAttach(projectId), constants.IOS_OBSERVE_NOTIFICATION_COMMAND_TYPE);
 			const readyForAttachPromise = this.$iOSNotificationService.awaitNotification(deviceIdentifier, +readyForAttachSocket, timeout);
-			await this.$iOSNotificationService.postNotification(deviceIdentifier, this.$iOSNotification.getAttachRequest(projectId));
+			await this.$iOSNotificationService.postNotification(deviceIdentifier, this.$iOSNotification.getAttachRequest(projectId, deviceIdentifier));
 			await readyForAttachPromise;
 		} catch (e) {
 			this.$errors.failWithoutHelp(`The application ${projectId} timed out when performing the socket handshake.`);