Adds autorest-based SQL Project generation to SQL Database Projects extension (#17078)

* Initial changes * checkpoint * Constructing project with post deployment script * Correcting to intentionally read from cached list of projects * Adding activation event, fixing fresh workspace bug * Convert netcoreTool and autorestHelper to share a helper class for streamed command * Include npm package version to force update * test checkpoint * Unit tests * Added contextual quickpicks for autorest dialogs * Adding projectController test * Added projectController test, some refactoring for testability * Merge branch 'main' into benjin/autorest * Fixing 'which' import * PR feedback * Fixing tests * Adding additional information for when project provider tests fail * Hopefully fixing failing tests (unable to repro locally) * Adding Generate Project item to workspace menu * PR feedback
2026-01-21 17:22:55 -05:00 · 2021-09-16 20:38:40 -07:00
parent 0cf1abc7c2
commit 08e15bce99
18 changed files with 586 additions and 85 deletions
--- a/extensions/sql-database-projects/src/tools/autorestHelper.ts
+++ b/extensions/sql-database-projects/src/tools/autorestHelper.ts
@@ -0,0 +1,106 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { DoNotAskAgain, Install, nodeButNotAutorestFound, nodeNotFound } from '../common/constants';
+import * as utils from '../common/utils';
+import * as semver from 'semver';
+import { DBProjectConfigurationKey } from './netcoreTool';
+import { ShellExecutionHelper } from './shellExecutionHelper';
+
+const autorestPackageName = 'autorest-sql-testing'; // name of AutoRest.Sql package on npm
+const nodejsDoNotAskAgainKey: string = 'nodejsDoNotAsk';
+const autorestSqlVersionKey: string = 'autorestSqlVersion';
+
+/**
+ * Helper class for dealing with Autorest generation and detection
+ */
+export class AutorestHelper extends ShellExecutionHelper {
+	constructor(_outputChannel: vscode.OutputChannel) {
+		super(_outputChannel);
+	}
+
+	/**
+	 * Checks the workspace configuration to for an AutoRest.Sql override, otherwise latest will be used from NPM
+	 */
+	public get autorestSqlPackageVersion(): string {
+		let configVal: string | undefined = vscode.workspace.getConfiguration(DBProjectConfigurationKey)[autorestSqlVersionKey];
+
+		if (configVal && semver.valid(configVal.trim())) {
+			return configVal.trim();
+		} else {
+			return 'latest';
+		}
+	}
+
+	/**
+	 * @returns the beginning of the command to execute autorest; 'autorest' if available, 'npx autorest' if module not installed, or undefined if neither
+	 */
+	public async detectInstallation(): Promise<string | undefined> {
+		const autorestCommand = 'autorest';
+		const npxCommand = 'npx';
+
+		if (await utils.detectCommandInstallation(autorestCommand)) {
+			return autorestCommand;
+		}
+
+		if (await utils.detectCommandInstallation(npxCommand)) {
+			this._outputChannel.appendLine(nodeButNotAutorestFound);
+			return `${npxCommand} ${autorestCommand}`;
+		}
+
+		return undefined;
+	}
+
+	/**
+	 * Calls autorest to generate files from the spec, piping standard and error output to the host console
+	 * @param specPath path to the OpenAPI spec file
+	 * @param outputFolder folder in which to generate the .sql script files
+	 * @returns console output from autorest execution
+	 */
+	public async generateAutorestFiles(specPath: string, outputFolder: string): Promise<string | undefined> {
+		const commandExecutable = await this.detectInstallation();
+
+		if (commandExecutable === undefined) {
+			// unable to find autorest or npx
+
+			if (vscode.workspace.getConfiguration(DBProjectConfigurationKey)[nodejsDoNotAskAgainKey] !== true) {
+				this._outputChannel.appendLine(nodeNotFound);
+				return; // user doesn't want to be prompted about installing it
+			}
+
+			// prompt user to install Node.js
+			const result = await vscode.window.showErrorMessage(nodeNotFound, DoNotAskAgain, Install);
+
+			if (result === Install) {
+				//open install link
+				const nodejsInstallationUrl = 'https://nodejs.dev/download';
+				await vscode.env.openExternal(vscode.Uri.parse(nodejsInstallationUrl));
+			} else if (result === DoNotAskAgain) {
+				const config = vscode.workspace.getConfiguration(DBProjectConfigurationKey);
+				await config.update(nodejsDoNotAskAgainKey, true, vscode.ConfigurationTarget.Global);
+			}
+
+			return;
+		}
+
+		const command = this.constructAutorestCommand(commandExecutable, specPath, outputFolder);
+		const output = await this.runStreamedCommand(command, this._outputChannel);
+
+		return output;
+	}
+
+	/**
+	 *
+	 * @param executable either "autorest" or "npx autorest", depending on whether autorest is already present in the global cache
+	 * @param specPath path to the OpenAPI spec
+	 * @param outputFolder folder in which to generate the files
+	 * @returns composed command to be executed
+	 */
+	public constructAutorestCommand(executable: string, specPath: string, outputFolder: string): string {
+		// TODO: should --clear-output-folder be included? We should always be writing to a folder created just for this, but potentially risky
+		return `${executable} --use:${autorestPackageName}@${this.autorestSqlPackageVersion} --input-file="${specPath}" --output-folder="${outputFolder}" --clear-output-folder`;
+	}
+}