Workaround aaubry/YamlDotNet#544

openmod · Jan 17, 2021 · 5e31264 · 5e31264
1 parent 536571f
commit 5e31264
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 1 deletion.
diff --git a/framework/OpenMod.Core/Commands/CommandStore.cs b/framework/OpenMod.Core/Commands/CommandStore.cs
@@ -128,7 +128,7 @@ public async Task InvalidateAsync()
             }
 
             await m_CommandDataStore.SetRegisteredCommandsAsync(commandsData);
-            m_Logger.LogDebug($"InvalidateAsync: Loaded {commands.Count} commands.");
+            m_Logger.LogInformation($"Loaded {commands.Count} commands.");
         }
 
         public async Task<IReadOnlyCollection<ICommandRegistration>> GetCommandsAsync()

diff --git a/framework/OpenMod.Core/Persistence/YamlDataStore.cs b/framework/OpenMod.Core/Persistence/YamlDataStore.cs
@@ -47,10 +47,13 @@ public YamlDataStore(DataStoreCreationParameters parameters)
 
             m_Serializer = new SerializerBuilder()
                 .WithNamingConvention(CamelCaseNamingConvention.Instance)
+                .WithTypeConverter(new YamlNullableEnumTypeConverter())
                 .Build();
 
             m_Deserializer = new DeserializerBuilder()
                 .WithNamingConvention(CamelCaseNamingConvention.Instance)
+                .IgnoreUnmatchedProperties()
+                .WithTypeConverter(new YamlNullableEnumTypeConverter())
                 .Build();
 
             m_ChangeListeners = new List<KeyValuePair<IOpenModComponent, Action>>();

diff --git a/framework/OpenMod.Core/Persistence/YamlNullableEnumTypeConverter.cs b/framework/OpenMod.Core/Persistence/YamlNullableEnumTypeConverter.cs
@@ -0,0 +1,50 @@
+using System;
+using OpenMod.API;
+using YamlDotNet.Core;
+using YamlDotNet.Core.Events;
+using YamlDotNet.Serialization;
+
+namespace OpenMod.Core.Persistence
+{
+    /// Fixes an issue introduced in YamlDotNet 9.1
+    /// https://github.com/aaubry/YamlDotNet/issues/544
+    [OpenModInternal]
+    public class YamlNullableEnumTypeConverter : IYamlTypeConverter
+    {
+        public bool Accepts(Type type)
+        {
+            return Nullable.GetUnderlyingType(type)?.IsEnum ?? false;
+        }
+
+        public object ReadYaml(IParser parser, Type type)
+        {
+            type = Nullable.GetUnderlyingType(type) ?? throw new ArgumentException("Expected nullable enum type for ReadYaml");
+            var scalar = parser.Consume<Scalar>();
+
+            if (string.IsNullOrWhiteSpace(scalar.Value))
+            {
+                return null;
+            }
+
+            try
+            {
+                return Enum.Parse(type, scalar.Value);
+            }
+            catch(Exception ex)
+            {
+                throw new Exception($"Invalid value: \"{scalar.Value}\" for {type.Name}", ex);
+            }
+        }
+
+        public void WriteYaml(IEmitter emitter, object value, Type type)
+        {
+            type = Nullable.GetUnderlyingType(type) ?? throw new ArgumentException("Expected nullable enum type for WriteYaml");
+
+            if (value != null)
+            {
+                var toWrite = Enum.GetName(type, value) ?? throw new InvalidOperationException($"Invalid value {value} for enum: {type}");
+                emitter.Emit(new Scalar(null, null, toWrite, ScalarStyle.Any, true, false));
+            }
+        }
+    }
+}