Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for deep oneOf inheritance #36

Merged
merged 5 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion Bonsai.Sgen.Tests/DiscriminatorGenerationTests.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using Microsoft.VisualStudio.TestTools.UnitTesting;
using NJsonSchema;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

Expand Down Expand Up @@ -214,10 +215,49 @@ public void GenerateFromArrayItemDiscriminatorRef_EnsureFallbackDiscriminatorBas
var code = generator.GenerateFile();
Assert.IsTrue(code.Contains("class Dog : Animal"), "Derived types do not inherit from base type.");
Assert.IsTrue(!code.Contains("public enum DogKind"), "Discriminator property is repeated in derived types.");
Assert.IsTrue(code.Contains("List<Animal> Animal"), "Container element type does not match base type.");
Assert.IsTrue(code.Contains("List<Animal> Animals"), "Container element type does not match base type.");
Assert.IsTrue(code.Contains("[JsonInheritanceAttribute(\"Dog\", typeof(Dog))]"));
AssertDiscriminatorAttribute(code, serializerLibraries, "kind");
CompilerTestHelper.CompileFromSource(code);
}

[TestMethod]
[DataRow(SerializerLibraries.YamlDotNet)]
[DataRow(SerializerLibraries.NewtonsoftJson)]
[DataRow(SerializerLibraries.NewtonsoftJson | SerializerLibraries.YamlDotNet)]
public void GenerateFromSubDiscriminatorSchemas_InheritanceHierarchyIsPreserved(SerializerLibraries serializerLibraries)
{
var subTypeSchemas = SchemaTestHelper.CreateDerivedSchemas("fur", "long", "short");
var subDiscriminator = SchemaTestHelper.CreateDiscriminatorSchema("fur", subTypeSchemas);
var derivedSchemas = SchemaTestHelper.CreateDerivedSchemas("type", "cat", "dog");
derivedSchemas[0].Value.DiscriminatorObject = subDiscriminator.DiscriminatorObject;
foreach (var subSchema in subDiscriminator.OneOf)
{
derivedSchemas[0].Value.OneOf.Add(subSchema);
}
var discriminator = SchemaTestHelper.CreateDiscriminatorSchema("type", derivedSchemas);
var schema = SchemaTestHelper.CreateContainerSchema(new Dictionary<string, JsonSchema>
{
{ "LongFurCat", subTypeSchemas[0].Value },
{ "Cat", derivedSchemas[0].Value },
{ "Dog", derivedSchemas[1].Value },
{ "Animal", discriminator },
{ "ShortFurCat", subTypeSchemas[1].Value }
});
schema.Properties.Add("Animals", new()
{
Type = JsonObjectType.Array,
Item = new() { Reference = discriminator }
});

var generator = TestHelper.CreateGenerator(schema, serializerLibraries);
var code = generator.GenerateFile();
Assert.IsTrue(code.Contains("class Cat : Animal"), "Derived types do not inherit from base type.");
Assert.IsTrue(!code.Contains("public enum LongFurCatFur"), "Discriminator property is repeated in derived types.");
Assert.IsTrue(code.Contains("List<Animal> Animals"), "Container element type does not match base type.");
Assert.IsTrue(code.Contains("[JsonInheritanceAttribute(\"dog\", typeof(Dog))]"));
AssertDiscriminatorAttribute(code, serializerLibraries, "type");
CompilerTestHelper.CompileFromSource(code);
}
}
}
2 changes: 1 addition & 1 deletion Bonsai.Sgen.Tests/TestHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ public static CSharpCodeDomGenerator CreateGenerator(
JsonSchema schema,
SerializerLibraries serializerLibraries = SerializerLibraries.YamlDotNet | SerializerLibraries.NewtonsoftJson)
{
schema = schema.WithUniqueDiscriminatorProperties();
schema = schema.WithResolvedDiscriminatorInheritance();
var settings = new CSharpCodeDomGeneratorSettings
{
Namespace = nameof(TestHelper),
Expand Down
7 changes: 4 additions & 3 deletions Bonsai.Sgen/CSharpClassTemplate.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using System.Text;
using System.Xml.Serialization;
using Newtonsoft.Json;
using NJsonSchema;
using NJsonSchema.Converters;
using YamlDotNet.Serialization;

Expand All @@ -30,7 +31,7 @@ public override void BuildType(CodeTypeDeclaration type)
var jsonSerializer = Settings.SerializerLibraries.HasFlag(SerializerLibraries.NewtonsoftJson);
var yamlSerializer = Settings.SerializerLibraries.HasFlag(SerializerLibraries.YamlDotNet);
if (Model.IsAbstract) type.TypeAttributes |= System.Reflection.TypeAttributes.Abstract;
if (Model.HasDiscriminator)
if (Model.Schema.DiscriminatorObject is OpenApiDiscriminator discriminator)
{
if (jsonSerializer || yamlSerializer)
{
Expand All @@ -39,13 +40,13 @@ public override void BuildType(CodeTypeDeclaration type)
type.CustomAttributes.Add(new CodeAttributeDeclaration(
new CodeTypeReference(typeof(JsonConverter)),
new CodeAttributeArgument(new CodeTypeOfExpression(nameof(JsonInheritanceConverter))),
new CodeAttributeArgument(new CodePrimitiveExpression(Model.Discriminator))));
new CodeAttributeArgument(new CodePrimitiveExpression(discriminator.PropertyName))));
}
if (yamlSerializer)
{
type.CustomAttributes.Add(new CodeAttributeDeclaration(
new CodeTypeReference("YamlDiscriminator"),
new CodeAttributeArgument(new CodePrimitiveExpression(Model.Discriminator))));
new CodeAttributeArgument(new CodePrimitiveExpression(discriminator.PropertyName))));
}

