Fix comments vol. I

Author: Dimitar Kerezov

PublicAPI.md

@@ -625,7 +625,7 @@ tns.liveSyncService.on("liveSyncStarted", data => {
 });
 ```
 
-* liveSyncExecuted - raised whenever CLI finishes a LiveSync operation for specific device. When `liveSync` method is called, the initial LiveSync operation will emit `liveSyncExecuted` for each specified device once it finishes the operation. After that the event will be emitted whenever a change is detected (in case file system watcher is staretd) and the LiveSync operation is executed for each device. The event is raised with the following data:
+* liveSyncExecuted - raised whenever CLI finishes a LiveSync operation for specific device. When `liveSync` method is called, the initial LiveSync operation will emit `liveSyncExecuted` for each specified device once it finishes the operation. After that the event will be emitted whenever a change is detected (in case file system watcher is started) and the LiveSync operation is executed for each device. The event is raised with the following data:
 ```TypeScript
 {
 	projectDir: string;
@@ -641,7 +641,7 @@ tns.liveSyncService.on("liveSyncStarted", data => {
 Example:
 ```JavaScript
 tns.liveSyncService.on("liveSyncExecuted", data => {
-	console.log(`Executed LiveSync on ${data.deviceIdentifier} for ${data.applicationIdentifier}. Uploaded files are: ${syncedFiles.join(" ")}.`);
+	console.log(`Executed LiveSync on ${data.deviceIdentifier} for ${data.applicationIdentifier}. Uploaded files are: ${data.syncedFiles.join(" ")}.`);
 });
 ```
 
@@ -680,7 +680,7 @@ tns.liveSyncService.on("liveSyncStopped", data => {
 Example:
 ```JavaScript
 tns.liveSyncService.on("liveSyncError", data => {
-	console.log(`Error detected during LiveSync on ${data.deviceIdentifier} for ${data.projectDir}. Error: ${err.message}.`);
+	console.log(`Error detected during LiveSync on ${data.deviceIdentifier} for ${data.projectDir}. Error: ${data.error.message}.`);
 });
 ```
 
@@ -697,7 +697,7 @@ tns.liveSyncService.on("liveSyncError", data => {
 Example:
 ```JavaScript
 tns.liveSyncService.on("notify", data => {
-	console.log(`Notification: ${notification} for LiveSync operation on ${data.deviceIdentifier} for ${data.projectDir}. `);
+	console.log(`Notification: ${data.notification} for LiveSync operation on ${data.deviceIdentifier} for ${data.projectDir}. `);
 });
 ```
 

lib/bootstrap.ts

@@ -104,12 +104,11 @@ $injector.require("devicePathProvider", "./device-path-provider");
 
 $injector.requireCommand("platform|clean", "./commands/platform-clean");
 
-$injector.requirePublicClass("liveSyncService", "./services/livesync/livesync-service"); // The name is used in https://github.com/NativeScript/nativescript-dev-typescript
+$injector.requirePublicClass("liveSyncService", "./services/livesync/livesync-service");
 $injector.require("debugLiveSyncService", "./services/livesync/debug-livesync-service");
 $injector.require("androidLiveSyncService", "./services/livesync/android-livesync-service");
 $injector.require("iOSLiveSyncService", "./services/livesync/ios-livesync-service");
 $injector.require("usbLiveSyncService", "./services/livesync/livesync-service"); // The name is used in https://github.com/NativeScript/nativescript-dev-typescript
-$injector.require("iosLiveSyncServiceLocator", "./services/livesync/ios-device-livesync-service");
 $injector.require("sysInfo", "./sys-info");
 
 $injector.require("iOSNotificationService", "./services/ios-notification-service");

lib/commands/build.ts

@@ -1,5 +1,6 @@
 export class BuildCommandBase {
 	constructor(protected $options: IOptions,
+		protected $errors: IErrors,
 		protected $projectData: IProjectData,
 		protected $platformsData: IPlatformsData,
 		protected $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
@@ -30,29 +31,32 @@ export class BuildCommandBase {
 			this.$platformService.copyLastOutput(platform, this.$options.copyTo, buildConfig, this.$projectData);
 		}
 	}
+
+	protected validatePlatform(platform: string): void {
+		if (!this.$platformService.isPlatformSupportedForOS(platform, this.$projectData)) {
+			this.$errors.fail(`Applications for platform ${platform} can not be built on this OS - ${process.platform}`);
+		}
+	}
 }
 
 export class BuildIosCommand extends BuildCommandBase implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 
 	constructor(protected $options: IOptions,
-		private $errors: IErrors,
+		$errors: IErrors,
 		$projectData: IProjectData,
 		$platformsData: IPlatformsData,
 		$devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		$platformService: IPlatformService) {
-		super($options, $projectData, $platformsData, $devicePlatformsConstants, $platformService);
+		super($options, $errors, $projectData, $platformsData, $devicePlatformsConstants, $platformService);
 	}
 
 	public async execute(args: string[]): Promise<void> {
 		return this.executeCore([this.$platformsData.availablePlatforms.iOS]);
 	}
 
 	public canExecute(args: string[]): Promise<boolean> {
-		if (!this.$platformService.isPlatformSupportedForOS(this.$devicePlatformsConstants.iOS, this.$projectData)) {
-			this.$errors.fail("Applications for platform %s can not be built on this OS - %s", this.$devicePlatformsConstants.iOS, process.platform);
-		}
-
+		super.validatePlatform(this.$devicePlatformsConstants.iOS);
 		return args.length === 0 && this.$platformService.validateOptions(this.$options.provision, this.$projectData, this.$platformsData.availablePlatforms.iOS);
 	}
 }
@@ -63,23 +67,20 @@ export class BuildAndroidCommand extends BuildCommandBase implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 
 	constructor(protected $options: IOptions,
-		private $errors: IErrors,
+		protected $errors: IErrors,
 		$projectData: IProjectData,
 		$platformsData: IPlatformsData,
 		$devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		$platformService: IPlatformService) {
-		super($options, $projectData, $platformsData, $devicePlatformsConstants, $platformService);
+		super($options, $errors, $projectData, $platformsData, $devicePlatformsConstants, $platformService);
 	}
 
 	public async execute(args: string[]): Promise<void> {
 		return this.executeCore([this.$platformsData.availablePlatforms.Android]);
 	}
 
 	public async canExecute(args: string[]): Promise<boolean> {
-		if (!this.$platformService.isPlatformSupportedForOS(this.$devicePlatformsConstants.Android, this.$projectData)) {
-			this.$errors.fail("Applications for platform %s can not be built on this OS - %s", this.$devicePlatformsConstants.Android, process.platform);
-		}
-
+		super.validatePlatform(this.$devicePlatformsConstants.Android);
 		if (this.$options.release && (!this.$options.keyStorePath || !this.$options.keyStorePassword || !this.$options.keyStoreAlias || !this.$options.keyStoreAliasPassword)) {
 			this.$errors.fail("When producing a release build, you need to specify all --key-store-* options.");
 		}

lib/commands/debug.ts

@@ -30,7 +30,6 @@ export abstract class DebugPlatformCommand implements ICommand {
 
 		this.$config.debugLivesync = true;
 
-		// TODO: Fix this call
 		await this.$devicesService.initialize({ deviceId: this.$options.device, platform: this.platform, skipDeviceDetectionInterval: true, skipInferPlatform: true });
 		await this.$devicesService.detectCurrentlyAttachedDevices();
 
@@ -42,7 +41,7 @@ export abstract class DebugPlatformCommand implements ICommand {
 					identifier: d.deviceInfo.identifier,
 					buildAction: async (): Promise<string> => {
 						const buildConfig: IBuildConfig = {
-							buildForDevice: !d.isEmulator, // this.$options.forDevice,
+							buildForDevice: !d.isEmulator,
 							projectDir: this.$options.path,
 							clean: this.$options.clean,
 							teamId: this.$options.teamId,
@@ -133,7 +132,7 @@ export class DebugIOSCommand extends DebugPlatformCommand {
 		}
 	}
 
-	public platform = "iOS";
+	public platform = this.$devicePlatformsConstants.iOS;
 }
 
 $injector.registerCommand("debug|ios", DebugIOSCommand);
@@ -162,7 +161,7 @@ export class DebugAndroidCommand extends DebugPlatformCommand {
 		return await super.canExecute(args) && await this.$platformService.validateOptions(this.$options.provision, this.$projectData, this.$platformsData.availablePlatforms.Android);
 	}
 
-	public platform = "Android";
+	public platform = this.$devicePlatformsConstants.Android;
 }
 
 $injector.registerCommand("debug|android", DebugAndroidCommand);

lib/commands/run.ts

@@ -72,7 +72,9 @@ export class RunCommandBase implements ICommand {
 				return info;
 			});
 
-		if ((!this.platform || this.$mobileHelper.isiOSPlatform(this.platform)) && (this.$options.watch || !this.$options.justlaunch)) {
+		const workingWithiOSDevices = !this.platform || this.$mobileHelper.isiOSPlatform(this.platform);
+		const shouldKeepProcessAlive = this.$options.watch || !this.$options.justlaunch;
+		if (workingWithiOSDevices && shouldKeepProcessAlive) {
 			this.$iosDeviceOperations.setShouldDispose(false);
 		}
 

lib/constants.ts

@@ -73,11 +73,13 @@ class ItunesConnectApplicationTypesClass implements IiTunesConnectApplicationTyp
 }
 
 export const ItunesConnectApplicationTypes = new ItunesConnectApplicationTypesClass();
-export const SYNC_DIR_NAME = "sync";
-export const REMOVEDSYNC_DIR_NAME = "removedsync";
-export const FULLSYNC_DIR_NAME = "fullsync";
-export const IOS_DEVICE_PROJECT_ROOT_PATH = "Library/Application Support/LiveSync/app";
-export const IOS_DEVICE_SYNC_ZIP_PATH = "Library/Application Support/LiveSync/sync.zip";
+export class LiveSyncPaths {
+	static SYNC_DIR_NAME = "sync";
+	static REMOVEDSYNC_DIR_NAME = "removedsync";
+	static FULLSYNC_DIR_NAME = "fullsync";
+	static IOS_DEVICE_PROJECT_ROOT_PATH = "Library/Application Support/LiveSync";
+	static IOS_DEVICE_SYNC_ZIP_PATH = "Library/Application Support/LiveSync/sync.zip";
+};
 export const ANGULAR_NAME = "angular";
 export const TYPESCRIPT_NAME = "typescript";
 export const BUILD_OUTPUT_EVENT_NAME = "buildOutput";

lib/definitions/livesync.d.ts

@@ -1,3 +1,4 @@
+// This interface is a mashup of NodeJS' along with Chokidar's event watchers
 interface IFSWatcher extends NodeJS.EventEmitter {
 	// from fs.FSWatcher
 	close(): void;
@@ -152,7 +153,6 @@ interface ILiveSyncWatchInfo {
 	isRebuilt: boolean;
 	syncAllFiles: boolean;
 	useLiveEdit?: boolean;
-
 }
 
 interface ILiveSyncResultInfo {
@@ -190,12 +190,11 @@ interface INativeScriptDeviceLiveSyncService extends IDeviceLiveSyncServiceBase
 
 	/**
 	 * Removes specified files from a connected device
-	 * @param  {string} appIdentifier Application identifier.
+	 * @param  {Mobile.IDeviceAppData} deviceAppData Data about device and app.
 	 * @param  {Mobile.ILocalToDevicePathData[]} localToDevicePaths Object containing a mapping of file paths from the system to the device.
-	 * @param  {string} projectId Project identifier - for example org.nativescript.livesync.
 	 * @return {Promise<void>}
 	 */
-	removeFiles(appIdentifier: string, localToDevicePaths: Mobile.ILocalToDevicePathData[], projectId: string): Promise<void>;
+	removeFiles(deviceAppData: Mobile.IDeviceAppData, localToDevicePaths: Mobile.ILocalToDevicePathData[]): Promise<void>;
 }
 
 interface IAndroidNativeScriptDeviceLiveSyncService {
@@ -209,12 +208,12 @@ interface IAndroidNativeScriptDeviceLiveSyncService {
 
 interface IDeviceProjectRootOptions {
 	appIdentifier: string;
+	getDirname?: boolean;
 	syncAllFiles?: boolean;
 	watch?: boolean;
 }
 
 interface IDevicePathProvider {
-	getDeviceBuildInfoDirname(device: Mobile.IDevice, appIdentifier: string): Promise<string>;
 	getDeviceProjectRootPath(device: Mobile.IDevice, options: IDeviceProjectRootOptions): Promise<string>;
 	getDeviceSyncZipPath(device: Mobile.IDevice): string;
 }

lib/definitions/platform.d.ts

@@ -55,7 +55,8 @@ interface IPlatformService extends NodeJS.EventEmitter {
 	 * - the .nsbuildinfo file in product folder points to an old prepare.
 	 * @param {string} platform The platform to build.
 	 * @param {IProjectData} projectData DTO with information about the project.
-	 * @param {IBuildConfig} buildConfig Indicates whether the build is for device or emulator.
+	 * @param {IBuildConfig} @optional buildConfig Indicates whether the build is for device or emulator.
+	 * @param {string} @optional outputPath Directory containing build information and artifacts.
 	 * @returns {boolean} true indicates that the platform should be build.
 	 */
 	shouldBuild(platform: string, projectData: IProjectData, buildConfig?: IBuildConfig, outputPath?: string): Promise<boolean>;
@@ -77,6 +78,7 @@ interface IPlatformService extends NodeJS.EventEmitter {
 	 * - the .nsbuildinfo file located in application root folder is different than the local .nsbuildinfo file
 	 * @param {Mobile.IDevice} device The device where the application should be installed.
 	 * @param {IProjectData} projectData DTO with information about the project.
+	 * @param {string} @optional outputPath Directory containing build information and artifacts.
 	 * @returns {Promise<boolean>} true indicates that the application should be installed.
 	 */
 	shouldInstall(device: Mobile.IDevice, projectData: IProjectData, outputPath?: string): Promise<boolean>;
@@ -87,6 +89,8 @@ interface IPlatformService extends NodeJS.EventEmitter {
 	 * * .nsbuildinfo is not persisted when building for release.
 	 * @param {Mobile.IDevice} device The device where the application should be installed.
 	 * @param {IRelease} options Whether the application was built in release configuration.
+	 * @param {string} @optional pathToBuiltApp Path to build artifact.
+	 * @param {string} @optional outputPath Directory containing build information and artifacts.
 	 * @param {IProjectData} projectData DTO with information about the project.
 	 * @returns {void}
 	 */
@@ -129,7 +133,10 @@ interface IPlatformService extends NodeJS.EventEmitter {
 	validatePlatform(platform: string, projectData: IProjectData): void;
 
 	/**
-	 * Ensures that passed platform can be built on the current OS
+	 * Checks whether passed platform can be built on the current OS
+	 * @param {string} platform The mobile platform.
+	 * @param {IProjectData} projectData DTO with information about the project.
+	 * @returns {boolean} Whether the platform is supported for current OS or not.
 	 */
 	isPlatformSupportedForOS(platform: string, projectData: IProjectData): boolean;
 

lib/definitions/simple-plist.d.ts

@@ -0,0 +1,4 @@
+declare module "simple-plist" {
+	export function readFile(filePath: string, callback?:(err: Error, obj: any) => void): void;
+	export function readFileSync(filePath: string): any;
+}

lib/device-path-provider.ts

@@ -1,5 +1,5 @@
 import { fromWindowsRelativePathToUnix } from "./common/helpers";
-import { IOS_DEVICE_SYNC_ZIP_PATH, IOS_DEVICE_PROJECT_ROOT_PATH, SYNC_DIR_NAME, FULLSYNC_DIR_NAME } from "./constants";
+import { APP_FOLDER_NAME, LiveSyncPaths } from "./constants";
 import { AndroidDeviceLiveSyncService } from "./services/livesync/android-device-livesync-service";
 import * as path from "path";
 
@@ -9,39 +9,35 @@ export class DevicePathProvider implements IDevicePathProvider {
 		private $iOSSimResolver: Mobile.IiOSSimResolver) {
 	}
 
-	public async getDeviceBuildInfoDirname(device: Mobile.IDevice, appIdentifier: string): Promise<string> {
-		let result = "";
-		if (this.$mobileHelper.isiOSPlatform(device.deviceInfo.platform)) {
-			result = path.dirname(await this.getDeviceProjectRootPath(device, { appIdentifier }));
-		} else if (this.$mobileHelper.isAndroidPlatform(device.deviceInfo.platform)) {
-			result = `/data/local/tmp/${appIdentifier}`;
-		}
-
-		return result;
-	}
-
 	public async getDeviceProjectRootPath(device: Mobile.IDevice, options: IDeviceProjectRootOptions): Promise<string> {
 		let projectRoot = "";
 		if (this.$mobileHelper.isiOSPlatform(device.deviceInfo.platform)) {
 			if (device.isEmulator) {
 				let applicationPath = this.$iOSSimResolver.iOSSim.getApplicationPath(device.deviceInfo.identifier, options.appIdentifier);
-				projectRoot = path.join(applicationPath, "app");
+				projectRoot = path.join(applicationPath);
 			} else {
-				projectRoot = IOS_DEVICE_PROJECT_ROOT_PATH;
+				projectRoot = LiveSyncPaths.IOS_DEVICE_PROJECT_ROOT_PATH;
+			}
+
+			if (!options.getDirname) {
+				projectRoot = path.join(projectRoot, APP_FOLDER_NAME);
 			}
 		} else if (this.$mobileHelper.isAndroidPlatform(device.deviceInfo.platform)) {
-			const deviceLiveSyncService = this.$injector.resolve<AndroidDeviceLiveSyncService>(AndroidDeviceLiveSyncService, { _device: device });
-			const hashService = deviceLiveSyncService.getDeviceHashService(options.appIdentifier);
-			const hashFile = options.syncAllFiles ? null : await hashService.doesShasumFileExistsOnDevice();
-			const syncFolderName = options.watch || hashFile ? SYNC_DIR_NAME : FULLSYNC_DIR_NAME;
-			projectRoot = `/data/local/tmp/${options.appIdentifier}/${syncFolderName}`;
+			projectRoot = `/data/local/tmp/${options.appIdentifier}`;
+			if (!options.getDirname) {
+				const deviceLiveSyncService = this.$injector.resolve<AndroidDeviceLiveSyncService>(AndroidDeviceLiveSyncService, { _device: device });
+				const hashService = deviceLiveSyncService.getDeviceHashService(options.appIdentifier);
+				const hashFile = options.syncAllFiles ? null : await hashService.doesShasumFileExistsOnDevice();
+				const syncFolderName = options.watch || hashFile ? LiveSyncPaths.SYNC_DIR_NAME : LiveSyncPaths.FULLSYNC_DIR_NAME;
+				projectRoot = path.join(projectRoot, syncFolderName);
+			}
 		}
 
 		return fromWindowsRelativePathToUnix(projectRoot);
 	}
 
 	public getDeviceSyncZipPath(device: Mobile.IDevice): string {
-		return this.$mobileHelper.isiOSPlatform(device.deviceInfo.platform) && !device.isEmulator ? IOS_DEVICE_SYNC_ZIP_PATH : undefined;
+		return this.$mobileHelper.isiOSPlatform(device.deviceInfo.platform) && !device.isEmulator ? LiveSyncPaths.IOS_DEVICE_SYNC_ZIP_PATH : undefined;
 	}
 }