SLVS-2526 Implement show rule help (#6421)

Author: gabriela-trutan-sonarsource

src/IssueViz.Security.UnitTests/ReportView/ReportViewModelTest.cs

@@ -24,6 +24,7 @@
 using SonarLint.VisualStudio.Core.Analysis;
 using SonarLint.VisualStudio.Core.Binding;
 using SonarLint.VisualStudio.Core.Telemetry;
+using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Models;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
@@ -43,6 +44,7 @@ public class ReportViewModelTest
     private ILocalHotspotsStore localHotspotsStore;
     private IShowDependencyRiskInBrowserHandler showDependencyRiskInBrowserHandler;
     private IChangeDependencyRiskStatusHandler changeDependencyRiskStatusHandler;
+    private INavigateToRuleDescriptionCommand navigateToRuleDescriptionCommand;
     private IMessageBox messageBox;
     private ITelemetryManager telemetryManager;
     private IThreadHandling threadHandling;
@@ -56,6 +58,7 @@ public void Initialize()
         localHotspotsStore = Substitute.For<ILocalHotspotsStore>();
         showDependencyRiskInBrowserHandler = Substitute.For<IShowDependencyRiskInBrowserHandler>();
         changeDependencyRiskStatusHandler = Substitute.For<IChangeDependencyRiskStatusHandler>();
+        navigateToRuleDescriptionCommand = Substitute.For<INavigateToRuleDescriptionCommand>();
         messageBox = Substitute.For<IMessageBox>();
         telemetryManager = Substitute.For<ITelemetryManager>();
         threadHandling = Substitute.ForPartsOf<NoOpThreadHandler>();
@@ -74,6 +77,9 @@ public void Class_SubscribesToEvents()
         dependencyRisksStore.Received(1).DependencyRisksChanged += Arg.Any<EventHandler>();
     }
 
+    [TestMethod]
+    public void Class_InitializesProperties() => testSubject.NavigateToRuleDescriptionCommand.Should().BeSameAs(navigateToRuleDescriptionCommand);
+
     [TestMethod]
     public void Ctor_InitializesDependencyRisks()
     {
@@ -204,10 +210,7 @@ public async Task ChangeStatusAsync_NullTransition_DoesNotCallHandler_ShowsMessa
     }
 
     [TestMethod]
-    public void SelectedItem_Initially_IsNull()
-    {
-        testSubject.SelectedItem.Should().BeNull();
-    }
+    public void SelectedItem_Initially_IsNull() => testSubject.SelectedItem.Should().BeNull();
 
     [TestMethod]
     public void SelectedItem_SetToDependencyRiskViewModel_CallsTelemetryForDependencyRisk()
@@ -469,6 +472,7 @@ private ReportViewModel CreateTestSubject()
             localHotspotsStore,
             showDependencyRiskInBrowserHandler,
             changeDependencyRiskStatusHandler,
+            navigateToRuleDescriptionCommand,
             messageBox,
             telemetryManager,
             threadHandling);

src/IssueViz.Security/ReportView/ReportViewControl.xaml

@@ -12,6 +12,7 @@
              xmlns:imaging="clr-namespace:Microsoft.VisualStudio.Imaging;assembly=Microsoft.VisualStudio.Imaging"
              xmlns:vsimagecatalog="clr-namespace:Microsoft.VisualStudio.Imaging;assembly=Microsoft.VisualStudio.ImageCatalog"
              xmlns:core="clr-namespace:SonarLint.VisualStudio.Core;assembly=SonarLint.VisualStudio.Core"
+             xmlns:commands="clr-namespace:SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;assembly=SonarLint.VisualStudio.IssueVisualization"
              DataContext="{Binding RelativeSource={RelativeSource Mode=Self}, Path=ReportViewModel}">
     <UserControl.Resources>
         <ResourceDictionary>
@@ -25,6 +26,8 @@
             <reportView:EnumToImageSourceConverter x:Key="EnumToImageSourceConverter" />
             <reportView:FileNameToMonikerConverter x:Key="FileNameToMonikerConverter" />
             <hotspots:HotspotTooltipConverter x:Key="HotspotTooltipConverter" />
+            <commands:NavigateToRuleDescriptionCommandConverter x:Key="NavigateToRuleDescriptionCommandConverter" />
+
             <wpf:BoolToVisibilityConverter x:Key="TrueToVisibleConverter" FalseValue="Collapsed" TrueValue="Visible" />
             <wpf:BoolToVisibilityConverter x:Key="TrueToCollapsedConverter" FalseValue="Visible" TrueValue="Collapsed"/>
             <wpf:EnglishPluralizationConverter x:Key="EnglishPluralizationConverter" />
@@ -54,6 +57,7 @@
                 <Setter Property="IsExpanded" Value="True" />
                 <Setter Property="Foreground" Value="{DynamicResource {x:Static vsShell:VsBrushes.BrandedUITextKey}}" />
                 <EventSetter Event="PreviewMouseUp" Handler="TreeViewItem_OnPreviewMouseUp"/>
