Implement cancel run

- Fix #25

Author: timheuer

src/Converters/NullToVisibilityConverter.cs

@@ -1,4 +1,5 @@
-using System.Globalization;
+using GitHubActionsVS.Models;
+using System.Globalization;
 using System.Windows;
 using System.Windows.Data;
 
@@ -15,3 +16,29 @@ public object ConvertBack(object value, Type targetType, object parameter, Cultu
         throw new NotImplementedException();
     }
 }
+
+public class NullToBooleanConverter : IValueConverter
+{
+    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        return value == null ? false : true;
+    }
+
+    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        throw new NotImplementedException();
+    }
+}
+
+public class BoolToVisibilityConverter : IValueConverter
+{
+    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        return (bool)value ? Visibility.Visible : Visibility.Collapsed;
+    }
+
+    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        throw new NotImplementedException();
+    }
+}

src/GitHubActionsVS.csproj

@@ -50,6 +50,7 @@
     <Compile Include="Converters\ConclusionColorConverter.cs" />
     <Compile Include="Converters\ConclusionIconConverter.cs" />
     <Compile Include="Converters\NullToVisibilityConverter.cs" />
+    <Compile Include="Helpers\ConclusionFilter.cs" />
     <Compile Include="Helpers\CredentialManager.cs" />
     <Compile Include="Helpers\RepoInfo.cs" />
     <Compile Include="Models\BaseWorkflowType.cs" />
@@ -104,6 +105,7 @@
     <Resource Include="Resources\AddItem.png" />
     <Resource Include="Resources\Delete.png" />
     <Resource Include="Resources\Edit.png" />
+    <Resource Include="Resources\CancelBuild.png" />
     <Content Include="Resources\Icon.png">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       <IncludeInVSIX>true</IncludeInVSIX>

src/Helpers/ConclusionFilter.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GitHubActionsVS.Helpers;
+public class ConclusionFilter
+{
+    public static bool IsFinished(string conclusion)
+    {
+        return conclusion.ToLower() switch
+        {
+            "pending" or "waiting" or "queued" or "in_progress" or "inprogress" or "requested" => false,
+            _ => true,
+        };
+    }
+}

src/Models/BaseWorkflowType.cs

@@ -10,4 +10,22 @@ public abstract class BaseWorkflowType
     public string DisplayDate => $"{LogDate:g}";
     public string? Url { get; set; }
     public string Id { get; set; }
+    public string TriggerEvent { get; set; }
+    public string TriggerLogin { get; set; }
+
+    public bool HasActions
+    {
+        get
+        {
+            return TriggerEvent is not null || Url is not null; 
+        }
+    }
+
+    public bool Cancellable
+    {
+        get
+        {
+            return TriggerEvent is not null && !Helpers.ConclusionFilter.IsFinished(Conclusion);
+        }
+    }
 }

src/Resources/CancelBuild.png

@@ -133,6 +133,10 @@
     <value>Update</value>
     <comment>Button text for update</comment>
   </data>
+  <data name="CANCEL_RUN" xml:space="preserve">
+    <value>Cancel Run</value>
+    <comment>Menu for cancelling a run</comment>
+  </data>
   <data name="CONFIRM_DELETE" xml:space="preserve">
     <value>Are you sure you want to delete this secret?</value>
     <comment>Question for deleting an item</comment>
@@ -209,6 +213,14 @@
     <value>Run Workflow</value>
     <comment>Menu for running a workflow</comment>
   </data>
+  <data name="TRIGGERED_BY" xml:space="preserve">
+    <value> by </value>
+    <comment>Message separating event and actor - requries spaces</comment>
+  </data>
+  <data name="TRIGGERED_VIA" xml:space="preserve">
+    <value>Triggered via </value>
+    <comment>Message starting the trigger sentence</comment>
+  </data>
   <data name="VIEW_LOG" xml:space="preserve">
     <value>View Log</value>
     <comment>Menu for viewing a log</comment>

src/Resources/UIStrings.Designer.cs

@@ -22,6 +22,8 @@
         <ivc:ConclusionIconConverter x:Key="ConclusionIconConverter" />
         <ivc:ConclusionColorConverter x:Key="ConclusionColorConverter" />
         <ivc:NullToVisibilityConverter x:Key="NullVisibilityConverter" />
+        <ivc:BoolToVisibilityConverter x:Key="BoolToVisibilityConverter" />
+        <ivc:NullToBooleanConverter x:Key="NullToBooleanConverter" />
         <Style TargetType="{x:Type Expander}">
             <Setter Property="toolkit:Themes.UseVsTheme" Value="True" />
         </Style>
