SLCORE-1521 Add telemetry for binding suggestion

Author: eray-felek-sonarsource

backend/core/src/main/java/org/sonarsource/sonarlint/core/BindingSuggestionProvider.java

@@ -49,6 +49,7 @@
 import org.sonarsource.sonarlint.core.rpc.protocol.backend.config.binding.BindingSuggestionDto;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.binding.SuggestBindingParams;
 import org.sonarsource.sonarlint.core.serverapi.ServerApi;
+import org.sonarsource.sonarlint.core.telemetry.TelemetryService;
 import org.springframework.context.event.EventListener;
 
 import static java.lang.String.join;
@@ -69,17 +70,19 @@ public class BindingSuggestionProvider {
   private final AtomicBoolean enabled = new AtomicBoolean(true);
   private final SonarQubeClientManager sonarQubeClientManager;
   private final ClientFileSystemService clientFs;
+  private final TelemetryService telemetryService;
 
   @Inject
   public BindingSuggestionProvider(ConfigurationRepository configRepository, ConnectionConfigurationRepository connectionRepository, SonarLintRpcClient client,
-    BindingClueProvider bindingClueProvider, SonarProjectsCache sonarProjectsCache, SonarQubeClientManager sonarQubeClientManager, ClientFileSystemService clientFs) {
+    BindingClueProvider bindingClueProvider, SonarProjectsCache sonarProjectsCache, SonarQubeClientManager sonarQubeClientManager, ClientFileSystemService clientFs, TelemetryService telemetryService) {
     this.configRepository = configRepository;
     this.connectionRepository = connectionRepository;
     this.client = client;
     this.bindingClueProvider = bindingClueProvider;
     this.sonarProjectsCache = sonarProjectsCache;
     this.sonarQubeClientManager = sonarQubeClientManager;
     this.clientFs = clientFs;
+    this.telemetryService = telemetryService;
     this.executorService = new ExecutorServiceShutdownWatchable<>(FailSafeExecutors.newSingleThreadExecutor("Binding Suggestion Provider"));
   }
 
@@ -192,6 +195,9 @@ private List<BindingSuggestionDto> suggestBindingForEligibleScope(String checked
 
     if (suggestions.isEmpty()) {
       searchByRemoteUrlInConnections(suggestions, checkedConfigScopeId, candidateConnectionIds, cancelMonitor);
+      if (!suggestions.isEmpty()) {
+        telemetryService.suggestedRemoteBinding();
+      }
     }
 
     return suggestions;

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

@@ -234,6 +234,11 @@ public void exportedConnectedMode() {
     updateTelemetry(TelemetryLocalStorage::incrementExportedConnectedModeCount);
   }
 
+  public void suggestedRemoteBinding() {
+    updateTelemetry(TelemetryLocalStorage::incrementSuggestedRemoteBindingsCount);
+  }
+
+
   public void toolCalled(ToolCalledParams params) {
     updateTelemetry(storage -> storage.incrementToolCalledCount(params.getToolName(), params.isSucceeded()));
   }

backend/core/src/test/java/org/sonarsource/sonarlint/core/BindingSuggestionProviderTests.java

@@ -48,6 +48,7 @@
 import org.sonarsource.sonarlint.core.rpc.protocol.backend.config.binding.BindingSuggestionDto;
 import org.sonarsource.sonarlint.core.rpc.protocol.client.binding.SuggestBindingParams;
 import org.sonarsource.sonarlint.core.serverapi.component.ServerProject;
+import org.sonarsource.sonarlint.core.telemetry.TelemetryService;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.tuple;
@@ -82,8 +83,9 @@ class BindingSuggestionProviderTests {
   private final SonarProjectsCache sonarProjectsCache = mock(SonarProjectsCache.class);
   private final SonarQubeClientManager sonarQubeClientManager = mock(SonarQubeClientManager.class);
   private final ClientFileSystemService clientFs = mock(ClientFileSystemService.class);
+  private final TelemetryService telemetryService = mock(TelemetryService.class);
 
-  private final BindingSuggestionProvider underTest = new BindingSuggestionProvider(configRepository, connectionRepository, client, bindingClueProvider, sonarProjectsCache, sonarQubeClientManager, clientFs);
+  private final BindingSuggestionProvider underTest = new BindingSuggestionProvider(configRepository, connectionRepository, client, bindingClueProvider, sonarProjectsCache, sonarQubeClientManager, clientFs, telemetryService);
 
   @BeforeEach
   public void setup() {

backend/server-api/src/main/java/org/sonarsource/sonarlint/core/serverapi/component/ComponentApi.java

@@ -33,6 +33,7 @@
 
 public class ComponentApi {
   private static final SonarLintLogger LOG = SonarLintLogger.get();
+  private static final String ORGANIZATION_PARAM = "&organization=";
 
   private final ServerApiHelper helper;
 
@@ -56,7 +57,7 @@ private String buildAllFileKeysPath(String projectKey) {
     var url = new StringBuilder();
     url.append("api/components/tree.protobuf?qualifiers=FIL,UTS&");
     url.append("component=").append(UrlUtils.urlEncode(projectKey));
-    helper.getOrganizationKey().ifPresent(org -> url.append("&organization=").append(UrlUtils.urlEncode(org)));
+    helper.getOrganizationKey().ifPresent(org -> url.append(ORGANIZATION_PARAM).append(UrlUtils.urlEncode(org)));
     return url.toString();
   }
 
@@ -80,7 +81,7 @@ private String getAllProjectsUrl() {
     var searchUrl = new StringBuilder();
     searchUrl.append("api/components/search.protobuf?qualifiers=TRK");
     helper.getOrganizationKey()
-      .ifPresent(org -> searchUrl.append("&organization=").append(UrlUtils.urlEncode(org)));
+      .ifPresent(org -> searchUrl.append(ORGANIZATION_PARAM).append(UrlUtils.urlEncode(org)));
     return searchUrl.toString();
   }
 
@@ -93,7 +94,7 @@ public SearchProjectResponse searchProjects(String projectId, SonarLintCancelMon
       LOG.warn("Organization key is not set, cannot search projects for ID: {}", projectId);
       return null;
     }
-    var path = "/api/components/search_projects?projectIds=" + encodedProjectId + "&organization=" + organization.get();
+    var path = "/api/components/search_projects?projectIds=" + encodedProjectId + ORGANIZATION_PARAM + organization.get();
 
     try (var response = helper.rawGet(path, cancelMonitor)) {
       if (response.isSuccessful()) {

backend/server-api/src/test/java/org/sonarsource/sonarlint/core/serverapi/component/ComponentApiTests.java

@@ -29,7 +29,6 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.tuple;
-import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy;
 
 class ComponentApiTests {
   @RegisterExtension

backend/server-api/src/test/java/org/sonarsource/sonarlint/core/serverapi/projectbindings/ProjectBindingsApiTests.java

@@ -89,7 +89,7 @@ void should_return_empty_when_request_fails() {
       var url = "https://github.com/foo/bar";
       var encodedUrl = URLEncoder.encode(url, StandardCharsets.UTF_8);
       mockServer.addResponse("/dop-translation/project-bindings?url=" + encodedUrl,
-        new MockResponse().setResponseCode(500).setBody("Internal error"));
+        new MockResponse.Builder().code(500).body("Internal error").build());
 
       var result = underTest.getSQCProjectBindings(url, new SonarLintCancelMonitor());
 
@@ -140,11 +140,11 @@ void should_return_empty_when_request_fails() {
       var url = "https://github.com/foo/bar";
       var encodedUrl = URLEncoder.encode(url, StandardCharsets.UTF_8);
       mockServer.addResponse("/api/v2/dop-translation/project-bindings?repositoryUrl=" + encodedUrl,
-        new MockResponse().setResponseCode(500).setBody("Internal error"));
+        new MockResponse.Builder().code(500).body("Internal error").build());
 
       var result = underTest.getSQSProjectBindings(url, new SonarLintCancelMonitor());
 
       assertThat(result).isNull();
     }
   }
-}
+}

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

@@ -74,6 +74,7 @@ public class TelemetryLocalStorage {
   private int importedAddedBindingsCount;
   private int autoAddedBindingsCount;
   private int exportedConnectedModeCount;
+  private int suggestedRemoteBindingsCount;
   private long newIssuesFoundCount;
   private long issuesFixedCount;
   private int biggestNumberOfFilesInConfigScope;
@@ -238,6 +239,7 @@ void clearAfterPing() {
     importedAddedBindingsCount = 0;
     autoAddedBindingsCount = 0;
     exportedConnectedModeCount = 0;
+    suggestedRemoteBindingsCount = 0;
     newIssuesFoundCount = 0;
     issuesFixedCount = 0;
     biggestNumberOfFilesInConfigScope = 0;
@@ -484,10 +486,18 @@ public void incrementExportedConnectedModeCount() {
     exportedConnectedModeCount++;
   }
 
+  public void incrementSuggestedRemoteBindingsCount() {
+    suggestedRemoteBindingsCount++;
+  }
+
   public int getExportedConnectedModeCount() {
     return exportedConnectedModeCount;
   }
 
+  public int getSuggestedRemoteBindingsCount() {
+    return suggestedRemoteBindingsCount;
+  }
+
   public void addNewlyFoundIssues(long newIssues) {
     markSonarLintAsUsedToday();
     newIssuesFoundCount += newIssues;

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

@@ -91,6 +91,7 @@ private void addConnectedModeMeasures(ArrayList<TelemetryMeasuresValue> values)
       values.add(new TelemetryMeasuresValue("shared_connected_mode.imported", String.valueOf(storage.getImportedAddedBindingsCount()), INTEGER, DAILY));
       values.add(new TelemetryMeasuresValue("shared_connected_mode.auto", String.valueOf(storage.getAutoAddedBindingsCount()), INTEGER, DAILY));
       values.add(new TelemetryMeasuresValue("shared_connected_mode.exported", String.valueOf(storage.getExportedConnectedModeCount()), INTEGER, DAILY));
+      values.add(new TelemetryMeasuresValue("shared_connected_mode.remote_url", String.valueOf(storage.getSuggestedRemoteBindingsCount()), INTEGER, DAILY));
 
       values.add(new TelemetryMeasuresValue("bindings.child_count", String.valueOf(liveAttributes.countChildBindings()), INTEGER, DAILY));
       values.add(new TelemetryMeasuresValue("bindings.server_count", String.valueOf(liveAttributes.countSonarQubeServerBindings()), INTEGER, DAILY));

backend/telemetry/src/test/java/org/sonarsource/sonarlint/core/telemetry/payload/TelemetryMeasuresPayloadTests.java

@@ -63,6 +63,7 @@ void testGenerationJson() {
       "{\"key\":\"shared_connected_mode.imported\",\"value\":\"2\",\"type\":\"integer\",\"granularity\":\"daily\"}," +
       "{\"key\":\"shared_connected_mode.auto\",\"value\":\"3\",\"type\":\"integer\",\"granularity\":\"daily\"}," +
       "{\"key\":\"shared_connected_mode.exported\",\"value\":\"4\",\"type\":\"integer\",\"granularity\":\"daily\"}," +
+      "{\"key\":\"shared_connected_mode.remote_url\",\"value\":\"5\",\"type\":\"integer\",\"granularity\":\"daily\"}," +
       "{\"key\":\"bindings.child_count\",\"value\":\"1\",\"type\":\"integer\",\"granularity\":\"daily\"}," +
       "{\"key\":\"bindings.server_count\",\"value\":\"2\",\"type\":\"integer\",\"granularity\":\"daily\"}," +
       "{\"key\":\"bindings.cloud_eu_count\",\"value\":\"0\",\"type\":\"integer\",\"granularity\":\"daily\"}," +
@@ -88,6 +89,7 @@ private List<TelemetryMeasuresValue> generateMeasures() {
     values.add(new TelemetryMeasuresValue("shared_connected_mode.imported", String.valueOf(2), INTEGER, DAILY));
     values.add(new TelemetryMeasuresValue("shared_connected_mode.auto", String.valueOf(3), INTEGER, DAILY));
     values.add(new TelemetryMeasuresValue("shared_connected_mode.exported", String.valueOf(4), INTEGER, DAILY));
+    values.add(new TelemetryMeasuresValue("shared_connected_mode.remote_url", String.valueOf(5), INTEGER, DAILY));
 
     values.add(new TelemetryMeasuresValue("bindings.child_count", String.valueOf(1), INTEGER, DAILY));
     values.add(new TelemetryMeasuresValue("bindings.server_count", String.valueOf(2), INTEGER, DAILY));
@@ -109,6 +111,7 @@ private static void assertValues(List<TelemetryMeasuresValue> values) {
       .contains(tuple("shared_connected_mode.imported", "2", INTEGER, DAILY))
       .contains(tuple("shared_connected_mode.auto", "3", INTEGER, DAILY))
       .contains(tuple("shared_connected_mode.exported", "4", INTEGER, DAILY))
+      .contains(tuple("shared_connected_mode.remote_url", "5", INTEGER, DAILY))
       .contains(tuple("help_and_feedback.doc_link", "5", INTEGER, DAILY))
       .contains(tuple("analysis_reporting.trigger_count_vcs_changed_files", "7", INTEGER, DAILY));
   }

medium-tests/src/test/java/mediumtest/BindingSuggestionsMediumTests.java

@@ -366,6 +366,7 @@ void should_suggest_binding_by_remote_url_when_no_other_suggestions_found(SonarL
       .withSonarQubeCloudEuRegionApiUri(scServer.baseUrl())
       .withSonarCloudConnection(MYSONAR, "orgKey")
       .withUnboundConfigScope(CONFIG_SCOPE_ID, "unmatched-project-name")
+      .withTelemetryEnabled()
       .start(fakeClient);
 
     scServer.getMockServer().stubFor(get(urlEqualTo(expectedPath))
@@ -396,6 +397,7 @@ void should_suggest_binding_by_remote_url_when_no_other_suggestions_found(SonarL
     verify(fakeClient, timeout(5000)).suggestBinding(suggestionCaptor.capture());
 
     var bindingSuggestions = suggestionCaptor.getValue();
+    assertThat(backend.telemetryFileContent().getSuggestedRemoteBindingsCount()).isEqualTo(1);
     assertThat(bindingSuggestions).containsOnlyKeys(CONFIG_SCOPE_ID);
     assertThat(bindingSuggestions.get(CONFIG_SCOPE_ID))
       .extracting(BindingSuggestionDto::getConnectionId, BindingSuggestionDto::getSonarProjectKey, BindingSuggestionDto::getSonarProjectName)
@@ -430,6 +432,7 @@ void should_suggest_binding_by_remote_url_when_no_other_suggestions_found_for_so
     var backend = harness.newBackend()
       .withSonarQubeConnection(MYSONAR, sqServer.baseUrl())
       .withUnboundConfigScope(CONFIG_SCOPE_ID, "unmatched-project-name")
+      .withTelemetryEnabled()
       .start(fakeClient);
 
     sqServer.getMockServer().stubFor(get(urlEqualTo(expectedPath))
@@ -455,6 +458,7 @@ void should_suggest_binding_by_remote_url_when_no_other_suggestions_found_for_so
     verify(fakeClient, timeout(5000)).suggestBinding(suggestionCaptor.capture());
 
     var bindingSuggestions = suggestionCaptor.getValue();
+    assertThat(backend.telemetryFileContent().getSuggestedRemoteBindingsCount()).isEqualTo(1);
     assertThat(bindingSuggestions).containsOnlyKeys(CONFIG_SCOPE_ID);
     assertThat(bindingSuggestions.get(CONFIG_SCOPE_ID))
       .extracting(BindingSuggestionDto::getConnectionId, BindingSuggestionDto::getSonarProjectKey, BindingSuggestionDto::getSonarProjectName)