Merge pull request #1286 from json-api-dotnet/query-string-extensibility

Extensible query string functions

Author: bkoelman

benchmarks/QueryString/QueryStringParserBenchmarks.cs

@@ -4,8 +4,8 @@
 using JsonApiDotNetCore;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
+using JsonApiDotNetCore.Queries.Parsing;
 using JsonApiDotNetCore.QueryStrings;
-using JsonApiDotNetCore.QueryStrings.Internal;
 using JsonApiDotNetCore.Resources;
 using Microsoft.Extensions.Logging.Abstractions;
 
@@ -37,11 +37,23 @@ public QueryStringParserBenchmarks()
 
         var resourceFactory = new ResourceFactory(new ServiceContainer());
 
-        var includeReader = new IncludeQueryStringParameterReader(request, resourceGraph, options);
-        var filterReader = new FilterQueryStringParameterReader(request, resourceGraph, resourceFactory, options);
-        var sortReader = new SortQueryStringParameterReader(request, resourceGraph);
-        var sparseFieldSetReader = new SparseFieldSetQueryStringParameterReader(request, resourceGraph);
-        var paginationReader = new PaginationQueryStringParameterReader(request, resourceGraph, options);
+        var includeParser = new IncludeParser(options);
+        var includeReader = new IncludeQueryStringParameterReader(includeParser, request, resourceGraph);
+
+        var filterScopeParser = new QueryStringParameterScopeParser();
+        var filterValueParser = new FilterParser(resourceFactory);
+        var filterReader = new FilterQueryStringParameterReader(filterScopeParser, filterValueParser, request, resourceGraph, options);
+
+        var sortScopeParser = new QueryStringParameterScopeParser();
+        var sortValueParser = new SortParser();
+        var sortReader = new SortQueryStringParameterReader(sortScopeParser, sortValueParser, request, resourceGraph);
+
+        var sparseFieldSetScopeParser = new SparseFieldTypeParser(resourceGraph);
+        var sparseFieldSetValueParser = new SparseFieldSetParser();
+        var sparseFieldSetReader = new SparseFieldSetQueryStringParameterReader(sparseFieldSetScopeParser, sparseFieldSetValueParser, request, resourceGraph);
+
+        var paginationParser = new PaginationParser();
+        var paginationReader = new PaginationQueryStringParameterReader(paginationParser, request, resourceGraph, options);
 
         IQueryStringParameterReader[] readers = ArrayFactory.Create<IQueryStringParameterReader>(includeReader, filterReader, sortReader,
             sparseFieldSetReader, paginationReader);

benchmarks/Serialization/OperationsSerializationBenchmarks.cs

@@ -3,7 +3,6 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
-using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
 

benchmarks/Serialization/ResourceSerializationBenchmarks.cs

@@ -6,7 +6,6 @@
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
-using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Serialization.Objects;
 

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -5,7 +5,6 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
-using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Serialization.Response;

benchmarks/Tools/NeverResourceDefinitionAccessor.cs

