Merge pull request #4287 from NativeScript/fatme/track-data-from-preview-app

Fatme · web-flow · commit 4b9f1a381921 · 2019-01-30T11:36:32.000+02:00
feat: track data from preview app on `preview` and `run` commands
diff --git a/lib/commands/preview.ts b/lib/commands/preview.ts
@@ -4,15 +4,18 @@ export class PreviewCommand implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 	private static MIN_SUPPORTED_WEBPACK_VERSION = "0.17.0";
 
-	constructor(private $bundleValidatorHelper: IBundleValidatorHelper,
+	constructor(private $analyticsService: IAnalyticsService,
+		private $bundleValidatorHelper: IBundleValidatorHelper,
 		private $errors: IErrors,
 		private $liveSyncService: ILiveSyncService,
 		private $logger: ILogger,
 		private $networkConnectivityValidator: INetworkConnectivityValidator,
 		private $projectData: IProjectData,
 		private $options: IOptions,
 		private $previewAppLogProvider: IPreviewAppLogProvider,
-		private $previewQrCodeService: IPreviewQrCodeService) { }
+		private $previewQrCodeService: IPreviewQrCodeService) {
+			this.$analyticsService.setShouldDispose(this.$options.justlaunch || !this.$options.watch);
+		}
 
 	public async execute(): Promise<void> {
 		this.$previewAppLogProvider.on(DEVICE_LOG_EVENT_NAME, (deviceId: string, message: string) => {
diff --git a/lib/commands/run.ts b/lib/commands/run.ts
@@ -6,7 +6,9 @@ export class RunCommandBase implements ICommand {
 	private liveSyncCommandHelperAdditionalOptions: ILiveSyncCommandHelperAdditionalOptions = <ILiveSyncCommandHelperAdditionalOptions>{};
 
 	public platform: string;
-	constructor(private $projectData: IProjectData,
+	constructor(
+		private $analyticsService: IAnalyticsService,
+		private $projectData: IProjectData,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $errors: IErrors,
 		private $hostInfo: IHostInfo,
@@ -15,6 +17,7 @@ export class RunCommandBase implements ICommand {
 
 	public allowedParameters: ICommandParameter[] = [];
 	public async execute(args: string[]): Promise<void> {
+		await this.$analyticsService.trackPreviewAppData(this.platform, this.$projectData.projectDir);
 		return this.$liveSyncCommandHelper.executeCommandLiveSync(this.platform, this.liveSyncCommandHelperAdditionalOptions);
 	}
 
diff --git a/lib/common/declarations.d.ts b/lib/common/declarations.d.ts
@@ -203,6 +203,11 @@ declare const enum TrackingTypes {
 	 */
 	GoogleAnalyticsData = "googleAnalyticsData",
 
+	/**
+	 * Defines that the broker process should get and track the data from preview app to Google Analytics
+	 */
+	PreviewAppData = "PreviewAppData",
+
 	/**
 	 * Defines that all information has been sent and no more data will be tracked in current session.
 	 */
@@ -690,6 +695,11 @@ interface IAnalyticsService {
 	 */
 	trackEventActionInGoogleAnalytics(data: IEventActionData): Promise<void>;
 
+	/**
+	 * Tracks preview's app data to Google Analytics project.
+	 */
+	trackPreviewAppData(platform: string, projectDir: string): Promise<void>
+
 	/**
 	 * Defines if the instance should be disposed.
 	 * @param {boolean} shouldDispose Defines if the instance should be disposed and the child processes should be disconnected.
diff --git a/lib/common/definitions/google-analytics.d.ts b/lib/common/definitions/google-analytics.d.ts
@@ -13,6 +13,11 @@ interface IGoogleAnalyticsData {
 	customDimensions?: IStringDictionary;
 }
 
+interface IPreviewAppGoogleAnalyticsData {
+	platform: string;
+	additionalData?: string;
+}
+
 /**
  * Describes information about event that should be tracked.
  */
diff --git a/lib/common/definitions/mobile.d.ts b/lib/common/definitions/mobile.d.ts
@@ -320,6 +320,7 @@ declare module Mobile {
 	interface IDeviceFileSystem {
 		listFiles(devicePath: string, appIdentifier?: string): Promise<any>;
 		getFile(deviceFilePath: string, appIdentifier: string, outputFilePath?: string): Promise<void>;
+		getFileContent(deviceFilePath: string, appIdentifier: string): Promise<string>;
 		putFile(localFilePath: string, deviceFilePath: string, appIdentifier: string): Promise<void>;
 		deleteFile(deviceFilePath: string, appIdentifier: string): Promise<void>;
 		transferFiles(deviceAppData: Mobile.IDeviceAppData, localToDevicePaths: Mobile.ILocalToDevicePathData[]): Promise<Mobile.ILocalToDevicePathData[]>;
diff --git a/lib/common/mobile/android/android-device-file-system.ts b/lib/common/mobile/android/android-device-file-system.ts
@@ -48,6 +48,11 @@ export class AndroidDeviceFileSystem implements Mobile.IDeviceFileSystem {
 		}
 	}
 
+	public async getFileContent(deviceFilePath: string, appIdentifier: string): Promise<string> {
+		const result = await this.adb.executeShellCommand(["cat", deviceFilePath]);
+		return result;
+	}
+
 	public async putFile(localFilePath: string, deviceFilePath: string, appIdentifier: string): Promise<void> {
 		await this.adb.pushFile(localFilePath, deviceFilePath);
 	}
diff --git a/lib/common/mobile/ios/device/ios-device-file-system.ts b/lib/common/mobile/ios/device/ios-device-file-system.ts
@@ -23,15 +23,19 @@ export class IOSDeviceFileSystem implements Mobile.IDeviceFileSystem {
 	}
 
 	public async getFile(deviceFilePath: string, appIdentifier: string, outputFilePath?: string): Promise<void> {
-		if (!outputFilePath) {
-			const result = await this.$iosDeviceOperations.readFiles([{ deviceId: this.device.deviceInfo.identifier, path: deviceFilePath, appId: appIdentifier }]);
-			const response = result[this.device.deviceInfo.identifier][0];
-			if (response) {
-				this.$logger.out(response.response);
-			}
-		} else {
+		if (outputFilePath) {
 			await this.$iosDeviceOperations.downloadFiles([{ appId: appIdentifier, deviceId: this.device.deviceInfo.identifier, source: deviceFilePath, destination: outputFilePath }]);
+			return;
 		}
+
+		const fileContent = await this.getFileContent(deviceFilePath, appIdentifier);
+		this.$logger.out(fileContent);
+	}
+
+	public async getFileContent(deviceFilePath: string, appIdentifier: string): Promise<string> {
+		const result = await this.$iosDeviceOperations.readFiles([{ deviceId: this.device.deviceInfo.identifier, path: deviceFilePath, appId: appIdentifier }]);
+		const response = result[this.device.deviceInfo.identifier][0];
+		return response.response;
 	}
 
 	public async putFile(localFilePath: string, deviceFilePath: string, appIdentifier: string): Promise<void> {
diff --git a/lib/common/mobile/ios/simulator/ios-simulator-file-system.ts b/lib/common/mobile/ios/simulator/ios-simulator-file-system.ts
@@ -16,6 +16,11 @@ export class IOSSimulatorFileSystem implements Mobile.IDeviceFileSystem {
 		}
 	}
 
+	public async getFileContent(deviceFilePath: string, appIdentifier: string): Promise<string> {
+		const result = this.$fs.readText(deviceFilePath);
+		return result;
+	}
+
 	public async putFile(localFilePath: string, deviceFilePath: string, appIdentifier: string): Promise<void> {
 		shelljs.cp("-f", localFilePath, deviceFilePath);
 	}
@@ -27,7 +32,7 @@ export class IOSSimulatorFileSystem implements Mobile.IDeviceFileSystem {
 	public async transferFiles(deviceAppData: Mobile.IDeviceAppData, localToDevicePaths: Mobile.ILocalToDevicePathData[]): Promise<Mobile.ILocalToDevicePathData[]> {
 		await Promise.all(
 			_.map(localToDevicePaths, localToDevicePathData => this.transferFile(localToDevicePathData.getLocalPath(), localToDevicePathData.getDevicePath())
-			));
+		));
 		return localToDevicePaths;
 	}
 
diff --git a/lib/constants.ts b/lib/constants.ts
@@ -156,7 +156,8 @@ export const enum TrackActionNames {
 	CheckEnvironmentRequirements = "Check Environment Requirements",
 	Options = "Options",
 	AcceptTracking = "Accept Tracking",
-	Performance = "Performance"
+	Performance = "Performance",
+	PreviewAppData = "Preview App Data"
 }
 
 export const AnalyticsEventLabelDelimiter = "__";
diff --git a/lib/services/analytics/analytics-broker-process.ts b/lib/services/analytics/analytics-broker-process.ts
@@ -54,15 +54,47 @@ const finishTracking = async (data?: ITrackingInformation) => {
 	}
 };
 
+const trackPreviewAppData = async (data: any) => {
+	const mobileHelper = $injector.resolve<Mobile.IMobileHelper>("mobileHelper");
+	const devicesService = $injector.resolve<Mobile.IDevicesService>("devicesService");
+	await devicesService.initialize({ platform: data.platform, skipDeviceDetectionInterval: true, skipEmulatorStart: true });
+
+	const devices = await devicesService.getDevicesForPlatform(data.platform);
+	_.each(devices, async (device: Mobile.IDevice) => {
+		try {
+			let previewAppFilePath = null;
+			if (mobileHelper.isAndroidPlatform(device.deviceInfo.platform)) {
+				previewAppFilePath = "/sdcard/org.nativescript.preview/device.json";
+			} else if (mobileHelper.isiOSPlatform(device.deviceInfo.platform)) {
+				previewAppFilePath = "Documents/device.json";
+			}
+
+			const previewAppFileContent = await device.fileSystem.getFileContent(previewAppFilePath, "org.nativescript.preview");
+			const previewAppDeviceId = JSON.parse(previewAppFileContent).id;
+			data.label += `_${previewAppDeviceId}`;
+
+			analyticsLoggingService.logData({ message: `analytics-broker-process will send the data from preview app: ${data}` });
+			await sendDataForTracking(data);
+		} catch (err) {
+			// ignore the error
+		}
+	});
+};
+
 process.on("message", async (data: ITrackingInformation) => {
-	analyticsLoggingService.logData({ message: `analytics-broker-process received message of type: ${data.type}` });
+	analyticsLoggingService.logData({ message: `analytics-broker-process received message of type: ${JSON.stringify(data)}` });
 
 	if (data.type === TrackingTypes.Finish) {
 		receivedFinishMsg = true;
 		await finishTracking(data);
 		return;
 	}
 
+	if (data.type === TrackingTypes.PreviewAppData) {
+		await trackPreviewAppData(<IPreviewAppTrackingInformation>data);
+		return;
+	}
+
 	await sendDataForTracking(data);
 });
 
diff --git a/lib/services/analytics/analytics-service.ts b/lib/services/analytics/analytics-service.ts
@@ -96,7 +96,6 @@ export class AnalyticsService implements IAnalyticsService, IDisposable {
 		const platform = device ? device.deviceInfo.platform : data.platform;
 		const normalizedPlatform = platform ? this.$mobileHelper.normalizePlatformName(platform) : platform;
 		const isForDevice = device ? !device.isEmulator : data.isForDevice;
-
 		let label: string = "";
 		label = this.addDataToLabel(label, normalizedPlatform);
 
@@ -129,6 +128,25 @@ export class AnalyticsService implements IAnalyticsService, IDisposable {
 		await this.trackInGoogleAnalytics(googleAnalyticsEventData);
 	}
 
+	public async trackPreviewAppData(platform: string, projectDir: string): Promise<void> {
+		const customDimensions: IStringDictionary = {};
+		this.setProjectRelatedCustomDimensions(customDimensions, projectDir);
+
+		let label: string = "";
+		label = this.addDataToLabel(label, this.$mobileHelper.normalizePlatformName(platform));
+
+		const eventActionData = {
+			googleAnalyticsDataType: GoogleAnalyticsDataType.Event,
+			action: TrackActionNames.PreviewAppData,
+			platform,
+			label,
+			customDimensions,
+			type: TrackingTypes.PreviewAppData
+		};
+
+		await this.trackInGoogleAnalytics(eventActionData);
+	}
+
 	private forcefullyTrackInGoogleAnalytics(gaSettings: IGoogleAnalyticsData): Promise<void> {
 		gaSettings.customDimensions = gaSettings.customDimensions || {};
 		gaSettings.customDimensions[GoogleAnalyticsCustomDimensions.client] = this.$options.analyticsClient || (isInteractive() ? AnalyticsClients.Cli : AnalyticsClients.Unknown);
diff --git a/lib/services/analytics/analytics.d.ts b/lib/services/analytics/analytics.d.ts
@@ -37,6 +37,8 @@ interface IAnalyticsBroker {
 
 interface IGoogleAnalyticsTrackingInformation extends IGoogleAnalyticsData, ITrackingInformation { }
 
+interface IPreviewAppTrackingInformation extends IPreviewAppGoogleAnalyticsData, ITrackingInformation { }
+
 /**
  * Describes methods required to track in Google Analytics.
  */
diff --git a/lib/services/livesync/playground/preview-app-livesync-service.ts b/lib/services/livesync/playground/preview-app-livesync-service.ts
@@ -1,6 +1,6 @@
 import * as path from "path";
 import { Device, FilesPayload } from "nativescript-preview-sdk";
-import { APP_RESOURCES_FOLDER_NAME, APP_FOLDER_NAME } from "../../../constants";
+import { APP_RESOURCES_FOLDER_NAME, APP_FOLDER_NAME, TrackActionNames } from "../../../constants";
 import { PreviewAppLiveSyncEvents } from "./preview-app-constants";
 import { HmrConstants } from "../../../common/constants";
 import { stringify } from "../../../common/helpers";
@@ -12,6 +12,7 @@ export class PreviewAppLiveSyncService extends EventEmitter implements IPreviewA
 	private deviceInitializationPromise: IDictionary<Promise<FilesPayload>> = {};
 
 	constructor(
+		private $analyticsService: IAnalyticsService,
 		private $errors: IErrors,
 		private $hooksService: IHooksService,
 		private $logger: ILogger,
@@ -37,6 +38,14 @@ export class PreviewAppLiveSyncService extends EventEmitter implements IPreviewA
 					return this.deviceInitializationPromise[device.id];
 				}
 
+				if (device.uniqueId) {
+					await this.$analyticsService.trackEventActionInGoogleAnalytics({
+						action: TrackActionNames.PreviewAppData,
+						platform: device.platform,
+						additionalData: device.uniqueId
+					});
+				}
+
 				this.deviceInitializationPromise[device.id] = this.getInitialFilesForDevice(data, device);
 				try {
 					const payloads = await this.deviceInitializationPromise[device.id];
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -58,7 +58,7 @@
     "mkdirp": "0.5.1",
     "mute-stream": "0.0.5",
     "nativescript-doctor": "1.8.1",
-    "nativescript-preview-sdk": "0.3.2",
+    "nativescript-preview-sdk": "0.3.3",
     "open": "0.0.5",
     "ora": "2.0.0",
     "osenv": "0.1.3",
diff --git a/test/services/playground/preview-app-livesync-service.ts b/test/services/playground/preview-app-livesync-service.ts
@@ -158,6 +158,9 @@ function createTestInjector(options?: {
 		getConnectedDevices: () => [deviceMockData]
 	});
 	injector.register("previewAppFilesService", PreviewAppFilesService);
+	injector.register("analyticsService", {
+		trackEventActionInGoogleAnalytics: () => ({})
+	});
 
 	return injector;
 }
diff --git a/test/services/playground/preview-app-plugins-service.ts b/test/services/playground/preview-app-plugins-service.ts
@@ -59,7 +59,8 @@ function createDevice(plugins: string): Device {
 		previewAppVersion: "28.0.0",
 		runtimeVersion: "4.3.0",
 		plugins,
-		pluginsExpanded: false
+		pluginsExpanded: false,
+		uniqueId: "testId"
 	};
 }
 
diff --git a/test/services/preview-devices-service.ts b/test/services/preview-devices-service.ts
@@ -29,7 +29,8 @@ function createDevice(id: string): Device {
 		name: "my test name",
 		osVersion: "10.0.0",
 		previewAppVersion: "19.0.0",
-		runtimeVersion: "5.0.0"
+		runtimeVersion: "5.0.0",
+		uniqueId: "testUniqueId"
 	};
 }
 

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,11 @@ export class AndroidDeviceFileSystem implements Mobile.IDeviceFileSystem {`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
	`51`	`+ public async getFileContent(deviceFilePath: string, appIdentifier: string): Promise<string> {`
	`52`	`+ const result = await this.adb.executeShellCommand(["cat", deviceFilePath]);`
	`53`	`+ return result;`
	`54`	`+ }`
	`55`	`+`
`51`	`56`	`public async putFile(localFilePath: string, deviceFilePath: string, appIdentifier: string): Promise<void> {`
`52`	`57`	`await this.adb.pushFile(localFilePath, deviceFilePath);`
`53`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,11 @@ export class IOSSimulatorFileSystem implements Mobile.IDeviceFileSystem {`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`
	`19`	`+ public async getFileContent(deviceFilePath: string, appIdentifier: string): Promise<string> {`
	`20`	`+ const result = this.$fs.readText(deviceFilePath);`
	`21`	`+ return result;`
	`22`	`+ }`
	`23`	`+`
`19`	`24`	`public async putFile(localFilePath: string, deviceFilePath: string, appIdentifier: string): Promise<void> {`
`20`	`25`	`shelljs.cp("-f", localFilePath, deviceFilePath);`
`21`	`26`	`}`
`@@ -27,7 +32,7 @@ export class IOSSimulatorFileSystem implements Mobile.IDeviceFileSystem {`
`27`	`32`	`public async transferFiles(deviceAppData: Mobile.IDeviceAppData, localToDevicePaths: Mobile.ILocalToDevicePathData[]): Promise<Mobile.ILocalToDevicePathData[]> {`
`28`	`33`	`await Promise.all(`
`29`	`34`	`_.map(localToDevicePaths, localToDevicePathData => this.transferFile(localToDevicePathData.getLocalPath(), localToDevicePathData.getDevicePath())`
`30`		`- ));`
	`35`	`+ ));`
`31`	`36`	`return localToDevicePaths;`
`32`	`37`	`}`
`33`	`38`
Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,8 @@ export const enum TrackActionNames {`
`156`	`156`	`CheckEnvironmentRequirements = "Check Environment Requirements",`
`157`	`157`	`Options = "Options",`
`158`	`158`	`AcceptTracking = "Accept Tracking",`
`159`		`- Performance = "Performance"`
	`159`	`+ Performance = "Performance",`
	`160`	`+ PreviewAppData = "Preview App Data"`
`160`	`161`	`}`
`161`	`162`
`162`	`163`	`export const AnalyticsEventLabelDelimiter = "__";`