quartznet/pulsar
2
0
Fork 0
mirror of https://github.com/9ParsonsB/Pulsar.git synced 2025-04-05 17:39:39 -04:00
Code Actions

Error handling improvements (#92)

Browse Source 
* Consolidate plugin errors into single window.

* Handle error aggregation and loggin inside error reporter.

* Minor logging corrections.

* Error popup tweaking
This commit is contained in:
Jonathan Miller 2022-07-24 15:48:55 -02:30 committed by GitHub
parent d8d5f2794b
commit 342d5af11c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 80 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
ObservatoryCore/ErrorReporter.cs
View File

@ -8,19 +8,45 @@ namespace Observatory
{ {
public static class ErrorReporter public static class ErrorReporter
{ {
public static void ShowErrorPopup(string title, string message) public static void ShowErrorPopup(string title, List<(string error, string detail)> errorList)
{ {
// Limit number of errors displayed.
StringBuilder displayMessage = new();
displayMessage.AppendLine($"{errorList.Count} error{(errorList.Count > 1 ? "s" : string.Empty)} encountered.");
var firstFiveErrors = errorList.Take(Math.Min(5, errorList.Count)).Select(e => e.error);
displayMessage.AppendJoin(Environment.NewLine, firstFiveErrors);
displayMessage.AppendLine();
displayMessage.Append("Full error details logged to ObservatoryErrorLog file in your documents folder.");
if (Avalonia.Application.Current.ApplicationLifetime is Avalonia.Controls.ApplicationLifetimes.IClassicDesktopStyleApplicationLifetime desktop) if (Avalonia.Application.Current.ApplicationLifetime is Avalonia.Controls.ApplicationLifetimes.IClassicDesktopStyleApplicationLifetime desktop)
{ {
var errorMessage = MessageBox.Avalonia.MessageBoxManager Avalonia.Threading.Dispatcher.UIThread.InvokeAsync(() =>
.GetMessageBoxStandardWindow(new MessageBox.Avalonia.DTO.MessageBoxStandardParams
{ {
ContentTitle = title, var errorMessage = MessageBox.Avalonia.MessageBoxManager
ContentMessage = message, .GetMessageBoxStandardWindow(new MessageBox.Avalonia.DTO.MessageBoxStandardParams
Topmost = true {
ContentTitle = title,
ContentMessage = displayMessage.ToString(),
Topmost = true
});
errorMessage.Show();
}); });
errorMessage.Show();
} }
// Log entirety of errors out to file.
var timestamp = DateTime.Now.ToString("G");
StringBuilder errorLog = new();
foreach (var error in errorList)
{
errorLog.AppendLine($"[{timestamp}]:");
errorLog.AppendLine($"{error.error} - {error.detail}");
errorLog.AppendLine();
}
var docPath = System.Environment.GetFolderPath(System.Environment.SpecialFolder.MyDocuments);
System.IO.File.AppendAllText(docPath + System.IO.Path.DirectorySeparatorChar + "ObservatoryErrorLog.txt", errorLog.ToString());
errorList.Clear();
} }
} }
} }

35
ObservatoryCore/LogMonitor.cs
View File

@ -374,42 +374,21 @@ namespace Observatory
{ {
if (readErrors.Any()) if (readErrors.Any())
{ {
var errorContent = new System.Text.StringBuilder(); var errorList = readErrors.Select(error =>
int count = 0;
foreach (var error in readErrors)
{ {
string message;
if (error.ex.InnerException == null) if (error.ex.InnerException == null)
{ {
errorContent.AppendLine(error.ex.Message); message = error.ex.Message;
} }
else else
{ {
errorContent.AppendLine(error.ex.InnerException.Message); message = error.ex.InnerException.Message;
}
errorContent.AppendLine($"File: {error.file}");
if (error.line.Length > 200)
{
errorContent.AppendLine($"Line (first 200 chars): {error.line.Substring(0, 200)}");
}
else
{
errorContent.AppendLine($"Line: {error.line}");
} }
return ($"Error reading file {error.file}: {message}", error.line);
});
if (error != readErrors.Last()) ErrorReporter.ShowErrorPopup($"Journal Read Error{(readErrors.Count > 1 ? "s" : "")}", errorList.ToList());
{
errorContent.AppendLine();
if (count++ == 5)
{
errorContent.AppendLine($"There are {readErrors.Count - 6} more errors but let's keep this window manageable.");
break;
}
}
}
Avalonia.Threading.Dispatcher.UIThread.InvokeAsync(() => ErrorReporter.ShowErrorPopup($"Journal Read Error{(readErrors.Count > 1 ? "s" : "")}", errorContent.ToString()));
} }
} }

2
ObservatoryCore/ObservatoryCore.cs
View File

@ -44,7 +44,7 @@ namespace Observatory
.AppendLine($"[{timestamp}] Error encountered in Elite Observatory {context}") .AppendLine($"[{timestamp}] Error encountered in Elite Observatory {context}")
.AppendLine(FormatExceptionMessage(ex)) .AppendLine(FormatExceptionMessage(ex))
.AppendLine(); .AppendLine();
System.IO.File.AppendAllText(docPath + System.IO.Path.DirectorySeparatorChar + "ObservatoryErrorLog.txt", errorMessage.ToString()); System.IO.File.AppendAllText(docPath + System.IO.Path.DirectorySeparatorChar + "ObservatoryCrashLog.txt", errorMessage.ToString());
} }
static string FormatExceptionMessage(Exception ex, bool inner = false) static string FormatExceptionMessage(Exception ex, bool inner = false)

