feat(FilterQuery / QueryAccessor): use public attribute names for keys

Closes #197

Author: jaredcnance

src/JsonApiDotNetCore/Internal/Query/AttrFilterQuery.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Linq;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
@@ -9,14 +10,14 @@ public class AttrFilterQuery : BaseFilterQuery
         private readonly IJsonApiContext _jsonApiContext;
 
         public AttrFilterQuery(
-            IJsonApiContext jsonApiCopntext,
+            IJsonApiContext jsonApiContext,
             FilterQuery filterQuery)
         {
-            _jsonApiContext = jsonApiCopntext;
+            _jsonApiContext = jsonApiContext;
 
-            var attribute = GetAttribute(filterQuery.Key);
+            var attribute = GetAttribute(filterQuery.Attribute);
 
-            FilteredAttribute = attribute ?? throw new JsonApiException(400, $"{filterQuery.Key} is not a valid property.");
+            FilteredAttribute = attribute ?? throw new JsonApiException(400, $"'{filterQuery.Attribute}' is not a valid attribute.");
             PropertyValue = filterQuery.Value;
             FilterOperation = GetFilterOperation(filterQuery.Operation);
         }
@@ -25,12 +26,9 @@ public AttrFilterQuery(
         public string PropertyValue { get; set; }
         public FilterOperations FilterOperation { get; set; }
 
-        private AttrAttribute GetAttribute(string propertyName)
-        {
-            return _jsonApiContext.RequestEntity.Attributes
-                .FirstOrDefault(attr =>
-                    attr.InternalAttributeName.ToLower() == propertyName.ToLower()
+        private AttrAttribute GetAttribute(string attribute) =>  
+            _jsonApiContext.RequestEntity.Attributes.FirstOrDefault(
+                attr => string.Equals(attr.PublicAttributeName, attribute, StringComparison.OrdinalIgnoreCase)
             );
-        }
     }
-}
+}

src/JsonApiDotNetCore/Internal/Query/FilterQuery.cs

@@ -1,17 +1,23 @@
+using System;
+using JsonApiDotNetCore.Extensions;
+
 namespace JsonApiDotNetCore.Internal.Query
 {
     public class FilterQuery
     {
-        public FilterQuery(string key, string value, string operation)
+        public FilterQuery(string attribute, string value, string operation)
         {
-            Key = key;
+            Attribute = attribute;
+            Key = attribute.ToProperCase();
             Value = value;
             Operation = operation;
         }
 
+        [Obsolete("Key has been replaced by '" + nameof(Attribute) + "'. Members should be located by their public name, not by coercing the provided value to the internal name.")]
         public string Key { get; set; }
+        public string Attribute { get; }
         public string Value { get; set; }
         public string Operation { get; set; }
-        public bool IsAttributeOfRelationship => Key.Contains(".");
+        public bool IsAttributeOfRelationship => Attribute.Contains(".");
     }
-}
+}

src/JsonApiDotNetCore/Services/QueryAccessor.cs

@@ -61,9 +61,22 @@ public bool TryGetValue<T>(string key, out T value)
             }
         }
 
-        private string GetFilterValue(string key) => _jsonApiContext.QuerySet
-            .Filters
-            .FirstOrDefault(f => string.Equals(f.Key, key, StringComparison.OrdinalIgnoreCase))
-            ?.Value;
+        private string GetFilterValue(string key) {
+            var publicValue = _jsonApiContext.QuerySet.Filters
+                .FirstOrDefault(f => string.Equals(f.Attribute, key, StringComparison.OrdinalIgnoreCase))?.Value;
+            
+            if(publicValue != null) 
+                return publicValue;
+            
+            var internalValue = _jsonApiContext.QuerySet.Filters
+                .FirstOrDefault(f => string.Equals(f.Key, key, StringComparison.OrdinalIgnoreCase))?.Value;
+            
+            if(internalValue != null) {
+                _logger.LogWarning("Locating filters by the internal propterty name is deprecated. You should use the public attribute name instead.");
+                return publicValue;
+            }
+
+            return null;
+        }
     }
-}
+}

src/JsonApiDotNetCore/Services/QueryParser.cs

@@ -18,6 +18,8 @@ public class QueryParser : IQueryParser {
         private readonly IControllerContext _controllerContext;
         private readonly JsonApiOptions _options;
 
+        private const char OPEN_BRACKET = '[';
+        private const char CLOSE_BRACKET = ']';
         public QueryParser(
             IControllerContext controllerContext,
             JsonApiOptions options) {
@@ -72,7 +74,7 @@ protected virtual List<FilterQuery> ParseFilterQuery(string key, string value) {
             // expected input = filter[id]=eq:1
             var queries = new List<FilterQuery>();
 
-            var propertyName = key.Split('[', ']') [1].ToProperCase();
+            var propertyName = key.Split(OPEN_BRACKET, CLOSE_BRACKET) [1];
 
             var values = value.Split(',');
             foreach (var val in values) {