Fixes #2754, enable key in parenthesis after composable function with parameters #2757

xuzhg · 2023-10-03T22:30:22Z

… parameters

Issues

This pull request fixes #2754.

Description

Briefly describe the changes of this pull request.

Checklist (Uncheck if it is not completed)

Test cases added
Build and test with one-click build and test script passed

Additional work necessary

If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.

… parameters

pull-request-quantifier-deprecated · 2023-10-03T22:50:51Z

This PR has 102 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Medium
Size       : +91 -11
Percentile : 40.4%

Total files changed: 6

Change summary by file extension:
.cs : +91 -11

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

gathogojr · 2023-10-04T04:37:19Z

src/Microsoft.OData.Core/UriParser/Parsers/FunctionParameterParser.cs

+
+            Stack<ExpressionTokenKind> stack = new Stack<ExpressionTokenKind>();
+            stack.Push(ExpressionTokenKind.OpenParen);
+            ExpressionLexer lexer = new ExpressionLexer(parenthesisExpression, true /*moveToFirstToken*/, false /*useSemicolonDelimiter*/, true /*parsingFunctionParameters*/);


Named parameters would be neater...

gathogojr · 2023-10-04T04:37:54Z

src/Microsoft.OData.Core/UriParser/Parsers/FunctionParameterParser.cs

+            Stack<ExpressionTokenKind> stack = new Stack<ExpressionTokenKind>();
+            stack.Push(ExpressionTokenKind.OpenParen);
+            ExpressionLexer lexer = new ExpressionLexer(parenthesisExpression, true /*moveToFirstToken*/, false /*useSemicolonDelimiter*/, true /*parsingFunctionParameters*/);
+            bool paramertersFound = false;


nit:

Suggested change

bool paramertersFound = false;

bool parametersFound = false;

gathogojr · 2023-10-04T04:42:22Z

src/Microsoft.OData.Core/UriParser/Parsers/ODataPathParser.cs

