SLVS-2521 Implement navigation to the hotspot location (#6422)

gabriela-trutan-sonarsource · web-flow · commit 2c66794500a4 · 2025-09-19T16:27:38.000+02:00
diff --git a/src/IssueViz.Security.UnitTests/ReportView/Hotspots/HotspotViewModelTests.cs b/src/IssueViz.Security.UnitTests/ReportView/Hotspots/HotspotViewModelTests.cs
@@ -47,6 +47,7 @@ public void Ctor_InitializesPropertiesAsExpected()
         testSubject.Column.Should().Be(hotspot.Visualization.Issue.PrimaryLocation.TextRange.StartLineOffset);
         testSubject.Title.Should().Be(hotspot.Visualization.Issue.PrimaryLocation.Message);
         testSubject.FilePath.Should().Be(hotspot.Visualization.Issue.PrimaryLocation.FilePath);
+        testSubject.Issue.Should().Be(hotspot.Visualization);
     }
 
     private static LocalHotspot CreateMockedHotspot(
diff --git a/src/IssueViz.Security.UnitTests/ReportView/ReportViewModelTest.cs b/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.Editor;
 using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Models;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
@@ -45,6 +46,7 @@ public class ReportViewModelTest
     private IShowDependencyRiskInBrowserHandler showDependencyRiskInBrowserHandler;
     private IChangeDependencyRiskStatusHandler changeDependencyRiskStatusHandler;
     private INavigateToRuleDescriptionCommand navigateToRuleDescriptionCommand;
+    private ILocationNavigator locationNavigator;
     private IMessageBox messageBox;
     private ITelemetryManager telemetryManager;
     private IThreadHandling threadHandling;
@@ -59,6 +61,7 @@ public void Initialize()
         showDependencyRiskInBrowserHandler = Substitute.For<IShowDependencyRiskInBrowserHandler>();
         changeDependencyRiskStatusHandler = Substitute.For<IChangeDependencyRiskStatusHandler>();
         navigateToRuleDescriptionCommand = Substitute.For<INavigateToRuleDescriptionCommand>();
+        locationNavigator = Substitute.For<ILocationNavigator>();
         messageBox = Substitute.For<IMessageBox>();
         telemetryManager = Substitute.For<ITelemetryManager>();
         threadHandling = Substitute.ForPartsOf<NoOpThreadHandler>();
@@ -78,7 +81,11 @@ public void Class_SubscribesToEvents()
     }
 
     [TestMethod]
-    public void Class_InitializesProperties() => testSubject.NavigateToRuleDescriptionCommand.Should().BeSameAs(navigateToRuleDescriptionCommand);
+    public void Class_InitializesProperties()
+    {
+        testSubject.NavigateToRuleDescriptionCommand.Should().BeSameAs(navigateToRuleDescriptionCommand);
+        testSubject.NavigateToLocationCommand.Should().NotBeNull();
+    }
 
     [TestMethod]
     public void Ctor_InitializesDependencyRisks()
@@ -465,6 +472,35 @@ public void HasRisks_ReturnsTrue_WhenThereAreRisks()
     [TestMethod]
     public void HasRisks_ReturnsFalse_WhenThereAreNoRisks() => testSubject.HasGroups.Should().BeFalse();
 
