MF2025 - Make messaging between Frontend and Backend work

Base/LogAppender/MessageExchange.cs

@@ -0,0 +1,20 @@
+using MobiFlight.BrowserMessages;
+using MobiFlight.BrowserMessages.Outgoing;
+using System;
+
+namespace MobiFlight.Base.LogAppender
+{
+    public class MessageExchange : ILogAppender
+    {   public void log(string message, LogSeverity severity)
+        {
+            var m = new LogEntry
+            {
+                Timestamp = DateTime.Now,
+                Message = message,
+                Severity = severity.ToString()
+            };
+
+            BrowserMessages.MessageExchange.Instance.Publish(m);
+        }
+    }
+}

MobiFlight/BrowserMessages/IMessageExchange.cs

@@ -0,0 +1,10 @@
+using System;
+
+namespace MobiFlight.BrowserMessages
+{
+    public interface IMessageExchange
+    {
+        void Publish<TPayload>(TPayload message);
+        void Subscribe<TPayload>(Action<TPayload> action);
+    }
+}

MobiFlight/BrowserMessages/IMessagePublisher.cs

@@ -0,0 +1,10 @@
+using System;
+
+namespace MobiFlight.BrowserMessages
+{
+    public interface IMessagePublisher
+    {
+        void Publish<TEvent>(TEvent eventToPublish);
+        void OnMessageReceived(Action<string> callback);
+    }
+}

MobiFlight/BrowserMessages/Incoming/Test.cs

@@ -0,0 +1,7 @@
+namespace MobiFlight.BrowserMessages.Incoming
+{
+    internal class Test
+    {
+        public string Message { get; set; }
+    }
+}

MobiFlight/BrowserMessages/Message.cs

@@ -0,0 +1,30 @@
+using System;
+
+namespace MobiFlight.BrowserMessages
+{
+    public class Message<T>
+    {
+        public String key
+        {
+            get; set;
+        }
+
+        public T payload { get; set; }
+
+        public Message()
+        {
+        }
+
+        public Message(string key, T payload)
+        {
+            this.key = key;
+            this.payload = payload;
+        }
+        public Message(T payload)
+        {
+            this.key = payload.GetType().Name;
+            this.payload = payload;
+        }
+
+    }
+}

MobiFlight/BrowserMessages/MessageExchange.cs

@@ -0,0 +1,115 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace MobiFlight.BrowserMessages
+{
+    // Implement as singleton   
+    public class MessageExchange : IMessageExchange
+    {
+        private readonly Dictionary<Type, List<object>> _subscribers = new Dictionary<Type, List<object>>();
+        private readonly Dictionary<String, Type> _subscribedTypes = new Dictionary<string, Type>();
+        private static readonly object _lock = new object();
+        private static MessageExchange _instance;
+        private IMessagePublisher _messagePublisher;
+
+        public static MessageExchange Instance
+        {
+            get
+            {
+                if (_instance == null)
+                {
+                    lock (_lock)
+                    {
+                        if (_instance == null)
+                        {
+                            _instance = new MessageExchange();
+                        }
+                    }
+                }
+                return _instance;
+            }
+        }
+
+        private MessageExchange()
+        {
+        }
+
+        public void SetPublisher(IMessagePublisher messagePublisher)
+        {
+            _messagePublisher = messagePublisher;
+            _messagePublisher.OnMessageReceived(PublishReceivedMessage);
+        }
+
+        /// <summary>
+        /// Publishes an event to the message publisher
+        /// </summary>
+        /// <typeparam name="TEvent"></typeparam>
+        /// <param name="eventToPublish"></param>
+        public void Publish<TEvent>(TEvent eventToPublish)
+        {
+            _messagePublisher?.Publish(eventToPublish);
+        }
+
+        /// <summary>
+        /// Publishes a received message to all subscribers
+        /// </summary>
+        private void PublishReceivedMessage(string jsonMessage)
+        {
+            var eventToPublish = JsonConvert.DeserializeObject<Message<object>>(jsonMessage);
+            if (!_subscribedTypes.ContainsKey(eventToPublish.key)) return;
+
+            Type eventType = _subscribedTypes[eventToPublish.key];
+
+            List<object> subscribers;
+
+            lock (_lock)
+            {
+                if (!_subscribers.ContainsKey(eventType)) return;
+                subscribers = _subscribers[eventType].ToList();
+            }
+
+            var deserializedPayload = JsonConvert.DeserializeObject(eventToPublish.payload.ToString(), eventType);
+
+            foreach (var subscriber in subscribers)
+            {
+                subscriber.GetType().GetMethod("Invoke")?.Invoke(subscriber, new[] { deserializedPayload });
+            }
+        }
+
+        public void Subscribe<TMessagePayloadType>(Action<TMessagePayloadType> callback)
+        {
+            var eventType = typeof(TMessagePayloadType);
+
+            lock (_lock)
+            {
+                if (!_subscribers.ContainsKey(eventType))
+                {
+                    _subscribedTypes.Add(eventType.Name, eventType);
+                    _subscribers[eventType] = new List<object>();
+                }
+
+                _subscribers[eventType].Add(callback);
+            }
+        }
+
+        public void Unsubscribe<TEvent>(Action<TEvent> callback)
+        {
+            var eventType = typeof(TEvent);
+
+            lock (_lock)
+            {
+                if (_subscribers.ContainsKey(eventType))
+                {
+                    _subscribers[eventType].Remove(callback);
+                    if (_subscribers[eventType].Count == 0)
+                    {
+                        _subscribers.Remove(eventType);
+                        _subscribedTypes.Remove(eventType.Name);
+                    }
+                }
+            }
+        }
+    }
+}

