Merge pull request Flow-Launcher#3854 from Flow-Launcher/plugin_initialization

jjw24 · TBM13 · commit 56e519908fd3 · 2025-11-07T00:22:22.000-03:00
Asynchronous Loading &amp; Initialization Plugin Model to Improve Window Startup Speed
diff --git a/Flow.Launcher.Core/Plugin/IResultUpdateRegister.cs b/Flow.Launcher.Core/Plugin/IResultUpdateRegister.cs
@@ -0,0 +1,12 @@
+﻿using Flow.Launcher.Plugin;
+
+namespace Flow.Launcher.Core.Plugin;
+
+public interface IResultUpdateRegister
+{
+    /// <summary>
+    /// Register a plugin to receive results updated event.
+    /// </summary>
+    /// <param name="pair"></param>
+    void RegisterResultsUpdatedEvent(PluginPair pair);
+}
diff --git a/Flow.Launcher.Core/Plugin/PluginManager.cs b/Flow.Launcher.Core/Plugin/PluginManager.cs
diff --git a/Flow.Launcher.Core/Plugin/PluginsLoader.cs b/Flow.Launcher.Core/Plugin/PluginsLoader.cs
@@ -28,7 +28,7 @@ public static List<PluginPair> Plugins(List<PluginMetadata> metadatas, PluginsSe
             return plugins;
         }
 
-        private static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)
+        private static List<PluginPair> DotNetPlugins(List<PluginMetadata> source)
         {
             var erroredPlugins = new List<string>();
 
@@ -38,55 +38,57 @@ private static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source
             foreach (var metadata in metadatas)
             {
                 var milliseconds = PublicApi.Instance.StopwatchLogDebug(ClassName, $"Constructor init cost for {metadata.Name}", () =>
-                    {
-                        Assembly assembly = null;
-                        IAsyncPlugin plugin = null;
+                {
+                    Assembly assembly = null;
+                    IAsyncPlugin plugin = null;
 
-                        try
-                        {
-                            var assemblyLoader = new PluginAssemblyLoader(metadata.ExecuteFilePath);
-                            assembly = assemblyLoader.LoadAssemblyAndDependencies();
+                    try
+                    {
+                        var assemblyLoader = new PluginAssemblyLoader(metadata.ExecuteFilePath);
+                        assembly = assemblyLoader.LoadAssemblyAndDependencies();
 
-                            var type = assemblyLoader.FromAssemblyGetTypeOfInterface(assembly,
-                                typeof(IAsyncPlugin));
+                        var type = assemblyLoader.FromAssemblyGetTypeOfInterface(assembly,
+                            typeof(IAsyncPlugin));
 
-                            plugin = Activator.CreateInstance(type) as IAsyncPlugin;
+                        plugin = Activator.CreateInstance(type) as IAsyncPlugin;
 
-                            metadata.AssemblyName = assembly.GetName().Name;
-                        }
+                        metadata.AssemblyName = assembly.GetName().Name;
+                    }
 #if DEBUG
-                        catch (Exception)
-                        {
-                            throw;
-                        }
+                    catch (Exception)
+                    {
+                        throw;
+                    }
 #else
-                        catch (Exception e) when (assembly == null)
-                        {
-                            PublicApi.Instance.LogException(ClassName, $"Couldn't load assembly for the plugin: {metadata.Name}", e);
-                        }
-                        catch (InvalidOperationException e)
-                        {
-                            PublicApi.Instance.LogException(ClassName, $"Can't find the required IPlugin interface for the plugin: <{metadata.Name}>", e);
-                        }
-                        catch (ReflectionTypeLoadException e)
-                        {
-                            PublicApi.Instance.LogException(ClassName, $"The GetTypes method was unable to load assembly types for the plugin: <{metadata.Name}>", e);
-                        }
-                        catch (Exception e)
-                        {
-                            PublicApi.Instance.LogException(ClassName, $"The following plugin has errored and can not be loaded: <{metadata.Name}>", e);
-                        }
+                    catch (Exception e) when (assembly == null)
+                    {
+                        PublicApi.Instance.LogException(ClassName, $"Couldn't load assembly for the plugin: {metadata.Name}", e);
+                    }
+                    catch (InvalidOperationException e)
+                    {
+                        PublicApi.Instance.LogException(ClassName, $"Can't find the required IPlugin interface for the plugin: <{metadata.Name}>", e);
+                    }
+                    catch (ReflectionTypeLoadException e)
+                    {
+                        PublicApi.Instance.LogException(ClassName, $"The GetTypes method was unable to load assembly types for the plugin: <{metadata.Name}>", e);
+                    }
+                    catch (Exception e)
+                    {
+                        PublicApi.Instance.LogException(ClassName, $"The following plugin has errored and can not be loaded: <{metadata.Name}>", e);
+                    }
 #endif
 
-                        if (plugin == null)
-                        {
-                            erroredPlugins.Add(metadata.Name);
-                            return;
-                        }
+                    if (plugin == null)
+                    {
+                        erroredPlugins.Add(metadata.Name);
+                        return;
+                    }
+
+                    plugins.Add(new PluginPair { Plugin = plugin, Metadata = metadata });
+                });
 
-                        plugins.Add(new PluginPair { Plugin = plugin, Metadata = metadata });
-                    });
                 metadata.InitTime += milliseconds;
+                PublicApi.Instance.LogDebug(ClassName, $"Constructor cost for <{metadata.Name}> is <{metadata.InitTime}ms>");
             }
 
             if (erroredPlugins.Count > 0)
