Fix trace logging for resource inheritance

bkoelman · bkoelman · commit 43ed74171a18 · 2023-11-17T14:39:32.000+01:00
diff --git a/src/Examples/DapperExample/Repositories/ResourceChangeDetector.cs b/src/Examples/DapperExample/Repositories/ResourceChangeDetector.cs
@@ -209,7 +209,7 @@ public void AssertIsNotClearingAnyRequiredToOneRelationships(string resourceName
     private static void AssertSameType(ResourceType resourceType, IIdentifiable resource)
     {
         Type declaredType = resourceType.ClrType;
-        Type instanceType = resource.GetType();
+        Type instanceType = resource.GetClrType();
 
         if (instanceType != declaredType)
         {
diff --git a/src/Examples/DapperExample/TranslationToSql/DataModel/BaseDataModelService.cs b/src/Examples/DapperExample/TranslationToSql/DataModel/BaseDataModelService.cs
@@ -139,7 +139,7 @@ private static bool IsMapped(PropertyInfo property)
                 return null;
             }
 
-            PropertyInfo rightKeyProperty = rightResource.GetType().GetProperty(TableSourceNode.IdColumnName)!;
+            PropertyInfo rightKeyProperty = rightResource.GetClrType().GetProperty(TableSourceNode.IdColumnName)!;
             return rightKeyProperty.GetValue(rightResource);
         }
 
@@ -150,7 +150,7 @@ private static bool IsMapped(PropertyInfo property)
     private static void AssertSameType(ResourceType resourceType, IIdentifiable resource)
     {
         Type declaredType = resourceType.ClrType;
-        Type instanceType = resource.GetType();
+        Type instanceType = resource.GetClrType();
 
         if (instanceType != declaredType)
         {
diff --git a/src/JsonApiDotNetCore/Middleware/TraceLogWriter.cs b/src/JsonApiDotNetCore/Middleware/TraceLogWriter.cs
@@ -1,4 +1,3 @@
-using System.Globalization;
 using System.Reflection;
 using System.Runtime.CompilerServices;
 using System.Text;
@@ -25,6 +24,7 @@ internal abstract class TraceLogWriter
             new JsonStringEnumConverter(),
             new ResourceTypeInTraceJsonConverter(),
             new ResourceFieldInTraceJsonConverterFactory(),
+            new AbstractResourceWrapperInTraceJsonConverterFactory(),
             new IdentifiableInTraceJsonConverter()
         }
     };
@@ -51,11 +51,8 @@ public override bool CanConvert(Type typeToConvert)
 
         public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
         {
-            Type objectType = typeof(ResourceFieldInTraceJsonConverter<>);
-            Type converterType = objectType.MakeGenericType(typeToConvert);
-
-            return (JsonConverter)Activator.CreateInstance(converterType, BindingFlags.Instance | BindingFlags.Public, null, null,
-                CultureInfo.InvariantCulture)!;
+            Type converterType = typeof(ResourceFieldInTraceJsonConverter<>).MakeGenericType(typeToConvert);
+            return (JsonConverter)Activator.CreateInstance(converterType)!;
         }
 
         private sealed class ResourceFieldInTraceJsonConverter<TField> : JsonConverter<TField>
@@ -82,10 +79,43 @@ public override IIdentifiable Read(ref Utf8JsonReader reader, Type typeToConvert
 
         public override void Write(Utf8JsonWriter writer, IIdentifiable value, JsonSerializerOptions options)
         {
+            // Intentionally *not* calling GetClrType() because we need delegation to the wrapper converter.
             Type runtimeType = value.GetType();
+
             JsonSerializer.Serialize(writer, value, runtimeType, options);
         }
     }
+
+    private sealed class AbstractResourceWrapperInTraceJsonConverterFactory : JsonConverterFactory
+    {
+        public override bool CanConvert(Type typeToConvert)
+        {
+            return typeToConvert.IsAssignableTo(typeof(IAbstractResourceWrapper));
+        }
+
+        public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
+        {
+            Type converterType = typeof(AbstractResourceWrapperInTraceJsonConverter<>).MakeGenericType(typeToConvert);
+            return (JsonConverter)Activator.CreateInstance(converterType)!;
+        }
+
+        private sealed class AbstractResourceWrapperInTraceJsonConverter<TWrapper> : JsonConverter<TWrapper>
+            where TWrapper : IAbstractResourceWrapper
+        {
+            public override TWrapper Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+            {
+                throw new NotSupportedException();
+            }
+
+            public override void Write(Utf8JsonWriter writer, TWrapper value, JsonSerializerOptions options)
+            {
+                writer.WriteStartObject();
+                writer.WriteString("ClrType", value.AbstractType.FullName);
+                writer.WriteString("StringId", value.StringId);
+                writer.WriteEndObject();
+            }
+        }
+    }
 }
 
 internal sealed class TraceLogWriter<T> : TraceLogWriter
diff --git a/src/JsonApiDotNetCore/Serialization/JsonConverters/SingleOrManyDataConverterFactory.cs b/src/JsonApiDotNetCore/Serialization/JsonConverters/SingleOrManyDataConverterFactory.cs
@@ -1,5 +1,3 @@
-using System.Globalization;
-using System.Reflection;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using JetBrains.Annotations;
@@ -25,7 +23,7 @@ public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializer
         Type objectType = typeToConvert.GetGenericArguments()[0];
         Type converterType = typeof(SingleOrManyDataConverter<>).MakeGenericType(objectType);
 
