Add a warning for file logging being disabled

Closes #1119
couchbase · Jan 24, 2019 · bbb6450 · bbb6450
1 parent c3a4e97
commit bbb6450
Show file tree

Hide file tree

Showing 7 changed files with 123 additions and 3 deletions.
diff --git a/src/Couchbase.Lite.Shared/API/Database/Database.cs b/src/Couchbase.Lite.Shared/API/Database/Database.cs
@@ -252,9 +252,17 @@ public Database([NotNull]string name, [CanBeNull]DatabaseConfiguration configura
         {
             Name = CBDebug.MustNotBeNull(WriteLog.To.Database, Tag, nameof(name), name);
             Config = configuration?.Freeze() ?? new DatabaseConfiguration(true);
+            RunOnce.GetInstance(nameof(Database)).Run(CheckFileLogger);
             Open();
         }
 
+        private void CheckFileLogger()
+        {
+            if (Log.File.Config == null) {
+                WriteLog.To.Database.W("Logging", "Database.Log.File.Config is null, meaning file logging is disabled.  Log files required for product support are not being generated.");
+            }
+        }
+
         internal Database([NotNull]Database other)
             : this(other.Name, other.Config)
         {

diff --git a/src/Couchbase.Lite.Shared/API/Log/FileLogger.cs b/src/Couchbase.Lite.Shared/API/Log/FileLogger.cs
@@ -184,6 +184,10 @@ public LogFileConfiguration Config
         {
             get => _config;
             set {
+                if (value == null) {
+                    WriteLog.To.Database.W("Logging", "Database.Log.File.Config is now null, meaning file logging is disabled.  Log files required for product support are not being generated.");
+                }
+
                 _config = value?.Freeze();
                 UpdateConfig();
             }

diff --git a/src/Couchbase.Lite.Shared/Couchbase.Lite.Shared.projitems b/src/Couchbase.Lite.Shared/Couchbase.Lite.Shared.projitems
@@ -175,5 +175,6 @@
     <Compile Include="$(MSBuildThisFileDirectory)Util\NonNullDictionary.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Util\OptionsDictionary.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Util\RefCountedDisposable.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)Util\RunOnce.cs" />
   </ItemGroup>
 </Project>
diff --git a/src/Couchbase.Lite.Shared/Util/RunOnce.cs b/src/Couchbase.Lite.Shared/Util/RunOnce.cs
@@ -0,0 +1,66 @@
+using System;
+using System.Collections.Concurrent;
+
+using Couchbase.Lite.Internal.Logging;
+
+using JetBrains.Annotations;
+
+namespace Couchbase.Lite.Util
+{
+    internal sealed class RunOnce
+    {
+        #region Constants
+
+        private const string Tag = nameof(RunOnce);
+
+        [NotNull] private static readonly ConcurrentDictionary<string, RunOnce> Instances =
+            new ConcurrentDictionary<string, RunOnce>();
+
+        #endregion
+
+        #region Variables
+
+        [NotNull]
+        private readonly string _id;
+
+        [NotNull]
+        private readonly ConcurrentDictionary<Action, bool> _seen = new ConcurrentDictionary<Action, bool>();
+
+        #endregion
+
+        #region Constructors
+
+        private RunOnce([NotNull]string identifier)
+        {
+            _id = identifier;
+        }
+
+        #endregion
+
+        #region Public Methods
+
+        public static RunOnce GetInstance([NotNull]string identifier)
+        {
+            return Instances.GetOrAdd(identifier, k => new RunOnce(k));
+        }
+
+        public void Run([NotNull]Action a)
+        {
+            if (_seen.TryAdd(a, false)) {
+                WriteLog.To.Database.V(Tag, "Executing logic for {0}", _id);
+                a();
+            }
+        }
+
+        #endregion
+
+        #region Overrides
+
+        public override string ToString()
+        {
+            return $"RunOnce => [{_id}]";
+        }
+
+        #endregion
+    }
+}
diff --git a/src/Couchbase.Lite.Tests.Shared/LogTest.cs b/src/Couchbase.Lite.Tests.Shared/LogTest.cs
@@ -30,6 +30,8 @@
 using FluentAssertions;
 
 using JetBrains.Annotations;
+
+using Test.Util;
 #if !WINDOWS_UWP
 using Xunit;
 using Xunit.Abstractions;
@@ -51,6 +53,25 @@ static LogTest()
         }
 #endif
 
+#if !WINDOWS_UWP
+        public LogTest(ITestOutputHelper output)
+        {
+            Database.Log.Custom = new XunitLogger(output) { Level = LogLevel.Info };
+        }
+#endif
+
+#if WINDOWS_UWP
+        private TestContext _testContext;
+        public TestContext TestContext
+        {
+            get => _testContext;
+            set {
+                _testContext = value;
+                Database.Log.Custom = new MSTestLogger(_testContext) { Level = LogLevel.Info };
+            }
+        }
+#endif
+
         [Fact]
         public void TestDefaultLogFormat()
         {
@@ -295,6 +316,26 @@ public void TestConsoleLoggingDomains()
             Database.Log.Console.Domains = LogDomain.All;
             Database.Log.Console.Level = LogLevel.Warning;
         }
+
+        [Fact]
+        public void TestFileLogDisabledWarning()
+        {
+            Database.Log.File.Config.Should().BeNull();
+            var sw = new StringWriter();
+            Console.SetOut(sw);
+            using (var db = new Database("tmp")) {
+                sw.ToString().Contains("file logging is disabled").Should().BeTrue();
+                db.Delete();
+            }
+
+            sw.Dispose();
+            sw = new StringWriter();
+            Console.SetOut(sw);
+            Database.Log.File.Config = new LogFileConfiguration("foo");
+            Database.Log.File.Config = null;
+            sw.ToString().Contains("file logging is disabled").Should().BeTrue();
+            Console.SetOut(new StreamWriter(Console.OpenStandardOutput()));
+        }
 #endif
 
         [Fact]

diff --git a/src/Couchbase.Lite.Tests.Shared/PerfTest.cs b/src/Couchbase.Lite.Tests.Shared/PerfTest.cs
@@ -50,7 +50,7 @@ public virtual TestContext TestContext
             get => _output;
             set {
                 _output = value;
-                Database.Log.Custom = new MSTestLogger(value);
+                Database.Log.Custom = new MSTestLogger(value) { Level = LogLevel.Info };
             }
         }
 #endif
@@ -71,7 +71,7 @@ static PerfTest()
         protected PerfTest(ITestOutputHelper output)
         {
             _output = output;
-            Database.Log.Custom = new XunitLogger(output);
+            Database.Log.Custom = new XunitLogger(output) { Level = LogLevel.Info };
         }
 #endif
 

diff --git a/src/Couchbase.Lite.Tests.Shared/TestCase.cs b/src/Couchbase.Lite.Tests.Shared/TestCase.cs
@@ -66,7 +66,7 @@ public TestContext TestContext
             get => _testContext;
             set {
                 _testContext = value;
-                Database.Log.Custom = new MSTestLogger(_testContext);
+                Database.Log.Custom = new MSTestLogger(_testContext) { Level = LogLevel.Info };
             }
         }
 #endif