feat: draft of reflectively retrieving all query parameters

Author: maurei

src/JsonApiDotNetCore/Query/Common/IQueryParameterService.cs

@@ -3,16 +3,15 @@
     /// <summary>
     /// Base interface that all query parameter services should inherit.
     /// </summary>
-    public interface IQueryParameterService
+    internal interface IQueryParameterService
     {
         /// <summary>
         /// Parses the value of the query parameter. Invoked in the middleware.
         /// </summary>
         /// <param name="value">the value of the query parameter as parsed from the url</param>
         void Parse(string value);
         /// <summary>
-        /// Name of the parameter as appearing in the url, used internally for matching.
-        /// Case sensitive.
+        /// The name of the query parameter as matched in the URL.
         /// </summary>
         string Name { get; }
     }

src/JsonApiDotNetCore/Query/IncludeService.cs

@@ -1,15 +1,39 @@
 using System.Collections.Generic;
 using System.Linq;
+using System.Text.RegularExpressions;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Internal.Query;
 using JsonApiDotNetCore.Managers.Contracts;
 using JsonApiDotNetCore.Models;
-using JsonApiDotNetCore.Query;
 
 namespace JsonApiDotNetCore.Query
 {
-    public class IncludeService : IIncludeService, IQueryParameterService
+
+    public abstract class QueryParameterService : IQueryParameterService
+    {
+
+        /// <summary>
+        /// By default, the name is derived from the implementing type.
+        /// </summary>
+        /// <example>
+        /// The following query param service will match the query  displayed in URL
+        /// `?include=some-relationship`
+        /// <code>public class IncludeService : QueryParameterService  { /* ... */  } </code>
+        /// </example>
+        public virtual string Name { get { return GetParameterNameFromType(); } }
+
+        /// <inheritdoc/>
+        public abstract void Parse(string value);
+
+        /// <summary>
+        /// Gets the query parameter name from the implementing class name. Trims "Service"
+        /// from the name if present.
+        /// </summary>
+        private string GetParameterNameFromType() => new Regex("Service$").Replace(GetType().Name, string.Empty);
+    }
+
+    public class IncludeService : QueryParameterService, IIncludeService
     {
         /// todo: make readonly
         private readonly List<List<RelationshipAttribute>> _includedChains;
@@ -29,16 +53,14 @@ public IncludeService(ICurrentRequest currentRequest,
         /// </summary>
         internal IncludeService() : this(null, null) { }
 
-        public string Name => QueryConstants.INCLUDE;
-
         /// <inheritdoc/>
         public List<List<RelationshipAttribute>> Get()
         {
             return _includedChains.Select(chain => chain.ToList()).ToList();
         }
 
         /// <inheritdoc/>
-        public void Parse(string value)
+        public override void Parse(string value)
         {
             if (string.IsNullOrWhiteSpace(value))
                 throw new JsonApiException(400, "Include parameter must not be empty if provided");

src/JsonApiDotNetCore/Services/QueryParser.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Internal.Query;
@@ -27,6 +28,7 @@ public class QueryParser : IQueryParser
         private readonly ICurrentRequest _currentRequest;
         private readonly IContextEntityProvider _provider;
         private readonly IJsonApiOptions _options;
+        private readonly IServiceProvider _sp;
         private ContextEntity _primaryResource;
 
         public QueryParser(IIncludeService includeService,
@@ -46,6 +48,13 @@ public QueryParser(IIncludeService includeService,
 
         public virtual QuerySet Parse(IQueryCollection query)
         {
+            var type = typeof(IQueryParameterService);
+            var types = AppDomain.CurrentDomain.GetAssemblies()
+                .SelectMany(a => a.GetTypes())
+                .Where(t => t.IsInterface && t.Inherits(type))
+                .Select(t => (IQueryParameterService)_sp.GetService(t));
+
+
             _primaryResource = _currentRequest.GetRequestResource();
             var querySet = new QuerySet();
             var disabledQueries = _currentRequest.DisabledQueryParams;