Prevent some notification from closing on solution close

Some notifications are session scoped rather than solution scoped.
SonarSource · Oct 28, 2024 · 1b1701c · 1b1701c
1 parent 92c4485
commit 1b1701c
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 16 deletions.
diff --git a/src/ConnectedMode.UnitTests/Binding/Suggestion/SuggestSharedBindingGoldBarTests.cs b/src/ConnectedMode.UnitTests/Binding/Suggestion/SuggestSharedBindingGoldBarTests.cs
@@ -71,6 +71,7 @@ public void Show_GeneratesCorrectNotificationStructure()
         notificationActions[1].CommandText.Should().Be(BindingStrings.SharedBindingSuggestionInfoOptionText);
         notificationActions[1].ShouldDismissAfterAction.Should().BeFalse();
         notificationActions[2].Should().BeSameAs(doNotShowAgainMock.Object);
+        notification.CloseOnSolutionClose.Should().Be(false);
     }
 
 

diff --git a/src/ConnectedMode/Binding/Suggestion/SuggestSharedBindingGoldBar.cs b/src/ConnectedMode/Binding/Suggestion/SuggestSharedBindingGoldBar.cs
@@ -60,12 +60,15 @@ public void Show(ServerType serverType, Action onConnectHandler)
             var notification = new Notification(
                 id: string.Format(IdTemplate, solutionInfoProvider.GetSolutionName()),
                 message: string.Format(BindingStrings.SharedBindingSuggestionMainText, serverType),
-                actions: new INotificationAction[]
-                {
+                actions:
+                [
                     new NotificationAction(BindingStrings.SharedBindingSuggestionConnectOptionText, _ => onConnectHandler(), true),
                     new NotificationAction(BindingStrings.SharedBindingSuggestionInfoOptionText, _ => OnLearnMore(), false),
                     doNotShowAgainNotificationAction
-                });
+                ],
+                // Prevent INotificationService from handling the on solution change events
+                // as this is exceptionally overriden by the SharedBindingSuggestionService
+                closeOnSolutionClose: false);
 
             notificationService.ShowNotification(notification);
         }

diff --git a/src/Integration.UnitTests/MefServices/SharedBindingSuggestionServiceTests.cs b/src/Integration.UnitTests/MefServices/SharedBindingSuggestionServiceTests.cs
@@ -147,6 +147,14 @@ public void ActiveSolutionChanged_SolutionIsOpened_ShowsGoldBarAndShowManageBind
         showAction.Should().NotBeNull();
         connectedModeManager.Received(1).ShowManageBindingDialog(true);
     }
+
+    [TestMethod]
+    public void ActiveSolutionChanged_SolutionIsClosed_ClosesNotification()
+    {
+        RaiseActiveSolutionChanged(false);
+
+        suggestSharedBindingGoldBar.Received().Close();
+    }
 
     private void RaiseActiveSolutionChanged(bool isSolutionOpened)
     {

diff --git a/src/Integration/MefServices/SharedBindingSuggestionService.cs b/src/Integration/MefServices/SharedBindingSuggestionService.cs
@@ -19,11 +19,9 @@
  */
 
 using System.ComponentModel.Composition;
-using System.Windows;
 using SonarLint.VisualStudio.ConnectedMode.Binding.Suggestion;
 using SonarLint.VisualStudio.ConnectedMode.Shared;
 using SonarLint.VisualStudio.ConnectedMode.UI;
-using SonarLint.VisualStudio.ConnectedMode.UI.ManageBinding;
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Binding;
 
@@ -88,6 +86,10 @@ private void OnActiveSolutionChanged(object sender, ActiveSolutionChangedEventAr
             {
                 Suggest();
             }
+            else
+            {
+                suggestSharedBindingGoldBar.Close();
+            }
         }
     }
 }
diff --git a/src/SLCore.UnitTests/NodeJS/Notifications/UnsupportedNodeVersionNotificationServiceTests.cs b/src/SLCore.UnitTests/NodeJS/Notifications/UnsupportedNodeVersionNotificationServiceTests.cs
@@ -21,6 +21,7 @@
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Notifications;
 using SonarLint.VisualStudio.SLCore.NodeJS.Notifications;