44
ObservatoryCore/PluginManagement/PluginEventHandler.cs
View File

@ -5,6 +5,7 @@ using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using System.Linq;
using Observatory.Framework.Files.Journal; using Observatory.Framework.Files.Journal;
using System.Timers;
namespace Observatory.PluginManagement namespace Observatory.PluginManagement
{ {
@ -12,13 +13,20 @@ namespace Observatory.PluginManagement
{ {
private IEnumerable<IObservatoryWorker> observatoryWorkers; private IEnumerable<IObservatoryWorker> observatoryWorkers;
private IEnumerable<IObservatoryNotifier> observatoryNotifiers; private IEnumerable<IObservatoryNotifier> observatoryNotifiers;
private List<string> errorList; private List<(string error, string detail)> errorList;
private Timer timer;
public PluginEventHandler(IEnumerable<IObservatoryWorker> observatoryWorkers, IEnumerable<IObservatoryNotifier> observatoryNotifiers) public PluginEventHandler(IEnumerable<IObservatoryWorker> observatoryWorkers, IEnumerable<IObservatoryNotifier> observatoryNotifiers)
{ {
this.observatoryWorkers = observatoryWorkers; this.observatoryWorkers = observatoryWorkers;
this.observatoryNotifiers = observatoryNotifiers; this.observatoryNotifiers = observatoryNotifiers;
errorList = new(); errorList = new();
// Use a timer to delay error reporting until incoming errors are "quiet" for one full second.
// Should resolve issue where repeated plugin errors open hundreds of error windows.
timer = new();
timer.Interval = 1000;
timer.Elapsed += ReportErrorsIfAny;
} }
public void OnJournalEvent(object source, JournalEventArgs journalEventArgs) public void OnJournalEvent(object source, JournalEventArgs journalEventArgs)
@ -35,9 +43,9 @@ namespace Observatory.PluginManagement
} }
catch (Exception ex) catch (Exception ex)
{ {
RecordError(ex, worker.Name, journalEventArgs.journalType.Name); RecordError(ex, worker.Name, journalEventArgs.journalType.Name, ((JournalBase)journalEventArgs.journalEvent).Json);
} }
ReportErrorsIfAny(); ResetTimer();
} }
} }
@ -55,9 +63,9 @@ namespace Observatory.PluginManagement
} }
catch (Exception ex) catch (Exception ex)
{ {
RecordError(ex, worker.Name, journalEventArgs.journalType.Name); RecordError(ex, worker.Name, journalEventArgs.journalType.Name, ((JournalBase)journalEventArgs.journalEvent).Json);
} }
ReportErrorsIfAny(); ResetTimer();
} }
} }
@ -71,7 +79,7 @@ namespace Observatory.PluginManagement
} }
catch (Exception ex) catch (Exception ex)
{ {
RecordError(ex, worker.Name, "LogMonitorStateChanged event"); RecordError(ex, worker.Name, "LogMonitorStateChanged event", ex.StackTrace);
} }
} }
} }
@ -90,29 +98,35 @@ namespace Observatory.PluginManagement
} }
catch (Exception ex) catch (Exception ex)
{ {
RecordError(ex, notifier.Name, notificationArgs.Title); RecordError(ex, notifier.Name, notificationArgs.Title, notificationArgs.Detail);
} }
ReportErrorsIfAny(); ResetTimer();
} }
} }
private void ResetTimer()
{
timer.Stop();
timer.Start();
}
private void RecordError(PluginException ex) private void RecordError(PluginException ex)
{ {
errorList.Add($"Error in {ex.PluginName}: {ex.Message}"); errorList.Add(($"Error in {ex.PluginName}: {ex.Message}", ex.StackTrace));
} }
private void RecordError(Exception ex, string plugin, string eventType) private void RecordError(Exception ex, string plugin, string eventType, string eventDetail)
{ {
errorList.Add($"Error in {plugin} while handling {eventType}: {ex.Message}"); errorList.Add(($"Error in {plugin} while handling {eventType}: {ex.Message}", eventDetail));
} }
private void ReportErrorsIfAny() private void ReportErrorsIfAny(object sender, ElapsedEventArgs e)
{ {
if (errorList.Any()) if (errorList.Any())
{ {
ErrorReporter.ShowErrorPopup($"Plugin Error{(errorList.Count > 1 ? "s" : "")}", string.Join(Environment.NewLine, errorList)); ErrorReporter.ShowErrorPopup($"Plugin Error{(errorList.Count > 1 ? "s" : "")}", errorList);
errorList.Clear(); timer.Stop();
} }
} }
} }

