refactor: Set logFilter's project name when starting iOS application

rosen-vladimirov · rosen-vladimirov · commit aa4ecfe2cbf7 · 2018-03-13T14:53:11.000+02:00
When strating iOS Application, set the projectName to the log filter, so
we can filter the logs by it. Same logic is used for Android, where we
are using the PID of the started application. So introduce
IDeviceLogOptions, where logLevel, pid and projectName can be set. Pass
the projectName wherever is required in order to get it in
startApplication.
diff --git a/lib/common b/lib/common
@@ -1 +1 @@
-Subproject commit ca950f50d2be2f4c64b053b559effefe8a4eb406
+Subproject commit 2464b2658408c55ae7ecfd5a8a3dd95e4dfcc0c1
diff --git a/lib/definitions/platform.d.ts b/lib/definitions/platform.d.ts
@@ -125,7 +125,7 @@ interface IPlatformService extends IBuildPlatformAction, NodeJS.EventEmitter {
 	 * @param {IProjectData} projectData DTO with information about the project.
 	 * @returns {void}
 	 */
-	startApplication(platform: string, runOptions: IRunPlatformOptions, projectId: string): Promise<void>;
+	startApplication(platform: string, runOptions: IRunPlatformOptions, projectId: string, projectName: string): Promise<void>;
 
 	cleanDestinationApp(platformInfo: IPreparePlatformInfo): Promise<void>;
 	validatePlatformInstalled(platform: string, projectData: IProjectData): void;
diff --git a/lib/helpers/livesync-command-helper.ts b/lib/helpers/livesync-command-helper.ts
@@ -151,7 +151,7 @@ export class LiveSyncCommandHelper implements ILiveSyncCommandHelper {
 			};
 
 			await this.$platformService.deployPlatform(deployPlatformInfo);
-			await this.$platformService.startApplication(currentPlatform, runPlatformOptions, this.$projectData.projectId);
+			await this.$platformService.startApplication(currentPlatform, runPlatformOptions, this.$projectData.projectId, this.$projectData.projectName);
 			this.$platformService.trackProjectType(this.$projectData);
 		}
 	}
diff --git a/lib/services/android-debug-service.ts b/lib/services/android-debug-service.ts
@@ -13,7 +13,8 @@ export class AndroidDebugService extends DebugServiceBase implements IPlatformDe
 		private $logger: ILogger,
 		private $androidDeviceDiscovery: Mobile.IDeviceDiscovery,
 		private $androidProcessService: Mobile.IAndroidProcessService,
-		private $net: INet) {
+		private $net: INet,
+		private $projectDataService: IProjectDataService) {
 		super(device, $devicesService);
 	}
 
@@ -25,8 +26,9 @@ export class AndroidDebugService extends DebugServiceBase implements IPlatformDe
 	}
 
 	public async debugStart(debugData: IDebugData, debugOptions: IDebugOptions): Promise<void> {
+		const projectData = this.$projectDataService.getProjectData(debugData.projectDir);
 		await this.$devicesService.initialize({ platform: this.platform, deviceId: debugData.deviceIdentifier });
-		const action = (device: Mobile.IAndroidDevice): Promise<void> => this.debugStartCore(debugData.applicationIdentifier, debugOptions);
+		const action = (device: Mobile.IAndroidDevice): Promise<void> => this.debugStartCore(debugData.applicationIdentifier, debugOptions, projectData.projectName);
 
 		await this.$devicesService.execute(action, this.getCanExecuteAction(debugData.deviceIdentifier));
 	}
@@ -91,23 +93,24 @@ export class AndroidDebugService extends DebugServiceBase implements IPlatformDe
 
 		await this.$devicesService.initialize({ platform: this.platform, deviceId: debugData.deviceIdentifier });
 
-		const action = (device: Mobile.IAndroidDevice): Promise<string> => this.debugCore(device, packageFile, debugData.applicationIdentifier, debugOptions);
+		const packageName = this.$projectDataService.getProjectData(debugData.projectDir).projectName;
+		const action = (device: Mobile.IAndroidDevice): Promise<string> => this.debugCore(device, packageFile, debugData.applicationIdentifier, packageName, debugOptions);
 
 		const deviceActionResult = await this.$devicesService.execute(action, this.getCanExecuteAction(debugData.deviceIdentifier));
 		return deviceActionResult[0].result;
 	}
 