+using Language = SonarLint.VisualStudio.SLCore.Common.Models.Language;
 
 namespace SonarLint.VisualStudio.SLCore.UnitTests.NodeJS.Notifications
 {
@@ -37,11 +38,11 @@ public void MefCtor_CheckIsExported()
         }
 
         [DataTestMethod]
-        [DataRow(SLCore.Common.Models.Language.JS, "321", "123", "123")]
-        [DataRow(SLCore.Common.Models.Language.CSS, "99.00.11", "9876.5432", "9876.5432")]
-        [DataRow(SLCore.Common.Models.Language.JS, "321", null, "Not found")]
-        [DataRow(SLCore.Common.Models.Language.TS, "5.4.3.2.1", null, "Not found")]
-        public void Show_ShowsCorrectMessageAndNotificationId(SLCore.Common.Models.Language language, string expectedVersion, string actualVersion, string displayActualVersion)
+        [DataRow(Language.JS, "321", "123", "123")]
+        [DataRow(Language.CSS, "99.00.11", "9876.5432", "9876.5432")]
+        [DataRow(Language.JS, "321", null, "Not found")]
+        [DataRow(Language.TS, "5.4.3.2.1", null, "Not found")]
+        public void Show_ShowsCorrectMessageAndNotificationId(Language language, string expectedVersion, string actualVersion, string displayActualVersion)
         {
             INotification createdNotification = null;
             var notificationService = CreateNotificationService(n => createdNotification = n);
@@ -60,6 +61,7 @@ public void Show_ShowsCorrectMessageAndNotificationId(SLCore.Common.Models.Langu
             createdNotification.Id.Should().Be("sonarlint.nodejs.min.version.not.found");
             createdNotification.Message.Should().Be($"SonarLint: {language} analysis failed. Could not find a Node.js runtime (required: >={expectedVersion}, actual: {displayActualVersion}) on your computer.");
             createdNotification.Actions.Count().Should().Be(2);
+            createdNotification.CloseOnSolutionClose.Should().Be(false);
         }
 
         [TestMethod]

diff --git a/src/SLCore.UnitTests/Notification/SloopRestartFailedNotificationServiceTests.cs b/src/SLCore.UnitTests/Notification/SloopRestartFailedNotificationServiceTests.cs
@@ -18,7 +18,6 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-using System.Linq;
 using SonarLint.VisualStudio.Core.Notifications;
 using SonarLint.VisualStudio.SLCore.Notification;
 
@@ -59,6 +58,7 @@ public void Show_CreatesNotificationAndCallsShow()
             notification.Id.Should().Be("sonarlint.sloop.restart.failed");
             notification.Message.Should().Be("SonarLint background service failed to start");
             notification.Actions.Should().HaveCount(1);
+            notification.CloseOnSolutionClose.Should().Be(false);
 
             notification.Actions.First().Action(notification);
 

diff --git a/src/SLCore/NodeJS/Notifications/IUnsupportedNodeVersionNotificationService.cs b/src/SLCore/NodeJS/Notifications/IUnsupportedNodeVersionNotificationService.cs
@@ -54,11 +54,13 @@ public void Show(string languageName, string minVersion, string currentVersion =
             notificationService.ShowNotification(new VisualStudio.Core.Notifications.Notification(
                 id: NotificationId,
                 message: string.Format(NotificationStrings.NotificationUnsupportedNode, languageName, minVersion, currentVersion ?? NotificationStrings.NotificationNoneVersion),
-                actions: new INotificationAction[]
-                {
+                actions:
+                [
                     new NotificationAction(NotificationStrings.NotificationShowMoreInfoAction, _ => ShowMoreInfo(), false),
                     doNotShowAgainNotificationAction
-                }));
+                ],
+                closeOnSolutionClose: false)
+            );
         }
 
         private void ShowMoreInfo()

diff --git a/src/SLCore/Notification/ISloopRestartFailedNotificationService.cs b/src/SLCore/Notification/ISloopRestartFailedNotificationService.cs
@@ -18,7 +18,6 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-using System;
 using System.ComponentModel.Composition;
 using SonarLint.VisualStudio.Core.Notifications;
 
@@ -52,7 +51,8 @@ public void Show(Action act)
                 {
                     new NotificationAction(SLCoreStrings.SloopRestartFailedNotificationService_Restart, _ => act(), true)
                 },
-                showOncePerSession: false
+                showOncePerSession: false,
+                closeOnSolutionClose: false
             );
 
             notificationService.ShowNotification(notification);