Feature: Allow deleting local Git branches (#14059)

ferrariofilippo · web-flow · commit e1be096dffb7 · 2023-11-27T10:19:38.000-05:00
diff --git a/src/Files.App/Converters/MultiBooleanConverter.cs b/src/Files.App/Converters/MultiBooleanConverter.cs
@@ -22,6 +22,9 @@ public static Boolean OrAndConvert(bool a, bool b, bool c)
 		public static Visibility OrConvertToVisibility(bool a, bool b)
 			=> (a || b) ? Visibility.Visible : Visibility.Collapsed;
 
+		public static Visibility NorConvertToVisibility(bool a, bool b)
+			=> !(a || b) ? Visibility.Visible : Visibility.Collapsed;
+
 		public static Visibility OrNotConvertToVisibility(bool a, bool b)
 			=> OrConvertToVisibility(a, !b);
 	}
diff --git a/src/Files.App/Data/Items/BranchItem.cs b/src/Files.App/Data/Items/BranchItem.cs
@@ -3,5 +3,5 @@
 
 namespace Files.App.Data.Items
 {
-	public record BranchItem(string Name, bool IsRemote, int? AheadBy, int? BehindBy);
+	public record BranchItem(string Name, bool IsHead, bool IsRemote, int? AheadBy, int? BehindBy);
 }
diff --git a/src/Files.App/Data/Models/DirectoryPropertiesViewModel.cs b/src/Files.App/Data/Models/DirectoryPropertiesViewModel.cs
@@ -14,9 +14,9 @@ public class DirectoryPropertiesViewModel : ObservableObject
 
 		private string? _gitRepositoryPath;
 
-		private readonly ObservableCollection<string> _localBranches = new();
+		private readonly ObservableCollection<BranchItem> _localBranches = new();
 
-		private readonly ObservableCollection<string> _remoteBranches = new();
+		private readonly ObservableCollection<BranchItem> _remoteBranches = new();
 
 		public bool IsBranchesFlyoutExpaned { get; set; } = false;
 
@@ -43,9 +43,9 @@ public int SelectedBranchIndex
 				if (SetProperty(ref _SelectedBranchIndex, value) && 
 					value != -1 && 
 					(value != ACTIVE_BRANCH_INDEX || !_ShowLocals) &&
-					value < BranchesNames.Count)
+					value < Branches.Count)
 				{
-					CheckoutRequested?.Invoke(this, BranchesNames[value]);
+					CheckoutRequested?.Invoke(this, Branches[value].Name);
 				}
 			}
 		}
@@ -58,7 +58,7 @@ public bool ShowLocals
 			{
 				if (SetProperty(ref _ShowLocals, value))
 				{
-					OnPropertyChanged(nameof(BranchesNames));
+					OnPropertyChanged(nameof(Branches));
 
 					if (value)
 						SelectedBranchIndex = ACTIVE_BRANCH_INDEX;
@@ -80,7 +80,7 @@ public string ExtendedStatusInfo
 			set => SetProperty(ref _ExtendedStatusInfo, value);
 		}
 
-		public ObservableCollection<string> BranchesNames => _ShowLocals 
+		public ObservableCollection<BranchItem> Branches => _ShowLocals 
 			? _localBranches 
 			: _remoteBranches;
 
@@ -91,7 +91,7 @@ public string ExtendedStatusInfo
 		public DirectoryPropertiesViewModel()
 		{
 			NewBranchCommand = new AsyncRelayCommand(()
-				=> GitHelpers.CreateNewBranchAsync(_gitRepositoryPath!, _localBranches[ACTIVE_BRANCH_INDEX]));
+				=> GitHelpers.CreateNewBranchAsync(_gitRepositoryPath!, _localBranches[ACTIVE_BRANCH_INDEX].Name));
 		}
 
 		public void UpdateGitInfo(bool isGitRepository, string? repositoryPath, BranchItem? head)
@@ -128,12 +128,17 @@ public async Task LoadBranches()
 			foreach (var branch in branches)
 			{
 				if (branch.IsRemote)
-					_remoteBranches.Add(branch.Name);
+					_remoteBranches.Add(branch);
 				else
-					_localBranches.Add(branch.Name);
+					_localBranches.Add(branch);
 			}
 
 			SelectedBranchIndex = ShowLocals ? ACTIVE_BRANCH_INDEX : -1;
 		}
