chore: fix comments of PR

KristianDD · KristianDD · commit f81fc1645ee8 · 2018-07-18T10:57:20.000+03:00
diff --git a/lib/bootstrap.ts b/lib/bootstrap.ts
@@ -122,7 +122,7 @@ $injector.require("deployCommandHelper", "./helpers/deploy-command-helper");
 
 $injector.requirePublicClass("localBuildService", "./services/local-build-service");
 $injector.requirePublicClass("liveSyncService", "./services/livesync/livesync-service");
-$injector.requirePublicClass("androidLivesyncLibrary", "./services/livesync/android-livesync-library");
+$injector.requirePublicClass("androidLivesyncTool", "./services/livesync/android-livesync-tool");
 $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
diff --git a/lib/definitions/livesync.d.ts b/lib/definitions/livesync.d.ts
@@ -356,9 +356,19 @@ interface INativeScriptDeviceLiveSyncService extends IDeviceLiveSyncServiceBase
 	 * Removes specified files from a connected device
 	 * @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} projectFilesPath The Path to the app folder inside platforms folder
 	 * @return {Promise<void>}
 	 */
 	removeFiles(deviceAppData: Mobile.IDeviceAppData, localToDevicePaths: Mobile.ILocalToDevicePathData[], projectFilesPath?: string): Promise<void>;
+
+	/**
+	 * Transfers specified files to a connected device
+	 * @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} projectFilesPath The Path to the app folder inside platforms folder
+	 * @param  {boolean} isFullSync Indicates if the operation is part of a fullSync
+	 * @return {Promise<Mobile.ILocalToDevicePathData[]>} Returns the ILocalToDevicePathData of all transfered files
+	 */
 	transferFiles(deviceAppData: Mobile.IDeviceAppData, localToDevicePaths: Mobile.ILocalToDevicePathData[], projectFilesPath: string, isFullSync: boolean): Promise<Mobile.ILocalToDevicePathData[]>;
 }
 
diff --git a/lib/services/livesync/android-device-livesync-sockets-service.ts b/lib/services/livesync/android-device-livesync-sockets-service.ts
@@ -2,11 +2,12 @@ import { DeviceAndroidDebugBridge } from "../../common/mobile/android/device-and
 import { AndroidDeviceHashService } from "../../common/mobile/android/android-device-hash-service";
 import { DeviceLiveSyncServiceBase } from "./device-livesync-service-base";
 import { APP_FOLDER_NAME } from "../../constants";
