Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix bug in LoadProperty for complex and complex collection #2487

Conversation

gathogojr
Copy link
Contributor

@gathogojr gathogojr commented Aug 18, 2022

Issues

This pull request fixes #2471.

Description

We rely on ODataLoadNavigationPropertyMaterializer to materialize load property result for complex and complex collection property. Complex and complex collection properties are structural properties, the reliance on ODataLoadNavigationPropertyMaterializer is by design - we use ODataReaderEntityMaterializer as well to materialize complex and complex collection properties, since just like entities, they're returned as ODataResource.
The bug was in how we apply the materialized values to the respective properties on the client type instance.
Due to a missing condition check, the complex collections were being treated as if they are a single entity value.

I fixed the bug by applying the missing check. By doing so, this block in LoadPropertyResult class does the job of applying the complex collection to the property - after first clearing the existing items.

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.

@@ -99,12 +102,11 @@ protected override bool ReadImplementation()
this.MaterializeEntryPlan,
this.responseInfo.IsContinuation);
}
else
else if (property.EdmProperty.Type.TypeKind() == EdmTypeKind.Entity)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In which block do complex properties and/or complex collection properties get handled?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@habbes This block

else if (property.IsPrimitiveOrEnumOrComplexCollection)

@gathogojr gathogojr force-pushed the fix/2471-fix-loadproperty-for-complex-and-complex-collection branch from cfd2a2f to 2597166 Compare August 22, 2022 12:34
KenitoInc
KenitoInc previously approved these changes Aug 25, 2022
xuzhg
xuzhg previously approved these changes Aug 25, 2022
@@ -81,6 +81,7 @@
<Compile Include="Tests\Materialization\CollectionValueMaterializationPolicyTests.cs" />
<Compile Include="Tests\Materialization\EntryValueMaterializationPolicyUnitTests.cs" />
<Compile Include="Tests\Materialization\CamelCasedTypeMaterializationTests.cs" />
<Compile Include="Tests\LoadPropertyTests.cs" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we put the new test file under "Materialization" subfolder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xuzhg Done

@gathogojr gathogojr dismissed stale reviews from xuzhg and KenitoInc via c0f28c9 August 25, 2022 19:31
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Large
Size       : +273 -2
Percentile : 67.5%

Total files changed: 3

Change summary by file extension:
.cs : +272 -2
.csproj : +1 -0

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 gathogojr merged commit 5c36339 into OData:master Aug 26, 2022
@gathogojr gathogojr deleted the fix/2471-fix-loadproperty-for-complex-and-complex-collection branch August 26, 2022 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DataServiceContext.LoadProperty fails to load collection of complex types.
5 participants