+
+		public Task ExecuteDeleteBranch(string? branchName)
+		{
+			return GitHelpers.DeleteBranchAsync(_gitRepositoryPath, GitBranchDisplayName, branchName);
+		}
 	}
 }
diff --git a/src/Files.App/Helpers/Dialog/DynamicDialogFactory.cs b/src/Files.App/Helpers/Dialog/DynamicDialogFactory.cs
@@ -291,5 +291,25 @@ public static DynamicDialog GetFor_GitCannotInitializeqRepositoryHere()
 				DynamicButtons = DynamicDialogButtons.Primary
 			});
 		}
+
+		public static DynamicDialog GetFor_DeleteGitBranchConfirmation(string branchName)
+		{
+			DynamicDialog dialog = null!;
+			dialog = new DynamicDialog(new DynamicDialogViewModel()
+			{
+				TitleText = "GitDeleteBranch".GetLocalizedResource(),
+				SubtitleText = string.Format("GitDeleteBranchSubtitle".GetLocalizedResource(), branchName),
+				PrimaryButtonText = "OK".GetLocalizedResource(),
+				CloseButtonText = "Cancel".GetLocalizedResource(),
+				AdditionalData = true,
+				CloseButtonAction = (vm, e) =>
+				{
+					dialog.ViewModel.AdditionalData = false;
+					vm.HideDialog();
+				}
+			});
+
+			return dialog;
+		}
 	}
 }
diff --git a/src/Files.App/Strings/en-US/Resources.resw b/src/Files.App/Strings/en-US/Resources.resw
@@ -3614,6 +3614,12 @@
   <data name="FailedToSetBackground" xml:space="preserve">
     <value>Failed to set the background wallpaper</value>
   </data>
+  <data name="GitDeleteBranch" xml:space="preserve">
+    <value>Delete Git branch</value>
+  </data>
+  <data name="GitDeleteBranchSubtitle" xml:space="preserve">
+    <value>Are you sure you want to permanently delete "{0}" branch?</value>
+  </data>
   <data name="ConnectedToGitHub" xml:space="preserve">
     <value>Connected to GitHub</value>
   </data>
diff --git a/src/Files.App/UserControls/StatusBarControl.xaml b/src/Files.App/UserControls/StatusBarControl.xaml
@@ -5,6 +5,7 @@
 	xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
 	xmlns:converters="using:Files.App.Converters"
 	xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+	xmlns:data="using:Files.App.Data.Items"
 	xmlns:helpers="using:Files.App.Helpers"
 	xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
 	xmlns:usercontrols="using:Files.App.UserControls"
@@ -350,9 +351,37 @@
 							Background="{ThemeResource CardBackgroundFillColorDefaultBrush}"
 							IsItemClickEnabled="True"
 							ItemClick="BranchesList_ItemClick"
-							ItemsSource="{x:Bind DirectoryPropertiesViewModel.BranchesNames, Mode=OneWay}"
+							ItemsSource="{x:Bind DirectoryPropertiesViewModel.Branches, Mode=OneWay}"
 							SelectedIndex="{x:Bind DirectoryPropertiesViewModel.SelectedBranchIndex, Mode=TwoWay}"
-							SelectionMode="Single" />
+							SelectionMode="Single">
+
+							<ListView.ItemTemplate>
+								<DataTemplate x:DataType="data:BranchItem">
+									<Grid HorizontalAlignment="Stretch">
+										<Grid.ColumnDefinitions>
+											<ColumnDefinition />
+											<ColumnDefinition Width="Auto" />
+										</Grid.ColumnDefinitions>
+
+										<TextBlock
+											VerticalAlignment="Center"
+											Text="{x:Bind Name}"
+											TextTrimming="CharacterEllipsis" />
+										<Button
+											Grid.Column="1"
+											AutomationProperties.Name="{helpers:ResourceString Name=Delete}"
+											Background="Transparent"
+											BorderBrush="Transparent"
+											Click="DeleteBranch_Click"
+											ToolTipService.ToolTip="{helpers:ResourceString Name=Delete}"
+											Visibility="{x:Bind converters:MultiBooleanConverter.NorConvertToVisibility(IsHead, IsRemote)}">
+											<FontIcon FontSize="12" Glyph="&#xE74D;" />
+										</Button>
+									</Grid>
+								</DataTemplate>
+							</ListView.ItemTemplate>
+
+						</ListView>
 					</Grid>
 				</Flyout>
 			</Button.Flyout>
