SLCORE-1783 Allow clients to record telemetry events for IDE Labs

Author: Krosovok

API_CHANGES.md

@@ -1,8 +1,17 @@
 # 10.37
 
 ## Breaking Changes
+
+* Add initial IDE Labs parameters to `org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.InitializeParams`. Deprecated constructor uses default parameters.
+
+## Deprecation
+
 * Deprecate 4-parameter constructor and remove deprecation of 2-parameter one of `org.sonarsource.sonarlint.core.rpc.protocol.backend.config.binding.DidUpdateBindingParams`. Move back to an old constructor as not all IDEs were able to provide all data to a new one.
 * Remove Deprecation from `org.sonarsource.sonarlint.core.rpc.protocol.backend.telemetry.TelemetryRpcService#addedManualBindings` method. It should be used again for manual binding events instead of parametrized `didUpdateBinding`.
+
+## New features
+
+* Introduce 3 new methods to `org.sonarsource.sonarlint.core.rpc.protocol.backend.telemetry.TelemetryRpcService` to record Ide Labs telemetry: `toggleIdeLabsEnablement`, `externalLinkClicked`, `feedbackLinkClicked`.
 * Introduce a new `org.sonarsource.sonarlint.core.rpc.protocol.backend.telemetry.TelemetryRpcService.acceptedBindingSuggestion`. It should be used to for bindings created based on suggestions and pass `org.sonarsource.sonarlint.core.rpc.protocol.backend.config.binding.BindingSuggestionOrigin` instead of parametrized `didUpdateBinding`. 
 
 # 10.36

backend/core/src/main/java/org/sonarsource/sonarlint/core/event/JoinIdeLabsEvent.java

