Added the ability to automatically get settings after 5 minutes of being idle

Author: niemyjski

Source/Shared/Configuration/SettingsManager.cs

@@ -8,6 +8,9 @@
 namespace Exceptionless.Configuration {
     public static class SettingsManager {
         public static void ApplySavedServerSettings(ExceptionlessConfiguration config) {
+            if (config == null)
+                return;
+
             if (String.IsNullOrEmpty(config.ApiKey) || String.Equals(config.ApiKey, "API_KEY_HERE", StringComparison.OrdinalIgnoreCase)) {
                 config.Resolver.GetLog().Error(typeof(SettingsManager), "Unable to apply saved server settings: ApiKey is not set.");
                 return;
@@ -18,6 +21,9 @@ public static void ApplySavedServerSettings(ExceptionlessConfiguration config) {
         }
 
         private static SettingsDictionary GetSavedServerSettings(ExceptionlessConfiguration config) {
+            if (config == null)
+                return new SettingsDictionary();
+
             string configPath = GetConfigPath(config);
             if (String.IsNullOrEmpty(configPath))
                 return new SettingsDictionary();
@@ -36,6 +42,9 @@ private static SettingsDictionary GetSavedServerSettings(ExceptionlessConfigurat
         }
 
         public static void CheckVersion(int version, ExceptionlessConfiguration config) {
+            if (config == null)
+                return;
+
             if (String.IsNullOrEmpty(config.ApiKey) || String.Equals(config.ApiKey, "API_KEY_HERE", StringComparison.OrdinalIgnoreCase)) {
                 config.Resolver.GetLog().Error(typeof(SettingsManager), "Unable to check version: ApiKey is not set.");
                 return;
@@ -49,6 +58,9 @@ public static void CheckVersion(int version, ExceptionlessConfiguration config)
         }
 
         public static void UpdateSettings(ExceptionlessConfiguration config) {
+            if (config == null)
+                return;
+
             if (String.IsNullOrEmpty(config.ApiKey) || String.Equals(config.ApiKey, "API_KEY_HERE", StringComparison.OrdinalIgnoreCase)) {
                 config.Resolver.GetLog().Error(typeof(SettingsManager), "Unable to update settings: ApiKey is not set.");
                 return;
@@ -79,7 +91,7 @@ public static void UpdateSettings(ExceptionlessConfiguration config) {
         }
 
         private static string GetConfigPath(ExceptionlessConfiguration config) {
-            return config.GetQueueName() + "\\server-settings.json";
+            return (config != null ? config.GetQueueName() : String.Empty) + "\\server-settings.json";
         }
     }
 }

Source/Shared/Exceptionless.Portable.csproj

@@ -76,6 +76,7 @@
     <Compile Include="Plugins\Default\050_EnvironmentInfoPlugin.cs" />
     <Compile Include="Plugins\Default\005_HandleAggregateExceptionsPlugin.cs" />
     <Compile Include="Plugins\Default\010_EventExclusionPlugin.cs" />
+    <Compile Include="Plugins\Default\1020_UpdateConfigurationSettingsWhileIdlePlugin.cs" />
     <Compile Include="Plugins\PriortyAttribute.cs" />
     <Compile Include="EventBuilder.cs" />
     <Compile Include="Events\ConfigurationUpdatedEventArgs.cs" />

Source/Shared/Plugins/Default/1020_UpdateConfigurationSettingsWhileIdlePlugin.cs

@@ -0,0 +1,44 @@
+using System;
+using System.Threading;
+using Exceptionless.Configuration;
+using Exceptionless.Dependency;
+using Exceptionless.Logging;
+
+namespace Exceptionless.Plugins.Default {
+    [Priority(1020)]
+    public class UpdateConfigurationSettingsWhileIdlePlugin : IEventPlugin, IDisposable {
+        private readonly Timer _timer;
+        private readonly TimeSpan _interval;
+        private readonly ExceptionlessConfiguration _configuration;
+
+        /// <summary>
+        /// Automatically sync the configuration settings when the client hasn't sent any events for a period of time.
+        /// </summary>
+        /// <param name="configuration">The configuration.</param>
+        /// <param name="interval">The interval at which the client will automatically ensure the configuration settings are up-to-date when idle.</param>
+        public UpdateConfigurationSettingsWhileIdlePlugin(ExceptionlessConfiguration configuration, TimeSpan? interval = null) {
+            _configuration = configuration;
+
+            var startupInterval = interval ?? TimeSpan.FromSeconds(5);
+            _interval = interval.HasValue && interval.Value.Ticks > 0 ? interval.Value : TimeSpan.FromMinutes(5);
+            _timer = new Timer(UpdateConfiguration, null, startupInterval, _interval);
+        }
+
+        public void Run(EventPluginContext context) {
+            _timer.Change(_interval, _interval);
+        }
+
+        private void UpdateConfiguration(object state) {
+            try {
+                SettingsManager.UpdateSettings(_configuration);
+            } catch (Exception ex) {
+                var log = _configuration.Resolver.GetLog();
+                log.Error(ex, "Error while updating configuration settings.");
+            }
+        }
+
+        public void Dispose() {
+            _timer.Dispose();
+        }
+    }
+}

Source/Shared/Plugins/EventPluginManager.cs

@@ -32,6 +32,7 @@ public static void AddDefaultPlugins(ExceptionlessConfiguration config) {
             config.AddPlugin<EnvironmentInfoPlugin>();
             config.AddPlugin<SubmissionMethodPlugin>();
             config.AddPlugin<CancelSessionsWithNoUserPlugin>();
+            config.AddPlugin<UpdateConfigurationSettingsWhileIdlePlugin>(new UpdateConfigurationSettingsWhileIdlePlugin(config));
         }
     }
 }

Source/Tests/Plugins/PluginTests.cs

@@ -150,6 +150,7 @@ public void EventExclusionPlugin_EventExclusions() {
         [InlineData("Test", "Info", SettingsDictionary.KnownKeys.LogLevelPrefix + "Test", "Debug", false)]
         [InlineData("Test", "Trace", SettingsDictionary.KnownKeys.LogLevelPrefix + "*", "Debug", true)]
         [InlineData("Test", "Warn", SettingsDictionary.KnownKeys.LogLevelPrefix + "*", "Debug", false)]
+        [InlineData("Test", "Warn", SettingsDictionary.KnownKeys.LogLevelPrefix + "*", "Off", true)]
         public void EventExclusionPlugin_LogLevels(string source, string level, string settingKey, string settingValue, bool cancelled) {
             var client = CreateClient();
             if (settingKey != null)