feat: enable to possibility to ensure analytics tracking is finished

Introudce finishTracking method in `analyticsService` which will ensure all pending information is send to Google Analytics. This is required for some rare cases in which we want to be sure all the information has been sent.

Author: rosen-vladimirov

lib/common/declarations.d.ts

@@ -207,6 +207,12 @@ declare const enum TrackingTypes {
 	 * Defines that the broker process should get and track the data from preview app to Google Analytics
 	 */
 	PreviewAppData = "PreviewAppData",
+
+	/**
+	 * Defines that the broker process should send all the pending information to Analytics.
+	 * After that the process should send information it has finished tracking and die gracefully.
+	 */
+	FinishTracking = "FinishTracking",
 }
 
 /**
@@ -688,6 +694,7 @@ interface IAnalyticsService {
 	setStatus(settingName: string, enabled: boolean): Promise<void>;
 	getStatusMessage(settingName: string, jsonFormat: boolean, readableSettingName: string): Promise<string>;
 	isEnabled(settingName: string): Promise<boolean>;
+	finishTracking(): Promise<void>;
 
 	/**
 	 * Tracks the answer of question if user allows to be tracked.

lib/detached-processes/detached-process-enums.d.ts

@@ -5,7 +5,12 @@ declare const enum DetachedProcessMessages {
 	/**
 	 * The detached process is initialized and is ready to receive information for tracking.
 	 */
-	ProcessReadyToReceive = "ProcessReadyToReceive"
+	ProcessReadyToReceive = "ProcessReadyToReceive",
+
+	/**
+	 * The detached process finished its tasks and will now exit.
+	 */
+	ProcessFinishedTasks = "ProcessFinishedTasks"
 }
 
 /**

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

@@ -29,6 +29,10 @@ const finishTracking = async (data?: ITrackingInformation) => {
 	analyticsLoggingService.logData({ message: `analytics-broker-process finish tracking started` });
 	await trackingQueue;
 	analyticsLoggingService.logData({ message: `analytics-broker-process tracking finished` });
+
+};
+
+const killCurrentProcessGracefully = () => {
 	$injector.dispose();
 	process.exit();
 };
@@ -68,12 +72,27 @@ process.on("message", async (data: ITrackingInformation) => {
 		return;
 	}
 
+	if (data.type === TrackingTypes.FinishTracking) {
+		await finishTracking();
+
+		if (process.connected) {
+			analyticsLoggingService.logData({ message: `analytics-broker-process will send ${DetachedProcessMessages.ProcessFinishedTasks} message` });
+			process.send(DetachedProcessMessages.ProcessFinishedTasks, () => {
+				analyticsLoggingService.logData({ message: `analytics-broker-process sent ${DetachedProcessMessages.ProcessFinishedTasks} message and will exit gracefully now` });
+				killCurrentProcessGracefully();
+			});
+		}
+
+		return;
+	}
+
 	await sendDataForTracking(data);
 });
 
 process.on("disconnect", async () => {
 	analyticsLoggingService.logData({ message: "analytics-broker-process received process.disconnect event" });
 	await finishTracking();
+	killCurrentProcessGracefully();
 });
 
 analyticsLoggingService.logData({ message: `analytics-broker-process will send ${DetachedProcessMessages.ProcessReadyToReceive} message` });

lib/services/analytics/analytics-service.ts

@@ -146,6 +146,34 @@ export class AnalyticsService implements IAnalyticsService, IDisposable {
 		await this.trackInGoogleAnalytics(eventActionData);
 	}
 
+	public async finishTracking(): Promise<void> {
+		return new Promise((resolve, reject) => {
+			if (this.brokerProcess && this.brokerProcess.connected) {
+				let timer: NodeJS.Timer;
+
+				const handler = (data: string) => {
+					if (data === DetachedProcessMessages.ProcessFinishedTasks) {
+						this.brokerProcess.removeListener("message", handler);
+						clearTimeout(timer);
+						resolve();
+					}
+				};
+
+				timer = setTimeout(() => {
+					this.brokerProcess.removeListener("message", handler);
+					resolve();
+				}, 3000);
+
+				this.brokerProcess.on("message", handler);
+
+				const msg = { type: TrackingTypes.FinishTracking };
+				this.brokerProcess.send(msg, (err: Error) => this.$logger.trace(`Error while sending ${JSON.stringify(msg)}`));
+			} else {
+				resolve();
+			}
+		});
+	}
+
 	private forcefullyTrackInGoogleAnalytics(gaSettings: IGoogleAnalyticsData): Promise<void> {
 		gaSettings.customDimensions = gaSettings.customDimensions || {};
 		gaSettings.customDimensions[GoogleAnalyticsCustomDimensions.client] = this.$options.analyticsClient || (isInteractive() ? AnalyticsClients.Cli : AnalyticsClients.Unknown);