wizard for deploying bdc (#7183)

* wip * wip2 * wip eod 820 * wip 822 * text component improvements and misc changes * aria-label * targetClusterPage wip * target cluster page * target cluster page * wip 827 * wip deployment profile page * profile page * service settings page * wip 0903 * 0909 wip * 0910 * 0911 * sql instance and working directory * notebooks * docker version on windows * EULA env var * 917 updates * address comments * use async file access * fix the summary page display issue for ad auth * add save json file buttons * use promise for private methds * review feedbacks * refactor * pass json to notebooks * fix no tool scenario * bypass tool check if installed * update hint text * update notebooks * workaround azdata first time use * comments * accept eula and some text update * fix the error in package.json * promise instead of thenable * comments * fix typo
2026-02-16 10:58:30 -05:00 · 2019-09-25 10:04:13 -07:00
parent 6a6048d40f
commit a0e31fc723
51 changed files with 4137 additions and 855 deletions
--- a/extensions/resource-deployment/src/ui/wizardBase.ts
+++ b/extensions/resource-deployment/src/ui/wizardBase.ts
@@ -0,0 +1,90 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as azdata from 'azdata';
+import * as vscode from 'vscode';
+import * as nls from 'vscode-nls';
+import { WizardPageBase } from './wizardPageBase';
+import { Model } from './model';
+const localize = nls.loadMessageBundle();
+
+export abstract class WizardBase<T, M extends Model> {
+	private customButtons: azdata.window.Button[] = [];
+	private pages: WizardPageBase<T>[] = [];
+
+	public wizardObject: azdata.window.Wizard;
+	public toDispose: vscode.Disposable[] = [];
+	public get model(): M {
+		return this._model;
+	}
+
+	constructor(private title: string, private _model: M) {
+		this.wizardObject = azdata.window.createWizard(title);
+	}
+
+	public open(): Thenable<void> {
+		this.initialize();
+		this.wizardObject.customButtons = this.customButtons;
+		this.toDispose.push(this.wizardObject.onPageChanged((e) => {
+			let previousPage = this.pages[e.lastPage];
+			let newPage = this.pages[e.newPage];
+			previousPage.onLeave();
+			newPage.onEnter();
+		}));
+
+		this.toDispose.push(this.wizardObject.doneButton.onClick(() => {
+			this.onOk();
+			this.dispose();
+		}));
+		this.toDispose.push(this.wizardObject.cancelButton.onClick(() => {
+			this.onCancel();
+			this.dispose();
+		}));
+
+		return this.wizardObject.open().then(() => {
+			if (this.pages && this.pages.length > 0) {
+				this.pages[0].onEnter();
+			}
+		});
+
+	}
+
+	protected abstract initialize(): void;
+	protected abstract onOk(): void;
+	protected abstract onCancel(): void;
+
+	public addButton(button: azdata.window.Button) {
+		this.customButtons.push(button);
+	}
+
+	protected setPages(pages: WizardPageBase<T>[]) {
+		this.wizardObject!.pages = pages.map(p => p.pageObject);
+		this.pages = pages;
+		this.pages.forEach((page) => {
+			page.initialize();
+		});
+	}
+
+	private dispose() {
+		let errorOccured = false;
+		this.toDispose.forEach((disposable: vscode.Disposable) => {
+			try {
+				disposable.dispose();
+			}
+			catch (error) {
+				errorOccured = true;
+				console.error(error);
+			}
+		});
+
+		if (errorOccured) {
+			vscode.window.showErrorMessage(localize('resourceDeployment.DisposableError', "Error occured while closing the wizard: {0}, open 'Debugger Console' for more information."), this.title);
+		}
+	}
+
+	public registerDisposable(disposable: vscode.Disposable): void {
+		this.toDispose.push(disposable);
+	}
+}