Added logging (#115)

coenm · Apr 25, 2024 · 63cd484 · 63cd484
1 parent 1dec0c5
commit 63cd484
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 6 deletions.
diff --git a/src/RepoM.ActionMenu.Core/Yaml/Serialization/ActionMenuDeserializer.cs b/src/RepoM.ActionMenu.Core/Yaml/Serialization/ActionMenuDeserializer.cs
@@ -2,7 +2,9 @@ namespace RepoM.ActionMenu.Core.Yaml.Serialization;
 
 using System;
 using System.Collections.Generic;
+using System.ComponentModel.Design;
 using System.Linq;
+using Microsoft.Extensions.Logging;
 using RepoM.ActionMenu.Core.Misc;
 using RepoM.ActionMenu.Core.Model;
 using RepoM.ActionMenu.Core.Yaml.Model;
@@ -34,17 +36,21 @@ internal class ActionMenuDeserializer : IActionMenuDeserializer
             { typeof(Predicate), () => new ScribanPredicate() },
             { typeof(Text), () => new ScribanText() },
         };
+    private readonly ILogger _logger;
 
-    public ActionMenuDeserializer(IEnumerable<IKeyTypeRegistration<IMenuAction>> keyTypeRegistrations, ITemplateParser templateParser)
-        : this(keyTypeRegistrations.ToDictionary(item => item.Tag, item => item.ConfigurationType), templateParser)
+    public ActionMenuDeserializer(IEnumerable<IKeyTypeRegistration<IMenuAction>> keyTypeRegistrations, ITemplateParser templateParser, ILogger logger)
+        : this(keyTypeRegistrations.ToDictionary(item => item.Tag, item => item.ConfigurationType), templateParser, logger)
     {
     }
 
-    private ActionMenuDeserializer(IDictionary<string, Type> menuActionTypes, ITemplateParser templateParser)
+    private ActionMenuDeserializer(IDictionary<string, Type> menuActionTypes, ITemplateParser templateParser, ILogger logger)
     {
         ArgumentNullException.ThrowIfNull(menuActionTypes);
         ArgumentNullException.ThrowIfNull(templateParser);
-
+        ArgumentNullException.ThrowIfNull(logger);
+
+        _logger = logger;
+
         _serializer = new SerializerBuilder()
             .WithNamingConvention(HyphenatedNamingConvention.Instance) // CamelCaseNamingConvention.Instance
             .WithDefaultScalarStyle(ScalarStyle.Any)
@@ -70,7 +76,7 @@ private ActionMenuDeserializer(IDictionary<string, Type> menuActionTypes, ITempl
                                     { ContextActionSetVariableV1.TYPE_VALUE, typeof(ContextActionSetVariableV1)},
                                     { ContextActionLoadFileV1.TYPE_VALUE, typeof(ContextActionLoadFileV1)},
                                 }));
-                    options.AddKeyValueTypeDiscriminator<IMenuAction>("type", menuActionTypes);
+                    options.AddTypeDiscriminator(new RequiredKeyValueTypeDiscriminator<IMenuAction>("type", menuActionTypes, _logger));
                 },
                 maxDepth: -1,
                 maxLength: -1)

diff --git a/src/RepoM.ActionMenu.Core/Yaml/Serialization/RequiredKeyValueTypeDiscriminator.cs b/src/RepoM.ActionMenu.Core/Yaml/Serialization/RequiredKeyValueTypeDiscriminator.cs
@@ -0,0 +1,47 @@
+namespace RepoM.ActionMenu.Core.Yaml.Serialization;
+
+using System;
+using System.Collections.Generic;
+using Microsoft.Extensions.Logging;
+using YamlDotNet.Core;
+using YamlDotNet.Core.Events;
+using YamlDotNet.Serialization.BufferedDeserialization;
+using YamlDotNet.Serialization.BufferedDeserialization.TypeDiscriminators;
+
+internal class RequiredKeyValueTypeDiscriminator<TInterface> : ITypeDiscriminator
+    where TInterface : class
+{
+    private readonly KeyValueTypeDiscriminator _discriminator;
+    private readonly ILogger _logger;
+
+    public RequiredKeyValueTypeDiscriminator(string key, IDictionary<string, Type> mapping, ILogger logger)
+    {
+        _discriminator = new KeyValueTypeDiscriminator(typeof(TInterface), key, mapping);
+        BaseType = typeof(TInterface);
+        _logger = logger;
+    }
+
+    public Type BaseType { get; }
+
+    public bool TryDiscriminate(IParser buffer, out Type? suggestedType)
+    {
+        var result = _discriminator.TryDiscriminate(buffer, out suggestedType);
+
+        if (!result)
+        {
+            if (buffer.Current is Scalar scalar)
+            {
+                _logger.LogError("Could not find required type. Type found {Type}", scalar.Value);
+            }
+            else
+            {
+                _logger.LogError("Could not find required type");
+            }
+
+            suggestedType = null;
+            return false;
+        }
+
+        return true;
+    }
+}
diff --git a/src/RepoM.ActionMenu.Interface/YamlModel/DefaultMenuAction.cs b/src/RepoM.ActionMenu.Interface/YamlModel/DefaultMenuAction.cs
@@ -0,0 +1,16 @@
+namespace RepoM.ActionMenu.Interface.YamlModel;
+
+using RepoM.ActionMenu.Interface.YamlModel.Templating;
+
+public class DefaultMenuAction : IMenuAction
+{
+    public string Type { get; }
+
+    public Predicate Active { get; }
+
+    public DefaultMenuAction()
+    {
+        Type = string.Empty;
+        Active = new Predicate();
+    }
+}
diff --git a/tests/RepoM.ActionMenu.Core.Tests/Yaml/Serialization/ActionMenuDeserializerTests.cs b/tests/RepoM.ActionMenu.Core.Tests/Yaml/Serialization/ActionMenuDeserializerTests.cs
@@ -4,6 +4,7 @@ namespace RepoM.ActionMenu.Core.Tests.Yaml.Serialization;
 using System.Linq;
 using System.Threading.Tasks;
 using FluentAssertions;
+using Microsoft.Extensions.Logging.Abstractions;
 using RepoM.ActionMenu.Core.Misc;
 using RepoM.ActionMenu.Core.Yaml.Model;
 using RepoM.ActionMenu.Core.Yaml.Model.ActionContext.SetVariable;
@@ -22,7 +23,7 @@ public class ActionMenuDeserializerTests
 
     public ActionMenuDeserializerTests()
     {
-        _sut = new ActionMenuDeserializer(_registrations, _templateParser);
+        _sut = new ActionMenuDeserializer(_registrations, _templateParser, NullLogger.Instance);
     }
 
     [Fact]