Refactor UI thread invocation with DispatcherHelper

Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs

@@ -5,6 +5,7 @@
 using System.Windows;
 using System.Windows.Controls;
 using System.Windows.Documents;
+using Flow.Launcher.Core.Resource;
 using Flow.Launcher.Infrastructure.Storage;
 using Flow.Launcher.Plugin;
 
@@ -99,22 +100,22 @@
                     {
                         case TextBox textBox:
                             var text = value as string ?? string.Empty;
-                            textBox.Dispatcher.Invoke(() => textBox.Text = text);
+                            DispatcherHelper.Invoke(() => textBox.Text = text);
                             break;
                         case PasswordBox passwordBox:
                             var password = value as string ?? string.Empty;
-                            passwordBox.Dispatcher.Invoke(() => passwordBox.Password = password);
+                            DispatcherHelper.Invoke(() => passwordBox.Password = password);
                             break;
                         case ComboBox comboBox:
-                            comboBox.Dispatcher.Invoke(() => comboBox.SelectedItem = value);
+                            DispatcherHelper.Invoke(() => comboBox.SelectedItem = value);
                             break;
                         case CheckBox checkBox:
                             var isChecked = value is bool boolValue
                                 ? boolValue
                                 // If can parse the default value to bool, use it, otherwise use false
                                 : value is string stringValue && bool.TryParse(stringValue, out var boolValueFromString)
                                     && boolValueFromString;
-                            checkBox.Dispatcher.Invoke(() => checkBox.IsChecked = isChecked);
+                            DispatcherHelper.Invoke(() => checkBox.IsChecked = isChecked);
                             break;
                     }
                 }
