Fix log in iOS11 simulators.

Author: Kristian D. Dimitrov

lib/declarations.ts

@@ -33,6 +33,7 @@ interface ISimctl {
 	uninstall(deviceId: string, applicationIdentifier: string, opts?: any): void;
 	notifyPost(deviceId: string, notification: string): void;
 	getDevices(): IDevice[];
+	getLog(deviceId: string): any;
 	getAppContainer(deviceId: string, applicationIdentifier: string): string;
 }
 

lib/iphone-simulator-common.ts

@@ -36,54 +36,6 @@ export function getInstalledApplications(deviceId: string): IApplication[] {
 	return result;
 }
 
-export function printDeviceLog(deviceId: string, launchResult?: string): any {
-	if (launchResult) {
-		pid = launchResult.split(":")[1].trim();
-	}
-
-	if (!isDeviceLogOperationStarted) {
-		deviceLogChildProcess = this.getDeviceLogProcess(deviceId);
-		if (deviceLogChildProcess.stdout) {
-			deviceLogChildProcess.stdout.on("data", (data: NodeBuffer) => {
-				let dataAsString = data.toString();
-				if (pid) {
-					if (dataAsString.indexOf(`[${pid}]`) > -1) {
-						process.stdout.write(dataAsString);
-					}
-				} else {
-					process.stdout.write(dataAsString);
-				}
-			});
-		}
-
-		if (deviceLogChildProcess.stderr) {
-			deviceLogChildProcess.stderr.on("data", (data: string) => {
-				let dataAsString = data.toString();
-				if (pid) {
-					if (dataAsString.indexOf(`[${pid}]`) > -1) {
-						process.stdout.write(dataAsString);
-					}
-				} else {
-					process.stdout.write(dataAsString);
-				}
-				process.stdout.write(data.toString());
-			});
-		}
-	}
-
-	return deviceLogChildProcess;
-}
-
-export function getDeviceLogProcess(deviceId: string): any {
-	if (!isDeviceLogOperationStarted) {
-		let logFilePath = path.join(osenv.home(), "Library", "Logs", "CoreSimulator", deviceId, "system.log");
-		deviceLogChildProcess = require("child_process").spawn("tail", ['-f', '-n', '1', logFilePath]);
-		isDeviceLogOperationStarted = true;
-	}
-
-	return deviceLogChildProcess;
-}
-
 export function startSimulator(deviceId: string): void {
 	let simulatorPath = path.resolve(xcode.getPathFromXcodeSelect(), "Applications", "Simulator.app");
 	let args = ["open", simulatorPath, '--args', '-CurrentDeviceUDID', deviceId];

lib/iphone-simulator-xcode-simctl.ts

@@ -15,8 +15,12 @@ import * as _ from "lodash";
 
 import { IPhoneSimulatorNameGetter } from "./iphone-simulator-name-getter";
 
+const osenv = require("osenv");
+
 export class XCodeSimctlSimulator extends IPhoneSimulatorNameGetter implements ISimulator {
 	private static DEVICE_IDENTIFIER_PREFIX = "com.apple.CoreSimulator.SimDeviceType";
+	private deviceLogChildProcess: any = null;
+	private isDeviceLogOperationStarted = false;
 	public defaultDeviceIdentifier = "iPhone 6";
 
 	private simctl: ISimctl = null;
@@ -116,11 +120,63 @@ export class XCodeSimctlSimulator extends IPhoneSimulatorNameGetter implements I
 	}
 
 	public printDeviceLog(deviceId: string, launchResult?: string): any {
-		return common.printDeviceLog(deviceId, launchResult);
+		let pid = "";
+		let deviceLogChildProcess;
+
+		if (launchResult) {
+			pid = launchResult.split(":")[1].trim();
+		}
+
+		if (!this.isDeviceLogOperationStarted) {
+			deviceLogChildProcess = this.getDeviceLogProcess(deviceId);
+			if (deviceLogChildProcess.stdout) {
+				deviceLogChildProcess.stdout.on("data", (data: NodeBuffer) => {
+					let dataAsString = data.toString();
+					if (pid) {
+						if (dataAsString.indexOf(`[${pid}]`) > -1 || dataAsString.indexOf(` ${pid} `) > -1) {
+							process.stdout.write(dataAsString);
+						}
+					} else {
+						process.stdout.write(dataAsString);
+					}
+				});
+			}
+
+			if (deviceLogChildProcess.stderr) {
+				deviceLogChildProcess.stderr.on("data", (data: string) => {
+					let dataAsString = data.toString();
+					if (pid) {
+						if (dataAsString.indexOf(`[${pid}]`) > -1 || dataAsString.indexOf(` ${pid} `) > -1) {
+							process.stdout.write(dataAsString);
+						}
+					} else {
+						process.stdout.write(dataAsString);
+					}
+					process.stdout.write(data.toString());
+				});
+			}
+		}
+
+		return deviceLogChildProcess;
 	}
 
 	public getDeviceLogProcess(deviceId: string): any {
-		return common.getDeviceLogProcess(deviceId);
+		const device = this.getDeviceFromIdentifier(deviceId) || {};
+		const deviceVersion = this.getDeviceFromIdentifier(deviceId).runtimeVersion || "";
+		const majorVersion = deviceVersion.split(".")[0];
+
+		if (!this.isDeviceLogOperationStarted) {
+			if(majorVersion && parseInt(majorVersion) >= 11) {
+				this.deviceLogChildProcess = this.simctl.getLog(deviceId);
+			} else {
+				let logFilePath = path.join(osenv.home(), "Library", "Logs", "CoreSimulator", deviceId, "system.log");
+				this.deviceLogChildProcess = require("child_process").spawn("tail", ['-f', '-n', '1', logFilePath]);
+			}
+
+			this.isDeviceLogOperationStarted = true;
+		}
+
+		return this.deviceLogChildProcess;
 	}
 
 	private getDeviceToRun(): IDevice {
@@ -195,6 +251,12 @@ export class XCodeSimctlSimulator extends IPhoneSimulatorNameGetter implements I
 		}
 	}
 
+	private getDeviceFromIdentifier(deviceId: string) {
+		const availableDevices = this.getDevices();
+
+		return _.find(availableDevices, { id: deviceId });
+	}
+
 	private killSimulator(): void {
 		childProcess.execSync("pkill -9 -f Simulator");
 	}

lib/simctl.ts

@@ -1,4 +1,5 @@
 import childProcess = require("./child-process");
+import * as child_process from "child_process";
 import errors = require("./errors");
 import options = require("./options");
 import * as _ from "lodash";
@@ -120,11 +121,19 @@ export class Simctl implements ISimctl {
 		return devices;
 	}
 
+	public getLog(deviceId: string): any {
+		return this.simctlSpawn("spawn", [deviceId, "log", "stream"]);
+	}
+
 	private simctlExec(command: string, args: string[], opts?: any): any {
 		let result = childProcess.spawnSync("xcrun", ["simctl", command].concat(args), opts);
-		if(result && result.stdout) {
+		if (result && result.stdout) {
 			return result.stdout.toString().trim();
 		}
 		return '';
 	}
+
+	private simctlSpawn(command: string, args: string[], opts?: any): any {
+		return child_process.spawn("xcrun", ["simctl", command].concat(args), opts);
+	}
 }