@@ -0,0 +1,23 @@
+/*
+ * SonarLint Core - Implementation
+ * Copyright (C) 2016-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonarsource.sonarlint.core.event;
+
+public record JoinIdeLabsEvent() {
+}

backend/core/src/main/java/org/sonarsource/sonarlint/core/labs/IdeLabsService.java

@@ -20,28 +20,34 @@
 package org.sonarsource.sonarlint.core.labs;
 
 import com.google.gson.Gson;
+import org.sonarsource.sonarlint.core.event.JoinIdeLabsEvent;
 import org.sonarsource.sonarlint.core.rpc.protocol.backend.labs.JoinIdeLabsProgramResponse;
+import org.springframework.context.ApplicationEventPublisher;
 
 public class IdeLabsService {
+
   private final IdeLabsHttpClient labsHttpClient;
+  private final ApplicationEventPublisher eventPublisher;
   private final Gson gson = new Gson();
 
-  public IdeLabsService(IdeLabsHttpClient labsHttpClient) {
+  public IdeLabsService(IdeLabsHttpClient labsHttpClient, ApplicationEventPublisher eventPublisher) {
     this.labsHttpClient = labsHttpClient;
+    this.eventPublisher = eventPublisher;
   }
 
   public JoinIdeLabsProgramResponse joinIdeLabsProgram(String email, String ideName) {
     try (var response = labsHttpClient.join(email, ideName)) {
       if (!response.isSuccessful()) {  
         return new JoinIdeLabsProgramResponse(false, "An unexpected error occurred. Server responded with status code: " + response.code());  
-      }  
+      }
 
-      var responseBody = response.bodyAsString();  
-      if (gson.fromJson(responseBody, IdeLabsSubscriptionResponseBody.class).validEmail()) {
-        return new JoinIdeLabsProgramResponse(true, null);  
-      }  
+      var responseBody = gson.fromJson(response.bodyAsString(), IdeLabsSubscriptionResponseBody.class);
+      if (!responseBody.validEmail()) {
+        return new JoinIdeLabsProgramResponse(false, "The provided email address is not valid. Please enter a valid email address.");
+      }
 
-      return new JoinIdeLabsProgramResponse(false, "The provided email address is not valid. Please enter a valid email address.");  
+      eventPublisher.publishEvent(new JoinIdeLabsEvent());
+      return new JoinIdeLabsProgramResponse(true, null);
     } catch (Exception e) {
       return new JoinIdeLabsProgramResponse(false, "An unexpected error occurred: " + e.getMessage());
     }

backend/core/src/main/java/org/sonarsource/sonarlint/core/telemetry/TelemetryService.java

@@ -35,6 +35,7 @@
 import org.sonarsource.sonarlint.core.commons.log.SonarLintLogger;
 import org.sonarsource.sonarlint.core.commons.util.FailSafeExecutors;
 import org.sonarsource.sonarlint.core.event.FixSuggestionReceivedEvent;
+import org.sonarsource.sonarlint.core.event.JoinIdeLabsEvent;
 import org.sonarsource.sonarlint.core.event.LocalOnlyIssueStatusChangedEvent;
 import org.sonarsource.sonarlint.core.event.MatchingSessionEndedEvent;
 import org.sonarsource.sonarlint.core.event.ServerIssueStatusChangedEvent;
@@ -86,6 +87,8 @@ private void initTelemetryAndScheduleUpload(InitializeParams initializeParams) {
     updateTelemetry(localStorage -> {
       localStorage.setInitialNewCodeFocus(initializeParams.isFocusOnNewCode());
       localStorage.setInitialAutomaticAnalysisEnablement(initializeParams.isAutomaticAnalysisEnabled());
+      localStorage.setLabsJoined(initializeParams.hasJoinedIdeLabs());
+      localStorage.setLabsEnabled(initializeParams.hasEnabledIdeLabs());
     });
     var initialDelay = Integer.parseInt(System.getProperty("sonarlint.internal.telemetry.initialDelay", "1"));
     scheduledExecutor.scheduleWithFixedDelay(this::upload, initialDelay, TELEMETRY_UPLOAD_DELAY, MINUTES);
@@ -318,6 +321,18 @@ public void mcpServerConfigurationRequested() {
     updateTelemetry(TelemetryLocalStorage::incrementMcpServerConfigurationRequestedCount);
   }
 
+  public void toggleIdeLabsEnablement(boolean newValue) {
+    updateTelemetry(storage -> storage.setLabsEnabled(newValue));
+  }
+
+  public void ideLabsLinkClicked(String linkId) {
+    updateTelemetry(storage -> storage.ideLabsLinkClicked(linkId));
+  }
+
+  public void ideLabsFeedbackLinkClicked(String featureId) {
+    updateTelemetry(storage -> storage.ideLabsFeedbackLinkClicked(featureId));
+  }
+
   @EventListener
   public void onMatchingSessionEnded(MatchingSessionEndedEvent event) {
     updateTelemetry(telemetryLocalStorage -> {
@@ -371,6 +386,12 @@ public void onAutomaticAnalysisSettingChanged(AutomaticAnalysisSettingChangedEve
     automaticAnalysisSettingToggled();
   }
 
+  @EventListener
+  public void onJoiningIdeLabs(JoinIdeLabsEvent event) {
+    updateTelemetry(storage -> storage.setLabsJoined(true));
+    updateTelemetry(storage -> storage.setLabsEnabled(true));
+  }
+
   @PreDestroy
   public void close() {
     if ((!MoreExecutors.shutdownAndAwaitTermination(scheduledExecutor, 1, TimeUnit.SECONDS)) && (InternalDebug.isEnabled())) {

backend/rpc-impl/src/main/java/org/sonarsource/sonarlint/core/rpc/impl/TelemetryRpcServiceDelegate.java

@@ -30,8 +30,11 @@
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.DevNotificationsClickedParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.FindingsFilteredParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.FixSuggestionResolvedParams;
+import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.IdeLabsExternalLinkClickedParams;
+import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.IdeLabsFeedbackLinkClickedParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.HelpAndFeedbackClickedParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.McpTransportModeUsedParams;
+import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.ToggleIdeLabsEnablementParams;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.ToolCalledParams;
 import org.sonarsource.sonarlint.core.telemetry.TelemetryService;
 
@@ -175,4 +178,19 @@ public void dependencyRiskInvestigatedLocally() {
   public void findingsFiltered(FindingsFilteredParams params) {
     notify(() -> getBean(TelemetryService.class).findingsFiltered(params.getFilterType()));
   }
+
+  @Override
+  public void toggleIdeLabsEnablement(ToggleIdeLabsEnablementParams params) {
+    notify(() -> getBean(TelemetryService.class).toggleIdeLabsEnablement(params.getNewValue()));
+  }
+
+  @Override
+  public void ideLabsExternalLinkClicked(IdeLabsExternalLinkClickedParams params) {
+    notify(() -> getBean(TelemetryService.class).ideLabsLinkClicked(params.getLinkId()));
+  }
+
+  @Override
+  public void ideLabsFeedbackLinkClicked(IdeLabsFeedbackLinkClickedParams params) {
+    notify(() -> getBean(TelemetryService.class).ideLabsFeedbackLinkClicked(params.getFeatureId()));
+  }
 }

backend/telemetry/src/main/java/org/sonarsource/sonarlint/core/telemetry/TelemetryLocalStorage.java

@@ -100,6 +100,10 @@ public class TelemetryLocalStorage {
   private boolean isMcpIntegrationEnabled;
   @Nullable
   private McpTransportMode mcpTransportModeUsed;
+  private boolean labsEnabled;
+  private boolean labsJoined;
+  private final Map<String, Integer> labsLinkClickedCount;
+  private final Map<String, Integer> labsFeedbackLinkClickedCount;
 
   TelemetryLocalStorage() {
     enabled = true;
@@ -117,6 +121,8 @@ public class TelemetryLocalStorage {
     fixSuggestionResolved = new LinkedHashMap<>();
     issuesUuidAiFixableSeen = new HashSet<>();
     calledToolsByName = new HashMap<>();
+    labsLinkClickedCount = new HashMap<>();
+    labsFeedbackLinkClickedCount = new HashMap<>();
   }
 
   public Collection<String> getRaisedIssuesRules() {
@@ -267,6 +273,8 @@ void clearAfterPing() {
     mcpServerConfigurationRequestedCount = 0;
     isMcpIntegrationEnabled = false;
     mcpTransportModeUsed = null;
+    labsLinkClickedCount.clear();
+    labsFeedbackLinkClickedCount.clear();
   }
 
   public long numUseDays() {
@@ -725,4 +733,36 @@ public void incrementMcpServerConfigurationRequestedCount() {
   public int getMcpServerConfigurationRequestedCount() {
     return mcpServerConfigurationRequestedCount;
   }
+
+  public Map<String, Integer> getLabsFeedbackLinkClickedCount() {
+    return labsFeedbackLinkClickedCount;
+  }
+
+  public Map<String, Integer> getLabsLinkClickedCount() {
+    return labsLinkClickedCount;
+  }
+
+  public boolean isLabsJoined() {
+    return labsJoined;
+  }
+
+  public boolean isLabsEnabled() {
+    return labsEnabled;
+  }
+
+  public void setLabsJoined(boolean labsJoined) {
+    this.labsJoined = labsJoined;
+  }
+
+  public void setLabsEnabled(boolean labsEnabled) {
+    this.labsEnabled = labsEnabled;
+  }
+
+  public void ideLabsLinkClicked(String linkId) {
+    this.labsLinkClickedCount.merge(linkId, 1, Integer::sum);
+  }
+
+  public void ideLabsFeedbackLinkClicked(String featureId) {
+    this.labsFeedbackLinkClickedCount.merge(featureId, 1, Integer::sum);
+  }
 }

backend/telemetry/src/main/java/org/sonarsource/sonarlint/core/telemetry/measures/payload/TelemetryMeasuresBuilder.java

@@ -23,6 +23,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 import java.util.UUID;
 import org.sonarsource.sonarlint.core.telemetry.TelemetryLiveAttributes;
 import org.sonarsource.sonarlint.core.telemetry.TelemetryLocalStorage;
@@ -34,6 +35,9 @@
 
 public class TelemetryMeasuresBuilder {
 
+  private static final String LINK_CLICKED_BASE_NAME = "link_clicked_count_";
+  private static final String FEEDBACK_CLICKED_BASE_NAME = "feedback_link_clicked_count_";
+
   private final String platform;
   private final String product;
   private final TelemetryLocalStorage storage;
@@ -77,6 +81,8 @@ public TelemetryMeasuresPayload build() {
 
     addMCPMeasures(values);
 
+    addLabsMeasures(values);
+
     return new TelemetryMeasuresPayload(UUID.randomUUID().toString(), platform, storage.installTime(), product, TelemetryMeasuresDimension.INSTALLATION, values);
   }
 
@@ -221,4 +227,21 @@ private void addMCPMeasures(List<TelemetryMeasuresValue> values) {
     }
   }
 
+  private void addLabsMeasures(ArrayList<TelemetryMeasuresValue> values) {
+    values.add(new TelemetryMeasuresValue("ide_labs.joined", String.valueOf(storage.isLabsJoined()), BOOLEAN, DAILY));
+    values.add(new TelemetryMeasuresValue("ide_labs.enabled", String.valueOf(storage.isLabsEnabled()), BOOLEAN, DAILY));
+    addAll(storage.getLabsLinkClickedCount(), LINK_CLICKED_BASE_NAME, values);
+    addAll(storage.getLabsFeedbackLinkClickedCount(), FEEDBACK_CLICKED_BASE_NAME, values);
+  }
+
+  private static void addAll(Map<String, Integer> clickCounts, String baseName, List<TelemetryMeasuresValue> values) {
+    clickCounts.entrySet().stream()
+      .filter(entry -> entry.getValue() > 0)
+      .map(entry -> new TelemetryMeasuresValue(
+        "ide_labs." + baseName + entry.getKey(),
+        String.valueOf(entry.getValue()),
+        INTEGER,
+        DAILY))
+      .forEach(values::add);
+  }
 }

backend/telemetry/src/test/java/org/sonarsource/sonarlint/core/telemetry/TelemetryHttpClientTests.java

@@ -123,6 +123,14 @@ private void assertTelemetryUploaded(boolean isDebugEnabled) {
     telemetryLocalStorage.incrementFlightRecorderSessionsCount();
     telemetryLocalStorage.setMcpIntegrationEnabled(true);
     telemetryLocalStorage.setMcpTransportModeUsed(McpTransportMode.STDIO);
+    telemetryLocalStorage.setLabsJoined(true);
+    telemetryLocalStorage.setLabsEnabled(true);
+    telemetryLocalStorage.ideLabsLinkClicked("changed_file_analysis_doc");
+    telemetryLocalStorage.ideLabsLinkClicked("privacy_policy");
+    telemetryLocalStorage.ideLabsLinkClicked("privacy_policy");
+    telemetryLocalStorage.ideLabsFeedbackLinkClicked("connected_mode");
+    telemetryLocalStorage.ideLabsFeedbackLinkClicked("manage_dependency_risk");
+    telemetryLocalStorage.ideLabsFeedbackLinkClicked("manage_dependency_risk");
     spy.upload(telemetryLocalStorage, getTelemetryLiveAttributesDto());
 
     telemetryMock.verify(postRequestedFor(urlEqualTo("/"))
@@ -148,7 +156,13 @@ private void assertTelemetryUploaded(boolean isDebugEnabled) {
             {"key":"findings_filtered.severity","value":"1","type":"integer","granularity":"daily"},
             {"key":"flight_recorder.sessions_count","value":"1","type":"integer","granularity":"daily"},
             {"key":"mcp.integration_enabled","value":"true","type":"boolean","granularity":"daily"},
-            {"key":"mcp.transport_mode","value":"STDIO","type":"string","granularity":"daily"}
+            {"key":"mcp.transport_mode","value":"STDIO","type":"string","granularity":"daily"},
+            {"key":"ide_labs.joined","value":"true","type":"boolean","granularity":"daily"},
+            {"key":"ide_labs.enabled","value":"true","type":"boolean","granularity":"daily"},
+            {"key":"ide_labs.link_clicked_count_changed_file_analysis_doc","value":"1","type":"integer","granularity":"daily"},
+            {"key":"ide_labs.link_clicked_count_privacy_policy","value":"2","type":"integer","granularity":"daily"},
+            {"key":"ide_labs.feedback_link_clicked_count_connected_mode","value":"1","type":"integer","granularity":"daily"},
+            {"key":"ide_labs.feedback_link_clicked_count_manage_dependency_risk","value":"2","type":"integer","granularity":"daily"}
           ]}
           """, PLATFORM),
           true, true)));

backend/telemetry/src/test/java/org/sonarsource/sonarlint/core/telemetry/TelemetryLocalStorageTests.java

@@ -23,6 +23,7 @@
 import java.time.LocalDateTime;
 import java.time.OffsetDateTime;
 import java.time.temporal.ChronoUnit;
+import java.util.Map;
 import java.util.UUID;
 import org.assertj.core.api.Condition;
 import org.junit.jupiter.api.Test;
@@ -362,4 +363,65 @@ void should_find_mcp_transport_mode_used() {
     data.setMcpTransportModeUsed(McpTransportMode.HTTP);
     assertThat(data.getMcpTransportModeUsed()).isEqualTo(McpTransportMode.HTTP);
   }
+
+  @Test
+  void should_set_labs_joined() {
+    var data = new TelemetryLocalStorage();
+    assertThat(data.isLabsJoined()).isFalse();
+    data.setLabsJoined(true);
+    assertThat(data.isLabsJoined()).isTrue();
+  }
+
+  @Test
+  void should_set_labs_enabled() {
+    var data = new TelemetryLocalStorage();
+    assertThat(data.isLabsEnabled()).isFalse();
+    data.setLabsEnabled(true);
+    assertThat(data.isLabsEnabled()).isTrue();
+  }
+
+  @Test
+  void should_increment_link_clicked_count_for_each_link_separately() {
+    var data = new TelemetryLocalStorage();
+    assertThat(data.getLabsLinkClickedCount()).isEmpty();
+
+    data.ideLabsLinkClicked("1");
+    data.ideLabsLinkClicked("2");
+    data.ideLabsLinkClicked("2");
+
+    assertThat(data.getLabsLinkClickedCount())
+      .isEqualTo(Map.of(
+        "1", 1,
+        "2", 2));
+  }
+
+  @Test
+  void should_increment_feedback_link_clicked_count_for_each_link_separately() {
+    var data = new TelemetryLocalStorage();
+    assertThat(data.getLabsFeedbackLinkClickedCount()).isEmpty();
+
+    data.ideLabsFeedbackLinkClicked("1");
+    data.ideLabsFeedbackLinkClicked("2");
+    data.ideLabsFeedbackLinkClicked("2");
+
+    assertThat(data.getLabsFeedbackLinkClickedCount())
+      .isEqualTo(Map.of(
+        "1", 1,
+        "2", 2));
+  }
+
+  @Test
+  void should_reset_link_clicked_data_after_ping() {
+    var data = new TelemetryLocalStorage();
+
+    data.ideLabsLinkClicked("1");
+    data.ideLabsLinkClicked("2");
+    data.ideLabsFeedbackLinkClicked("1");
+    data.ideLabsFeedbackLinkClicked("2");
+
+    data.clearAfterPing();
+
+    assertThat(data.getLabsLinkClickedCount()).isEmpty();
+    assertThat(data.getLabsFeedbackLinkClickedCount()).isEmpty();
+  }
 }