+    [TestMethod]
+    public void NavigateToLocationCommand_NullParameter_CanExecuteReturnsFalse() => testSubject.NavigateToLocationCommand.CanExecute(null).Should().BeFalse();
+
+    [TestMethod]
+    public void NavigateToLocationCommand_NotAnalysisIssueViewModelParameter_CanExecuteReturnsFalse()
+    {
+        var viewModel = Substitute.For<IIssueViewModel>();
+
+        testSubject.NavigateToLocationCommand.CanExecute(viewModel).Should().BeFalse();
+    }
+
+    [TestMethod]
+    public void NavigateToLocationCommand_AnalysisIssueViewModelParameter_CanExecuteReturnsTrue()
+    {
+        var analysisIssueViewModel = Substitute.For<IAnalysisIssueViewModel>();
+
+        testSubject.NavigateToLocationCommand.CanExecute(analysisIssueViewModel).Should().BeTrue();
+    }
+
+    [TestMethod]
+    public void NavigateToLocationCommand_NavigatesToLocation()
+    {
+        var analysisIssueViewModel = Substitute.For<IAnalysisIssueViewModel>();
+
+        testSubject.NavigateToLocationCommand.Execute(analysisIssueViewModel);
+
+        locationNavigator.Received(1).TryNavigatePartial(analysisIssueViewModel.Issue);
+    }
+
     private ReportViewModel CreateTestSubject()
     {
         var reportViewModel = new ReportViewModel(activeSolutionBoundTracker,
@@ -473,6 +509,7 @@ private ReportViewModel CreateTestSubject()
             showDependencyRiskInBrowserHandler,
             changeDependencyRiskStatusHandler,
             navigateToRuleDescriptionCommand,
+            locationNavigator,
             messageBox,
             telemetryManager,
             threadHandling);
diff --git a/src/IssueViz.Security/ReportView/Hotspots/HotspotViewModel.cs b/src/IssueViz.Security/ReportView/Hotspots/HotspotViewModel.cs
@@ -19,11 +19,12 @@
  */
 
 using SonarLint.VisualStudio.Core.WPF;
+using SonarLint.VisualStudio.IssueVisualization.Models;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
 
 namespace SonarLint.VisualStudio.IssueVisualization.Security.ReportView.Hotspots;
 
-internal class HotspotViewModel : ViewModelBase, IIssueViewModel
+internal class HotspotViewModel : ViewModelBase, IAnalysisIssueViewModel
 {
     public LocalHotspot LocalHotspot { get; }
 
@@ -38,4 +39,5 @@ public HotspotViewModel(LocalHotspot localHotspot)
     public string Title => LocalHotspot.Visualization.Issue.PrimaryLocation.Message;
     public string FilePath => LocalHotspot.Visualization.Issue.PrimaryLocation.FilePath;
     public RuleInfoViewModel RuleInfo { get; }
+    public IAnalysisIssueVisualization Issue => LocalHotspot.Visualization;
 }
diff --git a/src/IssueViz.Security/ReportView/IIssueViewModel.cs b/src/IssueViz.Security/ReportView/IIssueViewModel.cs
@@ -18,6 +18,8 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
+using SonarLint.VisualStudio.IssueVisualization.Models;
+
 namespace SonarLint.VisualStudio.IssueVisualization.Security.ReportView;
 
 public interface IIssueViewModel
@@ -28,3 +30,8 @@ public interface IIssueViewModel
     string FilePath { get; }
     RuleInfoViewModel RuleInfo { get; }
 }
+
+public interface IAnalysisIssueViewModel : IIssueViewModel
+{
+    IAnalysisIssueVisualization Issue { get; }
+}
diff --git a/src/IssueViz.Security/ReportView/ReportViewControl.xaml.cs b/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.Editor;
 using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
@@ -52,6 +53,7 @@ public ReportViewControl(
         IShowDependencyRiskInBrowserHandler showDependencyRiskInBrowserHandler,
         IChangeDependencyRiskStatusHandler changeDependencyRiskStatusHandler,
         INavigateToRuleDescriptionCommand navigateToRuleDescriptionCommand,
+        ILocationNavigator locationNavigator,
         IMessageBox messageBox,
         ITelemetryManager telemetryManager,
         IThreadHandling threadHandling)
@@ -64,6 +66,7 @@ public ReportViewControl(
             showDependencyRiskInBrowserHandler,
             changeDependencyRiskStatusHandler,
             navigateToRuleDescriptionCommand,
+            locationNavigator,
             messageBox,
             telemetryManager,
             threadHandling);
@@ -150,15 +153,32 @@ private async void ChangeScaStatusMenuItem_OnClick(object sender, RoutedEventArg
 
     private void TreeViewItem_MouseDoubleClick(object sender, MouseButtonEventArgs e)
     {
-        if ((sender as FrameworkElement)?.DataContext is not IIssueViewModel issueViewModel)
+        NavigateToLocation(sender);
+        ShowRuleHelp(sender);
+    }
+
+    private void NavigateToLocation(object sender)
+    {
+        if ((sender as FrameworkElement)?.DataContext is IAnalysisIssueViewModel analysisIssueViewModel)
         {
-            return;
+            ExecuteCommandIfValid(ReportViewModel.NavigateToLocationCommand, analysisIssueViewModel);
         }
+    }
 
-        var commandParam = new NavigateToRuleDescriptionCommandParam { FullRuleKey = issueViewModel.RuleInfo.RuleKey, IssueId = issueViewModel.RuleInfo.IssueId };
-        if (ReportViewModel.NavigateToRuleDescriptionCommand.CanExecute(commandParam))
+    private void ShowRuleHelp(object sender)
+    {
+        if ((sender as FrameworkElement)?.DataContext is IIssueViewModel issueViewModel)
+        {
+            var commandParam = new NavigateToRuleDescriptionCommandParam { FullRuleKey = issueViewModel.RuleInfo.RuleKey, IssueId = issueViewModel.RuleInfo.IssueId };
+            ExecuteCommandIfValid(ReportViewModel.NavigateToRuleDescriptionCommand, commandParam);
+        }
+    }
+
+    private static void ExecuteCommandIfValid(ICommand command, object parameter)
+    {
+        if (command.CanExecute(parameter))
         {
-            ReportViewModel.NavigateToRuleDescriptionCommand.Execute(commandParam);
+            command.Execute(parameter);
         }
     }
 }