diff --git a/Flow.Launcher.Core/Resource/Internationalization.cs b/Flow.Launcher.Core/Resource/Internationalization.cs
@@ -351,6 +351,22 @@ public static void UpdatePluginMetadataTranslations()
             }
         }
 
+        public static void UpdatePluginMetadataTranslation(PluginPair p)
+        {
+            // Update plugin metadata name & description
+            if (p.Plugin is not IPluginI18n pluginI18N) return;
+            try
+            {
+                p.Metadata.Name = pluginI18N.GetTranslatedPluginTitle();
+                p.Metadata.Description = pluginI18N.GetTranslatedPluginDescription();
+                pluginI18N.OnCultureInfoChanged(CultureInfo.CurrentCulture);
+            }
+            catch (Exception e)
+            {
+                PublicApi.Instance.LogException(ClassName, $"Failed for <{p.Metadata.Name}>", e);
+            }
+        }
+
         #endregion
 
         #region IDisposable
diff --git a/Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs b/Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs
@@ -168,9 +168,21 @@ public interface IPublicAPI
         /// <summary>
         /// Get all loaded plugins
         /// </summary>
+        /// <remarks>
+        /// Will also return any plugins not fully initialized yet
+        /// </remarks>
         /// <returns></returns>
         List<PluginPair> GetAllPlugins();
 
+        /// <summary>
+        /// Get all initialized plugins
+        /// </summary>
+        /// <param name="includeFailed">
+        /// Whether to include plugins that failed to initialize
+        /// </param>
+        /// <returns></returns>
+        List<PluginPair> GetAllInitializedPlugins(bool includeFailed);
+
         /// <summary>
         /// Registers a callback function for global keyboard events.
         /// </summary>
