From 9456285c65b1ee905b1a916f687f98b8c2f5ec15 Mon Sep 17 00:00:00 2001 From: Alan Ren Date: Fri, 14 Apr 2023 13:52:06 -0700 Subject: [PATCH] support scripting in object management dialogs (#22429) * user management - scripting * remove confirmation * update sts * update string --- extensions/mssql/config.json | 2 +- extensions/mssql/src/contracts.ts | 18 +++++++ extensions/mssql/src/mssql.d.ts | 12 +++++ .../objectManagement/localizedConstants.ts | 7 +++ .../objectManagementService.ts | 34 ++++++++++++ .../src/objectManagement/ui/loginDialog.ts | 4 ++ .../ui/objectManagementDialogBase.ts | 54 ++++++++++++++++--- .../src/objectManagement/ui/userDialog.ts | 4 ++ 8 files changed, 126 insertions(+), 9 deletions(-) diff --git a/extensions/mssql/config.json b/extensions/mssql/config.json index 17811929bd..afd4436626 100644 --- a/extensions/mssql/config.json +++ b/extensions/mssql/config.json @@ -1,6 +1,6 @@ { "downloadUrl": "https://github.com/Microsoft/sqltoolsservice/releases/download/{#version#}/microsoft.sqltools.servicelayer-{#fileName#}", - "version": "4.7.0.8", + "version": "4.7.0.10", "downloadFileNames": { "Windows_86": "win-x86-net7.0.zip", "Windows_64": "win-x64-net7.0.zip", diff --git a/extensions/mssql/src/contracts.ts b/extensions/mssql/src/contracts.ts index a0d81987bf..d859695106 100644 --- a/extensions/mssql/src/contracts.ts +++ b/extensions/mssql/src/contracts.ts @@ -1538,6 +1538,15 @@ export namespace CreateLoginRequest { export const type = new RequestType('objectManagement/createLogin'); } +export interface ScriptLoginRequestParams { + contextId: string; + login: mssql.ObjectManagement.Login; +} + +export namespace ScriptLoginRequest { + export const type = new RequestType('objectManagement/scriptLogin'); +} + export interface UpdateLoginRequestParams { contextId: string; login: mssql.ObjectManagement.Login; @@ -1576,6 +1585,15 @@ export namespace CreateUserRequest { export const type = new RequestType('objectManagement/createUser'); } +export interface ScriptUserRequestParams { + contextId: string; + user: mssql.ObjectManagement.User; +} + +export namespace ScriptUserRequest { + export const type = new RequestType('objectManagement/scriptUser'); +} + export interface UpdateUserRequestParams { contextId: string; user: mssql.ObjectManagement.User; diff --git a/extensions/mssql/src/mssql.d.ts b/extensions/mssql/src/mssql.d.ts index ad35bff111..a333b071cf 100644 --- a/extensions/mssql/src/mssql.d.ts +++ b/extensions/mssql/src/mssql.d.ts @@ -1185,6 +1185,12 @@ declare module 'mssql' { * @param login The login information. */ updateLogin(contextId: string, login: ObjectManagement.Login): Thenable; + /** + * Script a login. + * @param contextId The login view's context id. + * @param login The login information. + */ + scriptLogin(contextId: string, login: ObjectManagement.Login): Thenable; /** * Dispose the login view. * @param contextId The id of the view. @@ -1211,6 +1217,12 @@ declare module 'mssql' { * @param user The user information. */ updateUser(contextId: string, user: ObjectManagement.User): Thenable; + /** + * Script a user. + * @param contextId Id of the view. + * @param user The user information. + */ + scriptUser(contextId: string, user: ObjectManagement.User): Thenable; /** * Dispose the user view. * @param contextId The id of the view. diff --git a/extensions/mssql/src/objectManagement/localizedConstants.ts b/extensions/mssql/src/objectManagement/localizedConstants.ts index b12454c969..e5859e1dcc 100644 --- a/extensions/mssql/src/objectManagement/localizedConstants.ts +++ b/extensions/mssql/src/objectManagement/localizedConstants.ts @@ -23,6 +23,9 @@ export const OkText: string = localize('objectManagement.OkText', "OK"); export const LoadingDialogText: string = localize('objectManagement.loadingDialog', "Loading dialog..."); export const FailedToRetrieveConnectionInfoErrorMessage: string = localize('objectManagement.noConnectionUriError', "Failed to retrieve the connection information, please reconnect and try again.") export const RenameObjectDialogTitle: string = localize('objectManagement.renameObjectDialogTitle', "Enter new name"); +export const ScriptText: string = localize('objectManagement.scriptText', "Script"); +export const ScriptGeneratedText: string = localize('objectManagement.scriptGenerated', "Script has been generated successfully. You can close the dialog to view it in the newly opened editor.") + export function RefreshObjectExplorerError(error: string): string { return localize({ @@ -108,6 +111,10 @@ export function RenameObjectError(objectType: string, originalName: string, newN }, "An error occurred while renaming {0} '{1}' to '{2}'. {3}", objectType, originalName, newName, error); } +export function ScriptError(error: string): string { + return localize('objectManagement.scriptError', "An error occurred while generating script. {0}", error); +} + export const NameText = localize('objectManagement.nameLabel', "Name"); export const SelectedText = localize('objectManagement.selectedLabel', "Selected"); export const GeneralSectionHeader = localize('objectManagement.generalSectionHeader', "General"); diff --git a/extensions/mssql/src/objectManagement/objectManagementService.ts b/extensions/mssql/src/objectManagement/objectManagementService.ts index 59b8749b9c..9f379e4d93 100644 --- a/extensions/mssql/src/objectManagement/objectManagementService.ts +++ b/extensions/mssql/src/objectManagement/objectManagementService.ts @@ -63,6 +63,16 @@ export class ObjectManagementService implements IObjectManagementService { } ); } + scriptLogin(contextId: string, login: ObjectManagement.Login): Thenable { + const params: contracts.ScriptLoginRequestParams = { contextId, login }; + return this.client.sendRequest(contracts.ScriptLoginRequest.type, params).then( + r => { return r; }, + e => { + this.client.logFailedRequest(contracts.ScriptLoginRequest.type, e); + return Promise.reject(e); + } + ); + } disposeLoginView(contextId: string): Thenable { const params: contracts.DisposeLoginViewRequestParams = { contextId }; return this.client.sendRequest(contracts.DisposeLoginViewRequest.type, params).then( @@ -105,6 +115,16 @@ export class ObjectManagementService implements IObjectManagementService { } ); } + scriptUser(contextId: string, user: ObjectManagement.User): Thenable { + const params: contracts.ScriptUserRequestParams = { contextId, user }; + return this.client.sendRequest(contracts.ScriptUserRequest.type, params).then( + r => { return r; }, + e => { + this.client.logFailedRequest(contracts.ScriptUserRequest.type, e); + return Promise.reject(e); + } + ); + } disposeUserView(contextId: string): Thenable { const params: contracts.DisposeUserViewRequestParams = { contextId }; return this.client.sendRequest(contracts.DisposeUserViewRequest.type, params).then( @@ -215,6 +235,13 @@ export class TestObjectManagementService implements IObjectManagementService { }, 3000); }); } + async scriptLogin(contextId: string, login: ObjectManagement.Login): Promise { + return new Promise((resolve, reject) => { + setTimeout(() => { + resolve('test script'); + }, 1000); + }); + } async disposeLoginView(contextId: string): Promise { } async initializeUserView(connectionUri: string, database: string, contextId: string, isNewObject: boolean, name: string): Promise { @@ -280,6 +307,13 @@ export class TestObjectManagementService implements IObjectManagementService { async updateUser(contextId: string, login: ObjectManagement.User): Promise { return this.delayAndResolve(); } + async scriptUser(contextId: string, login: ObjectManagement.User): Promise { + return new Promise((resolve, reject) => { + setTimeout(() => { + reject('generate script for user not supported'); + }, 1000); + }); + } async disposeUserView(contextId: string): Promise { } async rename(connectionUri: string, objectUrn: string, newName: string): Promise { diff --git a/extensions/mssql/src/objectManagement/ui/loginDialog.ts b/extensions/mssql/src/objectManagement/ui/loginDialog.ts index e89ec71504..7119d866e0 100644 --- a/extensions/mssql/src/objectManagement/ui/loginDialog.ts +++ b/extensions/mssql/src/objectManagement/ui/loginDialog.ts @@ -114,6 +114,10 @@ export class LoginDialog extends ObjectManagementDialogBase { + return this.objectManagementService.scriptLogin(this.contextId, this.objectInfo); + } + private initializeGeneralSection(): void { this.nameInput = this.modelView.modelBuilder.inputBox().withProps({ ariaLabel: localizedConstants.NameText, diff --git a/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts b/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts index e36a4be944..1c3c3ed01d 100644 --- a/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts +++ b/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts @@ -16,10 +16,11 @@ import { NodeType, TelemetryActions, TelemetryViews } from '../constants'; import { CreateObjectOperationDisplayName, HelpText, LoadingDialogText, NameText, - NewObjectDialogTitle, ObjectPropertiesDialogTitle, OkText, SelectedText, UpdateObjectOperationDisplayName + NewObjectDialogTitle, ObjectPropertiesDialogTitle, OkText, ScriptError, ScriptGeneratedText, ScriptText, SelectedText, UpdateObjectOperationDisplayName } from '../localizedConstants'; import { deepClone, getNodeTypeDisplayName, refreshNode } from '../utils'; import { TelemetryReporter } from '../../telemetry'; +import { providerId } from '../../constants'; export const DefaultLabelWidth = 150; export const DefaultInputWidth = 300; @@ -47,6 +48,7 @@ export abstract class ObjectManagementDialogBase { await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(docUrl)); })); - this.dialogObject.customButtons = [this._helpButton]; - this.dialogObject.okButton.hidden = true; - this._helpButton.hidden = true; + this._scriptButton = azdata.window.createButton(ScriptText, 'left'); + this.disposables.push(this._scriptButton.onClick(async () => { await this.onScriptButtonClick(); })); + this.dialogObject.customButtons = [this._helpButton, this._scriptButton]; + this.updateLoadingStatus(true); this.contextId = generateUuid(); this.dialogObject.registerCloseValidator(async (): Promise => { const confirmed = await this.onConfirmation(); @@ -83,6 +86,7 @@ export abstract class ObjectManagementDialogBase; protected async onDispose(): Promise { } protected abstract validateInput(): Promise; + protected abstract generateScript(): Promise; /** * Dispose the information related to this view in the backend service. @@ -90,7 +94,7 @@ export abstract class ObjectManagementDialogBase; protected onObjectValueChange(): void { - this.dialogObject.okButton.enabled = JSON.stringify(this.objectInfo) !== JSON.stringify(this._originalObjectInfo); + this.dialogObject.okButton.enabled = this.isDirty; } protected async onConfirmation(): Promise { @@ -175,9 +179,7 @@ export abstract class ObjectManagementDialogBase { + this.updateLoadingStatus(true); + try { + const isValid = await this.runValidation(); + if (!isValid) { + return; + } + const script = await this.generateScript(); + await azdata.queryeditor.openQueryDocument({ content: script }, providerId); + this.dialogObject.message = { + text: ScriptGeneratedText, + level: azdata.window.MessageLevel.Information + }; + } catch (err) { + this.dialogObject.message = { + text: ScriptError(getErrorMessage(err)), + level: azdata.window.MessageLevel.Error + }; + } finally { + this.updateLoadingStatus(false); + } + } + + private get isDirty(): boolean { + return JSON.stringify(this.objectInfo) !== JSON.stringify(this._originalObjectInfo); + } } diff --git a/extensions/mssql/src/objectManagement/ui/userDialog.ts b/extensions/mssql/src/objectManagement/ui/userDialog.ts index 2016f9e886..cede77f1cc 100644 --- a/extensions/mssql/src/objectManagement/ui/userDialog.ts +++ b/extensions/mssql/src/objectManagement/ui/userDialog.ts @@ -88,6 +88,10 @@ export class UserDialog extends ObjectManagementDialogBase { + return this.objectManagementService.scriptUser(this.contextId, this.objectInfo); + } + private initializeGeneralSection(): void { this.nameInput = this.modelView.modelBuilder.inputBox().withProps({ ariaLabel: localizedConstants.NameText,