diff --git a/ObservatoryCore/ErrorReporter.cs b/ObservatoryCore/ErrorReporter.cs index 7de3c82..756f81a 100644 --- a/ObservatoryCore/ErrorReporter.cs +++ b/ObservatoryCore/ErrorReporter.cs @@ -8,19 +8,45 @@ namespace Observatory { 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) { - var errorMessage = MessageBox.Avalonia.MessageBoxManager - .GetMessageBoxStandardWindow(new MessageBox.Avalonia.DTO.MessageBoxStandardParams + Avalonia.Threading.Dispatcher.UIThread.InvokeAsync(() => { - ContentTitle = title, - ContentMessage = message, - Topmost = true + var errorMessage = MessageBox.Avalonia.MessageBoxManager + .GetMessageBoxStandardWindow(new MessageBox.Avalonia.DTO.MessageBoxStandardParams + { + 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(); } } } diff --git a/ObservatoryCore/LogMonitor.cs b/ObservatoryCore/LogMonitor.cs index c75f1a3..d01a69c 100644 --- a/ObservatoryCore/LogMonitor.cs +++ b/ObservatoryCore/LogMonitor.cs @@ -374,42 +374,21 @@ namespace Observatory { if (readErrors.Any()) { - var errorContent = new System.Text.StringBuilder(); - int count = 0; - foreach (var error in readErrors) + var errorList = readErrors.Select(error => { - + string message; if (error.ex.InnerException == null) { - errorContent.AppendLine(error.ex.Message); + message = error.ex.Message; } else { - errorContent.AppendLine(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}"); + message = error.ex.InnerException.Message; } + return ($"Error reading file {error.file}: {message}", error.line); + }); - if (error != readErrors.Last()) - { - 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())); + ErrorReporter.ShowErrorPopup($"Journal Read Error{(readErrors.Count > 1 ? "s" : "")}", errorList.ToList()); } } diff --git a/ObservatoryCore/ObservatoryCore.cs b/ObservatoryCore/ObservatoryCore.cs index 266d36f..97b5eb8 100644 --- a/ObservatoryCore/ObservatoryCore.cs +++ b/ObservatoryCore/ObservatoryCore.cs @@ -44,7 +44,7 @@ namespace Observatory .AppendLine($"[{timestamp}] Error encountered in Elite Observatory {context}") .AppendLine(FormatExceptionMessage(ex)) .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) diff --git a/ObservatoryCore/PluginManagement/PluginEventHandler.cs b/ObservatoryCore/PluginManagement/PluginEventHandler.cs index 2463ce8..2cc97b4 100644 --- a/ObservatoryCore/PluginManagement/PluginEventHandler.cs +++ b/ObservatoryCore/PluginManagement/PluginEventHandler.cs @@ -5,6 +5,7 @@ using System; using System.Collections.Generic; using System.Linq; using Observatory.Framework.Files.Journal; +using System.Timers; namespace Observatory.PluginManagement { @@ -12,13 +13,20 @@ namespace Observatory.PluginManagement { private IEnumerable observatoryWorkers; private IEnumerable observatoryNotifiers; - private List errorList; + private List<(string error, string detail)> errorList; + private Timer timer; public PluginEventHandler(IEnumerable observatoryWorkers, IEnumerable observatoryNotifiers) { this.observatoryWorkers = observatoryWorkers; this.observatoryNotifiers = observatoryNotifiers; 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) @@ -35,9 +43,9 @@ namespace Observatory.PluginManagement } 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) { - 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) { - RecordError(ex, worker.Name, "LogMonitorStateChanged event"); + RecordError(ex, worker.Name, "LogMonitorStateChanged event", ex.StackTrace); } } } @@ -90,29 +98,35 @@ namespace Observatory.PluginManagement } 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) { - 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()) { - ErrorReporter.ShowErrorPopup($"Plugin Error{(errorList.Count > 1 ? "s" : "")}", string.Join(Environment.NewLine, errorList)); - - errorList.Clear(); + ErrorReporter.ShowErrorPopup($"Plugin Error{(errorList.Count > 1 ? "s" : "")}", errorList); + + timer.Stop(); } } } diff --git a/ObservatoryCore/PluginManagement/PluginManager.cs b/ObservatoryCore/PluginManagement/PluginManager.cs index 37e6ce1..12031f3 100644 --- a/ObservatoryCore/PluginManagement/PluginManager.cs +++ b/ObservatoryCore/PluginManagement/PluginManager.cs @@ -29,7 +29,7 @@ namespace Observatory.PluginManagement } - public readonly List errorList; + public readonly List<(string error, string detail)> errorList; public readonly List pluginPanels; public readonly List pluginTables; public readonly List<(IObservatoryWorker plugin, PluginStatus signed)> workerPlugins; @@ -62,7 +62,7 @@ namespace Observatory.PluginManagement } catch (PluginException ex) { - errorList.Add(FormatErrorMessage(ex)); + errorList.Add((FormatErrorMessage(ex), ex.StackTrace)); errorPlugins.Add(plugin); } } @@ -82,7 +82,7 @@ namespace Observatory.PluginManagement } catch (PluginException ex) { - errorList.Add(FormatErrorMessage(ex)); + errorList.Add((FormatErrorMessage(ex), ex.StackTrace)); errorPlugins.Add(plugin); } } @@ -175,11 +175,11 @@ namespace Observatory.PluginManagement Properties.Core.Default.Save(); } - private static List 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(); observatoryNotifiers = new(); - var errorList = new List(); + var errorList = new List<(string, string)>(); string pluginPath = $"{AppDomain.CurrentDomain.BaseDirectory}{Path.DirectorySeparatorChar}plugins"; @@ -218,7 +218,7 @@ namespace Observatory.PluginManagement string error = LoadPluginAssembly(dll, observatoryWorkers, observatoryNotifiers); if (!string.IsNullOrWhiteSpace(error)) { - errorList.Add(error); + errorList.Add((error, string.Empty)); } //} //else @@ -230,7 +230,7 @@ namespace Observatory.PluginManagement } 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); } } diff --git a/ObservatoryCore/UI/ViewModels/CoreViewModel.cs b/ObservatoryCore/UI/ViewModels/CoreViewModel.cs index 45427f0..219814d 100644 --- a/ObservatoryCore/UI/ViewModels/CoreViewModel.cs +++ b/ObservatoryCore/UI/ViewModels/CoreViewModel.cs @@ -207,8 +207,8 @@ namespace Observatory.UI.ViewModels { ObservatoryCore.LogError(e, "while exporting data"); ErrorReporter.ShowErrorPopup("Error encountered!", - "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."); + 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.", e.Message) }); } } diff --git a/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs b/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs index 8f45863..89ccdd9 100644 --- a/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs +++ b/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs @@ -11,7 +11,7 @@ namespace Observatory.UI.ViewModels core = new CoreViewModel(pluginManager.workerPlugins, pluginManager.notifyPlugins); 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; }