fix: Only pop toaster if we haven't connected to websocket

We're getting a lot of weird exceptions for Websockets even when the
connection works. This can lead to the notification toaster popping
constantly, which will confuse the user. Only pop the toaster if we
don't connect right after the exception is thrown.

Fixes #280

Author: qdot

Buttplug.Apps.WebsocketServerGUI/WebsocketServerControl.xaml.cs

@@ -1,17 +1,18 @@
-using System;
+using Buttplug.Components.Controls;
+using Buttplug.Components.WebsocketServer;
+using Buttplug.Core;
+using Buttplug.Server;
+using JetBrains.Annotations;
+using Microsoft.Win32;
+using System;
 using System.Collections.ObjectModel;
 using System.Net;
 using System.Net.NetworkInformation;
 using System.Net.Sockets;
+using System.Timers;
 using System.Windows;
 using System.Windows.Controls;
-using Buttplug.Components.WebsocketServer;
-using Buttplug.Core;
-using Buttplug.Server;
-using JetBrains.Annotations;
-using Microsoft.Win32;
 using Windows.UI.Notifications;
-using Buttplug.Components.Controls;
 
 namespace Buttplug.Apps.WebsocketServerGUI
 {
@@ -30,6 +31,8 @@ public partial class WebsocketServerControl
         private bool _loopback;
         private string _hostname;
         private ConnUrlList _connUrls;
+        private Timer _toastTimer;
+        private string _currentExceptionMessage;
 
         public WebsocketServerControl(IButtplugServerFactory bpFactory)
         {
@@ -41,6 +44,17 @@ public WebsocketServerControl(IButtplugServerFactory bpFactory)
             _config = new ButtplugConfig("Buttplug");
             _connUrls = new ConnUrlList();
             _port = 12345;
+
+            // Usually, if we throw errors then connect, it's not actually an error.
+            // If we don't connect after half a second of throwing an exception, pop the toaster, but not before then.
+            _toastTimer = new Timer
+            {
+                Interval = 500,
+                AutoReset = false,
+                Enabled = false,
+            };
+            _toastTimer.Elapsed += PopToaster;
+
             if (uint.TryParse(_config.GetValue("buttplug.server.port", "12345"), out uint pres))
             {
                 _port = pres;
@@ -76,6 +90,7 @@ public WebsocketServerControl(IButtplugServerFactory bpFactory)
 
         private void WebSocketExceptionHandler(object aObj, [NotNull] UnhandledExceptionEventArgs aEx)
         {
+            _toastTimer.Enabled = true;
             var errorMessage = (aEx.ExceptionObject as Exception)?.Message ?? "Unknown";
 
             if (_secure && errorMessage.Contains("Not GET request") && _ws != null && !aEx.IsTerminating)
@@ -90,14 +105,15 @@ private void WebSocketExceptionHandler(object aObj, [NotNull] UnhandledException
             }
             else if (_secure)
             {
-                errorMessage += "\n\nThis could mean that the client/browser has not accepted our SSL certificate. Try hitting the test button on the \"Websocket Server\" tab.";
+                errorMessage += "\n\nIf your connection is working, you can ignore this message. Otherwise, this could mean that the client/browser has not accepted our SSL certificate. Try hitting the test button on the \"Websocket Server\" tab.";
             }
-
+            _currentExceptionMessage = errorMessage;
             _log.LogException(aEx.ExceptionObject as Exception, true, errorMessage);
         }
 
         private void WebSocketConnectionAccepted(object aObj, [NotNull] ConnectionEventArgs aEvent)
         {
+            _toastTimer.Enabled = false;
             Dispatcher.InvokeAsync(() =>
             {
                 ConnStatus.Content = "(Connected) " + aEvent.ClientName;
@@ -107,13 +123,36 @@ private void WebSocketConnectionAccepted(object aObj, [NotNull] ConnectionEventA
 
         private void WebSocketConnectionClosed(object aObj, [NotNull] ConnectionEventArgs aEvent)
         {
+            _toastTimer.Enabled = false;
             Dispatcher.InvokeAsync(() =>
             {
                 ConnStatus.Content = "(Not Connected)";
                 DisconnectButton.IsEnabled = false;
             });
         }
 
+        private void PopToaster(object aObj, ElapsedEventArgs aArgs)
+        {
+            _toastTimer.Enabled = false;
+            Dispatcher.InvokeAsync(() =>
+            {
+                // Use the toast system to notify the user
+                var toastXml = ToastNotificationManager.GetTemplateContent(ToastTemplateType.ToastText02);
+                var tmp = toastXml.GetXml();
+                toastXml.SelectSingleNode("//*[@id='1']").InnerText = "Buttplug Error";
+                toastXml.SelectSingleNode("//*[@id='2']").InnerText = _currentExceptionMessage;
+                var toast = new ToastNotification(toastXml);
+                toast.Activated += OnActivatedToast;
+                var appId = (string)Registry.GetValue(
+                    @"HKEY_LOCAL_MACHINE\SOFTWARE\Classes\AppID\" + AppDomain.CurrentDomain.FriendlyName, "AppId",
+                    string.Empty);
+                if (appId != null && appId.Length > 0)
+                {
+                    ToastNotificationManager.CreateToastNotifier(appId).Show(toast);
+                }
+            });
+        }
+
         private void ExceptionLogged(object aObj, [NotNull] LogExceptionEventArgs aEvent)
         {
             if (aEvent.ErrorMessage != null)
@@ -122,20 +161,8 @@ private void ExceptionLogged(object aObj, [NotNull] LogExceptionEventArgs aEvent
                 {
                     // Show the error message in the app
                     LastError.Text = aEvent.ErrorMessage;
-
-                    // Use the toast system to notify the user
-                    var toastXml = ToastNotificationManager.GetTemplateContent(ToastTemplateType.ToastText02);
-                    var tmp = toastXml.GetXml();
-                    toastXml.SelectSingleNode("//*[@id='1']").InnerText = "Buttplug Error";
-                    toastXml.SelectSingleNode("//*[@id='2']").InnerText = aEvent.ErrorMessage;
-                    var toast = new ToastNotification(toastXml);
-                    toast.Activated += OnActivatedToast;
-                    var appId = (string)Registry.GetValue(@"HKEY_LOCAL_MACHINE\SOFTWARE\Classes\AppID\" + AppDomain.CurrentDomain.FriendlyName, "AppId", string.Empty);
-                    if (appId != null && appId.Length > 0)
-                    {
-                        ToastNotificationManager.CreateToastNotifier(appId).Show(toast);
-                    }
                 });
+                _toastTimer.Enabled = true;
             }
         }
 
@@ -296,4 +323,4 @@ public override string ToString()
             return WsUrl;
         }
     }
-}
+}