diff --git a/Flow.Launcher/App.xaml.cs b/Flow.Launcher/App.xaml.cs
@@ -167,6 +167,7 @@ await API.StopwatchLogInfoAsync(ClassName, "Startup cost", async () =>
                 // So set to OnExplicitShutdown to prevent the application from shutting down before main window is created
                 Current.ShutdownMode = ShutdownMode.OnExplicitShutdown;
 
+                // Initialize notification system before any notification api is called
                 Notification.Install();
 
                 // Enable Win32 dark mode if the system is in dark mode before creating all windows
@@ -182,19 +183,7 @@ await API.StopwatchLogInfoAsync(ClassName, "Startup cost", async () =>
                 RegisterDispatcherUnhandledException();
                 RegisterTaskSchedulerUnhandledException();
 
-                var imageLoadertask = ImageLoader.InitializeAsync();
-
-                PluginManager.LoadPlugins(_settings.PluginSettings);
-
-                // Register ResultsUpdated event after all plugins are loaded
-                Ioc.Default.GetRequiredService<MainViewModel>().RegisterResultsUpdatedEvent();
-
-                await PluginManager.InitializePluginsAsync();
-
-                // Update plugin titles after plugins are initialized with their api instances
-                Internationalization.UpdatePluginMetadataTranslations();
-
-                await imageLoadertask;
+                await ImageLoader.InitializeAsync();
 
                 _mainWindow = new MainWindow();
 
@@ -213,7 +202,28 @@ await API.StopwatchLogInfoAsync(ClassName, "Startup cost", async () =>
                 RegisterExitEvents();
 
                 API.SaveAppAllSettings();
-                API.LogInfo(ClassName, "End Flow Launcher startup ----------------------------------------------------");
+                API.LogInfo(ClassName, "End Flow Launcher startup ------------------------------------------------------");
+
+                _ = API.StopwatchLogInfoAsync(ClassName, "Startup cost", async () =>
+                {
+                    API.LogInfo(ClassName, "Begin plugin initialization ----------------------------------------------------");
+
+                    PluginManager.LoadPlugins(_settings.PluginSettings);
+
+                    await PluginManager.InitializePluginsAsync(_mainVM);
+
+                    // Refresh home page after plugins are initialized because users may open main window during plugin initialization
+                    // And home page is created without full plugin list
+                    if (_settings.ShowHomePage && _mainVM.QueryResultsSelected() && string.IsNullOrEmpty(_mainVM.QueryText))
+                    {
+                        _mainVM.QueryResults();
+                    }
+
+                    // Save all settings since we possibly update the plugin environment paths
+                    API.SaveAppAllSettings();
+
+                    API.LogInfo(ClassName, "End plugin initialization ------------------------------------------------------");
+                });
             });
         }
 
