MessagePack serializers check for "AllowDefaultStructs" and for null + fixed typo

Author: PawelGerr

docs

@@ -13,7 +13,7 @@ namespace Thinktecture;
 [MessagePackFormatter(typeof(Formatters.ValueObjectMessagePackFormatter<TextOrNumberSerializableWithFormatter, string, ValidationError>))] // Optional: otherwise ValueObjectMessageFormatterResolver is required
 public partial class TextOrNumberSerializableWithFormatter :
    IValueObjectFactory<TextOrNumberSerializableWithFormatter, string, ValidationError>, // For deserialization
-   IValueObjectConvertable<string>,                                                     // For serialization
+   IValueObjectConvertible<string>,                                                     // For serialization
    IParsable<TextOrNumberSerializableWithFormatter>                                     // For Minimal API and ASP.NET Core model binding validation
 {
    // For serialization

samples/Thinktecture.Runtime.Extensions.MessagePack.Samples/TextOrNumberSerializableWithFormatter.cs

@@ -13,7 +13,7 @@ namespace Thinktecture.Unions;
 [JsonConverter(typeof(ValueObjectJsonConverterFactory<TextOrNumberSerializable, string, ValidationError>))] // Optional: otherwise ValueObjectJsonConverterFactory is required
 public partial class TextOrNumberSerializable :
    IValueObjectFactory<TextOrNumberSerializable, string, ValidationError>, // For deserialization
-   IValueObjectConvertable<string>,                                        // For serialization
+   IValueObjectConvertible<string>,                                        // For serialization
    IParsable<TextOrNumberSerializable> // For Minimal API and ASP.NET Core model binding validation
 {
    // For serialization

samples/Thinktecture.Runtime.Extensions.Samples/Unions/TextOrNumberSerializable.cs

@@ -41,7 +41,7 @@ static partial void ValidateFactoryArguments(ref ValidationError? validationErro
    }
 
    /// <summary>
-   /// Custom implementation of "IValueObjectConvertable&amp;lt;string&amp;gt;"
+   /// Custom implementation of "IValueObjectConvertible&amp;lt;string&amp;gt;"
    /// requested by "ValueObjectFactory&lt;string&gt;".
    /// </summary>
    public string ToValue()

samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/BoundaryWithFactories.cs

@@ -17,7 +17,7 @@ public sealed class ValueObjectValueConverterFactory
    /// <typeparam name="TKey">Type of the key.</typeparam>
    /// <returns>An instance of <see cref="ValueConverter{T,TKey}"/>></returns>
    public static ValueConverter<T, TKey> Create<T, TKey>(bool useConstructorForRead = true)
-      where T : IValueObjectFactory<TKey>, IValueObjectConvertable<TKey>
+      where T : IValueObjectFactory<TKey>, IValueObjectConvertible<TKey>
       where TKey : notnull
    {
       return new ValueObjectValueConverter<T, TKey>(useConstructorForRead);
@@ -31,7 +31,7 @@ public static ValueConverter<T, TKey> Create<T, TKey>(bool useConstructorForRead
    /// <typeparam name="TKey">Type of the key.</typeparam>
    /// <returns>An instance of <see cref="ValueConverter{TEnum,TKey}"/>></returns>
    public static ValueConverter<TEnum, TKey> CreateForValidatableEnum<TEnum, TKey>(bool validateOnWrite)
-      where TEnum : IValidatableEnum, IValueObjectFactory<TKey>, IValueObjectConvertable<TKey>
+      where TEnum : IValidatableEnum, IValueObjectFactory<TKey>, IValueObjectConvertible<TKey>
       where TKey : notnull
    {
       return new ValidatableEnumValueConverter<TEnum, TKey>(validateOnWrite);
@@ -81,7 +81,7 @@ internal static ValueConverter Create(
    }
 
    private static Expression<Func<TKey, T>> GetConverterFromKey<T, TKey>(bool useConstructor)
-      where T : IValueObjectFactory<TKey>, IValueObjectConvertable<TKey>
+      where T : IValueObjectFactory<TKey>, IValueObjectConvertible<TKey>
       where TKey : notnull
    {
       var metadata = KeyedValueObjectMetadataLookup.Find(typeof(T));
@@ -102,7 +102,7 @@ private static T Convert<T>(object value)
    }
 
    private sealed class ValueObjectValueConverter<T, TKey> : ValueConverter<T, TKey>
-      where T : IValueObjectFactory<TKey>, IValueObjectConvertable<TKey>
+      where T : IValueObjectFactory<TKey>, IValueObjectConvertible<TKey>
       where TKey : notnull
    {
       /// <inheritdoc />
@@ -122,7 +122,7 @@ public ValueObjectValueConverter(bool useConstructor)
    }
 
    private sealed class ValidatableEnumValueConverter<TEnum, TKey> : ValueConverter<TEnum, TKey>
-      where TEnum : IValidatableEnum, IValueObjectFactory<TKey>, IValueObjectConvertable<TKey>
+      where TEnum : IValidatableEnum, IValueObjectFactory<TKey>, IValueObjectConvertible<TKey>
       where TKey : notnull
    {
       /// <inheritdoc />

src/Thinktecture.Runtime.Extensions.EntityFrameworkCore.Sources/EntityFrameworkCore/Storage/ValueConversion/ValueObjectValueConverterFactory.cs

@@ -10,7 +10,7 @@ namespace Thinktecture.Text.Json.Serialization;
 /// <typeparam name="TKey">Type of the key.</typeparam>
 /// <typeparam name="TValidationError">Type of the validation error.</typeparam>
 public sealed class ValueObjectJsonConverter<T, TKey, TValidationError> : JsonConverter<T>
-   where T : IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertable<TKey>
+   where T : IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertible<TKey>
    where TKey : notnull
    where TValidationError : class, IValidationError<TValidationError>
 {
@@ -71,7 +71,7 @@ public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions
 /// <typeparam name="T">Type of the value object.</typeparam>
 /// <typeparam name="TValidationError">Type of the validation error.</typeparam>
 public sealed class ValueObjectJsonConverter<T, TValidationError> : JsonConverter<T>
-   where T : IValueObjectFactory<T, string, TValidationError>, IValueObjectConvertable<string>
+   where T : IValueObjectFactory<T, string, TValidationError>, IValueObjectConvertible<string>
    where TValidationError : class, IValidationError<TValidationError>
 {
    private static readonly bool _mayReturnInvalidObjects = typeof(IValidatableEnum).IsAssignableFrom(typeof(T));

src/Thinktecture.Runtime.Extensions.Json/Text/Json/Serialization/ValueObjectJsonConverter.cs

@@ -9,7 +9,7 @@ namespace Thinktecture.Text.Json.Serialization;
 /// Factory for creation of <see cref="ValueObjectJsonConverter{T,TKey,TValidationError}"/>.
 /// </summary>
 public sealed class ValueObjectJsonConverterFactory<T, TKey, TValidationError> : JsonConverterFactory
-   where T : IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertable<TKey>
+   where T : IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertible<TKey>
    where TKey : notnull
    where TValidationError : class, IValidationError<TValidationError>
 {
@@ -33,7 +33,7 @@ public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializer
 /// Factory for creation of <see cref="ValueObjectJsonConverter{T,TKey,TValidationError}"/>.
 /// </summary>
 public sealed class ValueObjectJsonConverterFactory<T, TValidationError> : JsonConverterFactory
-   where T : IValueObjectFactory<T, string, TValidationError>, IValueObjectConvertable<string>
+   where T : IValueObjectFactory<T, string, TValidationError>, IValueObjectConvertible<string>
    where TValidationError : class, IValidationError<TValidationError>
 {
    /// <inheritdoc />

src/Thinktecture.Runtime.Extensions.Json/Text/Json/Serialization/ValueObjectJsonConverterFactory.cs

@@ -12,11 +12,13 @@ namespace Thinktecture.Formatters;
 /// <typeparam name="TKey">Type of the key.</typeparam>
 /// <typeparam name="TValidationError">Type of the validation error.</typeparam>
 public sealed class StructValueObjectMessagePackFormatter<T, TKey, TValidationError> : IMessagePackFormatter<T>, IMessagePackFormatter<T?>
-   where T : struct, IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertable<TKey>
+   where T : struct, IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertible<TKey>
    where TKey : notnull
    where TValidationError : class, IValidationError<TValidationError>
 {
    private static readonly bool _mayReturnInvalidObjects = typeof(IValidatableEnum).IsAssignableFrom(typeof(T));
+   private static readonly bool _disallowDefaultValues = typeof(IDisallowDefaultValue).IsAssignableFrom(typeof(T));
+   private static readonly TKey? _keyDefaultValue = default;
 
    /// <inheritdoc />
    public void Serialize(ref MessagePackWriter writer, T value, MessagePackSerializerOptions options)
@@ -41,8 +43,19 @@ public void Serialize(ref MessagePackWriter writer, T? value, MessagePackSeriali
    /// <inheritdoc />
    public T Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
    {
-      if (!TryReadKey(ref reader, options, out var key))
+      var formatter = options.Resolver.GetFormatterWithVerify<TKey?>();
+      var key = formatter.Deserialize(ref reader, options);
+
+      if (key is null)
+      {
+         if (_disallowDefaultValues)
+            throw new MessagePackSerializationException($"Cannot convert null to type \"{typeof(T).Name}\" because it doesn't allow default values.");
+
          return default;
+      }
+
+      if (_disallowDefaultValues && key.Equals(_keyDefaultValue))
+         throw new MessagePackSerializationException($"Cannot convert null to type \"{typeof(T).Name}\" because it doesn't allow default values.");
 
       return Deserialize(key);
    }
@@ -51,7 +64,7 @@ public T Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions
    T? IMessagePackFormatter<T?>.Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
    {
       if (!TryReadKey(ref reader, options, out var key))
-         return default;
+         return default; // nullable struct
 
       return Deserialize(key);
    }

src/Thinktecture.Runtime.Extensions.MessagePack/Formatters/StructValueObjectMessagePackFormatter.cs

@@ -11,7 +11,7 @@ namespace Thinktecture.Formatters;
 /// <typeparam name="TKey">Type of the key.</typeparam>
 /// <typeparam name="TValidationError">Type of the validation error.</typeparam>
 public sealed class ValueObjectMessagePackFormatter<T, TKey, TValidationError> : IMessagePackFormatter<T?>
-   where T : class, IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertable<TKey>
+   where T : class, IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertible<TKey>
    where TKey : notnull
    where TValidationError : class, IValidationError<TValidationError>
 {

src/Thinktecture.Runtime.Extensions.MessagePack/Formatters/ValueObjectMessagePackFormatter.cs

@@ -9,7 +9,7 @@ namespace Thinktecture.Json;
 /// <typeparam name="TKey">Type of the key.</typeparam>
 /// <typeparam name="TValidationError">Type of the validation error.</typeparam>
 public sealed class ValueObjectNewtonsoftJsonConverter<T, TKey, TValidationError> : JsonConverter
-   where T : IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertable<TKey>
+   where T : IValueObjectFactory<T, TKey, TValidationError>, IValueObjectConvertible<TKey>
    where TKey : notnull
    where TValidationError : class, IValidationError<TValidationError>
 {