Simplify IQueryStringParameterScopeParser

Author: bkoelman

src/JsonApiDotNetCore/Queries/Expressions/IncludeChainConverter.cs

@@ -8,6 +8,12 @@ namespace JsonApiDotNetCore.Queries.Expressions;
 /// </summary>
 internal sealed class IncludeChainConverter
 {
+    public static IncludeChainConverter Instance { get; } = new();
+
+    private IncludeChainConverter()
+    {
+    }
+
     /// <summary>
     /// Converts a tree of inclusions into a set of relationship chains.
     /// </summary>

src/JsonApiDotNetCore/Queries/Expressions/IncludeExpression.cs

@@ -13,8 +13,6 @@ namespace JsonApiDotNetCore.Queries.Expressions;
 [PublicAPI]
 public class IncludeExpression : QueryExpression
 {
-    private static readonly IncludeChainConverter IncludeChainConverter = new();
-
     public static readonly IncludeExpression Empty = new();
 
     /// <summary>
@@ -51,7 +49,7 @@ public override string ToFullString()
 
     private string InnerToString(bool toFullString)
     {
-        IReadOnlyCollection<ResourceFieldChainExpression> chains = IncludeChainConverter.GetRelationshipChains(this);
+        IReadOnlyCollection<ResourceFieldChainExpression> chains = IncludeChainConverter.Instance.GetRelationshipChains(this);
         return string.Join(",", chains.Select(field => toFullString ? field.ToFullString() : field.ToString()).Distinct().OrderBy(name => name));
     }
 

src/JsonApiDotNetCore/Queries/Parsing/IQueryStringParameterScopeParser.cs

@@ -1,12 +1,11 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Queries.Expressions;
-using JsonApiDotNetCore.QueryStrings.FieldChains;
 
 namespace JsonApiDotNetCore.Queries.Parsing;
 
 /// <summary>
-/// Parses the JSON:API 'sort' and 'filter' query string parameter names, which contain a resource field chain that indicates the scope its query string
-/// parameter value applies to.
+/// Parser for the JSON:API 'sort' and 'filter' query string parameter names, which indicate the scope their query string parameter value applies to. The
+/// value consists of an optional relationship chain ending in a to-many relationship, surrounded by brackets.
 /// </summary>
 public interface IQueryStringParameterScopeParser
 {
@@ -20,11 +19,5 @@ public interface IQueryStringParameterScopeParser
     /// <param name="resourceType">
     /// The resource type used to lookup JSON:API fields that are referenced in <paramref name="source" />.
     /// </param>
-    /// <param name="pattern">
-    /// The pattern that the field chain in <paramref name="source" /> must match.
-    /// </param>
-    /// <param name="options">
-    /// The match options for <paramref name="pattern" />.
-    /// </param>
-    QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType, FieldChainPattern pattern, FieldChainPatternMatchOptions options);
+    QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType);
 }

src/JsonApiDotNetCore/Queries/Parsing/QueryStringParameterScopeParser.cs

@@ -10,25 +10,22 @@ namespace JsonApiDotNetCore.Queries.Parsing;
 public class QueryStringParameterScopeParser : QueryExpressionParser, IQueryStringParameterScopeParser
 {
     /// <inheritdoc />
-    public QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType, FieldChainPattern pattern, FieldChainPatternMatchOptions options)
+    public QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType)
     {
         ArgumentNullException.ThrowIfNull(resourceType);
-        ArgumentNullException.ThrowIfNull(pattern);
 
         Tokenize(source);
 
-        QueryStringParameterScopeExpression expression = ParseQueryStringParameterScope(resourceType, pattern, options);
+        QueryStringParameterScopeExpression expression = ParseQueryStringParameterScope(resourceType);
 
         AssertTokenStackIsEmpty();
 
         return expression;
     }
 
