Configuration: Strengthen exception reporting

Author: lookeypl

LukeBot.Common/Configuration.cs

@@ -77,7 +77,15 @@ public static ConfigurationBase Deserialize(string confString)
             );
 
             MethodInfo deserializer = deserializerGeneric.MakeGenericMethod(new Type[] { confType[0] });
-            return deserializer.Invoke(null, new[] { confString }) as ConfigurationBase;
+
+            try
+            {
+                return deserializer.Invoke(null, new[] { confString }) as ConfigurationBase;
+            }
+            catch (TargetInvocationException e)
+            {
+                throw new ConfigurationException("Deserialization failed, deserializer caught an exception", e.InnerException);
+            }
         }
     }
 
@@ -296,7 +304,7 @@ private ConfigurationField AllocateFieldAccessor(object owner, FieldInfo fi, Con
             }
             catch (TargetInvocationException e)
             {
-                throw e.InnerException;
+                throw new ConfigurationException("Configuration Field constructor threw an Exception", e.InnerException);
             }
         }
 

LukeBot.Common/Exception/ConfigurationException.cs

@@ -3,6 +3,11 @@ namespace LukeBot.Common
     public class ConfigurationException: Exception
     {
         public ConfigurationException(string fmt, params object[] args)
-            : base(string.Format(fmt, args)) {}
+            : base(string.Format(fmt, args))
+        {}
+
+        public ConfigurationException(string msg, System.Exception inner)
+            : base(msg, inner)
+        {}
     }
 }

LukeBot.Common/Utils.cs

@@ -5,6 +5,7 @@
 using System.Net.Sockets;
 using System.Runtime.InteropServices;
 using LukeBot.Config;
+using LukeBot.Logging;
 
 
 namespace LukeBot.Common
@@ -223,6 +224,33 @@ public static List<string> SplitJSONs(string message)
             return messages;
         }
 
+        private static bool PrintAllExceptionsInner(System.Exception e)
+        {
+            if (e == null) return false;
+
+            if (!PrintAllExceptionsInner(e.InnerException))
+            {
+                Logger.Log().Error("Caused by {0}: {1}", e.GetType().ToString(), e.Message);
+            }
+            else
+            {
+                Logger.Log().Error("...which caused {0}: {1}", e.GetType().ToString(), e.Message);
+            }
+            Logger.Log().Trace("Stack trace:{0}\n", e.StackTrace);
+            return true;
+        }
+
+        /**
+         * Prints exception chain until InnerException is null
+         */
+        public static void PrintAllExceptions(string errorMsg, System.Exception e)
+        {
+            if (e == null) return;
+
+            Logger.Log().Error(errorMsg);
+            PrintAllExceptionsInner(e);
+        }
+
         // Common Config interactions //
 
         private static Path GetUserModulesPath(string service)

LukeBot.Widget/Alerts.cs

@@ -30,20 +30,24 @@ public AlertInterrupt()
             }
         }
 
+        public class AlertTrigger
+        {
+            [ConfigurationListRestrictedField<string>(new[] { "sub", "giftsub", "cheer" })]
+            private string EventType = "sub";
+            [ConfigurationListRestrictedField<int>(new[] { 1, 2, 3 })]
+            private int SubTier = 1;
+            private int FromMonths = 0;
+            private int ToMonths = 0;
+        }
+
         public class Config: Configuration<Config>
         {
             [ConfigurationListRestrictedField<string>(new[] { "left", "right" })]
-            private string Alignment;
-
-            public Config()
-                : this("right")
-            {
-            }
+            private string Alignment = "right";
+            [ConfigurationListRestrictedField<string>(new[] { "simple", "classic" })]
+            private string Style = "simple";
 
-            public Config(string alignment)
-            {
-                Alignment = alignment;
-            }
+            public Config() {}
         }
 
         private void AwaitEventCompletion()

LukeBot.Widget/IWidget.cs

@@ -83,7 +83,7 @@ private string GetWidgetWSAddress()
             return "wss://" + serverAddress + "/widgetws/" + ID;
         }
 