diff --git a/src/IssueViz.Security/ReportView/ReportViewModel.cs b/src/IssueViz.Security/ReportView/ReportViewModel.cs
@@ -21,10 +21,13 @@
 using System.Collections.ObjectModel;
 using System.Windows;
 using System.Windows.Data;
+using System.Windows.Input;
+using Microsoft.VisualStudio.PlatformUI;
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Analysis;
 using SonarLint.VisualStudio.Core.Binding;
 using SonarLint.VisualStudio.Core.Telemetry;
+using SonarLint.VisualStudio.IssueVisualization.Editor;
 using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
@@ -51,11 +54,11 @@ public ReportViewModel(
         IShowDependencyRiskInBrowserHandler showDependencyRiskInBrowserHandler,
         IChangeDependencyRiskStatusHandler changeDependencyRiskStatusHandler,
         INavigateToRuleDescriptionCommand navigateToRuleDescriptionCommand,
+        ILocationNavigator locationNavigator,
         IMessageBox messageBox,
         ITelemetryManager telemetryManager,
         IThreadHandling threadHandling) : base(activeSolutionBoundTracker)
     {
-        NavigateToRuleDescriptionCommand = navigateToRuleDescriptionCommand;
         this.dependencyRisksStore = dependencyRisksStore;
         this.hotspotsStore = hotspotsStore;
         this.showDependencyRiskInBrowserHandler = showDependencyRiskInBrowserHandler;
@@ -66,12 +69,15 @@ public ReportViewModel(
         threadHandling.RunOnUIThread(() => { BindingOperations.EnableCollectionSynchronization(GroupViewModels, @lock); });
         hotspotsStore.IssuesChanged += HotspotsStore_IssuesChanged;
         dependencyRisksStore.DependencyRisksChanged += DependencyRisksStore_DependencyRiskChanged;
+
+        InitializeCommands(navigateToRuleDescriptionCommand, locationNavigator);
         InitializeViewModels();
     }
 
     public ObservableCollection<IGroupViewModel> GroupViewModels { get; } = [];
     public bool HasGroups => GroupViewModels.Count > 0;
-    public INavigateToRuleDescriptionCommand NavigateToRuleDescriptionCommand { get; }
+    public INavigateToRuleDescriptionCommand NavigateToRuleDescriptionCommand { get; set; }
+    public ICommand NavigateToLocationCommand { get; set; }
 
     public IIssueViewModel SelectedItem
     {
@@ -180,4 +186,16 @@ private static ObservableCollection<IGroupViewModel> GetGroupViewModel(IEnumerab
 
         return groupViewModels;
     }
+
+    private void InitializeCommands(
+        INavigateToRuleDescriptionCommand navigateToRuleDescriptionCommand,
+        ILocationNavigator locationNavigator)
+    {
+        NavigateToRuleDescriptionCommand = navigateToRuleDescriptionCommand;
+        NavigateToLocationCommand = new DelegateCommand(parameter =>
+        {
+            var analysisIssueViewModel = (IAnalysisIssueViewModel)parameter;
+            locationNavigator.TryNavigate(analysisIssueViewModel.Issue);
+        }, parameter => parameter is IAnalysisIssueViewModel);
+    }
 }
diff --git a/src/IssueViz.Security/ReportView/ReportViewToolWindow.cs b/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.Editor;
 using SonarLint.VisualStudio.IssueVisualization.IssueVisualizationControl.ViewModels.Commands;
 using SonarLint.VisualStudio.IssueVisualization.Security.DependencyRisks;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
@@ -50,6 +51,7 @@ public ReportViewToolWindow(IServiceProvider serviceProvider)
             componentModel?.GetService<IShowDependencyRiskInBrowserHandler>(),
             componentModel?.GetService<IChangeDependencyRiskStatusHandler>(),
             componentModel?.GetService<INavigateToRuleDescriptionCommand>(),
+            componentModel?.GetService<ILocationNavigator>(),
             componentModel?.GetService<IMessageBox>(),
             componentModel?.GetService<ITelemetryManager>(),
             componentModel?.GetService<IThreadHandling>()

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ public void Ctor_InitializesPropertiesAsExpected()`
`47`	`47`	`testSubject.Column.Should().Be(hotspot.Visualization.Issue.PrimaryLocation.TextRange.StartLineOffset);`
`48`	`48`	`testSubject.Title.Should().Be(hotspot.Visualization.Issue.PrimaryLocation.Message);`
`49`	`49`	`testSubject.FilePath.Should().Be(hotspot.Visualization.Issue.PrimaryLocation.FilePath);`
	`50`	`+ testSubject.Issue.Should().Be(hotspot.Visualization);`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`private static LocalHotspot CreateMockedHotspot(`