@@ -1072,7 +1077,14 @@ private bool TryCreateSegmentForOperationImport(string identifier, string parent

            this.parsedSegments.Add(segment);

-            this.TryBindKeySegmentIfNoResolvedParametersAndParenthesisValueExists(parenthesisExpression, returnType, resolvedParameters, segment);
+            // Be noted, it's back-compatibile since the function can be called without parameters but with keys
+            // for example: "~/GetCoolPeople(1)", where '1' is the key, not the parameters.


We know that "1" is a key and not a parameter because it's not named, no?

gathogojr · 2023-10-04T04:59:20Z

...FunctionalTests/Microsoft.OData.Core.Tests/UriParser/Parsers/FunctionParameterParserTests.cs

+        [InlineData("degree=1)('fawn'", "degree=1", "'fawn'")]
+        public void SplitOperationParametersAndParenthesisKey_WorksForInputExpression(string expression, string parameters, string keys)
+        {
+            FunctionParameterParser.SplitOperationParametersAndParenthesisKey(expression, out string acutalParams, out string actualKeys);


nit:

Suggested change

FunctionParameterParser.SplitOperationParametersAndParenthesisKey(expression, out string acutalParams, out string actualKeys);

FunctionParameterParser.SplitOperationParametersAndParenthesisKey(expression, out string actualParams, out string actualKeys);

gathogojr · 2023-10-04T05:06:13Z

src/Microsoft.OData.Core/UriParser/Parsers/FunctionParameterParser.cs

+        /// <summary>
+        /// Splits the parenthesis expression into two parts (if apply)
+        /// One is the function parameter, the other is key in parenthesis (if exists)
+        /// Be noted, the input expression doesn't contain the beginning "(" and the ending ")"


Maybe this should be a <remark>...

gathogojr · 2023-10-04T05:16:43Z

...FunctionalTests/Microsoft.OData.Core.Tests/UriParser/Parsers/FunctionParameterParserTests.cs

@@ -21,6 +21,19 @@ namespace Microsoft.OData.Tests.UriParser.Parsers
    /// </summary>
    public class FunctionParameterParserTests
    {
+        [Theory]
+        [InlineData("1", "1", null)]


Is this a scenario where the function is being called with one parameter without specifying the name?

gathogojr · 2023-10-04T05:21:20Z

src/Microsoft.OData.Core/UriParser/Parsers/FunctionParameterParser.cs

+        /// <param name="parenthesisKey">the output for key in parenthesis part</param>
+        internal static void SplitOperationParametersAndParenthesisKey(string parenthesisExpression, out string parameters, out string parenthesisKey)
+        {
+            // Be noted, the input expression doesn't contain the first '(' and last ')'.


Should we have a sanity check to confirm that the input expression does not containe the beginning "(" and the ending ")"?

gathogojr · 2023-10-04T05:28:00Z

...FunctionalTests/Microsoft.OData.Core.Tests/UriParser/Parsers/FunctionParameterParserTests.cs

+        [InlineData(")(1", "", "1")]
+        [InlineData("person=People(1)", "person=People(1)", null)]
+        [InlineData("person=People(1))('bca(aa('", "person=People(1)", "'bca(aa('")]
+        [InlineData("degree=1)('fawn'", "degree=1", "'fawn'")]


Can you add the "" scenario? No parameters and no keys, i.e. fn()

gathogojr · 2023-10-04T05:31:37Z

...FunctionalTests/Microsoft.OData.Core.Tests/UriParser/Parsers/FunctionParameterParserTests.cs

+            Assert.Equal(parameters, acutalParams);
+            Assert.Equal(keys, actualKeys);
+        }
+


Add a test for the scenario where the ODataException(ODataErrorStrings.ExpressionLexer_SyntaxError(currentToken.Position, parenthesisExpression)); is thrown

gathogojr · 2023-10-04T05:34:03Z

src/Microsoft.OData.Core/UriParser/Parsers/ODataPathParser.cs

@@ -1072,7 +1077,14 @@ private bool TryCreateSegmentForOperationImport(string identifier, string parent

            this.parsedSegments.Add(segment);

-            this.TryBindKeySegmentIfNoResolvedParametersAndParenthesisValueExists(parenthesisExpression, returnType, resolvedParameters, segment);
+            // Be noted, it's back-compatibile since the function can be called without parameters but with keys
+            // for example: "~/GetCoolPeople(1)", where '1' is the key, not the parameters.


How do we know (1) represents the key and not the parameters?

Fixes #2754, enable key in parenthesis after composable function with…

c31d683

… parameters

xuzhg requested review from KenitoInc, habbes, mikepizzo, ElizabethOkerio and gathogojr October 3, 2023 22:30

xuzhg marked this pull request as ready for review October 3, 2023 22:30

pull-request-quantifier-deprecated bot added the Medium label Oct 3, 2023

gathogojr reviewed Oct 4, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #2754, enable key in parenthesis after composable function with parameters #2757

Fixes #2754, enable key in parenthesis after composable function with parameters #2757

xuzhg commented Oct 3, 2023

pull-request-quantifier-deprecated bot commented Oct 3, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

gathogojr Oct 4, 2023

	FunctionParameterParser.SplitOperationParametersAndParenthesisKey(expression, out string acutalParams, out string actualKeys);
	FunctionParameterParser.SplitOperationParametersAndParenthesisKey(expression, out string actualParams, out string actualKeys);

Fixes #2754, enable key in parenthesis after composable function with parameters #2757

Are you sure you want to change the base?

Fixes #2754, enable key in parenthesis after composable function with parameters #2757

Conversation

xuzhg commented Oct 3, 2023

Issues

Description

Checklist (Uncheck if it is not completed)

Additional work necessary

pull-request-quantifier-deprecated bot commented Oct 3, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment