SLLS-12 Show link to connection settings as a shortcut to disable notifications

* SLLS-12 Experiment with "disable" option in server notifications

* SLLS-12 Use a single request object (protocol restriction)

* SLLS-12 Just ask client to open connection settings

Author: jblievremont

src/main/java/org/sonarsource/sonarlint/ls/SonarLintExtendedLanguageClient.java

@@ -41,6 +41,9 @@ public interface SonarLintExtendedLanguageClient extends LanguageClient {
   @JsonRequest("sonarlint/openPathToNodeSettings")
   CompletableFuture<Void> openPathToNodeSettings();
 
+  @JsonRequest("sonarlint/openConnectionSettings")
+  CompletableFuture<Void> openConnectionSettings(boolean isSonarCloud);
+
   @JsonRequest("sonarlint/showRuleDescription")
   CompletableFuture<Void> showRuleDescription(ShowRuleDescriptionParams params);
 

src/main/java/org/sonarsource/sonarlint/ls/connected/notifications/ServerNotifications.java

@@ -20,7 +20,7 @@
 package org.sonarsource.sonarlint.ls.connected.notifications;
 
 import java.time.ZonedDateTime;
-import java.util.Collections;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
 import javax.annotation.CheckForNull;
@@ -47,6 +47,8 @@
 
 public class ServerNotifications implements WorkspaceSettingsChangeListener, WorkspaceFolderSettingsChangeListener {
 
+  private static final MessageActionItem SETTINGS_ACTION = new MessageActionItem("Open Settings");
+
   private final SonarLintExtendedLanguageClient client;
   private final ProjectBindingManager projectBindingManager;
   private final WorkspaceFoldersManager workspaceFoldersManager;
@@ -163,13 +165,14 @@ public void handle(ServerNotification serverNotification) {
       ShowMessageRequestParams params = new ShowMessageRequestParams();
       params.setType(MessageType.Info);
       params.setMessage(String.format("%s Notification: %s", label, serverNotification.message()));
-      MessageActionItem browseAction = new MessageActionItem();
-      browseAction.setTitle("Open in " + label);
-      params.setActions(Collections.singletonList(browseAction));
+      MessageActionItem browseAction = new MessageActionItem("Show on " + label);
+      params.setActions(Arrays.asList(browseAction, SETTINGS_ACTION));
       client.showMessageRequest(params).thenAccept(action -> {
         if(browseAction.equals(action)) {
           telemetry.devNotificationsClicked(serverNotification.category());
           client.browseTo(serverNotification.link());
+        } else if (SETTINGS_ACTION.equals(action)) {
+          client.openConnectionSettings(isSonarCloud);
         }
       });
     }

src/test/java/org/sonarsource/sonarlint/ls/connected/notifications/ServerNotificationsTest.java

@@ -21,6 +21,7 @@
 
 
 import java.time.ZonedDateTime;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.concurrent.CompletableFuture;
 import org.eclipse.lsp4j.MessageActionItem;
@@ -227,28 +228,55 @@ void updateRegistrationsOnWorkspaceSettingsChange() {
   }
 
   @Test
-  void shouldShowSonarQubeNotificationToUserAndClickOnNotification() {
+  void shouldShowSonarQubeNotificationToUserAndClickOnNotificationLink() {
     ServerNotifications.EventListener listener = underTest.new EventListener(false);
     String category = "category";
     String message = "message";
     String link = "http://some.link";
     String projectKey = "projectKey";
     ServerNotification notification = new DefaultServerNotification(category, message, link, projectKey, ZonedDateTime.now());
 
-    MessageActionItem browseAction = new MessageActionItem("Open in SonarQube");
+    MessageActionItem browseAction = new MessageActionItem("Show on SonarQube");
+    MessageActionItem settingsAction = new MessageActionItem("Open Settings");
     when(client.showMessageRequest(any())).thenReturn(CompletableFuture.completedFuture(browseAction));
+
     listener.handle(notification);
 
     verify(telemetry).devNotificationsReceived(category);
     ArgumentCaptor<ShowMessageRequestParams> messageCaptor = ArgumentCaptor.forClass(ShowMessageRequestParams.class);
     verify(client).showMessageRequest(messageCaptor.capture());
     ShowMessageRequestParams shownMessage = messageCaptor.getValue();
     assertThat(shownMessage).extracting(ShowMessageRequestParams::getMessage, ShowMessageRequestParams::getActions)
-      .containsExactly("SonarQube Notification: message", Collections.singletonList(browseAction));
+      .containsExactly("SonarQube Notification: message", Arrays.asList(browseAction, settingsAction));
     verify(telemetry).devNotificationsClicked(category);
     verify(client).browseTo(link);
   }
 
+  @Test
+  void shouldShowSonarQubeNotificationToUserAndOpenSettings() {
+    ServerNotifications.EventListener listener = underTest.new EventListener(false);
+    String category = "category";
+    String message = "message";
+    String link = "http://some.link";
+    String projectKey = "projectKey";
+    ServerNotification notification = new DefaultServerNotification(category, message, link, projectKey, ZonedDateTime.now());
+
+    MessageActionItem browseAction = new MessageActionItem("Show on SonarQube");
+    MessageActionItem settingsAction = new MessageActionItem("Open Settings");
+    when(client.showMessageRequest(any())).thenReturn(CompletableFuture.completedFuture(settingsAction));
+
+    listener.handle(notification);
+
+    verify(telemetry).devNotificationsReceived(category);
+    ArgumentCaptor<ShowMessageRequestParams> messageCaptor = ArgumentCaptor.forClass(ShowMessageRequestParams.class);
+    verify(client).showMessageRequest(messageCaptor.capture());
+    ShowMessageRequestParams shownMessage = messageCaptor.getValue();
+    assertThat(shownMessage).extracting(ShowMessageRequestParams::getMessage, ShowMessageRequestParams::getActions)
+      .containsExactly("SonarQube Notification: message", Arrays.asList(browseAction, settingsAction));
+
+    verify(client).openConnectionSettings(false);
+  }
+
   @Test
   void shouldShowSonarCloudNotificationToUserAndNotClickOnNotification() {
     ServerNotifications.EventListener listener = underTest.new EventListener(true);
@@ -258,16 +286,18 @@ void shouldShowSonarCloudNotificationToUserAndNotClickOnNotification() {
     String projectKey = "projectKey";
     ServerNotification notification = new DefaultServerNotification(category, message, link, projectKey, ZonedDateTime.now());
 
-    MessageActionItem browseAction = new MessageActionItem("Open in SonarCloud");
+    MessageActionItem browseAction = new MessageActionItem("Show on SonarCloud");
     when(client.showMessageRequest(any())).thenReturn(CompletableFuture.completedFuture(null));
+    MessageActionItem settingsAction = new MessageActionItem("Open Settings");
+
     listener.handle(notification);
 
     verify(telemetry).devNotificationsReceived(category);
     ArgumentCaptor<ShowMessageRequestParams> messageCaptor = ArgumentCaptor.forClass(ShowMessageRequestParams.class);
     verify(client).showMessageRequest(messageCaptor.capture());
     ShowMessageRequestParams shownMessage = messageCaptor.getValue();
     assertThat(shownMessage).extracting(ShowMessageRequestParams::getMessage, ShowMessageRequestParams::getActions)
-      .containsExactly("SonarCloud Notification: message", Collections.singletonList(browseAction));
+      .containsExactly("SonarCloud Notification: message", Arrays.asList(browseAction, settingsAction));
     verify(telemetry, never()).devNotificationsClicked(category);
   }
 

src/test/java/org/sonarsource/sonarlint/ls/mediumtests/AbstractLanguageServerMediumTests.java

@@ -341,6 +341,10 @@ public CompletableFuture<Void> browseTo(String link) {
       return CompletableFutures.computeAsync(null);
     }
 
+    @Override
+    public CompletableFuture<Void> openConnectionSettings(boolean isSonarCloud) {
+      return CompletableFutures.computeAsync(null);
+    }
   }
 
   protected void emulateConfigurationChangeOnClient(@Nullable String testFilePattern, @Nullable Boolean disableTelemetry, String... ruleConfigs) {