-	private async debugCore(device: Mobile.IAndroidDevice, packageFile: string, packageName: string, debugOptions: IDebugOptions): Promise<string> {
-		await this.printDebugPort(device.deviceInfo.identifier, packageName);
+	private async debugCore(device: Mobile.IAndroidDevice, packageFile: string, appId: string, packageName: string, debugOptions: IDebugOptions): Promise<string> {
+		await this.printDebugPort(device.deviceInfo.identifier, appId);
 
 		if (debugOptions.start) {
-			return await this.attachDebugger(device.deviceInfo.identifier, packageName, debugOptions);
+			return await this.attachDebugger(device.deviceInfo.identifier, appId, debugOptions);
 		} else if (debugOptions.stop) {
 			await this.removePortForwarding();
 			return null;
 		} else {
-			await this.debugStartCore(packageName, debugOptions);
-			return await this.attachDebugger(device.deviceInfo.identifier, packageName, debugOptions);
+			await this.debugStartCore(appId, debugOptions, packageName);
+			return await this.attachDebugger(device.deviceInfo.identifier, appId, debugOptions);
 		}
 	}
 
@@ -126,22 +129,22 @@ export class AndroidDebugService extends DebugServiceBase implements IPlatformDe
 		return this.getChromeDebugUrl(debugOptions, port);
 	}
 
