fix(migrate): remove useLegacyWorkflow property from nsconfig as its not respected anymore

Author: DimitarTachev

lib/controllers/migrate-controller.ts

@@ -160,6 +160,7 @@ export class MigrateController extends UpdateControllerBase implements IMigrateC
 
 	private async cleanUpProject(projectData: IProjectData): Promise<void> {
 		this.$logger.info("Clean old project artefacts.");
+		this.$projectDataService.removeNsConfigProperty(projectData.projectDir, "useLegacyWorkflow");
 		this.$fs.deleteDirectory(path.join(projectData.projectDir, constants.HOOKS_DIR_NAME));
 		this.$fs.deleteDirectory(path.join(projectData.projectDir, constants.PLATFORMS_DIR_NAME));
 		this.$fs.deleteDirectory(path.join(projectData.projectDir, constants.NODE_MODULES_FOLDER_NAME));

lib/definitions/project.d.ts

@@ -74,7 +74,6 @@ interface INsConfig {
 	appPath?: string;
 	appResourcesPath?: string;
 	shared?: boolean;
-	useLegacyWorkflow?: boolean;
 	previewAppSchema?: string;
 }
 
@@ -101,11 +100,6 @@ interface IProjectData extends ICreateProjectData {
 	 */
 	isShared: boolean;
 
-	/**
-	 * Defines if the project has hmr enabled by default
-	 */
-	useLegacyWorkflow: boolean;
-
 	/**
 	 * Defines the schema for the preview app
 	 */
@@ -150,6 +144,14 @@ interface IProjectDataService {
 	 */
 	removeNSProperty(projectDir: string, propertyName: string): void;
 
+	/**
+	 * Removes a property from `nsconfig.json`.
+	 * @param {string} projectDir The project directory - the place where the `nsconfig.json` is located.
+	 * @param {string} propertyName The name of the property to be removed.
+	 * @returns {void}
+	 */
+	removeNsConfigProperty(projectDir: string, propertyName: string): void;
+
 	/**
 	 * Removes dependency from package.json
 	 * @param {string} projectDir The project directory - the place where the root package.json is located.
@@ -192,12 +194,12 @@ interface IProjectDataService {
 	 */
 	getAppExecutableFiles(projectDir: string): string[];
 
-		/**
-	 * Returns a value from `nativescript` key in project's package.json.
-	 * @param {string} jsonData The project directory - the place where the root package.json is located.
-	 * @param {string} propertyName The name of the property to be checked in `nativescript` key.
-	 * @returns {any} The value of the property.
-	 */
+	/**
+ * Returns a value from `nativescript` key in project's package.json.
+ * @param {string} jsonData The project directory - the place where the root package.json is located.
+ * @param {string} propertyName The name of the property to be checked in `nativescript` key.
+ * @returns {any} The value of the property.
+ */
 	getNSValueFromContent(jsonData: Object, propertyName: string): any;
 }
 
@@ -496,7 +498,7 @@ interface IRemoveExtensionsOptions {
 	pbxProjPath: string
 }
 
-interface IRemoveWatchAppOptions extends IRemoveExtensionsOptions{}
+interface IRemoveWatchAppOptions extends IRemoveExtensionsOptions { }
 
 interface IRubyFunction {
 	functionName: string;

lib/project-data.ts

@@ -61,7 +61,6 @@ export class ProjectData implements IProjectData {
 	public buildXcconfigPath: string;
 	public podfilePath: string;
 	public isShared: boolean;
-	public useLegacyWorkflow: boolean;
 	public previewAppSchema: string;
 
 	constructor(private $fs: IFileSystem,
@@ -137,7 +136,6 @@ export class ProjectData implements IProjectData {
 			this.buildXcconfigPath = path.join(this.appResourcesDirectoryPath, this.$devicePlatformsConstants.iOS, constants.BUILD_XCCONFIG_FILE_NAME);
 			this.podfilePath = path.join(this.appResourcesDirectoryPath, this.$devicePlatformsConstants.iOS, constants.PODFILE_NAME);
 			this.isShared = !!(this.nsConfig && this.nsConfig.shared);
-			this.useLegacyWorkflow = this.nsConfig && this.nsConfig.useLegacyWorkflow;
 			this.previewAppSchema = this.nsConfig && this.nsConfig.previewAppSchema;
 			return;
 		}

lib/services/project-data-service.ts

@@ -1,5 +1,7 @@
 import * as path from "path";
 import { ProjectData } from "../project-data";
+import * as constants from "../constants";
+import { parseJson } from "../common/helpers";
 import { exported } from "../common/decorators";
 import {
 	NATIVESCRIPT_PROPS_INTERNAL_DELIMITER,
@@ -125,6 +127,12 @@ export class ProjectDataService implements IProjectDataService {
 		};
 	}
 
+	public removeNsConfigProperty(projectDir: string, propertyName: string): void {
+		this.$logger.trace(`Removing "${propertyName}" property from nsconfig.`);
+		this.updateNsConfigValue(projectDir, null, [propertyName]);
+		this.$logger.trace(`"${propertyName}" property successfully removed.`);
+	}
+
 	@exported("projectDataService")
 	public async getAndroidAssetsStructure(opts: IProjectDir): Promise<IAssetGroup> {
 		// TODO: Use image-size package to get the width and height of an image.
@@ -180,6 +188,43 @@ export class ProjectDataService implements IProjectDataService {
 
 		return files;
 	}
+	private refreshProjectData(projectDir: string) {
+		if (this.projectDataCache[projectDir]) {
+			this.projectDataCache[projectDir].initializeProjectData(projectDir);
+		}
+	}
+
+	private updateNsConfigValue(projectDir: string, updateObject?: INsConfig, propertiesToRemove?: string[]): void {
+		const nsConfigPath = path.join(projectDir, constants.CONFIG_NS_FILE_NAME);
+		const currentNsConfig = this.getNsConfig(nsConfigPath);
+		let newNsConfig = currentNsConfig;
+		if (updateObject) {
+			newNsConfig = _.assign(newNsConfig || this.getNsConfigDefaultObject(), updateObject);
+		}
+
+		if (newNsConfig && propertiesToRemove && propertiesToRemove.length) {
+			newNsConfig = _.omit(newNsConfig, propertiesToRemove);
+		}
+
+		if (newNsConfig) {
+			this.$fs.writeJson(nsConfigPath, newNsConfig);
+			this.refreshProjectData(projectDir);
+		}
+	}
+
+	private getNsConfig(nsConfigPath: string): INsConfig {
+		let result: INsConfig = null;
+		if (this.$fs.exists(nsConfigPath)) {
+			const nsConfigContent = this.$fs.readText(nsConfigPath);
+			try {
+				result = <INsConfig>parseJson(nsConfigContent);
+			} catch (e) {
+				// invalid nsconfig => null
+			}
+		}
+
+		return result;
+	}
 
 	private getImageDefinitions(): IImageDefinitionsStructure {
 		const pathToImageDefinitions = path.join(__dirname, "..", "..", CLI_RESOURCES_DIR_NAME, AssetConstants.assets, AssetConstants.imageDefinitionsFileName);
@@ -334,7 +379,7 @@ export class ProjectDataService implements IProjectDataService {
 	}
 
 	private getNsConfigDefaultObject(data?: Object): INsConfig {
-		const config: INsConfig = { useLegacyWorkflow: false };
+		const config: INsConfig = {};
 		Object.assign(config, data);
 
 		return config;

test/options.ts

@@ -263,73 +263,6 @@ describe("options", () => {
 	});
 
 	describe("setupOptions", () => {
-		const testCases = [
-			{
-				name: "no options are provided",
-				args: [],
-				data: [
-					{ useLegacyWorkflow: undefined, expectedHmr: true, expectedBundle: true },
-					{ useLegacyWorkflow: false, expectedHmr: true, expectedBundle: true },
-					{ useLegacyWorkflow: true, expectedHmr: true, expectedBundle: true }
-				]
-			},
-			{
-				name: " --hmr is provided",
-				args: ["--hmr"],
-				data: [
-					{ useLegacyWorkflow: undefined, expectedHmr: true, expectedBundle: true },
-					{ useLegacyWorkflow: false, expectedHmr: true, expectedBundle: true },
-					{ useLegacyWorkflow: true, expectedHmr: true, expectedBundle: true }
-				]
-			},
-			{
-				name: " --no-hmr is provided",
-				args: ["--no-hmr"],
-				data: [
-					{ useLegacyWorkflow: undefined, expectedHmr: false, expectedBundle: true },
-					{ useLegacyWorkflow: false, expectedHmr: false, expectedBundle: true },
-					{ useLegacyWorkflow: true, expectedHmr: false, expectedBundle: true }
-				]
-			},
-			{
-				name: " --bundle is provided",
-				args: ["--bundle"],
-				data: [
-					{ useLegacyWorkflow: undefined, expectedHmr: true, expectedBundle: true },
-					{ useLegacyWorkflow: false, expectedHmr: true, expectedBundle: true },
-					{ useLegacyWorkflow: true, expectedHmr: true, expectedBundle: true }
-				]
-			},
-			{
-				name: " --release is provided",
-				args: ["--release"],
-				data: [
-					{ useLegacyWorkflow: undefined, expectedHmr: false, expectedBundle: true },
-					{ useLegacyWorkflow: false, expectedHmr: false, expectedBundle: true },
-					{ useLegacyWorkflow: true, expectedHmr: false, expectedBundle: true }
-				]
-			}
-		];
-
-		_.each([undefined, false, true], useLegacyWorkflow => {
-			_.each(testCases, testCase => {
-				it(`should pass correctly when ${testCase.name} and useLegacyWorkflow is ${useLegacyWorkflow}`, () => {
-					(testCase.args || []).forEach(arg => process.argv.push(arg));
-
-					const options: any = createOptions(testInjector);
-					const projectData = <IProjectData>{ useLegacyWorkflow };
-					options.setupOptions(projectData);
-
-					(testCase.args || []).forEach(arg => process.argv.pop());
-
-					const data = testCase.data.find(item => item.useLegacyWorkflow === useLegacyWorkflow);
-
-					assert.equal(!!options.argv.hmr, !!data.expectedHmr);
-					assert.equal(!!options.argv.bundle, !!data.expectedBundle);
-				});
-			});
-		});
-
 		const testCasesExpectingToThrow = [
 			{
 				name: "--release --hmr",

test/stubs.ts

@@ -327,7 +327,6 @@ export class ProjectDataStub implements IProjectData {
 	public buildXcconfigPath: string;
 	public podfilePath: string;
 	public isShared: boolean;
-	public useLegacyWorkflow: boolean;
 	public previewAppSchema: string;
 
 	public initializeProjectData(projectDir?: string): void {
@@ -532,7 +531,7 @@ export class ProjectDataService implements IProjectDataService {
 		return [];
 	}
 
-	getNSValueFromContent(): any {}
+	getNSValueFromContent(): any { }
 }
 
 export class ProjectHelperStub implements IProjectHelper {