Expose source text on parser base class

Author: bkoelman

src/JsonApiDotNetCore/Queries/Parsing/IncludeParser.cs

@@ -29,17 +29,16 @@ public IncludeExpression Parse(string source, ResourceType resourceType)
 
         Tokenize(source);
 
-        IncludeExpression expression = ParseInclude(source, resourceType);
+        IncludeExpression expression = ParseInclude(resourceType);
 
         AssertTokenStackIsEmpty();
         ValidateMaximumIncludeDepth(expression, 0);
 
         return expression;
     }
 
-    protected virtual IncludeExpression ParseInclude(string source, ResourceType resourceType)
+    protected virtual IncludeExpression ParseInclude(ResourceType resourceType)
     {
-        ArgumentNullException.ThrowIfNull(source);
         ArgumentNullException.ThrowIfNull(resourceType);
 
         var treeRoot = IncludeTreeNode.CreateRoot(resourceType);
@@ -56,13 +55,13 @@ protected virtual IncludeExpression ParseInclude(string source, ResourceType res
                 isAtStart = false;
             }
 
-            ParseRelationshipChain(source, treeRoot);
+            ParseRelationshipChain(treeRoot);
         }
 
         return treeRoot.ToExpression();
     }
 
-    private void ParseRelationshipChain(string source, IncludeTreeNode treeRoot)
+    private void ParseRelationshipChain(IncludeTreeNode treeRoot)
     {
         // A relationship name usually matches a single relationship, even when overridden in derived types.
         // But in the following case, two relationships are matched on GET /shoppingBaskets?include=items:
@@ -90,30 +89,29 @@ private void ParseRelationshipChain(string source, IncludeTreeNode treeRoot)
         // that there's currently no way to include Products without Articles. We could add such optional upcast syntax
         // in the future, if desired.
 
-        ReadOnlyCollection<IncludeTreeNode> children = ParseRelationshipName(source, [treeRoot]);
+        ReadOnlyCollection<IncludeTreeNode> children = ParseRelationshipName([treeRoot]);
 
         while (TokenStack.TryPeek(out Token? nextToken) && nextToken.Kind == TokenKind.Period)
         {
             EatSingleCharacterToken(TokenKind.Period);
 
-            children = ParseRelationshipName(source, children);
+            children = ParseRelationshipName(children);
         }
     }
 
-    private ReadOnlyCollection<IncludeTreeNode> ParseRelationshipName(string source, IReadOnlyCollection<IncludeTreeNode> parents)
+    private ReadOnlyCollection<IncludeTreeNode> ParseRelationshipName(IReadOnlyCollection<IncludeTreeNode> parents)
     {
         int position = GetNextTokenPositionOrEnd();
 
         if (TokenStack.TryPop(out Token? token) && token.Kind == TokenKind.Text)
         {
-            return LookupRelationshipName(token.Value!, parents, source, position);
+            return LookupRelationshipName(token.Value!, parents, position);
         }
 
         throw new QueryParseException("Relationship name expected.", position);
     }
 
-    private static ReadOnlyCollection<IncludeTreeNode> LookupRelationshipName(string relationshipName, IReadOnlyCollection<IncludeTreeNode> parents,
-        string source, int position)
+    private ReadOnlyCollection<IncludeTreeNode> LookupRelationshipName(string relationshipName, IReadOnlyCollection<IncludeTreeNode> parents, int position)
     {
         List<IncludeTreeNode> children = [];
         HashSet<RelationshipAttribute> relationshipsFound = [];
@@ -135,7 +133,7 @@ private static ReadOnlyCollection<IncludeTreeNode> LookupRelationshipName(string
         }
 
         AssertRelationshipsFound(relationshipsFound, relationshipName, parents, position);
-        AssertAtLeastOneCanBeIncluded(relationshipsFound, relationshipName, source, position);
+        AssertAtLeastOneCanBeIncluded(relationshipsFound, relationshipName, position);
 
         return children.AsReadOnly();
     }
@@ -201,15 +199,15 @@ private static string GetErrorMessageForNoneFound(string relationshipName, Resou
         return builder.ToString();
     }
 
-    private static void AssertAtLeastOneCanBeIncluded(HashSet<RelationshipAttribute> relationshipsFound, string relationshipName, string source, int position)
+    private void AssertAtLeastOneCanBeIncluded(HashSet<RelationshipAttribute> relationshipsFound, string relationshipName, int position)
     {
         if (relationshipsFound.All(relationship => relationship.IsIncludeBlocked()))
         {
             ResourceType resourceType = relationshipsFound.First().LeftType;
             string message = $"Including the relationship '{relationshipName}' on '{resourceType}' is not allowed.";
 
             var exception = new QueryParseException(message, position);
-            string specificMessage = exception.GetMessageWithPosition(source);
+            string specificMessage = exception.GetMessageWithPosition(Source);
 
             throw new InvalidQueryStringParameterException("include", "The specified include is invalid.", specificMessage);
         }

src/JsonApiDotNetCore/Queries/Parsing/QueryExpressionParser.cs

@@ -18,8 +18,6 @@ namespace JsonApiDotNetCore.Queries.Parsing;
 [PublicAPI]
 public abstract class QueryExpressionParser
 {
-    private int _endOfSourcePosition;
-
     /// <summary>
     /// Contains the tokens produced from the source text, after <see cref="Tokenize" /> has been called.
     /// </summary>
@@ -28,6 +26,11 @@ public abstract class QueryExpressionParser
     /// </remarks>
     protected Stack<Token> TokenStack { get; private set; } = new();
 
+    /// <summary>
+    /// Contains the source text that tokens were produced from, after <see cref="Tokenize" /> has been called.
+    /// </summary>
+    protected string Source { get; private set; } = string.Empty;
+
     /// <summary>
     /// Enables derived types to throw a <see cref="QueryParseException" /> when usage of a JSON:API field inside a field chain is not permitted.
     /// </summary>
@@ -45,9 +48,10 @@ protected virtual void Tokenize(string source)
     {
         ArgumentNullException.ThrowIfNull(source);
 
+        Source = source;
+
         var tokenizer = new QueryTokenizer(source);
         TokenStack = new Stack<Token>(tokenizer.EnumerateTokens().Reverse());
-        _endOfSourcePosition = source.Length;
     }
 
     /// <summary>
@@ -154,7 +158,7 @@ protected int GetNextTokenPositionOrEnd()
             return nextToken.Position;
         }
 
-        return _endOfSourcePosition;
+        return Source.Length;
     }
 
     /// <summary>