foreach (var derivedModel in Model.DerivedClasses)
Expand Down
2 changes: 1 addition & 1 deletion Bonsai.Sgen/CSharpCodeDomGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public override IEnumerable<CodeArtifact> GenerateTypes()
let classType = type as CSharpClassCodeArtifact
where classType != null
select classType).ToList();
var discriminatorTypes = classTypes.Where(modelType => modelType.Model.HasDiscriminator).ToList();
var discriminatorTypes = classTypes.Where(modelType => modelType.Model.Schema.DiscriminatorObject != null).ToList();
foreach (var type in discriminatorTypes)
{
var matchTemplate = new CSharpTypeMatchTemplate(type, _provider, _options, Settings);
Expand Down
5 changes: 0 additions & 5 deletions Bonsai.Sgen/CSharpTypeResolver.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@ public CSharpTypeResolver(CSharpGeneratorSettings settings)
{
}

public CSharpTypeResolver(CSharpGeneratorSettings settings, JsonSchema exceptionSchema)
: base(settings, exceptionSchema)
{
}

public override JsonSchema RemoveNullability(JsonSchema schema)
{
JsonSchema? selectedSchema = null;
Expand Down
61 changes: 37 additions & 24 deletions Bonsai.Sgen/JsonSchemaExtensions.cs
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
using NJsonSchema;
using NJsonSchema.CodeGeneration;
using NJsonSchema.Visitors;

namespace Bonsai.Sgen
{
internal static class JsonSchemaExtensions
{
public static JsonSchema WithUniqueDiscriminatorProperties(this JsonSchema schema)
public static JsonSchema WithResolvedDiscriminatorInheritance(this JsonSchema schema)
{
var visitor = new DiscriminatorSchemaVisitor(schema);
visitor.Visit(schema);
var discriminatorVisitor = new DiscriminatorSchemaVisitor(schema);
var derivedDiscriminatorVisitor = new DerivedDiscriminatorSchemaVisitor();
discriminatorVisitor.Visit(schema);
derivedDiscriminatorVisitor.Visit(schema);
return schema;
}

class DiscriminatorSchemaVisitor : JsonSchemaVisitorBase
{
readonly Dictionary<JsonSchema, string> reverseTypeNameLookup = new();
readonly Dictionary<JsonSchema, string> definitionTypeNameLookup = new();

public DiscriminatorSchemaVisitor(JsonSchema rootObject)
{
Expand All @@ -34,7 +35,11 @@ private void ResolveOneOfInheritance(JsonSchema schema, JsonSchema baseSchema)
continue;
}

derivedSchema.ActualSchema.AllOf.Add(new JsonSchema { Reference = baseSchema });
var actualSchema = derivedSchema.ActualSchema;
if (!actualSchema.AllOf.Any(schema => schema.Reference == baseSchema))
{
actualSchema.AllOf.Add(new JsonSchema { Reference = baseSchema });
}
}
}

Expand All @@ -43,15 +48,16 @@ protected override JsonSchema VisitSchema(JsonSchema schema, string path, string
var actualSchema = schema.ActualSchema;
if (actualSchema.DiscriminatorObject != null)
{
if (schema is JsonSchemaProperty || schema.ParentSchema?.Item == schema)
var isDefinition = definitionTypeNameLookup.TryGetValue(actualSchema, out _);
if (schema is JsonSchemaProperty || schema.ParentSchema?.Item == schema || isDefinition)
{
if (string.IsNullOrEmpty(typeNameHint) &&
!reverseTypeNameLookup.TryGetValue(actualSchema, out typeNameHint))
var discriminatorSchema = isDefinition ? actualSchema : null;
if (string.IsNullOrEmpty(typeNameHint))
{
typeNameHint = "Anonymous";
}

if (!RootObject.Definitions.TryGetValue(typeNameHint, out JsonSchema? discriminatorSchema))
if (discriminatorSchema == null && !RootObject.Definitions.TryGetValue(typeNameHint, out discriminatorSchema))
{
discriminatorSchema = new JsonSchema();
discriminatorSchema.DiscriminatorObject = actualSchema.DiscriminatorObject;
Expand All @@ -64,23 +70,13 @@ protected override JsonSchema VisitSchema(JsonSchema schema, string path, string
if (discriminatorSchema.OneOf.Count > 0)
{
ResolveOneOfInheritance(discriminatorSchema, discriminatorSchema);
discriminatorSchema.OneOf.Clear();
}
}

schema.DiscriminatorObject = null;
schema.IsAbstract = false;
return schema;
}

foreach (var derivedSchema in schema.GetDerivedSchemas(RootObject).Keys)
{
foreach (var property in derivedSchema.Properties.Keys.ToList())
if (!isDefinition)
{
if (property == schema.Discriminator)
{
derivedSchema.Properties.Remove(property);
}
actualSchema.DiscriminatorObject = null;
actualSchema.IsAbstract = false;
}
}
}
Expand Down Expand Up @@ -111,7 +107,7 @@ private void VisitDefinitions(JsonSchema schema)
{
foreach (var definition in schema.Definitions)
{
reverseTypeNameLookup[definition.Value] = definition.Key;
definitionTypeNameLookup[definition.Value] = definition.Key;
VisitDefinitions(definition.Value);
}
}
Expand Down Expand Up @@ -139,5 +135,22 @@ private void VisitDefinitions(IDictionary<string, JsonSchemaProperty> dictionary
}
}
}

class DerivedDiscriminatorSchemaVisitor : JsonSchemaVisitorBase
{
protected override JsonSchema VisitSchema(JsonSchema schema, string path, string typeNameHint)
{
foreach (var baseSchema in schema.AllInheritedSchemas)
{
var discriminatorSchema = baseSchema.DiscriminatorObject;
if (discriminatorSchema != null)
{
schema.Properties.Remove(discriminatorSchema.PropertyName);
}
}

return schema;
}
}
}
}
2 changes: 1 addition & 1 deletion Bonsai.Sgen/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ static async Task Main(string[] args)
SerializerLibraries = serializerLibraries
};

schema = schema.WithUniqueDiscriminatorProperties();
schema = schema.WithResolvedDiscriminatorInheritance();
var generator = new CSharpCodeDomGenerator(schema, settings);
var code = generator.GenerateFile(generatorTypeName);
if (string.IsNullOrEmpty(outputFilePath))
Expand Down
Loading