Fixes #1161: Enable Parameter alias for collection value

xuzhg · xuzhg · commit 5da0f2dbc737 · 2026-01-13T15:41:49.000-08:00
Related the parameter alias to collection value node, not only the single value node,
diff --git a/src/Microsoft.OData.Core/PublicAPI/net10.0/PublicAPI.Shipped.txt b/src/Microsoft.OData.Core/PublicAPI/net10.0/PublicAPI.Shipped.txt
@@ -1091,7 +1091,7 @@ Microsoft.OData.ODataUri.Index.set -> void
 Microsoft.OData.ODataUri.ODataUri() -> void
 Microsoft.OData.ODataUri.OrderBy.get -> Microsoft.OData.UriParser.OrderByClause
 Microsoft.OData.ODataUri.OrderBy.set -> void
-Microsoft.OData.ODataUri.ParameterAliasNodes.get -> System.Collections.Generic.IDictionary<string, Microsoft.OData.UriParser.SingleValueNode>
+Microsoft.OData.ODataUri.ParameterAliasNodes.get -> System.Collections.Generic.IDictionary<string, Microsoft.OData.UriParser.QueryNode>
 Microsoft.OData.ODataUri.Path.get -> Microsoft.OData.UriParser.ODataPath
 Microsoft.OData.ODataUri.Path.set -> void
 Microsoft.OData.ODataUri.QueryCount.get -> bool?
