Merge pull request #4050 from mflor35/feat/pkg-mngr-impl

feat() - [Yarn Support - Part 1 and 2] Yarn and Package Manager implementation

Author: Fatme

lib/base-package-manager.ts

@@ -0,0 +1,46 @@
+import { isInteractive } from "./common/helpers";
+
+export class BasePackageManager {
+	constructor(
+		protected $childProcess: IChildProcess,
+		private $hostInfo: IHostInfo,
+		private packageManager: string
+	) { }
+
+	protected getPackageManagerExecutableName(): string {
+		let npmExecutableName = this.packageManager;
+
+		if (this.$hostInfo.isWindows) {
+			npmExecutableName += ".cmd";
+		}
+
+		return npmExecutableName;
+	}
+
+	protected async processPackageManagerInstall(params: string[], opts: { cwd: string }) {
+		const npmExecutable = this.getPackageManagerExecutableName();
+		const stdioValue = isInteractive() ? "inherit" : "pipe";
+		return await this.$childProcess.spawnFromEvent(npmExecutable, params, "close", { cwd: opts.cwd, stdio: stdioValue });
+	}
+
+	protected getFlagsString(config: any, asArray: boolean): any {
+		const array: Array<string> = [];
+		for (const flag in config) {
+			if (flag === "global" && this.packageManager !== 'yarn') {
+				array.push(`--${flag}`);
+				array.push(`${config[flag]}`);
+			} else if (config[flag]) {
+				if (flag === "dist-tags" || flag === "versions") {
+					array.push(` ${flag}`);
+					continue;
+				}
+				array.push(`--${flag}`);
+			}
+		}
+		if (asArray) {
+			return array;
+		}
+
+		return array.join(" ");
+	}
+}

lib/bootstrap.ts

