Wrap plugins in PluginWrapper to handle fatal errors in plugins
All checks were successful
Build / Compute Version (push) Successful in 5s
Build / Build Nuget package (CringeBootstrap.Abstractions) (push) Successful in 1m55s
Build / Build Nuget package (CringePlugins) (push) Successful in 2m24s
Build / Build Nuget package (NuGet) (push) Successful in 2m6s
Build / Build Nuget package (SharedCringe) (push) Successful in 2m47s
Build / Build Launcher (push) Successful in 3m45s

This commit is contained in:
2024-11-09 03:42:25 -05:00
parent ed8d307843
commit 36af9a722a
2 changed files with 78 additions and 4 deletions

View File

@@ -2,7 +2,6 @@
using System.Runtime.Loader;
using CringeBootstrap.Abstractions;
using CringePlugins.Utils;
using dnlib.DotNet;
using NLog;
using SharedCringe.Loader;
using VRage.Plugins;
@@ -16,10 +15,12 @@ internal sealed class PluginInstance
private readonly string _entrypointPath;
private PluginAssemblyLoadContext? _context;
private IPlugin? _instance;
private Action? _openConfigAction;
private IHandleInputPlugin? _handleInputInstance;
private PluginWrapper? _wrappedInstance;
private static readonly NLog.ILogger Log = LogManager.GetCurrentClassLogger();
private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
public PluginMetadata Metadata { get; }
public PluginInstance(PluginMetadata metadata, string entrypointPath)
@@ -67,6 +68,7 @@ internal sealed class PluginInstance
}
_handleInputInstance = _instance as IHandleInputPlugin;
_wrappedInstance = new PluginWrapper(Metadata.Name, _instance);
}
public void RegisterLifetime()
@@ -74,9 +76,9 @@ internal sealed class PluginInstance
if (_instance is null)
throw new InvalidOperationException("Must call Instantiate first");
MyPlugins.m_plugins.Add(_instance);
MyPlugins.m_plugins.Add(_wrappedInstance);
if (_handleInputInstance is not null)
MyPlugins.m_handleInputPlugins.Add(_handleInputInstance);
MyPlugins.m_handleInputPlugins.Add(_wrappedInstance);
}
public void OpenConfig()

View File

@@ -0,0 +1,72 @@
using NLog;
using VRage.Plugins;
namespace CringePlugins.Loader;
//todo: we should patch Mysanboxgame.Run to log init of actual plugin names instead of pluginwrapper
//also, maybe we could unload the plugin if there's an error?
internal sealed class PluginWrapper(string name, IPlugin plugin) : IHandleInputPlugin
{
public bool HasError => LastException != null;
public Exception? LastException { get; private set; } //todo: show exception when hovered in plugin menu?
private static readonly ILogger Log = LogManager.GetCurrentClassLogger();
public void Dispose()
{
try
{
plugin.Dispose();
}
catch (Exception e)
{
Log.Error(e, "Error Disposing {Name}", name);
LastException = e;
}
}
public void HandleInput()
{
if (HasError || plugin is not IHandleInputPlugin input)
return;
try
{
input.HandleInput();
}
catch (Exception e)
{
Log.Error(e, "Error Updating {Name}", name);
LastException = e;
}
}
public void Init(object gameInstance)
{
try
{
plugin.Init(gameInstance);
}
catch (Exception e)
{
Log.Error(e, "Error Initializing {Name}", name);
LastException = e;
}
}
public void Update()
{
if (HasError)
return;
try
{
plugin.Update();
}
catch (Exception e)
{
Log.Error(e, "Error Updating {Name}", name);
LastException = e;
}
}
}