feat: Add hook for checkForChanges

In case a plugin needs to apply some modifications over its own source, based on the project files, currently it cannot do it. The earliest possible hooks are before-shouldPrepare and beforePrepare, but they are both run after CLI had check the project for changes. In case the plugin uses any of these hooks and apply changes to its source code, CLI will not move the changes to platforms dir of the project as it will not recheck the project state.
In order to resolve this issue, add a hook to checkForChanges method. This way a plugin can apply the changes in before-checkForChanges hook and CLI will detect them correctly.
Change the method parameters to be a single object, which will allow easier modifications in the future without breaking the plugins that are already using the hook.

Author: rosen-vladimirov

lib/common

@@ -41,8 +41,12 @@ interface IProjectChangesOptions extends IAppFilesUpdaterOptions, IProvision, IT
 	nativePlatformStatus?: "1" | "2" | "3";
 }
 
+interface ICheckForChangesOptions extends IPlatform, IProjectDataComposition {
+	projectChangesOptions: IProjectChangesOptions
+}
+
 interface IProjectChangesService {
-	checkForChanges(platform: string, projectData: IProjectData, buildOptions: IProjectChangesOptions): Promise<IProjectChangesInfo>;
+	checkForChanges(checkForChangesOpts: ICheckForChangesOptions): Promise<IProjectChangesInfo>;
 	getPrepareInfo(platform: string, projectData: IProjectData): IPrepareInfo;
 	savePrepareInfo(platform: string, projectData: IProjectData): void;
 	getPrepareInfoFilePath(platform: string, projectData: IProjectData): string;

lib/definitions/project-changes.d.ts

@@ -269,13 +269,17 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 
 		const bundle = appFilesUpdaterOptions.bundle;
 		const nativePlatformStatus = (nativePrepare && nativePrepare.skipNativePrepare) ? constants.NativePlatformStatus.requiresPlatformAdd : constants.NativePlatformStatus.requiresPrepare;
-		const changesInfo = await this.$projectChangesService.checkForChanges(platform, projectData, {
-			bundle,
-			release: appFilesUpdaterOptions.release,
-			provision: config.provision,
-			teamId: config.teamId,
-			nativePlatformStatus,
-			skipModulesNativeCheck: skipNativeCheckOptions.skipModulesNativeCheck
+		const changesInfo = await this.$projectChangesService.checkForChanges({
+			platform,
+			projectData,
+			projectChangesOptions: {
+				bundle,
+				release: appFilesUpdaterOptions.release,
+				provision: config.provision,
+				teamId: config.teamId,
+				nativePlatformStatus,
+				skipModulesNativeCheck: skipNativeCheckOptions.skipModulesNativeCheck
+			}
 		});
 
 		this.$logger.trace("Changes info in prepare platform:", changesInfo);

lib/services/platform-service.ts

@@ -1,6 +1,6 @@
 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 { getHash } from "../common/helpers";
+import { getHash, hook } from "../common/helpers";
 
 const prepareInfoFileName = ".nsprepareinfo";
 
@@ -45,18 +45,25 @@ export class ProjectChangesService implements IProjectChangesService {
 	private _outputProjectMtime: number;
 	private _outputProjectCTime: number;
 
+	private get $hooksService(): IHooksService {
+		return this.$injector.resolve<IHooksService>("hooksService");
+	}
+
 	constructor(
 		private $platformsData: IPlatformsData,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $fs: IFileSystem,
-		private $filesHashService: IFilesHashService) {
+		private $filesHashService: IFilesHashService,
+		private $injector: IInjector) {
 	}
 
 	public get currentChanges(): IProjectChangesInfo {
 		return this._changesInfo;
 	}
 
-	public async checkForChanges(platform: string, projectData: IProjectData, projectChangesOptions: IProjectChangesOptions): Promise<IProjectChangesInfo> {
+	@hook("checkForChanges")
+	public async checkForChanges(checkForChangesOpts: ICheckForChangesOptions): Promise<IProjectChangesInfo> {
+		const { platform, projectData, projectChangesOptions } = checkForChangesOpts;
 		const platformData = this.$platformsData.getPlatformData(platform, projectData);
 		this._changesInfo = new ProjectChangesInfo();
 		const isNewPrepareInfo = await this.ensurePrepareInfo(platform, projectData, projectChangesOptions);

lib/services/project-changes-service.ts

@@ -6,6 +6,7 @@ import { PlatformsData } from "../lib/platforms-data";
 import { ProjectChangesService } from "../lib/services/project-changes-service";
 import * as Constants from "../lib/constants";
 import { FileSystem } from "../lib/common/file-system";
+import { HooksServiceStub } from "./stubs";
 
 // start tracking temporary folders/files
 temp.track();
@@ -36,6 +37,7 @@ class ProjectChangesServiceTest extends BaseServiceTest {
 		this.injector.register("logger", {
 			warn: () => ({})
 		});
+		this.injector.register("hooksService", HooksServiceStub);
 
 		const fs = this.injector.resolve<IFileSystem>("fs");
 		fs.writeJson(path.join(this.projectDir, Constants.PACKAGE_JSON_FILE_NAME), {
@@ -149,9 +151,28 @@ describe("Project Changes Service Tests", () => {
 
 	describe("Accumulates Changes From Project Services", () => {
 		it("accumulates changes from the project service", async () => {
-			const iOSChanges = await serviceTest.projectChangesService.checkForChanges("ios", serviceTest.projectData, { bundle: false, release: false, provision: undefined, teamId: undefined });
+			const iOSChanges = await serviceTest.projectChangesService.checkForChanges({
+				platform: "ios",
+				projectData: serviceTest.projectData,
+				projectChangesOptions: {
+					bundle: false,
+					release: false,
+					provision: undefined,
+					teamId: undefined
+				}
+			});
 			assert.isTrue(!!iOSChanges.signingChanged, "iOS signingChanged expected to be true");
-			const androidChanges = await serviceTest.projectChangesService.checkForChanges("android", serviceTest.projectData, { bundle: false, release: false, provision: undefined, teamId: undefined });
+
+			const androidChanges = await serviceTest.projectChangesService.checkForChanges({
+				platform: "android",
+				projectData: serviceTest.projectData,
+				projectChangesOptions: {
+					bundle: false,
+					release: false,
+					provision: undefined,
+					teamId: undefined
+				}
+			});
 			assert.isFalse(!!androidChanges.signingChanged, "Android signingChanged expected to be false");
 		});
 	});

test/project-changes-service.ts

@@ -651,7 +651,7 @@ export class ChildProcessStub {
 }
 
 export class ProjectChangesService implements IProjectChangesService {
-	public async checkForChanges(platform: string): Promise<IProjectChangesInfo> {
+	public async checkForChanges(checkForChangesOpts: ICheckForChangesOptions): Promise<IProjectChangesInfo> {
 		return <IProjectChangesInfo>{};
 	}