Skip to content

Improve plugin loading performance #2973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Improve plugin loading performance #2973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97688ef
improve plugin loading performance
Jack251970 Sep 15, 2024
0871a0b
use generic tasks
Jack251970 Sep 17, 2024
14fd0e5
improve code quality
Jack251970 Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions Flow.Launcher.Core/ExternalPlugins/Environments/AbstractPluginEnvironment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
using System.Linq;
using System.Windows.Forms;
using Flow.Launcher.Core.Resource;
using System.Threading.Tasks;
using Flow.Launcher.Core.Plugin;

namespace Flow.Launcher.Core.ExternalPlugins.Environments
{
Expand Down Expand Up @@ -37,10 +39,10 @@ internal AbstractPluginEnvironment(List<PluginMetadata> pluginMetadataList, Plug
PluginSettings = pluginSettings;
}

internal IEnumerable<PluginPair> Setup()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why would you not use a generic version of task?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have fixed this.

internal IEnumerable<Task> Setup()
{
if (!PluginMetadataList.Any(o => o.Language.Equals(Language, StringComparison.OrdinalIgnoreCase)))
return new List<PluginPair>();
return new List<Task>();

if (!string.IsNullOrEmpty(PluginsSettingsFilePath) && FilesFolders.FileExists(PluginsSettingsFilePath))
{
Expand Down Expand Up @@ -87,7 +89,7 @@ internal IEnumerable<PluginPair> Setup()
$"Not able to successfully set {EnvName} path, setting's plugin executable path variable is still an empty string.",
$"{Language}Environment");

return new List<PluginPair>();
return new List<Task>();
}
}

Expand All @@ -106,17 +108,17 @@ private void EnsureLatestInstalled(string expectedPath, string currentPath, stri

internal abstract PluginPair CreatePluginPair(string filePath, PluginMetadata metadata);

private IEnumerable<PluginPair> SetPathForPluginPairs(string filePath, string languageToSet)
private IEnumerable<Task> SetPathForPluginPairs(string filePath, string languageToSet)
{
var pluginPairs = new List<PluginPair>();
var tasks = new List<Task>();

foreach (var metadata in PluginMetadataList)
{
if (metadata.Language.Equals(languageToSet, StringComparison.OrdinalIgnoreCase))
pluginPairs.Add(CreatePluginPair(filePath, metadata));
tasks.Add(Task.Run(() => PluginsLoader.AddPlugin(CreatePluginPair(filePath, metadata))));
}

return pluginPairs;
return tasks;
}

private string GetFileFromDialog(string title, string filter = "")
Expand Down
4 changes: 2 additions & 2 deletions Flow.Launcher.Core/Plugin/PluginManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,12 +146,12 @@ static PluginManager()
/// todo happlebao The API should be removed
/// </summary>
/// <param name="settings"></param>
public static void LoadPlugins(PluginsSettings settings)
public static async Task LoadPluginsAsync(PluginsSettings settings)
{
_metadatas = PluginConfig.Parse(Directories);
Settings = settings;
Settings.UpdatePluginSettings(_metadatas);
AllPlugins = PluginsLoader.Plugins(_metadatas, Settings);
AllPlugins = await PluginsLoader.PluginsAsync(_metadatas, Settings);
}

/// <summary>
Expand Down
90 changes: 53 additions & 37 deletions Flow.Launcher.Core/Plugin/PluginsLoader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
Expand All @@ -16,7 +17,16 @@ namespace Flow.Launcher.Core.Plugin
{
public static class PluginsLoader
{
public static List<PluginPair> Plugins(List<PluginMetadata> metadatas, PluginsSettings settings)
private static readonly ConcurrentQueue<PluginPair> Plugins = new();

private static readonly ConcurrentQueue<string> ErroredPlugins = new();

public static void AddPlugin(PluginPair plugin)
{
Plugins.Enqueue(plugin);
}

public static async Task<List<PluginPair>> PluginsAsync(List<PluginMetadata> metadatas, PluginsSettings settings)
{
var dotnetPlugins = DotNetPlugins(metadatas);

Expand Down Expand Up @@ -46,17 +56,34 @@ public static List<PluginPair> Plugins(List<PluginMetadata> metadatas, PluginsSe
.Concat(executablePlugins)
.Concat(executableV2Plugins)
.ToList();
return plugins;

await Task.WhenAll(plugins);

if (!ErroredPlugins.IsEmpty)
{
var errorPluginString = String.Join(Environment.NewLine, ErroredPlugins);

var errorMessage = "The following "
+ (ErroredPlugins.Count > 1 ? "plugins have " : "plugin has ")
+ "errored and cannot be loaded:";

_ = Task.Run(() =>
{
MessageBox.Show($"{errorMessage}{Environment.NewLine}{Environment.NewLine}" +
$"{errorPluginString}{Environment.NewLine}{Environment.NewLine}" +
$"Please refer to the logs for more information", "",
MessageBoxButtons.OK, MessageBoxIcon.Warning);
});
}

return Plugins.ToList();
}

public static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)
public static IEnumerable<Task> DotNetPlugins(List<PluginMetadata> source)
{
var erroredPlugins = new List<string>();

var plugins = new List<PluginPair>();
var metadatas = source.Where(o => AllowedLanguage.IsDotNet(o.Language));

foreach (var metadata in metadatas)
return metadatas.Select(metadata => Task.Run(() =>
{
var milliseconds = Stopwatch.Debug(
$"|PluginsLoader.DotNetPlugins|Constructor init cost for {metadata.Name}", () =>
Expand Down Expand Up @@ -100,53 +127,42 @@ public static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)

if (plugin == null)
{
erroredPlugins.Add(metadata.Name);
ErroredPlugins.Enqueue(metadata.Name);
return;
}

plugins.Add(new PluginPair { Plugin = plugin, Metadata = metadata });
Plugins.Enqueue(new PluginPair { Plugin = plugin, Metadata = metadata });
});
metadata.InitTime += milliseconds;
}

if (erroredPlugins.Count > 0)
{
var errorPluginString = String.Join(Environment.NewLine, erroredPlugins);

var errorMessage = "The following "
+ (erroredPlugins.Count > 1 ? "plugins have " : "plugin has ")
+ "errored and cannot be loaded:";

_ = Task.Run(() =>
{
MessageBox.Show($"{errorMessage}{Environment.NewLine}{Environment.NewLine}" +
$"{errorPluginString}{Environment.NewLine}{Environment.NewLine}" +
$"Please refer to the logs for more information", "",
MessageBoxButtons.OK, MessageBoxIcon.Warning);
});
}

return plugins;
}));
}

