refactoring in order to start moving functionality from emulate to run command (#2614)

Plamen5kov · web-flow · commit 2221976f0668 · 2017-03-20T14:01:52.000+02:00
* rename method

* renamed method

* removed obsolete code

* removed unnecessary code and fixed stubs after renaming

* moved --availableDevices option to run command

* fixed up wrong inheritance

* moved platform specific code to appropriate place

* minor updates after review
diff --git a/lib/commands/appstore-upload.ts b/lib/commands/appstore-upload.ts
@@ -59,7 +59,7 @@ export class PublishIOS implements ICommand {
 			// No .ipa path provided, build .ipa on out own.
 			const appFilesUpdaterOptions: IAppFilesUpdaterOptions = { bundle: this.$options.bundle, release: this.$options.release };
 			if (mobileProvisionIdentifier || codeSignIdentity) {
-				let iOSBuildConfig: IiOSBuildConfig = {
+				let iOSBuildConfig: IBuildConfig = {
 					projectDir: this.$options.path,
 					release: this.$options.release,
 					device: this.$options.device,
diff --git a/lib/commands/build.ts b/lib/commands/build.ts
@@ -11,7 +11,7 @@ export class BuildCommandBase {
 		const appFilesUpdaterOptions: IAppFilesUpdaterOptions = { bundle: this.$options.bundle, release: this.$options.release };
 		await this.$platformService.preparePlatform(platform, appFilesUpdaterOptions, this.$options.platformTemplate, this.$projectData, { provision: this.$options.provision, sdk: this.$options.sdk });
 		this.$options.clean = true;
-		const buildConfig: IiOSBuildConfig = {
+		const buildConfig: IBuildConfig = {
 			buildForDevice: this.$options.forDevice,
 			projectDir: this.$options.path,
 			clean: this.$options.clean,
diff --git a/lib/commands/run.ts b/lib/commands/run.ts
@@ -2,11 +2,18 @@ export class RunCommandBase {
 	constructor(protected $platformService: IPlatformService,
 		protected $usbLiveSyncService: ILiveSyncService,
 		protected $projectData: IProjectData,
-		protected $options: IOptions) {
+		protected $options: IOptions,
+		protected $emulatorPlatformService: IEmulatorPlatformService,
+		private $mobileHelper: Mobile.IMobileHelper) {
 			this.$projectData.initializeProjectData();
 		}
 
 	public async executeCore(args: string[]): Promise<void> {
+
+		if (this.$options.availableDevices) {
+			return this.$emulatorPlatformService.listAvailableEmulators(this.$mobileHelper.validatePlatformName(args[0]));
+		}
+
 		const appFilesUpdaterOptions: IAppFilesUpdaterOptions = { bundle: this.$options.bundle, release: this.$options.release };
 		const deployOptions: IDeployPlatformOptions = {
 			clean: this.$options.clean,
@@ -22,6 +29,7 @@ export class RunCommandBase {
 			keyStorePassword: this.$options.keyStorePassword,
 			keyStorePath: this.$options.keyStorePath
 		};
+
 		await this.$platformService.deployPlatform(args[0], appFilesUpdaterOptions, deployOptions, this.$projectData, { provision: this.$options.provision, sdk: this.$options.sdk });
 
 		if (this.$options.bundle) {
@@ -35,7 +43,7 @@ export class RunCommandBase {
 				justlaunch: this.$options.justlaunch,
 			};
 
-			return this.$platformService.runPlatform(args[0], deployOpts, this.$projectData);
+			return this.$platformService.startApplication(args[0], deployOpts, this.$projectData);
 		}
 
 		return this.$usbLiveSyncService.liveSync(args[0], this.$projectData);
@@ -49,8 +57,10 @@ export class RunIosCommand extends RunCommandBase implements ICommand {
 		private $platformsData: IPlatformsData,
 		$usbLiveSyncService: ILiveSyncService,
 		$projectData: IProjectData,
-		$options: IOptions) {
-		super($platformService, $usbLiveSyncService, $projectData, $options);
+		$options: IOptions,
+		$emulatorPlatformService: IEmulatorPlatformService,
+		$mobileHelper: Mobile.IMobileHelper) {
+		super($platformService, $usbLiveSyncService, $projectData, $options, $emulatorPlatformService, $mobileHelper);
 	}
 
 	public async execute(args: string[]): Promise<void> {
@@ -72,8 +82,10 @@ export class RunAndroidCommand extends RunCommandBase implements ICommand {
 		$usbLiveSyncService: ILiveSyncService,
 		$projectData: IProjectData,
 		$options: IOptions,
+		$emulatorPlatformService: IEmulatorPlatformService,
+		$mobileHelper: Mobile.IMobileHelper,
 		private $errors: IErrors) {
-		super($platformService, $usbLiveSyncService, $projectData, $options);
+		super($platformService, $usbLiveSyncService, $projectData, $options, $emulatorPlatformService, $mobileHelper);
 	}
 
 	public async execute(args: string[]): Promise<void> {
diff --git a/lib/definitions/platform.d.ts b/lib/definitions/platform.d.ts
@@ -118,7 +118,7 @@ interface IPlatformService extends NodeJS.EventEmitter {
 	 * @param {IProjectData} projectData DTO with information about the project.
 	 * @returns {void}
 	 */
-	runPlatform(platform: string, runOptions: IRunPlatformOptions, projectData: IProjectData): Promise<void>;
+	startApplication(platform: string, runOptions: IRunPlatformOptions, projectData: IProjectData): Promise<void>;
 
 	/**
 	 * The emulate command. In addition to `run --emulator` command, it handles the `--available-devices` option to show the available devices.
diff --git a/lib/definitions/plugins.d.ts b/lib/definitions/plugins.d.ts
@@ -12,6 +12,7 @@ interface IPluginsService {
 	 * @returns {IPackageJsonDepedenciesResult}
 	 */
 	getDependenciesFromPackageJson(projectDir: string): IPackageJsonDepedenciesResult;
+	validate(platformData: IPlatformData, projectData: IProjectData): Promise<void>;
 }
 
 interface IPackageJsonDepedenciesResult {
diff --git a/lib/definitions/project.d.ts b/lib/definitions/project.d.ts
@@ -130,7 +130,7 @@ interface IBuildForDevice {
 	buildForDevice: boolean;
 }
 
-interface IBuildConfig extends IAndroidBuildOptionsSettings, IBuildForDevice {
+interface IBuildConfig extends IAndroidBuildOptionsSettings, IiOSBuildConfig {
 	projectDir: string;
 	clean?: boolean;
 	architectures?: string[];
@@ -140,7 +140,7 @@ interface IBuildConfig extends IAndroidBuildOptionsSettings, IBuildForDevice {
 /**
  * Describes iOS-specific build configuration properties
  */
-interface IiOSBuildConfig extends IBuildConfig, IRelease, IDeviceIdentifier, IProvision, ITeamIdentifier {
+interface IiOSBuildConfig extends IBuildForDevice, IDeviceIdentifier, IProvision, ITeamIdentifier, IRelease {
 	/**
 	 * Identifier of the mobile provision which will be used for the build. If not set a provision will be selected automatically if possible.
 	 */
@@ -178,6 +178,8 @@ interface IPlatformProjectService extends NodeJS.EventEmitter {
 	 */
 	validateOptions(projectId?: string, provision?: any): Promise<boolean>;
 
+	validatePlugins(projectData: IProjectData): Promise<void>;
+
 	buildProject(projectRoot: string, projectData: IProjectData, buildConfig: IBuildConfig): Promise<void>;
 
 	/**
@@ -231,7 +233,7 @@ interface IPlatformProjectService extends NodeJS.EventEmitter {
 	 */
 	getAppResourcesDestinationDirectoryPath(projectData: IProjectData): string;
 
-	deploy(deviceIdentifier: string, projectData: IProjectData): Promise<void>;
+	cleanDeviceTempFolder(deviceIdentifier: string, projectData: IProjectData): Promise<void>;
 	processConfigurationFilesFromAppResources(release: boolean, projectData: IProjectData): Promise<void>;
 
 	/**
diff --git a/lib/providers/livesync-provider.ts b/lib/providers/livesync-provider.ts
@@ -33,7 +33,7 @@ export class LiveSyncProvider implements ILiveSyncProvider {
 	}
 
 	public async buildForDevice(device: Mobile.IDevice, projectData: IProjectData): Promise<string> {
-		let buildConfig: IiOSBuildConfig = {
+		let buildConfig: IBuildConfig = {
 			buildForDevice: !device.isEmulator,
 			projectDir: this.$options.path,
 			release: this.$options.release,
diff --git a/lib/services/android-project-service.ts b/lib/services/android-project-service.ts
@@ -97,6 +97,10 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		await this.$androidToolsInfo.validateJavacVersion(javaCompilerVersion, { showWarningsAsErrors: true });
 	}
 
+	public async validatePlugins(): Promise<void> {
+		Promise.resolve();
+	}
+
 	public async createProject(frameworkDir: string, frameworkVersion: string, projectData: IProjectData, pathToTemplate?: string): Promise<void> {
 		if (semver.lt(frameworkVersion, AndroidProjectService.MIN_RUNTIME_VERSION_WITH_GRADLE)) {
 			this.$errors.failWithoutHelp(`The NativeScript CLI requires Android runtime ${AndroidProjectService.MIN_RUNTIME_VERSION_WITH_GRADLE} or later to work properly.`);
@@ -432,7 +436,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		await this.spawn(gradleBin, options, { stdio: "inherit", cwd: this.getPlatformData(projectData).projectRoot });
 	}
 
-	public async deploy(deviceIdentifier: string, projectData: IProjectData): Promise<void> {
+	public async cleanDeviceTempFolder(deviceIdentifier: string, projectData: IProjectData): Promise<void> {
 		let adb = this.$injector.resolve(DeviceAndroidDebugBridge, { identifier: deviceIdentifier });
 		let deviceRootPath = `/data/local/tmp/${projectData.projectId}`;
 		await adb.executeShellCommand(["rm", "-rf", deviceRootPath]);
diff --git a/lib/services/ios-debug-service.ts b/lib/services/ios-debug-service.ts
@@ -148,7 +148,7 @@ class IOSDebugService implements IDebugService {
 				justlaunch: this.$options.justlaunch
 			};
 			// we intentionally do not wait on this here, because if we did, we'd miss the AppLaunching notification
-			let action = this.$platformService.runPlatform(this.platform, runOptions, projectData);
+			let action = this.$platformService.startApplication(this.platform, runOptions, projectData);
 
 			await this.debugBrkCore(device, projectData, shouldBreak);
 
diff --git a/lib/services/ios-project-service.ts b/lib/services/ios-project-service.ts
@@ -40,7 +40,8 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		private $mobileHelper: Mobile.IMobileHelper,
 		private $pluginVariablesService: IPluginVariablesService,
 		private $xcprojService: IXcprojService,
-		private $iOSProvisionService: IOSProvisionService) {
+		private $iOSProvisionService: IOSProvisionService,
+		private $sysInfo: ISysInfo) {
 		super($fs, $projectDataService);
 	}
 
@@ -238,7 +239,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		}
 	}
 
-	public async buildProject(projectRoot: string, projectData: IProjectData, buildConfig: IiOSBuildConfig): Promise<void> {
+	public async buildProject(projectRoot: string, projectData: IProjectData, buildConfig: IBuildConfig): Promise<void> {
 		let basicArgs = [
 			"-configuration", buildConfig.release ? "Release" : "Debug",
 			"build",
@@ -270,7 +271,19 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 
 	}
 
-	private async buildForDevice(projectRoot: string, args: string[], buildConfig: IiOSBuildConfig, projectData: IProjectData): Promise<void> {
+	public async validatePlugins(projectData: IProjectData): Promise<void> {
+		let installedPlugins = await (<IPluginsService>this.$injector.resolve("pluginsService")).getAllInstalledPlugins(projectData);
+		for (let pluginData of installedPlugins) {
+			let pluginsFolderExists = this.$fs.exists(path.join(pluginData.pluginPlatformsFolderPath(this.$devicePlatformsConstants.iOS.toLowerCase()), "Podfile"));
+			let cocoaPodVersion = await this.$sysInfo.getCocoapodVersion();
+			if (pluginsFolderExists && !cocoaPodVersion) {
+				this.$errors.failWithoutHelp(`${pluginData.name} has Podfile and you don't have Cocoapods installed or it is not configured correctly. Please verify Cocoapods can work on your machine.`);
+			}
+		}
+		Promise.resolve();
+	}
+
+	private async buildForDevice(projectRoot: string, args: string[], buildConfig: IBuildConfig, projectData: IProjectData): Promise<void> {
 		let defaultArchitectures = [
 			'ARCHS=armv7 arm64',
 			'VALID_ARCHS=armv7 arm64'
@@ -438,7 +451,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		return this.$fs.exists(path.join(projectRoot, projectData.projectName, constants.APP_FOLDER_NAME));
 	}
 
-	public deploy(deviceIdentifier: string): Promise<void> {
+	public cleanDeviceTempFolder(deviceIdentifier: string): Promise<void> {
 		return Promise.resolve();
 	}
 
diff --git a/lib/services/livesync/livesync-service.ts b/lib/services/livesync/livesync-service.ts
@@ -1,44 +1,24 @@
 import * as constants from "../../constants";
 import * as helpers from "../../common/helpers";
 import * as path from "path";
-import * as semver from "semver";
 import { NodeModulesDependenciesBuilder } from "../../tools/node-modules/node-modules-dependencies-builder";
 
 let choki = require("chokidar");
 
 class LiveSyncService implements ILiveSyncService {
 	private _isInitialized = false;
 
-	constructor(private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
-		private $errors: IErrors,
+	constructor(private $errors: IErrors,
 		private $platformsData: IPlatformsData,
 		private $platformService: IPlatformService,
-		private $projectDataService: IProjectDataService,
-		private $prompter: IPrompter,
 		private $injector: IInjector,
-		private $mobileHelper: Mobile.IMobileHelper,
 		private $devicesService: Mobile.IDevicesService,
 		private $options: IOptions,
 		private $logger: ILogger,
 		private $dispatcher: IFutureDispatcher,
 		private $hooksService: IHooksService,
 		private $processService: IProcessService) { }
 
-	private async ensureAndroidFrameworkVersion(platformData: IPlatformData, projectData: IProjectData): Promise<void> { // TODO: this can be moved inside command or canExecute function
-		const frameworkVersion = this.$projectDataService.getNSValue(projectData.projectDir, platformData.frameworkPackageName).version;
-
-		if (platformData.normalizedPlatformName.toLowerCase() === this.$devicePlatformsConstants.Android.toLowerCase()) {
-			if (semver.lt(frameworkVersion, "1.2.1")) {
-				let shouldUpdate = await this.$prompter.confirm("You need Android Runtime 1.2.1 or later for LiveSync to work properly. Do you want to update your runtime now?");
-				if (shouldUpdate) {
-					await this.$platformService.updatePlatforms([this.$devicePlatformsConstants.Android.toLowerCase()], this.$options.platformTemplate, projectData, null);
-				} else {
-					return;
-				}
-			}
-		}
-	}
-
 	public get isInitialized(): boolean { // This function is used from https://github.com/NativeScript/nativescript-dev-typescript/blob/master/lib/before-prepare.js#L4
 		return this._isInitialized;
 	}
@@ -83,10 +63,6 @@ class LiveSyncService implements ILiveSyncService {
 		platform = platform || this.$devicesService.platform;
 		let platformData = this.$platformsData.getPlatformData(platform.toLowerCase(), projectData);
 
-		if (this.$mobileHelper.isAndroidPlatform(platform)) {
-			await this.ensureAndroidFrameworkVersion(platformData, projectData);
-		}
-
 		let liveSyncData: ILiveSyncData = {
 			platform: platform,
 			appIdentifier: projectData.projectId,
diff --git a/lib/services/livesync/platform-livesync-service.ts b/lib/services/livesync/platform-livesync-service.ts
@@ -165,7 +165,7 @@ export abstract class PlatformLiveSyncServiceBase implements IPlatformLiveSyncSe
 			let isFullSync = false;
 
 			if (this.$options.clean || this.$projectChangesService.currentChanges.changesRequireBuild) {
-				let buildConfig: IiOSBuildConfig = {
+				let buildConfig: IBuildConfig = {
 					buildForDevice: !device.isEmulator,
 					projectDir: this.$options.path,
 					release: this.$options.release,
diff --git a/lib/services/platform-service.ts b/lib/services/platform-service.ts
@@ -35,7 +35,6 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		private $hostInfo: IHostInfo,
 		private $xmlValidator: IXmlValidator,
 		private $npm: INodePackageManager,
-		private $sysInfo: ISysInfo,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $deviceAppDataFactory: Mobile.IDeviceAppDataFactory,
 		private $projectChangesService: IProjectChangesService,
@@ -230,15 +229,8 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 			this.$errors.failWithoutHelp(`Unable to install dependencies. Make sure your package.json is valid and all dependencies are correct. Error is: ${err.message}`);
 		}
 
-		// Need to check if any plugin requires Cocoapods to be installed.
-		if (platform === "ios") {
-			for (let pluginData of await this.$pluginsService.getAllInstalledPlugins(projectData)) {
-				if (this.$fs.exists(path.join(pluginData.pluginPlatformsFolderPath(platform), "Podfile")) &&
-					!(await this.$sysInfo.getCocoapodVersion())) {
-					this.$errors.failWithoutHelp(`${pluginData.name} has Podfile and you don't have Cocoapods installed or it is not configured correctly. Please verify Cocoapods can work on your machine.`);
-				}
-			}
-		}
+		let platformData = this.$platformsData.getPlatformData(platform, projectData);
+		await this.$pluginsService.validate(platformData, projectData);
 
 		await this.ensurePlatformInstalled(platform, platformTemplate, projectData, platformSpecificData);
 		let changesInfo = this.$projectChangesService.checkForChanges(platform, projectData);
@@ -251,7 +243,6 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 				let previousPrepareInfo = this.$projectChangesService.getPrepareInfo(platform, projectData);
 				// clean up prepared plugins when not building for release
 				if (previousPrepareInfo && previousPrepareInfo.release !== appFilesUpdaterOptions.release) {
-					let platformData = this.$platformsData.getPlatformData(platform, projectData);
 					await platformData.platformProjectService.cleanProject(platformData.projectRoot, [], projectData);
 				}
 			}
@@ -443,7 +434,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 			packageFile = this.getLatestApplicationPackageForDevice(platformData).packageName;
 		}
 
-		await platformData.platformProjectService.deploy(device.deviceInfo.identifier, projectData);
+		await platformData.platformProjectService.cleanDeviceTempFolder(device.deviceInfo.identifier, projectData);
 
 		await device.applicationManager.reinstallApplication(projectData.projectId, packageFile);
 
@@ -463,7 +454,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		this.$logger.out("Searching for devices...");
 		await this.$devicesService.initialize({ platform: platform, deviceId: deployOptions.device });
 		let action = async (device: Mobile.IDevice): Promise<void> => {
-			let buildConfig: IiOSBuildConfig = {
+			let buildConfig: IBuildConfig = {
 				buildForDevice: !this.$devicesService.isiOSSimulator(device),
 				projectDir: deployOptions.projectDir,
 				release: deployOptions.release,
@@ -492,7 +483,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		await this.$devicesService.execute(action, this.getCanExecuteAction(platform, deployOptions));
 	}
 
-	public async runPlatform(platform: string, runOptions: IRunPlatformOptions, projectData: IProjectData): Promise<void> {
+	public async startApplication(platform: string, runOptions: IRunPlatformOptions, projectData: IProjectData): Promise<void> {
 		await this.trackProjectType(projectData);
 
 		this.$logger.out("Starting...");
@@ -538,7 +529,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		}
 
 		await this.deployPlatform(platform, appFilesUpdaterOptions, emulateOptions, projectData, platformSpecificData);
-		return this.runPlatform(platform, emulateOptions, projectData);
+		return this.startApplication(platform, emulateOptions, projectData);
 	}
 
 	private getBuildOutputPath(platform: string, platformData: IPlatformData, options: IBuildForDevice): string {
diff --git a/lib/services/plugins-service.ts b/lib/services/plugins-service.ts
@@ -98,6 +98,10 @@ export class PluginsService implements IPluginsService {
 		return this.$npm.search(filter, { "silent": silent });
 	}
 
+	public async validate(platformData: IPlatformData, projectData: IProjectData): Promise<void> {
+		return await platformData.platformProjectService.validatePlugins(projectData);
+	}
+
 	public async prepare(dependencyData: IDependencyData, platform: string, projectData: IProjectData): Promise<void> {
 		platform = platform.toLowerCase();
 		let platformData = this.$platformsData.getPlatformData(platform, projectData);
diff --git a/test/ios-project-service.ts b/test/ios-project-service.ts
@@ -84,6 +84,7 @@ function createTestInjector(projectPath: string, projectName: string): IInjector
 	testInjector.register("pluginVariablesHelper", PluginVariablesHelper);
 	testInjector.register("androidProcessService", {});
 	testInjector.register("processService", {});
+	testInjector.register("sysInfo", {});
 	return testInjector;
 }
 
diff --git a/test/npm-support.ts b/test/npm-support.ts
@@ -159,6 +159,7 @@ async function setupProject(dependencies?: any): Promise<any> {
 				ensureConfigurationFileInAppResources: (): any => null,
 				interpolateConfigurationFile: (): void => undefined,
 				isPlatformPrepared: (projectRoot: string) => false
+				validatePlugins: (projectData: IProjectData) => Promise.resolve()
 			}
 		};
 	};
diff --git a/test/platform-service.ts b/test/platform-service.ts
@@ -57,6 +57,9 @@ function createTestInjector() {
 		},
 		ensureAllDependenciesAreInstalled: () => {
 			return Promise.resolve();
+		},
+		validate: (platformData: IPlatformData, projectData: IProjectData) => {
+			return Promise.resolve();
 		}
 	});
 	testInjector.register("projectFilesManager", ProjectFilesManagerLib.ProjectFilesManager);
diff --git a/test/stubs.ts b/test/stubs.ts

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ interface IPluginsService {`
`12`	`12`	`* @returns {IPackageJsonDepedenciesResult}`
`13`	`13`	`*/`
`14`	`14`	`getDependenciesFromPackageJson(projectDir: string): IPackageJsonDepedenciesResult;`
	`15`	`+ validate(platformData: IPlatformData, projectData: IProjectData): Promise<void>;`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`interface IPackageJsonDepedenciesResult {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ export class LiveSyncProvider implements ILiveSyncProvider {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public async buildForDevice(device: Mobile.IDevice, projectData: IProjectData): Promise<string> {`
`36`		`- let buildConfig: IiOSBuildConfig = {`
	`36`	`+ let buildConfig: IBuildConfig = {`
`37`	`37`	`buildForDevice: !device.isEmulator,`
`38`	`38`	`projectDir: this.$options.path,`
`39`	`39`	`release: this.$options.release,`