Skip to content

Make IPlugin inherit from IAsyncPlugin #390

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

Merged
merged 2 commits into from
Mar 31, 2021
Merged

Make IPlugin inherit from IAsyncPlugin #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab7d00e
Make IPlugin inherit from IAsyncPlugin
taooceros Mar 23, 2021
6bbedba
remove the explicitly abstract
taooceros Mar 23, 2021
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
4 changes: 2 additions & 2 deletions Flow.Launcher.Core/Plugin/PluginAssemblyLoader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ protected override Assembly Load(AssemblyName assemblyName)
return LoadFromAssemblyPath(assemblyPath);
}

internal Type FromAssemblyGetTypeOfInterface(Assembly assembly, params Type[] types)
internal Type FromAssemblyGetTypeOfInterface(Assembly assembly, Type type)
{
var allTypes = assembly.ExportedTypes;
return allTypes.First(o => o.IsClass && !o.IsAbstract && o.GetInterfaces().Intersect(types).Any());
return allTypes.First(o => o.IsClass && !o.IsAbstract && o.GetInterfaces().Any(t => t == type));
}

internal bool ExistsInReferencedPackage(AssemblyName assemblyName)
Expand Down
31 changes: 7 additions & 24 deletions Flow.Launcher.Core/Plugin/PluginManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,16 +97,9 @@ public static async Task InitializePlugins(IPublicAPI api)
{
try
{
var milliseconds = pair.Plugin switch
{
IAsyncPlugin plugin
=> await Stopwatch.DebugAsync($"|PluginManager.InitializePlugins|Init method time cost for <{pair.Metadata.Name}>",
() => plugin.InitAsync(new PluginInitContext(pair.Metadata, API))),
IPlugin plugin
=> Stopwatch.Debug($"|PluginManager.InitializePlugins|Init method time cost for <{pair.Metadata.Name}>",
() => plugin.Init(new PluginInitContext(pair.Metadata, API))),
_ => throw new ArgumentException(),
};
var milliseconds = await Stopwatch.DebugAsync($"|PluginManager.InitializePlugins|Init method time cost for <{pair.Metadata.Name}>",
() => pair.Plugin.InitAsync(new PluginInitContext(pair.Metadata, API)));

pair.Metadata.InitTime += milliseconds;
Log.Info(
$"|PluginManager.InitializePlugins|Total init cost for <{pair.Metadata.Name}> is <{pair.Metadata.InitTime}ms>");
Expand Down Expand Up @@ -169,19 +162,9 @@ public static async Task<List<Result>> QueryForPlugin(PluginPair pair, Query que

long milliseconds = -1L;

switch (pair.Plugin)
{
case IAsyncPlugin plugin:
milliseconds = await Stopwatch.DebugAsync($"|PluginManager.QueryForPlugin|Cost for {metadata.Name}",
async () => results = await plugin.QueryAsync(query, token).ConfigureAwait(false));
break;
case IPlugin plugin:
await Task.Run(() => milliseconds = Stopwatch.Debug($"|PluginManager.QueryForPlugin|Cost for {metadata.Name}",
() => results = plugin.Query(query)), token).ConfigureAwait(false);
break;
default:
throw new ArgumentOutOfRangeException();
}
milliseconds = await Stopwatch.DebugAsync($"|PluginManager.QueryForPlugin|Cost for {metadata.Name}",
async () => results = await pair.Plugin.QueryAsync(query, token).ConfigureAwait(false));

token.ThrowIfCancellationRequested();
if (results == null)
return results;
Expand All @@ -199,7 +182,7 @@ public static async Task<List<Result>> QueryForPlugin(PluginPair pair, Query que
}
catch (Exception e)
{
Log.Exception($"|PluginManager.QueryForPlugin|Exception for plugin <{pair.Metadata.Name}> when query <{query}>", e);
Log.Exception($"|PluginManager.QueryForPlugin|Exception for plugin <{pair.Metadata.Name}> when query <{query}>", e);
}

return results;
Expand Down
24 changes: 12 additions & 12 deletions Flow.Launcher.Core/Plugin/PluginsLoader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,23 @@ public static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)
#if DEBUG
var assemblyLoader = new PluginAssemblyLoader(metadata.ExecuteFilePath);
var assembly = assemblyLoader.LoadAssemblyAndDependencies();
var type = assemblyLoader.FromAssemblyGetTypeOfInterface(assembly, typeof(IPlugin),
var type = assemblyLoader.FromAssemblyGetTypeOfInterface(assembly,
typeof(IAsyncPlugin));

var plugin = Activator.CreateInstance(type);
var plugin = Activator.CreateInstance(type) as IAsyncPlugin;
#else
Assembly assembly = null;
object plugin = null;
IAsyncPlugin plugin = null;

try
{
var assemblyLoader = new PluginAssemblyLoader(metadata.ExecuteFilePath);
assembly = assemblyLoader.LoadAssemblyAndDependencies();

var type = assemblyLoader.FromAssemblyGetTypeOfInterface(assembly, typeof(IPlugin),
var type = assemblyLoader.FromAssemblyGetTypeOfInterface(assembly,
typeof(IAsyncPlugin));

plugin = Activator.CreateInstance(type);
plugin = Activator.CreateInstance(type) as IAsyncPlugin;
}
catch (Exception e) when (assembly == null)
{
Expand All @@ -78,13 +78,13 @@ public static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)
{
Log.Exception($"|PluginsLoader.DotNetPlugins|The following plugin has errored and can not be loaded: <{metadata.Name}>", e);
}

#endif
if (plugin == null)
{
erroredPlugins.Add(metadata.Name);
return;
}
#endif

plugins.Add(new PluginPair
{
Plugin = plugin,
Expand Down Expand Up @@ -139,7 +139,7 @@ public static IEnumerable<PluginPair> PythonPlugins(List<PluginMetadata> source,
}
else
{
Log.Error("PluginsLoader","Failed to set Python path despite the environment variable PATH is found", "PythonPlugins");
Log.Error("PluginsLoader", "Failed to set Python path despite the environment variable PATH is found", "PythonPlugins");
}
}
}
Expand All @@ -152,7 +152,7 @@ public static IEnumerable<PluginPair> PythonPlugins(List<PluginMetadata> source,
}
else
{
Log.Error("PluginsLoader",$"Tried to automatically set from Settings.PythonDirectory " +
Log.Error("PluginsLoader", $"Tried to automatically set from Settings.PythonDirectory " +
$"but can't find python executable in {path}", "PythonPlugins");
}
}
Expand Down Expand Up @@ -205,7 +205,7 @@ public static IEnumerable<PluginPair> PythonPlugins(List<PluginMetadata> source,
}
else
{
Log.Error("PluginsLoader",
Log.Error("PluginsLoader",
$"Failed to set Python path after Droplex install, {pythonPath} does not exist",
"PythonPlugins");
}
Expand All @@ -215,8 +215,8 @@ public static IEnumerable<PluginPair> PythonPlugins(List<PluginMetadata> source,
if (string.IsNullOrEmpty(settings.PythonDirectory))
{
MessageBox.Show("Unable to set Python executable path, please try from Flow's settings (scroll down to the bottom).");
Log.Error("PluginsLoader",
$"Not able to successfully set Python path, the PythonDirectory variable is still an empty string.",
Log.Error("PluginsLoader",
$"Not able to successfully set Python path, the PythonDirectory variable is still an empty string.",
"PythonPlugins");

return new List<PluginPair>();
Expand Down
8 changes: 7 additions & 1 deletion Flow.Launcher.Plugin/IPlugin.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

namespace Flow.Launcher.Plugin
{
Expand All @@ -9,7 +11,7 @@ namespace Flow.Launcher.Plugin
/// or performaing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface
/// </para>
/// </summary>
public interface IPlugin
public interface IPlugin : IAsyncPlugin
{
/// <summary>
/// Querying when user's search changes
Expand All @@ -27,5 +29,9 @@ public interface IPlugin
/// </summary>
/// <param name="context"></param>
void Init(PluginInitContext context);

Task IAsyncPlugin.InitAsync(PluginInitContext context) => Task.Run(() => Init(context));

Task<List<Result>> IAsyncPlugin.QueryAsync(Query query, CancellationToken token) => Task.Run(() => Query(query));
}
}
2 changes: 1 addition & 1 deletion Flow.Launcher.Plugin/PluginPair.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
public class PluginPair
{
public object Plugin { get; internal set; }
public IAsyncPlugin Plugin { get; internal set; }
public PluginMetadata Metadata { get; internal set; }


Expand Down