SLVS-2523 Implement telemetry for interacting with hotspots (#6425)

Author: gabriela-trutan-sonarsource

src/Core/Telemetry/ITelemetryManager.cs

@@ -43,4 +43,8 @@ public interface ITelemetryManager
     void AddedAutomaticBindings();
 
     void DependencyRiskInvestigatedLocally();
+
+    void HotspotInvestigatedLocally();
+
+    void HotspotInvestigatedRemotely();
 }

src/Integration.UnitTests/Telemetry/TelemetryManagerTests.cs

@@ -19,7 +19,6 @@
  */
 
 using Microsoft.VisualStudio.Shell;
-using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Telemetry;
 using SonarLint.VisualStudio.Integration.Telemetry;
 using SonarLint.VisualStudio.SLCore.Service.Telemetry;
@@ -244,6 +243,30 @@ public void DependencyRiskInvestigatedLocally_CallsRpcService()
         });
     }
 
+    [TestMethod]
+    public void HotspotInvestigatedLocally_CallsRpcService()
+    {
+        telemetryManager.HotspotInvestigatedLocally();
+
+        Received.InOrder(() =>
+        {
+            telemetryHandler.Notify(Arg.Any<Action<ITelemetrySLCoreService>>());
+            telemetryService.HotspotInvestigatedLocally();
+        });
+    }
+
+    [TestMethod]
+    public void HotspotInvestigatedRemotely_CallsRpcService()
+    {
+        telemetryManager.HotspotInvestigatedRemotely();
+
+        Received.InOrder(() =>
+        {
+            telemetryHandler.Notify(Arg.Any<Action<ITelemetrySLCoreService>>());
+            telemetryService.HotspotInvestigatedRemotely();
+        });
+    }
+
     private void MockTelemetryService()
     {
         telemetryService = Substitute.For<ITelemetrySLCoreService>();

src/Integration/Telemetry/TelemetryManager.cs

@@ -20,7 +20,6 @@
 
 using System.ComponentModel.Composition;
 using Microsoft.VisualStudio.Shell;
-using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Telemetry;
 using SonarLint.VisualStudio.SLCore.Service.Telemetry;
 using SonarLint.VisualStudio.SLCore.Service.Telemetry.Models;
@@ -68,6 +67,10 @@ public void FixSuggestionResolved(string suggestionId, IEnumerable<bool> changeR
 
     public void DependencyRiskInvestigatedLocally() => telemetryHelper.Notify(telemetryService => telemetryService.DependencyRiskInvestigatedLocally());
 
+    public void HotspotInvestigatedLocally() => telemetryHelper.Notify(telemetryService => telemetryService.HotspotInvestigatedLocally());
+
+    public void HotspotInvestigatedRemotely() => telemetryHelper.Notify(telemetryService => telemetryService.HotspotInvestigatedRemotely());
+
     private static IEnumerable<FixSuggestionResolvedParams> ConvertFixSuggestionChangeToResolvedParams(string suggestionId, IEnumerable<bool> changeApplicationStatus) =>
         changeApplicationStatus
             .Select((status, index) =>

src/IssueViz.Security.UnitTests/ReportView/Hotspots/HotspotsReportViewModelTest.cs

@@ -21,6 +21,7 @@
 using System.Windows;
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Analysis;
+using SonarLint.VisualStudio.Core.Telemetry;
 using SonarLint.VisualStudio.Integration.TestInfrastructure;
 using SonarLint.VisualStudio.IssueVisualization.Models;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
@@ -39,6 +40,7 @@ public class HotspotsReportViewModelTest
     private ILocalHotspotsStore localHotspotsStore;
     private IMessageBox messageBox;
     private IReviewHotspotsService reviewHotspotsService;
+    private ITelemetryManager telemetryManager;
     private HotspotsReportViewModel testSubject;
 
     [TestInitialize]
@@ -47,15 +49,17 @@ public void TestInitialize()
         localHotspotsStore = Substitute.For<ILocalHotspotsStore>();
         reviewHotspotsService = Substitute.For<IReviewHotspotsService>();
         messageBox = Substitute.For<IMessageBox>();
-        testSubject = new HotspotsReportViewModel(localHotspotsStore, reviewHotspotsService, messageBox);
+        telemetryManager = Substitute.For<ITelemetryManager>();
+        testSubject = new HotspotsReportViewModel(localHotspotsStore, reviewHotspotsService, messageBox, telemetryManager);
     }
 
     [TestMethod]
     public void MefCtor_CheckIsExported() =>
         MefTestHelpers.CheckTypeCanBeImported<HotspotsReportViewModel, IHotspotsReportViewModel>(
             MefTestHelpers.CreateExport<ILocalHotspotsStore>(),
             MefTestHelpers.CreateExport<IReviewHotspotsService>(),
-            MefTestHelpers.CreateExport<IMessageBox>()
+            MefTestHelpers.CreateExport<IMessageBox>(),
+            MefTestHelpers.CreateExport<ITelemetryManager>()
         );
 
     [TestMethod]
@@ -127,13 +131,14 @@ public void HotspotsChanged_RaisedOnStoreIssuesChanged()
     }
 
     [TestMethod]
-    public async Task ShowHotspotInBrowserAsync_CallsHandler()
+    public async Task ShowHotspotInBrowserAsync_CallsHandlerAndTelemetry()
     {
         var hotspot = CreateMockedHotspot("myFile.cs");
 
         await testSubject.ShowHotspotInBrowserAsync(hotspot);
 
         reviewHotspotsService.Received(1).OpenHotspotAsync(hotspot.Visualization.Issue.IssueServerKey).IgnoreAwaitForAssert();
+        telemetryManager.Received(1).HotspotInvestigatedRemotely();
     }
 
     [TestMethod]

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

@@ -25,7 +25,9 @@
 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;
+using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
 using SonarLint.VisualStudio.IssueVisualization.Security.ReportView;
 using SonarLint.VisualStudio.IssueVisualization.Security.ReportView.Hotspots;
 using SonarLint.VisualStudio.TestInfrastructure;
@@ -182,6 +184,44 @@ public void SelectedItem_SetToIssueViewModel_DoesNotCallTelemetryForDependencyRi
 
         testSubject.SelectedItem.Should().BeSameAs(issueViewModel);
         telemetryManager.DidNotReceive().DependencyRiskInvestigatedLocally();
+        telemetryManager.DidNotReceive().HotspotInvestigatedLocally();
+    }
+
+    [TestMethod]
+    public void SelectedItem_SetToHotspotViewModel_CallsTelemetryForDependencyRisk()
+    {
+        var hotspotViewModel = new HotspotViewModel(CreateMockedHotspot());
+
+        testSubject.SelectedItem = hotspotViewModel;
+
+        testSubject.SelectedItem.Should().BeSameAs(hotspotViewModel);
+        telemetryManager.Received(1).HotspotInvestigatedLocally();
+    }
+
+    [TestMethod]
+    public void SelectedItem_SetToSameHotspotViewModel_DoesNotCallTelemetry()
+    {
+        var hotspotViewModel = new HotspotViewModel(CreateMockedHotspot());
+        testSubject.SelectedItem = hotspotViewModel;
+        telemetryManager.ClearReceivedCalls();
+
+        testSubject.SelectedItem = hotspotViewModel;
+
+        telemetryManager.DidNotReceive().HotspotInvestigatedLocally();
+    }
+
+    [TestMethod]
+    public void SelectedItem_SetToDifferentHotspotViewModel_CallsTelemetry()
+    {
+        var hotspotViewModel1 = new HotspotViewModel(CreateMockedHotspot());
+        var hotspotViewModel2 = new HotspotViewModel(CreateMockedHotspot());
+        testSubject.SelectedItem = hotspotViewModel1;
+        telemetryManager.ClearReceivedCalls();
+
+        testSubject.SelectedItem = hotspotViewModel2;
+
+        testSubject.SelectedItem.Should().BeSameAs(hotspotViewModel2);
+        telemetryManager.Received(1).HotspotInvestigatedLocally();
     }
 
     [TestMethod]
