Separate logging classes into separate files

Author: tamasvajk

csharp/extractor/Semmle.Util/Logger.cs

@@ -0,0 +1,29 @@
+namespace Semmle.Util.Logging
+{
+    /// <summary>
+    /// A combined logger.
+    /// </summary>
+    public sealed class CombinedLogger : ILogger
+    {
+        private readonly ILogger logger1;
+        private readonly ILogger logger2;
+
+        public CombinedLogger(ILogger logger1, ILogger logger2)
+        {
+            this.logger1 = logger1;
+            this.logger2 = logger2;
+        }
+
+        public void Dispose()
+        {
+            logger1.Dispose();
+            logger2.Dispose();
+        }
+
+        public void Log(Severity s, string text, int? threadId = null)
+        {
+            logger1.Log(s, text, threadId);
+            logger2.Log(s, text, threadId);
+        }
+    }
+}

csharp/extractor/Semmle.Util/Logging/CombinedLogger.cs

@@ -0,0 +1,55 @@
+using System;
+using System.IO;
+
+namespace Semmle.Util.Logging
+{
+    /// <summary>
+    /// A logger that outputs to stdout/stderr.
+    /// </summary>
+    public sealed class ConsoleLogger : ILogger
+    {
+        private readonly Verbosity verbosity;
+        private readonly bool logThreadId;
+
+        public ConsoleLogger(Verbosity verbosity, bool logThreadId)
+        {
+            this.verbosity = verbosity;
+            this.logThreadId = logThreadId;
+        }
+
+        public void Dispose() { }
+
+        private static TextWriter GetConsole(Severity s)
+        {
+            return s == Severity.Error ? Console.Error : Console.Out;
+        }
+
+        private static string GetSeverityPrefix(Severity s)
+        {
+            switch (s)
+            {
+                case Severity.Trace:
+                case Severity.Debug:
+                case Severity.Info:
+                    return "";
+                case Severity.Warning:
+                    return "Warning: ";
+                case Severity.Error:
+                    return "Error: ";
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(s));
+            }
+        }
+
+        public void Log(Severity s, string text, int? threadId = null)
+        {
+            if (verbosity.Includes(s))
+            {
+                threadId ??= Environment.CurrentManagedThreadId;
+
+                var prefix = this.logThreadId ? $"[{threadId:D3}] " : "";
+                GetConsole(s).WriteLine(prefix + GetSeverityPrefix(s) + text);
+            }
+        }
+    }
+}

csharp/extractor/Semmle.Util/Logging/ConsoleLogger.cs

@@ -0,0 +1,58 @@
+using System;
+using System.IO;
+
+namespace Semmle.Util.Logging
+{
+    /// <summary>
+    /// A logger that outputs to a <code>csharp.log</code>
+    /// file.
+    /// </summary>
+    public sealed class FileLogger : ILogger
+    {
+        private readonly StreamWriter writer;
+        private readonly Verbosity verbosity;
+        private readonly bool logThreadId;
+
+        public FileLogger(Verbosity verbosity, string outputFile, bool logThreadId)
+        {
+            this.verbosity = verbosity;
+            this.logThreadId = logThreadId;
+
+            try
+            {
+                var dir = Path.GetDirectoryName(outputFile);
+                if (!string.IsNullOrEmpty(dir) && !System.IO.Directory.Exists(dir))
+                    Directory.CreateDirectory(dir);
+                writer = new PidStreamWriter(
+                    new FileStream(outputFile, FileMode.Append, FileAccess.Write, FileShare.ReadWrite, 8192));
+            }
+            catch (Exception ex)  // lgtm[cs/catch-of-all-exceptions]
+            {
+                Console.Error.WriteLine("CodeQL: Couldn't initialise C# extractor output: " + ex.Message + "\n" + ex.StackTrace);
+                Console.Error.Flush();
+                throw;
+            }
+        }
+
+        public void Dispose()
+        {
+            writer.Dispose();
+        }
+
+        private static string GetSeverityPrefix(Severity s)
+        {
+            return "[" + s.ToString().ToUpper() + "] ";
+        }
+
+        public void Log(Severity s, string text, int? threadId = null)
+        {
+            if (verbosity.Includes(s))
+            {
+                threadId ??= Environment.CurrentManagedThreadId;
+
+                var prefix = this.logThreadId ? $"[{threadId:D3}] " : "";
+                writer.WriteLine(prefix + GetSeverityPrefix(s) + text);
+            }
+        }
+    }
+}

csharp/extractor/Semmle.Util/Logging/FileLogger.cs

@@ -0,0 +1,25 @@
+using System;
+
+namespace Semmle.Util.Logging
+{
+    /// <summary>
+    /// A logger.
+    /// </summary>
+    public interface ILogger : IDisposable
+    {
+        /// <summary>
+        /// Log the given text with the given severity.
+        /// </summary>
+        void Log(Severity s, string text, int? threadId = null);
+
+        void LogError(string text, int? threadId = null) => Log(Severity.Error, text, threadId);
+
+        void LogWarning(string text, int? threadId = null) => Log(Severity.Warning, text, threadId);
+
+        void LogInfo(string text, int? threadId = null) => Log(Severity.Info, text, threadId);
+
+        void LogDebug(string text, int? threadId = null) => Log(Severity.Debug, text, threadId);
+
+        void Log(Severity s, string text, params object?[] args) => Log(s, string.Format(text, args));
+    }
+}

csharp/extractor/Semmle.Util/Logging/ILogger.cs

@@ -1,7 +1,7 @@
 using System.IO;
 using System.Diagnostics;
 
-namespace Semmle.Util
+namespace Semmle.Util.Logging
 {
     /// <summary>
     /// Utility stream writer that prefixes the current PID to some writes.