-        private string GetPrintableWidgetID()
+        internal string GetPrintableWidgetID()
         {
             if (Name.Length > 0) return Name;
             else return ID;
@@ -214,31 +214,18 @@ protected void SendToWS<T>(T obj)
 
         protected void LoadConfiguration()
         {
-            try
+            if (Conf.TryGet<string>(mConfigurationPath, out string configStr))
             {
-                if (Conf.TryGet<string>(mConfigurationPath, out string configStr))
-                {
-                    mConfiguration = ConfigurationFactory.Deserialize(configStr);
-                }
-                else
-                {
-                    mConfiguration = CreateDefaultConfiguration();
-                }
-
-                // Add the UpdateNotifier and afterwards manually trigger the Configuration update
-                mConfiguration.UpdateNotifier = OnConfigurationUpdate;
-                OnConfigurationUpdate();
+                mConfiguration = ConfigurationFactory.Deserialize(configStr);
             }
-            catch (ConfigurationException e)
+            else
             {
-                Logger.Log().Error("Failed to load {0} Widget's configuration. This might be because it is either old or becuase of some other error.");
-                Logger.Log().Error("If you're okay with losing the configuration data, try calling below CLI command to recreate it:");
-                Logger.Log().Error("  widget reload {0} --recreate-config", GetPrintableWidgetID());
-                Logger.Log().Error("Old configuration will be backed up in config for cross-reference.");
-                #pragma warning disable CA2200
-                throw e;
-                #pragma warning restore CA2200
+                mConfiguration = CreateDefaultConfiguration();
             }
+
+            // Add the UpdateNotifier and afterwards manually trigger the Configuration update
+            mConfiguration.UpdateNotifier = OnConfigurationUpdate;
+            OnConfigurationUpdate();
         }
 
         public void SaveConfiguration()

LukeBot.Widget/WidgetUserModule.cs

@@ -127,13 +127,24 @@ private void LoadWidget(string id)
                 // Load() can fail, which will leave the Widget in unloaded state.
                 w.Load();
             }
+            catch (ConfigurationException e)
+            {
+                Logger.Log().Error("Failed to load {0} Widget's configuration. This might be because it is either old or becuase of some other error.", w.GetPrintableWidgetID());
+                Logger.Log().Error("If you're okay with losing the configuration data, try calling below CLI command to recreate it:");
+                Logger.Log().Error("  widget reload {0} --recreate-config", w.GetPrintableWidgetID());
+                Logger.Log().Error("Old configuration will be backed up in config for cross-reference.");
+                Utils.PrintAllExceptions("Widget load failed because of a Configuration error.", e);
+            }
             catch (System.Exception e)
             {
+                string errorMsg;
+
                 if (w.Name.Length > 0)
-                    Logger.Log().Error("Failed to load Widget {0} ({1}): {2}", w.Name, w.ID, e.Message);
+                    errorMsg = String.Format("Failed to load Widget {0} ({1}): {2}", w.Name, w.ID, e.Message);
                 else
-                    Logger.Log().Error("Failed to load Widget {0}: {1}", w.ID, e.Message);
-                Logger.Log().Trace("Stack trace:\n{0}", e.StackTrace);
+                    errorMsg = String.Format("Failed to load Widget {0}: {1}", w.ID, e.Message);
+
+                Utils.PrintAllExceptions(errorMsg, e);
             }
         }
 

Tools/LukeBot.Tests/Common/ConfigurationTests.cs

@@ -447,8 +447,11 @@ public void Configuration_RestrictedDefaults()
             Assert.AreEqual("second", conf.restrictedSetToSecond);
 
             // empty or incorrect fields should be default-assigned to first value on the list
-            Assert.ThrowsException<ConfigurationFieldException>(() => new EmptyRestrictedFieldTestConfiguration());
-            Assert.ThrowsException<ConfigurationFieldException>(() => new WrongDefaultRestrictedFieldTestConfiguration());
+            ConfigurationException e = Assert.ThrowsException<ConfigurationException>(() => new EmptyRestrictedFieldTestConfiguration());
+            Assert.IsInstanceOfType(e.InnerException, typeof(ConfigurationFieldException));
+
+            e = Assert.ThrowsException<ConfigurationException>(() => new WrongDefaultRestrictedFieldTestConfiguration());
+            Assert.IsInstanceOfType(e.InnerException, typeof(ConfigurationFieldException));
         }
     }
 }