-import { AndroidLivesyncTool } from "./android-livesync-library";
+import { AndroidLivesyncTool } from "./android-livesync-tool";
 import * as path from "path";
 
 export class AndroidDeviceSocketsLiveSyncService extends DeviceLiveSyncServiceBase implements IAndroidNativeScriptDeviceLiveSyncService, INativeScriptDeviceLiveSyncService {
 	private livesyncTool: IAndroidLivesyncTool;
+	private static STATUS_UPDATE_INTERVAL = 10000;
 
 	constructor(
 		private data: IProjectData,
@@ -30,8 +31,7 @@ export class AndroidDeviceSocketsLiveSyncService extends DeviceLiveSyncServiceBa
 	}
 
 	public async refreshApplication(projectData: IProjectData, liveSyncInfo: ILiveSyncResultInfo): Promise<void> {
-		const canExecuteFastSync = !liveSyncInfo.isFullSync && !_.some(liveSyncInfo.modifiedFilesData,
-			(localToDevicePath: Mobile.ILocalToDevicePathData) => !this.canExecuteFastSync(localToDevicePath.getLocalPath(), projectData, this.device.deviceInfo.platform));
+		const canExecuteFastSync = !liveSyncInfo.isFullSync && this.canExecuteFastSyncForPaths(liveSyncInfo.modifiedFilesData, projectData, this.device.deviceInfo.platform);
 
 		if (liveSyncInfo.modifiedFilesData.length) {
 			const operationIdentifier = this.livesyncTool.generateOperationIdentifier();
@@ -41,7 +41,7 @@ export class AndroidDeviceSocketsLiveSyncService extends DeviceLiveSyncServiceBa
 				if (this.livesyncTool.isOperationInProgress(operationIdentifier)) {
 					this.$logger.info("Sync operation in progress...");
 				}
-			}, 10000);
+			}, AndroidDeviceSocketsLiveSyncService.STATUS_UPDATE_INTERVAL);
 
 			const clearSyncInterval = () => {
 				clearInterval(syncInterval);
@@ -83,28 +83,28 @@ export class AndroidDeviceSocketsLiveSyncService extends DeviceLiveSyncServiceBa
 	}
 
 	private async _transferDirectory(deviceAppData: Mobile.IDeviceAppData, localToDevicePaths: Mobile.ILocalToDevicePathData[], projectFilesPath: string): Promise<Mobile.ILocalToDevicePathData[]> {
-		let transferedFiles: Mobile.ILocalToDevicePathData[];
+		let transferredLocalToDevicePaths : Mobile.ILocalToDevicePathData[];
 		const deviceHashService = this.getDeviceHashService(deviceAppData.appIdentifier);
 		const currentShasums: IStringDictionary = await deviceHashService.generateHashesFromLocalToDevicePaths(localToDevicePaths);
 		const oldShasums = await deviceHashService.getShasumsFromDevice();
 
 		if (this.$options.force || !oldShasums) {
 			await this.livesyncTool.sendDirectory(projectFilesPath);
 			await deviceHashService.uploadHashFileToDevice(currentShasums);
-			transferedFiles = localToDevicePaths;
+			transferredLocalToDevicePaths  = localToDevicePaths;
 		} else {
-			const changedShasums = deviceHashService.getChnagedShasums(oldShasums, currentShasums);
+			const changedShasums = deviceHashService.getChangedShasums(oldShasums, currentShasums);
 			const changedFiles = _.keys(changedShasums);
 			if (changedFiles.length) {
 				await this.livesyncTool.sendFiles(changedFiles);
 				await deviceHashService.uploadHashFileToDevice(currentShasums);
-				transferedFiles = localToDevicePaths.filter(localToDevicePathData => changedFiles.indexOf(localToDevicePathData.getLocalPath()) >= 0);
+				transferredLocalToDevicePaths  = localToDevicePaths.filter(localToDevicePathData => changedFiles.indexOf(localToDevicePathData.getLocalPath()) >= 0);
 			} else {
-				transferedFiles = [];
+				transferredLocalToDevicePaths  = [];
 			}
 		}
 
-		return transferedFiles;
+		return transferredLocalToDevicePaths ;
 	}
 
 	private async connectLivesyncTool(projectFilesPath: string, appIdentifier: string) {
diff --git a/lib/services/livesync/android-livesync-tool.md b/lib/services/livesync/android-livesync-tool.md
@@ -1,8 +1,8 @@
-# android-livesync-library
-Library for livesyncing changes to a NativeScript application on Android.
+# android-livesync-tool
+Tool for livesyncing changes to a NativeScript application on Android.
 
 ## Usage
-The library has a few public methods that allow file manipulation to the files of a NativeScript application and provide control for refreshing the application. Restarting the application if necessary should be done by the user of this library.
+The tool has a few public methods that allow file manipulation to the files of a NativeScript application and provide control for refreshing the application. Restarting the application if necessary should be done by the user of this tool.
 
 ### Getting an instance
 
@@ -12,7 +12,7 @@ const globalModulesPath = require("global-modules-path");
 const cliPath = globalModulesPath.getPath("nativescript", "tns");
 cli = require(cliPath);
 
-const liveSyncTool = cli.androidLivesyncLibrary;
+const liveSyncTool = cli.androidLivesyncTool;
 ```
 
 
diff --git a/lib/services/livesync/android-livesync-tool.ts b/lib/services/livesync/android-livesync-tool.ts
@@ -12,14 +12,15 @@ const ERROR_REPORT = 1;
 const OPERATION_END_REPORT = 2;
 const OPERATION_END_NO_REFRESH_REPORT_CODE = 3;
 const REPORT_LENGTH = 1;
+const SYNC_OPERATION_TIMEOUT = 60000;
+const TRY_CONNECT_TIMEOUT = 30000;
 const DEFAULT_LOCAL_HOST_ADDRESS = "127.0.0.1";
 
 export class AndroidLivesyncTool implements IAndroidLivesyncTool {
 	private operationPromises: IDictionary<any>;
 	private socketError: string | Error;
 	private socketConnection: IDuplexSocket;
 	private configuration: IAndroidLivesyncToolConfiguration;
-	private appPlatformsPath: string;
 
 	constructor(private $androidProcessService: Mobile.IAndroidProcessService,
 		private $errors: IErrors,
@@ -49,7 +50,6 @@ export class AndroidLivesyncTool implements IAndroidLivesyncTool {
 		}
 
 		this.configuration = configuration;
-		this.appPlatformsPath = this.configuration.appPlatformsPath;
 		this.socketError = null;
 
 		const port = await this.$androidProcessService.forwardFreeTcpToAbstractPort({
@@ -58,7 +58,7 @@ export class AndroidLivesyncTool implements IAndroidLivesyncTool {
 			abstractPort: `localabstract:${configuration.appIdentifier}-livesync`
 		});
 
-		const connectionResult = await this.connectEventuallyUntilTimeout(this.createSocket.bind(this, port), 30000);
+		const connectionResult = await this.connectEventuallyUntilTimeout(this.createSocket.bind(this, port), TRY_CONNECT_TIMEOUT);
 		this.handleConnection(connectionResult);
 	}
 
@@ -141,7 +141,7 @@ export class AndroidLivesyncTool implements IAndroidLivesyncTool {
 				if (this.isOperationInProgress(id)) {
 					this.handleSocketError(socketId, "Sync operation is taking too long");
 				}
-			}, 60000);
+			}, SYNC_OPERATION_TIMEOUT);
 		});
 
 		return operationPromise;
@@ -282,18 +282,18 @@ export class AndroidLivesyncTool implements IAndroidLivesyncTool {
 	private connectEventuallyUntilTimeout(factory: () => IDuplexSocket, timeout: number): Promise<{socket: IDuplexSocket, data: NodeBuffer | string}> {
 		return new Promise((resolve, reject) => {
 			let lastKnownError: Error | string,
-				isResolved = false;
+				isConnected = false;
 
 			setTimeout(() => {
-				if (!isResolved) {
-					isResolved = true;
+				if (!isConnected) {
+					isConnected = true;
 					reject(lastKnownError);
 				}
 			}, timeout);
 
 			const tryConnect = () => {
 				const tryConnectAfterTimeout = (error: Error) => {
-					if (isResolved) {
+					if (isConnected) {
 						return;
 					}
 
@@ -310,7 +310,7 @@ export class AndroidLivesyncTool implements IAndroidLivesyncTool {
 				socket.once("data", data => {
 					socket.removeListener("close", tryConnectAfterTimeout);
 					socket.removeListener("error", tryConnectAfterTimeout);
-					isResolved = true;
+					isConnected = true;
 					resolve({ socket, data });
 				});
 				socket.on("close", tryConnectAfterTimeout);
@@ -391,9 +391,9 @@ export class AndroidLivesyncTool implements IAndroidLivesyncTool {
 	}
 
 	private resolveRelativePath(filePath: string): string {
-		const relativeFilePath = path.relative(this.appPlatformsPath, filePath);
+		const relativeFilePath = path.relative(this.configuration.appPlatformsPath, filePath);
 
 		return this.$mobileHelper.buildDevicePath(relativeFilePath);
 	}
 }
-$injector.register("androidLivesyncLibrary", AndroidLivesyncTool);
+$injector.register("androidLivesyncTool", AndroidLivesyncTool);
diff --git a/lib/services/livesync/device-livesync-service-base.ts b/lib/services/livesync/device-livesync-service-base.ts
@@ -14,6 +14,12 @@ export abstract class DeviceLiveSyncServiceBase {
 		return _.includes(fastSyncFileExtensions, path.extname(filePath));
 	}
 
+	protected canExecuteFastSyncForPaths(localToDevicePaths: Mobile.ILocalToDevicePathData[], projectData: IProjectData, platform: string) {
+		return !_.some(localToDevicePaths,
+			(localToDevicePath: Mobile.ILocalToDevicePathData) =>
+				!this.canExecuteFastSync(localToDevicePath.getLocalPath(), projectData, this.device.deviceInfo.platform));
+	}
+
 	@cache()
 	private getFastLiveSyncFileExtensions(platform: string, projectData: IProjectData): string[] {
 		const platformData = this.$platformsData.getPlatformData(platform, projectData);
diff --git a/lib/services/livesync/ios-device-livesync-service.ts b/lib/services/livesync/ios-device-livesync-service.ts
@@ -61,7 +61,7 @@ export class IOSDeviceLiveSyncService extends DeviceLiveSyncServiceBase implemen
 		constants.LIVESYNC_EXCLUDED_FILE_PATTERNS.forEach(pattern => scriptRelatedFiles = _.concat(scriptRelatedFiles, localToDevicePaths.filter(file => minimatch(file.getDevicePath(), pattern, { nocase: true }))));
 
 		const otherFiles = _.difference(localToDevicePaths, _.concat(scriptFiles, scriptRelatedFiles));
-		const shouldRestart = _.some(otherFiles, (localToDevicePath: Mobile.ILocalToDevicePathData) => !this.canExecuteFastSync(localToDevicePath.getLocalPath(), projectData, deviceAppData.platform));
+		const shouldRestart = this.canExecuteFastSyncForPaths(otherFiles, projectData, deviceAppData.platform);
 
 		if (shouldRestart || (!liveSyncInfo.useLiveEdit && scriptFiles.length)) {
 			await this.restartApplication(deviceAppData, projectData.projectName);
