Merge pull request #3941 from NativeScript/kddimitrov/make-log-parser-generic

KristianDD · web-flow · commit a51122b4f8f5 · 2018-09-28T12:57:30.000+03:00
feat: make log parser logic to work with multiple rules
diff --git a/lib/bootstrap.ts b/lib/bootstrap.ts
@@ -176,7 +176,7 @@ $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("logParserService", "./services/log-parser-service");
 $injector.require("iOSDebuggerPortService", "./services/ios-debugger-port-service");
 
 $injector.require("pacoteService", "./services/pacote-service");
diff --git a/lib/common/appbuilder/device-log-provider.ts b/lib/common/appbuilder/device-log-provider.ts
@@ -1,4 +1,5 @@
 import { DeviceLogProviderBase } from "../mobile/device-log-provider-base";
+import { DEVICE_LOG_EVENT_NAME } from "../constants";
 
 export class DeviceLogProvider extends DeviceLogProviderBase {
 	constructor(protected $logFilter: Mobile.ILogFilter,
@@ -15,6 +16,7 @@ export class DeviceLogProvider extends DeviceLogProviderBase {
 
 		if (data) {
 			this.emit('data', deviceIdentifier, data);
+			this.emit(DEVICE_LOG_EVENT_NAME, data, deviceIdentifier);
 		}
 	}
 
diff --git a/lib/common/commands/device/device-log-stream.ts b/lib/common/commands/device/device-log-stream.ts
@@ -1,3 +1,5 @@
+import { IOS_LOG_PREDICATE } from "../../constants";
+
 export class OpenDeviceLogStreamCommand implements ICommand {
 	private static NOT_SPECIFIED_DEVICE_ERROR_MESSAGE = "More than one device found. Specify device explicitly.";
 
@@ -23,7 +25,7 @@ export class OpenDeviceLogStreamCommand implements ICommand {
 			this.$errors.fail(OpenDeviceLogStreamCommand.NOT_SPECIFIED_DEVICE_ERROR_MESSAGE);
 		}
 
-		const action = (device: Mobile.IiOSDevice) => device.openDeviceLogStream({predicate: 'senderImagePath contains "NativeScript"'});
+		const action = (device: Mobile.IiOSDevice) => device.openDeviceLogStream({predicate: IOS_LOG_PREDICATE});
 		await this.$devicesService.execute(action);
 	}
 }
diff --git a/lib/common/constants.ts b/lib/common/constants.ts
@@ -59,6 +59,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 TARGET_FRAMEWORK_IDENTIFIERS = {
 	Cordova: "Cordova",
diff --git a/lib/common/definitions/mobile.d.ts b/lib/common/definitions/mobile.d.ts
@@ -186,7 +186,7 @@ declare module Mobile {
 	/**
 	 * Describes methods for providing device logs to a specific consumer.
 	 */
-	interface IDeviceLogProvider {
+	interface IDeviceLogProvider extends NodeJS.EventEmitter {
 		/**
 		 * Logs data in the specific way for the consumer.
 		 * @param {string} line String from the device logs.
@@ -248,12 +248,6 @@ declare module Mobile {
 		 * @param {Mobile.IiOSLogStreamOptions} options Describes the options which can be passed
 		 */
 		startLogProcess(deviceId: string, options?: Mobile.IiOSLogStreamOptions): Promise<void>;
-		/**
-		 * Starts a new process for getting simulator logs and emits and DEVICE_LOG_EVENT_NAME event. The event's reponse is with muted=true flag so it will not be printed from deviceLogProvider.
-		 * @param {string} deviceId The unique identifier of the device.
-		 * @param {Mobile.IiOSLogStreamOptions} options Describes the options which can be passed
-		 */
-		startNewMutedLogProcess(deviceId: string, options?: Mobile.IiOSLogStreamOptions): Promise<void>;
 	}
 
 	/**
diff --git a/lib/common/mobile/device-log-provider.ts b/lib/common/mobile/device-log-provider.ts
@@ -1,4 +1,5 @@
 import { DeviceLogProviderBase } from "./device-log-provider-base";
+import { DEVICE_LOG_EVENT_NAME } from "../constants";
 
 export class DeviceLogProvider extends DeviceLogProviderBase {
 	constructor(protected $logFilter: Mobile.ILogFilter,
@@ -11,6 +12,7 @@ export class DeviceLogProvider extends DeviceLogProviderBase {
 		const data = this.$logFilter.filterData(platform, lineText, loggingOptions);
 		if (data) {
 			this.$logger.write(data);
+			this.emit(DEVICE_LOG_EVENT_NAME, lineText, deviceIdentifier);
 		}
 	}
 
diff --git a/lib/common/mobile/ios/simulator/ios-simulator-application-manager.ts b/lib/common/mobile/ios/simulator/ios-simulator-application-manager.ts
@@ -3,6 +3,7 @@ import * as path from "path";
 import * as temp from "temp";
 import { hook, getPidFromiOSSimulatorLogs } from "../../../helpers";
 import { cache } from "../../../decorators";
+import { IOS_LOG_PREDICATE } from "../../../constants";
 
 export class IOSSimulatorApplicationManager extends ApplicationManagerBase {
 	constructor(private iosSim: any,
@@ -104,6 +105,6 @@ export class IOSSimulatorApplicationManager extends ApplicationManagerBase {
 
 	@cache()
 	private startDeviceLog(): Promise<void> {
-		return this.device.openDeviceLogStream({predicate: 'senderImagePath contains "NativeScript"'});
+		return this.device.openDeviceLogStream({predicate: IOS_LOG_PREDICATE});
 	}
 }
diff --git a/lib/common/mobile/ios/simulator/ios-simulator-device.ts b/lib/common/mobile/ios/simulator/ios-simulator-device.ts
@@ -6,11 +6,9 @@ import { cache } from "../../../decorators";
 export class IOSSimulator implements Mobile.IiOSSimulator {
 	private _applicationManager: Mobile.IDeviceApplicationManager;
 	private _fileSystem: Mobile.IDeviceFileSystem;
-	private _deviceLogHandler: Function;
 
 	constructor(private simulator: Mobile.IiSimDevice,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
-		private $deviceLogProvider: Mobile.IDeviceLogProvider,
 		private $injector: IInjector,
 		private $iOSSimResolver: Mobile.IiOSSimResolver,
 		private $iOSSimulatorLogProvider: Mobile.IiOSSimulatorLogProvider) { }
@@ -57,20 +55,6 @@ export class IOSSimulator implements Mobile.IiOSSimulator {
 
 	@cache()
 	public async openDeviceLogStream(options?: Mobile.IiOSLogStreamOptions): Promise<void> {
-		this._deviceLogHandler = this.onDeviceLog.bind(this, options);
-		this.$iOSSimulatorLogProvider.on(constants.DEVICE_LOG_EVENT_NAME, this._deviceLogHandler);
 		return this.$iOSSimulatorLogProvider.startLogProcess(this.simulator.id, options);
 	}
-
-	public detach(): void {
-		if (this._deviceLogHandler) {
-			this.$iOSSimulatorLogProvider.removeListener(constants.DEVICE_LOG_EVENT_NAME, this._deviceLogHandler);
-		}
-	}
-
-	private onDeviceLog(options: Mobile.IiOSLogStreamOptions, response: IOSDeviceLib.IDeviceLogData): void {
-		if (response.deviceId === this.deviceInfo.identifier && !(<any>response).muted) {
-			this.$deviceLogProvider.logData(response.message, this.$devicePlatformsConstants.iOS, this.deviceInfo.identifier);
-		}
-	}
 }
diff --git a/lib/common/mobile/ios/simulator/ios-simulator-log-provider.ts b/lib/common/mobile/ios/simulator/ios-simulator-log-provider.ts
@@ -1,5 +1,4 @@
 import { ChildProcess } from "child_process";
-import { DEVICE_LOG_EVENT_NAME } from "../../../constants";
 import { EventEmitter } from "events";
 
 export class IOSSimulatorLogProvider extends EventEmitter implements Mobile.IiOSSimulatorLogProvider, IDisposable, IShouldDispose {
@@ -9,7 +8,9 @@ export class IOSSimulatorLogProvider extends EventEmitter implements Mobile.IiOS
 
 	constructor(private $iOSSimResolver: Mobile.IiOSSimResolver,
 		private $logger: ILogger,
-		private $processService: IProcessService) {
+		private $processService: IProcessService,
+		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
+		private $deviceLogProvider: Mobile.IDeviceLogProvider) {
 			super();
 			this.shouldDispose = true;
 		}
@@ -24,7 +25,7 @@ export class IOSSimulatorLogProvider extends EventEmitter implements Mobile.IiOS
 
 			const action = (data: NodeBuffer | string) => {
 				const message = data.toString();
-				this.emit(DEVICE_LOG_EVENT_NAME, { deviceId, message, muted: (options || {}).muted });
+				this.$deviceLogProvider.logData(message, this.$devicePlatformsConstants.iOS, deviceId);
 			};
 
 			if (deviceLogChildProcess) {
@@ -53,14 +54,6 @@ export class IOSSimulatorLogProvider extends EventEmitter implements Mobile.IiOS
 		}
 	}
 
-	public async startNewMutedLogProcess(deviceId: string, options?: Mobile.IiOSLogStreamOptions): Promise<void> {
-		options = options || {};
-		options.muted = true;
-		this.simulatorsLoggingEnabled[deviceId] = false;
-		await this.startLogProcess(deviceId, options);
-		this.simulatorsLoggingEnabled[deviceId] = false;
-	}
-
 	public dispose(signal?: any) {
 		if (this.shouldDispose) {
 			_.each(this.simulatorsLogProcess, (logProcess: ChildProcess, deviceId: string) => {
diff --git a/lib/common/test/unit-tests/stubs.ts b/lib/common/test/unit-tests/stubs.ts
@@ -1,6 +1,7 @@
 /* tslint:disable:no-empty */
 
 import * as util from "util";
+import { EventEmitter } from "events";
 
 export class CommonLoggerStub implements ILogger {
 	setLevel(level: string): void { }
@@ -146,7 +147,7 @@ export class LogcatHelperStub implements Mobile.ILogcatHelper {
 	}
 }
 
-export class DeviceLogProviderStub implements Mobile.IDeviceLogProvider {
+export class DeviceLogProviderStub extends EventEmitter implements Mobile.IDeviceLogProvider {
 	public logger = new CommonLoggerStub();
 	public currentDevicePids: IStringDictionary = {};
 	public currentDeviceProjectNames: IStringDictionary = {};
diff --git a/lib/definitions/ios-debugger-port-service.d.ts b/lib/definitions/ios-debugger-port-service.d.ts
@@ -3,8 +3,10 @@ interface IIOSDebuggerPortInputData extends IProjectDir {
 	appId: string;
 }
 
-interface IIOSDebuggerPortData extends IIOSDebuggerPortInputData {
-	port: number;
+interface IIOSDebuggerPortData {
+	port: number,
+	deviceId: string;
+	appId: string;
 }
 
 interface IIOSDebuggerPortStoredData {
diff --git a/lib/definitions/log-parser-service.d.ts b/lib/definitions/log-parser-service.d.ts
@@ -1,7 +1,14 @@
-interface IIOSLogParserService extends NodeJS.EventEmitter {
+interface ILogParserService 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, data: IProjectName): Promise<void>;
+	addParseRule(rule: ILogParseRule): void;
 }
+
+interface ILogParseRule {
+	regex: RegExp,
+	handler: Function,
+	name: string,
+	platform?: string
+}
diff --git a/lib/services/ios-debugger-port-service.ts b/lib/services/ios-debugger-port-service.ts
@@ -3,15 +3,17 @@ import { cache } from "../common/decorators";
 import * as semver from "semver";
 
 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 static DEFAULT_PORT = 18181;
 	private static MIN_REQUIRED_FRAMEWORK_VERSION = "4.0.1";
 	private static DEFAULT_TIMEOUT_IN_SECONDS = 10;
 
-	constructor(private $iOSLogParserService: IIOSLogParserService,
+	constructor(private $logParserService: ILogParserService,
 		private $iOSProjectService: IPlatformProjectService,
 		private $iOSNotification: IiOSNotification,
 		private $projectDataService: IProjectDataService,
+		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $logger: ILogger) { }
 
 	public getPort(data: IIOSDebuggerPortInputData, debugOptions?: IDebugOptions): Promise<number> {
@@ -46,8 +48,6 @@ export class IOSDebuggerPortService implements IIOSDebuggerPortService {
 
 		this.attachToDebuggerPortFoundEventCore();
 		this.attachToAttachRequestEvent(device, debugOptions);
-
-		await this.$iOSLogParserService.startParsingLog(device, projectData);
 	}
 
 	private canStartLookingForDebuggerPort(data: IProjectDir): boolean {
@@ -58,13 +58,26 @@ export class IOSDebuggerPortService implements IIOSDebuggerPortService {
 
 	@cache()
 	private attachToDebuggerPortFoundEventCore(): void {
-		this.$iOSLogParserService.on(DEBUGGER_PORT_FOUND_EVENT_NAME, (data: IIOSDebuggerPortData) => {
-			this.$logger.trace(DEBUGGER_PORT_FOUND_EVENT_NAME, data);
-			this.setData(data, { port: data.port });
-			this.clearTimeout(data);
+		this.$logParserService.addParseRule({
+			regex: IOSDebuggerPortService.DEBUG_PORT_LOG_REGEX,
+			handler: this.handlePortFound.bind(this),
+			name: "debugPort",
+			platform: this.$devicePlatformsConstants.iOS.toLowerCase()
 		});
 	}
 
+	private handlePortFound(matches: RegExpMatchArray, deviceId: string): void {
+		const data = {
+			port: parseInt(matches[1]),
+			appId: matches[2],
+			deviceId
+		};
+
+		this.$logger.trace(DEBUGGER_PORT_FOUND_EVENT_NAME, data);
+		this.setData(data, { port: data.port });
+		this.clearTimeout(data);
+	}
+
 	@cache()
 	private attachToAttachRequestEvent(device: Mobile.IDevice, debugOptions: IDebugOptions): void {
 		const timeout = this.getTimeout(debugOptions);
diff --git a/lib/services/ios-log-parser-service.ts b/lib/services/ios-log-parser-service.ts
diff --git a/lib/services/log-parser-service.ts b/lib/services/log-parser-service.ts
@@ -0,0 +1,44 @@
+import { DEVICE_LOG_EVENT_NAME } from "../common/constants";
+import { cache } from "../common/decorators";
+import { EventEmitter } from "events";
+
+export class LogParserService extends EventEmitter implements ILogParserService {
+	private parseRules: IDictionary<ILogParseRule> = {};
+
+	constructor(private $deviceLogProvider: Mobile.IDeviceLogProvider,
+		private $devicesService: Mobile.IDevicesService,
+		private $errors: IErrors) {
+		super();
+	}
+
+	public addParseRule(rule: ILogParseRule): void {
+		if (this.parseRules[rule.name]) {
+			this.$errors.failWithoutHelp("Log parse rule already exists.");
+		}
+
+		this.parseRules[rule.name] = rule;
+		this.startParsingLogCore();
+	}
+
+	@cache()
+	private startParsingLogCore(): void {
+		this.$deviceLogProvider.on(DEVICE_LOG_EVENT_NAME, (message: string, deviceIdentifier: string) => this.processDeviceLogResponse(message, deviceIdentifier));
+	}
+
+	private processDeviceLogResponse(message: string, deviceIdentifier: string) {
+		const device = this.$devicesService.getDeviceByIdentifier(deviceIdentifier);
+		const devicePlatform = device.deviceInfo.platform.toLowerCase();
+
+		_.forEach(this.parseRules, (parseRule) => {
+			if (!parseRule.platform || parseRule.platform.toLowerCase() === devicePlatform) {
+				const matches = parseRule.regex.exec(message);
+
+				if (matches) {
+					parseRule.handler(matches, deviceIdentifier);
+				}
+			}
+		});
+	}
+}
+
+$injector.register("logParserService", LogParserService);
diff --git a/test/services/ios-debugger-port-service.ts b/test/services/ios-debugger-port-service.ts
diff --git a/test/services/ios-log-parser-service.ts b/test/services/ios-log-parser-service.ts
diff --git a/test/services/log-parser-service.ts b/test/services/log-parser-service.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import { DeviceLogProviderBase } from "../mobile/device-log-provider-base";`
	`2`	`+import { DEVICE_LOG_EVENT_NAME } from "../constants";`
`2`	`3`
`3`	`4`	`export class DeviceLogProvider extends DeviceLogProviderBase {`
`4`	`5`	`constructor(protected $logFilter: Mobile.ILogFilter,`
`@@ -15,6 +16,7 @@ export class DeviceLogProvider extends DeviceLogProviderBase {`
`15`	`16`
`16`	`17`	`if (data) {`
`17`	`18`	`this.emit('data', deviceIdentifier, data);`
	`19`	`+ this.emit(DEVICE_LOG_EVENT_NAME, data, deviceIdentifier);`
`18`	`20`	`}`
`19`	`21`	`}`
`20`	`22`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import { IOS_LOG_PREDICATE } from "../../constants";`
	`2`	`+`
`1`	`3`	`export class OpenDeviceLogStreamCommand implements ICommand {`
`2`	`4`	`private static NOT_SPECIFIED_DEVICE_ERROR_MESSAGE = "More than one device found. Specify device explicitly.";`
`3`	`5`
`@@ -23,7 +25,7 @@ export class OpenDeviceLogStreamCommand implements ICommand {`
`23`	`25`	`this.$errors.fail(OpenDeviceLogStreamCommand.NOT_SPECIFIED_DEVICE_ERROR_MESSAGE);`
`24`	`26`	`}`
`25`	`27`
`26`		`- const action = (device: Mobile.IiOSDevice) => device.openDeviceLogStream({predicate: 'senderImagePath contains "NativeScript"'});`
	`28`	`+ const action = (device: Mobile.IiOSDevice) => device.openDeviceLogStream({predicate: IOS_LOG_PREDICATE});`
`27`	`29`	`await this.$devicesService.execute(action);`
`28`	`30`	`}`
`29`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,7 @@ export class EmulatorDiscoveryNames {`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`export const DEVICE_LOG_EVENT_NAME = "deviceLogData";`
	`62`	`+export const IOS_LOG_PREDICATE = 'senderImagePath contains "NativeScript" \|\| eventMessage contains[c] "NativeScript"';`
`62`	`63`
`63`	`64`	`export const TARGET_FRAMEWORK_IDENTIFIERS = {`
`64`	`65`	`Cordova: "Cordova",`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import * as path from "path";`
`3`	`3`	`import * as temp from "temp";`
`4`	`4`	`import { hook, getPidFromiOSSimulatorLogs } from "../../../helpers";`
`5`	`5`	`import { cache } from "../../../decorators";`
	`6`	`+import { IOS_LOG_PREDICATE } from "../../../constants";`
`6`	`7`
`7`	`8`	`export class IOSSimulatorApplicationManager extends ApplicationManagerBase {`
`8`	`9`	`constructor(private iosSim: any,`
`@@ -104,6 +105,6 @@ export class IOSSimulatorApplicationManager extends ApplicationManagerBase {`
`104`	`105`
`105`	`106`	`@cache()`
`106`	`107`	`private startDeviceLog(): Promise<void> {`
`107`		`- return this.device.openDeviceLogStream({predicate: 'senderImagePath contains "NativeScript"'});`
	`108`	`+ return this.device.openDeviceLogStream({predicate: IOS_LOG_PREDICATE});`
`108`	`109`	`}`
`109`	`110`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`/* tslint:disable:no-empty */`
`2`	`2`
`3`	`3`	`import * as util from "util";`
	`4`	`+import { EventEmitter } from "events";`
`4`	`5`
`5`	`6`	`export class CommonLoggerStub implements ILogger {`
`6`	`7`	`setLevel(level: string): void { }`
`@@ -146,7 +147,7 @@ export class LogcatHelperStub implements Mobile.ILogcatHelper {`
`146`	`147`	`}`
`147`	`148`	`}`
`148`	`149`
`149`		`-export class DeviceLogProviderStub implements Mobile.IDeviceLogProvider {`
	`150`	`+export class DeviceLogProviderStub extends EventEmitter implements Mobile.IDeviceLogProvider {`
`150`	`151`	`public logger = new CommonLoggerStub();`
`151`	`152`	`public currentDevicePids: IStringDictionary = {};`
`152`	`153`	`public currentDeviceProjectNames: IStringDictionary = {};`