+                <EventSetter Event="MouseDoubleClick" Handler="TreeViewItem_MouseDoubleClick"/>
                 <Setter Property="Template">
                     <Setter.Value>
                         <ControlTemplate TargetType="TreeViewItem">
@@ -134,6 +138,18 @@
                 <Setter Property="FontSize"
                         Value="{DynamicResource {x:Static vsShell:VsFonts.Environment90PercentFontSizeKey}}" />
                 <Setter Property="Foreground" Value="{DynamicResource {x:Static vsShell:VsBrushes.InactiveCaptionTextKey}}" />
+                <Style.Triggers>
+                    <MultiDataTrigger>
+                        <MultiDataTrigger.Conditions>
+                            <Condition Binding="{Binding RelativeSource={RelativeSource AncestorType=TreeViewItem}, Path=IsSelected}" Value="True" />
+                            <Condition Binding="{Binding RelativeSource={RelativeSource AncestorType=TreeViewItem}, Path=IsSelectionActive}" Value="True" />
+                        </MultiDataTrigger.Conditions>
+                        <MultiDataTrigger.Setters>
+                            <Setter Property="Foreground"
+                                    Value="{DynamicResource {x:Static vsTheming:TreeViewColors.SelectedItemActiveTextBrushKey}}" />
+                        </MultiDataTrigger.Setters>
+                    </MultiDataTrigger>
+                </Style.Triggers>
             </Style>
 
             <Style x:Key="IssueTypeTextBlockStyle" TargetType="TextBlock">
@@ -154,6 +170,16 @@
                     <Trigger Property="IsMouseOver" Value="True">
                         <Setter Property="TextDecorations" Value="Underline" />
                     </Trigger>
+                    <MultiDataTrigger>
+                        <MultiDataTrigger.Conditions>
+                            <Condition Binding="{Binding RelativeSource={RelativeSource AncestorType=TreeViewItem}, Path=IsSelected}" Value="True" />
+                            <Condition Binding="{Binding RelativeSource={RelativeSource AncestorType=TreeViewItem}, Path=IsSelectionActive}" Value="True" />
+                        </MultiDataTrigger.Conditions>
+                        <MultiDataTrigger.Setters>
+                            <Setter Property="Foreground"
+                                    Value="{DynamicResource {x:Static vsTheming:TreeViewColors.SelectedItemActiveTextBrushKey}}" />
+                        </MultiDataTrigger.Setters>
+                    </MultiDataTrigger>
                 </Style.Triggers>
             </Style>
 
@@ -370,7 +396,14 @@
                                    Style="{StaticResource IssueTextBlockStyle}" />
                         <TextBlock Grid.Column="3" Margin="5,0,0,0"
                                    Style="{StaticResource IssueTextBlockStyle}">
-                            <Hyperlink Style="{StaticResource RuleKeyLinkStyle}">
+                            <Hyperlink Style="{StaticResource RuleKeyLinkStyle}"
+                                       Command="{Binding DataContext.NavigateToRuleDescriptionCommand, RelativeSource={RelativeSource Mode=FindAncestor, AncestorType=TreeView}}">
+                                <Hyperlink.CommandParameter>
+                                    <MultiBinding Converter="{StaticResource NavigateToRuleDescriptionCommandConverter}">
+                                        <Binding Path=".RuleInfo.RuleKey" />
+                                        <Binding Path=".RuleInfo.IssueId" />
+                                    </MultiBinding>
+                                </Hyperlink.CommandParameter>
                                 <TextBlock Text="{Binding RuleInfo.RuleKey}"
                                            Style="{StaticResource CellTextBlockStyle}" />
                             </Hyperlink>

src/IssueViz.Security/ReportView/ReportViewControl.xaml.cs

@@ -28,6 +28,7 @@
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Binding;
 using SonarLint.VisualStudio.Core.Telemetry;
+using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
 using SonarLint.VisualStudio.IssueVisualization.Security.ReviewStatus;
@@ -50,6 +51,7 @@ public ReportViewControl(
         ILocalHotspotsStore hotspotsStore,
         IShowDependencyRiskInBrowserHandler showDependencyRiskInBrowserHandler,
         IChangeDependencyRiskStatusHandler changeDependencyRiskStatusHandler,
+        INavigateToRuleDescriptionCommand navigateToRuleDescriptionCommand,
         IMessageBox messageBox,
         ITelemetryManager telemetryManager,
         IThreadHandling threadHandling)
@@ -61,6 +63,7 @@ public ReportViewControl(
             hotspotsStore,
             showDependencyRiskInBrowserHandler,
             changeDependencyRiskStatusHandler,
+            navigateToRuleDescriptionCommand,
             messageBox,
             telemetryManager,
             threadHandling);
@@ -144,4 +147,18 @@ private async void ChangeScaStatusMenuItem_OnClick(object sender, RoutedEventArg
     private void TreeView_OnSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs<object> e) => ReportViewModel.SelectedItem = e.NewValue as IIssueViewModel;
 
     private void Hyperlink_OnRequestNavigate(object sender, RequestNavigateEventArgs e) => browserService.Navigate(e.Uri.AbsoluteUri);