@@ -59,13 +61,31 @@
                    Foreground="{Binding Path=Conclusion, Converter={StaticResource ConclusionColorConverter}}"
                    Text="{Binding Path=Conclusion, Converter={StaticResource ConclusionIconConverter}}"/>
                 <emoji:TextBlock Text="{Binding DisplayName}" VerticalAlignment="Bottom" Tag="{Binding Url}">
+                    <emoji:TextBlock.ToolTip>
+                        <ToolTip Visibility="{Binding TriggerEvent, Converter={StaticResource NullVisibilityConverter}}">
+                            <StackPanel Orientation="Vertical">
+                                <TextBlock FontWeight="Bold" Text="{Binding Conclusion}"/>
+                                <TextBlock>
+                                    <Run Text="{x:Static resx:UIStrings.TRIGGERED_VIA}"/>
+                                    <Run FontWeight="Bold" Text="{Binding TriggerEvent}"/>
+                                    <Run Text="{x:Static resx:UIStrings.TRIGGERED_BY}"/>
+                                    <Run FontWeight="Bold" Text="{Binding TriggerLogin}"/>
+                                </TextBlock>
+                            </StackPanel>
+                        </ToolTip>
+                    </emoji:TextBlock.ToolTip>
                     <TextBlock.ContextMenu>
-                        <ContextMenu Visibility="{Binding Url, Converter={StaticResource NullVisibilityConverter}}">
-                            <MenuItem Header="{x:Static resx:UIStrings.VIEW_LOG}" Click="ViewLog_Click" CommandParameter="{Binding RelativeSource={RelativeSource Mode=FindAncestor, AncestorType={x:Type ContextMenu}}}">
+                        <ContextMenu Visibility="{Binding HasActions, Converter={StaticResource BoolToVisibilityConverter}}">
+                            <MenuItem IsEnabled="{Binding Url, Converter={StaticResource NullToBooleanConverter}}" Header="{x:Static resx:UIStrings.VIEW_LOG}" Click="ViewLog_Click" CommandParameter="{Binding RelativeSource={RelativeSource Mode=FindAncestor, AncestorType={x:Type ContextMenu}}}">
                                 <MenuItem.Icon>
                                     <Image Source="pack://application:,,,/GitHubActionsVS;component/Resources/OpenWebSite.png" />
                                 </MenuItem.Icon>
                             </MenuItem>
+                            <MenuItem IsEnabled="{Binding Cancellable}" Click="CancelRun_Click" Header="{x:Static resx:UIStrings.CANCEL_RUN}" CommandParameter="{Binding RelativeSource={RelativeSource Mode=FindAncestor, AncestorType={x:Type ContextMenu}}}">
+                                <MenuItem.Icon>
+                                    <Image Source="pack://application:,,,/GitHubActionsVS;component/Resources/CancelBuild.png" />
+                                </MenuItem.Icon>
+                            </MenuItem>
                         </ContextMenu>
                     </TextBlock.ContextMenu>
                 </emoji:TextBlock>

src/Resources/UIStrings.resx

@@ -172,7 +172,9 @@ private async Task LoadDataAsync()
                         Name = run.Name,
                         LogDate = run.UpdatedAt,
                         Id = run.Id.ToString(),
-                        RunNumber = run.RunNumber.ToString()
+                        RunNumber = run.RunNumber.ToString(),
+                        TriggerEvent = run.Event,
+                        TriggerLogin = run.TriggeringActor.Login
                     };
 
                     if (refreshPending)
@@ -466,5 +468,22 @@ private async void Secret_MouseDoubleClick(object sender, MouseButtonEventArgs e
             }
         }
     }
+
+    private void CancelRun_Click(object sender, RoutedEventArgs e)
+    {
+        MenuItem menuItem = (MenuItem)sender;
+        TextBlock tvi = GetParentTreeViewItem(menuItem);
+
+        // check the tag value to ensure it isn't null
+        if (tvi is not null && tvi.DataContext is not null)
+        {
+            var run = tvi.DataContext as BaseWorkflowType;
+            if (run is not null && run.Id is not null && !ConclusionFilter.IsFinished(run.Conclusion))
+            {
+                GitHubClient client = GetGitHubClient();
+                _ = client.Actions.Workflows.Runs.Cancel(_repoInfo.RepoOwner, _repoInfo.RepoName, Int64.Parse(run.Id));
+            }
+        }
+    }
 }