Merge pull request #915 from Tharylia/error-reason-tooltip

Added module FatalError tooltip with the reason on LoadAsync error

Author: dlamkins

Blish HUD/GameServices/Modules/Module.cs

@@ -1,5 +1,6 @@
 using System;
 using System.ComponentModel.Composition;
+using System.Text;
 using System.Threading.Tasks;
 using Blish_HUD.Graphics.UI;
 using Blish_HUD.Settings;
@@ -64,6 +65,8 @@ private set {
 
         public bool Loaded => _runState == ModuleRunState.Loaded;
 
+        internal string ErrorReason { get; set; }
+
         #region Manifest & Parameter Aliases
 
         // Manifest
@@ -110,6 +113,7 @@ private void CheckForLoaded() {
 
                     if (!loadError.Observed && _loadTask.Exception != null) {
                         Logger.GetLogger(GetType()).Error(_loadTask.Exception, "Module {module} had an unhandled exception while loading.", ModuleParameters.Manifest.GetDetailedName());
+                        this.ErrorReason = GetModuleErrorReason(_loadTask.Exception);
 
                         if (ApplicationSettings.Instance.DebugEnabled) {
                             throw _loadTask.Exception;
@@ -137,6 +141,26 @@ private void CheckForLoaded() {
             }
         }
 
+        /// <summary>
+        ///     Builds a error reason for the module from the specified exception.
+        /// </summary>
+        /// <param name="ex">The exception to read to error reason from.</param>
+        /// <returns>A string containing the error reasons.</returns>
+        private static string GetModuleErrorReason(Exception ex) {
+            if (ex is AggregateException ae && ae.InnerExceptions.Count > 0) {
+                StringBuilder sb = new StringBuilder();
+                foreach (Exception innerException in ae.InnerExceptions) {
+                    if (innerException != null) {
+                        sb.AppendLine(innerException.Message);
+                    }
+                }
+
+                return sb.ToString().Trim();
+            }
+
+            return ex.Message;
+        }
+
         public void DoUpdate(GameTime gameTime) {
             switch (_runState) {
                 case ModuleRunState.Loaded:

Blish HUD/GameServices/Modules/UI/Presenters/ManageModulePresenter.cs

@@ -26,7 +26,7 @@ protected override void UpdateView() {
 
             this.Model.ModuleDisabled += ModelOnModuleDisabled;
 
-            this.View.EnableModuleClicked  += ViewOnEnableModuleClicked;
+            this.View.EnableModuleClicked += ViewOnEnableModuleClicked;
             this.View.DisableModuleClicked += ViewOnDisableModuleClicked;
 
             SubscribeToModuleRunState();
@@ -73,14 +73,14 @@ private void InvalidateViewState(bool staticDetails = false, bool stateDetails =
         private void DisplayStaticDetails() {
             // Load static details based on the manifest
 
-            this.View.ModuleName                 = this.Model.Manifest.Name;
-            this.View.ModuleNamespace            = this.Model.Manifest.Namespace;
-            this.View.ModuleDescription          = this.Model.Manifest.Description;
-            this.View.ModuleVersion              = this.Model.Manifest.Version;
+            this.View.ModuleName = this.Model.Manifest.Name;
+            this.View.ModuleNamespace = this.Model.Manifest.Namespace;
+            this.View.ModuleDescription = this.Model.Manifest.Description;
+            this.View.ModuleVersion = this.Model.Manifest.Version;
             this.View.ModuleAssemblyStateDirtied = this.Model.IsModuleAssemblyStateDirty;
 
             this.View.AuthorImage = GetModuleAuthorImage();
-            this.View.AuthorName  = GetModuleAuthor();
+            this.View.AuthorName = GetModuleAuthor();
         }
 
         private void DisplaySettingMenu() {
@@ -104,7 +104,7 @@ private ContextMenuStripItem BuildDeleteModuleMenuItem() {
         }
 
         private ContextMenuStripItem BuildClearSettingsMenuItem() {
-            var clearSettings = new ContextMenuStripItem() {Text = Strings.GameServices.ModulesService.ModuleOption_ClearSettings };
+            var clearSettings = new ContextMenuStripItem() { Text = Strings.GameServices.ModulesService.ModuleOption_ClearSettings };
 
             clearSettings.BasicTooltipText = (clearSettings.Enabled = !this.Model.Enabled) == true
                                                  ? Strings.GameServices.ModulesService.ModuleOption_ClearSettings_DescriptionEnabled
@@ -119,11 +119,11 @@ private IEnumerable<ContextMenuStripItem> BuildOpenDirsMenuItem() {
             var dirs = this.Model.Manifest.Directories ?? new List<string>(0);
 
             foreach (string dir in dirs) {
-                var    dirItem = new ContextMenuStripItem() { Text = string.Format(Strings.GameServices.ModulesService.ModuleOption_OpenDir, dir.Titleize()) };
+                var dirItem = new ContextMenuStripItem() { Text = string.Format(Strings.GameServices.ModulesService.ModuleOption_OpenDir, dir.Titleize()) };
                 string dirPath = DirectoryUtil.RegisterDirectory(dir);
 
                 dirItem.BasicTooltipText = dirPath;
-                dirItem.Enabled          = Directory.Exists(dirPath);
+                dirItem.Enabled = Directory.Exists(dirPath);
 
                 dirItem.Click += delegate {
                     Process.Start("explorer.exe", $"/open, \"{dirPath}\\\"");
@@ -135,7 +135,10 @@ private IEnumerable<ContextMenuStripItem> BuildOpenDirsMenuItem() {
 
         private void DisplayStateDetails() {
             if (!GameService.Module.ModuleIsExplicitlyIncompatible(this.Model)) {
-                this.View.ModuleState = Model.ModuleInstance?.RunState ?? ModuleRunState.Unloaded;
+                var runState = Model.ModuleInstance?.RunState ?? ModuleRunState.Unloaded;
+                this.View.ModuleErrorReason = runState == ModuleRunState.FatalError ? this.Model.ModuleInstance?.ErrorReason : null;
+
+                this.View.ModuleState = runState;
 
                 GameService.Settings.Save();
             } else {
@@ -160,7 +163,7 @@ private void DisplaySettingsView(bool enable) {
         }
 
         private void DisplayStatedOptions() {
-            this.View.CanEnable  = GetModuleCanEnable();
+            this.View.CanEnable = GetModuleCanEnable();
             this.View.CanDisable = GetModuleCanDisable();
         }
 

Blish HUD/GameServices/Modules/UI/Views/ManageModuleView.cs

@@ -75,6 +75,8 @@ public Version ModuleVersion {
             }
         }
 
+        public string ModuleErrorReason { get; set; }
+
         private ModuleRunState _moduleRunState = ModuleRunState.Unloaded;
         public ModuleRunState ModuleState {
             get => _moduleRunState;
@@ -83,7 +85,7 @@ public ModuleRunState ModuleState {
 
                 var (status, color) = _moduleStatusLookup[_moduleRunState];
 
-                UpdateModuleRunState(status, color);
+                UpdateModuleRunState(status, color, _moduleRunState == ModuleRunState.FatalError ? this.ModuleErrorReason : null);
 
                 UpdateHeaderLayout();
             }
@@ -351,9 +353,10 @@ private void UpdateHeaderLayout() {
             _moduleStateLabel.Location   = new Point(_moduleVersionLabel.Right + 8, _moduleNameLabel.Top);
         }
 
-        private void UpdateModuleRunState(string status, Color color) {
+        private void UpdateModuleRunState(string status, Color color, string tooltip = null) {
             _moduleStateLabel.Text      = status;
             _moduleStateLabel.TextColor = color;
+            _moduleStateLabel.BasicTooltipText = tooltip;
         }
 
     }