Merge pull request #4455 from NativeScript/tachev/ios-crashes-livesync

Dimitar Tachev · web-flow · commit 70050a51a4be · 2019-03-21T13:10:11.000+02:00
fix: do not wait 60 seconds for debugger port when the app is crashed
diff --git a/lib/common/constants.ts b/lib/common/constants.ts
@@ -54,6 +54,7 @@ export class EmulatorDiscoveryNames {
 
 export const DEVICE_LOG_EVENT_NAME = "deviceLogData";
 export const IOS_LOG_PREDICATE = 'senderImagePath contains "NativeScript" || eventMessage contains[c] "NativeScript"';
+export const IOS_APP_CRASH_LOG_REG_EXP = /Fatal JavaScript exception \- application has been terminated/;
 
 export const TARGET_FRAMEWORK_IDENTIFIERS = {
 	Cordova: "Cordova",
diff --git a/lib/common/mobile/ios/device/ios-device.ts b/lib/common/mobile/ios/device/ios-device.ts
@@ -60,8 +60,7 @@ export class IOSDevice extends IOSDeviceBase {
 		}
 	}
 
-	protected async getDebugSocketCore(appId: string, projectName: string): Promise<net.Socket> {
-		await super.attachToDebuggerFoundEvent(projectName);
+	protected async getDebugSocketCore(appId: string): Promise<net.Socket> {
 		await this.$iOSSocketRequestExecutor.executeAttachRequest(this, constants.AWAIT_NOTIFICATION_TIMEOUT_SECONDS, appId);
 		const port = await super.getDebuggerPort(appId);
 		const deviceId = this.deviceInfo.identifier;
diff --git a/lib/common/mobile/ios/ios-device-base.ts b/lib/common/mobile/ios/ios-device-base.ts
@@ -22,7 +22,9 @@ export abstract class IOSDeviceBase implements Mobile.IiOSDevice {
 					return this.cachedSockets[appId];
 				}
 
-				this.cachedSockets[appId] = await this.getDebugSocketCore(appId, projectName);
+				await this.attachToDebuggerFoundEvent(appId, projectName);
+				await this.applicationManager.startApplication({ appId, projectName });
+				this.cachedSockets[appId] = await this.getDebugSocketCore(appId);
 
 				if (this.cachedSockets[appId]) {
 					this.cachedSockets[appId].on("close", async () => {
@@ -38,11 +40,11 @@ export abstract class IOSDeviceBase implements Mobile.IiOSDevice {
 		);
 	}
 
-	protected abstract async getDebugSocketCore(appId: string, projectName: string): Promise<net.Socket>;
+	protected abstract async getDebugSocketCore(appId: string): Promise<net.Socket>;
 
-	protected async attachToDebuggerFoundEvent(projectName: string): Promise<void> {
+	protected async attachToDebuggerFoundEvent(appId: string, projectName: string): Promise<void> {
 		await this.startDeviceLogProcess(projectName);
-		await this.$iOSDebuggerPortService.attachToDebuggerPortFoundEvent();
+		await this.$iOSDebuggerPortService.attachToDebuggerPortFoundEvent(appId);
 	}
 
 	protected async getDebuggerPort(appId: string): Promise<number> {
diff --git a/lib/common/mobile/ios/simulator/ios-simulator-device.ts b/lib/common/mobile/ios/simulator/ios-simulator-device.ts
@@ -53,9 +53,8 @@ export class IOSSimulator extends IOSDeviceBase implements Mobile.IiOSDevice {
 		return this.$iOSSimulatorLogProvider.startLogProcess(this.simulator.id, options);
 	}
 
-	protected async getDebugSocketCore(appId: string, projectName: string): Promise<net.Socket> {
+	protected async getDebugSocketCore(appId: string): Promise<net.Socket> {
 		let socket: net.Socket;
-		await super.attachToDebuggerFoundEvent(projectName);
 		const attachRequestMessage = this.$iOSNotification.getAttachRequest(appId, this.deviceInfo.identifier);
 		await this.$iOSEmulatorServices.postDarwinNotification(attachRequestMessage, this.deviceInfo.identifier);
 		const port = await super.getDebuggerPort(appId);
diff --git a/lib/definitions/hmr-status-service.d.ts b/lib/definitions/hmr-status-service.d.ts
@@ -1,4 +1,5 @@
 interface IHmrStatusService {
+	watchHmrStatus(deviceId: string, operationHash: string): void;
 	getHmrStatus(deviceId: string, operationHash: string): Promise<number>;
 	attachToHmrStatusEvent(): void;
 }
diff --git a/lib/definitions/ios-debugger-port-service.d.ts b/lib/definitions/ios-debugger-port-service.d.ts
@@ -12,6 +12,7 @@ interface IIOSDebuggerPortData {
 interface IIOSDebuggerPortStoredData {
 	port: number;
 	timer?: NodeJS.Timer;
+	error?: Error;
 }
 
 interface IIOSDebuggerPortService {
@@ -24,5 +25,5 @@ interface IIOSDebuggerPortService {
 	 * Attaches on DEBUGGER_PORT_FOUND event and stores the port
 	 * @returns {Promise<void>}
 	 */
-	attachToDebuggerPortFoundEvent(): Promise<void>;
+	attachToDebuggerPortFoundEvent(appId: string): Promise<void>;
 }
diff --git a/lib/services/hmr-status-service.ts b/lib/services/hmr-status-service.ts
@@ -1,5 +1,5 @@
 import { cache } from "../common/decorators";
-import { HmrConstants } from "../common/constants";
+import { HmrConstants, IOS_APP_CRASH_LOG_REG_EXP } from "../common/constants";
 
 export class HmrStatusService implements IHmrStatusService {
 	public static HMR_STATUS_LOG_REGEX = /([a-z A-Z]*) hmr hash ([a-z0-9]*)\./;
@@ -11,9 +11,10 @@ export class HmrStatusService implements IHmrStatusService {
 
 	constructor(private $logParserService: ILogParserService,
 		private $processService: IProcessService,
+		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $logger: ILogger) {
-			this.$processService.attachToProcessExitSignals(this, this.dispose);
-		}
+		this.$processService.attachToProcessExitSignals(this, this.dispose);
+	}
 
 	public getHmrStatus(deviceId: string, operationHash: string): Promise<number> {
 		return new Promise((resolve, reject) => {
@@ -33,13 +34,32 @@ export class HmrStatusService implements IHmrStatusService {
 		});
 	}
 
+	public watchHmrStatus(deviceId: string, operationHash: string): void {
+		this.setData(deviceId, operationHash);
+	}
+
 	@cache()
 	public attachToHmrStatusEvent(): void {
 		this.$logParserService.addParseRule({
 			regex: HmrStatusService.HMR_STATUS_LOG_REGEX,
 			handler: this.handleHmrStatusFound.bind(this),
 			name: "hmrStatus"
 		});
+		this.$logParserService.addParseRule({
+			regex: IOS_APP_CRASH_LOG_REG_EXP,
+			handler: this.handleAppCrash.bind(this),
+			name: "appCrashHmr",
+			platform: this.$devicePlatformsConstants.iOS.toLowerCase()
+		});
+	}
+
+	private handleAppCrash(matches: RegExpMatchArray, deviceId: string): void {
+		for (const operationId in this.hashOperationStatuses) {
+			const operation = this.hashOperationStatuses[operationId];
+			if (operationId.startsWith(deviceId) && !operation.status) {
+				operation.status = HmrConstants.HMR_ERROR_STATUS;
+			}
+		}
 	}
 
 	private handleHmrStatusFound(matches: RegExpMatchArray, deviceId: string): void {
@@ -65,7 +85,7 @@ export class HmrStatusService implements IHmrStatusService {
 		this.$logger.trace("Found hmr status.", { status, hash });
 
 		if (status) {
-			this.setData(status, hash, deviceId);
+			this.setData(deviceId, hash, status);
 		}
 	}
 
@@ -77,7 +97,7 @@ export class HmrStatusService implements IHmrStatusService {
 		return null;
 	}
 
-	private setData(status: Number, operationHash: string, deviceId: string): void {
+	private setData(deviceId: string, operationHash: string, status?: Number): void {
 		const key = `${deviceId}${operationHash}`;
 
 		if (!this.hashOperationStatuses[key]) {
diff --git a/lib/services/ios-debugger-port-service.ts b/lib/services/ios-debugger-port-service.ts
@@ -1,36 +1,42 @@
-import { DEBUGGER_PORT_FOUND_EVENT_NAME, ATTACH_REQUEST_EVENT_NAME } from "../common/constants";
+import { DEBUGGER_PORT_FOUND_EVENT_NAME, ATTACH_REQUEST_EVENT_NAME, IOS_APP_CRASH_LOG_REG_EXP } from "../common/constants";
 import { cache } from "../common/decorators";
 import { APPLICATION_RESPONSE_TIMEOUT_SECONDS } from "../constants";
 
 export class IOSDebuggerPortService implements IIOSDebuggerPortService {
 	public static DEBUG_PORT_LOG_REGEX = /NativeScript debugger has opened inspector socket on port (\d+?) for (.*)[.]/;
 	private mapDebuggerPortData: IDictionary<IIOSDebuggerPortStoredData> = {};
+	private currentAppId: string;
 
 	constructor(private $logParserService: ILogParserService,
 		private $iOSNotification: IiOSNotification,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $logger: ILogger) { }
 
-	public getPort(data: IIOSDebuggerPortInputData): Promise<number> {
-		return new Promise((resolve, reject) => {
+	public async getPort(data: IIOSDebuggerPortInputData): Promise<number> {
+		return new Promise<number>((resolve, reject) => {
 			const key = `${data.deviceId}${data.appId}`;
 			const retryInterval = 500;
 			let retryCount = Math.max(APPLICATION_RESPONSE_TIMEOUT_SECONDS * 1000 / retryInterval, 10);
 
 			const interval = setInterval(() => {
-				let port = this.getPortByKey(key);
+				const port = this.getPortByKey(key);
 				if (port || retryCount === 0) {
 					clearInterval(interval);
 					resolve(port);
 				} else {
-					port = this.getPortByKey(key);
-					retryCount--;
+					if (this.mapDebuggerPortData[key] && this.mapDebuggerPortData[key].error) {
+						clearInterval(interval);
+						reject(this.mapDebuggerPortData[key].error);
+					} else {
+						retryCount--;
+					}
 				}
 			}, retryInterval);
 		});
 	}
 
-	public async attachToDebuggerPortFoundEvent(): Promise<void> {
+	public async attachToDebuggerPortFoundEvent(appId: string): Promise<void> {
+		this.currentAppId = appId;
 		this.attachToDebuggerPortFoundEventCore();
 		this.attachToAttachRequestEvent();
 	}
@@ -43,6 +49,24 @@ export class IOSDebuggerPortService implements IIOSDebuggerPortService {
 			name: "debugPort",
 			platform: this.$devicePlatformsConstants.iOS.toLowerCase()
 		});
+		this.$logParserService.addParseRule({
+			regex: IOS_APP_CRASH_LOG_REG_EXP,
+			handler: this.handleAppCrash.bind(this),
+			name: "appCrash",
+			platform: this.$devicePlatformsConstants.iOS.toLowerCase()
+		});
+	}
+
+	private handleAppCrash(matches: RegExpMatchArray, deviceId: string): void {
+		const data = {
+			port: 0,
+			appId: this.currentAppId,
+			deviceId,
+			error: new Error("The application has been terminated.")
+		};
+
+		this.clearTimeout(data);
+		this.setData(data, { port: data.port, error: data.error });
 	}
 
 	private handlePortFound(matches: RegExpMatchArray, deviceId: string): void {
@@ -73,7 +97,7 @@ export class IOSDebuggerPortService implements IIOSDebuggerPortService {
 	}
 
 	private getPortByKey(key: string): number {
-		if (this.mapDebuggerPortData[key]) {
+		if (this.mapDebuggerPortData[key] && this.mapDebuggerPortData[key].port) {
 			return this.mapDebuggerPortData[key].port;
 		}
 
@@ -89,6 +113,7 @@ export class IOSDebuggerPortService implements IIOSDebuggerPortService {
 
 		this.mapDebuggerPortData[key].port = storedData.port;
 		this.mapDebuggerPortData[key].timer = storedData.timer;
+		this.mapDebuggerPortData[key].error = storedData.error;
 	}
 
 	private clearTimeout(data: IIOSDebuggerPortData): void {
diff --git a/lib/services/livesync/livesync-service.ts b/lib/services/livesync/livesync-service.ts
@@ -664,12 +664,17 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 										const service = this.getLiveSyncService(device.deviceInfo.platform);
 
 										const watchAction = async (watchInfo: ILiveSyncWatchInfo): Promise<void> => {
+											const isInHMRMode = liveSyncData.useHotModuleReload && platformHmrData.hash;
+											if (isInHMRMode) {
+												this.$hmrStatusService.watchHmrStatus(device.deviceInfo.identifier, platformHmrData.hash);
+											}
+
 											let liveSyncResultInfo = await service.liveSyncWatchAction(device, watchInfo);
 
 											await this.refreshApplication(projectData, liveSyncResultInfo, deviceBuildInfoDescriptor.debugOptions, deviceBuildInfoDescriptor.outputPath);
 
-											// If didRecover is true, this means we were in ErrorActivity and fallback files were already transfered and app will be restarted.
-											if (!liveSyncResultInfo.didRecover && liveSyncData.useHotModuleReload && platformHmrData.hash) {
+											// If didRecover is true, this means we were in ErrorActivity and fallback files were already transferred and app will be restarted.
+											if (!liveSyncResultInfo.didRecover && isInHMRMode) {
 												const status = await this.$hmrStatusService.getHmrStatus(device.deviceInfo.identifier, platformHmrData.hash);
 												if (status === HmrConstants.HMR_ERROR_STATUS) {
 													watchInfo.filesToSync = platformHmrData.fallbackFiles;
diff --git a/test/services/ios-debugger-port-service.ts b/test/services/ios-debugger-port-service.ts

Original file line number	Diff line number	Diff line change
`@@ -60,8 +60,7 @@ export class IOSDevice extends IOSDeviceBase {`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`- protected async getDebugSocketCore(appId: string, projectName: string): Promise<net.Socket> {`
`64`		`- await super.attachToDebuggerFoundEvent(projectName);`
	`63`	`+ protected async getDebugSocketCore(appId: string): Promise<net.Socket> {`
`65`	`64`	`await this.$iOSSocketRequestExecutor.executeAttachRequest(this, constants.AWAIT_NOTIFICATION_TIMEOUT_SECONDS, appId);`
`66`	`65`	`const port = await super.getDebuggerPort(appId);`
`67`	`66`	`const deviceId = this.deviceInfo.identifier;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`interface IHmrStatusService {`
	`2`	`+ watchHmrStatus(deviceId: string, operationHash: string): void;`
`2`	`3`	`getHmrStatus(deviceId: string, operationHash: string): Promise<number>;`
`3`	`4`	`attachToHmrStatusEvent(): void;`
`4`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ interface IIOSDebuggerPortData {`
`12`	`12`	`interface IIOSDebuggerPortStoredData {`
`13`	`13`	`port: number;`
`14`	`14`	`timer?: NodeJS.Timer;`
	`15`	`+ error?: Error;`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`interface IIOSDebuggerPortService {`
`@@ -24,5 +25,5 @@ interface IIOSDebuggerPortService {`
`24`	`25`	`* Attaches on DEBUGGER_PORT_FOUND event and stores the port`
`25`	`26`	`* @returns {Promise<void>}`
`26`	`27`	`*/`
`27`		`- attachToDebuggerPortFoundEvent(): Promise<void>;`
	`28`	`+ attachToDebuggerPortFoundEvent(appId: string): Promise<void>;`
`28`	`29`	`}`