stefh/anyof

Use the AnyOf<TFirst, TSecond, ...> type to handle multiple defined types as input parameters or return values for methods.

Hi 👋, I'm Stef Heyenrath

• 🔭 I’m currently working on WireMock.Net
• 🌱 I’m currently learning more Azure and Blazor

Environments

Languages

Frontends

anyof's Issues

Issues with matching types on nested objects

Good afternoon! I was exploring this project and I personally think it's awesome! Good work! Just wanted to raise an issue on this, let me know if it's something you'd plan to handle or not please, no worries if it doesn't fit into the scope or goals of this project.

I am attempting to utilize this for supporting multiple unique json responses for a given API endpoint.

When working with flat responses, this tool works really well. The issue I'm encountering is when each object has sub-objects on it. What I ahve found is that you need to register every single type from every possible property in your API response as part of the AnyOf<T1,T2,T3> call, otherwise the sub-objects can't have their types resolved.

Here is a sample I have put together

using AnyOfTypes;
using AnyOfTypes.System.Text.Json;
using System.Text.Json;



var options = new JsonSerializerOptions();
options.Converters.Add(new AnyOfJsonConverter());
options.PropertyNameCaseInsensitive = true;

var json1 = "{\"Value\": \"1\"}";
var json2 = "{\"StringValue\": \"1\"}";
var json3 = "{\"StringValue\": \"1\",\"SubClass\": {\"SampleProperty\": \"Abc\"}}";

var result = System.Text.Json.JsonSerializer.Deserialize<AnyOf<A, B>>(json1, options); // Matches type 2 and has a value of type "B". Works as expected
var result2 = System.Text.Json.JsonSerializer.Deserialize<AnyOf<A, B>>(json2, options); // Matches type 1 and has a value of type "A". Works as expected. SubClass on the result is null, as expected
var result3 = System.Text.Json.JsonSerializer.Deserialize<AnyOf<A, B, SampleSubClass>>(json3, options); // Matches type 2 and has a value of type "B". Works as expected. SubClass has a value with "Abc" as the sample property result
var result4 = System.Text.Json.JsonSerializer.Deserialize<AnyOf<A, B>>(json3, options); // Throws this exception: System.Text.Json.JsonException: 'No suitable type found.'

public class SampleSubClass
{
    public string SampleProperty { get; set; }
}

class A
{
    public SampleSubClass SubClass { get; set; }
    public string StringValue { get; set; }
}

class B
{
    public string Value { get; set; }
}

Would it be possible to recursively build a list of all sub-types on all classes that are passed as type arguments?

Additionally, this doesn't work if not every possible value on Json is used. For example, let's look at the example above, but with:

var json4 = "{\"StringValue\": \"1\",\"SubClass\": {\"SampleProperty\": \"Abc\"}, \"UnusedSubClass\": {\"UnusedProperty\": 123} }";

Well if I don't have a need for that in my use-case, FindBestObjectMatch will still try to find a match for it and throw an exception instead of simply ignoring it and picking the best match on the parent.