Adds Logging level control to UICatalog (gui-cs#3938)

* Tons of API doc updates * Added logging control to UICatalog * Added logging control to UICatalog - more * fixed minor issues * removed logs from .gitignore * Fixed log file path * Fixed app desc
tznind · Feb 28, 2025 · 79cd4e9 · 79cd4e9
1 parent c88c772
commit 79cd4e9
Show file tree

Hide file tree

Showing 20 changed files with 398 additions and 196 deletions.
diff --git a/.gitignore b/.gitignore
@@ -58,3 +58,5 @@ demo.*
 *.tui/
 
 *.dotCover
+
+logs/
diff --git a/Terminal.Gui/Application/ApplicationImpl.cs b/Terminal.Gui/Application/ApplicationImpl.cs
@@ -215,6 +215,7 @@ public virtual void Shutdown ()
 
         bool wasInitialized = Application.Initialized;
         Application.ResetState ();
+        LogJsonErrors ();
         PrintJsonErrors ();
 
         if (wasInitialized)

diff --git a/Terminal.Gui/Configuration/AttributeJsonConverter.cs b/Terminal.Gui/Configuration/AttributeJsonConverter.cs
@@ -57,11 +57,11 @@ public override Attribute Read (ref Utf8JsonReader reader, Type typeToConvert, J
             switch (propertyName?.ToLower ())
             {
                 case "foreground":
-                    foreground = JsonSerializer.Deserialize (color, _serializerContext.Color);
+                    foreground = JsonSerializer.Deserialize (color, SerializerContext.Color);
 
                     break;
                 case "background":
-                    background = JsonSerializer.Deserialize (color, _serializerContext.Color);
+                    background = JsonSerializer.Deserialize (color, SerializerContext.Color);
 
                     break;
 

diff --git a/Terminal.Gui/Configuration/ColorSchemeJsonConverter.cs b/Terminal.Gui/Configuration/ColorSchemeJsonConverter.cs
@@ -59,7 +59,7 @@ public override ColorScheme Read (ref Utf8JsonReader reader, Type typeToConvert,
 
             string propertyName = reader.GetString ();
             reader.Read ();
-            var attribute = JsonSerializer.Deserialize (ref reader, _serializerContext.Attribute);
+            var attribute = JsonSerializer.Deserialize (ref reader, SerializerContext.Attribute);
 
             switch (propertyName.ToLower ())
             {

diff --git a/Terminal.Gui/Configuration/ConfigurationManager.cs b/Terminal.Gui/Configuration/ConfigurationManager.cs
@@ -8,6 +8,7 @@
 using System.Text.Encodings.Web;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Microsoft.Extensions.Logging;
 
 #nullable enable
 
@@ -65,7 +66,7 @@ public static class ConfigurationManager
     internal static Dictionary<string, ConfigProperty>? _allConfigProperties;
 
     [SuppressMessage ("Style", "IDE1006:Naming Styles", Justification = "<Pending>")]
-    internal static readonly JsonSerializerOptions _serializerOptions = new ()
+    internal static readonly JsonSerializerOptions SerializerOptions = new ()
     {
         ReadCommentHandling = JsonCommentHandling.Skip,
         PropertyNameCaseInsensitive = true,
@@ -87,7 +88,7 @@ public static class ConfigurationManager
     };
 
     [SuppressMessage ("Style", "IDE1006:Naming Styles", Justification = "<Pending>")]
-    internal static readonly SourceGenerationContext _serializerContext = new (_serializerOptions);
+    internal static readonly SourceGenerationContext SerializerContext = new (SerializerOptions);
 
     [SuppressMessage ("Style", "IDE1006:Naming Styles", Justification = "<Pending>")]
     internal static StringBuilder _jsonErrors = new ();
@@ -209,7 +210,7 @@ public static string GetEmptyJson ()
         var emptyScope = new SettingsScope ();
         emptyScope.Clear ();
 
-        return JsonSerializer.Serialize (emptyScope, typeof (SettingsScope), _serializerContext);
+        return JsonSerializer.Serialize (emptyScope, typeof (SettingsScope), SerializerContext);
     }
 
     /// <summary>
@@ -235,7 +236,7 @@ public static string GetEmptyJson ()
     [RequiresDynamicCode ("AOT")]
     public static void Load (bool reset = false)
     {
-        Debug.WriteLine ("ConfigurationManager.Load()");
+        Logging.Trace ($"reset = {reset}");
 
         if (reset)
         {
@@ -292,7 +293,7 @@ public static void Load (bool reset = false)
     /// </summary>
     public static void OnApplied ()
     {
-        Debug.WriteLine ("ConfigurationManager.OnApplied()");
+        //Logging.Trace ("");
 
         Applied?.Invoke (null, new ());
 
@@ -308,7 +309,7 @@ public static void OnApplied ()
     /// </summary>
     public static void OnUpdated ()
     {
-        Debug.WriteLine (@"ConfigurationManager.OnUpdated()");
+        //Logging.Trace (@"");
         Updated?.Invoke (null, new ());
     }
 
@@ -324,6 +325,18 @@ public static void PrintJsonErrors ()
         }
     }
 
+
+    public static void LogJsonErrors ()
+    {
+        if (_jsonErrors.Length > 0)
+        {
+            Logging.Warning (
+                               @"Encountered the following errors while deserializing configuration files:"
+                              );
+            Logging.Warning (_jsonErrors.ToString ());
+        }
+    }
+
     /// <summary>
     ///     Resets the state of <see cref="ConfigurationManager"/>. Should be called whenever a new app session (e.g. in
     ///     <see cref="Application.Init"/> starts. Called by <see cref="Load"/> if the <c>reset</c> parameter is
@@ -334,7 +347,7 @@ public static void PrintJsonErrors ()
     [RequiresDynamicCode ("AOT")]
     public static void Reset ()
     {
-        Debug.WriteLine (@"ConfigurationManager.Reset()");
+        Logging.Trace ($"_allConfigProperties = {_allConfigProperties}");
 
         if (_allConfigProperties is null)
         {
@@ -369,7 +382,7 @@ public static void Reset ()
 
     internal static void AddJsonError (string error)
     {
-        Debug.WriteLine ($"ConfigurationManager: {error}");
+        Logging.Trace ($"error = {error}");
         _jsonErrors.AppendLine (error);
     }
 
@@ -541,8 +554,8 @@ where type.GetProperties ()
             classesWithConfigProps.Add (classWithConfig.Name, classWithConfig);
         }
 
-        //Debug.WriteLine ($"ConfigManager.getConfigProperties found {classesWithConfigProps.Count} classes:");
-        classesWithConfigProps.ToList ().ForEach (x => Debug.WriteLine ($"  Class: {x.Key}"));
+        //Logging.Trace ($"ConfigManager.getConfigProperties found {classesWithConfigProps.Count} classes:");
+        classesWithConfigProps.ToList ().ForEach (x => Logging.Trace ($"  Class: {x.Key}"));
 
         foreach (PropertyInfo? p in from c in classesWithConfigProps
                                     let props = c.Value
@@ -595,9 +608,9 @@ from p in enumerable
                                                                    StringComparer.InvariantCultureIgnoreCase
                                                                   );
 
-        //Debug.WriteLine ($"ConfigManager.Initialize found {_allConfigProperties.Count} properties:");
+        //Logging.Trace ($"Found {_allConfigProperties.Count} properties:");
 
-        //_allConfigProperties.ToList ().ForEach (x => Debug.WriteLine ($"  Property: {x.Key}"));
+        //_allConfigProperties.ToList ().ForEach (x => Logging.Trace ($"  Property: {x.Key}"));
 
         AppSettings = new ();
     }
@@ -608,16 +621,16 @@ from p in enumerable
     [RequiresDynamicCode ("AOT")]
     internal static string ToJson ()
     {
-        //Debug.WriteLine ("ConfigurationManager.ToJson()");
+        //Logging.Trace ("ConfigurationManager.ToJson()");
 
-        return JsonSerializer.Serialize (Settings!, typeof (SettingsScope), _serializerContext);
+        return JsonSerializer.Serialize (Settings!, typeof (SettingsScope), SerializerContext);
     }
 
     [RequiresUnreferencedCode ("AOT")]
     [RequiresDynamicCode ("AOT")]
     internal static Stream ToStream ()
     {
-        string json = JsonSerializer.Serialize (Settings!, typeof (SettingsScope), _serializerContext);
+        string json = JsonSerializer.Serialize (Settings!, typeof (SettingsScope), SerializerContext);
 
         // turn it into a stream
         var stream = new MemoryStream ();

diff --git a/Terminal.Gui/Configuration/DictionaryJsonConverter.cs b/Terminal.Gui/Configuration/DictionaryJsonConverter.cs
@@ -28,7 +28,7 @@ JsonSerializerOptions options
                 {
                     string key = reader.GetString ();
                     reader.Read ();
-                    var value = JsonSerializer.Deserialize (ref reader, typeof (T), _serializerContext);
+                    var value = JsonSerializer.Deserialize (ref reader, typeof (T), SerializerContext);
                     dictionary.Add (key, (T)value);
                 }
             }
@@ -51,7 +51,7 @@ public override void Write (Utf8JsonWriter writer, Dictionary<string, T> value,
 
             //writer.WriteString (item.Key, item.Key);
             writer.WritePropertyName (item.Key);
-            JsonSerializer.Serialize (writer, item.Value, typeof (T), _serializerContext);
+            JsonSerializer.Serialize (writer, item.Value, typeof (T), SerializerContext);
             writer.WriteEndObject ();
         }
 

diff --git a/Terminal.Gui/Configuration/ScopeJsonConverter.cs b/Terminal.Gui/Configuration/ScopeJsonConverter.cs
@@ -89,11 +89,11 @@ public override scopeT Read (ref Utf8JsonReader reader, Type typeToConvert, Json
                     try
                     {
                         scope! [propertyName].PropertyValue =
-                            JsonSerializer.Deserialize (ref reader, propertyType!, _serializerContext);
+                            JsonSerializer.Deserialize (ref reader, propertyType!, SerializerContext);
                     }
                     catch (Exception ex)
                     {
-                        Debug.WriteLine ($"scopeT Read: {ex}");
+                       // Logging.Trace ($"scopeT Read: {ex}");
                     }
                 }
             }
@@ -137,7 +137,7 @@ public override scopeT Read (ref Utf8JsonReader reader, Type typeToConvert, Json
                 if (property is { })
                 {
                     PropertyInfo prop = scope.GetType ().GetProperty (propertyName!)!;
-                    prop.SetValue (scope, JsonSerializer.Deserialize (ref reader, prop.PropertyType, _serializerContext));
+                    prop.SetValue (scope, JsonSerializer.Deserialize (ref reader, prop.PropertyType, SerializerContext));
                 }
                 else
                 {
@@ -165,7 +165,7 @@ public override void Write (Utf8JsonWriter writer, scopeT scope, JsonSerializerO
         {
             writer.WritePropertyName (ConfigProperty.GetJsonPropertyName (p));
             object? prop = scope.GetType ().GetProperty (p.Name)?.GetValue (scope);
-            JsonSerializer.Serialize (writer, prop, prop!.GetType (), _serializerContext);
+            JsonSerializer.Serialize (writer, prop, prop!.GetType (), SerializerContext);
         }
 
         foreach (KeyValuePair<string, ConfigProperty> p in from p in scope
@@ -211,7 +211,7 @@ SerializableConfigurationProperty scp
             else
             {
                 object? prop = p.Value.PropertyValue;
-                JsonSerializer.Serialize (writer, prop, prop!.GetType (), _serializerContext);
+                JsonSerializer.Serialize (writer, prop, prop!.GetType (), SerializerContext);
             }
         }
 

diff --git a/Terminal.Gui/Configuration/SettingsScope.cs b/Terminal.Gui/Configuration/SettingsScope.cs
@@ -45,9 +45,9 @@ public class SettingsScope : Scope<SettingsScope>
         // Update the existing settings with the new settings.
         try
         {
-            Update ((SettingsScope)JsonSerializer.Deserialize (stream, typeof (SettingsScope), _serializerOptions)!);
+            Update ((SettingsScope)JsonSerializer.Deserialize (stream, typeof (SettingsScope), SerializerOptions)!);
             OnUpdated ();
-            Debug.WriteLine ($"ConfigurationManager: Read configuration from \"{source}\"");
+            Logging.Trace ($"Read from \"{source}\"");
             if (!Sources.ContainsValue (source))
             {
                 Sources.Add (location, source);
@@ -79,7 +79,7 @@ public class SettingsScope : Scope<SettingsScope>
 
         if (!File.Exists (realPath))
         {
-            Debug.WriteLine ($"ConfigurationManager: Configuration file \"{realPath}\" does not exist.");
+            Logging.Warning ($"\"{realPath}\" does not exist.");
             if (!Sources.ContainsValue (filePath))
             {
                 Sources.Add (location, filePath);
@@ -105,7 +105,7 @@ public class SettingsScope : Scope<SettingsScope>
             }
             catch (IOException ioe)
             {
-                Debug.WriteLine ($"Couldn't open {filePath}. Retrying...: {ioe}");
+                Logging.Warning ($"Couldn't open {filePath}. Retrying...: {ioe}");
                 Task.Delay (100);
                 retryCount++;
             }

diff --git a/Terminal.Gui/Configuration/ThemeManager.cs b/Terminal.Gui/Configuration/ThemeManager.cs
@@ -127,7 +127,7 @@ internal static string SelectedTheme
     [RequiresDynamicCode ("Calls Terminal.Gui.ThemeManager.Themes")]
     internal static void GetHardCodedDefaults ()
     {
-        //Debug.WriteLine ("Themes.GetHardCodedDefaults()");
+        //Logging.Trace ("Themes.GetHardCodedDefaults()");
         var theme = new ThemeScope ();
         theme.RetrieveValues ();
 
@@ -141,15 +141,15 @@ internal static void GetHardCodedDefaults ()
     /// <summary>Called when the selected theme has changed. Fires the <see cref="ThemeChanged"/> event.</summary>
     internal void OnThemeChanged (string theme)
     {
-        //Debug.WriteLine ($"Themes.OnThemeChanged({theme}) -> {Theme}");
+        //Logging.Trace ($"Themes.OnThemeChanged({theme}) -> {Theme}");
         ThemeChanged?.Invoke (this, new ThemeManagerEventArgs (theme));
     }
 
     [RequiresUnreferencedCode ("Calls Terminal.Gui.ThemeManager.Themes")]
     [RequiresDynamicCode ("Calls Terminal.Gui.ThemeManager.Themes")]
     internal static void Reset ()
     {
-        Debug.WriteLine ("Themes.Reset()");
+        //Logging.Trace ("Themes.Reset()");
         Colors.Reset ();
         Themes?.Clear ();
         SelectedTheme = string.Empty;

diff --git a/Terminal.Gui/ConsoleDrivers/V2/Logging.cs b/Terminal.Gui/ConsoleDrivers/V2/Logging.cs
@@ -13,7 +13,7 @@ namespace Terminal.Gui;
 /// <remarks>
 ///     Also contains the
 ///     <see cref="Meter"/> instance that should be used for internal metrics
-///     (iteration timing etc).
+///     (iteration timing etc.).
 /// </remarks>
 public static class Logging
 {
@@ -51,7 +51,71 @@ public static class Logging
     public static readonly Histogram<int> DrainInputStream = Meter.CreateHistogram<int> ("Drain Input (ms)");
 
     /// <summary>
-    ///     Logs a trace message including the
+    ///     Logs an error message including the class and method name.
+    /// </summary>
+    /// <param name="message"></param>
+    /// <param name="caller"></param>
+    /// <param name="filePath"></param>
+    public static void Error (
+        string message,
+        [CallerMemberName] string caller = "",
+        [CallerFilePath] string filePath = ""
+    )
+    {
+        string className = Path.GetFileNameWithoutExtension (filePath);
+        Logger.LogError ($"[{className}] [{caller}] {message}");
+    }
+
+    /// <summary>
+    ///     Logs a critical message including the class and method name.
+    /// </summary>
+    /// <param name="message"></param>
+    /// <param name="caller"></param>
+    /// <param name="filePath"></param>
+    public static void Critical (
+        string message,
+        [CallerMemberName] string caller = "",
+        [CallerFilePath] string filePath = ""
+    )
+    {
+        string className = Path.GetFileNameWithoutExtension (filePath);
+        Logger.LogCritical ($"[{className}] [{caller}] {message}");
+    }
+
+    /// <summary>
+    ///     Logs a debug message including the class and method name.
+    /// </summary>
+    /// <param name="message"></param>
+    /// <param name="caller"></param>
+    /// <param name="filePath"></param>
+    public static void Debug (
+        string message,
+        [CallerMemberName] string caller = "",
+        [CallerFilePath] string filePath = ""
+    )
+    {
+        string className = Path.GetFileNameWithoutExtension (filePath);
+        Logger.LogDebug ($"[{className}] [{caller}] {message}");
+    }
+
+    /// <summary>
+    ///     Logs an informational message including the class and method name.
+    /// </summary>
+    /// <param name="message"></param>
+    /// <param name="caller"></param>
+    /// <param name="filePath"></param>
+    public static void Information (
+        string message,
+        [CallerMemberName] string caller = "",
+        [CallerFilePath] string filePath = ""
+    )
+    {
+        string className = Path.GetFileNameWithoutExtension (filePath);
+        Logger.LogInformation ($"[{className}] [{caller}] {message}");
+    }
+
+    /// <summary>
+    ///     Logs a trace message including the class and method name.
     /// </summary>
     /// <param name="message"></param>
     /// <param name="caller"></param>
@@ -65,4 +129,20 @@ public static void Trace (
         string className = Path.GetFileNameWithoutExtension (filePath);
         Logger.LogTrace ($"[{className}] [{caller}] {message}");
     }
+
+    /// <summary>
+    ///     Logs a warning message including the class and method name.
+    /// </summary>
+    /// <param name="message"></param>
+    /// <param name="caller"></param>
+    /// <param name="filePath"></param>
+    public static void Warning (
+        string message,
+        [CallerMemberName] string caller = "",
+        [CallerFilePath] string filePath = ""
+    )
+    {
+        string className = Path.GetFileNameWithoutExtension (filePath);
+        Logger.LogWarning ($"[{className}] [{caller}] {message}");
+    }
 }