Added ResourceFieldAttribute.Type and use it from QueryExpression.ToFullString() to provide improved debug info

Author: Bart Koelman

src/JsonApiDotNetCore.Annotations/Resources/Annotations/RelationshipAttribute.cs

@@ -14,21 +14,8 @@ public abstract class RelationshipAttribute : ResourceFieldAttribute
 {
     private protected static readonly CollectionConverter CollectionConverter = new();
 
-    /// <summary>
-    /// The CLR type in which this relationship is declared.
-    /// </summary>
-    internal Type? LeftClrType { get; set; }
-
-    /// <summary>
-    /// The CLR type this relationship points to. In the case of a <see cref="HasManyAttribute" /> relationship, this value will be the collection element
-    /// type.
-    /// </summary>
-    /// <example>
-    /// <code><![CDATA[
-    /// public ISet<Tag> Tags { get; set; } // RightClrType: typeof(Tag)
-    /// ]]></code>
-    /// </example>
-    internal Type? RightClrType { get; set; }
+    // These are definitely assigned after building the resource graph, which is why their public equivalents are declared as non-nullable.
+    private ResourceType? _rightType;
 
     /// <summary>
     /// The <see cref="PropertyInfo" /> of the Entity Framework Core inverse navigation, which may or may not exist. Even if it exists, it may not be exposed
@@ -52,15 +39,28 @@ public abstract class RelationshipAttribute : ResourceFieldAttribute
     public PropertyInfo? InverseNavigationProperty { get; set; }
 
     /// <summary>
-    /// The containing resource type in which this relationship is declared.
+    /// The containing resource type in which this relationship is declared. Identical to <see cref="ResourceFieldAttribute.Type" />.
     /// </summary>
-    public ResourceType LeftType { get; internal set; } = null!;
+    public ResourceType LeftType => Type;
 
     /// <summary>
     /// The resource type this relationship points to. In the case of a <see cref="HasManyAttribute" /> relationship, this value will be the collection
     /// element type.
     /// </summary>
-    public ResourceType RightType { get; internal set; } = null!;
+    /// <example>
+    /// <code><![CDATA[
+    /// public ISet<Tag> Tags { get; set; } // RightType: Tag
+    /// ]]></code>
+    /// </example>
+    public ResourceType RightType
+    {
+        get => _rightType!;
+        internal set
+        {
+            ArgumentGuard.NotNull(value, nameof(value));
+            _rightType = value;
+        }
+    }
 
     /// <summary>
     /// Configures which links to write in the relationship-level links object for this relationship. Defaults to <see cref="LinkTypes.NotConfigured" />,
@@ -91,12 +91,11 @@ public override bool Equals(object? obj)
 
         var other = (RelationshipAttribute)obj;
 
-        return LeftClrType == other.LeftClrType && RightClrType == other.RightClrType && Links == other.Links && CanInclude == other.CanInclude &&
-            base.Equals(other);
+        return _rightType?.ClrType == other._rightType?.ClrType && Links == other.Links && CanInclude == other.CanInclude && base.Equals(other);
     }
 
     public override int GetHashCode()
     {
-        return HashCode.Combine(LeftClrType, RightClrType, Links, CanInclude, base.GetHashCode());
+        return HashCode.Combine(_rightType?.ClrType, Links, CanInclude, base.GetHashCode());
     }
 }

src/JsonApiDotNetCore.Annotations/Resources/Annotations/ResourceFieldAttribute.cs

@@ -1,5 +1,6 @@
 using System.Reflection;
 using JetBrains.Annotations;
+using JsonApiDotNetCore.Configuration;
 
 // ReSharper disable NonReadonlyMemberInGetHashCode
 
@@ -15,6 +16,7 @@ public abstract class ResourceFieldAttribute : Attribute
     // These are definitely assigned after building the resource graph, which is why their public equivalents are declared as non-nullable.
     private string? _publicName;
     private PropertyInfo? _property;
+    private ResourceType? _type;
 
     /// <summary>
     /// The publicly exposed name of this JSON:API field. When not explicitly assigned, the configured naming convention is applied on the property name.
@@ -46,6 +48,19 @@ internal set
         }
     }
 