@@ -79,8 +79,12 @@ $injector.require("itmsTransporterService", "./services/itmstransporter-service"
 $injector.requireCommand("setup|*", "./commands/setup");
 $injector.requireCommand(["setup|cloud", "cloud|setup"], "./commands/setup");
 
+$injector.requirePublic("packageManager", "./package-manager");
 $injector.requirePublic("npm", "./node-package-manager");
-$injector.require("npmInstallationManager", "./npm-installation-manager");
+$injector.requirePublic("yarn", "./yarn-package-manager");
+$injector.requireCommand("package-manager|set", "./commands/package-manager-set");
+
+$injector.require("packageInstallationManager", "./package-installation-manager");
 $injector.require("dynamicHelpProvider", "./dynamic-help-provider");
 $injector.require("mobilePlatformsCapabilities", "./mobile-platforms-capabilities");
 $injector.require("commandsServiceProvider", "./providers/commands-service-provider");

lib/commands/install.ts

@@ -13,7 +13,7 @@ export class InstallCommand implements ICommand {
 		private $logger: ILogger,
 		private $fs: IFileSystem,
 		private $stringParameter: ICommandParameter,
-		private $npm: INodePackageManager) {
+		private $packageManager: INodePackageManager) {
 		this.$projectData.initializeProjectData();
 	}
 
@@ -54,7 +54,7 @@ export class InstallCommand implements ICommand {
 			moduleName = devPrefix + moduleName;
 		}
 
-		await this.$npm.install(moduleName, projectDir, {
+		await this.$packageManager.install(moduleName, projectDir, {
 			'save-dev': true,
 			disableNpmInstall: this.$options.disableNpmInstall,
 			frameworkPath: this.$options.frameworkPath,

lib/commands/plugin/create-plugin.ts

@@ -13,7 +13,7 @@ export class CreatePluginCommand implements ICommand {
 		private $fs: IFileSystem,
 		private $childProcess: IChildProcess,
 		private $prompter: IPrompter,
-		private $npm: INodePackageManager) { }
+		private $packageManager: INodePackageManager) { }
 
 	public async execute(args: string[]): Promise<void> {
 		const pluginRepoName = args[0];
@@ -45,7 +45,7 @@ export class CreatePluginCommand implements ICommand {
 		try {
 			spinner.start();
 			const npmOptions: any = { silent: true };
-			await this.$npm.install(cwd, cwd, npmOptions);
+			await this.$packageManager.install(cwd, cwd, npmOptions);
 		} finally {
 			spinner.stop();
 		}

lib/commands/test-init.ts

@@ -12,7 +12,7 @@ class TestInitCommand implements ICommand {
 		mocha: ['chai']
 	};
 
-	constructor(private $npm: INodePackageManager,
+	constructor(private $packageManager: INodePackageManager,
 		private $projectData: IProjectData,
 		private $errors: IErrors,
 		private $options: IOptions,
@@ -55,7 +55,7 @@ class TestInitCommand implements ICommand {
 			if (mod.version) {
 				moduleToInstall += `@${mod.version}`;
 			}
-			await this.$npm.install(moduleToInstall, projectDir, {
+			await this.$packageManager.install(moduleToInstall, projectDir, {
 				'save-dev': true,
 				'save-exact': true,
 				optional: false,
@@ -76,7 +76,7 @@ class TestInitCommand implements ICommand {
 				// catch errors when a peerDependency is already installed
 				// e.g karma is installed; karma-jasmine depends on karma and will try to install it again
 				try {
-					await this.$npm.install(`${peerDependency}@${dependencyVersion}`, projectDir, {
+					await this.$packageManager.install(`${peerDependency}@${dependencyVersion}`, projectDir, {
 						'save-dev': true,
 						'save-exact': true,
 						disableNpmInstall: false,

lib/common/commands/package-manager-set.ts

@@ -0,0 +1,20 @@
+
+export class PackageManagerCommand implements ICommand {
+
+	constructor(private $userSettingsService: IUserSettingsService,
+		private $errors: IErrors,
+		private $stringParameter: ICommandParameter) { }
+
+	public allowedParameters: ICommandParameter[] = [this.$stringParameter];
+
+	public execute(args: string[]): Promise<void> {
+		if (args[0] === 'yarn' ) {
+			return this.$userSettingsService.saveSetting("packageManager", "yarn");
+		} else if ( args[0] === 'npm') {
+			return this.$userSettingsService.saveSetting("packageManager", "npm");
+		}
+		return this.$errors.fail(`${args[0]} is not a valid package manager. Only yarn or npm are supported.`);
+	}
+}
+
+$injector.registerCommand("package-manager|set", PackageManagerCommand);

lib/declarations.d.ts

@@ -54,7 +54,7 @@ interface INodePackageManager {
 	getCachePath(): Promise<string>;
 }
 
-interface INpmInstallationManager {
+interface IPackageInstallationManager {
 	install(packageName: string, packageDir: string, options?: INpmInstallOptions): Promise<any>;
 	getLatestVersion(packageName: string): Promise<string>;
 	getNextVersion(packageName: string): Promise<string>;
@@ -506,6 +506,7 @@ interface IOptions extends IRelease, IDeviceIdentifier, IJustLaunch, IAvd, IAvai
 	framework: string;
 	frameworkName: string;
 	frameworkVersion: string;
+	yarn: string,
 	ipa: string;
 	tsc: boolean;
 	ts: boolean;

lib/node-package-manager.ts

@@ -1,18 +1,21 @@
 import * as path from "path";
+import { BasePackageManager } from "./base-package-manager";
 import { exported, cache } from "./common/decorators";
-import { isInteractive } from "./common/helpers";
 import { CACACHE_DIRECTORY_NAME } from "./constants";
 
-export class NodePackageManager implements INodePackageManager {
+export class NodePackageManager extends BasePackageManager implements INodePackageManager {
 	private static SCOPED_DEPENDENCY_REGEXP = /^(@.+?)(?:@(.+?))?$/;
 	private static DEPENDENCY_REGEXP = /^(.+?)(?:@(.+?))?$/;
 
-	constructor(private $fs: IFileSystem,
-		private $hostInfo: IHostInfo,
+	constructor(
+		$childProcess: IChildProcess,
 		private $errors: IErrors,
-		private $childProcess: IChildProcess,
+		private $fs: IFileSystem,
+		$hostInfo: IHostInfo,
 		private $logger: ILogger,
-		private $httpClient: Server.IHttpClient) { }
+		private $httpClient: Server.IHttpClient) {
+		super($childProcess, $hostInfo, 'npm');
+	}
 
 	@exported("npm")
 	public async install(packageName: string, pathToSave: string, config: INodePackageManagerInstallOptions): Promise<INpmInstallResultInfo> {
@@ -53,7 +56,7 @@ export class NodePackageManager implements INodePackageManager {
 		}
 
 		try {
-			const spawnResult: ISpawnResult = await this.getNpmInstallResult(params, cwd);
+			const spawnResult: ISpawnResult = await this.processPackageManagerInstall(params, { cwd });
 
 			// Whenever calling npm install without any arguments (hence installing all dependencies) no output is emitted on stdout
 			// Luckily, whenever you call npm install to install all dependencies chances are you won't need the name/version of the package you're installing because there is none.
@@ -66,7 +69,7 @@ export class NodePackageManager implements INodePackageManager {
 			// We cannot use the actual install with --json to get the information because of post-install scripts which may print on stdout
 			// dry-run install is quite fast when the dependencies are already installed even for many dependencies (e.g. angular) so we can live with this approach
 			// We need the --prefix here because without it no output is emitted on stdout because all the dependencies are already installed.
-			const spawnNpmDryRunResult = await this.$childProcess.spawnFromEvent(this.getNpmExecutableName(), params, "close");
+			const spawnNpmDryRunResult = await this.$childProcess.spawnFromEvent(this.getPackageManagerExecutableName(), params, "close");
 			return this.parseNpmInstallResult(spawnNpmDryRunResult.stdout, spawnResult.stdout, packageName);
 		} catch (err) {
 			if (err.message && err.message.indexOf("EPEERINVALID") !== -1) {
@@ -136,43 +139,12 @@ export class NodePackageManager implements INodePackageManager {
 		return path.join(cachePath.trim(), CACACHE_DIRECTORY_NAME);
 	}
 
-	private getNpmExecutableName(): string {
-		let npmExecutableName = "npm";
-
-		if (this.$hostInfo.isWindows) {
-			npmExecutableName += ".cmd";
-		}
-
-		return npmExecutableName;
-	}
-
-	private getFlagsString(config: any, asArray: boolean): any {
-		const array: Array<string> = [];
-		for (const flag in config) {
-			if (flag === "global") {
-				array.push(`--${flag}`);
-				array.push(`${config[flag]}`);
-			} else if (config[flag]) {
-				if (flag === "dist-tags" || flag === "versions") {
-					array.push(` ${flag}`);
-					continue;
-				}
-				array.push(`--${flag}`);
-			}
-		}
-		if (asArray) {
-			return array;
-		}
-
-		return array.join(" ");
-	}
-
 	private parseNpmInstallResult(npmDryRunInstallOutput: string, npmInstallOutput: string, userSpecifiedPackageName: string): INpmInstallResultInfo {
 		// TODO: Add tests for this functionality
 		try {
 			const originalOutput: INpmInstallCLIResult | INpm5InstallCliResult = JSON.parse(npmDryRunInstallOutput);
-			const npm5Output = <INpm5InstallCliResult> originalOutput;
-			const npmOutput = <INpmInstallCLIResult> originalOutput;
+			const npm5Output = <INpm5InstallCliResult>originalOutput;
+			const npmOutput = <INpmInstallCLIResult>originalOutput;
 			let name: string;
 			_.forOwn(npmOutput.dependencies, (peerDependency: INpmPeerDependencyInfo, key: string) => {
 				if (!peerDependency.required && !peerDependency.peerMissing) {
@@ -239,64 +211,6 @@ export class NodePackageManager implements INodePackageManager {
 			version
 		};
 	}
-
-	private async getNpmInstallResult(params: string[], cwd: string): Promise<ISpawnResult> {
-		return new Promise<ISpawnResult>((resolve, reject) => {
-			const npmExecutable = this.getNpmExecutableName();
-			const stdioValue = isInteractive() ? "inherit" : "pipe";
-
-			const childProcess = this.$childProcess.spawn(npmExecutable, params, { cwd, stdio: stdioValue });
-
-			let isFulfilled = false;
-			let capturedOut = "";
-			let capturedErr = "";
-
-			if (childProcess.stdout) {
-				childProcess.stdout.on("data", (data: string) => {
-					this.$logger.write(data.toString());
-					capturedOut += data;
-				});
-			}
-
-			if (childProcess.stderr) {
-				childProcess.stderr.on("data", (data: string) => {
-					capturedErr += data;
-				});
-			}
-
-			childProcess.on("close", (arg: any) => {
-				const exitCode = typeof arg === "number" ? arg : arg && arg.code;
-
-				if (exitCode === 0) {
-					isFulfilled = true;
-					const result = {
-						stdout: capturedOut,
-						stderr: capturedErr,
-						exitCode
-					};
-
-					resolve(result);
-				} else {
-					let errorMessage = `Command ${npmExecutable} ${params && params.join(" ")} failed with exit code ${exitCode}`;
-					if (capturedErr) {
-						errorMessage += ` Error output: \n ${capturedErr}`;
-					}
-
-					if (!isFulfilled) {
-						isFulfilled = true;
-						reject(new Error(errorMessage));
-					}
-				}
-			});
-
-			childProcess.on("error", (err: Error) => {
-				if (!isFulfilled) {
-					isFulfilled = true;
-					reject(err);
-				}
-			});
-		});
-	}
 }
 
 $injector.register("npm", NodePackageManager);

lib/options.ts

@@ -71,6 +71,7 @@ export class Options {
 			tsc: { type: OptionType.Boolean },
 			ts: { type: OptionType.Boolean },
 			typescript: { type: OptionType.Boolean },
+			yarn: { type: OptionType.Boolean },
 			androidTypings: { type: OptionType.Boolean },
 			bundle: { type: OptionType.String },
 			all: { type: OptionType.Boolean },

lib/npm-installation-manager.ts renamed to lib/package-installation-manager.ts

@@ -2,8 +2,9 @@ import * as path from "path";
 import * as semver from "semver";
 import * as constants from "./constants";
 
-export class NpmInstallationManager implements INpmInstallationManager {
-	constructor(private $npm: INodePackageManager,
+export class PackageInstallationManager implements IPackageInstallationManager {
+	constructor(
+		private $packageManager: INodePackageManager,
 		private $childProcess: IChildProcess,
 		private $logger: ILogger,
 		private $settingsService: ISettingsService,
@@ -32,7 +33,7 @@ export class NpmInstallationManager implements INpmInstallationManager {
 			return latestVersion;
 		}
 
-		const data = await this.$npm.view(packageName, { "versions": true });
+		const data = await this.$packageManager.view(packageName, { "versions": true });
 
 		const maxSatisfying = semver.maxSatisfying(data, compatibleVersionRange);
 		return maxSatisfying || latestVersion;
@@ -144,18 +145,18 @@ export class NpmInstallationManager implements INpmInstallationManager {
 			npmOptions[dependencyType] = true;
 		}
 
-		return await this.$npm.install(packageName, pathToSave, npmOptions);
+		return await this.$packageManager.install(packageName, pathToSave, npmOptions);
 	}
 
 	/**
 	 * This function must not be used with packageName being a URL or local file,
 	 * because npm view doens't work with those
 	 */
 	private async getVersion(packageName: string, version: string): Promise<string> {
-		const data: any = await this.$npm.view(packageName, { "dist-tags": true });
+		const data: any = await this.$packageManager.view(packageName, { "dist-tags": true });
 		this.$logger.trace("Using version %s. ", data[version]);
 
 		return data[version];
 	}
 }
-$injector.register("npmInstallationManager", NpmInstallationManager);
+$injector.register("packageInstallationManager", PackageInstallationManager);