Fixes #2794: Enable $root path #3157
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5.1.1.14.5 $root
The $root literal can be used in expressions to refer to resources of the same service. It can be used as a single-valued expression or within complex or collection literals.
Example 108: all employees with the same last name as employee A1235
http://host/service/Employees?$filter=LastName eq $root/Employees('A1245')/LastName
Example 109: products ordered by a set of customers, where the set of customers is passed as a JSON array containing the resource paths from $root to each customer.
http://host/service/ProductsOrderedBy(Customers=@c)?@c=[$root/Customers('ALFKI'),$root/Customers('BLAUS')]
xuzhg
requested review from
Copilot,
habbes,
mikepizzo,
WanjohiSammy and
gathogojr
There was a problem hiding this comment.
Copilot reviewed 5 out of 16 changed files in this pull request and generated 2 comments.
Files not reviewed (11)
- src/Microsoft.OData.Client/Microsoft.OData.Client.csproj: Language not supported
- src/Microsoft.OData.Client/PublicAPI/net8.0/PublicAPI.Unshipped.txt: Language not supported
- src/Microsoft.OData.Core/PublicAPI/net8.0/PublicAPI.Unshipped.txt: Language not supported
- src/Microsoft.OData.Core/UriParser/Visitors/ISyntacticTreeVisitor.cs: Evaluated as low risk
- src/Microsoft.OData.Core/UriParser/SyntacticAst/QueryTokenKind.cs: Evaluated as low risk
- src/Microsoft.OData.Core/UriParser/SyntacticAst/RootPathToken.cs: Evaluated as low risk
- src/Microsoft.OData.Core/UriParser/TreeNodeKinds/QueryNodeKind.cs: Evaluated as low risk
- src/Microsoft.OData.Core/UriParser/Visitors/QueryNodeVisitor.cs: Evaluated as low risk
- src/Microsoft.OData.Core/UriParser/Visitors/SyntacticTreeVisitor.cs: Evaluated as low risk
- test/FunctionalTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/FilterAndOrderByFunctionalTests.cs: Evaluated as low risk
- test/FunctionalTests/Microsoft.OData.Core.Tests/ScenarioTests/UriParser/ParameterAliasFunctionalTests.cs: Evaluated as low risk
| @@ -1064,6 +1064,12 @@ private QueryToken ParsePrimary() | |||
| expr = this.ParsePrimaryStart(); | |||
| } | |||
|
|
|||
| // Pase the $root path, for example: '$root/people(12)' | |||
There was a problem hiding this comment.
The comment contains a typo: 'Pase' should be 'Parse'.
Suggested change
| // Pase the $root path, for example: '$root/people(12)' | |
| // Parse the $root path, for example: '$root/people(12)' |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
| ODataPathSegment lastSegment = path.LastSegment; | ||
| if (lastSegment == null) | ||
| { | ||
| throw new ODataException("Empty root path is not valid."); |
There was a problem hiding this comment.
The error message should be 'An empty root path is not valid.'
Suggested change
| throw new ODataException("Empty root path is not valid."); | |
| throw new ODataException("An empty root path is not valid."); |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
| ODataPathSegment lastSegment = path.LastSegment; | ||
| if (lastSegment == null) | ||
| { | ||
| throw new ODataException("Empty root path is not valid."); |
There was a problem hiding this comment.
You can move this string to SRResources
| // The $root literal can be used in expressions to refer to resources of the same service. It can be used as a single-valued expression or within complex or collection literals. | ||
| if (!lastSegment.SingleResult) | ||
| { | ||
| throw new ODataException("The $root literal can be used in expressions to refer to resources of the same service. It can be used as a single-valued expression or within complex or collection literals."); |
There was a problem hiding this comment.
Same apply here. Move this string to SRResources
| { | ||
| ReadOnlySpan<char> dotIdentifier = this.lexer.ReadDottedIdentifier(false); | ||
| rootPathToken.Segments.Add(dotIdentifier.ToString()); | ||
| //lexer.NextToken(); |
There was a problem hiding this comment.
Should this be uncommented or you can add a comment on the top to explain why it is commented out.
| { | ||
| if (parent != null) | ||
| { | ||
| throw new ODataException("$root should be the top-level segment"); |
| @@ -0,0 +1,40 @@ | |||
| //--------------------------------------------------------------------- | |||
| // <copyright file="EndPathToken.cs" company="Microsoft"> | |||
There was a problem hiding this comment.
Should this be RootPathToken.cs instead of EndPathToken.cs
Suggested change
| // <copyright file="EndPathToken.cs" company="Microsoft"> | |
| // <copyright file="RootPathToken.cs" company="Microsoft"> | |
| IEdmTypeReference typeReference = lastSegment.EdmType == null ? null : lastSegment.EdmType.ToTypeReference(true); | ||
| return new RootPathNode(path, typeReference); | ||
|
|
||
| // Keep them for discussion, will remove after discussion. |
There was a problem hiding this comment.
Do you want to create an issue on Github to start the discussion around this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2794: Enable $root path
5.1.1.14.5 $root
The $root literal can be used in expressions to refer to resources of the same service. It can be used as a single-valued expression or within complex or collection literals.
Example 108: all employees with the same last name as employee A1235
http://host/service/Employees?$filter=LastName eq $root/Employees('A1245')/LastName
Example 109: products ordered by a set of customers, where the set of customers is passed as a JSON array containing the resource paths from $root to each customer.
http://host/service/ProductsOrderedBy(Customers=@c)?@c=[$root/Customers('ALFKI'),$root/Customers('BLAUS')]