SLCORE-1815 Use SQ:IDE key.

Author: Krosovok

API_CHANGES.md

@@ -13,7 +13,7 @@
 * Introduce a new `org.sonarsource.sonarlint.core.rpc.protocol.backend.labs.IdeLabsRpcService` service and a `joinIdeLabsProgram` method.
   * Use it to allow users to join the SonarQube for IDE Labs program
   * The method accepts user email and IDE name as parameters
-* Add a new `GESSIE_TELEMETRY` value in `org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.BackendCapability`. Clients using the feature need to declare it at initialization time.
+* Add a new `GESSIE_TELEMETRY` capability in `org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.BackendCapability`. Clients using the feature need to declare it at initialization time. Enables sending data to Gessie (Generic Event System) alongside previous telemetry implementation.
 
 # 10.35
 

backend/core/src/main/java/org/sonarsource/sonarlint/core/telemetry/gessie/GessieSpringConfig.java

@@ -31,10 +31,17 @@
 public class GessieSpringConfig {
 
   public static final String PROPERTY_GESSIE_ENDPOINT = "sonarlint.internal.telemetry.gessie.endpoint";
+  public static final String PROPERTY_GESSIE_API_KEY = "sonarlint.internal.telemetry.gessie.api.key";
   private static final String GESSIE_ENDPOINT = "https://events.sonardata.io";
+  private static final String IDE_SOURCE = "CiiwpdWnR21rWEOkgJ8tr3EYSXb7dzaQ5ezbipLb";
 
   @Bean
   String gessieEndpoint() {
     return System.getProperty(PROPERTY_GESSIE_ENDPOINT, GESSIE_ENDPOINT);
   }
+
+  @Bean
+  String gessieApiKey() {
+    return System.getProperty(PROPERTY_GESSIE_API_KEY, IDE_SOURCE);
+  }
 }

backend/telemetry/src/main/java/org/sonarsource/sonarlint/core/telemetry/gessie/GessieHttpClient.java

@@ -34,16 +34,17 @@
 public class GessieHttpClient {
 
   private static final SonarLintLogger LOG = SonarLintLogger.get();
-  private static final String X_API_KEY_IDE = "value";
 
   private final Gson gson = configureGson();
   private final HttpClient client;
   private final String endpoint;
   @Value("${SONARLINT_TELEMETRY_LOG:false}")
   private boolean isTelemetryLogEnabled;
 
-  public GessieHttpClient(HttpClientProvider httpClientProvider, @Qualifier("gessieEndpoint") String gessieEndpoint) {
-    this.client = httpClientProvider.getHttpClientWithXApiKeyAndRetries(X_API_KEY_IDE);
+  public GessieHttpClient(HttpClientProvider httpClientProvider,
+    @Qualifier("gessieEndpoint") String gessieEndpoint,
+    @Qualifier("gessieApiKey") String gessieApiKey) {
+    this.client = httpClientProvider.getHttpClientWithXApiKeyAndRetries(gessieApiKey);
     this.endpoint = gessieEndpoint;
   }
 
@@ -56,8 +57,7 @@ public void postEvent(GessieEvent event) {
 
   private void logGessiePayload(String json) {
     if (isTelemetryLogEnabled) {
-      LOG.info("Sending Gessie payload.");
-      LOG.info(json);
+      LOG.info("Sending Gessie payload.\n{}", json);
     }
   }
 
@@ -71,7 +71,8 @@ private static Gson configureGson() {
   private static void handleGessieResponse(CompletableFuture<HttpClient.Response> responseCompletableFuture) {
     responseCompletableFuture.thenAccept(response -> {
       if (!response.isSuccessful() && InternalDebug.isEnabled()) {
-        LOG.error("Failed to upload telemetry to Gessie: {}", response);
+        LOG.error("Failed to upload telemetry to Gessie: {} \n{}", response,
+          response.bodyAsString());
       }
     }).exceptionally(exception -> {
       if (InternalDebug.isEnabled()) {

backend/telemetry/src/test/java/org/sonarsource/sonarlint/core/telemetry/gessie/GessieHttpClientTests.java

@@ -58,7 +58,7 @@ class GessieHttpClientTests {
 
   @BeforeEach
   void setUp() {
-    tested = new GessieHttpClient(HttpClientProvider.forTesting(), mockGessie.baseUrl());
+    tested = new GessieHttpClient(HttpClientProvider.forTesting(), mockGessie.baseUrl(), "value");
   }
 
   @Test

its/tests/src/test/java/its/SonarQubeEnterpriseEditionTests.java

@@ -431,7 +431,7 @@ void should_return_risk_dependency_details() {
 
       assertThat(riskDetailsResponse)
         .usingRecursiveComparison()
-        .isEqualTo(new GetDependencyRiskDetailsResponse(firstDependencyRiskKey, DependencyRiskDto.Severity.MEDIUM,
+        .isEqualTo(new GetDependencyRiskDetailsResponse(firstDependencyRiskKey, DependencyRiskDto.Severity.LOW,
           DependencyRiskDto.SoftwareQuality.SECURITY, "com.fasterxml.woodstox:woodstox-core", "6.2.7",
           DependencyRiskDto.Type.VULNERABILITY, "CVE-2022-40152",
           "Those using Woodstox to parse XML data may be vulnerable to Denial of Service attacks (DOS) if DTD support is enabled. If the parser is running on user supplied input, an attacker may supply content that causes the parser to crash by stackoverflow. This effect may support a denial of service attack.",

medium-tests/src/test/java/mediumtest/gessie/GessieIntegrationMediumTests.java

@@ -34,6 +34,7 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.sonarsource.sonarlint.core.telemetry.InternalDebug;
+import org.sonarsource.sonarlint.core.telemetry.gessie.GessieSpringConfig;
 import org.sonarsource.sonarlint.core.test.utils.junit5.SonarLintTest;
 import org.sonarsource.sonarlint.core.test.utils.junit5.SonarLintTestHarness;
 import uk.org.webcompere.systemstubs.environment.EnvironmentVariables;
@@ -53,7 +54,7 @@
 class GessieIntegrationMediumTests {
 
   private static final String IDE_ENDPOINT = "/ide";
-  public static final String FAILED_ONCE = "Failed once";
+  private static final String FAILED_ONCE = "Failed once";
 
   @SystemStub
   private EnvironmentVariables environmentVariables;
@@ -75,12 +76,14 @@ void setUp() {
     this.oldDebugValue = InternalDebug.isEnabled();
     InternalDebug.setEnabled(true);
     environmentVariables.set("SONARLINT_HTTP_RETRY_INTERVAL_SECONDS", "0");
+    System.setProperty(GessieSpringConfig.PROPERTY_GESSIE_API_KEY, "value");
   }
 
   @AfterEach
   void tearDown() {
     InternalDebug.setEnabled(oldDebugValue);
     environmentVariables.remove("SONARLINT_HTTP_RETRY_INTERVAL_SECONDS");
+    System.clearProperty(GessieSpringConfig.PROPERTY_GESSIE_API_KEY);
   }
 
   @SonarLintTest