MobiFlight/BrowserMessages/Outgoing/LogEntry.cs

@@ -0,0 +1,11 @@
+using System;
+
+namespace MobiFlight.BrowserMessages.Outgoing
+{
+    public class LogEntry
+    {
+        public DateTime Timestamp;
+        public string Message;
+        public string Severity;
+    }
+}

MobiFlight/BrowserMessages/Outgoing/Notification.cs

@@ -0,0 +1,10 @@
+namespace MobiFlight.BrowserMessages.Outgoing
+{
+    internal class Notification
+    {
+        public string Type { get; set; }
+
+        public string Action { get; set; }
+        public object Value { get; set; }
+    }
+}

MobiFlight/BrowserMessages/Publisher/PostMessagePublisher.cs

@@ -0,0 +1,39 @@
+using Microsoft.Web.WebView2.Core;
+using Newtonsoft.Json;
+using System;
+
+namespace MobiFlight.BrowserMessages.Publisher
+{
+    public class PostMessagePublisher : IMessagePublisher
+    {
+        private readonly CoreWebView2 _webView;
+        private Action<object> _onMessageReceived;
+
+        public PostMessagePublisher(CoreWebView2 webView)
+        {
+            _webView = webView;
+            _webView.WebMessageReceived += WebView_WebMessageReceived;
+        }
+
+        public void Publish<TEvent>(TEvent eventToPublish)
+        {
+            if (_webView != null)
+            {
+                var message = new Message<TEvent>() { key = eventToPublish.GetType().Name, payload = eventToPublish };
+                var jsonMessage = JsonConvert.SerializeObject(message);
+                _webView.PostWebMessageAsJson(jsonMessage);
+            }
+        }
+
+        public void OnMessageReceived(Action<string> callback)
+        {
+            _onMessageReceived = (message) => callback((string)message);
+        }
+
+        private void WebView_WebMessageReceived(object sender, CoreWebView2WebMessageReceivedEventArgs args)
+        {
+            var message = args.WebMessageAsJson;
+            _onMessageReceived?.Invoke(message);
+        }
+    }
+}

MobiFlight/BrowserMessages/Publisher/WebsocketPublisher.cs