-    protected virtual QueryStringParameterScopeExpression ParseQueryStringParameterScope(ResourceType resourceType, FieldChainPattern pattern,
-        FieldChainPatternMatchOptions options)
+    protected virtual QueryStringParameterScopeExpression ParseQueryStringParameterScope(ResourceType resourceType)
     {
         ArgumentNullException.ThrowIfNull(resourceType);
-        ArgumentNullException.ThrowIfNull(pattern);
 
         int position = GetNextTokenPositionOrEnd();
 
@@ -45,7 +42,7 @@ protected virtual QueryStringParameterScopeExpression ParseQueryStringParameterS
         {
             TokenStack.Pop();
 
-            scope = ParseFieldChain(pattern, options, resourceType, null);
+            scope = ParseFieldChain(BuiltInPatterns.RelationshipChainEndingInToMany, FieldChainPatternMatchOptions.None, resourceType, null);
 
             EatSingleCharacterToken(TokenKind.CloseBracket);
         }

src/JsonApiDotNetCore/Queries/QueryableBuilding/IncludeClauseBuilder.cs

@@ -10,8 +10,6 @@ namespace JsonApiDotNetCore.Queries.QueryableBuilding;
 [PublicAPI]
 public class IncludeClauseBuilder : QueryClauseBuilder, IIncludeClauseBuilder
 {
-    private static readonly IncludeChainConverter IncludeChainConverter = new();
-
     public virtual Expression ApplyInclude(IncludeExpression include, QueryClauseBuilderContext context)
     {
         ArgumentNullException.ThrowIfNull(include);
@@ -26,7 +24,7 @@ public override Expression VisitInclude(IncludeExpression expression, QueryClaus
 
         ApplyEagerLoads(context.ResourceType.EagerLoads, null, propertyPaths);
 
-        foreach (ResourceFieldChainExpression chain in IncludeChainConverter.GetRelationshipChains(expression))
+        foreach (ResourceFieldChainExpression chain in IncludeChainConverter.Instance.GetRelationshipChains(expression))
         {
             ProcessRelationshipChain(chain, propertyPaths);
         }

src/JsonApiDotNetCore/QueryStrings/FilterQueryStringParameterReader.cs

@@ -7,7 +7,6 @@
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
 using JsonApiDotNetCore.Queries.Parsing;
-using JsonApiDotNetCore.QueryStrings.FieldChains;
 using Microsoft.Extensions.Primitives;
 
 namespace JsonApiDotNetCore.QueryStrings;
@@ -115,8 +114,7 @@ private void ReadSingleValue(string parameterName, string parameterValue)
 
     private ResourceFieldChainExpression? GetScope(string parameterName)
     {
-        QueryStringParameterScopeExpression parameterScope = _scopeParser.Parse(parameterName, RequestResourceType,
-            BuiltInPatterns.RelationshipChainEndingInToMany, FieldChainPatternMatchOptions.None);
+        QueryStringParameterScopeExpression parameterScope = _scopeParser.Parse(parameterName, RequestResourceType);
 
         if (parameterScope.Scope == null)
         {

src/JsonApiDotNetCore/QueryStrings/SortQueryStringParameterReader.cs

@@ -6,7 +6,6 @@
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
 using JsonApiDotNetCore.Queries.Parsing;
-using JsonApiDotNetCore.QueryStrings.FieldChains;
 using Microsoft.Extensions.Primitives;
 
 namespace JsonApiDotNetCore.QueryStrings;
@@ -72,8 +71,7 @@ public virtual void Read(string parameterName, StringValues parameterValue)
 
     private ResourceFieldChainExpression? GetScope(string parameterName)
     {
-        QueryStringParameterScopeExpression parameterScope = _scopeParser.Parse(parameterName, RequestResourceType,
-            BuiltInPatterns.RelationshipChainEndingInToMany, FieldChainPatternMatchOptions.None);
+        QueryStringParameterScopeExpression parameterScope = _scopeParser.Parse(parameterName, RequestResourceType);
 
         if (parameterScope.Scope == null)
         {

test/JsonApiDotNetCoreTests/UnitTests/Queries/QueryExpressionRewriterTests.cs

@@ -4,7 +4,6 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Queries.Expressions;
 using JsonApiDotNetCore.Queries.Parsing;
-using JsonApiDotNetCore.QueryStrings.FieldChains;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCoreTests.IntegrationTests.QueryStrings;
 using Microsoft.Extensions.Logging.Abstractions;
@@ -198,8 +197,7 @@ public void VisitParameterScope(string expressionText, string expectedTypes)
         var parser = new QueryStringParameterScopeParser();
         ResourceType blogType = ResourceGraph.GetResourceType<Blog>();
 
-        QueryExpression expression =
-            parser.Parse(expressionText, blogType, BuiltInPatterns.RelationshipChainEndingInToMany, FieldChainPatternMatchOptions.None);
+        QueryExpression expression = parser.Parse(expressionText, blogType);
 
         var rewriter = new TestableQueryExpressionRewriter();