Initial support for compound filters and deeply nested queries

Author: Bart Koelman

Directory.Build.props

@@ -15,6 +15,7 @@
   <!-- Test Project Dependencies -->
   <PropertyGroup>
     <XUnitVersion>2.4.1</XUnitVersion>
+    <FluentAssertionsVersion>5.10.3</FluentAssertionsVersion>
     <BogusVersion>29.0.1</BogusVersion>
     <MoqVersion>4.13.1</MoqVersion>
   </PropertyGroup>

benchmarks/LinkBuilder/LinkBuilderGetNamespaceFromPathBenchmarks.cs

@@ -8,23 +8,23 @@ namespace Benchmarks.LinkBuilder
     public class LinkBuilderGetNamespaceFromPathBenchmarks
     {
         private const string RequestPath = "/api/some-really-long-namespace-path/resources/current/articles/?some";
-        private const string EntityName = "articles";
+        private const string ResourceName = "articles";
         private const char PathDelimiter = '/';
 
         [Benchmark]
-        public void UsingStringSplit() => GetNamespaceFromPathUsingStringSplit(RequestPath, EntityName);
+        public void UsingStringSplit() => GetNamespaceFromPathUsingStringSplit(RequestPath, ResourceName);
 
         [Benchmark]
-        public void UsingReadOnlySpan() => GetNamespaceFromPathUsingReadOnlySpan(RequestPath, EntityName);
+        public void UsingReadOnlySpan() => GetNamespaceFromPathUsingReadOnlySpan(RequestPath, ResourceName);
 
-        public static string GetNamespaceFromPathUsingStringSplit(string path, string entityName)
+        public static string GetNamespaceFromPathUsingStringSplit(string path, string resourceName)
         {
             StringBuilder namespaceBuilder = new StringBuilder(path.Length);
             string[] segments = path.Split('/');
 
             for (int index = 1; index < segments.Length; index++)
             {
-                if (segments[index] == entityName)
+                if (segments[index] == resourceName)
                 {
                     break;
                 }
@@ -36,22 +36,22 @@ public static string GetNamespaceFromPathUsingStringSplit(string path, string en
             return namespaceBuilder.ToString();
         }
 
-        public static string GetNamespaceFromPathUsingReadOnlySpan(string path, string entityName)
+        public static string GetNamespaceFromPathUsingReadOnlySpan(string path, string resourceName)
         {
-            ReadOnlySpan<char> entityNameSpan = entityName.AsSpan();
+            ReadOnlySpan<char> resourceNameSpan = resourceName.AsSpan();
             ReadOnlySpan<char> pathSpan = path.AsSpan();
 
             for (int index = 0; index < pathSpan.Length; index++)
             {
                 if (pathSpan[index].Equals(PathDelimiter))
                 {
-                    if (pathSpan.Length > index + entityNameSpan.Length)
+                    if (pathSpan.Length > index + resourceNameSpan.Length)
                     {
-                        ReadOnlySpan<char> possiblePathSegment = pathSpan.Slice(index + 1, entityNameSpan.Length);
+                        ReadOnlySpan<char> possiblePathSegment = pathSpan.Slice(index + 1, resourceNameSpan.Length);
 
-                        if (entityNameSpan.SequenceEqual(possiblePathSegment))
+                        if (resourceNameSpan.SequenceEqual(possiblePathSegment))
                         {
-                            int lastCharacterIndex = index + 1 + entityNameSpan.Length;
+                            int lastCharacterIndex = index + 1 + resourceNameSpan.Length;
 
                             bool isAtEnd = lastCharacterIndex == pathSpan.Length;
                             bool hasDelimiterAfterSegment = pathSpan.Length >= lastCharacterIndex + 1 && pathSpan[lastCharacterIndex].Equals(PathDelimiter);

benchmarks/Query/QueryParserBenchmarks.cs

@@ -1,12 +1,12 @@
 using System;
 using System.Collections.Generic;
+using System.ComponentModel.Design;
 using BenchmarkDotNet.Attributes;
 using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Contracts;
-using JsonApiDotNetCore.Managers;
-using JsonApiDotNetCore.Query;
-using JsonApiDotNetCore.QueryParameterServices.Common;
-using JsonApiDotNetCore.Services;
+using JsonApiDotNetCore.Internal.QueryStrings;
+using JsonApiDotNetCore.RequestServices;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.Logging.Abstractions;
@@ -17,56 +17,59 @@ namespace Benchmarks.Query
     public class QueryParserBenchmarks
     {
         private readonly FakeRequestQueryStringAccessor _queryStringAccessor = new FakeRequestQueryStringAccessor();
-        private readonly QueryParameterParser _queryParameterParserForSort;
-        private readonly QueryParameterParser _queryParameterParserForAll;
+        private readonly QueryStringReader _queryStringReaderForSort;
+        private readonly QueryStringReader _queryStringReaderForAll;
 
         public QueryParserBenchmarks()
         {
-            IJsonApiOptions options = new JsonApiOptions();
+            IJsonApiOptions options = new JsonApiOptions
+            {
+                EnableLegacyFilterNotation = true
+            };
+
             IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph(options);
-            
-            var currentRequest = new CurrentRequest();
-            currentRequest.SetRequestResource(resourceGraph.GetResourceContext(typeof(BenchmarkResource)));
 
-            IResourceDefinitionProvider resourceDefinitionProvider = DependencyFactory.CreateResourceDefinitionProvider(resourceGraph);
+            var currentRequest = new CurrentRequest
+            {
+                PrimaryResource = resourceGraph.GetResourceContext(typeof(BenchmarkResource))
+            };
 
-            _queryParameterParserForSort = CreateQueryParameterDiscoveryForSort(resourceGraph, currentRequest, resourceDefinitionProvider, options, _queryStringAccessor);
-            _queryParameterParserForAll = CreateQueryParameterDiscoveryForAll(resourceGraph, currentRequest, resourceDefinitionProvider, options, _queryStringAccessor);
+            _queryStringReaderForSort = CreateQueryParameterDiscoveryForSort(resourceGraph, currentRequest, options, _queryStringAccessor);
+            _queryStringReaderForAll = CreateQueryParameterDiscoveryForAll(resourceGraph, currentRequest, options, _queryStringAccessor);
         }
 
-        private static QueryParameterParser CreateQueryParameterDiscoveryForSort(IResourceGraph resourceGraph,
-            CurrentRequest currentRequest, IResourceDefinitionProvider resourceDefinitionProvider,
+        private static QueryStringReader CreateQueryParameterDiscoveryForSort(IResourceGraph resourceGraph,
+            CurrentRequest currentRequest,
             IJsonApiOptions options, FakeRequestQueryStringAccessor queryStringAccessor)
         {
-            ISortService sortService = new SortService(resourceDefinitionProvider, resourceGraph, currentRequest);
-
-            var queryServices = new List<IQueryParameterService>
+            var sortReader = new SortQueryStringParameterReader(currentRequest, resourceGraph);
+            
+            var readers = new List<IQueryStringParameterReader>
             {
-                sortService
+                sortReader
             };
 
-            return new QueryParameterParser(options, queryStringAccessor, queryServices, NullLoggerFactory.Instance);
+            return new QueryStringReader(options, queryStringAccessor, readers, NullLoggerFactory.Instance);
         }
 
-        private static QueryParameterParser CreateQueryParameterDiscoveryForAll(IResourceGraph resourceGraph,
-            CurrentRequest currentRequest, IResourceDefinitionProvider resourceDefinitionProvider,
-            IJsonApiOptions options, FakeRequestQueryStringAccessor queryStringAccessor)
+        private static QueryStringReader CreateQueryParameterDiscoveryForAll(IResourceGraph resourceGraph,
+            CurrentRequest currentRequest, IJsonApiOptions options, FakeRequestQueryStringAccessor queryStringAccessor)
         {
-            IIncludeService includeService = new IncludeService(resourceGraph, currentRequest);
-            IFilterService filterService = new FilterService(resourceDefinitionProvider, resourceGraph, currentRequest);
-            ISortService sortService = new SortService(resourceDefinitionProvider, resourceGraph, currentRequest);
-            ISparseFieldsService sparseFieldsService = new SparseFieldsService(resourceGraph, currentRequest);
-            IPageService pageService = new PageService(options, resourceGraph, currentRequest);
-            IDefaultsService defaultsService = new DefaultsService(options);
-            INullsService nullsService = new NullsService(options);
-
-            var queryServices = new List<IQueryParameterService>
+            var resourceFactory = new ResourceFactory(new ServiceContainer());
+
+            var filterReader = new FilterQueryStringParameterReader(currentRequest, resourceGraph, resourceFactory, options);
+            var sortReader = new SortQueryStringParameterReader(currentRequest, resourceGraph);
+            var sparseFieldSetReader = new SparseFieldSetQueryStringParameterReader(currentRequest, resourceGraph);
+            var paginationReader = new PaginationQueryStringParameterReader(currentRequest, resourceGraph, options);
+            var defaultsReader = new DefaultsQueryStringParameterReader(options);
+            var nullsReader = new NullsQueryStringParameterReader(options);
+
+            var readers = new List<IQueryStringParameterReader>
             {
-                includeService, filterService, sortService, sparseFieldsService, pageService, defaultsService,
-                nullsService
+                filterReader, sortReader, sparseFieldSetReader, paginationReader, defaultsReader, nullsReader
             };
 
-            return new QueryParameterParser(options, queryStringAccessor, queryServices, NullLoggerFactory.Instance);
+            return new QueryStringReader(options, queryStringAccessor, readers, NullLoggerFactory.Instance);
         }
 
         [Benchmark]
@@ -75,7 +78,7 @@ public void AscendingSort()
             var queryString = $"?sort={BenchmarkResourcePublicNames.NameAttr}";
 
             _queryStringAccessor.SetQueryString(queryString);
-            _queryParameterParserForSort.Parse(null);
+            _queryStringReaderForSort.ReadAll(null);
         }
 
         [Benchmark]
@@ -84,7 +87,7 @@ public void DescendingSort()
             var queryString = $"?sort=-{BenchmarkResourcePublicNames.NameAttr}";
 
             _queryStringAccessor.SetQueryString(queryString);
-            _queryParameterParserForSort.Parse(null);
+            _queryStringReaderForSort.ReadAll(null);
         }
 
         [Benchmark]
@@ -93,7 +96,7 @@ public void ComplexQuery() => Run(100, () =>
             var queryString = $"?filter[{BenchmarkResourcePublicNames.NameAttr}]=abc,eq:abc&sort=-{BenchmarkResourcePublicNames.NameAttr}&include=child&page[size]=1&fields={BenchmarkResourcePublicNames.NameAttr}";
 
             _queryStringAccessor.SetQueryString(queryString);
-            _queryParameterParserForAll.Parse(null);
+            _queryStringReaderForAll.ReadAll(null);
         });
 
         private void Run(int iterations, Action action) { 

benchmarks/Serialization/JsonApiDeserializerBenchmarks.cs

@@ -39,7 +39,7 @@ public JsonApiDeserializerBenchmarks()
             var options = new JsonApiOptions();
             IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph(options);
             var targetedFields = new TargetedFields();
-            _jsonApiDeserializer = new RequestDeserializer(resourceGraph, new DefaultResourceFactory(new ServiceContainer()), targetedFields, new HttpContextAccessor());
+            _jsonApiDeserializer = new RequestDeserializer(resourceGraph, new ResourceFactory(new ServiceContainer()), targetedFields, new HttpContextAccessor());
         }
 
         [Benchmark]

benchmarks/Serialization/JsonApiSerializerBenchmarks.cs

@@ -2,8 +2,9 @@
 using BenchmarkDotNet.Attributes;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Internal.Contracts;
-using JsonApiDotNetCore.Managers;
-using JsonApiDotNetCore.Query;
+using JsonApiDotNetCore.Internal.Queries;
+using JsonApiDotNetCore.Internal.QueryStrings;
+using JsonApiDotNetCore.RequestServices;
 using JsonApiDotNetCore.Serialization;
 using JsonApiDotNetCore.Serialization.Server;
 using JsonApiDotNetCore.Serialization.Server.Builders;
@@ -14,7 +15,7 @@ namespace Benchmarks.Serialization
     [MarkdownExporter]
     public class JsonApiSerializerBenchmarks
     {
-        private static readonly BenchmarkResource Content = new BenchmarkResource
+        private static readonly BenchmarkResource _content = new BenchmarkResource
         {
             Id = 123,
             Name = Guid.NewGuid().ToString()
@@ -40,14 +41,19 @@ public JsonApiSerializerBenchmarks()
 
         private static FieldsToSerialize CreateFieldsToSerialize(IResourceGraph resourceGraph)
         {
-            var resourceDefinitionProvider = DependencyFactory.CreateResourceDefinitionProvider(resourceGraph);
             var currentRequest = new CurrentRequest();
-            var sparseFieldsService = new SparseFieldsService(resourceGraph, currentRequest);
-            
-            return new FieldsToSerialize(resourceGraph, sparseFieldsService, resourceDefinitionProvider);
+
+            var constraintProviders = new IQueryConstraintProvider[]
+            {
+                new SparseFieldSetQueryStringParameterReader(currentRequest, resourceGraph)
+            };
+
+            var resourceDefinitionProvider = DependencyFactory.CreateResourceDefinitionProvider(resourceGraph);
+
+            return new FieldsToSerialize(resourceGraph, constraintProviders, resourceDefinitionProvider);
         }
 
         [Benchmark]
-        public object SerializeSimpleObject() => _jsonApiSerializer.Serialize(Content);
+        public object SerializeSimpleObject() => _jsonApiSerializer.Serialize(_content);
     }
 }

docs/api/index.md

@@ -4,6 +4,6 @@ This section documents the package API and is generated from the XML source comm
 
 ## Common APIs
 
-- [`JsonApiOptions`](JsonApiDotNetCore.Configuration.JsonApiOptions.html)
-- [`IResourceGraph`](JsonApiDotNetCore.Internal.Contracts.IResourceGraph.html)
-- [`ResourceDefinition<T>`](JsonApiDotNetCore.Models.ResourceDefinition-1.html)
+- [`JsonApiOptions`](JsonApiDotNetCore.Configuration.JsonApiOptions.yml)
+- [`IResourceGraph`](JsonApiDotNetCore.Internal.Contracts.IResourceGraph.yml)
+- [`ResourceDefinition<TResource>`](JsonApiDotNetCore.Models.ResourceDefinition-1.yml)

docs/index.md

@@ -14,10 +14,10 @@ Eliminate CRUD boilerplate and provide the following features across your resour
 - Filtering
 - Sorting
 - Pagination
-- Sparse field selection
+- Sparse fieldset selection
 - Relationship inclusion and navigation
 
-Checkout the [example requests](request-examples) to see the kind of features you will get out of the box.
+Checkout the [example requests](request-examples/index.md) to see the kind of features you will get out of the box.
 
 ### 2. Extensibility
 

docs/usage/extensibility/custom-query-formats.md

@@ -1,9 +1,16 @@
-# Custom Query Formats
+# Custom QueryString parameters
 
-For information on the default query string parameter formats, see the documentation for each query method.
+For information on the built-in query string parameters, see the documentation for them.
+In order to add parsing of custom query string parameters, you can implement the `IQueryStringParameterReader` interface and inject it.
 
-In order to customize the query formats, you need to implement the `IQueryParameterParser` interface and inject it.
+```c#
+public class YourQueryStringParameterReader : IQueryStringParameterReader
+{
+    // ...
+}
+```
 
 ```c#
-services.AddScoped<IQueryParameterParser, FooQueryParameterParser>();
+services.AddScoped<YourQueryStringParameterReader>();
+services.AddScoped<IQueryStringParameterReader>(sp => sp.GetService<YourQueryStringParameterReader>());
 ```

docs/usage/extensibility/layer-overview.md

@@ -1,21 +1,21 @@
 # Layer Overview
 
-By default, data retrieval is distributed across 3 layers:
+By default, data retrieval is distributed across three layers:
 
 ```
 JsonApiController (required)
 
-+-- DefaultResourceService: IResourceService
++-- JsonApiResourceService : IResourceService
 
-     +-- DefaultResourceRepository: IResourceRepository
+     +-- EntityFrameworkCoreRepository : IResourceRepository
 ```
 
 Customization can be done at any of these layers. However, it is recommended that you make your customizations at the service or the repository layer when possible to keep the controllers free of unnecessary logic.
 You can use the following as a general rule of thumb for where to put business logic:
 
 - `Controller`: simple validation logic that should result in the return of specific HTTP status codes, such as model validation
 - `IResourceService`: advanced business logic and replacement of data access mechanisms
-- `IResourceRepository`: custom logic that builds on the Entity Framework Core APIs, such as Authorization of data
+- `IResourceRepository`: custom logic that builds on the Entity Framework Core APIs
 
 ## Replacing Services