@@ -195,6 +235,7 @@ public void SelectedItem_SetToNull_DoesNotCallTelemetry()
 
         testSubject.SelectedItem.Should().BeNull();
         telemetryManager.DidNotReceive().DependencyRiskInvestigatedLocally();
+        telemetryManager.DidNotReceive().HotspotInvestigatedLocally();
     }
 
     [TestMethod]
@@ -391,4 +432,6 @@ private static void VerifyExpectedDependencyRiskGroupViewModel(GroupDependencyRi
     }
 
     private void VerifyHasGroupsUpdated() => eventHandler.Received().Invoke(Arg.Any<object>(), Arg.Is<PropertyChangedEventArgs>(p => p.PropertyName == nameof(testSubject.HasGroups)));
+
+    private static LocalHotspot CreateMockedHotspot() => new(Substitute.For<IAnalysisIssueVisualization>(), default, default);
 }

src/IssueViz.Security/ReportView/Hotspots/HotspotsReportViewModel.cs

@@ -23,6 +23,7 @@
 using System.Windows;
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Analysis;
+using SonarLint.VisualStudio.Core.Telemetry;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots;
 using SonarLint.VisualStudio.IssueVisualization.Security.Hotspots.ReviewHotspot;
 using SonarLint.VisualStudio.IssueVisualization.Security.IssuesStore;
