SONARPY-2464 Add safety around the telemetry mechanism

Author: ghislainpiot

sonar-python-plugin/src/main/java/org/sonar/plugins/python/SensorTelemetryStorage.java

@@ -22,6 +22,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.utils.Version;
 
 public class SensorTelemetryStorage {
   private static final Logger LOG = LoggerFactory.getLogger(SensorTelemetryStorage.class);
@@ -37,10 +38,22 @@ public Map<String, String> data() {
   }
 
   public void send(SensorContext sensorContext) {
-    data.forEach((k, v) -> {
-      LOG.info("Metrics property: {}={}", k, v);
-      sensorContext.addTelemetryProperty(k, v);
-    });
+    // This try/catch block should be useless, as in the worst case it should be a no-op depending on the SensorContext implementation
+    // It exists to be extra sure for the LTA
+    try {
+      var apiVersion = sensorContext.runtime().getApiVersion();
+      if (apiVersion.isGreaterThanOrEqual(Version.create(10, 9))) {
+        data.forEach((k, v) -> {
+          LOG.info("Collected metric: {}={}", k, v);
+          sensorContext.addTelemetryProperty(k, v);
+        });
+
+      } else {
+        LOG.info("Skipping sending metrics because the plugin API version is {}", apiVersion);
+      }
+    } catch (Exception e) {
+      LOG.error("Failed to send metrics", e);
+    }
   }
 
   public void updateMetric(MetricKey key, String value) {

sonar-python-plugin/src/test/java/org/sonar/plugins/python/SensorTelemetryStorageTest.java

@@ -0,0 +1,80 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.plugins.python;
+
+import java.io.File;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.slf4j.event.Level;
+import org.sonar.api.SonarEdition;
+import org.sonar.api.SonarQubeSide;
+import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.batch.sensor.internal.SensorContextTester;
+import org.sonar.api.internal.SonarRuntimeImpl;
+import org.sonar.api.testfixtures.log.LogTesterJUnit5;
+import org.sonar.api.utils.Version;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.doThrow;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
+
+class SensorTelemetryStorageTest {
+
+  @RegisterExtension
+  public LogTesterJUnit5 logTester = new LogTesterJUnit5().setLevel(Level.DEBUG);
+
+  @Test
+  void no_send_on_incompatible_version() {
+    var sensorContext = sensorContext(Version.create(10, 8));
+    var storage = new SensorTelemetryStorage();
+    storage.updateMetric(SensorTelemetryStorage.MetricKey.NOTEBOOK_PRESENT_KEY, "1");
+    storage.send(sensorContext);
+
+    verify(sensorContext, never()).addTelemetryProperty(any(), any());
+    assertThat(logTester.logs()).contains("Skipping sending metrics because the plugin API version is 10.8");
+  }
+
+  @Test
+  void send_after_10_9() {
+    var sensorContext = sensorContext(Version.create(10, 9));
+    var storage = new SensorTelemetryStorage();
+    storage.updateMetric(SensorTelemetryStorage.MetricKey.NOTEBOOK_PRESENT_KEY, "1");
+    storage.send(sensorContext);
+
+    verify(sensorContext).addTelemetryProperty(SensorTelemetryStorage.MetricKey.NOTEBOOK_PRESENT_KEY.key(), "1");
+  }
+
+  @Test
+  void no_crash_on_exception() {
+    var sensorContext = sensorContext(Version.create(10, 9));
+    doThrow(new RuntimeException("Some exception")).when(sensorContext).addTelemetryProperty(any(), any());
+    var storage = new SensorTelemetryStorage();
+    storage.updateMetric(SensorTelemetryStorage.MetricKey.NOTEBOOK_PRESENT_KEY, "1");
+    Assertions.assertDoesNotThrow(() -> storage.send(sensorContext));
+    assertThat(logTester.logs()).contains("Failed to send metrics");
+  }
+
+  private SensorContext sensorContext(Version version) {
+    var sensorContext = spy(SensorContextTester.create(new File("")));
+    sensorContext.setRuntime(SonarRuntimeImpl.forSonarQube(version, SonarQubeSide.SERVER, SonarEdition.DEVELOPER));
+    return sensorContext;
+  }
+}