14
ObservatoryCore/PluginManagement/PluginManager.cs
View File

@ -29,7 +29,7 @@ namespace Observatory.PluginManagement
} }
public readonly List<string> errorList; public readonly List<(string error, string detail)> errorList;
public readonly List<Panel> pluginPanels; public readonly List<Panel> pluginPanels;
public readonly List<DataTable> pluginTables; public readonly List<DataTable> pluginTables;
public readonly List<(IObservatoryWorker plugin, PluginStatus signed)> workerPlugins; public readonly List<(IObservatoryWorker plugin, PluginStatus signed)> workerPlugins;
@ -62,7 +62,7 @@ namespace Observatory.PluginManagement
} }
catch (PluginException ex) catch (PluginException ex)
{ {
errorList.Add(FormatErrorMessage(ex)); errorList.Add((FormatErrorMessage(ex), ex.StackTrace));
errorPlugins.Add(plugin); errorPlugins.Add(plugin);
} }
} }
@ -82,7 +82,7 @@ namespace Observatory.PluginManagement
} }
catch (PluginException ex) catch (PluginException ex)
{ {
errorList.Add(FormatErrorMessage(ex)); errorList.Add((FormatErrorMessage(ex), ex.StackTrace));
errorPlugins.Add(plugin); errorPlugins.Add(plugin);
} }
} }
@ -175,11 +175,11 @@ namespace Observatory.PluginManagement
Properties.Core.Default.Save(); Properties.Core.Default.Save();
} }
private static List<string> LoadPlugins(out List<(IObservatoryWorker plugin, PluginStatus signed)> observatoryWorkers, out List<(IObservatoryNotifier plugin, PluginStatus signed)> observatoryNotifiers) private static List<(string, string)> LoadPlugins(out List<(IObservatoryWorker plugin, PluginStatus signed)> observatoryWorkers, out List<(IObservatoryNotifier plugin, PluginStatus signed)> observatoryNotifiers)
{ {
observatoryWorkers = new(); observatoryWorkers = new();
observatoryNotifiers = new(); observatoryNotifiers = new();
var errorList = new List<string>(); var errorList = new List<(string, string)>();
string pluginPath = $"{AppDomain.CurrentDomain.BaseDirectory}{Path.DirectorySeparatorChar}plugins"; string pluginPath = $"{AppDomain.CurrentDomain.BaseDirectory}{Path.DirectorySeparatorChar}plugins";
@ -218,7 +218,7 @@ namespace Observatory.PluginManagement
string error = LoadPluginAssembly(dll, observatoryWorkers, observatoryNotifiers); string error = LoadPluginAssembly(dll, observatoryWorkers, observatoryNotifiers);
if (!string.IsNullOrWhiteSpace(error)) if (!string.IsNullOrWhiteSpace(error))
{ {
errorList.Add(error); errorList.Add((error, string.Empty));
} }
//} //}
//else //else
@ -230,7 +230,7 @@ namespace Observatory.PluginManagement
} }
catch (Exception ex) catch (Exception ex)
{ {
errorList.Add($"ERROR: {new FileInfo(dll).Name}, {ex.Message}"); errorList.Add(($"ERROR: {new FileInfo(dll).Name}, {ex.Message}", ex.StackTrace));
LoadPlaceholderPlugin(dll, PluginStatus.InvalidLibrary, observatoryNotifiers); LoadPlaceholderPlugin(dll, PluginStatus.InvalidLibrary, observatoryNotifiers);
} }
} }

4
ObservatoryCore/UI/ViewModels/CoreViewModel.cs
View File

@ -207,8 +207,8 @@ namespace Observatory.UI.ViewModels
{ {
ObservatoryCore.LogError(e, "while exporting data"); ObservatoryCore.LogError(e, "while exporting data");
ErrorReporter.ShowErrorPopup("Error encountered!", ErrorReporter.ShowErrorPopup("Error encountered!",
"An error occurred while exporting; output may be missing or incomplete." + Environment.NewLine + new List<(string, string)> { ("An error occurred while exporting; output may be missing or incomplete." + Environment.NewLine +
"Please check the error log (found in your Documents folder) for more details and visit our discord to report it."); "Please check the error log (found in your Documents folder) for more details and visit our discord to report it.", e.Message) });
} }
} }

2
ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs
View File

@ -11,7 +11,7 @@ namespace Observatory.UI.ViewModels
core = new CoreViewModel(pluginManager.workerPlugins, pluginManager.notifyPlugins); core = new CoreViewModel(pluginManager.workerPlugins, pluginManager.notifyPlugins);
if (pluginManager.errorList.Any()) if (pluginManager.errorList.Any())
ErrorReporter.ShowErrorPopup("Plugin Load Error", string.Join(Environment.NewLine, pluginManager.errorList)); ErrorReporter.ShowErrorPopup("Plugin Load Error", pluginManager.errorList);
} }
public CoreViewModel core { get; } public CoreViewModel core { get; }