@@ -49,13 +50,19 @@ internal sealed class HotspotsReportViewModel : IHotspotsReportViewModel
     private readonly ILocalHotspotsStore hotspotsStore;
     private readonly IReviewHotspotsService reviewHotspotsService;
     private readonly IMessageBox messageBox;
+    private readonly ITelemetryManager telemetryManager;
 
     [ImportingConstructor]
-    public HotspotsReportViewModel(ILocalHotspotsStore hotspotsStore, IReviewHotspotsService reviewHotspotsService, IMessageBox messageBox)
+    public HotspotsReportViewModel(
+        ILocalHotspotsStore hotspotsStore,
+        IReviewHotspotsService reviewHotspotsService,
+        IMessageBox messageBox,
+        ITelemetryManager telemetryManager)
     {
         this.hotspotsStore = hotspotsStore;
         this.reviewHotspotsService = reviewHotspotsService;
         this.messageBox = messageBox;
+        this.telemetryManager = telemetryManager;
         hotspotsStore.IssuesChanged += HotspotsStore_IssuesChanged;
     }
 
@@ -69,7 +76,11 @@ public ObservableCollection<IGroupViewModel> GetHotspotsGroupViewModels()
         return GetGroupViewModel(hotspots);
     }
 
-    public async Task ShowHotspotInBrowserAsync(LocalHotspot localHotspot) => await reviewHotspotsService.OpenHotspotAsync(localHotspot.Visualization.Issue.IssueServerKey);
+    public async Task ShowHotspotInBrowserAsync(LocalHotspot localHotspot)
+    {
+        await reviewHotspotsService.OpenHotspotAsync(localHotspot.Visualization.Issue.IssueServerKey);
+        telemetryManager.HotspotInvestigatedRemotely();
+    }
 
     public async Task<IEnumerable<HotspotStatus>> GetAllowedStatusesAsync(HotspotViewModel selectedHotspotViewModel)
     {

src/IssueViz.Security/ReportView/ReportViewModel.cs

@@ -96,9 +96,14 @@ protected override void Dispose(bool disposing)
 
     private void UpdateTelemetry(IIssueViewModel issueViewModel)
     {
-        if (issueViewModel is DependencyRiskViewModel)
+        switch (issueViewModel)
         {
-            telemetryManager.DependencyRiskInvestigatedLocally();
+            case DependencyRiskViewModel:
+                telemetryManager.DependencyRiskInvestigatedLocally();
+                break;
+            case HotspotViewModel:
+                telemetryManager.HotspotInvestigatedLocally();
+                break;
         }
     }
 

src/SLCore/Service/Telemetry/ITelemetrySLCoreService.cs

@@ -27,18 +27,36 @@ namespace SonarLint.VisualStudio.SLCore.Service.Telemetry;
 public interface ITelemetrySLCoreService : ISLCoreService
 {
     Task<GetStatusResponse> GetStatusAsync();
+
     void EnableTelemetry();
+
     void DisableTelemetry();
+
     void AnalysisDoneOnSingleLanguage(AnalysisDoneOnSingleLanguageParams parameters);
+
     void DevNotificationsClicked(DevNotificationsClickedParams parameters);
+
     void TaintVulnerabilitiesInvestigatedLocally();
+
     void TaintVulnerabilitiesInvestigatedRemotely();
+
     void AddReportedRules(AddReportedRulesParams parameters);
+
     void AddQuickFixAppliedForRule(AddQuickFixAppliedForRuleParams parameters);
+
     void FixSuggestionResolved(FixSuggestionResolvedParams parameters);
+
     void HelpAndFeedbackLinkClicked(HelpAndFeedbackClickedParams parameters);
+
     void AddedManualBindings();
+
     void AddedImportedBindings();
+
     void AddedAutomaticBindings();
+
     void DependencyRiskInvestigatedLocally();
+
+    void HotspotInvestigatedLocally();
+
+    void HotspotInvestigatedRemotely();
 }