SLCORE-1541 Introduce a backend capability for SCA synchronization

Author: damien-urruty-sonarsource

API_CHANGES.md

@@ -1,3 +1,10 @@
+# 10.26
+
+## New features
+
+* Add a new `SCA_SYNCHRONIZATION` value in `org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.BackendCapability`. Clients using the feature need to declare it at initialization time.
+* Introduce a new `org.sonarsource.sonarlint.core.rpc.protocol.backend.tracking.ScaIssueTrackingRpcService` service and a `listAll` method
+
 # 10.25
 
 ## Breaking changes

backend/core/src/main/java/org/sonarsource/sonarlint/core/sync/ScaSynchronizationService.java

@@ -22,6 +22,8 @@
 import org.sonarsource.sonarlint.core.commons.log.SonarLintLogger;
 import org.sonarsource.sonarlint.core.commons.progress.SonarLintCancelMonitor;
 import org.sonarsource.sonarlint.core.event.ScaIssuesSynchronizedEvent;
+import org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.BackendCapability;
+import org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.InitializeParams;
 import org.sonarsource.sonarlint.core.serverapi.ServerApi;
 import org.sonarsource.sonarlint.core.serverconnection.issues.ServerScaIssue;
 import org.sonarsource.sonarlint.core.serverconnection.storage.UpdateSummary;
