Agent - Step Actions (#2779)

* fixed right click context menu bug in jobs view

* added stepInfo and edit job WIP

* show jobs in job edit

* added schedule description on select schedule

* fetch schedules during history and show in edit job

* added alerts to job histories and show in edit

* made history calls async

* filter menus now close when esc is pressed

* fixed bug where clicking on error row wouldnt populate job details

* added functionality to delete steps in a job

* added real time adding steps in edit job

extensions/agent/src/data/jobStepData.ts

@@ -6,37 +6,47 @@
 
 import { AgentUtils } from '../agentUtils';
 import { IAgentDialogData, AgentDialogMode } from '../interfaces';
+import { JobData } from './jobData';
+import * as nls from 'vscode-nls';
+
+const localize = nls.loadMessageBundle();
 
 export class JobStepData implements IAgentDialogData {
+
+	// Error Messages
+	private readonly CreateStepErrorMessage_JobNameIsEmpty = localize('stepData.jobNameRequired', 'Job name must be provided');
+	private readonly CreateStepErrorMessage_StepNameIsEmpty = localize('stepData.stepNameRequired', 'Step name must be provided');
+
 	public dialogMode: AgentDialogMode = AgentDialogMode.CREATE;
 	public ownerUri: string;
-	public jobId: string; //
+	public jobId: string;
 	public jobName: string;
-	public script: string; //
+	public script: string;
 	public scriptName: string;
-	public stepName: string; //
-	public subSystem: string; //
+	public stepName: string;
+	public subSystem: string;
 	public id: number;
-	public failureAction: string; //
-	public successAction: string; //
+	public failureAction: string;
+	public successAction: string;
 	public failStepId: number;
 	public successStepId: number;
 	public command: string;
 	public commandExecutionSuccessCode: number;
-	public databaseName: string; //
+	public databaseName: string;
 	public databaseUserName: string;
 	public server: string;
-	public outputFileName: string; //
+	public outputFileName: string;
 	public appendToLogFile: boolean;
 	public appendToStepHist: boolean;
 	public writeLogToTable: boolean;
 	public appendLogToTable: boolean;
-	public retryAttempts: number; //
-	public retryInterval: number; //
+	public retryAttempts: number;
+	public retryInterval: number;
 	public proxyName: string;
 
-	constructor(ownerUri:string) {
+	constructor(ownerUri:string, jobModel?: JobData) {
 		this.ownerUri = ownerUri;
+		this.jobName = jobModel.name;
 	}
 
 	public async initialize() {
@@ -51,7 +61,7 @@ export class JobStepData implements IAgentDialogData {
 			scriptName: this.scriptName,
 			stepName: this.stepName,
 			subSystem: this.subSystem,
-			id: 1,
+			id: this.id,
 			failureAction: this.failureAction,
 			successAction: this.successAction,
 			failStepId: this.failStepId,
@@ -70,7 +80,26 @@ export class JobStepData implements IAgentDialogData {
 			retryInterval: this.retryInterval,
 			proxyName: this.proxyName
 		}).then(result => {
-			console.info(result);
+			if (result && result.success) {
+				console.info(result);
+			}
 		});
 	}
+
+	public validate(): { valid: boolean, errorMessages: string[] } {
+		let validationErrors: string[] = [];
+
+		if (!(this.stepName && this.stepName.trim())) {
+			validationErrors.push(this.CreateStepErrorMessage_StepNameIsEmpty);
+		}
+
+		if (!(this.jobName && this.jobName.trim())) {
+			validationErrors.push(this.CreateStepErrorMessage_JobNameIsEmpty);
+		}
+
+		return {
+			valid: validationErrors.length === 0,
+			errorMessages: validationErrors
+		};
+	}
 }

extensions/agent/src/dialogs/agentDialog.ts

@@ -49,10 +49,8 @@ export abstract class AgentDialog<T extends IAgentDialogData> {
 
 	protected async execute() {
 		this.updateModel();
-		let success = await this.model.save();
-		if (success) {
-			this._onSuccess.fire(this.model);
-		}
+		await this.model.save();
+		this._onSuccess.fire(this.model);
 	}
 
 	protected async cancel() {

extensions/agent/src/dialogs/jobDialog.ts

@@ -10,6 +10,7 @@ import { JobStepDialog } from './jobStepDialog';
 import { PickScheduleDialog } from './pickScheduleDialog';
 import { AlertDialog } from './alertDialog';
 import { AgentDialog } from './agentDialog';
+import { AgentUtils } from '../agentUtils';
 
 const localize = nls.loadMessageBundle();
 
@@ -234,10 +235,14 @@ export class JobDialog extends AgentDialog<JobData>  {
 				width: 80
 			}).component();
 
+			let stepDialog = new JobStepDialog(this.model.ownerUri, '' , data.length + 1, this.model);
+			stepDialog.onSuccess((step) => {
+				this.model.jobSteps.push(step);
+				this.stepsTable.data = this.convertStepsToData(this.model.jobSteps);
+			});
 			this.newStepButton.onDidClick((e)=>{
 				if (this.nameTextBox.value && this.nameTextBox.value.length > 0) {
-					let stepDialog = new JobStepDialog(this.model.ownerUri, this.nameTextBox.value, '' , 1, this.model);
-					stepDialog.openNewStepDialog();
+					stepDialog.openDialog();
 				} else {
 					this.dialog.message = { text: this.BlankJobNameErrorText };
 				}
@@ -273,9 +278,17 @@ export class JobDialog extends AgentDialog<JobData>  {
 					});
 
 					this.deleteStepButton.onDidClick((e) => {
-						// implement delete steps
-
-
+						AgentUtils.getAgentService().then((agentService) => {
+							let steps = this.model.jobSteps ? this.model.jobSteps : [];
+							agentService.deleteJobStep(this.ownerUri, stepData).then((result) => {
+								if (result && result.success) {
+									delete steps[rowNumber];
+									this.model.jobSteps = steps;
+									let data = this.convertStepsToData(steps);
+									this.stepsTable.data = data;
+								}
+							});
+						});
 					});
 				}
 			});
@@ -529,7 +542,6 @@ export class JobDialog extends AgentDialog<JobData>  {
 		let result = [];
 		alerts.forEach(alert => {
 			let cols = [];
-			console.log(alert);
 			cols.push(alert.name);
 			cols.push(alert.isEnabled);
 			cols.push(alert.alertType.toString());

extensions/agent/src/dialogs/jobStepDialog.ts

@@ -9,11 +9,12 @@ import * as vscode from 'vscode';
 import { JobStepData } from '../data/jobStepData';
 import { AgentUtils } from '../agentUtils';
 import { JobData } from '../data/jobData';
+import { AgentDialog } from './agentDialog';
 const path = require('path');
 
 const localize = nls.loadMessageBundle();
 
-export class JobStepDialog {
+export class JobStepDialog extends AgentDialog<JobStepData> {
 
 	// TODO: localize
 	// Top level
@@ -67,7 +68,6 @@ export class JobStepDialog {
 	// UI Components
 
 	// Dialogs
-	private dialog: sqlops.window.modelviewdialog.Dialog;
 	private fileBrowserDialog: sqlops.window.modelviewdialog.Dialog;
 
 	// Dialog tabs
@@ -105,35 +105,27 @@ export class JobStepDialog {
 
 	private fileBrowserTree: sqlops.FileBrowserTreeComponent;
 	private jobModel: JobData;
-	private model: JobStepData;
-	private ownerUri: string;
 	private jobName: string;
 	private server: string;
 	private stepId: number;
 
 	constructor(
 		ownerUri: string,
-		jobName: string,
 		server: string,
 		stepId: number,
 		jobModel?: JobData
 	) {
-		this.model = new JobStepData(ownerUri);
+		super(ownerUri, new JobStepData(ownerUri, jobModel), 'New Step');
 		this.stepId = stepId;
-		this.ownerUri = ownerUri;
-		this.jobName = jobName;
+		this.jobName = jobModel.name;
 		this.server = server;
 		this.jobModel = jobModel;
 	}
 
 	private initializeUIComponents() {
-		this.dialog = sqlops.window.modelviewdialog.createDialog(this.DialogTitle);
 		this.generalTab = sqlops.window.modelviewdialog.createTab(this.GeneralTabText);
 		this.advancedTab = sqlops.window.modelviewdialog.createTab(this.AdvancedTabText);
 		this.dialog.content = [this.generalTab, this.advancedTab];
-		this.dialog.okButton.onClick(async () => await this.execute());
-		this.dialog.okButton.label = this.OkButtonText;
-		this.dialog.cancelButton.label = this.CancelButtonText;
 	}
 
 	private createCommands(view, queryProvider: sqlops.QueryProvider) {
@@ -478,7 +470,7 @@ export class JobStepDialog {
 		return outputFileForm;
 	}
 
-	protected execute() {
+	protected updateModel() {
 		this.model.stepName = this.nameTextBox.value;
 		if (!this.model.stepName || this.model.stepName.length === 0) {
 			this.dialog.message = this.dialog.message = { text: this.BlankStepNameErrorText };
@@ -499,12 +491,20 @@ export class JobStepDialog {
 		this.model.appendToLogFile = this.appendToExistingFileCheckbox.checked;
 	}
 
-	public async openNewStepDialog() {
+	public async initializeDialog() {
 		let databases = await AgentUtils.getDatabases(this.ownerUri);
 		let queryProvider = await AgentUtils.getQueryProvider();
 		this.initializeUIComponents();
 		this.createGeneralTab(databases, queryProvider);
 		this.createAdvancedTab();
-		sqlops.window.modelviewdialog.openDialog(this.dialog);
+		this.dialog.registerCloseValidator(() => {
+			this.updateModel();
+			let validationResult = this.model.validate();
+			if (!validationResult.valid) {
+				// TODO: Show Error Messages
+				console.error(validationResult.errorMessages.join(','));
+			}
+			return validationResult.valid;
+		});
 	}
 }

extensions/agent/src/dialogs/pickScheduleDialog.ts

@@ -74,7 +74,6 @@ export class PickScheduleDialog {
 				let data: any[][] = [];
 				for (let i = 0; i < this.model.schedules.length; ++i) {
 					let schedule = this.model.schedules[i];
-					console.log(schedule);
 					data[i] = [ schedule.id, schedule.name, schedule.description ];
 				}
 				this.schedulesTable.data = data;

extensions/agent/src/interfaces.ts

@@ -13,5 +13,5 @@ export enum AgentDialogMode {
 export interface IAgentDialogData {
 	dialogMode: AgentDialogMode;
 	initialize(): void;
-	save(): void;
+	save(): Promise<void>;
 }

extensions/agent/src/mainController.ts

@@ -40,9 +40,9 @@ export class MainController {
             let dialog = new JobDialog(ownerUri, jobInfo);
             dialog.openDialog();
         });
-        vscode.commands.registerCommand('agent.openNewStepDialog', (ownerUri: string, jobId: string, server: string, stepId: number) => {
-			let dialog = new JobStepDialog(ownerUri, jobId, server, stepId);
-			dialog.openNewStepDialog();
+        vscode.commands.registerCommand('agent.openNewStepDialog', (ownerUri: string, server: string, stepId: number) => {
+			let dialog = new JobStepDialog(ownerUri, server, stepId);
+			dialog.openDialog();
         });
         vscode.commands.registerCommand('agent.openPickScheduleDialog', (ownerUri: string) => {
             let dialog = new PickScheduleDialog(ownerUri);
@@ -57,9 +57,8 @@ export class MainController {
             dialog.openDialog();
         });
         vscode.commands.registerCommand('agent.openProxyDialog', (ownerUri: string, proxyInfo: sqlops.AgentProxyInfo, credentials: sqlops.CredentialInfo[]) => {
-            //@TODO: reenable create proxy after snapping July release (7/14/18)
-            // let dialog = new ProxyDialog(ownerUri, proxyInfo, credentials);
-            // dialog.openDialog();
+            let dialog = new ProxyDialog(ownerUri, proxyInfo, credentials);
+            dialog.openDialog();
             MainController.showNotYetImplemented();
         });
     }