Merge pull request #3854 from Flow-Launcher/plugin_initialization

Asynchronous Loading & Initialization Plugin Model to Improve Window Startup Speed

Author: jjw24

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);
+}

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -48,7 +48,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>();
 
@@ -58,55 +58,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)

Flow.Launcher.Core/Plugin/PluginsLoader.cs

@@ -377,6 +377,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

Flow.Launcher.Core/Resource/Internationalization.cs

@@ -13,6 +13,7 @@
 using Windows.Win32;
 using Windows.Win32.Foundation;
 using Windows.Win32.UI.Accessibility;
+using System.Collections.Concurrent;
 
 namespace Flow.Launcher.Infrastructure.DialogJump
 {
@@ -60,12 +61,12 @@ public static class DialogJump
 
         private static HWND _mainWindowHandle = HWND.Null;
 
-        private static readonly Dictionary<DialogJumpExplorerPair, IDialogJumpExplorerWindow> _dialogJumpExplorers = new();
+        private static readonly ConcurrentDictionary<DialogJumpExplorerPair, IDialogJumpExplorerWindow> _dialogJumpExplorers = new();
 
         private static DialogJumpExplorerPair _lastExplorer = null;
         private static readonly Lock _lastExplorerLock = new();
 
-        private static readonly Dictionary<DialogJumpDialogPair, IDialogJumpDialogWindow> _dialogJumpDialogs = new();
+        private static readonly ConcurrentDictionary<DialogJumpDialogPair, IDialogJumpDialogWindow> _dialogJumpDialogs = new();
 
         private static IDialogJumpDialogWindow _dialogWindow = null;
         private static readonly Lock _dialogWindowLock = new();
@@ -101,22 +102,13 @@ public static class DialogJump
 
         #region Initialize & Setup
 
-        public static void InitializeDialogJump(IList<DialogJumpExplorerPair> dialogJumpExplorers,
-            IList<DialogJumpDialogPair> dialogJumpDialogs)
+        public static void InitializeDialogJump()
         {
             if (_initialized) return;
 
-            // Initialize Dialog Jump explorers & dialogs
-            _dialogJumpExplorers.Add(WindowsDialogJumpExplorer, null);
-            foreach (var explorer in dialogJumpExplorers)
-            {
-                _dialogJumpExplorers.Add(explorer, null);
-            }
-            _dialogJumpDialogs.Add(WindowsDialogJumpDialog, null);
-            foreach (var dialog in dialogJumpDialogs)
-            {
-                _dialogJumpDialogs.Add(dialog, null);
-            }
+            // Initialize preinstalled Dialog Jump explorers & dialogs
+            _dialogJumpExplorers.TryAdd(WindowsDialogJumpExplorer, null);
+            _dialogJumpDialogs.TryAdd(WindowsDialogJumpDialog, null);
 
             // Initialize main window handle
             _mainWindowHandle = Win32Helper.GetMainWindowHandle();
@@ -131,6 +123,29 @@ public static void InitializeDialogJump(IList<DialogJumpExplorerPair> dialogJump
             _initialized = true;
         }
 
+        public static void InitializeDialogJumpPlugin(PluginPair pair)
+        {
+            // Add Dialog Jump explorers & dialogs
+            if (pair.Plugin is IDialogJumpExplorer explorer)
+            {
+                var dialogJumpExplorer = new DialogJumpExplorerPair
+                {
+                    Plugin = explorer,
+                    Metadata = pair.Metadata
+                };
+                _dialogJumpExplorers.TryAdd(dialogJumpExplorer, null);
+            }
+            if (pair.Plugin is IDialogJumpDialog dialog)
+            {
+                var dialogJumpDialog = new DialogJumpDialogPair
+                {
+                    Plugin = dialog,
+                    Metadata = pair.Metadata
+                };
+                _dialogJumpDialogs.TryAdd(dialogJumpDialog, null);
+            }
+        }
+
         public static void SetupDialogJump(bool enabled)
         {
             if (enabled == _enabled) return;

Flow.Launcher.Infrastructure/DialogJump/DialogJump.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.IO;
@@ -173,9 +173,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>

Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs

@@ -187,12 +187,14 @@ 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;
 
+                // Setup log level before any logging is done
                 Log.SetLogLevel(_settings.LogLevel);
 
                 // Update dynamic resources base on settings
                 Current.Resources["SettingWindowFont"] = new FontFamily(_settings.SettingWindowFont);
                 Current.Resources["ContentControlThemeFontFamily"] = new FontFamily(_settings.SettingWindowFont);
 
+                // 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
@@ -201,6 +203,7 @@ await API.StopwatchLogInfoAsync(ClassName, "Startup cost", async () =>
                 // Initialize language before portable clean up since it needs translations
                 await _internationalization.InitializeLanguageAsync();
 
+                // Clean up after portability update
                 Ioc.Default.GetRequiredService<Portable>().PreStartCleanUpAfterPortabilityUpdate();
 
                 API.LogInfo(ClassName, "Begin Flow Launcher startup ----------------------------------------------------");
@@ -210,52 +213,66 @@ await API.StopwatchLogInfoAsync(ClassName, "Startup cost", async () =>
                 RegisterDispatcherUnhandledException();
                 RegisterTaskSchedulerUnhandledException();
 
-                var imageLoadertask = ImageLoader.InitializeAsync();
-
-                AbstractPluginEnvironment.PreStartPluginExecutablePathUpdate(_settings);
-
-                PluginManager.LoadPlugins(_settings.PluginSettings);
-
-                // Register ResultsUpdated event after all plugins are loaded
-                Ioc.Default.GetRequiredService<MainViewModel>().RegisterResultsUpdatedEvent();
+                var imageLoaderTask = ImageLoader.InitializeAsync();
 
                 Http.Proxy = _settings.Proxy;
 
                 // Initialize plugin manifest before initializing plugins so that they can use the manifest instantly
                 await API.UpdatePluginManifestAsync();
 
-                await PluginManager.InitializePluginsAsync();
-
-                // Update plugin titles after plugins are initialized with their api instances
-                Internationalization.UpdatePluginMetadataTranslations();
-
-                await imageLoadertask;
+                await imageLoaderTask;
 
                 _mainWindow = new MainWindow();
 
                 Current.MainWindow = _mainWindow;
                 Current.MainWindow.Title = Constant.FlowLauncher;
 
+                // Initialize Dialog Jump before hotkey mapper since hotkey mapper will register its hotkey
+                // Initialize Dialog Jump after main window is created so that it can access main window handle
+                DialogJump.InitializeDialogJump();
+                DialogJump.SetupDialogJump(_settings.EnableDialogJump);
+
                 // Initialize hotkey mapper instantly after main window is created because
                 // it will steal focus from main window which causes window hide
                 HotKeyMapper.Initialize();
 
                 // Initialize theme for main window
                 Ioc.Default.GetRequiredService<Theme>().ChangeTheme();
 
-                DialogJump.InitializeDialogJump(PluginManager.GetDialogJumpExplorers(), PluginManager.GetDialogJumpDialogs());
-                DialogJump.SetupDialogJump(_settings.EnableDialogJump);
-
                 Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
 
                 RegisterExitEvents();
 
                 AutoStartup();
                 AutoUpdates();
-                AutoPluginUpdates();
 
                 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 ----------------------------------------------------");
+
+                    AbstractPluginEnvironment.PreStartPluginExecutablePathUpdate(_settings);
+
+                    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();
+                    }
+
+                    AutoPluginUpdates();
+
+                    // Save all settings since we possibly update the plugin environment paths
+                    API.SaveAppAllSettings();
+
+                    API.LogInfo(ClassName, "End plugin initialization ------------------------------------------------------");
+                });
             });
         }
 

Flow.Launcher/App.xaml.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
         {

Flow.Launcher/Helper/ResultHelper.cs

@@ -66,6 +66,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>

Flow.Launcher/Languages/en.xaml

@@ -477,7 +477,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))
                             {