@@ -36,13 +38,18 @@ public class ScaSynchronizationService {
 
   private final StorageService storageService;
   private final ApplicationEventPublisher eventPublisher;
+  private final boolean isScaSynchronizationEnabled;
 
-  public ScaSynchronizationService(StorageService storageService, ApplicationEventPublisher eventPublisher) {
+  public ScaSynchronizationService(StorageService storageService, ApplicationEventPublisher eventPublisher, InitializeParams initializeParams) {
     this.storageService = storageService;
     this.eventPublisher = eventPublisher;
+    this.isScaSynchronizationEnabled = initializeParams.getBackendCapabilities().contains(BackendCapability.SCA_SYNCHRONIZATION);
   }
 
   public void synchronize(ServerApi serverApi, String connectionId, String sonarProjectKey, String branchName, SonarLintCancelMonitor cancelMonitor) {
+    if (!isScaSynchronizationEnabled) {
+      return;
+    }
     if (!isScaSupported(serverApi, connectionId)) {
       return;
     }

medium-tests/src/test/java/mediumtest/sca/ScaIssuesMediumTests.java

@@ -38,6 +38,7 @@
 import static org.assertj.core.api.Assertions.tuple;
 import static org.awaitility.Awaitility.await;
 import static org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.BackendCapability.FULL_SYNCHRONIZATION;
+import static org.sonarsource.sonarlint.core.rpc.protocol.backend.initialize.BackendCapability.SCA_SYNCHRONIZATION;
 import static org.sonarsource.sonarlint.core.serverconnection.issues.ServerScaIssue.Severity;
 import static org.sonarsource.sonarlint.core.serverconnection.issues.ServerScaIssue.Status;
 import static org.sonarsource.sonarlint.core.serverconnection.issues.ServerScaIssue.Type;
@@ -52,6 +53,7 @@ class ScaIssuesMediumTests {
   @SonarLintTest
   void it_should_return_no_sca_issues_if_the_scope_does_not_exist(SonarLintTestHarness harness) {
     var backend = harness.newBackend()
+      .withBackendCapability(SCA_SYNCHRONIZATION)
       .start();
 
     var scaIssues = listAllScaIssues(backend, CONFIG_SCOPE_ID);
@@ -62,6 +64,7 @@ void it_should_return_no_sca_issues_if_the_scope_does_not_exist(SonarLintTestHar
   @SonarLintTest
   void it_should_return_no_sca_issues_if_the_scope_is_not_bound(SonarLintTestHarness harness) {
     var backend = harness.newBackend()
+      .withBackendCapability(SCA_SYNCHRONIZATION)
       .withUnboundConfigScope(CONFIG_SCOPE_ID)
       .start();
 
@@ -73,6 +76,7 @@ void it_should_return_no_sca_issues_if_the_scope_is_not_bound(SonarLintTestHarne
   @SonarLintTest
   void it_should_return_no_sca_issues_if_the_storage_is_empty(SonarLintTestHarness harness) {
     var backend = harness.newBackend()
+      .withBackendCapability(SCA_SYNCHRONIZATION)
       .withSonarQubeConnection(CONNECTION_ID)
       .withBoundConfigScope(CONFIG_SCOPE_ID, CONNECTION_ID, PROJECT_KEY)
       .start();
@@ -89,6 +93,7 @@ void it_should_return_the_stored_sca_issues(SonarLintTestHarness harness) {
       .start();
     var scaIssueKey = UUID.fromString("550e8400-e29b-41d4-a716-446655440000");
     var backend = harness.newBackend()
+      .withBackendCapability(SCA_SYNCHRONIZATION)
       .withSonarQubeConnection(CONNECTION_ID, server,
         storage -> storage.withProject(PROJECT_KEY,
           project -> project.withMainBranch("main",
@@ -120,6 +125,7 @@ void it_should_refresh_sca_issues_when_requested(SonarLintTestHarness harness) {
                 "2.1.0", List.of("CONFIRM")))))
       .start();
     var backend = harness.newBackend()
+      .withBackendCapability(SCA_SYNCHRONIZATION)
       .withSonarQubeConnection(CONNECTION_ID, server,
         storage -> storage
           .withGlobalSettings(Map.of("sonar.sca.enabled", "true"))
@@ -153,7 +159,7 @@ void it_should_notify_client_when_new_sca_issues_are_added(SonarLintTestHarness
     harness.newBackend()
       .withSonarQubeConnection(CONNECTION_ID, server)
       .withBoundConfigScope(CONFIG_SCOPE_ID, CONNECTION_ID, PROJECT_KEY)
-      .withBackendCapability(FULL_SYNCHRONIZATION)
+      .withBackendCapability(FULL_SYNCHRONIZATION, SCA_SYNCHRONIZATION)
       .start(client);
     client.waitForSynchronization();
 
@@ -196,7 +202,7 @@ void it_should_notify_client_when_sca_issues_are_removed(SonarLintTestHarness ha
               .withType(Type.VULNERABILITY)
               .withSeverity(Severity.HIGH)))))
       .withBoundConfigScope(CONFIG_SCOPE_ID, CONNECTION_ID, PROJECT_KEY)
-      .withBackendCapability(FULL_SYNCHRONIZATION)
+      .withBackendCapability(FULL_SYNCHRONIZATION, SCA_SYNCHRONIZATION)
       .start(client);
     client.waitForSynchronization();
 
@@ -235,7 +241,7 @@ void it_should_notify_client_when_sca_issues_are_updated(SonarLintTestHarness ha
               .withStatus(Status.OPEN)
               .withTransitions(List.of(ServerScaIssue.Transition.REOPEN))))))
       .withBoundConfigScope(CONFIG_SCOPE_ID, CONNECTION_ID, PROJECT_KEY)
-      .withBackendCapability(FULL_SYNCHRONIZATION)
+      .withBackendCapability(FULL_SYNCHRONIZATION, SCA_SYNCHRONIZATION)
       .start(client);
     client.waitForSynchronization();
 
@@ -250,7 +256,8 @@ void it_should_notify_client_when_sca_issues_are_updated(SonarLintTestHarness ha
         .extracting(ScaIssueDto::getId, ScaIssueDto::getType, ScaIssueDto::getSeverity, ScaIssueDto::getStatus, ScaIssueDto::getTransitions, ScaIssueDto::getPackageName,
           ScaIssueDto::getPackageVersion)
         .containsExactly(
-          tuple(scaIssueKey, ScaIssueDto.Type.VULNERABILITY, ScaIssueDto.Severity.LOW, ScaIssueDto.Status.ACCEPT, List.of(ScaIssueDto.Transition.REOPEN), "com.example.vulnerable", "2.1.0"));
+          tuple(scaIssueKey, ScaIssueDto.Type.VULNERABILITY, ScaIssueDto.Severity.LOW, ScaIssueDto.Status.ACCEPT, List.of(ScaIssueDto.Transition.REOPEN), "com.example.vulnerable",
+            "2.1.0"));
     });
   }
 

rpc-protocol/src/main/java/org/sonarsource/sonarlint/core/rpc/protocol/backend/initialize/BackendCapability.java

@@ -29,5 +29,6 @@ public enum BackendCapability {
   FULL_SYNCHRONIZATION,
   TELEMETRY,
   MONITORING,
-  ISSUE_STREAMING
+  ISSUE_STREAMING,
+  SCA_SYNCHRONIZATION,
 }