Merge pull request #577 from telerik/vladimirov/filter-device-logs

Add device log filtering

Author: rosen-vladimirov

README.md

@@ -7,9 +7,9 @@ Contains common infrastructure for CLIs - mainly AppBuilder and NativeScript.
 Installation
 ===
 
-Latest version: 0.3.0
+Latest version: 0.4.0
 
-Release date: 2015, December 21
+Release date: 2015, December 29
 
 ### System Requirements
 

appbuilder/device-log-provider.ts

@@ -4,8 +4,33 @@
 import { EventEmitter } from "events";
 
 export class DeviceLogProvider extends EventEmitter implements Mobile.IDeviceLogProvider {
+	private devicesLogLevel: IStringDictionary = {};
+
+	constructor(private $logFilter: Mobile.ILogFilter) {
+		super();
+	}
+
 	public logData(line: string, platform: string, deviceIdentifier?: string): void {
-		this.emit('data', deviceIdentifier, line);
+		let logLevel = this.$logFilter.loggingLevel;
+		if(deviceIdentifier) {
+			logLevel = this.devicesLogLevel[deviceIdentifier] = this.devicesLogLevel[deviceIdentifier] || this.$logFilter.loggingLevel;
+		}
+
+		let data = this.$logFilter.filterData(platform, line, logLevel);
+		if(data) {
+			this.emit('data', deviceIdentifier, data);
+		}
+	}
+
+	public setLogLevel(logLevel: string, deviceIdentifier?: string): void {
+		if(deviceIdentifier) {
+			this.devicesLogLevel[deviceIdentifier] = logLevel.toUpperCase();
+		} else {
+			this.$logFilter.loggingLevel = logLevel.toUpperCase();
+			_.each(this.devicesLogLevel, (deviceLogLevel: string, deviceId: string) => {
+				this.devicesLogLevel[deviceId] = this.$logFilter.loggingLevel;
+			});
+		}
 	}
 }
 $injector.register("deviceLogProvider", DeviceLogProvider);

bootstrap.ts

@@ -104,3 +104,8 @@ $injector.requireCommand("doctor", "./commands/doctor");
 $injector.require("utils", "./utils");
 $injector.require("bplistParser", "./bplist-parser");
 $injector.require("winreg", "./winreg");
+
+$injector.require("loggingLevels", "./mobile/logging-levels");
+$injector.require("logFilter", "./mobile/log-filter");
+$injector.require("androidLogFilter", "./mobile/android/android-log-filter");
+$injector.require("iOSLogFilter", "./mobile/ios/ios-log-filter");

commands/device/device-log-stream.ts

