feat: deprecate the legacy workflow and recommend the new one

DimitarTachev · DimitarTachev · commit d255b97ac3e4 · 2019-04-18T11:03:50.000+03:00
diff --git a/lib/bootstrap.ts b/lib/bootstrap.ts
@@ -190,6 +190,7 @@ $injector.require("hmrStatusService", "./services/hmr-status-service");
 $injector.require("pacoteService", "./services/pacote-service");
 $injector.require("qrCodeTerminalService", "./services/qr-code-terminal-service");
 $injector.require("testInitializationService", "./services/test-initialization-service");
+$injector.require("workflowService", "./services/workflow-service");
 
 $injector.require("networkConnectivityValidator", "./helpers/network-connectivity-validator");
 $injector.requirePublic("cleanupService", "./services/cleanup-service");
diff --git a/lib/commands/preview.ts b/lib/commands/preview.ts
@@ -14,12 +14,14 @@ export class PreviewCommand implements ICommand {
 		private $options: IOptions,
 		private $previewAppLogProvider: IPreviewAppLogProvider,
 		private $previewQrCodeService: IPreviewQrCodeService,
+		protected $workflowService: IWorkflowService,
 		$cleanupService: ICleanupService) {
-			this.$analyticsService.setShouldDispose(false);
-			$cleanupService.setShouldDispose(false);
-		}
+		this.$analyticsService.setShouldDispose(false);
+		$cleanupService.setShouldDispose(false);
+	}
 
 	public async execute(): Promise<void> {
+		await this.$workflowService.handleLegacyWorkflow(this.$projectData.projectDir, this.$options);
 		this.$previewAppLogProvider.on(DEVICE_LOG_EVENT_NAME, (deviceId: string, message: string) => {
 			this.$logger.info(message);
 		});
diff --git a/lib/commands/test.ts b/lib/commands/test.ts
@@ -11,8 +11,10 @@ abstract class TestCommandBase {
 	protected abstract $platformEnvironmentRequirements: IPlatformEnvironmentRequirements;
 	protected abstract $errors: IErrors;
 	protected abstract $cleanupService: ICleanupService;
+	protected abstract $workflowService: IWorkflowService;
 
 	async execute(args: string[]): Promise<void> {
+		await this.$workflowService.handleLegacyWorkflow(this.$projectData.projectDir, this.$options);
 		await this.$testExecutionService.startKarmaServer(this.platform, this.$projectData, this.projectFilesConfig);
 	}
 
@@ -54,7 +56,8 @@ class TestAndroidCommand extends TestCommandBase implements ICommand {
 		protected $options: IOptions,
 		protected $platformEnvironmentRequirements: IPlatformEnvironmentRequirements,
 		protected $errors: IErrors,
-		protected $cleanupService: ICleanupService) {
+		protected $cleanupService: ICleanupService,
+		protected $workflowService: IWorkflowService) {
 		super();
 	}
 
@@ -69,7 +72,8 @@ class TestIosCommand extends TestCommandBase implements ICommand {
 		protected $options: IOptions,
 		protected $platformEnvironmentRequirements: IPlatformEnvironmentRequirements,
 		protected $errors: IErrors,
-		protected $cleanupService: ICleanupService) {
+		protected $cleanupService: ICleanupService,
+		protected $workflowService: IWorkflowService) {
 		super();
 	}
 
diff --git a/lib/commands/update.ts b/lib/commands/update.ts
@@ -12,7 +12,8 @@ export class UpdateCommand extends ValidatePlatformCommandBase implements IComma
 		private $pluginsService: IPluginsService,
 		private $projectDataService: IProjectDataService,
 		private $fs: IFileSystem,
-		private $logger: ILogger) {
+		private $logger: ILogger,
+		private $workflowService: IWorkflowService) {
 		super($options, $platformsData, $platformService, $projectData);
 		this.$projectData.initializeProjectData();
 	}
@@ -28,6 +29,12 @@ export class UpdateCommand extends ValidatePlatformCommandBase implements IComma
 	static readonly backupFailMessage: string = "Could not backup project folders!";
 
 	public async execute(args: string[]): Promise<void> {
+		if (this.$options.workflow) {
+			const forceWebpackWorkflow = true;
+			await this.$workflowService.handleLegacyWorkflow(this.$projectData.projectDir, this.$options, forceWebpackWorkflow);
+			return;
+		}
+
 		const tmpDir = path.join(this.$projectData.projectDir, UpdateCommand.tempFolder);
 
 		try {
diff --git a/lib/declarations.d.ts b/lib/declarations.d.ts
@@ -571,6 +571,7 @@ interface IOptions extends IRelease, IDeviceIdentifier, IJustLaunch, IAvd, IAvai
 	performance: Object;
 	setupOptions(projectData: IProjectData): void;
 	cleanupLogFile: string;
+	workflow: boolean;
 }
 
 interface IEnvOptions {
@@ -940,6 +941,12 @@ interface IBundleValidatorHelper {
 	 * @return {void}
 	 */
 	validate(minSupportedVersion?: string): void;
+
+	/**
+	 * Returns the installed bundler version.
+	 * @return {string}
+	 */
+	getBundlerDependencyVersion(bundlerName?: string): string;
 }
 
 
diff --git a/lib/definitions/platform.d.ts b/lib/definitions/platform.d.ts
@@ -14,6 +14,16 @@ interface IBuildPlatformAction {
 	buildPlatform(platform: string, buildConfig: IBuildConfig, projectData: IProjectData): Promise<string>;
 }
 
+interface IWorkflowService {
+	handleLegacyWorkflow(projectDir: string, settings: IWebpackWorkflowSettings, force?: boolean): Promise<void>;
+}
+
+interface IWebpackWorkflowSettings {
+	bundle?: boolean | string;
+	useHotModuleReload?: boolean;
+	release?: boolean;
+}
+
 interface IPlatformService extends IBuildPlatformAction, NodeJS.EventEmitter {
 	cleanPlatforms(platforms: string[], platformTemplate: string, projectData: IProjectData, config: IPlatformOptions, framework?: string): Promise<void>;
 
diff --git a/lib/definitions/project.d.ts b/lib/definitions/project.d.ts
@@ -142,6 +142,14 @@ interface IProjectDataService {
 	 */
 	setNSValue(projectDir: string, key: string, value: any): void;
 
+	/**
+	 * Sets a value in the `useLegacyWorkflow` key in a project's nsconfig.json.
+	 * @param {string} projectDir The project directory - the place where the root package.json is located.
+	 * @param {any} value Value of the key to be set to `useLegacyWorkflow` key in project's nsconfig.json.
+	 * @returns {void}
+	 */
+	setUseLegacyWorkflow(projectDir: string, value: any): void;
+
 	/**
 	 * Removes a property from `nativescript` key in project's package.json.
 	 * @param {string} projectDir The project directory - the place where the root package.json is located.
@@ -584,7 +592,7 @@ interface IIOSExtensionsService {
 	removeExtensions(options: IRemoveExtensionsOptions): void;
 }
 
-interface IAddExtensionsFromPathOptions{
+interface IAddExtensionsFromPathOptions {
 	extensionsFolderPath: string;
 	projectData: IProjectData;
 	platformData: IPlatformData;
diff --git a/lib/helpers/bundle-validator-helper.ts b/lib/helpers/bundle-validator-helper.ts
@@ -16,20 +16,28 @@ export class BundleValidatorHelper extends VersionValidatorHelper implements IBu
 
 	public validate(minSupportedVersion?: string): void {
 		if (this.$options.bundle) {
-			const bundlePluginName = this.bundlersMap[this.$options.bundle];
-			const bundlerVersionInDependencies = this.$projectData.dependencies && this.$projectData.dependencies[bundlePluginName];
-			const bundlerVersionInDevDependencies = this.$projectData.devDependencies && this.$projectData.devDependencies[bundlePluginName];
-			if (!bundlePluginName || (!bundlerVersionInDependencies && !bundlerVersionInDevDependencies)) {
+			const currentVersion = this.getBundlerDependencyVersion();
+			if (!currentVersion) {
 				this.$errors.failWithoutHelp(BundleValidatorMessages.MissingBundlePlugin);
 			}
 
-			const currentVersion = bundlerVersionInDependencies || bundlerVersionInDevDependencies;
 			const shouldThrowError = minSupportedVersion && this.isValidVersion(currentVersion) && this.isVersionLowerThan(currentVersion, minSupportedVersion);
 			if (shouldThrowError) {
-					this.$errors.failWithoutHelp(util.format(BundleValidatorMessages.NotSupportedVersion, minSupportedVersion));
+				this.$errors.failWithoutHelp(util.format(BundleValidatorMessages.NotSupportedVersion, minSupportedVersion));
 			}
 		}
 	}
+
+	public getBundlerDependencyVersion(bundlerName?: string): string {
+		let dependencyVersion = null;
+		const bundlePluginName = bundlerName || this.bundlersMap[this.$options.bundle];
+		const bundlerVersionInDependencies = this.$projectData.dependencies && this.$projectData.dependencies[bundlePluginName];
+		const bundlerVersionInDevDependencies = this.$projectData.devDependencies && this.$projectData.devDependencies[bundlePluginName];
+		dependencyVersion = bundlerVersionInDependencies || bundlerVersionInDevDependencies;
+
+		return dependencyVersion;
+
+	}
 }
 
 $injector.register("bundleValidatorHelper", BundleValidatorHelper);
diff --git a/lib/options.ts b/lib/options.ts
@@ -136,6 +136,7 @@ export class Options {
 			file: { type: OptionType.String, hasSensitiveValue: true },
 			force: { type: OptionType.Boolean, alias: "f", hasSensitiveValue: false },
 			// remove legacy
+			workflow: { type: OptionType.Boolean, hasSensitiveValue: false },
 			companion: { type: OptionType.Boolean, hasSensitiveValue: false },
 			emulator: { type: OptionType.Boolean, hasSensitiveValue: false },
 			sdk: { type: OptionType.String, hasSensitiveValue: false },
diff --git a/lib/project-data.ts b/lib/project-data.ts
@@ -263,4 +263,4 @@ export class ProjectData implements IProjectData {
 		this.$logger.warnWithLabel("IProjectData.projectId is deprecated. Please use IProjectData.projectIdentifiers[platform].");
 	}
 }
-$injector.register("projectData", ProjectData);
+$injector.register("projectData", ProjectData, true);
diff --git a/lib/services/livesync/playground/preview-app-livesync-service.ts b/lib/services/livesync/playground/preview-app-livesync-service.ts
@@ -22,13 +22,15 @@ export class PreviewAppLiveSyncService extends EventEmitter implements IPreviewA
 		private $previewAppFilesService: IPreviewAppFilesService,
 		private $previewAppPluginsService: IPreviewAppPluginsService,
 		private $previewDevicesService: IPreviewDevicesService,
-		private $hmrStatusService: IHmrStatusService) {
-			super();
-		}
+		private $hmrStatusService: IHmrStatusService,
+		protected $workflowService: IWorkflowService) {
+		super();
+	}
 
 	@performanceLog()
 	public async initialize(data: IPreviewAppLiveSyncData): Promise<void> {
 		await this.$previewSdkService.initialize(data.projectDir, async (device: Device) => {
+			await this.$workflowService.handleLegacyWorkflow(data.projectDir, data);
 			try {
 				if (!device) {
 					this.$errors.failWithoutHelp("Sending initial preview files without a specified device is not supported.");
@@ -177,7 +179,7 @@ export class PreviewAppLiveSyncService extends EventEmitter implements IPreviewA
 						if (status === HmrConstants.HMR_ERROR_STATUS) {
 							const originalUseHotModuleReload = data.useHotModuleReload;
 							data.useHotModuleReload = false;
-							await this.syncFilesForPlatformSafe(data, { filesToSync: platformHmrData.fallbackFiles }, platform, previewDevice.id );
+							await this.syncFilesForPlatformSafe(data, { filesToSync: platformHmrData.fallbackFiles }, platform, previewDevice.id);
 							data.useHotModuleReload = originalUseHotModuleReload;
 						}
 					}));
diff --git a/lib/services/platform-service.ts b/lib/services/platform-service.ts
@@ -36,7 +36,8 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		private $terminalSpinnerService: ITerminalSpinnerService,
 		private $pacoteService: IPacoteService,
 		private $usbLiveSyncService: any,
-		public $hooksService: IHooksService
+		public $hooksService: IHooksService,
+		public $workflowService: IWorkflowService
 	) {
 		super();
 	}
@@ -221,6 +222,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 
 	@performanceLog()
 	public async preparePlatform(platformInfo: IPreparePlatformInfo): Promise<boolean> {
+		await this.$workflowService.handleLegacyWorkflow(platformInfo.projectData.projectDir, platformInfo.appFilesUpdaterOptions);
 		const changesInfo = await this.getChangesInfo(platformInfo);
 		const shouldPrepare = await this.shouldPrepare({ platformInfo, changesInfo });
 
diff --git a/lib/services/project-data-service.ts b/lib/services/project-data-service.ts
@@ -1,5 +1,7 @@
 import * as path from "path";
+import * as constants from "../constants";
 import { ProjectData } from "../project-data";
+import { parseJson } from "../common/helpers";
 import { exported } from "../common/decorators";
 import {
 	NATIVESCRIPT_PROPS_INTERNAL_DELIMITER,
@@ -17,14 +19,21 @@ interface IProjectFileData {
 }
 
 export class ProjectDataService implements IProjectDataService {
+	private defaultProjectDir = "";
 	private static DEPENDENCIES_KEY_NAME = "dependencies";
+	private projectDataCache: IDictionary<IProjectData> = {};
 
 	constructor(private $fs: IFileSystem,
 		private $staticConfig: IStaticConfig,
 		private $logger: ILogger,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $androidResourcesMigrationService: IAndroidResourcesMigrationService,
-		private $injector: IInjector) {
+		private $injector: IInjector,
+		$projectData: IProjectData) {
+		// add the ProjectData of the default projectDir to the projectData cache
+		$projectData.initializeProjectData();
+		this.defaultProjectDir = $projectData.projectDir;
+		this.projectDataCache[this.defaultProjectDir] = $projectData;
 	}
 
 	public getNSValue(projectDir: string, propertyName: string): any {
@@ -49,16 +58,19 @@ export class ProjectDataService implements IProjectDataService {
 	// TODO: Remove $projectData and replace it with $projectDataService.getProjectData
 	@exported("projectDataService")
 	public getProjectData(projectDir: string): IProjectData {
-		const projectDataInstance = this.$injector.resolve<IProjectData>(ProjectData);
-		projectDataInstance.initializeProjectData(projectDir);
-		return projectDataInstance;
+		projectDir = projectDir || this.defaultProjectDir;
+		this.projectDataCache[projectDir] = this.projectDataCache[projectDir] || this.$injector.resolve<IProjectData>(ProjectData);
+		this.projectDataCache[projectDir].initializeProjectData(projectDir);
+
+		return this.projectDataCache[projectDir];
 	}
 
 	@exported("projectDataService")
 	public getProjectDataFromContent(packageJsonContent: string, nsconfigContent: string, projectDir?: string): IProjectData {
-		const projectDataInstance = this.$injector.resolve<IProjectData>(ProjectData);
-		projectDataInstance.initializeProjectDataFromContent(packageJsonContent, nsconfigContent, projectDir);
-		return projectDataInstance;
+		projectDir = projectDir || this.defaultProjectDir;
+		this.projectDataCache[projectDir] = this.projectDataCache[projectDir] || this.$injector.resolve<IProjectData>(ProjectData);
+		this.projectDataCache[projectDir].initializeProjectDataFromContent(packageJsonContent, nsconfigContent, projectDir);
+		return this.projectDataCache[projectDir];
 	}
 
 	@exported("projectDataService")
@@ -124,6 +136,14 @@ export class ProjectDataService implements IProjectDataService {
 		};
 	}
 
+	public setUseLegacyWorkflow(projectDir: string, value: any): void {
+		// TODO: use trace
+		this.$logger.info(`useLegacyWorkflow will be set to ${value}`);
+		this.updateNsConfigValue(projectDir, { useLegacyWorkflow: value });
+		this.refreshProjectData(projectDir);
+		this.$logger.info(`useLegacyWorkflow was set to ${value}`);
+	}
+
 	public getAppExecutableFiles(projectDir: string): string[] {
 		const projectData = this.getProjectData(projectDir);
 
@@ -157,6 +177,34 @@ 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): void {
+		const nsConfigPath = path.join(projectDir, constants.CONFIG_NS_FILE_NAME);
+		const currentNsConfig = this.getNsConfig(nsConfigPath);
+		const newNsConfig = Object.assign(currentNsConfig, updateObject);
+
+		this.$fs.writeJson(nsConfigPath, newNsConfig);
+	}
+
+	private getNsConfig(nsConfigPath: string): INsConfig {
+		let result = this.getNsConfigDefaultObject();
+		if (this.$fs.exists(nsConfigPath)) {
+			const nsConfigContent = this.$fs.readText(nsConfigPath);
+			try {
+				result = <INsConfig>parseJson(nsConfigContent);
+			} catch (e) {
+				// default
+			}
+		}
+
+		return result;
+	}
+
 	private getImageDefinitions(): IImageDefinitionsStructure {
 		const pathToImageDefinitions = path.join(__dirname, "..", "..", CLI_RESOURCES_DIR_NAME, AssetConstants.assets, AssetConstants.imageDefinitionsFileName);
 		const imageDefinitions = this.$fs.readJson(pathToImageDefinitions);
@@ -308,10 +356,16 @@ export class ProjectDataService implements IProjectDataService {
 		};
 	}
 
+	private getNsConfigDefaultObject(data?: Object): INsConfig {
+		const config: INsConfig = { useLegacyWorkflow: false };
+		Object.assign(config, data);
+
+		return config;
+	}
+
 	@exported("projectDataService")
 	public getNsConfigDefaultContent(data?: Object): string {
-		const config: INsConfig = {};
-		Object.assign(config, data);
+		const config = this.getNsConfigDefaultObject(data);
 
 		return JSON.stringify(config);
 	}
diff --git a/lib/services/workflow-service.ts b/lib/services/workflow-service.ts
diff --git a/test/stubs.ts b/test/stubs.ts

Original file line number	Diff line number	Diff line change
`@@ -263,4 +263,4 @@ export class ProjectData implements IProjectData {`
`263`	`263`	`this.$logger.warnWithLabel("IProjectData.projectId is deprecated. Please use IProjectData.projectIdentifiers[platform].");`
`264`	`264`	`}`
`265`	`265`	`}`
`266`		`-$injector.register("projectData", ProjectData);`
	`266`	`+$injector.register("projectData", ProjectData, true);`