SLLS-338 toolCalled telemetry

Author: sophio-japharidze-sonarsource

src/main/java/org/sonarsource/sonarlint/ls/SonarLintExtendedLanguageServer.java

@@ -387,6 +387,12 @@ public String getId() {
   @JsonNotification("sonarlint/helpAndFeedbackLinkClicked")
   CompletableFuture<Void> helpAndFeedbackLinkClicked(HelpAndFeedbackLinkClickedNotificationParams params);
 
+  record ToolCalledParams(String toolName, boolean success) {
+  }
+
+  @JsonNotification("sonarlint/toolCalled")
+  void toolCalled(ToolCalledParams params);
+
   class ScanFolderForHotspotsParams {
     private final String folderUri;
 

src/main/java/org/sonarsource/sonarlint/ls/SonarLintLanguageServer.java

@@ -736,6 +736,11 @@ public CompletableFuture<Void> helpAndFeedbackLinkClicked(HelpAndFeedbackLinkCli
     return CompletableFuture.completedFuture(null);
   }
 
+  @Override
+  public void toolCalled(ToolCalledParams params) {
+    telemetry.toolCalled(params.toolName(), params.success());
+  }
+
   public Map<String, Path> getEmbeddedPluginsToPath() {
     var plugins = new HashMap<String, Path>();
     addPluginPathOrWarn("cfamily", Language.C, plugins);

src/main/java/org/sonarsource/sonarlint/ls/telemetry/SonarLintTelemetry.java

@@ -26,6 +26,7 @@
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.DevNotificationsClickedParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.FixSuggestionResolvedParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.HelpAndFeedbackClickedParams;
+import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.ToolCalledParams;
 import org.sonarsource.sonarlint.ls.backend.BackendServiceFacade;
 import org.sonarsource.sonarlint.ls.log.LanguageClientLogger;
 import org.sonarsource.sonarlint.ls.settings.WorkspaceSettings;
@@ -87,6 +88,10 @@ public void helpAndFeedbackLinkClicked(String itemId) {
     actIfEnabled(telemetryRpcService -> telemetryRpcService.helpAndFeedbackLinkClicked(new HelpAndFeedbackClickedParams(itemId)));
   }
 
+  public void toolCalled(String toolName, boolean success) {
+    actIfEnabled(telemetryRpcService -> telemetryRpcService.toolCalled(new ToolCalledParams(toolName, success)));
+  }
+
   public void addedAutomaticBindings() {
     actIfEnabled(TelemetryRpcService::addedAutomaticBindings);
   }

src/test/java/org/sonarsource/sonarlint/ls/mediumtests/LanguageServerMediumTests.java

@@ -823,7 +823,7 @@ void test_analysis_logs_enabled() throws Exception {
         "[Info] [org.sonarsource.analyzer.commons.ProgressReport : rules execution progress] 1 source file to be analyzed",
         "[Info] [sonarlint : sonarlint-analysis-scheduler] Analysis detected 1 issue and 0 Security Hotspots in XXXms"));
   }
-  
+
   @Test
   void test_analysis_with_debug_logs_enabled() throws Exception {
     setShowVerboseLogs(client.globalSettings, true);

src/test/java/org/sonarsource/sonarlint/ls/telemetry/SonarLintTelemetryTests.java

@@ -34,6 +34,7 @@
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.FixSuggestionResolvedParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.FixSuggestionStatus;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.HelpAndFeedbackClickedParams;
+import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.ToolCalledParams;
 import org.sonarsource.sonarlint.ls.backend.BackendService;
 import org.sonarsource.sonarlint.ls.backend.BackendServiceFacade;
 import org.sonarsource.sonarlint.ls.settings.WorkspaceSettings;
@@ -176,6 +177,24 @@ void helpAndFeedbackLinkClicked_when_disabled() {
     verify(telemetryService, never()).helpAndFeedbackLinkClicked(any());
   }
 
+  @Test
+  void toolCalled_when_enabled() {
+    ArgumentCaptor<ToolCalledParams> argument = ArgumentCaptor.forClass(ToolCalledParams.class);
+    telemetry.toolCalled("lm.sonarqube_list_potential_security_issues", true);
+
+    verify(telemetryService).toolCalled(argument.capture());
+    assertThat(argument.getValue().getToolName()).isEqualTo("lm.sonarqube_list_potential_security_issues");
+    assertThat(argument.getValue().isSucceeded()).isTrue();
+  }
+
+  @Test
+  void toolCalled_when_disabled() {
+    System.setProperty(SonarLintTelemetry.DISABLE_PROPERTY_KEY, "true");
+    telemetry.toolCalled("lm.sonarqube_list_potential_security_issues", true);
+
+    verify(telemetryService, never()).toolCalled(any());
+  }
+
   @Test
   void addedAutomaticBindings_when_enabled() {
     telemetry.addedAutomaticBindings();