-	private async debugStartCore(packageName: string, debugOptions: IDebugOptions): Promise<void> {
+	private async debugStartCore(appId: string, debugOptions: IDebugOptions, projectName: string): Promise<void> {
 		// Arguments passed to executeShellCommand must be in array ([]), but it turned out adb shell "arg with intervals" still works correctly.
 		// As we need to redirect output of a command on the device, keep using only one argument.
 		// We could rewrite this with two calls - touch and rm -f , but -f flag is not available on old Android, so rm call will fail when file does not exist.
 
-		await this.device.applicationManager.stopApplication(packageName);
+		await this.device.applicationManager.stopApplication(appId);
 
 		if (debugOptions.debugBrk) {
-			await this.device.adb.executeShellCommand([`cat /dev/null > /data/local/tmp/${packageName}-debugbreak`]);
+			await this.device.adb.executeShellCommand([`cat /dev/null > /data/local/tmp/${appId}-debugbreak`]);
 		}
 
-		await this.device.adb.executeShellCommand([`cat /dev/null > /data/local/tmp/${packageName}-debugger-started`]);
+		await this.device.adb.executeShellCommand([`cat /dev/null > /data/local/tmp/${appId}-debugger-started`]);
 
-		await this.device.applicationManager.startApplication(packageName);
+		await this.device.applicationManager.startApplication(appId, projectName);
 
-		await this.waitForDebugger(packageName);
+		await this.waitForDebugger(appId);
 	}
 
 	private async waitForDebugger(packageName: String): Promise<void> {
diff --git a/lib/services/ios-debug-service.ts b/lib/services/ios-debug-service.ts
@@ -33,7 +33,8 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 		private $iOSSocketRequestExecutor: IiOSSocketRequestExecutor,
 		private $processService: IProcessService,
 		private $socketProxyFactory: ISocketProxyFactory,
-		private $net: INet) {
+		private $net: INet,
+		private $projectDataService: IProjectDataService) {
 		super(device, $devicesService);
 		this.$processService.attachToProcessExitSignals(this, this.debugStop);
 		this.$socketProxyFactory.on(CONNECTION_ERROR_EVENT_NAME, (e: Error) => this.emit(CONNECTION_ERROR_EVENT_NAME, e));
@@ -173,6 +174,7 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 
 	private async deviceDebugBrk(debugData: IDebugData, debugOptions: IDebugOptions): Promise<string> {
 		await this.$devicesService.initialize({ platform: this.platform, deviceId: debugData.deviceIdentifier });
+		const projectData = this.$projectDataService.getProjectData(debugData.projectDir);
 		const action = async (device: iOSDevice.IOSDevice): Promise<string> => {
 			if (device.isEmulator) {
 				return await this.emulatorDebugBrk(debugData, debugOptions);
@@ -185,7 +187,7 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 			};
 
 			const promisesResults = await Promise.all<any>([
-				this.$platformService.startApplication(this.platform, runOptions, debugData.applicationIdentifier),
+				this.$platformService.startApplication(this.platform, runOptions, debugData.applicationIdentifier, projectData.projectName),
 				this.debugBrkCore(device, debugData, debugOptions)
 			]);
 
diff --git a/lib/services/ios-log-filter.ts b/lib/services/ios-log-filter.ts
@@ -17,14 +17,15 @@ export class IOSLogFilter implements Mobile.IPlatformLogFilter {
 
 	private partialLine: string = null;
 
-	constructor(
+	constructor(private $logger: ILogger,
 		private $loggingLevels: Mobile.ILoggingLevels,
 		private $fs: IFileSystem,
 		private $projectData: IProjectData) {
 	}
 
-	public filterData(data: string, logLevel: string, pid?: string): string {
-		const specifiedLogLevel = (logLevel || '').toUpperCase();
+	public filterData(data: string, loggingOptions: Mobile.IDeviceLogOptions = <any>{}): string {
+		const specifiedLogLevel = (loggingOptions.logLevel || '').toUpperCase();
+		this.$logger.trace("Logging options", loggingOptions);
 
 		if (specifiedLogLevel !== this.$loggingLevels.info || !data) {
 			return data;
@@ -57,8 +58,8 @@ export class IOSLogFilter implements Mobile.IPlatformLogFilter {
 				// Check if the name of the app equals the name of the CLI project and turn on the filter if not.
 				// We call initializeProjectData in order to obtain the current project name as the instance
 				// of this filter may be used accross multiple projects.
-				this.$projectData.initializeProjectData();
-				this.filterActive = matchResult[1] !== this.$projectData.projectName;
+				const projectName = loggingOptions && loggingOptions.projectName;
+				this.filterActive = matchResult[1] !== projectName;
 			}
 
 			if (this.filterActive) {
diff --git a/lib/services/livesync/android-device-livesync-service.ts b/lib/services/livesync/android-device-livesync-service.ts
@@ -42,7 +42,7 @@ export class AndroidDeviceLiveSyncService extends DeviceLiveSyncServiceBase impl
 			(localToDevicePath: Mobile.ILocalToDevicePathData) => !this.canExecuteFastSync(localToDevicePath.getLocalPath(), projectData, this.device.deviceInfo.platform));
 
 		if (!canExecuteFastSync) {
-			return this.restartApplication(deviceAppData);
+			return this.restartApplication(deviceAppData, projectData.projectName);
 		}
 	}
 
@@ -57,12 +57,12 @@ export class AndroidDeviceLiveSyncService extends DeviceLiveSyncServiceBase impl
 			await this.$mobileHelper.buildDevicePath(deviceRootPath, LiveSyncPaths.REMOVEDSYNC_DIR_NAME)]);
 	}
 
-	private async restartApplication(deviceAppData: Mobile.IDeviceAppData): Promise<void> {
+	private async restartApplication(deviceAppData: Mobile.IDeviceAppData, projectName: string): Promise<void> {
 		const devicePathRoot = `/data/data/${deviceAppData.appIdentifier}/files`;
 		const devicePath = this.$mobileHelper.buildDevicePath(devicePathRoot, "code_cache", "secondary_dexes", "proxyThumb");
 		await this.device.adb.executeShellCommand(["rm", "-rf", devicePath]);
 
-		await this.device.applicationManager.restartApplication(deviceAppData.appIdentifier);
+		await this.device.applicationManager.restartApplication(deviceAppData.appIdentifier, projectName);
 	}
 
 	public async beforeLiveSyncAction(deviceAppData: Mobile.IDeviceAppData): Promise<void> {
diff --git a/lib/services/platform-service.ts b/lib/services/platform-service.ts
@@ -543,11 +543,11 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		await this.$devicesService.execute(action, this.getCanExecuteAction(deployInfo.platform, deployInfo.deployOptions));
 	}
 
-	public async startApplication(platform: string, runOptions: IRunPlatformOptions, projectId: string): Promise<void> {
+	public async startApplication(platform: string, runOptions: IRunPlatformOptions, projectId: string, projectName: string): Promise<void> {
 		this.$logger.out("Starting...");
 
 		const action = async (device: Mobile.IDevice) => {
-			await device.applicationManager.startApplication(projectId);
+			await device.applicationManager.startApplication(projectId, projectName);
 			this.$logger.out(`Successfully started on device with identifier '${device.deviceInfo.identifier}'.`);
 		};
 
diff --git a/test/services/android-debug-service.ts b/test/services/android-debug-service.ts
@@ -11,8 +11,9 @@ class AndroidDebugServiceInheritor extends AndroidDebugService {
 		$logger: ILogger,
 		$androidDeviceDiscovery: Mobile.IDeviceDiscovery,
 		$androidProcessService: Mobile.IAndroidProcessService,
-		$net: INet) {
-		super(<any>{}, $devicesService, $errors, $logger, $androidDeviceDiscovery, $androidProcessService, $net);
+		$net: INet,
+		$projectDataService: IProjectDataService) {
+		super(<any>{}, $devicesService, $errors, $logger, $androidDeviceDiscovery, $androidProcessService, $net, $projectDataService);
 	}
 
 	public getChromeDebugUrl(debugOptions: IDebugOptions, port: number): string {
@@ -28,6 +29,7 @@ const createTestInjector = (): IInjector => {
 	testInjector.register("androidDeviceDiscovery", {});
 	testInjector.register("androidProcessService", {});
 	testInjector.register("net", {});
+	testInjector.register("projectDataService", {});
 
 	return testInjector;
 };
diff --git a/test/services/ios-debug-service.ts b/test/services/ios-debug-service.ts
@@ -18,9 +18,10 @@ class IOSDebugServiceInheritor extends IOSDebugService {
 		$iOSSocketRequestExecutor: IiOSSocketRequestExecutor,
 		$processService: IProcessService,
 		$socketProxyFactory: ISocketProxyFactory,
-		$net: INet) {
+		$net: INet,
+		$projectDataService: IProjectDataService) {
 		super(<any>{}, $devicesService, $platformService, $iOSEmulatorServices, $childProcess, $hostInfo, $logger, $errors,
-			$npmInstallationManager, $iOSNotification, $iOSSocketRequestExecutor, $processService, $socketProxyFactory, $net);
+			$npmInstallationManager, $iOSNotification, $iOSSocketRequestExecutor, $processService, $socketProxyFactory, $net, $projectDataService);
 	}
 
 	public getChromeDebugUrl(debugOptions: IDebugOptions, port: number): string {
@@ -54,6 +55,8 @@ const createTestInjector = (): IInjector => {
 		waitForPortToListen: async (opts: { port: number, timeout: number, interval?: number }): Promise<boolean> => true
 	});
 
+	testInjector.register("projectDataService", {});
+
 	return testInjector;
 };
 
diff --git a/test/services/ios-log-filter.ts b/test/services/ios-log-filter.ts
@@ -1,6 +1,7 @@
 import { IOSLogFilter } from "../../lib/services/ios-log-filter";
 import { Yok } from "../../lib/common/yok";
 import { LoggingLevels } from "../../lib/common/mobile/logging-levels";
+import { LoggerStub } from "../stubs";
 import * as assert from "assert";
 
 function createTestInjector(projectName: string): IInjector {
@@ -15,6 +16,8 @@ function createTestInjector(projectName: string): IInjector {
 		projectName: projectName
 	});
 
+	testInjector.register("logger", LoggerStub);
+
 	return testInjector;
 }
 
@@ -189,7 +192,7 @@ describe("iOSLogFilter", () => {
 				while (true) {
 					const currentRange = Math.floor(Math.random() * maxRange);
 					const currentFilterInput = input.substr(currentStart, currentRange);
-					const tempOutput = logFilter.filterData(currentFilterInput, infoLogLevel, null);
+					const tempOutput = logFilter.filterData(currentFilterInput, { logLevel: infoLogLevel, projectName: data.projectName });
 					if (tempOutput !== null) {
 						output += tempOutput;
 					}
@@ -206,7 +209,7 @@ describe("iOSLogFilter", () => {
 			it(`returns correct data when logLevel is ${fullLogLevel} on iOS ${data.version} and all data is passed at once`, () => {
 				testInjector = createTestInjector(data.projectName);
 				logFilter = testInjector.resolve(IOSLogFilter);
-				const actualData = logFilter.filterData(data.originalDataArr.join("\n"), fullLogLevel, null);
+				const actualData = logFilter.filterData(data.originalDataArr.join("\n"), { logLevel: fullLogLevel, projectName: data.projectName });
 				const actualArr = actualData.split("\n").map(line => line.trim());
 				const expectedArr = data.originalDataArr.map(line => line.trim()).filter(item => item !== null);
 				assert.deepEqual(actualArr, expectedArr);
@@ -216,23 +219,23 @@ describe("iOSLogFilter", () => {
 				data.originalDataArr.forEach(line => {
 					testInjector = createTestInjector(data.projectName);
 					logFilter = testInjector.resolve(IOSLogFilter);
-					const actualData = logFilter.filterData(line, fullLogLevel, null);
+					const actualData = logFilter.filterData(line, { logLevel: fullLogLevel, projectName: data.projectName });
 					assert.deepEqual(actualData.trim(), line.trim());
 				});
 			});
 
 			it(`parses data incorrectly when logLevel is ${infoLogLevel} on iOS ${data.version} and all data is passed at once with pid(simulator)`, () => {
 				testInjector = createTestInjector(data.simProjectName);
 				logFilter = testInjector.resolve(IOSLogFilter);
-				const actualData = logFilter.filterData(data.simulator.join("\n"), infoLogLevel, pid);
+				const actualData = logFilter.filterData(data.simulator.join("\n"), { logLevel: infoLogLevel, projectName: data.simProjectName, applicationPid: pid });
 				const actualArr = actualData.split("\n").map(line => line.trim());
 				assert.deepEqual(actualArr, data.simulatorExpectedArr.filter(item => item !== null));
 			});
 
 			it(`parses data incorrectly when logLevel is ${infoLogLevel} on iOS ${data.version} and all data is passed at once and pid is available`, () => {
 				testInjector = createTestInjector(data.projectName);
 				logFilter = testInjector.resolve(IOSLogFilter);
-				const actualData = logFilter.filterData(data.originalDataArr.join("\n"), infoLogLevel, null);
+				const actualData = logFilter.filterData(data.originalDataArr.join("\n"), { logLevel: infoLogLevel, projectName: data.projectName });
 				const actualArr = actualData.split("\n").map(line => line.trim());
 				const expectedArr = data.infoExpectedArr.filter(item => item !== null);
 				assert.deepEqual(actualArr, expectedArr);
@@ -245,7 +248,7 @@ describe("iOSLogFilter", () => {
 					if (line.length > 0) {
 						line += "\n";
 					}
-					const actualData = logFilter.filterData(line, infoLogLevel, null);
+					const actualData = logFilter.filterData(line, { logLevel: infoLogLevel, projectName: data.projectName });
 					const expectedData = data.infoExpectedArr[index];
 					assert.equal(actualData && actualData.trim(), expectedData);
 				});

Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,7 @@ export class LiveSyncCommandHelper implements ILiveSyncCommandHelper {`
`151`	`151`	`};`
`152`	`152`
`153`	`153`	`await this.$platformService.deployPlatform(deployPlatformInfo);`
`154`		`- await this.$platformService.startApplication(currentPlatform, runPlatformOptions, this.$projectData.projectId);`
	`154`	`+ await this.$platformService.startApplication(currentPlatform, runPlatformOptions, this.$projectData.projectId, this.$projectData.projectName);`
`155`	`155`	`this.$platformService.trackProjectType(this.$projectData);`
`156`	`156`	`}`
`157`	`157`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ export class AndroidDeviceLiveSyncService extends DeviceLiveSyncServiceBase impl`
`42`	`42`	`(localToDevicePath: Mobile.ILocalToDevicePathData) => !this.canExecuteFastSync(localToDevicePath.getLocalPath(), projectData, this.device.deviceInfo.platform));`
`43`	`43`
`44`	`44`	`if (!canExecuteFastSync) {`
`45`		`- return this.restartApplication(deviceAppData);`
	`45`	`+ return this.restartApplication(deviceAppData, projectData.projectName);`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`
`@@ -57,12 +57,12 @@ export class AndroidDeviceLiveSyncService extends DeviceLiveSyncServiceBase impl`
`57`	`57`	`await this.$mobileHelper.buildDevicePath(deviceRootPath, LiveSyncPaths.REMOVEDSYNC_DIR_NAME)]);`
`58`	`58`	`}`
`59`	`59`
`60`		`- private async restartApplication(deviceAppData: Mobile.IDeviceAppData): Promise<void> {`
	`60`	`+ private async restartApplication(deviceAppData: Mobile.IDeviceAppData, projectName: string): Promise<void> {`
`61`	`61`	const devicePathRoot = `/data/data/${deviceAppData.appIdentifier}/files`;
`62`	`62`	`const devicePath = this.$mobileHelper.buildDevicePath(devicePathRoot, "code_cache", "secondary_dexes", "proxyThumb");`
`63`	`63`	`await this.device.adb.executeShellCommand(["rm", "-rf", devicePath]);`
`64`	`64`
`65`		`- await this.device.applicationManager.restartApplication(deviceAppData.appIdentifier);`
	`65`	`+ await this.device.applicationManager.restartApplication(deviceAppData.appIdentifier, projectName);`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`public async beforeLiveSyncAction(deviceAppData: Mobile.IDeviceAppData): Promise<void> {`