From d2d24e38275b657e8fcbf7512cbe5b971cd1c152 Mon Sep 17 00:00:00 2001
From: Alan Ren <alanren@microsoft.com>
Date: Fri, 3 Mar 2023 15:34:51 -0800
Subject: [PATCH] dispose view after the operation is done (#22144)

---
 .../mssql/src/objectManagement/ui/loginDialog.ts |  2 +-
 .../ui/objectManagementDialogBase.ts             | 16 +++++++++++++---
 .../mssql/src/objectManagement/ui/userDialog.ts  |  2 +-
 3 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/extensions/mssql/src/objectManagement/ui/loginDialog.ts b/extensions/mssql/src/objectManagement/ui/loginDialog.ts
index 8e4cee0e7a..530f81b980 100644
--- a/extensions/mssql/src/objectManagement/ui/loginDialog.ts
+++ b/extensions/mssql/src/objectManagement/ui/loginDialog.ts
@@ -84,7 +84,7 @@ export class LoginDialog extends ObjectManagementDialogBase<ObjectManagement.Log
 		}
 	}
 
-	protected async onDispose(): Promise<void> {
+	protected async disposeView(): Promise<void> {
 		await this.objectManagementService.disposeLoginView(this.contextId);
 	}
 
diff --git a/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts b/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts
index 576fbca789..ddb4d5b32b 100644
--- a/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts
+++ b/extensions/mssql/src/objectManagement/ui/objectManagementDialogBase.ts
@@ -60,7 +60,7 @@ export abstract class ObjectManagementDialogBase<ObjectInfoType extends ObjectMa
 		const dialogTitle = isNewObject ? NewObjectDialogTitle(objectTypeDisplayName) : ObjectPropertiesDialogTitle(objectTypeDisplayName, objectName);
 		this.dialogObject = azdata.window.createModelViewDialog(dialogTitle, getDialogName(objectType, isNewObject), dialogWidth);
 		this.dialogObject.okButton.label = OkText;
-		this.disposables.push(this.dialogObject.onClosed(async () => { await this.dispose(); }));
+		this.disposables.push(this.dialogObject.onClosed(async (reason: azdata.window.CloseReason) => { await this.dispose(reason); }));
 		this._helpButton = azdata.window.createButton(HelpText, 'left');
 		this.disposables.push(this._helpButton.onClick(async () => {
 			await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(docUrl));
@@ -81,9 +81,14 @@ export abstract class ObjectManagementDialogBase<ObjectInfoType extends ObjectMa
 	protected abstract initializeData(): Promise<ViewInfoType>;
 	protected abstract initializeUI(): Promise<void>;
 	protected abstract onComplete(): Promise<void>;
-	protected abstract onDispose(): Promise<void>;
+	protected async onDispose(): Promise<void> { }
 	protected abstract validateInput(): Promise<string[]>;
 
+	/**
+	 * Dispose the information related to this view in the backend service.
+	 */
+	protected abstract disposeView(): Promise<void>;
+
 	protected onObjectValueChange(): void {
 		this.dialogObject.okButton.enabled = JSON.stringify(this.objectInfo) !== JSON.stringify(this._originalObjectInfo);
 	}
@@ -165,6 +170,8 @@ export abstract class ObjectManagementDialogBase<ObjectInfoType extends ObjectMa
 						TelemetryReporter.createErrorEvent2(TelemetryViews.ObjectManagement, actionName, err).withAdditionalProperties({
 							objectType: this.objectType
 						}).send();
+					} finally {
+						await this.disposeView();
 					}
 				}
 			});
@@ -180,9 +187,12 @@ export abstract class ObjectManagementDialogBase<ObjectInfoType extends ObjectMa
 		}
 	}
 
-	private async dispose(): Promise<void> {
+	private async dispose(reason: azdata.window.CloseReason): Promise<void> {
 		await this.onDispose();
 		this.disposables.forEach(disposable => disposable.dispose());
+		if (reason !== 'ok') {
+			await this.disposeView();
+		}
 	}
 
 	protected async runValidation(showErrorMessage: boolean = true): Promise<boolean> {
diff --git a/extensions/mssql/src/objectManagement/ui/userDialog.ts b/extensions/mssql/src/objectManagement/ui/userDialog.ts
index eec1b51ab6..49fb6f85dc 100644
--- a/extensions/mssql/src/objectManagement/ui/userDialog.ts
+++ b/extensions/mssql/src/objectManagement/ui/userDialog.ts
@@ -69,7 +69,7 @@ export class UserDialog extends ObjectManagementDialogBase<ObjectManagement.User
 		}
 	}
 
-	protected async onDispose(): Promise<void> {
+	protected async disposeView(): Promise<void> {
 		await this.objectManagementService.disposeUserView(this.contextId);
 	}