fix: fix plugin development workflow

Chokidar raises changed event when `.js` file is changed from within symlinked plugin and this led to a native build on every .js change for plugin's developer. As a workaround, we checked if there are native changes and rebuild the project only in this case.

Author: Fatme

lib/controllers/prepare-controller.ts

@@ -4,7 +4,7 @@ import { hook } from "../common/helpers";
 import { performanceLog } from "../common/decorators";
 import { EventEmitter } from "events";
 import * as path from "path";
-import { PREPARE_READY_EVENT_NAME, WEBPACK_COMPILATION_COMPLETE } from "../constants";
+import { PREPARE_READY_EVENT_NAME, WEBPACK_COMPILATION_COMPLETE, PACKAGE_JSON_FILE_NAME } from "../constants";
 
 interface IPlatformWatcherData {
 	webpackCompilerProcess: child_process.ChildProcess;
@@ -115,6 +115,8 @@ export class PrepareController extends EventEmitter {
 		}
 
 		const patterns = [
+			path.join(projectData.projectDir, PACKAGE_JSON_FILE_NAME),
+			path.join(projectData.getAppDirectoryPath(), PACKAGE_JSON_FILE_NAME),
 			path.join(projectData.getAppResourcesRelativeDirectoryPath(), platformData.normalizedPlatformName),
 			`node_modules/**/platforms/${platformData.platformNameLowerCase}/`
 		];

lib/controllers/run-controller.ts

@@ -302,8 +302,9 @@ export class RunController extends EventEmitter implements IRunController {
 
 			try {
 				if (data.hasNativeChanges) {
-					await this.$prepareNativePlatformService.prepareNativePlatform(platformData, projectData, prepareData);
-					await deviceDescriptor.buildAction();
+					if (await this.$prepareNativePlatformService.prepareNativePlatform(platformData, projectData, prepareData)) {
+						await deviceDescriptor.buildAction();
+					}
 				}
 
 				const isInHMRMode = liveSyncInfo.useHotModuleReload && data.hmrData && data.hmrData.hash;

lib/definitions/project-changes.d.ts

@@ -15,7 +15,6 @@ interface IPrepareInfo extends IAddedNativePlatform, IAppFilesHashes {
 interface IProjectChangesInfo extends IAddedNativePlatform {
 	appResourcesChanged: boolean;
 	configChanged: boolean;
-	packageChanged: boolean;
 	nativeChanged: boolean;
 	signingChanged: boolean;
 

lib/services/platform/prepare-native-platform-service.ts

@@ -22,11 +22,10 @@ export class PrepareNativePlatformService implements IPrepareNativePlatformServi
 		const changesInfo = await this.$projectChangesService.checkForChanges(platformData, projectData, prepareData);
 
 		const hasNativeModulesChange = !changesInfo || changesInfo.nativeChanged;
-		const hasPackageChange = !changesInfo || changesInfo.packageChanged;
 		const hasConfigChange = !changesInfo || changesInfo.configChanged;
 		const hasChangesRequirePrepare = !changesInfo || changesInfo.changesRequirePrepare;
 
-		const hasChanges = hasNativeModulesChange || hasPackageChange || hasConfigChange || hasChangesRequirePrepare;
+		const hasChanges = hasNativeModulesChange || hasConfigChange || hasChangesRequirePrepare;
 
 		if (changesInfo.hasChanges) {
 			await this.cleanProject(platformData, { release });
@@ -38,11 +37,11 @@ export class PrepareNativePlatformService implements IPrepareNativePlatformServi
 			await platformData.platformProjectService.prepareProject(projectData, prepareData);
 		}
 
-		if (hasNativeModulesChange || hasPackageChange) {
+		if (hasNativeModulesChange) {
 			await this.$nodeModulesBuilder.prepareNodeModules(platformData, projectData);
 		}
 
-		if (hasNativeModulesChange || hasPackageChange || hasConfigChange) {
+		if (hasNativeModulesChange || hasConfigChange) {
 			await platformData.platformProjectService.processConfigurationFilesFromAppResources(projectData, { release });
 			await platformData.platformProjectService.handleNativeDependenciesChange(projectData, { release });
 		}

lib/services/project-changes-service.ts

@@ -1,5 +1,5 @@
 import * as path from "path";
-import { NativePlatformStatus, PACKAGE_JSON_FILE_NAME, APP_GRADLE_FILE_NAME, BUILD_XCCONFIG_FILE_NAME } from "../constants";
+import { NativePlatformStatus, PACKAGE_JSON_FILE_NAME, APP_GRADLE_FILE_NAME, BUILD_XCCONFIG_FILE_NAME, PLATFORMS_DIR_NAME } from "../constants";
 import { getHash, hook } from "../common/helpers";
 import { PrepareData } from "../data/prepare-data";
 
@@ -9,21 +9,19 @@ class ProjectChangesInfo implements IProjectChangesInfo {
 
 	public appResourcesChanged: boolean;
 	public configChanged: boolean;
-	public packageChanged: boolean;
 	public nativeChanged: boolean;
 	public signingChanged: boolean;
 	public nativePlatformStatus: NativePlatformStatus;
 
 	public get hasChanges(): boolean {
-		return this.packageChanged ||
+		return this.nativeChanged ||
 			this.appResourcesChanged ||
 			this.configChanged ||
 			this.signingChanged;
 	}
 
 	public get changesRequireBuild(): boolean {
-		return this.packageChanged ||
-			this.appResourcesChanged ||
+		return this.appResourcesChanged ||
 			this.nativeChanged;
 	}
 
@@ -57,18 +55,23 @@ export class ProjectChangesService implements IProjectChangesService {
 		this._changesInfo = new ProjectChangesInfo();
 		const isNewPrepareInfo = await this.ensurePrepareInfo(platformData, projectData, prepareData);
 		if (!isNewPrepareInfo) {
-			this._changesInfo.packageChanged = this.isProjectFileChanged(projectData.projectDir, platformData);
-
 			const platformResourcesDir = path.join(projectData.appResourcesDirectoryPath, platformData.normalizedPlatformName);
 			this._changesInfo.appResourcesChanged = this.containsNewerFiles(platformResourcesDir, projectData);
 
 			this.$nodeModulesDependenciesBuilder.getProductionDependencies(projectData.projectDir)
-				.filter(dep => dep.nativescript && this.$fs.exists(path.join(dep.directory, "platforms", platformData.platformNameLowerCase)))
+				.filter(dep => dep.nativescript && this.$fs.exists(path.join(dep.directory, PLATFORMS_DIR_NAME, platformData.platformNameLowerCase)))
 				.map(dep => {
 					this._changesInfo.nativeChanged = this._changesInfo.nativeChanged ||
-						this.containsNewerFiles(path.join(dep.directory, "platforms", platformData.platformNameLowerCase), projectData);
+						this.containsNewerFiles(path.join(dep.directory, PLATFORMS_DIR_NAME, platformData.platformNameLowerCase), projectData) ||
+						this.isFileModified(path.join(dep.directory, PACKAGE_JSON_FILE_NAME));
 				});
 
+			if (!this._changesInfo.nativeChanged) {
+				const packageJsonChanged = this.isProjectFileChanged(projectData.projectDir, platformData);
+				this._prepareInfo.projectFileHash = this.getProjectFileStrippedHash(projectData.projectDir, platformData);
+				this._changesInfo.nativeChanged = packageJsonChanged;
+			}
+
 			this.$logger.trace(`Set nativeChanged to ${this._changesInfo.nativeChanged}.`);
 
 			if (platformData.platformNameLowerCase === this.$devicePlatformsConstants.iOS.toLowerCase()) {
@@ -106,8 +109,6 @@ export class ProjectChangesService implements IProjectChangesService {
 			if (this._prepareInfo.changesRequireBuild) {
 				this._prepareInfo.changesRequireBuildTime = this._prepareInfo.time;
 			}
-
-			this._prepareInfo.projectFileHash = this.getProjectFileStrippedHash(projectData.projectDir, platformData);
 		}
 
 		this._changesInfo.nativePlatformStatus = this._prepareInfo.nativePlatformStatus;
@@ -223,8 +224,7 @@ export class ProjectChangesService implements IProjectChangesService {
 			return false;
 		}
 
-		const dirFileStat = this.$fs.getFsStats(dir);
-		if (this.isFileModified(dirFileStat, dir)) {
+		if (this.isFileModified(dir)) {
 			this.$logger.trace(`containsNewerFiles returns true for ${dir} as the dir itself has been modified.`);
 			return true;
 		}
@@ -234,7 +234,7 @@ export class ProjectChangesService implements IProjectChangesService {
 			const filePath = path.join(dir, file);
 
 			const fileStats = this.$fs.getFsStats(filePath);
-			const changed = this.isFileModified(fileStats, filePath);
+			const changed = this.isFileModified(filePath, fileStats);
 
 			if (changed) {
 				this.$logger.trace(`containsNewerFiles returns true for ${dir}. The modified file is ${filePath}`);
@@ -253,9 +253,10 @@ export class ProjectChangesService implements IProjectChangesService {
 		return false;
 	}
 
-	private isFileModified(filePathStat: IFsStats, filePath: string): boolean {
-		let changed = filePathStat.mtime.getTime() >= this._outputProjectMtime ||
-			filePathStat.ctime.getTime() >= this._outputProjectCTime;
+	private isFileModified(filePath: string, filePathStats?: IFsStats): boolean {
+		filePathStats = filePathStats || this.$fs.getFsStats(filePath);
+		let changed = filePathStats.mtime.getTime() >= this._outputProjectMtime ||
+			filePathStats.ctime.getTime() >= this._outputProjectCTime;
 
 		if (!changed) {
 			const lFileStats = this.$fs.getLsStats(filePath);

test/stubs.ts

@@ -506,16 +506,10 @@ export class ProjectDataService implements IProjectDataService {
 	removeDependency(dependencyName: string): void { }
 
 	getProjectData(projectDir: string): IProjectData {
-		return <any>{
-			projectDir: "/path/to/my/projecDir",
-			projectName: "myTestProjectName",
-			platformsDir: "/path/to/my/projecDir/platforms",
-			projectIdentifiers: {
-				ios: "org.nativescript.myiosApp",
-				android: "org.nativescript.myAndroidApp"
-			},
-			getAppResourcesRelativeDirectoryPath: () => "/path/to/my/projecDir/App_Resources"
-		};
+		const projectData = new ProjectDataStub();
+		projectData.initializeProjectData(projectDir);
+
+		return projectData;
 	}
 
 	async getAssetsStructure(opts: IProjectDir): Promise<IAssetsStructure> {