ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-21 01:25:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Refactor vscode-mssql sql bindings logic to sql bindings ext (#18725)

Browse Source 
* wip for refactor of mssql to sql-bindings

* remove STS dependency

* work to bring function over and setup with vscodeMsql APIs

* copy typings from vscode-mssql
This commit is contained in:
Vasu Bhog
2022-03-14 13:07:27 -07:00
committed by GitHub
parent a86301312c
commit 2d1ffeb47c
12 changed files with 627 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

241
extensions/sql-bindings/src/common/azureFunctionsUtils.ts
View File

@@ -2,13 +2,16 @@
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as fse from 'fs-extra';
import * as os from 'os';
import * as fs from 'fs';
import * as path from 'path';
import * as vscode from 'vscode';
import * as utils from './utils';
import * as constants from './constants';
import { parseJson } from './parseJson';
// https://github.com/microsoft/vscode-azurefunctions/blob/main/src/vscode-azurefunctions.api.d.ts
import { AzureFunctionsExtensionApi } from '../typings/vscode-azurefunctions.api';
// https://github.com/microsoft/vscode-azuretools/blob/main/ui/api.d.ts
import { AzureExtensionApiProvider } from '../typings/vscode-azuretools.api';
/**
* Represents the settings in an Azure function project's locawl.settings.json file
*/
@@ -19,20 +22,25 @@ export interface ILocalSettingsJson {
ConnectionStrings?: { [key: string]: string };
}
export interface IFileFunctionObject {
filePromise: Promise<string>;
watcherDisposable: vscode.Disposable;
}
/**
* copied and modified from vscode-azurefunctions extension
* https://github.com/microsoft/vscode-azurefunctions/blob/main/src/funcConfig/local.settings.ts
* @param localSettingsPath full path to local.settings.json
* @returns settings in local.settings.json. If no settings are found, returns default "empty" settings
*/
export async function getLocalSettingsJson(localSettingsPath: string): Promise<ILocalSettingsJson> {
if (await fse.pathExists(localSettingsPath)) {
const data: string = (await fse.readFile(localSettingsPath)).toString();
if (/[^\s]/.test(data)) {
try {
return parseJson(data);
} catch (error) {
throw new Error(constants.failedToParse(error.message));
}
if (fs.existsSync(localSettingsPath)) {
const data: string = (fs.readFileSync(localSettingsPath)).toString();
try {
return JSON.parse(data);
} catch (error) {
console.log(error);
throw new Error(utils.formatString(constants.failedToParse(error.message), constants.azureFunctionLocalSettingsFileName, error.message));
}
}
@@ -66,11 +74,210 @@ export async function setLocalAppSetting(projectFolder: string, key: string, val
}
settings.Values[key] = value;
await fse.writeJson(localSettingsPath, settings, { spaces: 2 });
void fs.promises.writeFile(localSettingsPath, JSON.stringify(settings, undefined, 2));
return true;
}
/**
* Gets the Azure Functions extension API if it is installed
* if it is not installed, prompt the user to install directly, learn more, or do not install
* @returns the Azure Functions extension API if it is installed, prompt if it is not installed
*/
export async function getAzureFunctionsExtensionApi(): Promise<AzureFunctionsExtensionApi | undefined> {
let apiProvider = await vscode.extensions.getExtension(constants.azureFunctionsExtensionName)?.activate() as AzureExtensionApiProvider;
if (!apiProvider) {
const response = await vscode.window.showInformationMessage(constants.azureFunctionsExtensionNotFound,
constants.install, constants.learnMore, constants.doNotInstall);
if (response === constants.install) {
const extensionInstalled = new Promise<void>((resolve, reject) => {
const timeout = setTimeout(async () => {
reject(new Error(constants.timeoutExtensionError));
extensionChange.dispose();
}, 10000);
let extensionChange = vscode.extensions.onDidChange(async () => {
if (vscode.extensions.getExtension(constants.azureFunctionsExtensionName)) {
resolve();
extensionChange.dispose();
clearTimeout(timeout);
}
});
});
await vscode.window.withProgress(
{
location: vscode.ProgressLocation.Notification,
title: constants.azureFunctionsExtensionName,
cancellable: false
}, async (_progress, _token) => {
await vscode.commands.executeCommand('workbench.extensions.installExtension', constants.azureFunctionsExtensionName);
}
);
// the extension has not been notified that the azure function extension is installed so wait till it is to then activate it
await extensionInstalled;
apiProvider = await vscode.extensions.getExtension(constants.azureFunctionsExtensionName)?.activate() as AzureExtensionApiProvider;
} else if (response === constants.learnMore) {
await vscode.env.openExternal(vscode.Uri.parse(constants.linkToAzureFunctionExtension));
return undefined;
} else {
return undefined;
}
}
const azureFunctionApi = apiProvider.getApi<AzureFunctionsExtensionApi>('*');
if (azureFunctionApi) {
return azureFunctionApi;
} else {
void vscode.window.showErrorMessage(constants.azureFunctionsExtensionNotInstalled);
return undefined;
}
}
/**
* TODO REMOVE defaultSqlBindingTextLines
* Overwrites the Azure function methods body to work with the binding
* @param filePath is the path for the function file (.cs for C# functions)
*/
export function overwriteAzureFunctionMethodBody(filePath: string): void {
let defaultBindedFunctionText = fs.readFileSync(filePath, 'utf-8');
// Replace default binding text
let newValueLines = defaultBindedFunctionText.split(os.EOL);
const defaultFunctionTextToSkip = new Set(constants.defaultSqlBindingTextLines);
let replacedValueLines = [];
for (let defaultLine of newValueLines) {
// Skipped lines
if (defaultFunctionTextToSkip.has(defaultLine.trimStart())) {
continue;
} else if (defaultLine.trimStart() === constants.defaultBindingResult) { // Result change
replacedValueLines.push(defaultLine.replace(constants.defaultBindingResult, constants.sqlBindingResult));
} else {
// Normal lines to be included
replacedValueLines.push(defaultLine);
}
}
defaultBindedFunctionText = replacedValueLines.join(os.EOL);
fs.writeFileSync(filePath, defaultBindedFunctionText, 'utf-8');
}
/**
* Gets the azure function project for the user to choose from a list of projects files
* If only one project is found that project is used to add the binding to
* if no project is found, user is informed there needs to be a C# Azure Functions project
* @returns the selected project file path
*/
export async function getAzureFunctionProject(): Promise<string | undefined> {
let selectedProjectFile: string | undefined = '';
if (vscode.workspace.workspaceFolders === undefined || vscode.workspace.workspaceFolders.length === 0) {
return selectedProjectFile;
} else {
const projectFiles = await getAzureFunctionProjectFiles();
if (projectFiles !== undefined) {
if (projectFiles.length > 1) {
// select project to add azure function to
selectedProjectFile = (await vscode.window.showQuickPick(projectFiles, {
canPickMany: false,
title: constants.selectProject,
ignoreFocusOut: true
}));
return selectedProjectFile;
} else if (projectFiles.length === 1) {
// only one azure function project found
return projectFiles[0];
}
}
return undefined;
}
}
/**
* Gets the azure function project files based on the host file found in the same folder
* @returns the azure function project files paths
*/
export async function getAzureFunctionProjectFiles(): Promise<string[] | undefined> {
let projFiles: string[] = [];
const hostFiles = await getHostFiles();
if (!hostFiles) {
return undefined;
}
for (let host of hostFiles) {
let projectFile = await vscode.workspace.findFiles(new vscode.RelativePattern(path.dirname(host), '*.csproj'));
projectFile.filter(file => path.dirname(file.fsPath) === path.dirname(host) ? projFiles.push(file?.fsPath) : projFiles);
}
return projFiles.length > 0 ? projFiles : undefined;
}
/**
* Gets the host files from the workspace
* @returns the host file paths
*/
export async function getHostFiles(): Promise<string[] | undefined> {
const hostUris = await vscode.workspace.findFiles('**/host.json');
const hostFiles = hostUris.map(uri => uri.fsPath);
return hostFiles.length > 0 ? hostFiles : undefined;
}
/**
* Gets the local.settings.json file path
* @param projectFile path of the azure function project
* @returns the local.settings.json file path
*/
export async function getSettingsFile(projectFile: string): Promise<string | undefined> {
return path.join(path.dirname(projectFile), 'local.settings.json');
}
/**
* Retrieves the new function file once the file is created and the watcher disposable
* @param projectFile is the path to the project file
* @returns the function file path once created and the watcher disposable
*/
export function waitForNewFunctionFile(projectFile: string): IFileFunctionObject {
const watcher = vscode.workspace.createFileSystemWatcher((
path.dirname(projectFile), '**/*.cs'), false, true, true);
const filePromise = new Promise<string>((resolve, _) => {
watcher.onDidCreate((e) => {
resolve(e.fsPath);
});
});
return {
filePromise,
watcherDisposable: watcher
};
}
/**
* Retrieves the new host project file once it has created and the watcher disposable
* @returns the host file path once created and the watcher disposable
*/
export function waitForNewHostFile(): IFileFunctionObject {
const watcher = vscode.workspace.createFileSystemWatcher('**/host.json', false, true, true);
const filePromise = new Promise<string>((resolve, _) => {
watcher.onDidCreate((e) => {
resolve(e.fsPath);
});
});
return {
filePromise,
watcherDisposable: watcher
};
}
/**
* Adds the required nuget package to the project
* @param selectedProjectFile is the users selected project file path
*/
export async function addNugetReferenceToProjectFile(selectedProjectFile: string): Promise<void> {
await utils.executeCommand(`dotnet add ${selectedProjectFile} package ${constants.sqlExtensionPackageName} --prerelease`);
}
/**
* Adds the Sql Connection String to the local.settings.json
* @param connectionString of the SQL Server connection that was chosen by the user
*/
export async function addConnectionStringToConfig(connectionString: string, projectFile: string): Promise<void> {
const settingsFile = await getSettingsFile(projectFile);
if (settingsFile) {
await setLocalAppSetting(path.dirname(settingsFile), constants.sqlConnectionString, connectionString);
}
}
/**
* Gets the Azure Functions project that contains the given file if the project is open in one of the workspace folders
* @param fileUri file that the containing project needs to be found for
@@ -98,13 +305,5 @@ export async function getAFProjectContainingFile(fileUri: vscode.Uri): Promise<v
// Use 'host.json' as an indicator that this is a functions project
// copied from verifyIsproject.ts in vscode-azurefunctions extension
export async function isFunctionProject(folderPath: string): Promise<boolean> {
return fse.pathExists(path.join(folderPath, constants.hostFileName));
return fs.existsSync(path.join(folderPath, constants.hostFileName));
}
/**
* Adds the required nuget package to the project
* @param selectedProjectFile is the users selected project file path
*/
export async function addNugetReferenceToProjectFile(selectedProjectFile: string): Promise<void> {
await utils.executeCommand(`dotnet add ${selectedProjectFile} package ${constants.sqlExtensionPackageName} --prerelease`);
}