feat(extensibility): Add hint how to get access to a command from extension

In case user executes any command that is registered in extension, but this extension is not installed, they'll receive error:
`Unknown command ...`. Instead of showing this, it is better to tell them how to get access to this command.
In order to achieve this, implement a new logic in `extensibilityService` to find commands registered in all extensions. CLI searches npm (via npms API) for packages that have the keyword `nativescript:extension`.
After that, CLI gets the package.json of the latest version of each dependency (via registry.npmjs.org) and searches for nativescript key in it. In case it has nativescript key, CLI reads the commands value inside it. The value should be string array containg all commands registered in extension's bootstrap.
When user writes down a command that is not registered in CLI, we check if there's such command and in case it is found, CLI will instruc the user how to install the respective extension.
Same will happen in case user tries to access the help content of a command that is registered in extension.

Author: rosen-vladimirov

lib/common

@@ -32,6 +32,20 @@ interface INodePackageManager {
 	 * @return {Promise<string>}                The output of the uninstallation.
 	 */
 	search(filter: string[], config: IDictionary<string | boolean>): Promise<string>;
+
+	/**
+	 * Searches for npm packages in npms by keyword.
+	 * @param {string} keyword The keyword based on which the search action will be executed.
+	 * @returns {INpmsResult} The information about found npm packages.
+	 */
+	searchNpms(keyword: string): Promise<INpmsResult>;
+
+	/**
+	 * Gets information for a specified package from registry.npmjs.org.
+	 * @param {string} packageName The name of the package.
+	 * @returns {any} The full data from registry.npmjs.org for this package.
+	 */
+	getRegistryPackageData(packageName: string): Promise<any>;
 }
 
 interface INpmInstallationManager {
@@ -306,6 +320,57 @@ interface IDependencyData {
 	dependencies?: string[];
 }
 
+interface INpmsResult {
+	total: number;
+	results: INpmsSingleResultData[];
+}
+
+interface INpmsSingleResultData {
+	package: INpmsPackageData;
+	flags: INpmsFlags;
+	score: INpmsScore;
+	searchScore: number;
+}
+
+interface INpmsPackageData {
+	name: string;
+	// unscoped in case package is not in a scope
+	// scope name in case part of a scope "angular" for example for @angular/core
+	scope: string;
+	version: string;
+	description: string;
+	keywords: string[];
+	date: string;
+	links: { npm: string };
+	author: { name: string };
+	publisher: INpmsUser;
+	maintainers: INpmsUser[];
+}
+
+interface IUsername {
+	username: string;
+}
+
+interface INpmsUser extends IUsername {
+	email: string;
+}
+
+interface INpmsFlags {
+	unstable: boolean;
+	insecure: number;
+	// Describes the reason for deprecation.
+	deprecated: string;
+}
+
+interface INpmsScore {
+	final: number;
+	detail: {
+		quality: number;
+		popularity: number;
+		maintenance: number;
+	}
+}
+
 interface IStaticConfig extends Config.IStaticConfig { }
 
 interface IConfiguration extends Config.IConfig {

lib/declarations.d.ts

@@ -10,7 +10,8 @@ export class NodePackageManager implements INodePackageManager {
 		private $hostInfo: IHostInfo,
 		private $errors: IErrors,
 		private $childProcess: IChildProcess,
-		private $logger: ILogger) { }
+		private $logger: ILogger,
+		private $httpClient: Server.IHttpClient) { }
 
 	@exported("npm")
 	public async install(packageName: string, pathToSave: string, config: INodePackageManagerInstallOptions): Promise<INpmInstallResultInfo> {
@@ -110,6 +111,23 @@ export class NodePackageManager implements INodePackageManager {
 		return JSON.parse(viewResult);
 	}
 
+	public async searchNpms(keyword: string): Promise<INpmsResult> {
+		// TODO: Fix the generation of url - in case it contains @ or / , the call may fail.
+		const httpRequestResult = await this.$httpClient.httpRequest(`https://api.npms.io/v2/search?q=keywords:${keyword}`);
+		const result: INpmsResult = JSON.parse(httpRequestResult.body);
+		return result;
+	}
+
+	public async getRegistryPackageData(packageName: string): Promise<any> {
+		const url = `https://registry.npmjs.org/${packageName}`;
+		this.$logger.trace(`Trying to get data from npm registry for package ${packageName}, url is: ${url}`);
+		const responseData = (await this.$httpClient.httpRequest(url)).body;
+		this.$logger.trace(`Successfully received data from npm registry for package ${packageName}. Response data is: ${responseData}`);
+		const jsonData = JSON.parse(responseData);
+		this.$logger.trace(`Successfully parsed data from npm registry for package ${packageName}.`);
+		return jsonData;
+	}
+
 	private getNpmExecutableName(): string {
 		let npmExecutableName = "npm";
 

lib/node-package-manager.ts

@@ -1,6 +1,7 @@
 import * as path from "path";
 import { cache, exported } from "../common/decorators";
 import * as constants from "../constants";
+import { createRegExp, regExpEscape } from "../common/helpers";
 
 export class ExtensibilityService implements IExtensibilityService {
 	private get pathToExtensions(): string {
@@ -107,6 +108,63 @@ export class ExtensibilityService implements IExtensibilityService {
 		}
 	}
 
+	public async getExtensionNameWhereCommandIsRegistered(inputOpts: IGetExtensionCommandInfoParams): Promise<IExtensionCommandInfo> {
+		let allExtensions: INpmsSingleResultData[] = [];
+
+		try {
+			const npmsResult = await this.$npm.searchNpms("nativescript:extension");
+			allExtensions = npmsResult.results || [];
+		} catch (err) {
+			this.$logger.trace(`Unable to find extensions via npms. Error is: ${err}`);
+			return null;
+		}
+
+		const defaultCommandRegExp = new RegExp(`${regExpEscape(inputOpts.defaultCommandDelimiter)}.*`);
+		const commandDelimiterRegExp = createRegExp(inputOpts.commandDelimiter, "g");
+
+		for (const extensionData of allExtensions) {
+			const extensionName = extensionData.package.name;
+
+			try {
+				// now get full package.json for the latest version of the package
+				const registryData = await this.$npm.getRegistryPackageData(extensionName);
+				const latestPackageData = registryData.versions[registryData["dist-tags"].latest];
+				const commands: string[] = latestPackageData && latestPackageData.nativescript && latestPackageData.nativescript.commands;
+				if (commands && commands.length) {
+					// For each default command we need to add its short syntax in the array of commands.
+					// For example in case there's a default command called devices list, the commands array will contain devices|*list.
+					// However, in case the user executes just tns devices, CLI will still execute the tns devices list command.
+					// So we need to add the devices command as well.
+					_.filter(commands, command => command.indexOf(inputOpts.defaultCommandDelimiter) !== -1)
+						.forEach(defaultCommand => {
+							commands.push(defaultCommand.replace(defaultCommandRegExp, ""));
+						});
+
+					const copyOfFullArgs = _.clone(inputOpts.inputStrings);
+					while (copyOfFullArgs.length) {
+						const currentCommand = copyOfFullArgs.join(inputOpts.commandDelimiter).toLowerCase();
+
+						if (_.some(commands, c => c.toLowerCase() === currentCommand)) {
+							const beautifiedCommandName = currentCommand.replace(commandDelimiterRegExp, " ");
+							return {
+								extensionName,
+								registeredCommandName: currentCommand,
+								installationMessage: `The command ${beautifiedCommandName} is registered in extension ${extensionName}. You can install it by executing 'tns extension install ${extensionName}'`
+							};
+						}
+
+						copyOfFullArgs.splice(-1, 1);
+					}
+				}
+			} catch (err) {
+				// We do not want to stop the whole process in case we are unable to find data for one of the extensions.
+				this.$logger.trace(`Unable to get data for ${extensionName}. Error is: ${err}`);
+			}
+		}
+
+		return null;
+	}
+
 	private getPathToExtension(extensionName: string): string {
 		return path.join(this.pathToExtensions, constants.NODE_MODULES_FOLDER_NAME, extensionName);
 	}

lib/services/extensibility-service.ts

@@ -117,6 +117,7 @@ function createTestInjector(projectPath: string, projectName: string): IInjector
 	testInjector.register("npm", NodePackageManager);
 	testInjector.register("xCConfigService", XCConfigService);
 	testInjector.register("settingsService", SettingsService);
+	testInjector.register("httpClient", {});
 
 	return testInjector;
 }

test/ios-project-service.ts

@@ -96,6 +96,7 @@ function createTestInjector(): IInjector {
 			message: (): void => undefined
 		})
 	});
