PluginSettingsWindow: Throw exceptions to prevent invalid state, and then catch to LogException and show localized error message, and make OpenPluginSettingsDialog use this to return success boolean

Author: DavidGBrett

Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs

@@ -167,7 +167,8 @@ public interface IPublicAPI
         /// Open plugin setting window for a specific plugin
         /// </summary>
         /// <param name="pluginId">ID of the plugin whose settings window should be opened</param>
-        void OpenPluginSettingsWindow(string pluginId);
+        /// <returns>True if the plugin settings window was successfully opened; false otherwise</returns>
+        bool OpenPluginSettingsWindow(string pluginId);
 
         /// <summary>
         /// Get translation of current language

Flow.Launcher/Languages/en.xaml

@@ -487,6 +487,7 @@
 
     <!--  Plugin Settings Window  -->
     <system:String x:Key="pluginSettingsWindowTitle">Settings: {0}</system:String>
+    <system:String x:Key="pluginSettingsWindowOpenFailed">Failed to open plugin settings window</system:String>
 
     <!--  Release Notes Window  -->
     <system:String x:Key="seeMoreReleaseNotes">See more release notes on GitHub</system:String>

Flow.Launcher/PluginSettingsWindow.xaml.cs

@@ -17,24 +17,20 @@ public PluginSettingsWindow(string pluginId)
     {
         _settings = Ioc.Default.GetRequiredService<Settings>();
 
-        if (string.IsNullOrWhiteSpace(pluginId))
-        {
-            App.API.ShowMsgError("Plugin settings", "Invalid plugin id.");
-            return;
+        if (string.IsNullOrWhiteSpace(pluginId)){
+            throw new ArgumentException("Plugin ID cannot be null or whitespace.", nameof(pluginId));
         }
 
         var pluginPair = PluginManager.GetPluginForId(pluginId);
         if (pluginPair == null)
         {
-            App.API.ShowMsgError("Plugin settings", $"Unable to find plugin: {pluginId}");
-            return;
+            throw new InvalidOperationException($"Unable to find plugin: {pluginId}");
         }
 
         var pluginSettings = _settings.PluginSettings.GetPluginSettings(pluginId);
         if (pluginSettings == null)
         {
-            App.API.ShowMsgError("Plugin settings", $"Unable to load settings for plugin: {pluginPair.Metadata.Name}");
-            return;
+            throw new InvalidOperationException($"Unable to load settings for plugin: {pluginPair.Metadata.Name}");
         }
 
         var pluginViewModel = new PluginViewModel

Flow.Launcher/PublicAPIInstance.cs

@@ -147,12 +147,22 @@ public void OpenSettingDialog()
             });
         }
 
-        public void OpenPluginSettingsWindow(string pluginId)
+        public bool OpenPluginSettingsWindow(string pluginId)
         {
-            Application.Current.Dispatcher.Invoke(() =>
+            return Application.Current.Dispatcher.Invoke(() =>
             {
-                var window = new PluginSettingsWindow(pluginId);
-                window.Show();
+                try
+                {
+                    var window = new PluginSettingsWindow(pluginId);
+                    window.Show();
+                    return true;
+                }
+                catch (Exception e)
+                {
+                    LogException(ClassName, $"Failed to open plugin settings window for plugin id '{pluginId}'", e);
+                    ShowMsgError(Localize.pluginSettingsWindowOpenFailed());
+                    return false;
+                }
             });
         }
 

Flow.Launcher/ViewModel/MainViewModel.cs

@@ -1841,8 +1841,7 @@ private static Result ContextMenuPluginSettings(Result result)
                 PluginDirectory = Constant.ProgramDirectory,
                 Action = _ =>
                 {
-                    App.API.OpenPluginSettingsWindow(id);
-                    return true;
+                    return App.API.OpenPluginSettingsWindow(id);
                 },
                 OriginQuery = result.OriginQuery
             };