@@ -7,12 +7,16 @@ export class OpenDeviceLogStreamCommand implements ICommand {
 	constructor(private $devicesService: Mobile.IDevicesService,
 		private $errors: IErrors,
 		private $commandsService: ICommandsService,
-		private $options: ICommonOptions) { }
+		private $options: ICommonOptions,
+		private $deviceLogProvider: Mobile.IDeviceLogProvider,
+		private $loggingLevels: Mobile.ILoggingLevels) { }
 
 	allowedParameters: ICommandParameter[] = [];
 
 	public execute(args: string[]): IFuture<void> {
 		return (() => {
+			this.$deviceLogProvider.setLogLevel(this.$loggingLevels.full);
+
 			this.$devicesService.initialize({ deviceId: this.$options.device, skipInferPlatform: true }).wait();
 
 			if (this.$devicesService.deviceCount > 1) {

definitions/mobile.d.ts

@@ -69,6 +69,45 @@ declare module Mobile {
 
 	interface IDeviceLogProvider {
 		logData(line: string, platform: string, deviceIdentifier: string): void;
+		setLogLevel(level: string, deviceIdentifier?: string): void;
+	}
+
+	/**
+	 * Describes common filtering rules for device logs.
+	 */
+	interface ILogFilter {
+		/**
+		 * The logging level that will be used for filtering in case logLevel is not passed to filterData method.
+		 * Defaults to INFO.
+		 */
+		loggingLevel: string;
+
+		/**
+		 * Filters data for specified platform.
+		 * @param {string} platform The platform for which is the device log.
+		 * @param {string} data The input data for filtering.
+		 * @param {string} logLevel @optional The logging level based on which input data will be filtered.
+		 * @return {string} The filtered result based on the input or null when the input data shouldn't be shown.
+		 */
+		filterData(platform: string, data: string, logLevel?: string): string;
+	}
+
+	/**
+	 * Describes filtering logic for specific platform (Android, iOS).
+	 */
+	interface IPlatformLogFilter {
+		/**
+		 * Filters passed string data based on the passed logging level.
+		 * @param {string} data The string data that will be checked based on the logging level.
+		 * @param {string} logLevel Selected logging level.
+		 * @return {string} The filtered result based on the input or null when the input data shouldn't be shown.
+		 */
+		filterData(data: string, logLevel: string): string;
+	}
+
+	interface ILoggingLevels {
+		info: string;
+		full: string;
 	}
 
 	interface IDeviceApplicationManager {

helpers.ts

@@ -237,7 +237,7 @@ export function hook(commandName: string) {
 }
 
 export function isFuture(candidateFuture: any): boolean {
-	return candidateFuture && typeof(candidateFuture.wait) === "function";
+	return !!(candidateFuture && typeof(candidateFuture.wait) === "function");
 }
 
 export function whenAny<T>(...futures: IFuture<T>[]): IFuture<IFuture<T>> {

mobile/android/android-log-filter.ts

@@ -0,0 +1,44 @@
+///<reference path="../../.d.ts"/>
+"use strict";
+
+export class AndroidLogFilter implements Mobile.IPlatformLogFilter {
+
+	//sample line is "I/Web Console(    4438): Received Event: deviceready at file:///storage/emulated/0/Icenium/com.telerik.TestApp/js/index.js:48"
+	private static LINE_REGEX = /.\/(.+?)\s*\(\s*\d+?\): (.*)/;
+
+	// sample line is "11-23 12:39:07.310  1584  1597 I art     : Background sticky concurrent mark sweep GC freed 21966(1780KB) AllocSpace objects, 4(80KB) LOS objects, 77% free, 840KB/3MB, paused 4.018ms total 158.629ms"
+	// or '12-28 10:45:08.020  3329  3329 W chromium: [WARNING:data_reduction_proxy_settings.cc(328)] SPDY proxy OFF at startup'
+	private static API_LEVEL_23_LINE_REGEX = /.+?\s+?(?:[A-Z]\s+?)([A-Za-z ]+?)\s*?\: (.*)/;
+
+	constructor(private $loggingLevels: Mobile.ILoggingLevels) {}
+
+	public filterData(data: string, logLevel: string): string {
+		let specifiedLogLevel = (logLevel || '').toUpperCase();
+		if(specifiedLogLevel === this.$loggingLevels.info) {
+			let log = this.getConsoleLogFromLine(data);
+			if(log) {
+				if(log.tag) {
+					return `${log.tag}: ${log.message}`;
+				} else {
+					return log.message;
+				}
+			}
+
+			return null;
+		}
+
+		return data;
+	}
+
+	private getConsoleLogFromLine(lineText: string): any {
+		let acceptedTags = ["chromium", "Web Console", "JS"];
+		let match = lineText.match(AndroidLogFilter.LINE_REGEX) || lineText.match(AndroidLogFilter.API_LEVEL_23_LINE_REGEX);
+
+		if (match && acceptedTags.indexOf(match[1].trim()) !== -1) {
+			return { tag: match[1].trim(), message: match[2] };
+		}
+		let matchingTag = _.any(acceptedTags, (tag: string) => { return lineText.indexOf(tag) !== -1; });
+		return matchingTag ? { message: lineText } : null;
+	}
+}
+$injector.register("androidLogFilter", AndroidLogFilter);

mobile/device-log-provider.ts

@@ -0,0 +1,19 @@
+///<reference path="../.d.ts"/>
+"use strict";
+
+export class DeviceLogProvider implements Mobile.IDeviceLogProvider {
+	constructor(private $logFilter: Mobile.ILogFilter,
+		private $logger: ILogger) { }
+
+	public logData(lineText: string, platform: string, deviceIdentifier: string): void {
+		let data = this.$logFilter.filterData(platform, lineText);
+		if(data) {
+			this.$logger.out(data);
+		}
+	}
+
+	public setLogLevel(logLevel: string, deviceIdentifier?: string): void {
+		this.$logFilter.loggingLevel = logLevel.toUpperCase();
+	}
+}
+$injector.register("deviceLogProvider", DeviceLogProvider);

mobile/ios/ios-log-filter.ts

@@ -0,0 +1,20 @@
+///<reference path="../../.d.ts"/>
+"use strict";
+
+export class IOSLogFilter implements Mobile.IPlatformLogFilter {
+	private static INFO_FILTER_REGEX = /^.*?(AppBuilder|Cordova|NativeScript).*?(<Notice>:.*?(CONSOLE LOG|JS ERROR).*?|<Warning>:.*?|<Error>:.*?)$/im;
+
+	constructor(private $loggingLevels: Mobile.ILoggingLevels) {}
+
+	public filterData(data: string, logLevel: string): string {
+		let specifiedLogLevel = (logLevel || '').toUpperCase();
+
+		if(specifiedLogLevel === this.$loggingLevels.info) {
+			let matchingInfoMessage = data.match(IOSLogFilter.INFO_FILTER_REGEX);
+			return matchingInfoMessage ? matchingInfoMessage[2] : null;
+		}
+
+		return data;
+	}
+}
+$injector.register("iOSLogFilter", IOSLogFilter);

mobile/log-filter.ts

@@ -0,0 +1,48 @@
+///<reference path="../.d.ts"/>
+"use strict";
+
+export class LogFilter implements Mobile.ILogFilter {
+	private _loggingLevel: string = this.$loggingLevels.info;
+
+	constructor(private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
+		private $injector: IInjector,
+		private $loggingLevels: Mobile.ILoggingLevels) {}
+
+	public get loggingLevel(): string {
+		return this._loggingLevel;
+	}
+
+	public set loggingLevel(logLevel: string) {
+		if(this.verifyLogLevel(logLevel)) {
+			this._loggingLevel = logLevel;
+		}
+	}
+
+	public filterData(platform: string, data: string, logLevel?: string): string {
+		let deviceLogFilter = this.getDeviceLogFilterInstance(platform);
+		if(deviceLogFilter) {
+			return deviceLogFilter.filterData(data, logLevel || this.loggingLevel);
+		}
+
+		// In case the platform is not valid, just return the data without filtering.
+		return data;
+	}
+
+	private getDeviceLogFilterInstance(platform: string): Mobile.IPlatformLogFilter {
+		if(platform) {
+			if(platform.toLowerCase() === this.$devicePlatformsConstants.iOS.toLowerCase()) {
+				return this.$injector.resolve("iOSLogFilter");
+			} else if(platform.toLowerCase() ===  this.$devicePlatformsConstants.Android.toLowerCase()) {
+				return this.$injector.resolve("androidLogFilter");
+			}
+		}
+		return null;
+	}
+
+	private verifyLogLevel(logLevel: string): boolean {
+		let upperCaseLogLevel = (logLevel || '').toUpperCase();
+		return upperCaseLogLevel === this.$loggingLevels.info.toUpperCase() || upperCaseLogLevel === this.$loggingLevels.full.toUpperCase();
+	}
+
+}
+$injector.register("logFilter", LogFilter);

mobile/logging-levels.ts

@@ -0,0 +1,8 @@
+///<reference path="../.d.ts"/>
+"use strict";
+
+export class LoggingLevels implements Mobile.ILoggingLevels {
+	public info = "INFO";
+	public full = "FULL";
+};
+$injector.register("loggingLevels", LoggingLevels);

mobile/mobile-core/devices-service.ts

@@ -23,7 +23,8 @@ export class DevicesService implements Mobile.IDevicesService {
 		private $androidDeviceDiscovery: Mobile.IDeviceDiscovery,
 		private $staticConfig: Config.IStaticConfig,
 		private $messages: IMessages,
-		private $mobileHelper: Mobile.IMobileHelper) {
+		private $mobileHelper: Mobile.IMobileHelper,
+		private $deviceLogProvider: Mobile.IDeviceLogProvider) {
 		this.attachToDeviceDiscoveryEvents();
 	}
 
@@ -40,6 +41,13 @@ export class DevicesService implements Mobile.IDevicesService {
 		return this.getDeviceInstances().map(deviceInstance => deviceInstance.deviceInfo);
 	}
 
+	/* tslint:disable:no-unused-variable */
+	@exported("devicesService")
+	private setLogLevel(logLevel: string, deviceIdentifier?: string): void {
+		this.$deviceLogProvider.setLogLevel(logLevel, deviceIdentifier);
+	}
+	/* tslint:enable:no-unused-variable */
+
 	public getDeviceInstances(): Mobile.IDevice[] {
 		return _.values(this._devices);
 	}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "mobile-cli-lib",
   "preferGlobal": false,
-  "version": "0.3.0",
+  "version": "0.4.0",
   "author": "Telerik <[email protected]>",
   "description": "common lib used by different CLI",
   "bin": {