+	testInjector.register("httpClient", {});
 
 	return testInjector;
 }

test/npm-support.ts

@@ -160,6 +160,7 @@ function createTestInjector() {
 			message: (): void => undefined
 		})
 	});
+	testInjector.register("extensibilityService", {});
 
 	return testInjector;
 }

test/platform-commands.ts

@@ -110,7 +110,8 @@ function createTestInjector() {
 			message: (): void => undefined
 		})
 	});
-
+	testInjector.register("httpClient", {});
+	testInjector.register("extensibilityService", {});
 	return testInjector;
 }
 

test/plugins-service.ts

@@ -9,7 +9,6 @@ import * as ProjectHelperLib from "../lib/common/project-helper";
 import { StaticConfig } from "../lib/config";
 import * as NpmLib from "../lib/node-package-manager";
 import { NpmInstallationManager } from "../lib/npm-installation-manager";
-import * as HttpClientLib from "../lib/common/http-client";
 import { FileSystem } from "../lib/common/file-system";
 import * as path from "path";
 import temp = require("temp");
@@ -145,7 +144,7 @@ class ProjectIntegrationTest {
 
 		this.testInjector.register("npmInstallationManager", NpmInstallationManager);
 		this.testInjector.register("npm", NpmLib.NodePackageManager);
-		this.testInjector.register("httpClient", HttpClientLib.HttpClient);
+		this.testInjector.register("httpClient", {});
 
 		this.testInjector.register("options", Options);
 		this.testInjector.register("hostInfo", HostInfo);