+
+    private void TreeViewItem_MouseDoubleClick(object sender, MouseButtonEventArgs e)
+    {
+        if ((sender as FrameworkElement)?.DataContext is not IIssueViewModel issueViewModel)
+        {
+            return;
+        }
+
+        var commandParam = new NavigateToRuleDescriptionCommandParam { FullRuleKey = issueViewModel.RuleInfo.RuleKey, IssueId = issueViewModel.RuleInfo.IssueId };
+        if (ReportViewModel.NavigateToRuleDescriptionCommand.CanExecute(commandParam))
+        {
+            ReportViewModel.NavigateToRuleDescriptionCommand.Execute(commandParam);
+        }
+    }
 }

src/IssueViz.Security/ReportView/ReportViewModel.cs

@@ -25,6 +25,7 @@
 using SonarLint.VisualStudio.Core.Analysis;
 using SonarLint.VisualStudio.Core.Binding;
 using SonarLint.VisualStudio.Core.Telemetry;
+using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
 using SonarLint.VisualStudio.IssueVisualization.Security.IssuesStore;
@@ -49,10 +50,12 @@ public ReportViewModel(
         ILocalHotspotsStore hotspotsStore,
         IShowDependencyRiskInBrowserHandler showDependencyRiskInBrowserHandler,
         IChangeDependencyRiskStatusHandler changeDependencyRiskStatusHandler,
+        INavigateToRuleDescriptionCommand navigateToRuleDescriptionCommand,
         IMessageBox messageBox,
         ITelemetryManager telemetryManager,
         IThreadHandling threadHandling) : base(activeSolutionBoundTracker)
     {
+        NavigateToRuleDescriptionCommand = navigateToRuleDescriptionCommand;
         this.dependencyRisksStore = dependencyRisksStore;
         this.hotspotsStore = hotspotsStore;
         this.showDependencyRiskInBrowserHandler = showDependencyRiskInBrowserHandler;
@@ -68,6 +71,7 @@ public ReportViewModel(
 
     public ObservableCollection<IGroupViewModel> GroupViewModels { get; } = [];
     public bool HasGroups => GroupViewModels.Count > 0;
+    public INavigateToRuleDescriptionCommand NavigateToRuleDescriptionCommand { get; }
 
     public IIssueViewModel SelectedItem
     {

src/IssueViz.Security/ReportView/ReportViewToolWindow.cs

@@ -25,6 +25,7 @@
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Binding;
 using SonarLint.VisualStudio.Core.Telemetry;
+using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
 
@@ -48,6 +49,7 @@ public ReportViewToolWindow(IServiceProvider serviceProvider)
             componentModel?.GetService<ILocalHotspotsStore>(),
             componentModel?.GetService<IShowDependencyRiskInBrowserHandler>(),
             componentModel?.GetService<IChangeDependencyRiskStatusHandler>(),
+            componentModel?.GetService<INavigateToRuleDescriptionCommand>(),
             componentModel?.GetService<IMessageBox>(),
             componentModel?.GetService<ITelemetryManager>(),
             componentModel?.GetService<IThreadHandling>()

src/IssueViz/IssueVisualizationControl/ViewModels/Commands/NavigateToRuleDescriptionCommand.cs

@@ -18,9 +18,7 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-using System;
 using System.ComponentModel.Composition;
-using System.Diagnostics;
 using System.Globalization;
 using System.Windows.Data;
 using System.Windows.Input;
@@ -48,13 +46,13 @@ public NavigateToRuleDescriptionCommand(IEducation educationService)
                     }
                 },
                 parameter => parameter is NavigateToRuleDescriptionCommandParam s &&
-                    !string.IsNullOrEmpty(s.FullRuleKey) &&
-                SonarCompositeRuleId.TryParse(s.FullRuleKey, out var _))
+                             !string.IsNullOrEmpty(s.FullRuleKey) &&
+                             SonarCompositeRuleId.TryParse(s.FullRuleKey, out var _))
         {
         }
     }
 
-    internal class NavigateToRuleDescriptionCommandParam
+    public class NavigateToRuleDescriptionCommandParam
     {
         /// <summary>
         /// The id of the issue that comes from SlCore
@@ -65,7 +63,11 @@ internal class NavigateToRuleDescriptionCommandParam
 
     public class NavigateToRuleDescriptionCommandConverter : IMultiValueConverter
     {
-        public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
+        public object Convert(
+            object[] values,
+            Type targetType,
+            object parameter,
+            CultureInfo culture)
         {
             if (values.Length == 2 && values[0] is string && (values[1] is Guid || values[1] == null))
             {
@@ -74,7 +76,11 @@ public object Convert(object[] values, Type targetType, object parameter, Cultur
             return null;
         }
 
-        public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
+        public object[] ConvertBack(
+            object value,
+            Type[] targetTypes,
+            object parameter,
+            CultureInfo culture)
         {
             Debug.Fail("We should not hit here");
             return null;