Remove ApiWrapper from sql-database-projects (#11345)

* Remove ApiWrapper

* fix compile error

* Use .resolves

* Check error messages

* Check for not called

* FIx global beforeEach/afterEach
This commit is contained in:
Charles Gagnon
2020-07-15 14:02:33 -07:00
committed by GitHub
parent c7799168b0
commit f4a4127471
11 changed files with 753 additions and 867 deletions

View File

@@ -13,10 +13,9 @@ import * as UUID from 'vscode-languageclient/lib/utils/uuid';
import * as templates from '../templates/templates';
import * as xmldom from 'xmldom';
import { Uri, QuickPickItem, WorkspaceFolder, extensions, Extension } from 'vscode';
import { IConnectionProfile, TaskExecutionMode } from 'azdata';
import * as vscode from 'vscode';
import * as azdata from 'azdata';
import { promises as fs } from 'fs';
import { ApiWrapper } from '../common/apiWrapper';
import { PublishDatabaseDialog } from '../dialogs/publishDatabaseDialog';
import { Project, DatabaseReferenceLocation, SystemDatabase, TargetPlatform, ProjectEntry, reservedProjectFolders } from '../models/project';
import { SqlDatabaseProjectTreeViewProvider } from './databaseProjectTreeViewProvider';
@@ -38,7 +37,7 @@ export class ProjectsController {
projects: Project[] = [];
constructor(private apiWrapper: ApiWrapper, projTreeViewProvider: SqlDatabaseProjectTreeViewProvider) {
constructor(projTreeViewProvider: SqlDatabaseProjectTreeViewProvider) {
this.projectTreeViewProvider = projTreeViewProvider;
this.netCoreTool = new NetCoreTool();
this.buildHelper = new BuildHelper();
@@ -48,10 +47,10 @@ export class ProjectsController {
this.projectTreeViewProvider.load(this.projects);
}
public async openProject(projectFile: Uri): Promise<Project> {
public async openProject(projectFile: vscode.Uri): Promise<Project> {
for (const proj of this.projects) {
if (proj.projectFilePath === projectFile.fsPath) {
this.apiWrapper.showInformationMessage(constants.projectAlreadyOpened(projectFile.fsPath));
vscode.window.showInformationMessage(constants.projectAlreadyOpened(projectFile.fsPath));
return proj;
}
}
@@ -96,7 +95,7 @@ export class ProjectsController {
public async focusProject(project?: Project): Promise<void> {
if (project && this.projects.includes(project)) {
await this.apiWrapper.executeCommand(constants.sqlDatabaseProjectsViewFocusCommand);
await vscode.commands.executeCommand(constants.sqlDatabaseProjectsViewFocusCommand);
await this.projectTreeViewProvider.focus(project);
}
}
@@ -107,7 +106,7 @@ export class ProjectsController {
* @param folderUri
* @param projectGuid
*/
public async createNewProject(newProjName: string, folderUri: Uri, makeOwnFolder: boolean, projectGuid?: string): Promise<string> {
public async createNewProject(newProjName: string, folderUri: vscode.Uri, makeOwnFolder: boolean, projectGuid?: string): Promise<string> {
if (projectGuid && !UUID.isUUID(projectGuid)) {
throw new Error(`Specified GUID is invalid: '${projectGuid}'`);
}
@@ -179,7 +178,7 @@ export class ProjectsController {
return path.join(project.projectFolderPath, 'bin', 'Debug', `${project.projectFileName}.dacpac`);
}
catch (err) {
this.apiWrapper.showErrorMessage(constants.projBuildFailed(utils.getErrorMessage(err)));
vscode.window.showErrorMessage(constants.projBuildFailed(utils.getErrorMessage(err)));
return undefined;
}
}
@@ -221,14 +220,14 @@ export class ProjectsController {
const dacFxService = await this.getDaxFxService();
if ((<IPublishSettings>settings).upgradeExisting) {
return await dacFxService.deployDacpac(tempPath, settings.databaseName, (<IPublishSettings>settings).upgradeExisting, settings.connectionUri, TaskExecutionMode.execute, settings.sqlCmdVariables);
return await dacFxService.deployDacpac(tempPath, settings.databaseName, (<IPublishSettings>settings).upgradeExisting, settings.connectionUri, azdata.TaskExecutionMode.execute, settings.sqlCmdVariables);
}
else {
return await dacFxService.generateDeployScript(tempPath, settings.databaseName, settings.connectionUri, TaskExecutionMode.script, settings.sqlCmdVariables);
return await dacFxService.generateDeployScript(tempPath, settings.databaseName, settings.connectionUri, azdata.TaskExecutionMode.script, settings.sqlCmdVariables);
}
}
public async readPublishProfile(profileUri: Uri): Promise<PublishProfile> {
public async readPublishProfile(profileUri: vscode.Uri): Promise<PublishProfile> {
const profileText = await fs.readFile(profileUri.fsPath);
const profileXmlDoc = new xmldom.DOMParser().parseFromString(profileText.toString());
@@ -251,7 +250,7 @@ export class ProjectsController {
public async schemaCompare(treeNode: BaseProjectTreeItem): Promise<void> {
// check if schema compare extension is installed
if (this.apiWrapper.getExtension(constants.schemaCompareExtensionId)) {
if (vscode.extensions.getExtension(constants.schemaCompareExtensionId)) {
// build project
await this.buildProject(treeNode);
@@ -261,12 +260,12 @@ export class ProjectsController {
// check that dacpac exists
if (await utils.exists(dacpacPath)) {
await this.apiWrapper.executeCommand(constants.schemaCompareStartCommand, dacpacPath);
await vscode.commands.executeCommand(constants.schemaCompareStartCommand, dacpacPath);
} else {
this.apiWrapper.showErrorMessage(constants.buildDacpacNotFound);
vscode.window.showErrorMessage(constants.buildDacpacNotFound);
}
} else {
this.apiWrapper.showErrorMessage(constants.schemaCompareNotInstalled);
vscode.window.showErrorMessage(constants.schemaCompareNotInstalled);
}
}
@@ -292,7 +291,7 @@ export class ProjectsController {
await project.addFolderItem(relativeFolderPath);
this.refreshProjectsTree();
} catch (err) {
this.apiWrapper.showErrorMessage(utils.getErrorMessage(err));
vscode.window.showErrorMessage(utils.getErrorMessage(err));
}
}
@@ -308,13 +307,13 @@ export class ProjectsController {
public async addItemPrompt(project: Project, relativePath: string, itemTypeName?: string) {
if (!itemTypeName) {
const items: QuickPickItem[] = [];
const items: vscode.QuickPickItem[] = [];
for (const itemType of templates.projectScriptTypes()) {
items.push({ label: itemType.friendlyName });
}
itemTypeName = (await this.apiWrapper.showQuickPick(items, {
itemTypeName = (await vscode.window.showQuickPick(items, {
canPickMany: false
}))?.label;
@@ -346,11 +345,11 @@ export class ProjectsController {
const newEntry = await project.addScriptItem(relativeFilePath, newFileText);
await this.apiWrapper.executeCommand(constants.vscodeOpenCommand, newEntry.fsUri);
await vscode.commands.executeCommand(constants.vscodeOpenCommand, newEntry.fsUri);
this.refreshProjectsTree();
} catch (err) {
this.apiWrapper.showErrorMessage(utils.getErrorMessage(err));
vscode.window.showErrorMessage(utils.getErrorMessage(err));
}
}
@@ -362,7 +361,7 @@ export class ProjectsController {
if (fileEntry) {
await project.exclude(fileEntry);
} else {
this.apiWrapper.showErrorMessage(constants.unableToPerformAction(constants.excludeAction, context.uri.path));
vscode.window.showErrorMessage(constants.unableToPerformAction(constants.excludeAction, context.uri.path));
}
this.refreshProjectsTree();
@@ -372,7 +371,7 @@ export class ProjectsController {
const project = this.getProjectFromContext(context);
const confirmationPrompt = context instanceof FolderNode ? constants.deleteConfirmationContents(context.friendlyName) : constants.deleteConfirmation(context.friendlyName);
const response = await this.apiWrapper.showWarningMessageOptions(confirmationPrompt, { modal: true }, constants.yesString);
const response = await vscode.window.showWarningMessage(confirmationPrompt, { modal: true }, constants.yesString);
if (response !== constants.yesString) {
return;
@@ -392,7 +391,7 @@ export class ProjectsController {
if (success) {
this.refreshProjectsTree();
} else {
this.apiWrapper.showErrorMessage(constants.unableToPerformAction(constants.deleteAction, context.uri.path));
vscode.window.showErrorMessage(constants.unableToPerformAction(constants.deleteAction, context.uri.path));
}
}
@@ -406,7 +405,7 @@ export class ProjectsController {
*/
public async openContainingFolder(context: BaseProjectTreeItem): Promise<void> {
const project = this.getProjectFromContext(context);
await this.apiWrapper.executeCommand(constants.revealFileInOsCommand, Uri.file(project.projectFilePath));
await vscode.commands.executeCommand(constants.revealFileInOsCommand, vscode.Uri.file(project.projectFilePath));
}
/**
@@ -439,12 +438,12 @@ export class ProjectsController {
this.refreshProjectsTree();
} catch (err) {
this.apiWrapper.showErrorMessage(utils.getErrorMessage(err));
vscode.window.showErrorMessage(utils.getErrorMessage(err));
}
}
private async getDatabaseReferenceType(): Promise<string> {
let databaseReferenceOptions: QuickPickItem[] = [
let databaseReferenceOptions: vscode.QuickPickItem[] = [
{
label: constants.systemDatabase
},
@@ -453,7 +452,7 @@ export class ProjectsController {
}
];
let input = await this.apiWrapper.showQuickPick(databaseReferenceOptions, {
let input = await vscode.window.showQuickPick(databaseReferenceOptions, {
canPickMany: false,
placeHolder: constants.addDatabaseReferenceInput
});
@@ -466,7 +465,7 @@ export class ProjectsController {
}
public async getSystemDatabaseName(project: Project): Promise<SystemDatabase> {
let databaseReferenceOptions: QuickPickItem[] = [
let databaseReferenceOptions: vscode.QuickPickItem[] = [
{
label: constants.master
}
@@ -480,7 +479,7 @@ export class ProjectsController {
});
}
let input = await this.apiWrapper.showQuickPick(databaseReferenceOptions, {
let input = await vscode.window.showQuickPick(databaseReferenceOptions, {
canPickMany: false,
placeHolder: constants.systemDatabaseReferenceInput
});
@@ -492,13 +491,13 @@ export class ProjectsController {
return input.label === constants.master ? SystemDatabase.master : SystemDatabase.msdb;
}
private async getDacpacFileLocation(): Promise<Uri> {
let fileUris = await this.apiWrapper.showOpenDialog(
private async getDacpacFileLocation(): Promise<vscode.Uri> {
let fileUris = await vscode.window.showOpenDialog(
{
canSelectFiles: true,
canSelectFolders: false,
canSelectMany: false,
defaultUri: this.apiWrapper.workspaceFolders() ? (this.apiWrapper.workspaceFolders() as WorkspaceFolder[])[0].uri : undefined,
defaultUri: vscode.workspace.workspaceFolders ? (vscode.workspace.workspaceFolders as vscode.WorkspaceFolder[])[0].uri : undefined,
openLabel: constants.selectString,
filters: {
[constants.dacpacFiles]: ['dacpac'],
@@ -514,7 +513,7 @@ export class ProjectsController {
}
private async getDatabaseLocation(): Promise<DatabaseReferenceLocation> {
let databaseReferenceOptions: QuickPickItem[] = [
let databaseReferenceOptions: vscode.QuickPickItem[] = [
{
label: constants.databaseReferenceSameDatabase
},
@@ -523,7 +522,7 @@ export class ProjectsController {
}
];
let input = await this.apiWrapper.showQuickPick(databaseReferenceOptions, {
let input = await vscode.window.showQuickPick(databaseReferenceOptions, {
canPickMany: false,
placeHolder: constants.databaseReferenceLocation
});
@@ -536,9 +535,9 @@ export class ProjectsController {
return location;
}
private async getDatabaseName(dacpac: Uri): Promise<string | undefined> {
private async getDatabaseName(dacpac: vscode.Uri): Promise<string | undefined> {
const dacpacName = path.parse(dacpac.toString()).name;
let databaseName = await this.apiWrapper.showInputBox({
let databaseName = await vscode.window.showInputBox({
prompt: constants.databaseReferenceDatabaseName,
value: `${dacpacName}`
});
@@ -554,7 +553,7 @@ export class ProjectsController {
//#region Helper methods
public getPublishDialog(project: Project): PublishDatabaseDialog {
return new PublishDatabaseDialog(this.apiWrapper, project);
return new PublishDatabaseDialog(project);
}
public async updateProjectForRoundTrip(project: Project) {
@@ -563,13 +562,13 @@ export class ProjectsController {
}
if (!project.importedTargets.includes(constants.NetCoreTargets)) {
const result = await this.apiWrapper.showWarningMessage(constants.updateProjectForRoundTrip, constants.yesString, constants.noString);
const result = await vscode.window.showWarningMessage(constants.updateProjectForRoundTrip, constants.yesString, constants.noString);
if (result === constants.yesString) {
await project.updateProjectForRoundTrip();
await project.updateSystemDatabaseReferencesInProjFile();
}
} else if (project.containsSSDTOnlySystemDatabaseReferences()) {
const result = await this.apiWrapper.showWarningMessage(constants.updateProjectDatabaseReferencesForRoundTrip, constants.yesString, constants.noString);
const result = await vscode.window.showWarningMessage(constants.updateProjectDatabaseReferencesForRoundTrip, constants.yesString, constants.noString);
if (result === constants.yesString) {
await project.updateSystemDatabaseReferencesInProjFile();
}
@@ -590,7 +589,7 @@ export class ProjectsController {
}
public async getDaxFxService(): Promise<mssql.IDacFxService> {
const ext: Extension<any> = extensions.getExtension(mssql.extension.name)!;
const ext: vscode.Extension<any> = vscode.extensions.getExtension(mssql.extension.name)!;
await ext.activate();
return (ext.exports as mssql.IExtension).dacFx;
@@ -616,7 +615,7 @@ export class ProjectsController {
// TODO: ask project for suggested name that doesn't conflict
const suggestedName = itemType.friendlyName.replace(new RegExp('\s', 'g'), '') + '1';
const itemObjectName = await this.apiWrapper.showInputBox({
const itemObjectName = await vscode.window.showInputBox({
prompt: constants.newObjectNamePrompt(itemType.friendlyName),
value: suggestedName,
});
@@ -632,7 +631,7 @@ export class ProjectsController {
* Imports a new SQL database project from the existing database,
* prompting the user for a name, file path location and extract target
*/
public async importNewDatabaseProject(context: IConnectionProfile | any): Promise<void> {
public async importNewDatabaseProject(context: azdata.IConnectionProfile | any): Promise<void> {
// TODO: Refactor code
try {
@@ -641,14 +640,12 @@ export class ProjectsController {
if (!model) {
return; // cancelled by user
}
model.projName = await this.getProjectName(model.database);
let newProjFolderUri = (await this.getFolderLocation()).fsPath;
model.extractTarget = await this.getExtractTarget();
model.version = '1.0.0.0';
const newProjFilePath = await this.createNewProject(model.projName, Uri.file(newProjFolderUri), true);
const newProjFilePath = await this.createNewProject(model.projName, vscode.Uri.file(newProjFolderUri), true);
model.filePath = path.dirname(newProjFilePath);
if (model.extractTarget === mssql.ExtractTarget.file) {
@@ -656,15 +653,14 @@ export class ProjectsController {
}
const project = await Project.openProject(newProjFilePath);
await this.importApiCall(model); // Call ExtractAPI in DacFx Service
let fileFolderList: string[] = model.extractTarget === mssql.ExtractTarget.file ? [model.filePath] : await this.generateList(model.filePath); // Create a list of all the files and directories to be added to project
await project.addToProject(fileFolderList); // Add generated file structure to the project
await this.openProject(Uri.file(newProjFilePath));
await this.openProject(vscode.Uri.file(newProjFilePath));
}
catch (err) {
this.apiWrapper.showErrorMessage(utils.getErrorMessage(err));
vscode.window.showErrorMessage(utils.getErrorMessage(err));
}
}
@@ -680,7 +676,7 @@ export class ProjectsController {
connectionId = profile.id;
}
else {
const connection = await this.apiWrapper.openConnectionDialog();
const connection = await azdata.connection.openConnectionDialog();
if (!connection) {
return undefined;
@@ -695,8 +691,8 @@ export class ProjectsController {
// choose database if connection was to a server or master
if (!model.database || model.database === constants.master) {
const databaseList = await this.apiWrapper.listDatabases(connectionId);
database = (await this.apiWrapper.showQuickPick(databaseList.map(dbName => { return { label: dbName }; }),
const databaseList = await azdata.connection.listDatabases(connectionId);
database = (await vscode.window.showQuickPick(databaseList.map(dbName => { return { label: dbName }; }),
{
canPickMany: false,
placeHolder: constants.extractDatabaseSelection
@@ -714,7 +710,7 @@ export class ProjectsController {
return model;
}
private getConnectionProfileFromContext(context: IConnectionProfile | any): IConnectionProfile | undefined {
private getConnectionProfileFromContext(context: azdata.IConnectionProfile | any): azdata.IConnectionProfile | undefined {
if (!context) {
return undefined;
}
@@ -725,7 +721,7 @@ export class ProjectsController {
}
private async getProjectName(dbName: string): Promise<string> {
let projName = await this.apiWrapper.showInputBox({
let projName = await vscode.window.showInputBox({
prompt: constants.newDatabaseProjectName,
value: `DatabaseProject${dbName}`
});
@@ -757,7 +753,7 @@ export class ProjectsController {
private async getExtractTarget(): Promise<mssql.ExtractTarget> {
let extractTarget: mssql.ExtractTarget;
let extractTargetOptions: QuickPickItem[] = [];
let extractTargetOptions: vscode.QuickPickItem[] = [];
let keys = [constants.file, constants.flat, constants.objectType, constants.schema, constants.schemaObjectType];
@@ -766,7 +762,7 @@ export class ProjectsController {
extractTargetOptions.push({ label: targetOption });
});
let input = await this.apiWrapper.showQuickPick(extractTargetOptions, {
let input = await vscode.window.showQuickPick(extractTargetOptions, {
canPickMany: false,
placeHolder: constants.extractTargetInput
});
@@ -777,19 +773,19 @@ export class ProjectsController {
return extractTarget;
}
private async getFolderLocation(): Promise<Uri> {
let projUri: Uri;
private async getFolderLocation(): Promise<vscode.Uri> {
let projUri: vscode.Uri;
const selectionResult = await this.apiWrapper.showOpenDialog({
const selectionResult = await vscode.window.showOpenDialog({
canSelectFiles: false,
canSelectFolders: true,
canSelectMany: false,
openLabel: constants.selectString,
defaultUri: this.apiWrapper.workspaceFolders() ? (this.apiWrapper.workspaceFolders() as WorkspaceFolder[])[0].uri : undefined
defaultUri: vscode.workspace.workspaceFolders ? (vscode.workspace.workspaceFolders as vscode.WorkspaceFolder[])[0].uri : undefined
});
if (selectionResult) {
projUri = (selectionResult as Uri[])[0];
projUri = (selectionResult as vscode.Uri[])[0];
}
else {
throw new Error(constants.projectLocationRequired);
@@ -799,12 +795,12 @@ export class ProjectsController {
}
public async importApiCall(model: ImportDataModel): Promise<void> {
let ext = this.apiWrapper.getExtension(mssql.extension.name)!;
let ext = vscode.extensions.getExtension(mssql.extension.name)!;
const service = (await ext.activate() as mssql.IExtension).dacFx;
const ownerUri = await this.apiWrapper.getUriForConnection(model.serverId);
const ownerUri = await azdata.connection.getUriForConnection(model.serverId);
await service.importDatabaseProject(model.database, model.filePath, model.projName, model.version, ownerUri, model.extractTarget, TaskExecutionMode.execute);
await service.importDatabaseProject(model.database, model.filePath, model.projName, model.version, ownerUri, model.extractTarget, azdata.TaskExecutionMode.execute);
// TODO: Check for success; throw error
}
@@ -819,7 +815,7 @@ export class ProjectsController {
if (await utils.exists(absolutePath + constants.sqlFileExtension)) {
absolutePath += constants.sqlFileExtension;
} else {
await this.apiWrapper.showErrorMessage(constants.cannotResolvePath(absolutePath));
vscode.window.showErrorMessage(constants.cannotResolvePath(absolutePath));
return fileFolderList;
}
}