azuredatastudio/extensions/sql-database-projects/src/tools/packageHelper.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the Source EULA. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
import * as vscode from 'vscode';
import * as utils from '../common/utils';
import * as azureFunctionsUtils from '../common/azureFunctionsUtils';
import * as constants from '../common/constants';
import { NetCoreTool } from './netcoreTool';
import { ShellCommandOptions } from './shellExecutionHelper';

export class PackageHelper {
	private netCoreTool: NetCoreTool;
	private _outputChannel: vscode.OutputChannel;

	constructor(outputChannel: vscode.OutputChannel) {
		this.netCoreTool = new NetCoreTool(outputChannel);
		this._outputChannel = outputChannel;
	}

	/**
	 * Constructs the parameters for a dotnet add package
	 * @param projectUri uri of project to add package to
	 * @param packageName name of package
	 * @param packageVersion optional version of package. If none, latest will be pulled in
	 * @returns string constructed with the arguments for dotnet add package
	 */
	public constructAddPackageArguments(projectUri: vscode.Uri, packageName: string, packageVersion?: string): string {
		const projectPath = utils.getQuotedPath(projectUri.fsPath);
		if (packageVersion) {
			return ` add ${projectPath} package ${packageName} -v ${packageVersion}`;
		} else {
			// pull in the latest version of the package and allow prerelease versions
			return ` add ${projectPath} package ${packageName} --prerelease`;
		}
	}

	/**
	 * Runs dotnet add package to add a package reference to the specified project. If the project already has a package reference
	 * for this package version, the project file won't get updated
	 * @param projectPath uri of project to add package to
	 * @param packageName name of package
	 * @param packageVersion optional version of package. If none, latest will be pulled in
	 */
	public async addPackage(projectUri: vscode.Uri, packageName: string, packageVersion?: string): Promise<void> {
		const addOptions: ShellCommandOptions = {
			commandTitle: constants.addPackage,
			argument: this.constructAddPackageArguments(projectUri, packageName, packageVersion)
		};
		// Add package can be done with any version of .NET so skip the supported version check
		await this.netCoreTool.runDotnetCommand(addOptions, true);
	}

	/**
	 * Adds specified package to Azure Functions project the specified file is a part of
	 * @param filePath uri of file to find the containing AF project of to add package reference to
	 * @param packageName package to add reference to
	 * @param packageVersion optional version of package. If none, latest will be pulled in
	 */
	public async addPackageToAFProjectContainingFile(fileUri: vscode.Uri, packageName: string, packageVersion?: string): Promise<void> {
		try {
			const project = await azureFunctionsUtils.getAFProjectContainingFile(fileUri);

			// if no AF projects were found, an error gets thrown from getAFProjectContainingFile(). This check is temporary until
			// multiple AF projects in the workspace is handled. That scenario returns undefined and shows an info message telling the
			// user to make sure their project has the package reference
			if (project) {
				await this.addPackage(project, packageName, packageVersion);
			} else {
				void vscode.window.showInformationMessage(constants.addPackageReferenceMessage, constants.moreInformation).then((result) => {
					if (result === constants.moreInformation) {
						void vscode.env.openExternal(vscode.Uri.parse(constants.sqlBindingsHelpLink));
					}
				});
			}
		} catch (e) {
			const result = await vscode.window.showErrorMessage(constants.addSqlBindingPackageError, constants.checkoutOutputMessage);
			if (result === constants.checkoutOutputMessage) {
				this._outputChannel.show();
			}
		}
	}
}