Add log for cmd pal ext to trace exceptions (#39326)

* Add log to trace error for apps.

* Add bookmark log

* registry exception log

* fix

* Added logger for cmdpal extensions.

Signed-off-by: Shawn Yuan <shuaiyuan@microsoft.com>

* remove noise

* Update

Signed-off-by: Shawn Yuan <shuaiyuan@microsoft.com>

* change log level

* change level

* Fix comments

* Fixed comments.

Signed-off-by: Shawn Yuan <shuaiyuan@microsoft.com>

* Resolve comments

Signed-off-by: Shawn Yuan <shuaiyuan@microsoft.com>

---------

Signed-off-by: Shawn Yuan <shuaiyuan@microsoft.com>
Co-authored-by: Shawn Yuan <shuaiyuan@microsoft.com>

src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WindowsSettings/Helpers/JsonSettingsListHelper.cs

@@ -6,6 +6,7 @@ using System;
 using System.IO;
 using System.Reflection;
 using System.Text.Json;
+using ManagedCommon;
 
 namespace Microsoft.CmdPal.Ext.WindowsSettings.Helpers;
 
@@ -60,6 +61,7 @@ internal static class JsonSettingsListHelper
         {
             // TODO GH #108 Logging is something we have to take care of
             // Log.Exception("Error loading settings JSON file", exception, typeof(JsonSettingsListHelper));
+            Logger.LogError($"Error loading settings JSON file: {exception.Message}");
         }
 #pragma warning restore CS0168
         return settings ?? new Classes.WindowsSettings();

src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WindowsSettings/Helpers/TranslationHelper.cs

@@ -7,6 +7,7 @@ using System.Collections.ObjectModel;
 using System.Globalization;
 using System.Linq;
 
+using ManagedCommon;
 using Microsoft.CmdPal.Ext.WindowsSettings.Properties;
 
 namespace Microsoft.CmdPal.Ext.WindowsSettings.Helpers;
@@ -36,6 +37,7 @@ internal static class TranslationHelper
                 if (string.IsNullOrEmpty(name))
                 {
                     // Log.Warn($"Resource string for [{settings.Name}] not found", typeof(TranslationHelper));
+                    Logger.LogWarning($"Resource string for [{settings.Name}] not found");
                 }
 
                 settings.Name = name ?? settings.Name ?? string.Empty;
@@ -48,6 +50,7 @@ internal static class TranslationHelper
                 if (string.IsNullOrEmpty(type))
                 {
                     // Log.Warn($"Resource string for [{settings.Type}] not found", typeof(TranslationHelper));
+                    Logger.LogWarning($"Resource string for [{settings.Type}] not found");
                 }
 
                 settings.Type = type ?? settings.Type ?? string.Empty;
@@ -69,6 +72,7 @@ internal static class TranslationHelper
                     if (string.IsNullOrEmpty(translatedArea))
                     {
                         // Log.Warn($"Resource string for [{area}] not found", typeof(TranslationHelper));
+                        Logger.LogWarning($"Resource string for [{area}] not found");
                     }
 
                     translatedAreas.Add(translatedArea ?? area);
@@ -93,6 +97,7 @@ internal static class TranslationHelper
                     if (string.IsNullOrEmpty(translatedAltName))
                     {
                         // Log.Warn($"Resource string for [{altName}] not found", typeof(TranslationHelper));
+                        Logger.LogWarning($"Resource string for [{altName}] not found");
                     }
 
                     translatedAltNames.Add(translatedAltName ?? altName);
@@ -108,6 +113,7 @@ internal static class TranslationHelper
                 if (string.IsNullOrEmpty(note))
                 {
                     // Log.Warn($"Resource string for [{settings.Note}] not found", typeof(TranslationHelper));
+                    Logger.LogWarning($"Resource string for [{settings.Note}] not found");
                 }
 
                 settings.Note = note ?? settings.Note ?? string.Empty;

src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WindowsSettings/Helpers/UnsupportedSettingsHelper.cs

@@ -4,6 +4,7 @@
 
 using System;
 using System.Linq;
+using ManagedCommon;
 
 namespace Microsoft.CmdPal.Ext.WindowsSettings.Helpers;
 
@@ -40,6 +41,7 @@ internal static class UnsupportedSettingsHelper
 
             // TODO GH #108 Logging is something we have to take care of
             // Log.Warn(warningMessage, typeof(UnsupportedSettingsHelper));
+            Logger.LogWarning(warningMessage);
         }
 
         var currentWindowsBuild = currentBuild != uint.MinValue
@@ -71,12 +73,9 @@ internal static class UnsupportedSettingsHelper
         {
             registryValueData = Win32.Registry.GetValue(registryKey, valueName, uint.MinValue);
         }
-        catch
+        catch (Exception ex)
         {
-            // Log.Exception(
-            //    $"Can't get registry value for '{valueName}'",
-            //    exception,
-            //    typeof(UnsupportedSettingsHelper));
+            Logger.LogError($"Can't get registry value for '{valueName}' - {ex.Message}");
             return uint.MinValue;
         }
 

src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WindowsSettings/Helpers/WindowsSettingsPathHelper.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Linq;
+using ManagedCommon;
 
 namespace Microsoft.CmdPal.Ext.WindowsSettings.Helpers;
 
@@ -34,6 +35,7 @@ internal static class WindowsSettingsPathHelper
             {
                 // TODO GH #108 Logging is something we have to take care of
                 // Log.Warn($"The type property is not set for setting [{settings.Name}] in json. Skipping generating of settings path.", typeof(WindowsSettingsPathHelper));
+                Logger.LogWarning($"The type property is not set for setting [{settings.Name}] in json. Skipping generating of settings path.");
                 continue;
             }
 
@@ -41,12 +43,14 @@ internal static class WindowsSettingsPathHelper
             if (!string.IsNullOrEmpty(settings.JoinedAreaPath))
             {
                 // Log.Debug($"The property [JoinedAreaPath] of setting [{settings.Name}] was filled from the json. This value is not used and will be overwritten.", typeof(WindowsSettingsPathHelper));
+                Logger.LogDebug($"The property [JoinedAreaPath] of setting [{settings.Name}] was filled from the json. This value is not used and will be overwritten.");
             }
 
             if (!string.IsNullOrEmpty(settings.JoinedFullSettingsPath))
             {
                 // TODO GH #108 Logging is something we have to take care of
                 // Log.Debug($"The property [JoinedFullSettingsPath] of setting [{settings.Name}] was filled from the json. This value is not used and will be overwritten.", typeof(WindowsSettingsPathHelper));
+                Logger.LogDebug($"The property [JoinedFullSettingsPath] of setting [{settings.Name}] was filled from the json. This value is not used and will be overwritten.");
             }
 
             // Generating path values.

src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.WindowsSettings/Microsoft.CmdPal.Ext.WindowsSettings.csproj

@@ -20,6 +20,7 @@
     <PackageReference Include="System.ServiceProcess.ServiceController" />
   </ItemGroup>
   <ItemGroup>
+    <ProjectReference Include="..\..\..\..\common\ManagedCommon\ManagedCommon.csproj" />
     <ProjectReference Include="..\..\extensionsdk\Microsoft.CommandPalette.Extensions.Toolkit\Microsoft.CommandPalette.Extensions.Toolkit.csproj" />
   </ItemGroup>
   <ItemGroup>