Support for filtering on branch #8

extension/src/IDetailSettings.d.ts

@@ -15,4 +15,6 @@
 
 interface IDetailSettings {
 	definitionId: number;
+	branch: string;
+	showBranch: boolean;
 }

extension/src/build-details-configuration.ts

@@ -15,6 +15,7 @@
 
 import TFS_Build_Contracts = require("TFS/Build/Contracts");
 import TFS_Build_Client = require("TFS/Build/RestClient");
+import TFS_Git_Client = require("TFS/VersionControl/GitRestClient");
 
 VSS.require(["TFS/Dashboards/WidgetHelpers"], (WidgetHelpers) => {
 	WidgetHelpers.IncludeWidgetConfigurationStyles();
@@ -31,19 +32,33 @@ class DetailsConfiguration {
 	private definitionDropDown = $("#definitionDropDown");
 	private errordropdown = $("#definitionDropDown .validation-error > .validation-error-text");
 
+	private reposDropDown = $("#reposDropDown");
+	private showBranchCheckBox = $("#showBranchCheckBox");
+
+	private detailsSettings: IDetailSettings;
+	private showBranch: boolean = false;
+
 	constructor(public WidgetHelpers) { }
 
 	public async load(widgetSettings, widgetConfigurationContext) {
 		this.widgetConfigurationContext = widgetConfigurationContext;
-		const settings: IDetailSettings = JSON.parse(widgetSettings.customSettings.data);
-		if (!settings || !settings.definitionId) {
+		this.detailsSettings = JSON.parse(widgetSettings.customSettings.data);
+
+		if (!this.detailsSettings || !this.detailsSettings.definitionId) {
 			const options = this.definitionDropDown;
 			const text = "Select a build definition";
 			options.append($("<option style=\"font-style:italic\" />").val(-1).text(text));
 		}
-		await this.loadBuildDefinitions(settings);
-
+		await this.loadBuildDefinitions(this.detailsSettings);
+		this.showBranch = this.detailsSettings.showBranch;
+		if (this.showBranch) {
+			this.showBranchCheckBox.prop("checked", true);
+		} else {
+			this.showBranchCheckBox.prop("checked", false);
+		}
 		this.notifyOnChange(this.definitionDropDown);
+		this.notifyOnReposDropDownChange(this.reposDropDown);
+		this.notifyOnShowBranchChange(this.showBranchCheckBox);
 
 		return this.WidgetHelpers.WidgetStatusHelper.Success();
 	}
@@ -68,10 +83,40 @@ class DetailsConfiguration {
 				options.append($("<option />").val(defRef.id).text(defRef.name));
 			}
 		}
+
+		this.loadBranches();
+	}
+
+	private loadBranches() {
+		if (this.validateQueryDropdown(this.definitionDropDown, this.errordropdown)) {
+			const context = VSS.getWebContext();
+			const buildClient = TFS_Build_Client.getClient();
+			buildClient.getDefinition(this.definitionDropDown.val() as number, context.project.id)
+			.then((def) => {
+				const buildRepo = def.repository;
+
+				const gitClient = TFS_Git_Client.getClient();
+				gitClient.getBranches(buildRepo.id)
+				.then( (branches)  => {
+					const options = this.reposDropDown;
+					options.empty();
+					options.append($("<option style=\"font-style:italic\" />").val(-1).text("Any"));
+
+					for (const b of branches) {
+
+						if (this.detailsSettings && this.detailsSettings.branch && b.name === this.detailsSettings.branch) {
+							options.append($("<option selected/>").val(b.name).text(b.name));
+						} else {
+							options.append($("<option />").val(b.name).text(b.name));
+						}
+					}
+				});
+			});
+		}
 	}
 
 	private validateQueryDropdown($queryDropdown, $errordropdown): boolean {
-		if (this.definitionDropDown.val() === "-1") {
+		if ($queryDropdown.val() === "-1") {
 			const text = "Please select a build definition";
 			$errordropdown.text(text);
 			$errordropdown.parent().css("visibility", "visible");
@@ -85,23 +130,36 @@ class DetailsConfiguration {
 		control.change(() => {
 			if (this.validateQueryDropdown(this.definitionDropDown, this.errordropdown)) {
 				$("#definitionDropDown option[value='-1']").remove();
-				this.widgetConfigurationContext.notify(this.WidgetHelpers.WidgetEvent.ConfigurationChange,
-					this.WidgetHelpers.WidgetEvent.Args(this.getCustomSettings()));
+				this.notifyConfigurationChanged();
+				this.loadBranches();
 			}
 		});
 	}
 
+	private notifyOnShowBranchChange(control) {
+		control.change(() => {
+			this.showBranch = !this.showBranch;
+			this.notifyConfigurationChanged();
+		});
+	}
+
+	private notifyOnReposDropDownChange(control) {
+		control.change(() => {
+			this.notifyConfigurationChanged();
+		});
+	}
+
+	private notifyConfigurationChanged() {
+		this.widgetConfigurationContext.notify(this.WidgetHelpers.WidgetEvent.ConfigurationChange,
+			this.WidgetHelpers.WidgetEvent.Args(this.getCustomSettings()));
+	}
+
 	private getCustomSettings() {
 		const data: IDetailSettings = {
+			branch: this.reposDropDown.val() as string,
 			definitionId: this.definitionDropDown.val() as number,
+			showBranch: this.showBranch,
 		};
 		return { data: JSON.stringify(data) };
 	}
-
-	private onSave() {
-		if (this.definitionDropDown.val() === "-1") {
-			return this.WidgetHelpers.WidgetConfigurationSave.Invalid();
-		}
-		return this.WidgetHelpers.WidgetConfigurationSave.Valid(this.getCustomSettings());
-	}
 }