ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-17 02:51:36 -05:00
Code Issues Packages Projects Releases Wiki Activity

Adding wizard step telemetry for sql migration wizard (#16469)

Browse Source 
* Adding wizard step telemetry for sql migration wizard

* Refactoring event name

* refactoring function name
This commit is contained in:
Aasim Khan
2021-07-29 10:14:45 -07:00
committed by GitHub
parent 0e9d956ee5
commit 39f65b1881
2 changed files with 61 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
extensions/sql-migration/src/telemtery.ts
View File

@@ -19,7 +19,8 @@ export enum TelemetryViews {
MigrationWizardAccountSelectionPage = 'MigrationWizardAccountSelectionPage', MigrationWizardAccountSelectionPage = 'MigrationWizardAccountSelectionPage',
MigrationWizardTargetSelectionPage = 'MigrationWizardTargetSelectionPage', MigrationWizardTargetSelectionPage = 'MigrationWizardTargetSelectionPage',
MigrationWizardSummaryPage = 'MigrationWizardSummaryPage', MigrationWizardSummaryPage = 'MigrationWizardSummaryPage',
StartMigrationService = 'StartMigrationSerivce' StartMigrationService = 'StartMigrationSerivce',
SqlMigrationWizard = 'SqlMigrationWizard'
} }
export enum TelemetryAction { export enum TelemetryAction {
@@ -32,7 +33,8 @@ export enum TelemetryAction {
StartMigration = 'StartMigration', StartMigration = 'StartMigration',
CutoverMigration = 'CutoverMigration', CutoverMigration = 'CutoverMigration',
CancelMigration = 'CancelMigration', CancelMigration = 'CancelMigration',
MigrationStatus = 'MigrationStatus' MigrationStatus = 'MigrationStatus',
PageButtonClick = 'PageButtonClick'
} }
export function sendSqlMigrationActionEvent(telemetryView: TelemetryViews, telemetryAction: TelemetryAction, additionalProps: TelemetryEventProperties, additionalMeasurements: TelemetryEventMeasures): void { export function sendSqlMigrationActionEvent(telemetryView: TelemetryViews, telemetryAction: TelemetryAction, additionalProps: TelemetryEventProperties, additionalMeasurements: TelemetryEventMeasures): void {

76
extensions/sql-migration/src/wizard/wizardController.ts
View File

@@ -15,9 +15,12 @@ import { IntergrationRuntimePage } from './integrationRuntimePage';
import { SummaryPage } from './summaryPage'; import { SummaryPage } from './summaryPage';
import { MigrationModePage } from './migrationModePage'; import { MigrationModePage } from './migrationModePage';
import { DatabaseSelectorPage } from './databaseSelectorPage'; import { DatabaseSelectorPage } from './databaseSelectorPage';
import { sendSqlMigrationActionEvent, TelemetryAction, TelemetryViews } from '../telemtery';
export const WIZARD_INPUT_COMPONENT_WIDTH = '600px'; export const WIZARD_INPUT_COMPONENT_WIDTH = '600px';
export class WizardController { export class WizardController {
private _wizardObject!: azdata.window.Wizard;
private _model!: MigrationStateModel;
constructor(private readonly extensionContext: vscode.ExtensionContext) { constructor(private readonly extensionContext: vscode.ExtensionContext) {
} }
@@ -25,24 +28,24 @@ export class WizardController {
public async openWizard(connectionId: string): Promise<void> { public async openWizard(connectionId: string): Promise<void> {
const api = (await vscode.extensions.getExtension(mssql.extension.name)?.activate()) as mssql.IExtension; const api = (await vscode.extensions.getExtension(mssql.extension.name)?.activate()) as mssql.IExtension;
if (api) { if (api) {
const stateModel = new MigrationStateModel(this.extensionContext, connectionId, api.sqlMigration); this._model = new MigrationStateModel(this.extensionContext, connectionId, api.sqlMigration);
this.extensionContext.subscriptions.push(stateModel); this.extensionContext.subscriptions.push(this._model);
this.createWizard(stateModel); this.createWizard(this._model);
} }
} }
private async createWizard(stateModel: MigrationStateModel): Promise<void> { private async createWizard(stateModel: MigrationStateModel): Promise<void> {
const serverName = (await stateModel.getSourceConnectionProfile()).serverName; const serverName = (await stateModel.getSourceConnectionProfile()).serverName;
const wizard = azdata.window.createWizard(loc.WIZARD_TITLE(serverName), 'MigrationWizard', 'wide'); this._wizardObject = azdata.window.createWizard(loc.WIZARD_TITLE(serverName), 'MigrationWizard', 'wide');
wizard.generateScriptButton.enabled = false; this._wizardObject.generateScriptButton.enabled = false;
wizard.generateScriptButton.hidden = true; this._wizardObject.generateScriptButton.hidden = true;
const skuRecommendationPage = new SKURecommendationPage(wizard, stateModel); const skuRecommendationPage = new SKURecommendationPage(this._wizardObject, stateModel);
const migrationModePage = new MigrationModePage(wizard, stateModel); const migrationModePage = new MigrationModePage(this._wizardObject, stateModel);
const databaseSelectorPage = new DatabaseSelectorPage(wizard, stateModel); const databaseSelectorPage = new DatabaseSelectorPage(this._wizardObject, stateModel);
const azureAccountsPage = new AccountsSelectionPage(wizard, stateModel); const azureAccountsPage = new AccountsSelectionPage(this._wizardObject, stateModel);
const databaseBackupPage = new DatabaseBackupPage(wizard, stateModel); const databaseBackupPage = new DatabaseBackupPage(this._wizardObject, stateModel);
const integrationRuntimePage = new IntergrationRuntimePage(wizard, stateModel); const integrationRuntimePage = new IntergrationRuntimePage(this._wizardObject, stateModel);
const summaryPage = new SummaryPage(wizard, stateModel); const summaryPage = new SummaryPage(this._wizardObject, stateModel);
const pages: MigrationWizardPage[] = [ const pages: MigrationWizardPage[] = [
azureAccountsPage, azureAccountsPage,
@@ -54,21 +57,21 @@ export class WizardController {
summaryPage summaryPage
]; ];
wizard.pages = pages.map(p => p.getwizardPage()); this._wizardObject.pages = pages.map(p => p.getwizardPage());
const wizardSetupPromises: Thenable<void>[] = []; const wizardSetupPromises: Thenable<void>[] = [];
wizardSetupPromises.push(...pages.map(p => p.registerWizardContent())); wizardSetupPromises.push(...pages.map(p => p.registerWizardContent()));
wizardSetupPromises.push(wizard.open()); wizardSetupPromises.push(this._wizardObject.open());
this.extensionContext.subscriptions.push(wizard.onPageChanged(async (pageChangeInfo: azdata.window.WizardPageChangeInfo) => { this.extensionContext.subscriptions.push(this._wizardObject.onPageChanged(async (pageChangeInfo: azdata.window.WizardPageChangeInfo) => {
const newPage = pageChangeInfo.newPage; const newPage = pageChangeInfo.newPage;
const lastPage = pageChangeInfo.lastPage; const lastPage = pageChangeInfo.lastPage;
this.sendPageButtonClickEvent(pageChangeInfo).catch(e => console.log(e));
await pages[lastPage]?.onPageLeave(); await pages[lastPage]?.onPageLeave();
await pages[newPage]?.onPageEnter(); await pages[newPage]?.onPageEnter();
})); }));
wizard.registerNavigationValidator(async validator => { this._wizardObject.registerNavigationValidator(async validator => {
// const lastPage = validator.lastPage; // const lastPage = validator.lastPage;
// const canLeave = await pages[lastPage]?.canLeave() ?? true; // const canLeave = await pages[lastPage]?.canLeave() ?? true;
@@ -81,9 +84,44 @@ export class WizardController {
await Promise.all(wizardSetupPromises); await Promise.all(wizardSetupPromises);
await pages[0].onPageEnter(); await pages[0].onPageEnter();
this.extensionContext.subscriptions.push(wizard.doneButton.onClick(async (e) => { this.extensionContext.subscriptions.push(this._wizardObject.doneButton.onClick(async (e) => {
await stateModel.startMigration(); await stateModel.startMigration();
})); }));
this._wizardObject.cancelButton.onClick(e => {
sendSqlMigrationActionEvent(
TelemetryViews.SqlMigrationWizard,
TelemetryAction.PageButtonClick,
{
'sessionId': this._model._sessionId,
'buttonPressed': 'cancel',
'pageTitle': this._wizardObject.pages[this._wizardObject.currentPage].title
}, {});
});
this._wizardObject.doneButton.onClick(e => {
sendSqlMigrationActionEvent(
TelemetryViews.SqlMigrationWizard,
TelemetryAction.PageButtonClick,
{
'sessionId': this._model._sessionId,
'buttonPressed': 'done',
'pageTitle': this._wizardObject.pages[this._wizardObject.currentPage].title
}, {});
});
}
private async sendPageButtonClickEvent(pageChangeInfo: azdata.window.WizardPageChangeInfo) {
const buttonPressed = pageChangeInfo.newPage > pageChangeInfo.lastPage ? 'next' : 'prev';
const pageTitle = this._wizardObject.pages[pageChangeInfo.lastPage].title;
sendSqlMigrationActionEvent(
TelemetryViews.SqlMigrationWizard,
TelemetryAction.PageButtonClick,
{
'sessionId': this._model._sessionId,
'buttonPressed': buttonPressed,
'pageTitle': pageTitle
}, {});
} }
} }