public static IEnumerable<PluginPair> ExecutablePlugins(IEnumerable<PluginMetadata> source)
public static IEnumerable<Task> ExecutablePlugins(IEnumerable<PluginMetadata> source)
{
return source
.Where(o => o.Language.Equals(AllowedLanguage.Executable, StringComparison.OrdinalIgnoreCase))
.Select(metadata => new PluginPair
.Select(metadata => Task.Run(() =>
{
Plugin = new ExecutablePlugin(metadata.ExecuteFilePath), Metadata = metadata
});
Plugins.Enqueue(new PluginPair
{
Plugin = new ExecutablePlugin(metadata.ExecuteFilePath),
Metadata = metadata
});
}));
}

public static IEnumerable<PluginPair> ExecutableV2Plugins(IEnumerable<PluginMetadata> source)
public static IEnumerable<Task> ExecutableV2Plugins(IEnumerable<PluginMetadata> source)
{
return source
.Where(o => o.Language.Equals(AllowedLanguage.ExecutableV2, StringComparison.OrdinalIgnoreCase))
.Select(metadata => new PluginPair
.Select(metadata => Task.Run(() =>
{
Plugin = new ExecutablePluginV2(metadata.ExecuteFilePath), Metadata = metadata
});
Plugins.Enqueue(new PluginPair
{
Plugin = new ExecutablePluginV2(metadata.ExecuteFilePath),
Metadata = metadata
});
}));
}
}
}
2 changes: 1 addition & 1 deletion Flow.Launcher/App.xaml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ await Stopwatch.NormalAsync("|App.OnStartup|Startup cost", async () =>
InternationalizationManager.Instance.Settings = _settings;
InternationalizationManager.Instance.ChangeLanguage(_settings.Language);

PluginManager.LoadPlugins(_settings.PluginSettings);
await PluginManager.LoadPluginsAsync(_settings.PluginSettings);
_mainVM = new MainViewModel(_settings);

API = new PublicAPIInstance(_settingsVM, _mainVM, _alphabet);
Expand Down
Loading