diff --git a/Flow.Launcher/Helper/ResultHelper.cs b/Flow.Launcher/Helper/ResultHelper.cs
@@ -20,7 +20,7 @@ public static class ResultHelper
     {
         var plugin = PluginManager.GetPluginForId(pluginId);
         if (plugin == null) return null;
-        var query = QueryBuilder.Build(rawQuery, PluginManager.NonGlobalPlugins);
+        var query = QueryBuilder.Build(rawQuery, PluginManager.GetNonGlobalPlugins());
         if (query == null) return null;
         try
         {
diff --git a/Flow.Launcher/Languages/en.xaml b/Flow.Launcher/Languages/en.xaml
@@ -62,6 +62,10 @@
     <system:String x:Key="PositionReset">Position Reset</system:String>
     <system:String x:Key="PositionResetToolTip">Reset search window position</system:String>
     <system:String x:Key="queryTextBoxPlaceholder">Type here to search</system:String>
+    <system:String x:Key="pluginStillInitializing">{0}: This plugin is still initializing...</system:String>
+    <system:String x:Key="pluginStillInitializingSubtitle">Select this result to requery</system:String>
+    <system:String x:Key="pluginFailedToRespond">{0}: Failed to respond!</system:String>
+    <system:String x:Key="pluginFailedToRespondSubtitle">Select this result for more info</system:String>
 
     <!--  Setting General  -->
     <system:String x:Key="flowlauncher_settings">Settings</system:String>
diff --git a/Flow.Launcher/MainWindow.xaml.cs b/Flow.Launcher/MainWindow.xaml.cs
@@ -331,7 +331,7 @@ private void OnKeyDown(object sender, KeyEventArgs e)
                             && QueryTextBox.CaretIndex == QueryTextBox.Text.Length)
                         {
                             var queryWithoutActionKeyword =
-                                QueryBuilder.Build(QueryTextBox.Text.Trim(), PluginManager.NonGlobalPlugins)?.Search;
+                                QueryBuilder.Build(QueryTextBox.Text.Trim(), PluginManager.GetNonGlobalPlugins())?.Search;
 
                             if (FilesFolders.IsLocationPathString(queryWithoutActionKeyword))
                             {
diff --git a/Flow.Launcher/PublicAPIInstance.cs b/Flow.Launcher/PublicAPIInstance.cs
@@ -5,7 +5,6 @@
 using System.ComponentModel;
 using System.Diagnostics;
 using System.IO;
-using System.Linq;
 using System.Net;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
@@ -229,7 +228,10 @@ private static async Task<Exception> RetryActionOnSTAThreadAsync(Action action,
 
         public string GetTranslation(string key) => Internationalization.GetTranslation(key);
 
-        public List<PluginPair> GetAllPlugins() => PluginManager.AllPlugins.ToList();
+        public List<PluginPair> GetAllPlugins() => PluginManager.GetAllLoadedPlugins();
+
+        public List<PluginPair> GetAllInitializedPlugins(bool includeFailed) =>
+            PluginManager.GetAllInitializedPlugins(includeFailed);
 
         public MatchResult FuzzySearch(string query, string stringToCompare) =>
             StringMatcher.FuzzySearch(query, stringToCompare);
diff --git a/Flow.Launcher/SettingPages/ViewModels/SettingsPanePluginsViewModel.cs b/Flow.Launcher/SettingPages/ViewModels/SettingsPanePluginsViewModel.cs
@@ -100,8 +100,11 @@ public string FilterText
         }
     }
 
-    private IList<PluginViewModel>? _pluginViewModels;
-    public IList<PluginViewModel> PluginViewModels => _pluginViewModels ??= PluginManager.AllPlugins
+    private List<PluginViewModel>? _pluginViewModels;
+    // Get all plugins: Initializing & Initialized & Init failed plugins
+    // Include init failed ones so that we can uninstall them
+    // Include initializing ones so that we can change related settings like action keywords, etc.
+    public List<PluginViewModel> PluginViewModels => _pluginViewModels ??= App.API.GetAllPlugins()
         .OrderBy(plugin => plugin.Metadata.Disabled)
         .ThenBy(plugin => plugin.Metadata.Name)
         .Select(plugin => new PluginViewModel
diff --git a/Flow.Launcher/ViewModel/MainViewModel.cs b/Flow.Launcher/ViewModel/MainViewModel.cs
@@ -28,7 +28,7 @@
 
 namespace Flow.Launcher.ViewModel
 {
-    public partial class MainViewModel : BaseModel, ISavable, IDisposable
+    public partial class MainViewModel : BaseModel, ISavable, IDisposable, IResultUpdateRegister
     {
         #region Private Fields
 
@@ -241,36 +241,42 @@ void continueAction(Task t)
             }
         }
 
-        public void RegisterResultsUpdatedEvent()
+        public void RegisterResultsUpdatedEvent(PluginPair pair)
         {
-            foreach (var pair in PluginManager.GetResultUpdatePlugin())
+            if (pair.Plugin is not IResultUpdated plugin) return;
+
+            plugin.ResultsUpdated += (s, e) =>
             {
-                var plugin = (IResultUpdated)pair.Plugin;
-                plugin.ResultsUpdated += (s, e) =>
+                if (e.Query.RawQuery != QueryText || e.Token.IsCancellationRequested)
                 {
-                    if (e.Query.RawQuery != QueryText || e.Token.IsCancellationRequested)
-                    {
-                        return;
-                    }
+                    return;
+                }
 
-                    var token = e.Token == default ? _updateToken : e.Token;
+                var token = e.Token == default ? _updateToken : e.Token;
 
+                IReadOnlyList<Result> resultsCopy;
+                if (e.Results == null)
+                {
+                    resultsCopy = _emptyResult;
+                }
+                else
+                {
                     // make a clone to avoid possible issue that plugin will also change the list and items when updating view model
-                    var resultsCopy = DeepCloneResults(e.Results, token);
+                    resultsCopy = DeepCloneResults(e.Results, token);
+                }
 
-                    PluginManager.UpdatePluginMetadata(resultsCopy, pair.Metadata, e.Query);
+                PluginManager.UpdatePluginMetadata(resultsCopy, pair.Metadata, e.Query);
 
-                    if (token.IsCancellationRequested) return;
+                if (token.IsCancellationRequested) return;
 
-                    App.API.LogDebug(ClassName, $"Update results for plugin <{pair.Metadata.Name}>");
+                App.API.LogDebug(ClassName, $"Update results for plugin <{pair.Metadata.Name}>");
 
-                    if (!_resultsUpdateChannelWriter.TryWrite(new ResultsForUpdate(resultsCopy, pair.Metadata, e.Query,
-                        token)))
-                    {
-                        App.API.LogError(ClassName, "Unable to add item to Result Update Queue");
-                    }
-                };
-            }
+                if (!_resultsUpdateChannelWriter.TryWrite(new ResultsForUpdate(resultsCopy, pair.Metadata, e.Query,
+                    token)))
+                {
+                    App.API.LogError(ClassName, "Unable to add item to Result Update Queue");
+                }
+            };
         }
 
         [RelayCommand]
@@ -319,7 +325,7 @@ private void LoadContextMenu()
         [RelayCommand]
         private void Backspace(object index)
         {
-            var query = QueryBuilder.Build(QueryText.Trim(), PluginManager.NonGlobalPlugins);
+            var query = QueryBuilder.Build(QueryText.Trim(), PluginManager.GetNonGlobalPlugins());
 
             // GetPreviousExistingDirectory does not require trailing '\', otherwise will return empty string
             var path = FilesFolders.GetPreviousExistingDirectory((_) => true, query.Search.TrimEnd('\\'));
@@ -1262,7 +1268,7 @@ private async Task<Query> ConstructQueryAsync(string queryText, IEnumerable<Cust
         {
             if (string.IsNullOrWhiteSpace(queryText))
             {
-                return QueryBuilder.Build(string.Empty, PluginManager.NonGlobalPlugins);
+                return QueryBuilder.Build(string.Empty, PluginManager.GetNonGlobalPlugins());
             }
 
             var queryBuilder = new StringBuilder(queryText);
@@ -1282,7 +1288,7 @@ private async Task<Query> ConstructQueryAsync(string queryText, IEnumerable<Cust
             // Applying builtin shortcuts
             await BuildQueryAsync(builtInShortcuts, queryBuilder, queryBuilderTmp);
 
-            return QueryBuilder.Build(queryBuilder.ToString().Trim(), PluginManager.NonGlobalPlugins);
+            return QueryBuilder.Build(queryBuilder.ToString().Trim(), PluginManager.GetNonGlobalPlugins());
         }
 
         private async Task BuildQueryAsync(IEnumerable<BaseBuiltinShortcutModel> builtInShortcuts,
diff --git a/Flow.Launcher/ViewModel/PluginViewModel.cs b/Flow.Launcher/ViewModel/PluginViewModel.cs

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public static class ResultHelper`
`20`	`20`	`{`
`21`	`21`	`var plugin = PluginManager.GetPluginForId(pluginId);`
`22`	`22`	`if (plugin == null) return null;`
`23`		`- var query = QueryBuilder.Build(rawQuery, PluginManager.NonGlobalPlugins);`
	`23`	`+ var query = QueryBuilder.Build(rawQuery, PluginManager.GetNonGlobalPlugins());`
`24`	`24`	`if (query == null) return null;`
`25`	`25`	`try`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,7 @@ private void OnKeyDown(object sender, KeyEventArgs e)`
`331`	`331`	`&& QueryTextBox.CaretIndex == QueryTextBox.Text.Length)`
`332`	`332`	`{`
`333`	`333`	`var queryWithoutActionKeyword =`
`334`		`- QueryBuilder.Build(QueryTextBox.Text.Trim(), PluginManager.NonGlobalPlugins)?.Search;`
	`334`	`+ QueryBuilder.Build(QueryTextBox.Text.Trim(), PluginManager.GetNonGlobalPlugins())?.Search;`
`335`	`335`
`336`	`336`	`if (FilesFolders.IsLocationPathString(queryWithoutActionKeyword))`
`337`	`337`	`{`