Fix hanging commands

In case the command is not related to LiveSync, once it finishes its work, CLI process should end. However, this works only on Windows, as the broker child process there is really detached from the parent. On macOS and Linux, the 'ipc' channel between the broker process and CLI, keeps both alive. So use the 'dispose' method, which is called at the end of command execution and disconnect the broker process. In case we are in LiveSync case, set shouldDispose to false and this way the broker will be kept alive. Once Ctrl + C is used to end the CLI process, send the finish message to broker and it will disconnect itself from CLI.

Author: rosen-vladimirov

lib/commands/run.ts

@@ -5,7 +5,6 @@ export class RunCommandBase implements ICommand {
 
 	public platform: string;
 	constructor(protected $platformService: IPlatformService,
-		protected $liveSyncService: ILiveSyncService,
 		protected $projectData: IProjectData,
 		protected $options: IOptions,
 		protected $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,

lib/common

@@ -25,15 +25,19 @@ const finishTracking = async (data?: ITrackingInformation) => {
 		sentFinishMsg = true;
 
 		data = data || { type: TrackingTypes.Finish };
+		const action = async () => {
+			await sendDataForTracking(data);
+			process.disconnect();
+		};
 
 		if (receivedFinishMsg) {
-			await sendDataForTracking(data);
+			await action();
 		} else {
 			// In case we've got here without receiving "finish" message from parent (receivedFinishMsg is false)
 			// there might be various reasons, but most probably the parent is dead.
 			// However, there's no guarantee that we've received all messages. So wait some time before sending finish message to children.
 			setTimeout(async () => {
-				await sendDataForTracking(data);
+				await action();
 			}, 1000);
 		}
 	}

lib/services/analytics/analytics-broker-process.ts

@@ -5,8 +5,9 @@ import { cache } from "../../common/decorators";
 import { isInteractive } from '../../common/helpers';
 import { DeviceTypes, AnalyticsClients } from "../../common/constants";
 
-export class AnalyticsService extends AnalyticsServiceBase implements IAnalyticsService {
+export class AnalyticsService extends AnalyticsServiceBase {
 	private static ANALYTICS_BROKER_START_TIMEOUT = 30 * 1000;
+	private brokerProcess: ChildProcess;
 
 	constructor(protected $logger: ILogger,
 		protected $options: IOptions,
@@ -56,7 +57,7 @@ export class AnalyticsService extends AnalyticsServiceBase implements IAnalytics
 			gaSettings.customDimensions = gaSettings.customDimensions || {};
 			gaSettings.customDimensions[GoogleAnalyticsCustomDimensions.client] = this.$options.analyticsClient || (isInteractive() ? AnalyticsClients.Cli : AnalyticsClients.Unknown);
 
-			const googleAnalyticsData: IGoogleAnalyticsTrackingInformation = _.merge({ type: TrackingTypes.GoogleAnalyticsData }, gaSettings, { category: AnalyticsClients.Cli });
+			const googleAnalyticsData: IGoogleAnalyticsTrackingInformation = _.merge({ type: TrackingTypes.GoogleAnalyticsData, category: AnalyticsClients.Cli }, gaSettings);
 			return this.sendMessageToBroker(googleAnalyticsData);
 		}
 	}
@@ -69,9 +70,9 @@ export class AnalyticsService extends AnalyticsServiceBase implements IAnalytics
 		let label: string = "";
 		label = this.addDataToLabel(label, platform);
 
+		// In some cases (like in case action is Build and platform is Android), we do not know if the deviceType is emulator or device.
+		// Just exclude the device_type in this case.
 		if (isForDevice !== null) {
-			// In case action is Build and platform is Android, we do not know if the deviceType is emulator or device.
-			// Just exclude the device_type in this case.
 			const deviceType = isForDevice ? DeviceTypes.Device : (this.$mobileHelper.isAndroidPlatform(platform) ? DeviceTypes.Emulator : DeviceTypes.Simulator);
 			label = this.addDataToLabel(label, deviceType);
 		}
@@ -102,6 +103,12 @@ export class AnalyticsService extends AnalyticsServiceBase implements IAnalytics
 		await this.trackInGoogleAnalytics(googleAnalyticsEventData);
 	}
 
+	public dispose(): void {
+		if (this.brokerProcess && this.shouldDisposeInstance) {
+			this.brokerProcess.disconnect();
+		}
+	}
+
 	private addDataToLabel(label: string, newData: string): string {
 		if (newData && label) {
 			return `${label}_${newData}`;
@@ -156,6 +163,8 @@ export class AnalyticsService extends AnalyticsServiceBase implements IAnalytics
 							});
 						});
 
+						this.brokerProcess = broker;
+
 						resolve(broker);
 					}
 				}

lib/services/analytics/analytics-service.ts

@@ -51,6 +51,10 @@ export class EqatecAnalyticsProvider extends AnalyticsServiceBase implements IAn
 		this.tryStopEqatecMonitors();
 	}
 
+	public dispose(): void {
+		// Intentionally left blank.
+	}
+
 }
 
 $injector.register("eqatecAnalyticsProvider", EqatecAnalyticsProvider);

lib/services/analytics/eqatec-analytics-provider.ts

@@ -109,7 +109,7 @@ export class GoogleAnalyticsProvider implements IGoogleAnalyticsProvider {
 
 	private getMacOSReleaseVersion(osRelease: string): string {
 		// https://en.wikipedia.org/wiki/Darwin_(operating_system)#Release_history
-		// Each macOS version is labeled 10.<version>, where it looks like <versions> is taken from the major version returned by os.release() (16.x.x for example) and substituting 4 from it.
+		// Each macOS version is labeled 10.<version>, where it looks like <versions> is taken from the major version returned by os.release() (16.x.x for example) and subtracting 4 from it.
 		// So the version becomes "10.12" in this case.
 		// Could be improved by spawning `system_profiler SPSoftwareDataType` and getting the System Version line from the result.
 		const majorVersion = osRelease && _.first(osRelease.split("."));

lib/services/analytics/google-analytics-provider.ts

@@ -7,7 +7,9 @@ export class LiveSyncCommandHelper implements ILiveSyncCommandHelper {
 		private $iosDeviceOperations: IIOSDeviceOperations,
 		private $mobileHelper: Mobile.IMobileHelper,
 		private $platformsData: IPlatformsData,
+		private $analyticsService: IAnalyticsService,
 		private $errors: IErrors) {
+			this.$analyticsService.setShouldDispose(this.$options.justlaunch || !this.$options.watch);
 	}
 
 	public getPlatformsForOperation(platform: string): string[] {

lib/services/livesync/livesync-command-helper.ts

@@ -26,7 +26,9 @@ class TestExecutionService implements ITestExecutionService {
 		private $errors: IErrors,
 		private $debugService: IDebugService,
 		private $devicesService: Mobile.IDevicesService,
+		private $analyticsService: IAnalyticsService,
 		private $childProcess: IChildProcess) {
+			this.$analyticsService.setShouldDispose(this.$options.justlaunch || !this.$options.watch);
 	}
 
 	public platform: string;