Start livesync watcher before preparing the project

Implemented #3404

Author: Fatme

lib/bootstrap.ts

@@ -165,3 +165,5 @@ $injector.require("nativeScriptCloudExtensionService", "./services/nativescript-
 $injector.requireCommand("resources|generate|icons", "./commands/generate-assets");
 $injector.requireCommand("resources|generate|splashes", "./commands/generate-assets");
 $injector.requirePublic("assetsGenerationService", "./services/assets-generation/assets-generation-service");
+
+$injector.require("filesHashService", "./services/files-hash-service");

lib/definitions/files-hash-service.d.ts

@@ -0,0 +1,4 @@
+interface IFilesHashService {
+	generateHashes(files: string[]): Promise<IStringDictionary>;
+	getChanges(files: string[], oldHashes: IStringDictionary): Promise<IStringDictionary>;
+}

lib/definitions/platform.d.ts

@@ -88,7 +88,7 @@ interface IPlatformService extends IBuildPlatformAction, NodeJS.EventEmitter {
 	 * @param {IShouldPrepareInfo} shouldPrepareInfo Options needed to decide whether to prepare.
 	 * @returns {Promise<boolean>} true indicates that the project should be prepared.
 	 */
-	shouldPrepare(shouldPrepareInfo: IShouldPrepareInfo): Promise<boolean>
+	shouldPrepare(shouldPrepareInfo: IShouldPrepareInfo): Promise<boolean>;
 
 	/**
 	 * Installs the application on specified device.
@@ -213,7 +213,7 @@ interface IPlatformService extends IBuildPlatformAction, NodeJS.EventEmitter {
 	 * @param {string} buildInfoFileDirname The directory where the build file should be written to.
 	 * @returns {void}
 	 */
-	saveBuildInfoFile(platform: string, projectDir: string, buildInfoFileDirname: string): void
+	saveBuildInfoFile(platform: string, projectDir: string, buildInfoFileDirname: string): void;
 }
 
 interface IPlatformOptions extends IPlatformSpecificData, ICreateProjectOptions { }

lib/definitions/project-changes.d.ts

@@ -1,4 +1,8 @@
-interface IPrepareInfo extends IAddedNativePlatform {
+interface IAppFilesHashes {
+	appFilesHashes: IStringDictionary;
+}
+
+interface IPrepareInfo extends IAddedNativePlatform, IAppFilesHashes {
 	time: string;
 	bundle: boolean;
 	release: boolean;

lib/services/files-hash-service.ts

@@ -0,0 +1,26 @@
+import { executeActionByChunks } from "../common/helpers";
+import { DEFAULT_CHUNK_SIZE } from "../common/constants";
+
+export class FilesHashService implements IFilesHashService {
+	constructor(private $fs: IFileSystem) { }
+
+	public async generateHashes(files: string[]): Promise<IStringDictionary> {
+		const result: IStringDictionary = {};
+
+		const action = async (file: string) => {
+			if (this.$fs.getFsStats(file).isFile()) {
+				result[file] = await this.$fs.getFileShasum(file);
+			}
+		};
+
+		await executeActionByChunks(files, DEFAULT_CHUNK_SIZE, action);
+
+		return result;
+	}
+
+	public async getChanges(files: string[], oldHashes: IStringDictionary): Promise<IStringDictionary> {
+		const newHashes = await this.generateHashes(files);
+		return _.omitBy(newHashes, (hash: string, pathToFile: string) => !!_.find(oldHashes, (oldHash: string, oldPath: string) => pathToFile === oldPath && hash === oldHash));
+	}
+}
+$injector.register("filesHashService", FilesHashService);

lib/services/livesync/livesync-service.ts

@@ -318,26 +318,16 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 	}
 
 	@hook("liveSync")
-	private async liveSyncOperation(deviceDescriptors: ILiveSyncDeviceInfo[],
-		liveSyncData: ILiveSyncInfo, projectData: IProjectData): Promise<void> {
+	private async liveSyncOperation(deviceDescriptors: ILiveSyncDeviceInfo[], liveSyncData: ILiveSyncInfo, projectData: IProjectData): Promise<void> {
 		// In case liveSync is called for a second time for the same projectDir.
 		const isAlreadyLiveSyncing = this.liveSyncProcessesInfo[projectData.projectDir] && !this.liveSyncProcessesInfo[projectData.projectDir].isStopped;
 
-		// Prevent cases where liveSync is called consecutive times with the same device, for example [ A, B, C ] and then [ A, B, D ] - we want to execute initialSync only for D.
-		const currentlyRunningDeviceDescriptors = this.getLiveSyncDeviceDescriptors(projectData.projectDir);
-		const deviceDescriptorsForInitialSync = isAlreadyLiveSyncing ? _.differenceBy(deviceDescriptors, currentlyRunningDeviceDescriptors, deviceDescriptorPrimaryKey) : deviceDescriptors;
 		this.setLiveSyncProcessInfo(liveSyncData.projectDir, deviceDescriptors);
 
-		await this.initialSync(projectData, deviceDescriptorsForInitialSync, liveSyncData);
-
 		if (!liveSyncData.skipWatcher && this.liveSyncProcessesInfo[projectData.projectDir].deviceDescriptors.length) {
 			// Should be set after prepare
 			this.$usbLiveSyncService.isInitialized = true;
-
-			const devicesIds = deviceDescriptors.map(dd => dd.identifier);
-			const devices = _.filter(this.$devicesService.getDeviceInstances(), device => _.includes(devicesIds, device.deviceInfo.identifier));
-			const platforms = _(devices).map(device => device.deviceInfo.platform).uniq().value();
-			await this.startWatcher(projectData, liveSyncData, platforms);
+			await this.startWatcher(projectData, liveSyncData, deviceDescriptors, { isAlreadyLiveSyncing });
 		}
 	}
 
@@ -351,6 +341,13 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 		this.liveSyncProcessesInfo[projectDir].deviceDescriptors = _.uniqBy(currentDeviceDescriptors.concat(deviceDescriptors), deviceDescriptorPrimaryKey);
 	}
 
+	private async initialSync(projectData: IProjectData, liveSyncData: ILiveSyncInfo, deviceDescriptors: ILiveSyncDeviceInfo[], options: { isAlreadyLiveSyncing: boolean }): Promise<void> {
+		// Prevent cases where liveSync is called consecutive times with the same device, for example [ A, B, C ] and then [ A, B, D ] - we want to execute initialSync only for D.
+		const currentlyRunningDeviceDescriptors = this.getLiveSyncDeviceDescriptors(projectData.projectDir);
+		const deviceDescriptorsForInitialSync = options.isAlreadyLiveSyncing ? _.differenceBy(deviceDescriptors, currentlyRunningDeviceDescriptors, deviceDescriptorPrimaryKey) : deviceDescriptors;
+		await this.initialSyncCore(projectData, deviceDescriptorsForInitialSync, liveSyncData);
+	}
+
 	private getLiveSyncService(platform: string): IPlatformLiveSyncService {
 		if (this.$mobileHelper.isiOSPlatform(platform)) {
 			return this.$injector.resolve("iOSLiveSyncService");
@@ -452,7 +449,7 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 		return null;
 	}
 
-	private async initialSync(projectData: IProjectData, deviceDescriptors: ILiveSyncDeviceInfo[], liveSyncData: ILiveSyncInfo): Promise<void> {
+	private async initialSyncCore(projectData: IProjectData, deviceDescriptors: ILiveSyncDeviceInfo[], liveSyncData: ILiveSyncInfo): Promise<void> {
 		const preparedPlatforms: string[] = [];
 		const rebuiltInformation: ILiveSyncBuildInfo[] = [];
 
@@ -483,6 +480,7 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 					useLiveEdit: liveSyncData.useLiveEdit,
 					watch: !liveSyncData.skipWatcher
 				});
+
 				await this.$platformService.trackActionForPlatform({ action: "LiveSync", platform: device.deviceInfo.platform, isForDevice: !device.isEmulator, deviceOsVersion: device.deviceInfo.version });
 				await this.refreshApplication(projectData, liveSyncResultInfo, deviceBuildInfoDescriptor.debugOptions, deviceBuildInfoDescriptor.outputPath);
 
@@ -525,7 +523,10 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 		};
 	}
 
-	private async startWatcher(projectData: IProjectData, liveSyncData: ILiveSyncInfo, platforms: string[]): Promise<void> {
+	private async startWatcher(projectData: IProjectData, liveSyncData: ILiveSyncInfo, deviceDescriptors: ILiveSyncDeviceInfo[], options: { isAlreadyLiveSyncing: boolean }): Promise<void> {
+		const devicesIds = deviceDescriptors.map(dd => dd.identifier);
+		const devices = _.filter(this.$devicesService.getDeviceInstances(), device => _.includes(devicesIds, device.deviceInfo.identifier));
+		const platforms = _(devices).map(device => device.deviceInfo.platform).uniq().value();
 		const patterns = await this.getWatcherPatterns(liveSyncData, projectData, platforms);
 
 		if (liveSyncData.watchAllFiles) {
@@ -683,6 +684,8 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 			this.liveSyncProcessesInfo[liveSyncData.projectDir].watcherInfo = { watcher, patterns };
 			this.liveSyncProcessesInfo[liveSyncData.projectDir].timer = timeoutTimer;
 
+			await this.initialSync(projectData, liveSyncData, deviceDescriptors, options);
+
 			this.$processService.attachToProcessExitSignals(this, () => {
 				_.keys(this.liveSyncProcessesInfo).forEach(projectDir => {
 					// Do not await here, we are in process exit's handler.

lib/services/project-changes-service.ts

@@ -1,5 +1,5 @@
 import * as path from "path";
-import { NODE_MODULES_FOLDER_NAME, NativePlatformStatus, PACKAGE_JSON_FILE_NAME, APP_GRADLE_FILE_NAME, BUILD_XCCONFIG_FILE_NAME } from "../constants";
+import { NODE_MODULES_FOLDER_NAME, NativePlatformStatus, PACKAGE_JSON_FILE_NAME, APP_GRADLE_FILE_NAME, BUILD_XCCONFIG_FILE_NAME, APP_RESOURCES_FOLDER_NAME } from "../constants";
 import { getHash } from "../common/helpers";
 
 const prepareInfoFileName = ".nsprepareinfo";
@@ -48,7 +48,8 @@ export class ProjectChangesService implements IProjectChangesService {
 	constructor(
 		private $platformsData: IPlatformsData,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
-		private $fs: IFileSystem) {
+		private $fs: IFileSystem,
+		private $filesHashService: IFilesHashService) {
 	}
 
 	public get currentChanges(): IProjectChangesInfo {
@@ -60,7 +61,10 @@ export class ProjectChangesService implements IProjectChangesService {
 		this._changesInfo = new ProjectChangesInfo();
 		if (!this.ensurePrepareInfo(platform, projectData, projectChangesOptions)) {
 			this._newFiles = 0;
-			this._changesInfo.appFilesChanged = this.containsNewerFiles(projectData.appDirectoryPath, projectData.appResourcesDirectoryPath, projectData);
+
+			const appFiles = this.$fs.enumerateFilesInDirectorySync(projectData.appDirectoryPath, (filePath: string, stat: IFsStats) => filePath.indexOf(APP_RESOURCES_FOLDER_NAME) === -1);
+			this._changesInfo.appFilesChanged = await this.hasChangedFiles(appFiles, projectData);
+
 			this._changesInfo.packageChanged = this.isProjectFileChanged(projectData, platform);
 			this._changesInfo.appResourcesChanged = this.containsNewerFiles(projectData.appResourcesDirectoryPath, null, projectData);
 			/*done because currently all node_modules are traversed, a possible improvement could be traversing only the production dependencies*/
@@ -173,7 +177,8 @@ export class ProjectChangesService implements IProjectChangesService {
 			release: projectChangesOptions.release,
 			changesRequireBuild: true,
 			projectFileHash: this.getProjectFileStrippedHash(projectData, platform),
-			changesRequireBuildTime: null
+			changesRequireBuildTime: null,
+			appFilesHashes: {}
 		};
 
 		this._outputProjectMtime = 0;
@@ -300,5 +305,15 @@ export class ProjectChangesService implements IProjectChangesService {
 		}
 		return false;
 	}
+
+	private async hasChangedFiles(files: string[], projectData: IProjectData): Promise<boolean> {
+		const changedFiles = await this.$filesHashService.getChanges(files, this._prepareInfo.appFilesHashes || {});
+		const hasChanges = changedFiles && _.keys(changedFiles).length > 0;
+		if (hasChanges) {
+			this._prepareInfo.appFilesHashes = await this.$filesHashService.generateHashes(files);
+		}
+
+		return hasChanges;
+	}
 }
 $injector.register("projectChangesService", ProjectChangesService);

test/project-changes-service.ts

@@ -30,6 +30,7 @@ class ProjectChangesServiceTest extends BaseServiceTest {
 		this.injector.register("devicePlatformsConstants", {});
 		this.injector.register("devicePlatformsConstants", {});
 		this.injector.register("projectChangesService", ProjectChangesService);
+		this.injector.register("filesHashService", {});
 
 		const fs = this.injector.resolve<IFileSystem>("fs");
 		fs.writeJson(path.join(this.projectDir, Constants.PACKAGE_JSON_FILE_NAME), {
@@ -127,7 +128,8 @@ describe("Project Changes Service Tests", () => {
 					changesRequireBuildTime: new Date().toString(),
 					iOSProvisioningProfileUUID: "provisioning_profile_test",
 					projectFileHash: "",
-					nativePlatformStatus: Constants.NativePlatformStatus.requiresPlatformAdd
+					nativePlatformStatus: Constants.NativePlatformStatus.requiresPlatformAdd,
+					appFilesHashes: {}
 				};
 				fs.writeJson(prepareInfoPath, expectedPrepareInfo);