@@ -1568,7 +1568,7 @@ Microsoft.OData.UriParser.ODataQueryOptionParser.ODataQueryOptionParser(Microsof
 Microsoft.OData.UriParser.ODataQueryOptionParser.ODataQueryOptionParser(Microsoft.OData.Edm.IEdmModel model, Microsoft.OData.Edm.IEdmType targetEdmType, Microsoft.OData.Edm.IEdmNavigationSource targetNavigationSource, System.Collections.Generic.IDictionary<string, string> queryOptions, System.IServiceProvider container) -> void
 Microsoft.OData.UriParser.ODataQueryOptionParser.ODataQueryOptionParser(Microsoft.OData.Edm.IEdmModel model, Microsoft.OData.UriParser.ODataPath odataPath, System.Collections.Generic.IDictionary<string, string> queryOptions) -> void
 Microsoft.OData.UriParser.ODataQueryOptionParser.ODataQueryOptionParser(Microsoft.OData.Edm.IEdmModel model, Microsoft.OData.UriParser.ODataPath odataPath, System.Collections.Generic.IDictionary<string, string> queryOptions, System.IServiceProvider container) -> void
-Microsoft.OData.UriParser.ODataQueryOptionParser.ParameterAliasNodes.get -> System.Collections.Generic.IDictionary<string, Microsoft.OData.UriParser.SingleValueNode>
+Microsoft.OData.UriParser.ODataQueryOptionParser.ParameterAliasNodes.get -> System.Collections.Generic.IDictionary<string, Microsoft.OData.UriParser.QueryNode>
 Microsoft.OData.UriParser.ODataQueryOptionParser.ParseApply() -> Microsoft.OData.UriParser.Aggregation.ApplyClause
 Microsoft.OData.UriParser.ODataQueryOptionParser.ParseCompute() -> Microsoft.OData.UriParser.ComputeClause
 Microsoft.OData.UriParser.ODataQueryOptionParser.ParseCount() -> bool?
@@ -1615,7 +1615,7 @@ Microsoft.OData.UriParser.ODataUriParser.ODataUriParser(Microsoft.OData.Edm.IEdm
 Microsoft.OData.UriParser.ODataUriParser.ODataUriParser(Microsoft.OData.Edm.IEdmModel model, System.Uri relativeUri, System.IServiceProvider container) -> void
 Microsoft.OData.UriParser.ODataUriParser.ODataUriParser(Microsoft.OData.Edm.IEdmModel model, System.Uri serviceRoot, System.Uri uri) -> void
 Microsoft.OData.UriParser.ODataUriParser.ODataUriParser(Microsoft.OData.Edm.IEdmModel model, System.Uri serviceRoot, System.Uri uri, System.IServiceProvider container) -> void
-Microsoft.OData.UriParser.ODataUriParser.ParameterAliasNodes.get -> System.Collections.Generic.IDictionary<string, Microsoft.OData.UriParser.SingleValueNode>
+Microsoft.OData.UriParser.ODataUriParser.ParameterAliasNodes.get -> System.Collections.Generic.IDictionary<string, Microsoft.OData.UriParser.QueryNode>
 Microsoft.OData.UriParser.ODataUriParser.ParseApply() -> Microsoft.OData.UriParser.Aggregation.ApplyClause
 Microsoft.OData.UriParser.ODataUriParser.ParseCompute() -> Microsoft.OData.UriParser.ComputeClause
 Microsoft.OData.UriParser.ODataUriParser.ParseCount() -> bool?
diff --git a/src/Microsoft.OData.Core/PublicAPI/net10.0/PublicAPI.Unshipped.txt b/src/Microsoft.OData.Core/PublicAPI/net10.0/PublicAPI.Unshipped.txt
@@ -1,3 +1,10 @@
 Microsoft.OData.ODataNestedResourceInfo.InstanceAnnotations.get -> System.Collections.Generic.ICollection<Microsoft.OData.ODataInstanceAnnotation>
 Microsoft.OData.ODataNestedResourceInfo.InstanceAnnotations.set -> void
 Microsoft.OData.ValidationKinds.ThrowOnUnexpectedODataPropertyAnnotationOnNavigationProperty = 8 -> Microsoft.OData.ValidationKinds
+Microsoft.OData.UriParser.ParameterAliasCollectionNode
+Microsoft.OData.UriParser.ParameterAliasCollectionNode.Alias.get -> string
+Microsoft.OData.UriParser.ParameterAliasCollectionNode.ParameterAliasCollectionNode(string alias, Microsoft.OData.Edm.IEdmCollectionTypeReference collectionType) -> void
+override Microsoft.OData.UriParser.ParameterAliasCollectionNode.Accept<T>(Microsoft.OData.UriParser.QueryNodeVisitor<T> visitor) -> T
+override Microsoft.OData.UriParser.ParameterAliasCollectionNode.CollectionType.get -> Microsoft.OData.Edm.IEdmCollectionTypeReference
+override Microsoft.OData.UriParser.ParameterAliasCollectionNode.ItemType.get -> Microsoft.OData.Edm.IEdmTypeReference
+virtual Microsoft.OData.UriParser.QueryNodeVisitor<T>.Visit(Microsoft.OData.UriParser.ParameterAliasCollectionNode nodeIn) -> T
diff --git a/src/Microsoft.OData.Core/Uri/NodeToStringBuilder.cs b/src/Microsoft.OData.Core/Uri/NodeToStringBuilder.cs
@@ -397,6 +397,17 @@ public override String Visit(ParameterAliasNode node)
             return node.Alias;
         }
 
+        /// <summary>
+        /// Translates a <see cref="ParameterAliasCollectionNode"/> into a corresponding <see cref="String"/>.
+        /// </summary>
+        /// <param name="node">The node to translate.</param>
+        /// <returns>The translated String.</returns>
+        public override String Visit(ParameterAliasCollectionNode node)
+        {
+            ExceptionUtils.CheckArgumentNotNull(node, "node");
+            return node.Alias;
+        }
+
         /// <summary>
         /// Translates a <see cref="NamedFunctionParameterNode"/> into a corresponding <see cref="String"/>.
         /// </summary>
@@ -570,12 +581,12 @@ internal string TranslateComputeClause(ComputeClause computeClause)
         /// </summary>
         /// <param name="dictionary">Dictionary</param>
         /// <returns>The url query string of dictionary's key value pairs (URL encoded)</returns>
-        internal String TranslateParameterAliasNodes(IDictionary<string, SingleValueNode> dictionary)
+        internal String TranslateParameterAliasNodes(IDictionary<string, QueryNode> dictionary)
         {
             String result = null;
             if (dictionary != null)
             {
-                foreach (KeyValuePair<string, SingleValueNode> keyValuePair in dictionary)
+                foreach (KeyValuePair<string, QueryNode> keyValuePair in dictionary)
                 {
                     if (keyValuePair.Value != null)
                     {
diff --git a/src/Microsoft.OData.Core/Uri/ODataUri.cs b/src/Microsoft.OData.Core/Uri/ODataUri.cs
@@ -124,7 +124,7 @@ public Uri ServiceRoot
         /// <summary>
         /// Get the parameter alias nodes info.
         /// </summary>
-        public IDictionary<string, SingleValueNode> ParameterAliasNodes
+        public IDictionary<string, QueryNode> ParameterAliasNodes
         {
             get
             {
diff --git a/src/Microsoft.OData.Core/Uri/ODataUriSlim.cs b/src/Microsoft.OData.Core/Uri/ODataUriSlim.cs
@@ -69,7 +69,7 @@ public ODataUriSlim(ODataUriSlim odataUriSlim)
         /// <summary>
         /// Get the parameter alias nodes info.
         /// </summary>
-        public IDictionary<string, SingleValueNode> ParameterAliasNodes => this.odataUri.ParameterAliasNodes;
+        public IDictionary<string, QueryNode> ParameterAliasNodes => this.odataUri.ParameterAliasNodes;
 
         /// <summary>
         /// Gets any custom query options for this uri.
diff --git a/src/Microsoft.OData.Core/UriParser/Binders/MetadataBinder.cs b/src/Microsoft.OData.Core/UriParser/Binders/MetadataBinder.cs
@@ -224,7 +224,7 @@ protected internal QueryNode Bind(QueryToken token)
         /// </summary>
         /// <param name="functionParameterAliasToken">The alias syntactics token.</param>
         /// <returns>The semantics node for parameter alias.</returns>
-        protected virtual SingleValueNode BindParameterAlias(FunctionParameterAliasToken functionParameterAliasToken)
+        protected virtual QueryNode BindParameterAlias(FunctionParameterAliasToken functionParameterAliasToken)
         {
             ParameterAliasBinder binder = new ParameterAliasBinder(this.Bind);
             return binder.BindParameterAlias(this.BindingState, functionParameterAliasToken);
diff --git a/src/Microsoft.OData.Core/UriParser/Binders/ParameterAliasBinder.cs b/src/Microsoft.OData.Core/UriParser/Binders/ParameterAliasBinder.cs
@@ -6,7 +6,6 @@
 
 using Microsoft.OData.Metadata;
 using Microsoft.OData.Edm;
-using Microsoft.OData.Core;
 
 namespace Microsoft.OData.UriParser
 {
@@ -38,7 +37,7 @@ internal ParameterAliasBinder(MetadataBinder.QueryTokenVisitor bindMethod)
         /// <param name="bindingState">The alias name which is inside another alias value.</param>
         /// <param name="aliasToken">The cache of alias value nodes</param>
         /// <returns>The semantics node tree for alias (the @p1 in "@p1=...", not alias value expression)</returns>
-        internal ParameterAliasNode BindParameterAlias(BindingState bindingState, FunctionParameterAliasToken aliasToken)
+        internal QueryNode BindParameterAlias(BindingState bindingState, FunctionParameterAliasToken aliasToken)
         {
             ExceptionUtils.CheckArgumentNotNull(bindingState, "bindingState");
             ExceptionUtils.CheckArgumentNotNull(aliasToken, "aliasToken");
@@ -51,7 +50,7 @@ internal ParameterAliasNode BindParameterAlias(BindingState bindingState, Functi
             }
 
             // in cache?
-            SingleValueNode aliasValueNode = null;
+            QueryNode aliasValueNode = null;
             if (!aliasValueAccessor.ParameterAliasValueNodesCached.TryGetValue(alias, out aliasValueNode))
             {
                 // has value expression?
@@ -67,6 +66,11 @@ internal ParameterAliasNode BindParameterAlias(BindingState bindingState, Functi
                 }
             }
 
+            if (aliasValueNode is CollectionNode collectionNode)
+            {
+                return new ParameterAliasCollectionNode(alias, collectionNode.CollectionType);
+            }
+
             return new ParameterAliasNode(alias, aliasValueNode.GetEdmTypeReference());
         }
 
@@ -77,7 +81,7 @@ internal ParameterAliasNode BindParameterAlias(BindingState bindingState, Functi
         /// <param name="aliasValueExpression">The alias value's expression text.</param>
         /// <param name="parameterType">The edm type of the parameter.</param>
         /// <returns>The semantics node of the expression text.</returns>
-        private SingleValueNode ParseAndBindParameterAliasValueExpression(BindingState bindingState, string aliasValueExpression, IEdmTypeReference parameterType)
+        private QueryNode ParseAndBindParameterAliasValueExpression(BindingState bindingState, string aliasValueExpression, IEdmTypeReference parameterType)
         {
             // Get the syntactic representation of the filter expression
             // TODO: change Settings.FilterLimit to ParameterAliasValueLimit
@@ -87,16 +91,8 @@ private SingleValueNode ParseAndBindParameterAliasValueExpression(BindingState b
             // Special logic to handle parameter alias token.
             aliasValueToken = ParseComplexOrCollectionAlias(aliasValueToken, parameterType, bindingState.Model);
 
-            // Get the semantic node, and check for SingleValueNode
-            QueryNode aliasValueNode = this.bindMethod(aliasValueToken);
-            SingleValueNode result = aliasValueNode as SingleValueNode;
-            if (result == null)
-            {
-                // TODO: add string resource
-                throw new ODataException(SRResources.MetadataBinder_ParameterAliasValueExpressionNotSingleValue);
-            }
-
-            return result;
+            // Get the semantic node, it should support single and collection value node.
+            return this.bindMethod(aliasValueToken);
         }
 
         /// <summary>
diff --git a/src/Microsoft.OData.Core/UriParser/ODataQueryOptionParser.cs b/src/Microsoft.OData.Core/UriParser/ODataQueryOptionParser.cs
@@ -137,7 +137,7 @@ public ODataUriParserSettings Settings
         /// <summary>
         /// Get the parameter alias nodes info.
         /// </summary>
-        public IDictionary<string, SingleValueNode> ParameterAliasNodes
+        public IDictionary<string, QueryNode> ParameterAliasNodes
         {
             get { return this.Configuration.ParameterAliasValueAccessor.ParameterAliasValueNodesCached; }
         }
diff --git a/src/Microsoft.OData.Core/UriParser/ODataUriParser.cs b/src/Microsoft.OData.Core/UriParser/ODataUriParser.cs
@@ -214,7 +214,7 @@ public ParseDynamicPathSegment ParseDynamicPathSegmentFunc
         /// <summary>
         /// Get the parameter alias nodes info.
         /// </summary>
-        public IDictionary<string, SingleValueNode> ParameterAliasNodes
+        public IDictionary<string, QueryNode> ParameterAliasNodes
         {
             get
             {
diff --git a/src/Microsoft.OData.Core/UriParser/SemanticAst/ParameterAliasCollectionNode.cs b/src/Microsoft.OData.Core/UriParser/SemanticAst/ParameterAliasCollectionNode.cs
@@ -0,0 +1,62 @@
+﻿//---------------------------------------------------------------------
+// <copyright file="ParameterAliasCollectionNode.cs" company="Microsoft">
+//      Copyright (C) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
+// </copyright>
+//---------------------------------------------------------------------
+
+namespace Microsoft.OData.UriParser
+{
+    using Microsoft.OData.Edm;
+
+    /// <summary>
+    /// Represents a parameter alias that refers to a collection value.
+    /// </summary>
+    public class ParameterAliasCollectionNode : CollectionNode
+    {
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        /// <param name="alias">The parameter alias.</param>
+        /// <param name="collectionType">The alias' type which is inferred from the type of alias value's CollectionNode.</param>
+        public ParameterAliasCollectionNode(string alias, IEdmCollectionTypeReference collectionType)
+        {
+            ExceptionUtils.CheckArgumentNotNull(collectionType, "collectionType");
+
+            Alias = alias;
+            CollectionType = collectionType;
+        }
+
+        /// <summary>
+        /// The parameter alias.
+        /// </summary>
+        public string Alias { get; }
+
+        /// <summary>
+        /// Gets the type of a single item from the collection represented by this node.
+        /// </summary>
+        public override IEdmTypeReference ItemType => CollectionType.ElementType();
+
+        /// <summary>
+        /// The type of the collection represented by this node.
+        /// </summary>
+        public override IEdmCollectionTypeReference CollectionType { get; }
+
+        /// <summary>
+        /// Is InternalQueryNodeKind.ParameterAliasCollection.
+        /// </summary>
+        internal override InternalQueryNodeKind InternalKind => InternalQueryNodeKind.ParameterAliasCollection;
+
+        /// <summary>
+        /// Accept a <see cref="QueryNodeVisitor{T}"/> to walk a tree of <see cref="QueryNode"/>s.
+        /// </summary>
+        /// <typeparam name="T">Type that the visitor will return after visiting this token.</typeparam>
+        /// <param name="visitor">An implementation of the visitor interface.</param>
+        /// <returns>An object whose type is determined by the type parameter of the visitor.</returns>
+        /// <exception cref="System.ArgumentNullException">Throws if the input visitor is null.</exception>
+        public override T Accept<T>(QueryNodeVisitor<T> visitor)
+        {
+            ExceptionUtils.CheckArgumentNotNull(visitor, "visitor");
+            return visitor.Visit(this);
+        }
+    }
+}
diff --git a/src/Microsoft.OData.Core/UriParser/SemanticAst/ParameterAliasValueAccessor.cs b/src/Microsoft.OData.Core/UriParser/SemanticAst/ParameterAliasValueAccessor.cs
@@ -22,14 +22,14 @@ public ParameterAliasValueAccessor(IDictionary<string, string> parameterAliasVal
         {
             ExceptionUtils.CheckArgumentNotNull(parameterAliasValueExpressions, "parameterAliasValueExpressions");
             this.ParameterAliasValueExpressions = new Dictionary<string, string>(parameterAliasValueExpressions, StringComparer.Ordinal);
-            this.ParameterAliasValueNodesCached = new Dictionary<string, SingleValueNode>(StringComparer.Ordinal);
+            this.ParameterAliasValueNodesCached = new Dictionary<string, QueryNode>(StringComparer.Ordinal);
         }
 
         /// <summary>
         /// Gets the up-to-now cached semantics nodes of parameter alias value expressions (StringComparer.Ordinal)
         /// Only referenced parameter alias will have their value nodes cached.
         /// </summary>
-        public IDictionary<string, SingleValueNode> ParameterAliasValueNodesCached { get; private set; }
+        public IDictionary<string, QueryNode> ParameterAliasValueNodesCached { get; private set; }
 
         /// <summary>
         /// Gets the parameter alias's value expressions like @p1=... (StringComparer.Ordinal)
diff --git a/src/Microsoft.OData.Core/UriParser/TreeNodeKinds/QueryNodeKind.cs b/src/Microsoft.OData.Core/UriParser/TreeNodeKinds/QueryNodeKind.cs
@@ -379,5 +379,10 @@ internal enum InternalQueryNodeKind
         /// Node that represents a custom query option
         /// </summary>
         CustomQueryOption = 35,
+
+        /// <summary>
+        /// The parameter alias node to collection.
+        /// </summary>
+        ParameterAliasCollection = 36,
     }
 }
diff --git a/src/Microsoft.OData.Core/UriParser/Visitors/QueryNodeVisitor.cs b/src/Microsoft.OData.Core/UriParser/Visitors/QueryNodeVisitor.cs
@@ -254,6 +254,16 @@ public virtual T Visit(ParameterAliasNode nodeIn)
             throw new NotImplementedException();
         }
 
+        /// <summary>
+        /// Visit a ParameterAliasCollectionNode
+        /// </summary>
+        /// <param name="nodeIn">The node to visit</param>
+        /// <returns>The translated expression</returns>
+        public virtual T Visit(ParameterAliasCollectionNode nodeIn)
+        {
+            throw new NotImplementedException();
+        }
+
         /// <summary>
         /// Visit a SearchTermNode
         /// </summary>
diff --git a/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriBuilder/UrlBuilderWithParameterAliasTests.cs b/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriBuilder/UrlBuilderWithParameterAliasTests.cs
diff --git a/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/FullUriFunctionalTests.cs b/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/FullUriFunctionalTests.cs
diff --git a/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/ParameterAliasFunctionalTests.cs b/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/ParameterAliasFunctionalTests.cs
diff --git a/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/SetBasedOperationTests.cs b/test/UnitTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/SetBasedOperationTests.cs
diff --git a/test/UnitTests/Microsoft.OData.Core.Tests/UriParser/NodeAssertions.cs b/test/UnitTests/Microsoft.OData.Core.Tests/UriParser/NodeAssertions.cs

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ public Uri ServiceRoot`
`124`	`124`	`/// <summary>`
`125`	`125`	`/// Get the parameter alias nodes info.`
`126`	`126`	`/// </summary>`
`127`		`- public IDictionary<string, SingleValueNode> ParameterAliasNodes`
	`127`	`+ public IDictionary<string, QueryNode> ParameterAliasNodes`
`128`	`128`	`{`
`129`	`129`	`get`
`130`	`130`	`{`
Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,7 @@ protected internal QueryNode Bind(QueryToken token)`
`224`	`224`	`/// </summary>`
`225`	`225`	`/// <param name="functionParameterAliasToken">The alias syntactics token.</param>`
`226`	`226`	`/// <returns>The semantics node for parameter alias.</returns>`
`227`		`- protected virtual SingleValueNode BindParameterAlias(FunctionParameterAliasToken functionParameterAliasToken)`
	`227`	`+ protected virtual QueryNode BindParameterAlias(FunctionParameterAliasToken functionParameterAliasToken)`
`228`	`228`	`{`
`229`	`229`	`ParameterAliasBinder binder = new ParameterAliasBinder(this.Bind);`
`230`	`230`	`return binder.BindParameterAlias(this.BindingState, functionParameterAliasToken);`
Original file line number	Diff line number	Diff line change
`@@ -137,7 +137,7 @@ public ODataUriParserSettings Settings`
`137`	`137`	`/// <summary>`
`138`	`138`	`/// Get the parameter alias nodes info.`
`139`	`139`	`/// </summary>`
`140`		`- public IDictionary<string, SingleValueNode> ParameterAliasNodes`
	`140`	`+ public IDictionary<string, QueryNode> ParameterAliasNodes`
`141`	`141`	`{`
`142`	`142`	`get { return this.Configuration.ParameterAliasValueAccessor.ParameterAliasValueNodesCached; }`
`143`	`143`	`}`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ public ParseDynamicPathSegment ParseDynamicPathSegmentFunc`
`214`	`214`	`/// <summary>`
`215`	`215`	`/// Get the parameter alias nodes info.`
`216`	`216`	`/// </summary>`
`217`		`- public IDictionary<string, SingleValueNode> ParameterAliasNodes`
	`217`	`+ public IDictionary<string, QueryNode> ParameterAliasNodes`
`218`	`218`	`{`
`219`	`219`	`get`
`220`	`220`	`{`