@@ -2,6 +2,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries.Expressions;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 
@@ -13,6 +14,7 @@ namespace Benchmarks.Tools;
 internal sealed class NeverResourceDefinitionAccessor : IResourceDefinitionAccessor
 {
     bool IResourceDefinitionAccessor.IsReadOnlyRequest => throw new NotImplementedException();
+    public IQueryableBuilder QueryableBuilder => throw new NotImplementedException();
 
     public IImmutableSet<IncludeElementExpression> OnApplyIncludes(ResourceType resourceType, IImmutableSet<IncludeElementExpression> existingIncludes)
     {

src/Examples/NoEntityFrameworkExample/QueryLayerToLinqConverter.cs

@@ -1,21 +1,21 @@
 using System.Collections;
 using System.Linq.Expressions;
 using JsonApiDotNetCore.Queries;
-using JsonApiDotNetCore.Queries.Internal.QueryableBuilding;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using JsonApiDotNetCore.Resources;
 using Microsoft.EntityFrameworkCore.Metadata;
 
 namespace NoEntityFrameworkExample;
 
 internal sealed class QueryLayerToLinqConverter
 {
-    private readonly IResourceFactory _resourceFactory;
     private readonly IModel _model;
+    private readonly IQueryableBuilder _queryableBuilder;
 
-    public QueryLayerToLinqConverter(IResourceFactory resourceFactory, IModel model)
+    public QueryLayerToLinqConverter(IModel model, IQueryableBuilder queryableBuilder)
     {
-        _resourceFactory = resourceFactory;
         _model = model;
+        _queryableBuilder = queryableBuilder;
     }
 
     public IEnumerable<TResource> ApplyQueryLayer<TResource>(QueryLayer queryLayer, IEnumerable<TResource> resources)
@@ -26,10 +26,9 @@ public IEnumerable<TResource> ApplyQueryLayer<TResource>(QueryLayer queryLayer,
         converter.ConvertIncludesToSelections();
 
         // Convert QueryLayer into LINQ expression.
-        Expression source = ((IEnumerable)resources).AsQueryable().Expression;
-        var nameFactory = new LambdaParameterNameFactory();
-        var queryableBuilder = new QueryableBuilder(source, queryLayer.ResourceType.ClrType, typeof(Enumerable), nameFactory, _resourceFactory, _model);
-        Expression expression = queryableBuilder.ApplyQuery(queryLayer);
+        IQueryable source = ((IEnumerable)resources).AsQueryable();
+        var context = QueryableBuilderContext.CreateRoot(source, typeof(Enumerable), _model, null);
+        Expression expression = _queryableBuilder.ApplyQuery(queryLayer, context);
 
         // Insert null checks to prevent a NullReferenceException during execution of expressions such as:
         // 'todoItems => todoItems.Where(todoItem => todoItem.Assignee.Id == 1)' when a TodoItem doesn't have an assignee.

src/Examples/NoEntityFrameworkExample/Repositories/InMemoryResourceRepository.cs

@@ -1,7 +1,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
-using JsonApiDotNetCore.Queries.Internal.QueryableBuilding;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using JsonApiDotNetCore.Repositories;
 using JsonApiDotNetCore.Resources;
 using NoEntityFrameworkExample.Data;
@@ -25,12 +25,12 @@ public abstract class InMemoryResourceRepository<TResource, TId> : IResourceRead
     private readonly ResourceType _resourceType;
     private readonly QueryLayerToLinqConverter _queryLayerToLinqConverter;
 
-    protected InMemoryResourceRepository(IResourceGraph resourceGraph, IResourceFactory resourceFactory)
+    protected InMemoryResourceRepository(IResourceGraph resourceGraph, IQueryableBuilder queryableBuilder)
     {
         _resourceType = resourceGraph.GetResourceType<TResource>();
 
         var model = new InMemoryModel(resourceGraph);
-        _queryLayerToLinqConverter = new QueryLayerToLinqConverter(resourceFactory, model);
+        _queryLayerToLinqConverter = new QueryLayerToLinqConverter(model, queryableBuilder);
     }
 
     /// <inheritdoc />

src/Examples/NoEntityFrameworkExample/Repositories/PersonRepository.cs

@@ -1,6 +1,6 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using NoEntityFrameworkExample.Data;
 using NoEntityFrameworkExample.Models;
 
@@ -9,8 +9,8 @@ namespace NoEntityFrameworkExample.Repositories;
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
 public sealed class PersonRepository : InMemoryResourceRepository<Person, long>
 {
-    public PersonRepository(IResourceGraph resourceGraph, IResourceFactory resourceFactory)
-        : base(resourceGraph, resourceFactory)
+    public PersonRepository(IResourceGraph resourceGraph, IQueryableBuilder queryableBuilder)
+        : base(resourceGraph, queryableBuilder)
     {
     }
 

src/Examples/NoEntityFrameworkExample/Repositories/TagRepository.cs

@@ -1,6 +1,6 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using NoEntityFrameworkExample.Data;
 using NoEntityFrameworkExample.Models;
 
@@ -9,8 +9,8 @@ namespace NoEntityFrameworkExample.Repositories;
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
 public sealed class TagRepository : InMemoryResourceRepository<Tag, long>
 {
-    public TagRepository(IResourceGraph resourceGraph, IResourceFactory resourceFactory)
-        : base(resourceGraph, resourceFactory)
+    public TagRepository(IResourceGraph resourceGraph, IQueryableBuilder queryableBuilder)
+        : base(resourceGraph, queryableBuilder)
     {
     }
 

src/Examples/NoEntityFrameworkExample/Repositories/TodoItemRepository.cs

@@ -1,6 +1,6 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using NoEntityFrameworkExample.Data;
 using NoEntityFrameworkExample.Models;
 
@@ -9,8 +9,8 @@ namespace NoEntityFrameworkExample.Repositories;
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
 public sealed class TodoItemRepository : InMemoryResourceRepository<TodoItem, long>
 {
-    public TodoItemRepository(IResourceGraph resourceGraph, IResourceFactory resourceFactory)
-        : base(resourceGraph, resourceFactory)
+    public TodoItemRepository(IResourceGraph resourceGraph, IQueryableBuilder queryableBuilder)
+        : base(resourceGraph, queryableBuilder)
     {
     }
 

src/Examples/NoEntityFrameworkExample/Services/InMemoryResourceService.cs

@@ -3,7 +3,7 @@
 using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
-using JsonApiDotNetCore.Queries.Internal.QueryableBuilding;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Services;
@@ -42,7 +42,7 @@ public abstract class InMemoryResourceService<TResource, TId> : IResourceQuerySe
     private readonly QueryLayerToLinqConverter _queryLayerToLinqConverter;
 
     protected InMemoryResourceService(IJsonApiOptions options, IResourceGraph resourceGraph, IQueryLayerComposer queryLayerComposer,
-        IResourceFactory resourceFactory, IPaginationContext paginationContext, IEnumerable<IQueryConstraintProvider> constraintProviders,
+        IPaginationContext paginationContext, IEnumerable<IQueryConstraintProvider> constraintProviders, IQueryableBuilder queryableBuilder,
         ILoggerFactory loggerFactory)
     {
         _options = options;
@@ -54,7 +54,7 @@ protected InMemoryResourceService(IJsonApiOptions options, IResourceGraph resour
         _resourceType = resourceGraph.GetResourceType<TResource>();
 
         var model = new InMemoryModel(resourceGraph);
-        _queryLayerToLinqConverter = new QueryLayerToLinqConverter(resourceFactory, model);
+        _queryLayerToLinqConverter = new QueryLayerToLinqConverter(model, queryableBuilder);
     }
 
     /// <inheritdoc />

src/Examples/NoEntityFrameworkExample/Services/TodoItemService.cs

@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Queries;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using JsonApiDotNetCore.Resources;
 using NoEntityFrameworkExample.Data;
 using NoEntityFrameworkExample.Models;
@@ -10,9 +11,9 @@ namespace NoEntityFrameworkExample.Services;
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
 public sealed class TodoItemService : InMemoryResourceService<TodoItem, long>
 {
-    public TodoItemService(IJsonApiOptions options, IResourceGraph resourceGraph, IQueryLayerComposer queryLayerComposer, IResourceFactory resourceFactory,
-        IPaginationContext paginationContext, IEnumerable<IQueryConstraintProvider> constraintProviders, ILoggerFactory loggerFactory)
-        : base(options, resourceGraph, queryLayerComposer, resourceFactory, paginationContext, constraintProviders, loggerFactory)
+    public TodoItemService(IJsonApiOptions options, IResourceGraph resourceGraph, IQueryLayerComposer queryLayerComposer, IPaginationContext paginationContext,
+        IEnumerable<IQueryConstraintProvider> constraintProviders, IQueryableBuilder queryableBuilder, ILoggerFactory loggerFactory)
+        : base(options, resourceGraph, queryLayerComposer, paginationContext, constraintProviders, queryableBuilder, loggerFactory)
     {
     }
 

src/JsonApiDotNetCore.Annotations/Resources/Identifiable.cs

@@ -1,5 +1,4 @@
 using System.ComponentModel.DataAnnotations.Schema;
-using JsonApiDotNetCore.Resources.Internal;
 
 namespace JsonApiDotNetCore.Resources;
 

src/JsonApiDotNetCore.Annotations/Resources/Internal/RuntimeTypeConverter.cs renamed to src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs

@@ -3,13 +3,31 @@
 
 #pragma warning disable AV1008 // Class should not be static
 
-namespace JsonApiDotNetCore.Resources.Internal;
+namespace JsonApiDotNetCore.Resources;
 
+/// <summary>
+/// Provides utilities regarding runtime types.
+/// </summary>
 [PublicAPI]
 public static class RuntimeTypeConverter
 {
     private const string ParseQueryStringsUsingCurrentCultureSwitchName = "JsonApiDotNetCore.ParseQueryStringsUsingCurrentCulture";
 
+    /// <summary>
+    /// Converts the specified value to the specified type.
+    /// </summary>
+    /// <param name="value">
+    /// The value to convert from.
+    /// </param>
+    /// <param name="type">
+    /// The type to convert to.
+    /// </param>
+    /// <returns>
+    /// The converted type, or <c>null</c> if <paramref name="value" /> is <c>null</c> and <paramref name="type" /> is a nullable type.
+    /// </returns>
+    /// <exception cref="FormatException">
+    /// <paramref name="value" /> is not compatible with <paramref name="type" />.
+    /// </exception>
     public static object? ConvertType(object? value, Type type)
     {
         ArgumentGuard.NotNull(type);
@@ -114,11 +132,20 @@ public static class RuntimeTypeConverter
         }
     }
 
+    /// <summary>
+    /// Indicates whether the specified type is a nullable value type or a reference type.
+    /// </summary>
     public static bool CanContainNull(Type type)
     {
         return !type.IsValueType || Nullable.GetUnderlyingType(type) != null;
     }
 
+    /// <summary>
+    /// Gets the default value for the specified type.
+    /// </summary>
+    /// <returns>
+    /// The default value, or <c>null</c> for nullable value types and reference types.
+    /// </returns>
     public static object? GetDefaultValue(Type type)
     {
         return type.IsValueType ? Activator.CreateInstance(type) : null;

src/JsonApiDotNetCore/AtomicOperations/OperationsProcessor.cs

@@ -2,7 +2,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Middleware;
-using JsonApiDotNetCore.Queries.Internal;
+using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
 

src/JsonApiDotNetCore/CollectionExtensions.cs

@@ -32,6 +32,18 @@ public static int FindIndex<T>(this IReadOnlyList<T> source, Predicate<T> match)
         return -1;
     }
 
+    public static IEnumerable<T> ToEnumerable<T>(this LinkedListNode<T>? startNode)
+    {
+        LinkedListNode<T>? current = startNode;
+
+        while (current != null)
+        {
+            yield return current.Value;
+
+            current = current.Next;
+        }
+    }
+
     public static bool DictionaryEqual<TKey, TValue>(this IReadOnlyDictionary<TKey, TValue>? first, IReadOnlyDictionary<TKey, TValue>? second,
         IEqualityComparer<TValue>? valueComparer = null)
     {

src/JsonApiDotNetCore/Configuration/JsonApiApplicationBuilder.cs

@@ -2,9 +2,9 @@
 using JsonApiDotNetCore.AtomicOperations.Processors;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
-using JsonApiDotNetCore.Queries.Internal;
+using JsonApiDotNetCore.Queries.Parsing;
+using JsonApiDotNetCore.Queries.QueryableBuilding;
 using JsonApiDotNetCore.QueryStrings;
-using JsonApiDotNetCore.QueryStrings.Internal;
 using JsonApiDotNetCore.Repositories;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.JsonConverters;
@@ -193,6 +193,13 @@ private void AddRepositoryLayer()
         RegisterImplementationForInterfaces(ServiceDiscoveryFacade.RepositoryUnboundInterfaces, typeof(EntityFrameworkCoreRepository<,>));
 
         _services.AddScoped<IResourceRepositoryAccessor, ResourceRepositoryAccessor>();
+
+        _services.TryAddTransient<IQueryableBuilder, QueryableBuilder>();
+        _services.TryAddTransient<IIncludeClauseBuilder, IncludeClauseBuilder>();
+        _services.TryAddTransient<IOrderClauseBuilder, OrderClauseBuilder>();
+        _services.TryAddTransient<ISelectClauseBuilder, SelectClauseBuilder>();
+        _services.TryAddTransient<ISkipTakeClauseBuilder, SkipTakeClauseBuilder>();
+        _services.TryAddTransient<IWhereClauseBuilder, WhereClauseBuilder>();
     }
 
     private void AddServiceLayer()
@@ -210,6 +217,14 @@ private void RegisterImplementationForInterfaces(HashSet<Type> unboundInterfaces
 
     private void AddQueryStringLayer()
     {
+        _services.TryAddTransient<IQueryStringParameterScopeParser, QueryStringParameterScopeParser>();
+        _services.TryAddTransient<IIncludeParser, IncludeParser>();
+        _services.TryAddTransient<IFilterParser, FilterParser>();
+        _services.TryAddTransient<ISortParser, SortParser>();
+        _services.TryAddTransient<ISparseFieldTypeParser, SparseFieldTypeParser>();
+        _services.TryAddTransient<ISparseFieldSetParser, SparseFieldSetParser>();
+        _services.TryAddTransient<IPaginationParser, PaginationParser>();
+
         _services.AddScoped<IIncludeQueryStringParameterReader, IncludeQueryStringParameterReader>();
         _services.AddScoped<IFilterQueryStringParameterReader, FilterQueryStringParameterReader>();
         _services.AddScoped<ISortQueryStringParameterReader, SortQueryStringParameterReader>();

src/JsonApiDotNetCore/Queries/Internal/EvaluatedIncludeCache.cs renamed to src/JsonApiDotNetCore/Queries/EvaluatedIncludeCache.cs

@@ -1,6 +1,6 @@
 using JsonApiDotNetCore.Queries.Expressions;
 
-namespace JsonApiDotNetCore.Queries.Internal;
+namespace JsonApiDotNetCore.Queries;
 
 /// <inheritdoc />
 internal sealed class EvaluatedIncludeCache : IEvaluatedIncludeCache