Publish frontend message when Auto Run changes, added integration test. (#2754)

* Publish frontend message when Auto Run changes, added integration test.

* Remove testing for persistence since it doesn't work well in a parallel execution in CI

* Implement review feedback

Author: DocMoebiuz

MobiFlight/BrowserMessages/MessageExchange.cs

@@ -14,6 +14,13 @@ public class MessageExchange : IMessageExchange
         private static MessageExchange _instance;
         private IMessagePublisher _messagePublisher;
 
+        /// <summary>
+        /// Setting a contextProvider is only required for integration tests
+        /// Provide a () => null provider so that the synchronization context is not used during unit tests,
+        /// Outside of unit tests, a working synchronization context will automatically be available
+        /// </summary>
+        private Func<System.Threading.SynchronizationContext> _syncContextProvider;
+
         public static MessageExchange Instance
         {
             get
@@ -91,8 +98,10 @@ private void PublishReceivedMessage(string jsonMessage)
             try
             {
                 var deserializedPayload = JsonConvert.DeserializeObject(eventToPublish.payload.ToString(), eventType);
-                var synchronizationContext = System.Threading.SynchronizationContext.Current;
-                
+                var synchronizationContext = _syncContextProvider != null
+                    ? _syncContextProvider.Invoke()
+                    : System.Threading.SynchronizationContext.Current;
+
                 foreach (var subscriber in subscribers)
                 {
                     Action invokeSubscriber = () =>
@@ -154,5 +163,9 @@ public void Unsubscribe<TEvent>(Action<TEvent> callback)
                 }
             }
         }
+        public void SetSynchronizationContextProvider(Func<System.Threading.SynchronizationContext> provider)
+        {
+            _syncContextProvider = provider;
+        }
     }
 }

MobiFlightUnitTests/UI/MainFormTests.cs

@@ -4,6 +4,7 @@
 using MobiFlight.BrowserMessages.Incoming;
 using MobiFlight.BrowserMessages.Outgoing;
 using MobiFlight.Controllers;
+using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
 using System.Collections.Specialized;
@@ -17,6 +18,7 @@ namespace MobiFlight.UI.Tests
     [TestClass()]
     public class MainFormTests
     {
+        private bool originalAutoRun;
         private StringCollection originalRecentFiles;
         private string _tempDirectory;
 
@@ -89,6 +91,9 @@ public void SetUp()
             // Save original RecentFiles
             originalRecentFiles = Properties.Settings.Default.RecentFiles;
 
+            // Save original AutoRun setting
+            originalAutoRun = Properties.Settings.Default.AutoRun;
+
             // Initialize with clean state
             Properties.Settings.Default.RecentFiles = new StringCollection();
 
@@ -104,6 +109,7 @@ public void Cleanup()
         {
             // Restore original RecentFiles
             Properties.Settings.Default.RecentFiles = originalRecentFiles;
+            Properties.Settings.Default.AutoRun = originalAutoRun;
             Properties.Settings.Default.Save();
 
             _mainForm.RestorePublisher();
@@ -495,21 +501,55 @@ public void ConfigItemModified_BindingsUnchanged_DoesNotPublishUpdate()
         }
         #endregion
 
+        #region Browser Message Handling Tests
+        [TestMethod]
+        public void ToggleAutoRun_PublishesSettingsUpdate()
+        {
+            // Arrange
+            var initialAutoRun = Properties.Settings.Default.AutoRun;
+
+            // Act (Simulate Frontend action after clicking on autorun toggle button)
+            var jsonMessage = JsonConvert.SerializeObject(new BrowserMessages.Message<CommandProjectToolbar>(new CommandProjectToolbar()
+            {
+                Action = CommandProjectToolbarAction.toggleAutoRun
+            }));
+
+            _mainForm.Publisher.SimulateIncomingMessage(jsonMessage);
+
+            // Assert
+            var settingsMessage = _mainForm.Publisher.PublishedMessages.FirstOrDefault(m => m.GetType() == typeof(Settings)) as Settings;
+            Assert.IsNotNull(settingsMessage, "Settings message should be published");
+            Assert.AreEqual(!initialAutoRun, settingsMessage.AutoRun,
+                "AutoRun should be toggled in published settings");
+        }
+        #endregion
+
         public class TestMessagePublisher : IMessagePublisher
         {
             public List<object> PublishedMessages { get; } = new List<object>();
+            private Action<object> _onMessageReceived;
 
             public void Publish<TEvent>(TEvent eventToPublish)
             {
                 PublishedMessages.Add(eventToPublish);
             }
 
-            public void OnMessageReceived(Action<string> callback) { }
+            public void OnMessageReceived(Action<string> callback)
+            {
+                _onMessageReceived = (message) => callback((string)message);
+            }
 
             public void Reset()
             {
                 PublishedMessages.Clear();
             }
+
+            public void SimulateIncomingMessage(string jsonMessage)
+            {
+                MessageExchange.Instance.SetSynchronizationContextProvider(() => null);
+                _onMessageReceived?.Invoke(jsonMessage);
+                MessageExchange.Instance.SetSynchronizationContextProvider(null);
+            }
         }
     }
 }

UI/MainForm.cs

@@ -521,12 +521,6 @@ private async void MainForm_Shown(object sender, EventArgs e)
             xPlaneDirectToolStripMenuItem.Image = Properties.Resources.warning;
             toolStripConnectedDevicesIcon.Image = Properties.Resources.warning;
 
-            // we only load the autorun value stored in settings
-            // and do not use possibly passed in autoRun from cmdline
-            // because latter shall only have an temporary influence
-            // on the program
-            setAutoRunValue(Properties.Settings.Default.AutoRun);
-
             updateNotifyContextMenu(false);
 
             // Reset the Title of the Main Window so that it displays the Version too.
@@ -2461,6 +2455,9 @@ public void RenameProject(string newName)
         private void setAutoRunValue(bool value)
         {
             Properties.Settings.Default.AutoRun = value;
+
+            // Triggers update to frontend
+            Properties.Settings.Default.Save();
         }
 
         public void settingsToolStripMenuItem_Click(object sender, EventArgs e)