Fix ArgumentException in ProjectPlanCompiler caused by missing materializerContext argument in dynamic calls #2535

habbes · 2022-10-21T13:53:07Z

Issues

*This pull request fixes #2531

Description

The ProjectionPlanCompiler and GroupByProjectionCompiler class call methods of the ODataEntityMaterializerInvoker dynamically using reflection/dynamic IL generation. Since the PR that refactored the MaterializerCache, many materializer static methods needed to adjusted to accept an IODataMaterializerContext as input. 2 methods in ProjectionPlanCompiler expect a materializer context as the last argument: ProjectionCheckValueForPathIsNull and ProjectionDynamicValueForPath. ProjectionPlanCompiler calls both methods, but did not pass the materializer context to the ProjectionCheckValueForPathIsNull. There was not test covering this method, so we didn't notice. This method is called when there's a conditional check against a nested navigation property in the LINQ query. I've added a test and fixed it.

I've also done some additional refactoring (replacing string literals of method names with nameof) and implementing suggestions @corranrogue9 added to this PR

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.

corranrogue9 · 2022-10-21T17:23:48Z

test/EndToEndTests/Tests/Client/AsynchronousTests/AsynchronousQueryTests.cs

+                        .Select(c => new Computer
+                         {
+                             ComputerId = c.ComputerId,
+                             ComputerDetail = c.ComputerDetail == null ? null : c.ComputerDetail,


This line is interesting, what does the ternary operator give us here?

The ternary operator here is used to force the ProjectPlanCompiler to call the method ProjectionCheckValueForPathIsNull, which is the one that had the bug. In this case, the result of that expression will be the value of c.ComputerDetail since it's not null. But the key thing here I believe is the null check against a nested EntityType.

corranrogue9 · 2022-10-21T17:25:24Z

test/EndToEndTests/Tests/Client/AsynchronousTests/AsynchronousQueryTests.cs

@@ -788,6 +789,24 @@ public void Linq_ProjectPropertiesFromEntityandExpandedEntity()
            this.EnqueueTestComplete();
        }

+        [Fact]
+        public async Task Linq_ProjectPropertiesFromEntityWithConditionalNullCheckOnExpandedEntity()


Would this test be the one that fails without your other changes? The LINQ query wasn't generating an expression with the materializer?

Yes, it was failing without my changes. It was throwing an ArgumentException because the ProjectPlanCompiler was generating a dynamic call to ProjectionCheckValueForPathIsNull without passing the required materializerContext argument.

gathogojr

pull-request-quantifier-deprecated · 2022-10-24T05:20:14Z

This PR has 128 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       : +78 -50
Percentile : 45.6%

Total files changed: 18

Change summary by file extension:
.cs : +78 -50

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

habbes added 2 commits October 21, 2022 16:46

Add failing test

f2a34e3

Fix issue

6880242

pull-request-quantifier-deprecated bot added the Extra Small label Oct 21, 2022

Use nameof instead of literals for dynamic method names

8df3946

pull-request-quantifier-deprecated bot added Small and removed Extra Small labels Oct 21, 2022

habbes marked this pull request as ready for review October 21, 2022 14:22

Refactoring

d6b86c3

pull-request-quantifier-deprecated bot added Medium and removed Small labels Oct 21, 2022

habbes requested review from gathogojr, ElizabethOkerio, chrisspre, corranrogue9, KenitoInc, lisicase, mikepizzo and xuzhg October 21, 2022 15:41

corranrogue9 reviewed Oct 21, 2022

View reviewed changes

corranrogue9 previously approved these changes Oct 21, 2022

View reviewed changes

gathogojr previously approved these changes Oct 21, 2022

View reviewed changes

Use base.MaterializerCache consistently

b5dd111

habbes dismissed stale reviews from gathogojr and corranrogue9 via b5dd111 October 24, 2022 05:20

ElizabethOkerio approved these changes Oct 24, 2022

View reviewed changes

gathogojr approved these changes Oct 24, 2022

View reviewed changes

habbes merged commit 1eadadf into OData:master Oct 24, 2022

habbes mentioned this pull request Feb 22, 2023

Incorrect number of arguments supplied for call to method in 7.14.1 #2617

Closed

habbes mentioned this pull request Feb 22, 2023

Fix ArgumentException regression in ProjectPlanCompiler #2624

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix ArgumentException in ProjectPlanCompiler caused by missing materializerContext argument in dynamic calls #2535

Fix ArgumentException in ProjectPlanCompiler caused by missing materializerContext argument in dynamic calls #2535

habbes commented Oct 21, 2022 •

edited

Loading

corranrogue9 Oct 21, 2022

habbes Oct 21, 2022

corranrogue9 Oct 21, 2022

habbes Oct 21, 2022

gathogojr left a comment

pull-request-quantifier-deprecated bot commented Oct 24, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

gathogojr left a comment

Fix ArgumentException in ProjectPlanCompiler caused by missing materializerContext argument in dynamic calls #2535

Fix ArgumentException in ProjectPlanCompiler caused by missing materializerContext argument in dynamic calls #2535

Conversation

habbes commented Oct 21, 2022 • edited Loading

Issues

Description

Checklist (Uncheck if it is not completed)

Additional work necessary

corranrogue9 Oct 21, 2022

Choose a reason for hiding this comment

habbes Oct 21, 2022

Choose a reason for hiding this comment

corranrogue9 Oct 21, 2022

Choose a reason for hiding this comment

habbes Oct 21, 2022

Choose a reason for hiding this comment

gathogojr left a comment

Choose a reason for hiding this comment

pull-request-quantifier-deprecated bot commented Oct 24, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

gathogojr left a comment

Choose a reason for hiding this comment

habbes commented Oct 21, 2022 •

edited

Loading