-        return (JsonConverter)Activator.CreateInstance(converterType, BindingFlags.Instance | BindingFlags.Public, null, null, CultureInfo.InvariantCulture)!;
+        return (JsonConverter)Activator.CreateInstance(converterType)!;
     }
 
     private sealed class SingleOrManyDataConverter<T> : JsonObjectConverter<SingleOrManyData<T>>
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/Banana.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/Banana.cs
@@ -0,0 +1,14 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCoreTests.IntegrationTests.Logging;
+
+[UsedImplicitly(ImplicitUseTargetFlags.Members)]
+[Resource(ControllerNamespace = "JsonApiDotNetCoreTests.IntegrationTests.Logging")]
+public sealed class Banana : Fruit
+{
+    public override string Color => "Yellow";
+
+    [Attr]
+    public double LengthInCentimeters { get; set; }
+}
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/Fruit.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/Fruit.cs
@@ -0,0 +1,13 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCoreTests.IntegrationTests.Logging;
+
+[UsedImplicitly(ImplicitUseTargetFlags.Members)]
+[Resource(ControllerNamespace = "JsonApiDotNetCoreTests.IntegrationTests.Logging")]
+public abstract class Fruit : Identifiable<long>
+{
+    [Attr]
+    public abstract string Color { get; }
+}
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/FruitBowl.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/FruitBowl.cs
@@ -0,0 +1,13 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCoreTests.IntegrationTests.Logging;
+
+[UsedImplicitly(ImplicitUseTargetFlags.Members)]
+[Resource(ControllerNamespace = "JsonApiDotNetCoreTests.IntegrationTests.Logging")]
+public sealed class FruitBowl : Identifiable<long>
+{
+    [HasMany]
+    public ISet<Fruit> Fruits { get; set; } = new HashSet<Fruit>();
+}
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/LoggingDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/LoggingDbContext.cs
@@ -8,6 +8,10 @@ namespace JsonApiDotNetCoreTests.IntegrationTests.Logging;
 public sealed class LoggingDbContext : TestableDbContext
 {
     public DbSet<AuditEntry> AuditEntries => Set<AuditEntry>();
+    public DbSet<FruitBowl> FruitBowls => Set<FruitBowl>();
+    public DbSet<Fruit> Fruits => Set<Fruit>();
+    public DbSet<Banana> Bananas => Set<Banana>();
+    public DbSet<Peach> Peaches => Set<Peach>();
 
     public LoggingDbContext(DbContextOptions<LoggingDbContext> options)
         : base(options)
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/LoggingFakers.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/LoggingFakers.cs
@@ -13,5 +13,15 @@ internal sealed class LoggingFakers : FakerContainer
         .RuleFor(auditEntry => auditEntry.UserName, faker => faker.Internet.UserName())
         .RuleFor(auditEntry => auditEntry.CreatedAt, faker => faker.Date.PastOffset().TruncateToWholeMilliseconds()));
 
+    private readonly Lazy<Faker<Banana>> _lazyBananaFaker = new(() => new Faker<Banana>()
+        .UseSeed(GetFakerSeed())
+        .RuleFor(banana => banana.LengthInCentimeters, faker => faker.Random.Double(10, 25)));
+
+    private readonly Lazy<Faker<Peach>> _lazyPeachFaker = new(() => new Faker<Peach>()
+        .UseSeed(GetFakerSeed())
+        .RuleFor(peach => peach.DiameterInCentimeters, faker => faker.Random.Double(6, 7.5)));
+
     public Faker<AuditEntry> AuditEntry => _lazyAuditEntryFaker.Value;
+    public Faker<Banana> Banana => _lazyBananaFaker.Value;
+    public Faker<Peach> Peach => _lazyPeachFaker.Value;
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/LoggingTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/LoggingTests.cs
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/Peach.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Logging/Peach.cs

Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,7 @@ public void AssertIsNotClearingAnyRequiredToOneRelationships(string resourceName`
`209`	`209`	`private static void AssertSameType(ResourceType resourceType, IIdentifiable resource)`
`210`	`210`	`{`
`211`	`211`	`Type declaredType = resourceType.ClrType;`
`212`		`- Type instanceType = resource.GetType();`
	`212`	`+ Type instanceType = resource.GetClrType();`
`213`	`213`
`214`	`214`	`if (instanceType != declaredType)`
`215`	`215`	`{`
Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ private static bool IsMapped(PropertyInfo property)`
`139`	`139`	`return null;`
`140`	`140`	`}`
`141`	`141`
`142`		`- PropertyInfo rightKeyProperty = rightResource.GetType().GetProperty(TableSourceNode.IdColumnName)!;`
	`142`	`+ PropertyInfo rightKeyProperty = rightResource.GetClrType().GetProperty(TableSourceNode.IdColumnName)!;`
`143`	`143`	`return rightKeyProperty.GetValue(rightResource);`
`144`	`144`	`}`
`145`	`145`
`@@ -150,7 +150,7 @@ private static bool IsMapped(PropertyInfo property)`
`150`	`150`	`private static void AssertSameType(ResourceType resourceType, IIdentifiable resource)`
`151`	`151`	`{`
`152`	`152`	`Type declaredType = resourceType.ClrType;`
`153`		`- Type instanceType = resource.GetType();`
	`153`	`+ Type instanceType = resource.GetClrType();`
`154`	`154`
`155`	`155`	`if (instanceType != declaredType)`
`156`	`156`	`{`