@@ -422,14 +423,14 @@
                         }
                     case "hyperlink":
                         {
                             var hyperlink = new Hyperlink
                             {
                                 ToolTip = attributes.Description,
                                 NavigateUri = attributes.url
                             };
 
                             hyperlink.Inlines.Add(attributes.urlLabel);
                             hyperlink.RequestNavigate += (sender, e) =>
                             {
                                 API.OpenUrl(e.Uri);
                                 e.Handled = true;
@@ -443,7 +444,7 @@
                                 TextAlignment = TextAlignment.Left,
                                 TextWrapping = TextWrapping.Wrap
                             };
                             textBlock.Inlines.Add(hyperlink);
 
                             contentControl = textBlock;
 

Flow.Launcher.Core/Resource/DispatcherHelper.cs

@@ -0,0 +1,102 @@
+using System;
+using System.Threading.Tasks;
+using System.Windows;
+using System.Windows.Threading;
+
+namespace Flow.Launcher.Core.Resource;
+
+#pragma warning disable VSTHRD001 // Avoid legacy thread switching APIs
+
+public static class DispatcherHelper
+{
+    public static void Invoke(Action action, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        Invoke(Application.Current?.Dispatcher, action, priority);
+    }
+
+    public static T Invoke<T>(Func<T> func, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        return Invoke(Application.Current?.Dispatcher, func, priority);
+    }
+
+    public static void Invoke(Dispatcher dispatcher, Action action, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        if (dispatcher == null) return;
+        if (dispatcher.CheckAccess())
+        {
+            action();
+        }
+        else
+        {
+            dispatcher.Invoke(action, priority);
+        }
+    }
+
+    public static T Invoke<T>(Dispatcher dispatcher, Func<T> func, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        if (dispatcher == null) return default;
+        if (dispatcher.CheckAccess())
+        {
+            return func();
+        }
+        else
+        {
+            return dispatcher.Invoke(func, priority);
+        }
+    }
+
+    public static async Task InvokeAsync(Action action, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        await InvokeAsync(Application.Current?.Dispatcher, action, priority);
+    }
+
+    public static async Task<T> InvokeAsync<T>(Func<T> func, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        return await InvokeAsync(Application.Current?.Dispatcher, func, priority);
+    }
+
+    public static async Task InvokeAsync(Func<Task> func, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        await InvokeAsync(Application.Current?.Dispatcher, func, priority);
+    }
+
+    public static async Task InvokeAsync(Dispatcher dispatcher, Action action, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        if (dispatcher == null) return;
+        if (dispatcher.CheckAccess())
+        {
+            action();
+        }
+        else
+        {
+            await dispatcher.InvokeAsync(action, priority);
+        }
+    }
+
+    public static async Task<T> InvokeAsync<T>(Dispatcher dispatcher, Func<T> func, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        if (dispatcher == null) return default;
+        if (dispatcher.CheckAccess())
+        {
+            return func();
+        }
+        else
+        {
+            return await dispatcher.InvokeAsync(func, priority);
+        }
+    }
+
+    public static async Task InvokeAsync(Dispatcher dispatcher, Func<Task> func, DispatcherPriority priority = DispatcherPriority.Normal)
+    {
+        if (dispatcher == null) return;
+        if (dispatcher.CheckAccess())
+        {
+            await func();
+        }
+        else
+        {
+            var task = await dispatcher.InvokeAsync(func, priority);
+            await task;
+        }
+    }
+}

Flow.Launcher.Core/Resource/Theme.cs

@@ -592,7 +592,7 @@ private void SetResizeBoarderThickness(Thickness? effectMargin)
         /// </summary>
         public async Task RefreshFrameAsync()
         {
-            await Application.Current.Dispatcher.InvokeAsync(() =>
+            await DispatcherHelper.InvokeAsync(() =>
             {
                 // Get the actual backdrop type and drop shadow effect settings
                 var (backdropType, useDropShadowEffect) = GetActualValue();
@@ -619,7 +619,7 @@ await Application.Current.Dispatcher.InvokeAsync(() =>
         /// </summary>
         public async Task SetBlurForWindowAsync()
         {
-            await Application.Current.Dispatcher.InvokeAsync(() =>
+            await DispatcherHelper.InvokeAsync(() =>
             {
                 // Get the actual backdrop type and drop shadow effect settings
                 var (backdropType, _) = GetActualValue();

Flow.Launcher/App.xaml.cs

@@ -334,7 +334,7 @@ private static void AutoPluginUpdates()
                     var timer = new PeriodicTimer(TimeSpan.FromHours(5));
                     await PluginInstaller.CheckForPluginUpdatesAsync((plugins) =>
                     {
-                        Current.Dispatcher.Invoke(() =>
+                        DispatcherHelper.Invoke(() =>
                         {
                             var pluginUpdateWindow = new PluginUpdateWindow(plugins);
                             pluginUpdateWindow.ShowDialog();
@@ -345,7 +345,7 @@ await PluginInstaller.CheckForPluginUpdatesAsync((plugins) =>
                         // check updates on startup
                         await PluginInstaller.CheckForPluginUpdatesAsync((plugins) =>
                         {
-                            Current.Dispatcher.Invoke(() =>
+                            DispatcherHelper.Invoke(() =>
                             {
                                 var pluginUpdateWindow = new PluginUpdateWindow(plugins);
                                 pluginUpdateWindow.ShowDialog();
@@ -444,7 +444,7 @@ protected virtual void Dispose(bool disposing)
                 {
                     // Dispose needs to be called on the main Windows thread,
                     // since some resources owned by the thread need to be disposed.
-                    _mainWindow?.Dispatcher.Invoke(_mainWindow.Dispose);
+                    DispatcherHelper.Invoke(_mainWindow?.Dispatcher, _mainWindow.Dispose);
                     _mainVM?.Dispose();
                     DialogJump.Dispose();
                     _internationalization.Dispose();

Flow.Launcher/Helper/SingleInstance.cs

@@ -3,6 +3,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using System.Windows;
+using Flow.Launcher.Core.Resource;
 
 // http://blogs.microsoft.co.il/arik/2010/05/28/wpf-single-instance-application/
 // modified to allow single instace restart
@@ -24,7 +25,7 @@
     /// running as Administrator, can activate it with command line arguments.
     /// For most apps, this will not be much of an issue.
     /// </remarks>
     public static class SingleInstance<TApplication> where TApplication : Application, ISingleInstanceApp
     {
         #region Private Fields
 
@@ -100,7 +101,9 @@
                 await pipeServer.WaitForConnectionAsync();
 
                 // Do an asynchronous call to ActivateFirstInstance function
-                Application.Current?.Dispatcher.Invoke(ActivateFirstInstance);
+#pragma warning disable VSTHRD103 // Call async methods when in an async method
+                DispatcherHelper.Invoke(ActivateFirstInstance);
+#pragma warning restore VSTHRD103 // Call async methods when in an async method
 
                 // Disconect client
                 pipeServer.Disconnect();
@@ -135,7 +138,7 @@
                 return;
             }
 
             ((TApplication)Application.Current).OnSecondAppStarted();
         }
 
         #endregion

Flow.Launcher/Helper/WallpaperPathRetrieval.cs

@@ -3,9 +3,9 @@
 using System.IO;
 using System.Linq;
 using System.Threading;
-using System.Windows;
 using System.Windows.Media;
 using System.Windows.Media.Imaging;
+using Flow.Launcher.Core.Resource;
 using Flow.Launcher.Infrastructure;
 using Microsoft.Win32;
 
@@ -22,11 +22,11 @@ public static class WallpaperPathRetrieval
     public static Brush GetWallpaperBrush()
     {
         // Invoke the method on the UI thread
-        if (!Application.Current.Dispatcher.CheckAccess())
-        {
-            return Application.Current.Dispatcher.Invoke(GetWallpaperBrush);
-        }
+        return DispatcherHelper.Invoke(GetWallpaperBrushCore);
+    }
 
+    private static Brush GetWallpaperBrushCore()
+    {
         try
         {
             var wallpaperPath = Win32Helper.GetWallpaperPath();

Flow.Launcher/MainWindow.xaml.cs

@@ -25,8 +25,8 @@
 using Flow.Launcher.Plugin.SharedCommands;
 using Flow.Launcher.Plugin.SharedModels;
 using Flow.Launcher.ViewModel;
 using iNKORE.UI.WPF.Modern;
 using iNKORE.UI.WPF.Modern.Controls;
 using DataObject = System.Windows.DataObject;
 using Key = System.Windows.Input.Key;
 using MouseButtons = System.Windows.Forms.MouseButtons;
@@ -116,7 +116,7 @@
         {
             var handle = Win32Helper.GetWindowHandle(this, true);
             _hwndSource = HwndSource.FromHwnd(handle);
             _hwndSource.AddHook(WndProc);
             Win32Helper.HideFromAltTab(this);
             Win32Helper.DisableControlBox(this);
         }
@@ -153,7 +153,7 @@
                     Localize.appUpdateButtonContent(),
                     () =>
                     {
-                        Application.Current.Dispatcher.Invoke(() =>
+                        DispatcherHelper.Invoke(() =>
                         {
                             var releaseNotesWindow = new ReleaseNotesWindow();
                             releaseNotesWindow.Show();
@@ -225,7 +225,7 @@
                 {
                     case nameof(MainViewModel.MainWindowVisibilityStatus):
                         {
-                            Dispatcher.Invoke(() =>
+                            DispatcherHelper.Invoke(() =>
                             {
                                 if (_viewModel.MainWindowVisibilityStatus)
                                 {
@@ -269,7 +269,7 @@
                         {
                             // QueryTextBox seems to be update with a DispatcherPriority as low as ContextIdle.
                             // To ensure QueryTextBox is up to date with QueryText from the View, we need to Dispatch with such a priority
-                            Dispatcher.Invoke(() => QueryTextBox.CaretIndex = QueryTextBox.Text.Length);
+                            DispatcherHelper.Invoke(() => QueryTextBox.CaretIndex = QueryTextBox.Text.Length);
                             _viewModel.QueryTextCursorMovedToEnd = false;
                         }
                         break;
@@ -376,7 +376,7 @@
         {
             try
             {
                 _hwndSource.RemoveHook(WndProc);
             }
             catch (Exception)
             {
@@ -542,7 +542,7 @@
                         // Switch to Normal state
                         WindowState = WindowState.Normal;
 
-                        Application.Current?.Dispatcher.Invoke(new Action(() =>
+                        DispatcherHelper.Invoke(() =>
                         {
                             double normalWidth = Width;
                             double normalHeight = Height;
@@ -555,7 +555,7 @@
                             {
                                 DragMove();
                             }
-                        }), DispatcherPriority.ApplicationIdle);
+                        }, DispatcherPriority.ApplicationIdle);
                     }
                     else
                     {
@@ -726,19 +726,8 @@
             {
                 Win32Helper.RegisterSleepModeListener(() =>
                 {
-                    if (Application.Current == null)
-                    {
-                        return;
-                    }
-
                     // We must run InitSoundEffects on UI thread because MediaPlayer is a DispatcherObject
-                    if (!Application.Current.Dispatcher.CheckAccess())
-                    {
-                        Application.Current.Dispatcher.Invoke(InitSoundEffects);
-                        return;
-                    }
-
-                    InitSoundEffects();
+                    DispatcherHelper.Invoke(InitSoundEffects);
                 });
             }
             catch (Exception e)

Flow.Launcher/MessageBoxEx.xaml.cs

@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Input;
+using Flow.Launcher.Core.Resource;
 using Flow.Launcher.Infrastructure;
 
 namespace Flow.Launcher
@@ -29,11 +30,16 @@ public static MessageBoxResult Show(
             MessageBoxImage icon = MessageBoxImage.None,
             MessageBoxResult defaultResult = MessageBoxResult.OK)
         {
-            if (!Application.Current.Dispatcher.CheckAccess())
-            {
-                return Application.Current.Dispatcher.Invoke(() => Show(messageBoxText, caption, button, icon, defaultResult));
-            }
+            return DispatcherHelper.Invoke(() => ShowCore(messageBoxText, caption, button, icon, defaultResult));
+        }
 
+        private static MessageBoxResult ShowCore(
+            string messageBoxText,
+            string caption = "",
+            MessageBoxButton button = MessageBoxButton.OK,
+            MessageBoxImage icon = MessageBoxImage.None,
+            MessageBoxResult defaultResult = MessageBoxResult.OK)
+        {
             try
             {
                 msgBox = new MessageBoxEx(button);

Flow.Launcher/Msg.xaml.cs

@@ -3,6 +3,7 @@
 using System.Windows;
 using System.Windows.Input;
 using System.Windows.Media.Animation;
+using Flow.Launcher.Core.Resource;
 using Flow.Launcher.Infrastructure;
 using Flow.Launcher.Plugin.SharedModels;
 
@@ -80,12 +81,12 @@ public async void Show(string title, string subTitle, string iconPath)
 
             Show();
 
-            await Dispatcher.InvokeAsync(async () =>
+            await DispatcherHelper.InvokeAsync(async () =>
             {
                 if (!closing)
                 {
                     closing = true;
-                    await Dispatcher.InvokeAsync(fadeOutStoryboard.Begin);
+                    fadeOutStoryboard.Begin();
                 }
             });
         }

Flow.Launcher/MsgWithButton.xaml.cs

@@ -3,6 +3,7 @@
 using System.Windows;
 using System.Windows.Input;
 using System.Windows.Media.Animation;
+using Flow.Launcher.Core.Resource;
 using Flow.Launcher.Infrastructure;
 using Flow.Launcher.Plugin.SharedModels;
 
@@ -82,12 +83,12 @@ public async void Show(string title, string buttonText, Action buttonAction, str
 
             Show();
 
-            await Dispatcher.InvokeAsync(async () =>
+            await DispatcherHelper.InvokeAsync(async () =>
             {
                 if (!closing)
                 {
                     closing = true;
-                    await Dispatcher.InvokeAsync(fadeOutStoryboard.Begin);
+                    fadeOutStoryboard.Begin();
                 }
             });
         }

Flow.Launcher/Notification.cs

@@ -1,7 +1,7 @@
 using System;
 using System.Collections.Concurrent;
 using System.IO;
-using System.Windows;
+using Flow.Launcher.Core.Resource;
 using Flow.Launcher.Infrastructure;
 using Microsoft.Toolkit.Uwp.Notifications;
 
@@ -41,7 +41,7 @@ internal static void Uninstall()
 
         public static void Show(string title, string subTitle, string iconPath = null)
         {
-            Application.Current.Dispatcher.Invoke(() =>
+            DispatcherHelper.Invoke(() =>
             {
                 ShowInternal(title, subTitle, iconPath);
             });
@@ -91,7 +91,7 @@ private static void LegacyShow(string title, string subTitle, string iconPath)
 
         public static void ShowWithButton(string title, string buttonText, Action buttonAction, string subTitle, string iconPath = null)
         {
-            Application.Current.Dispatcher.Invoke(() =>
+            DispatcherHelper.Invoke(() =>
             {
                 ShowInternalWithButton(title, buttonText, buttonAction, subTitle, iconPath);
             });