implement new resource definition featurees

Author: jaredcnance

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -21,15 +21,17 @@ public class DefaultEntityRepository<TEntity>
     {
         public DefaultEntityRepository(
             IJsonApiContext jsonApiContext,
-            IDbContextResolver contextResolver)
-        : base(jsonApiContext, contextResolver)
+            IDbContextResolver contextResolver,
+            ResourceDefinition<TEntity> resourceDefinition = null)
+        : base(jsonApiContext, contextResolver, resourceDefinition)
         { }
 
         public DefaultEntityRepository(
             ILoggerFactory loggerFactory,
             IJsonApiContext jsonApiContext,
-            IDbContextResolver contextResolver)
-        : base(loggerFactory, jsonApiContext, contextResolver)
+            IDbContextResolver contextResolver,
+            ResourceDefinition<TEntity> resourceDefinition = null)
+        : base(loggerFactory, jsonApiContext, contextResolver, resourceDefinition)
         { }
     }
 
@@ -47,27 +49,32 @@ public class DefaultEntityRepository<TEntity, TId>
         private readonly ILogger _logger;
         private readonly IJsonApiContext _jsonApiContext;
         private readonly IGenericProcessorFactory _genericProcessorFactory;
+        private readonly ResourceDefinition<TEntity> _resourceDefinition;
 
         public DefaultEntityRepository(
             IJsonApiContext jsonApiContext,
-            IDbContextResolver contextResolver)
+            IDbContextResolver contextResolver,
+            ResourceDefinition<TEntity> resourceDefinition = null)
         {
             _context = contextResolver.GetContext();
             _dbSet = contextResolver.GetDbSet<TEntity>();
             _jsonApiContext = jsonApiContext;
             _genericProcessorFactory = _jsonApiContext.GenericProcessorFactory;
+            _resourceDefinition = resourceDefinition;
         }
 
         public DefaultEntityRepository(
             ILoggerFactory loggerFactory,
             IJsonApiContext jsonApiContext,
-            IDbContextResolver contextResolver)
+            IDbContextResolver contextResolver,
+            ResourceDefinition<TEntity> resourceDefinition = null)
         {
             _context = contextResolver.GetContext();
             _dbSet = contextResolver.GetDbSet<TEntity>();
             _jsonApiContext = jsonApiContext;
             _logger = loggerFactory.CreateLogger<DefaultEntityRepository<TEntity, TId>>();
             _genericProcessorFactory = _jsonApiContext.GenericProcessorFactory;
+            _resourceDefinition = resourceDefinition;
         }
 
         /// <inheritdoc />
@@ -82,13 +89,38 @@ public virtual IQueryable<TEntity> Get()
         /// <inheritdoc />
         public virtual IQueryable<TEntity> Filter(IQueryable<TEntity> entities, FilterQuery filterQuery)
         {
+            if(_resourceDefinition != null) 
+            {
+                var defaultQueryFilters = _resourceDefinition.GetQueryFilters();
+                if(defaultQueryFilters != null && defaultQueryFilters.TryGetValue(filterQuery.Attribute, out var defaultQueryFilter) == true)
+                {
+                    return defaultQueryFilter(entities, filterQuery.Value);
+                }
+            }
+
             return entities.Filter(_jsonApiContext, filterQuery);
         }
 
         /// <inheritdoc />
         public virtual IQueryable<TEntity> Sort(IQueryable<TEntity> entities, List<SortQuery> sortQueries)
         {
-            return entities.Sort(sortQueries);
+            if (sortQueries != null && sortQueries.Count > 0)
+                return entities.Sort(sortQueries);
+            
+            if(_resourceDefinition != null) 
+            {
+                var defaultSortOrder = _resourceDefinition.DefaultSort();
+                if(defaultSortOrder != null && defaultSortOrder.Count > 0)
+                {
+                    foreach(var sortProp in defaultSortOrder)
+                    { 
+                        // this is dumb...add an overload, don't allocate for no reason
+                        entities.Sort(new SortQuery(sortProp.Item2, sortProp.Item1));
+                    }
+                }
+            }
+
+            return entities;
         }
 
         /// <inheritdoc />

src/JsonApiDotNetCore/Models/ResourceDefinition.cs

@@ -49,12 +49,10 @@ private bool InstanceOutputAttrsAreSpecified()
                 .FirstOrDefault();
             var declaringType = instanceMethod?.DeclaringType;
             return declaringType == derivedType;
-        }
-        
-        public delegate dynamic FilterExpression(T type);        
+        }   
 
         // TODO: need to investigate options for caching these
-        protected List<AttrAttribute> Remove(Expression<FilterExpression> filter, List<AttrAttribute> from = null)
+        protected List<AttrAttribute> Remove(Expression<Func<T, dynamic>> filter, List<AttrAttribute> from = null)
         {
             from = from ?? _contextEntity.Attributes;
 
@@ -155,7 +153,7 @@ private List<AttrAttribute> GetOutputAttrs()
         /// }
         /// </code>
         /// </example>
-        protected virtual QueryFilters GetQueryFilters() => null;
+        public virtual QueryFilters GetQueryFilters() => null;
 
         /// <summary>
         /// This is an alias type intended to simplify the implementation's
@@ -181,6 +179,28 @@ public class QueryFilters : Dictionary<string, Func<IQueryable<T>, string, IQuer
         /// </example>
         protected virtual PropertySortOrder GetDefaultSortOrder() => null;
 
+        internal List<(AttrAttribute, SortDirection)> DefaultSort()
+        {
+            var defaultSortOrder = GetDefaultSortOrder();
+            if(defaultSortOrder != null && defaultSortOrder.Count > 0)
+            {
+                var order = new List<(AttrAttribute, SortDirection)>();
+                foreach(var sortProp in defaultSortOrder)
+                {
+                    // TODO: error handling, log or throw?
+                    if (sortProp.Item1.Body is MemberExpression memberExpression)
+                        order.Add(
+                            (_contextEntity.Attributes.SingleOrDefault(a => a.InternalAttributeName != memberExpression.Member.Name), 
+                            sortProp.Item2)
+                        );
+                }
+
+                return order;
+            }
+
+            return null;
+        }
+
         /// <summary>
         /// This is an alias type intended to simplify the implementation's
         /// method signature.

src/JsonApiDotNetCore/Services/EntityResourceService.cs

@@ -223,8 +223,7 @@ protected virtual IQueryable<TEntity> ApplySortAndFilterQuery(IQueryable<TEntity
                 foreach (var filter in query.Filters)
                     entities = _entities.Filter(entities, filter);
 
-            if (query.SortParameters != null && query.SortParameters.Count > 0)
-                entities = _entities.Sort(entities, query.SortParameters);
+            entities = _entities.Sort(entities, query.SortParameters);
 
             return entities;
         }

test/UnitTests/Models/ResourceDefinitionTests.cs

@@ -120,7 +120,7 @@ protected override List<AttrAttribute> OutputAttrs()
                 ? Remove(m => m.AlwaysExcluded)
                 : Remove(m => new { m.AlwaysExcluded, m.Password }, from: base.OutputAttrs());
 
-        protected override QueryFilters GetQueryFilters()
+        public override QueryFilters GetQueryFilters()
             => new QueryFilters {
                 { "is-active", (query, value) => query.Select(x => x) }
             };