@@ -0,0 +1,65 @@
+using Newtonsoft.Json;
+using System;
+using System.Net.WebSockets;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MobiFlight.BrowserMessages.Publisher
+{
+
+    public class WebSocketPublisher : IMessagePublisher
+    {
+        private readonly ClientWebSocket _webSocket;
+        private Action<object> _onMessageReceived;
+
+        public WebSocketPublisher(string uri)
+        {
+            _webSocket = new ClientWebSocket();
+            Task.Run(() => ConnectAsync(uri));
+        }
+
+        private async Task ConnectAsync(string uri)
+        {
+            await _webSocket.ConnectAsync(new Uri(uri), CancellationToken.None);
+            await ReceiveMessagesAsync();
+        }
+
+        public void OnMessageReceived(Action<string> action)
+        {
+            _onMessageReceived = (message) => action((string) message);
+        }
+
+        public async void Publish<TEvent>(TEvent eventToPublish)
+        {
+            if (_webSocket.State == WebSocketState.Open)
+            {
+
+                var jsonMessage = JsonConvert.SerializeObject(eventToPublish);
+                var bytes = Encoding.UTF8.GetBytes(jsonMessage);
+                var buffer = new ArraySegment<byte>(bytes);
+
+                await _webSocket.SendAsync(buffer, WebSocketMessageType.Text, true, CancellationToken.None);
+            }
+        }
+
+        private async Task ReceiveMessagesAsync()
+        {
+            var buffer = new byte[1024 * 4];
+
+            while (_webSocket.State == WebSocketState.Open)
+            {
+                var result = await _webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
+                if (result.MessageType == WebSocketMessageType.Close)
+                {
+                    await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, string.Empty, CancellationToken.None);
+                }
+                else
+                {
+                    var message = Encoding.UTF8.GetString(buffer, 0, result.Count);
+                    _onMessageReceived?.Invoke(message);
+                }
+            }
+        }
+    }
+}

MobiFlightConnector.csproj

@@ -249,6 +249,7 @@
     <Compile Include="Base\Extensions.cs" />
     <Compile Include="Base\FullCacheInterface.cs" />
     <Compile Include="Base\i18n.cs" />
+    <Compile Include="Base\LogAppender\MessageExchange.cs" />
     <Compile Include="Base\PreconditionList.cs" />
     <Compile Include="Base\ProgressUpdateEvent.cs" />
     <Compile Include="Base\SerialNumber.cs" />
@@ -258,6 +259,15 @@
     <Compile Include="HubHop\Msfs2020EventIdPresetList.cs" />
     <Compile Include="MobiFlight\Board.cs" />
     <Compile Include="MobiFlight\BoardDefinitions.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\IMessageExchange.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\IMessagePublisher.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\Message.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\MessageExchange.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\Outgoing\LogEntry.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\Outgoing\Notification.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\Incoming\Test.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\Publisher\PostMessagePublisher.cs" />
+    <Compile Include="MobiFlight\BrowserMessages\Publisher\WebsocketPublisher.cs" />
     <Compile Include="MobiFlight\Clipboard.cs" />
     <Compile Include="MobiFlight\ConfigExtensions.cs" />
     <Compile Include="MobiFlight\Config\Compatibility\LedModuleDeprecated.cs" />
@@ -545,6 +555,12 @@
     <Compile Include="UI\Panels\Device\MFCustomDevicePanel.Designer.cs">
       <DependentUpon>MFCustomDevicePanel.cs</DependentUpon>
     </Compile>
+    <Compile Include="UI\Panels\FrontendPanel.cs">
+      <SubType>UserControl</SubType>
+    </Compile>
+    <Compile Include="UI\Panels\FrontendPanel.Designer.cs">
+      <DependentUpon>FrontendPanel.cs</DependentUpon>
+    </Compile>
     <Compile Include="UI\Panels\InputConfigPanel.cs">
       <SubType>UserControl</SubType>
     </Compile>
@@ -1529,6 +1545,9 @@
     <EmbeddedResource Include="UI\Panels\Device\MFShiftRegisterPanel.de.resx">
       <DependentUpon>MFShiftRegisterPanel.cs</DependentUpon>
     </EmbeddedResource>
+    <EmbeddedResource Include="UI\Panels\FrontendPanel.resx">
+      <DependentUpon>FrontendPanel.cs</DependentUpon>
+    </EmbeddedResource>
     <EmbeddedResource Include="UI\Panels\InputConfigPanel.de.resx">
       <DependentUpon>InputConfigPanel.cs</DependentUpon>
     </EmbeddedResource>

MobiFlightUnitTests/App.config

@@ -17,7 +17,7 @@
     <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
       <dependentAssembly>
         <assemblyIdentity name="System.Runtime.CompilerServices.Unsafe" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
-        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="6.0.0.0" />
+        <bindingRedirect oldVersion="0.0.0.0-4.0.4.1" newVersion="4.0.4.1" />
       </dependentAssembly>
       <dependentAssembly>
         <assemblyIdentity name="System.Buffers" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />