fix: Use EnableCollectionSynchronization on GUI log

We update the log GUI from multiple threads, so just use
EnableCollectionSynchronization to make sure all functions of that
collection that need to be sync'd are.

Fixes #274

Author: qdot

Buttplug.Components.Controls/ButtplugLogControl.xaml.cs

@@ -1,19 +1,16 @@
-using System;
+using Buttplug.Core;
+using Microsoft.Win32;
+using NLog;
+using NLog.Config;
+using NLog.Targets;
+using System;
 using System.Collections.ObjectModel;
 using System.Linq;
 using System.Text;
-using System.Threading;
-using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Controls;
+using System.Windows.Data;
 using System.Windows.Input;
-using System.Windows.Threading;
-using Buttplug.Core;
-using Microsoft.Win32;
-using NLog;
-using NLog.Config;
-using NLog.Targets;
-using System.Collections.Specialized;
 
 namespace Buttplug.Components.Controls
 {
@@ -25,44 +22,22 @@ public class LogList : ObservableCollection<string>
     public sealed class ButtplugGUIMessageNLogTarget : TargetWithLayoutHeaderAndFooter
     {
         private readonly LogList _logs;
-        private readonly Thread _winThread;
+        private readonly object _logLock = new object();
         public long MaxLogs;
 
-        public ButtplugGUIMessageNLogTarget(LogList aList, Thread aWinThread, long aMaxLogs = 1000)
+        public ButtplugGUIMessageNLogTarget(LogList aList, long aMaxLogs = 1000)
         {
-            // TODO This totally needs a mutex or something
             _logs = aList;
-            _winThread = aWinThread;
             MaxLogs = aMaxLogs;
+            BindingOperations.EnableCollectionSynchronization(_logs, _logLock);
         }
 
         protected override void Write(LogEventInfo aLogEvent)
         {
-            try
-            {
-                if (_winThread != Dispatcher.CurrentDispatcher.Thread)
-                {
-                    Dispatcher.FromThread(_winThread).Invoke(() =>
-                    {
-                        _logs.Add(Layout.Render(aLogEvent));
-                        while (_logs.Count > MaxLogs)
-                        {
-                            _logs.RemoveAt(0);
-                        }
-                    });
-                }
-                else
-                {
-                    _logs.Add(Layout.Render(aLogEvent));
-                    while (_logs.Count > MaxLogs)
-                    {
-                        _logs.RemoveAt(0);
-                    }
-                }
-            }
-            catch (TaskCanceledException)
+            _logs.Add(Layout.Render(aLogEvent));
+            while (_logs.Count > MaxLogs)
             {
-                // noop
+                _logs.RemoveAt(0);
             }
         }
     }
@@ -97,7 +72,7 @@ public ButtplugLogControl()
             // Null check Dispatcher, otherwise test bringup for GUI tests will fail.
             if (Dispatcher != null)
             {
-                _logTarget = new ButtplugGUIMessageNLogTarget(_logs, Dispatcher.Thread);
+                _logTarget = new ButtplugGUIMessageNLogTarget(_logs);
                 c.AddTarget("ButtplugGuiLogger", _logTarget);
                 _outgoingLoggingRule = new LoggingRule("*", LogLevel.Debug, _logTarget);
                 c.LoggingRules.Add(_outgoingLoggingRule);
@@ -209,4 +184,4 @@ private void LogListBox_KeyUp(object sender, System.Windows.Input.KeyEventArgs e
             }
         }
     }
-}
+}