diff --git a/src/Files.App/UserControls/StatusBarControl.xaml.cs b/src/Files.App/UserControls/StatusBarControl.xaml.cs
@@ -68,5 +68,14 @@ private void BranchesFlyout_Closing(object _, object e)
 
 			DirectoryPropertiesViewModel.IsBranchesFlyoutExpaned = false;
 		}
+
+		private async void DeleteBranch_Click(object sender, RoutedEventArgs e)
+		{
+			if (DirectoryPropertiesViewModel is null)
+				return;
+
+			BranchesFlyout.Hide();
+			await DirectoryPropertiesViewModel.ExecuteDeleteBranch(((BranchItem)((Button)sender).DataContext).Name);
+		}
 	}
 }
diff --git a/src/Files.App/Utils/Git/GitHelpers.cs b/src/Files.App/Utils/Git/GitHelpers.cs
@@ -138,14 +138,14 @@ public static async Task<BranchItem[]> GetBranchesNames(string? path)
 						.OrderByDescending(b => b.Tip?.Committer.When)
 						.Take(MAX_NUMBER_OF_BRANCHES)
 						.OrderByDescending(b => b.IsCurrentRepositoryHead)
-						.Select(b => new BranchItem(b.FriendlyName, b.IsRemote, TryGetTrackingDetails(b)?.AheadBy ?? 0, TryGetTrackingDetails(b)?.BehindBy ?? 0))
+						.Select(b => new BranchItem(b.FriendlyName, b.IsCurrentRepositoryHead, b.IsRemote, TryGetTrackingDetails(b)?.AheadBy ?? 0, TryGetTrackingDetails(b)?.BehindBy ?? 0))
 						.ToArray();
-				} 
+				}
 				catch (Exception)
 				{
 					result = GitOperationResult.GenericError;
 				}
-				
+
 				return (result, branches);
 			});
 
@@ -165,7 +165,13 @@ public static async Task<BranchItem[]> GetBranchesNames(string? path)
 					using var repository = new Repository(path);
 					var branch = GetValidBranches(repository.Branches).FirstOrDefault(b => b.IsCurrentRepositoryHead);
 					if (branch is not null)
-						head = new BranchItem(branch.FriendlyName, branch.IsRemote, TryGetTrackingDetails(branch)?.AheadBy ?? 0, TryGetTrackingDetails(branch)?.BehindBy ?? 0);
+						head = new BranchItem(
+							branch.FriendlyName,
+							branch.IsCurrentRepositoryHead,
+							branch.IsRemote,
+							TryGetTrackingDetails(branch)?.AheadBy ?? 0,
+							TryGetTrackingDetails(branch)?.BehindBy ?? 0
+						);
 				}
 				catch
 				{
@@ -280,6 +286,45 @@ await Checkout(repositoryPath, viewModel.BasedOn))
 			IsExecutingGitAction = false;
 		}
 
+		public static async Task DeleteBranchAsync(string? repositoryPath, string? activeBranch, string? branchToDelete)
+		{
+			Analytics.TrackEvent("Triggered delete git branch");
+
+			if (string.IsNullOrWhiteSpace(repositoryPath) ||
+				string.IsNullOrWhiteSpace(activeBranch) ||
+				string.IsNullOrWhiteSpace(branchToDelete) ||
+				activeBranch.Equals(branchToDelete, StringComparison.OrdinalIgnoreCase) ||
+				!Repository.IsValid(repositoryPath))
+			{
+				return;
+			}
+
+			var dialog = DynamicDialogFactory.GetFor_DeleteGitBranchConfirmation(branchToDelete);
+			await dialog.TryShowAsync();
+			if (!(dialog.ViewModel.AdditionalData as bool? ?? false))
+				return;
+
+			IsExecutingGitAction = true;
+
+			await PostMethodToThreadWithMessageQueueAsync<GitOperationResult>(() =>
+			{
+				try
+				{
+					using var repository = new Repository(repositoryPath);
+					repository.Branches.Remove(branchToDelete);
+				}
+				catch (Exception)
+				{
+					return GitOperationResult.GenericError;
+				}
+
+				return GitOperationResult.Success;
+			});
+
+			IsExecutingGitAction = false;
+		}
+
+
 		public static bool ValidateBranchNameForRepository(string branchName, string repositoryPath)
 		{
 			if (string.IsNullOrEmpty(branchName) || !Repository.IsValid(repositoryPath))
diff --git a/src/Files.App/Views/Shells/BaseShellPage.cs b/src/Files.App/Views/Shells/BaseShellPage.cs
@@ -243,14 +243,14 @@ protected async void FilesystemViewModel_DirectoryInfoUpdated(object sender, Eve
 				? "ItemCount/Text".GetLocalizedResource()
 				: "ItemsCount/Text".GetLocalizedResource();
 
+			BranchItem? headBranch = headBranch = InstanceViewModel.IsGitRepository
+					? await GitHelpers.GetRepositoryHead(InstanceViewModel.GitRepositoryPath)
+					: null;
+
 			if (InstanceViewModel.GitRepositoryPath != FilesystemViewModel.GitDirectory)
 			{
 				InstanceViewModel.GitRepositoryPath = FilesystemViewModel.GitDirectory;
 
-				BranchItem? headBranch = headBranch = InstanceViewModel.IsGitRepository
-					? await GitHelpers.GetRepositoryHead(InstanceViewModel.GitRepositoryPath)
-					: null;
-
 				InstanceViewModel.GitBranchName = headBranch is not null
 					? headBranch.Name
 					: string.Empty;
@@ -267,14 +267,14 @@ protected async void FilesystemViewModel_DirectoryInfoUpdated(object sender, Eve
 						() => GitHelpers.FetchOrigin(InstanceViewModel.GitRepositoryPath),
 						_gitFetchToken.Token);
 				}
+			}
 
-				if (!GitHelpers.IsExecutingGitAction)
-				{
-					ContentPage.DirectoryPropertiesViewModel.UpdateGitInfo(
-						InstanceViewModel.IsGitRepository,
-						InstanceViewModel.GitRepositoryPath,
-						headBranch);
-				}
+			if (!GitHelpers.IsExecutingGitAction)
+			{
+				ContentPage.DirectoryPropertiesViewModel.UpdateGitInfo(
+					InstanceViewModel.IsGitRepository,
+					InstanceViewModel.GitRepositoryPath,
+					headBranch);
 			}
 
 			ContentPage.DirectoryPropertiesViewModel.DirectoryItemCount = $"{FilesystemViewModel.FilesAndFolders.Count} {directoryItemCountLocalization}";

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ public static Boolean OrAndConvert(bool a, bool b, bool c)`
`22`	`22`	`public static Visibility OrConvertToVisibility(bool a, bool b)`
`23`	`23`	`=> (a \|\| b) ? Visibility.Visible : Visibility.Collapsed;`
`24`	`24`
	`25`	`+ public static Visibility NorConvertToVisibility(bool a, bool b)`
	`26`	`+ => !(a \|\| b) ? Visibility.Visible : Visibility.Collapsed;`
	`27`	`+`
`25`	`28`	`public static Visibility OrNotConvertToVisibility(bool a, bool b)`
`26`	`29`	`=> OrConvertToVisibility(a, !b);`
`27`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`
`4`	`4`	`namespace Files.App.Data.Items`
`5`	`5`	`{`
`6`		`- public record BranchItem(string Name, bool IsRemote, int? AheadBy, int? BehindBy);`
	`6`	`+ public record BranchItem(string Name, bool IsHead, bool IsRemote, int? AheadBy, int? BehindBy);`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,9 @@ public class DirectoryPropertiesViewModel : ObservableObject`
`14`	`14`
`15`	`15`	`private string? _gitRepositoryPath;`
`16`	`16`
`17`		`- private readonly ObservableCollection<string> _localBranches = new();`
	`17`	`+ private readonly ObservableCollection<BranchItem> _localBranches = new();`
`18`	`18`
`19`		`- private readonly ObservableCollection<string> _remoteBranches = new();`
	`19`	`+ private readonly ObservableCollection<BranchItem> _remoteBranches = new();`
`20`	`20`
`21`	`21`	`public bool IsBranchesFlyoutExpaned { get; set; } = false;`
`22`	`22`
`@@ -43,9 +43,9 @@ public int SelectedBranchIndex`
`43`	`43`	`if (SetProperty(ref _SelectedBranchIndex, value) &&`
`44`	`44`	`value != -1 &&`
`45`	`45`	`(value != ACTIVE_BRANCH_INDEX \|\| !_ShowLocals) &&`
`46`		`- value < BranchesNames.Count)`
	`46`	`+ value < Branches.Count)`
`47`	`47`	`{`
`48`		`- CheckoutRequested?.Invoke(this, BranchesNames[value]);`
	`48`	`+ CheckoutRequested?.Invoke(this, Branches[value].Name);`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`	`}`
`@@ -58,7 +58,7 @@ public bool ShowLocals`
`58`	`58`	`{`
`59`	`59`	`if (SetProperty(ref _ShowLocals, value))`
`60`	`60`	`{`
`61`		`- OnPropertyChanged(nameof(BranchesNames));`
	`61`	`+ OnPropertyChanged(nameof(Branches));`
`62`	`62`
`63`	`63`	`if (value)`
`64`	`64`	`SelectedBranchIndex = ACTIVE_BRANCH_INDEX;`
`@@ -80,7 +80,7 @@ public string ExtendedStatusInfo`
`80`	`80`	`set => SetProperty(ref _ExtendedStatusInfo, value);`
`81`	`81`	`}`
`82`	`82`
`83`		`- public ObservableCollection<string> BranchesNames => _ShowLocals`
	`83`	`+ public ObservableCollection<BranchItem> Branches => _ShowLocals`
`84`	`84`	`? _localBranches`
`85`	`85`	`: _remoteBranches;`
`86`	`86`
`@@ -91,7 +91,7 @@ public string ExtendedStatusInfo`
`91`	`91`	`public DirectoryPropertiesViewModel()`
`92`	`92`	`{`
`93`	`93`	`NewBranchCommand = new AsyncRelayCommand(()`
`94`		`- => GitHelpers.CreateNewBranchAsync(_gitRepositoryPath!, _localBranches[ACTIVE_BRANCH_INDEX]));`
	`94`	`+ => GitHelpers.CreateNewBranchAsync(_gitRepositoryPath!, _localBranches[ACTIVE_BRANCH_INDEX].Name));`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`public void UpdateGitInfo(bool isGitRepository, string? repositoryPath, BranchItem? head)`
`@@ -128,12 +128,17 @@ public async Task LoadBranches()`
`128`	`128`	`foreach (var branch in branches)`
`129`	`129`	`{`
`130`	`130`	`if (branch.IsRemote)`
`131`		`- _remoteBranches.Add(branch.Name);`
	`131`	`+ _remoteBranches.Add(branch);`
`132`	`132`	`else`
`133`		`- _localBranches.Add(branch.Name);`
	`133`	`+ _localBranches.Add(branch);`
`134`	`134`	`}`
`135`	`135`
`136`	`136`	`SelectedBranchIndex = ShowLocals ? ACTIVE_BRANCH_INDEX : -1;`
`137`	`137`	`}`
	`138`	`+`
	`139`	`+ public Task ExecuteDeleteBranch(string? branchName)`
	`140`	`+ {`
	`141`	`+ return GitHelpers.DeleteBranchAsync(_gitRepositoryPath, GitBranchDisplayName, branchName);`
	`142`	`+ }`
`138`	`143`	`}`
`139`	`144`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,5 +68,14 @@ private void BranchesFlyout_Closing(object _, object e)`
`68`	`68`
`69`	`69`	`DirectoryPropertiesViewModel.IsBranchesFlyoutExpaned = false;`
`70`	`70`	`}`
	`71`	`+`
	`72`	`+ private async void DeleteBranch_Click(object sender, RoutedEventArgs e)`
	`73`	`+ {`
	`74`	`+ if (DirectoryPropertiesViewModel is null)`
	`75`	`+ return;`
	`76`	`+`
	`77`	`+ BranchesFlyout.Hide();`
	`78`	`+ await DirectoryPropertiesViewModel.ExecuteDeleteBranch(((BranchItem)((Button)sender).DataContext).Name);`
	`79`	`+ }`
`71`	`80`	`}`
`72`	`81`	`}`