+    /// <summary>
+    /// The containing resource type in which this field is declared.
+    /// </summary>
+    public ResourceType Type
+    {
+        get => _type!;
+        internal set
+        {
+            ArgumentGuard.NotNull(value, nameof(value));
+            _type = value;
+        }
+    }
+
     /// <summary>
     /// Gets the value of this field on the specified resource instance. Throws if the property is write-only or if the field does not belong to the
     /// specified resource instance.

src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs

@@ -43,23 +43,35 @@ public IResourceGraph Build()
 
         var resourceGraph = new ResourceGraph(resourceTypes);
 
+        SetFieldTypes(resourceGraph);
         SetRelationshipTypes(resourceGraph);
         SetDirectlyDerivedTypes(resourceGraph);
 
         return resourceGraph;
     }
 
+    private static void SetFieldTypes(ResourceGraph resourceGraph)
+    {
+        foreach (ResourceFieldAttribute field in resourceGraph.GetResourceTypes().SelectMany(resourceType => resourceType.Fields))
+        {
+            field.Type = resourceGraph.GetResourceType(field.Property.ReflectedType!);
+        }
+    }
+
     private static void SetRelationshipTypes(ResourceGraph resourceGraph)
     {
         foreach (RelationshipAttribute relationship in resourceGraph.GetResourceTypes().SelectMany(resourceType => resourceType.Relationships))
         {
-            relationship.LeftType = resourceGraph.GetResourceType(relationship.LeftClrType!);
-            ResourceType? rightType = resourceGraph.FindResourceType(relationship.RightClrType!);
+            Type rightClrType = relationship is HasOneAttribute
+                ? relationship.Property.PropertyType
+                : relationship.Property.PropertyType.GetGenericArguments()[0];
+
+            ResourceType? rightType = resourceGraph.FindResourceType(rightClrType);
 
             if (rightType == null)
             {
-                throw new InvalidConfigurationException($"Resource type '{relationship.LeftClrType}' depends on " +
-                    $"'{relationship.RightClrType}', which was not added to the resource graph.");
+                throw new InvalidConfigurationException($"Resource type '{relationship.LeftType.ClrType}' depends on " +
+                    $"'{rightClrType}', which was not added to the resource graph.");
             }
 
             relationship.RightType = rightType;
@@ -254,8 +266,6 @@ private IReadOnlyCollection<RelationshipAttribute> GetRelationships(Type resourc
             {
                 relationship.Property = property;
                 SetPublicName(relationship, property);
-                relationship.LeftClrType = resourceClrType;
-                relationship.RightClrType = GetRelationshipType(relationship, property);
 
                 IncludeField(relationshipsByName, relationship);
             }
@@ -270,14 +280,6 @@ private void SetPublicName(ResourceFieldAttribute field, PropertyInfo property)
         field.PublicName ??= FormatPropertyName(property);
     }
 
-    private Type GetRelationshipType(RelationshipAttribute relationship, PropertyInfo property)
-    {
-        ArgumentGuard.NotNull(relationship, nameof(relationship));
-        ArgumentGuard.NotNull(property, nameof(property));
-
-        return relationship is HasOneAttribute ? property.PropertyType : property.PropertyType.GetGenericArguments()[0];
-    }
-
     private IReadOnlyCollection<EagerLoadAttribute> GetEagerLoads(Type resourceClrType, int recursionDepth = 0)
     {
         AssertNoInfiniteRecursion(recursionDepth);

src/JsonApiDotNetCore/Queries/Expressions/AnyExpression.cs

@@ -34,14 +34,24 @@ public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgum
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public override string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
 
         builder.Append(Keywords.Any);
         builder.Append('(');
-        builder.Append(TargetAttribute);
+        builder.Append(toFullString ? TargetAttribute.ToFullString() : TargetAttribute);
         builder.Append(',');
-        builder.Append(string.Join(",", Constants.Select(constant => constant.ToString()).OrderBy(value => value)));
+        builder.Append(string.Join(",", Constants.Select(constant => toFullString ? constant.ToFullString() : constant.ToString()).OrderBy(value => value)));
         builder.Append(')');
 
         return builder.ToString();

src/JsonApiDotNetCore/Queries/Expressions/ComparisonExpression.cs

@@ -33,6 +33,11 @@ public override string ToString()
         return $"{Operator.ToString().Camelize()}({Left},{Right})";
     }
 
+    public override string ToFullString()
+    {
+        return $"{Operator.ToString().Camelize()}({Left.ToFullString()},{Right.ToFullString()})";
+    }
+
     public override bool Equals(object? obj)
     {
         if (ReferenceEquals(this, obj))

src/JsonApiDotNetCore/Queries/Expressions/CountExpression.cs

@@ -28,6 +28,11 @@ public override string ToString()
         return $"{Keywords.Count}({TargetCollection})";
     }
 
+    public override string ToFullString()
+    {
+        return $"{Keywords.Count}({TargetCollection.ToFullString()})";
+    }
+
     public override bool Equals(object? obj)
     {
         if (ReferenceEquals(this, obj))

src/JsonApiDotNetCore/Queries/Expressions/HasExpression.cs

@@ -27,16 +27,26 @@ public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgum
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public override string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
         builder.Append(Keywords.Has);
         builder.Append('(');
-        builder.Append(TargetCollection);
+        builder.Append(toFullString ? TargetCollection.ToFullString() : TargetCollection);
 
         if (Filter != null)
         {
             builder.Append(',');
-            builder.Append(Filter);
+            builder.Append(toFullString ? Filter.ToFullString() : Filter);
         }
 
         builder.Append(')');

src/JsonApiDotNetCore/Queries/Expressions/IncludeElementExpression.cs

@@ -34,14 +34,24 @@ public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgum
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public override string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
-        builder.Append(Relationship);
+        builder.Append(toFullString ? $"{Relationship.LeftType.PublicName}:{Relationship.PublicName}" : Relationship.PublicName);
 
         if (Children.Any())
         {
             builder.Append('{');
-            builder.Append(string.Join(",", Children.Select(child => child.ToString()).OrderBy(name => name)));
+            builder.Append(string.Join(",", Children.Select(child => toFullString ? child.ToFullString() : child.ToString()).OrderBy(name => name)));
             builder.Append('}');
         }
 

src/JsonApiDotNetCore/Queries/Expressions/IncludeExpression.cs

@@ -33,9 +33,19 @@ public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgum
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public override string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         IReadOnlyCollection<ResourceFieldChainExpression> chains = IncludeChainConverter.GetRelationshipChains(this);
-        return string.Join(",", chains.Select(child => child.ToString()).OrderBy(name => name));
+        return string.Join(",", chains.Select(field => toFullString ? field.ToFullString() : field.ToString()).OrderBy(name => name));
     }
 
     public override bool Equals(object? obj)

src/JsonApiDotNetCore/Queries/Expressions/IsTypeExpression.cs

@@ -31,14 +31,24 @@ public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgum
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public override string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
         builder.Append(Keywords.IsType);
         builder.Append('(');
 
         if (TargetToOneRelationship != null)
         {
-            builder.Append(TargetToOneRelationship);
+            builder.Append(toFullString ? TargetToOneRelationship.ToFullString() : TargetToOneRelationship);
         }
 
         builder.Append(',');
@@ -47,7 +57,7 @@ public override string ToString()
         if (Child != null)
         {
             builder.Append(',');
-            builder.Append(Child);
+            builder.Append(toFullString ? Child.ToFullString() : Child);
         }
 
         builder.Append(')');

src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs

@@ -28,6 +28,11 @@ public override string ToString()
         return $"'{value}'";
     }
 
+    public override string ToFullString()
+    {
+        return ToString();
+    }
+
     public override bool Equals(object? obj)
     {
         if (ReferenceEquals(this, obj))

src/JsonApiDotNetCore/Queries/Expressions/LogicalExpression.cs

@@ -47,12 +47,22 @@ public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgum
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public override string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
 
         builder.Append(Operator.ToString().Camelize());
         builder.Append('(');
-        builder.Append(string.Join(",", Terms.Select(term => term.ToString())));
+        builder.Append(string.Join(",", Terms.Select(term => toFullString ? term.ToFullString() : term.ToString())));
         builder.Append(')');
 
         return builder.ToString();

src/JsonApiDotNetCore/Queries/Expressions/MatchTextExpression.cs

@@ -30,12 +30,26 @@ public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgum
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public override string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
 
         builder.Append(MatchKind.ToString().Camelize());
         builder.Append('(');
-        builder.Append(string.Join(",", TargetAttribute, TextValue));
+
+        builder.Append(toFullString
+            ? string.Join(",", TargetAttribute.ToFullString(), TextValue.ToFullString())
+            : string.Join(",", TargetAttribute, TextValue));
+
         builder.Append(')');
 
         return builder.ToString();