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

Allow using property-paths with respect to declaring type from model. #2734

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mirecg
Copy link
Contributor

@mirecg mirecg commented Dec 2, 2022

Solves property path expressions like Stamp/CreatedByUser/Name, where CreatedByUser is interface (e.g. IMyInterface) which do not directly have a Name property, but the Name is in some base interface up in the hierarchy.

Otherwise it internally throws System.ArgumentException: 'Instance property 'Name' is not defined for type 'IMyInterface'.

It is possible to overcome the issue using a cast expression, but this forces to use hardcoded casts on client calling odata endpoints and have deeper knowledge about model behind it.

Description

Using IEdmProperty and IEdmModel in ExpressionBinderBase.GetPropertyExpression() we can create property access expression with regards to declaring type of the property

Solves property path expressions like Stamp/CreatedByUser/Name, where CreatedByUser is interface (e.g. IMyInterface) which do not directly have a Name property, but the Name is in some base interface up in the hierarchy.

Otherwise it internally throws System.ArgumentException: 'Instance property 'Name' is not defined for type 'IMyInterface'.

It is possible to overcome the issue using a cast expression, but this forces to use hardcoded casts on client calling odata endpoints and have deeper knowledge about model behind it.
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Small
Size       : +11 -4
Percentile : 6%

Total files changed: 1

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

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.

@KenitoInc
Copy link
Contributor

Add tests

Comment on lines +1194 to +1201
var propertyDeclaringClrType = EdmLibHelpers.GetClrType(property.DeclaringType, model);
if (propertyDeclaringClrType != null)
propertyValue = Expression.Property(propertyValue, propertyDeclaringClrType, propertyNameParts[i]);
else
propertyValue = Expression.Property(propertyValue, propertyNameParts[i]);
}
else
propertyValue = Expression.Property(propertyValue, propertyNameParts[i]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestions to meet library's coding conventions

Suggested change
var propertyDeclaringClrType = EdmLibHelpers.GetClrType(property.DeclaringType, model);
if (propertyDeclaringClrType != null)
propertyValue = Expression.Property(propertyValue, propertyDeclaringClrType, propertyNameParts[i]);
else
propertyValue = Expression.Property(propertyValue, propertyNameParts[i]);
}
else
propertyValue = Expression.Property(propertyValue, propertyNameParts[i]);
Type propertyDeclaringClrType = EdmLibHelpers.GetClrType(property.DeclaringType, model);
if (propertyDeclaringClrType != null)
{
propertyValue = Expression.Property(propertyValue, propertyDeclaringClrType, propertyNameParts[i]);
}
else
{
propertyValue = Expression.Property(propertyValue, propertyNameParts[i]);
}
}
else
{
propertyValue = Expression.Property(propertyValue, propertyNameParts[i]);
}

{
propertyValue = Expression.Property(propertyValue, propertyName);
// property access over declaring type from model without extra casts
// - solves property path expressions like Stamp/CreatedByUser/Name, where CreatedByUser is interface which do not directly have a Name property, but the Name is in some base interface up in the hierarchy
Copy link
Contributor

Choose a reason for hiding this comment

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

When you talk about a "base interface up in the hierarchy", do you mean a type that inerhits from CreatedByUser or a type that CreatedByUser inherits from?

Why not use that type that has the property in the path expressions instead of using a type that is not guaranteed to have that property?

Could you share more information about concrete scenarios where this issue occurs and that this PR aims to fix?

@ElizabethOkerio
Copy link
Contributor

@mirecg Add tests and also respond to some of the questions already asked.

@WanjohiSammy
Copy link

@mirecg Also link the Issue ID associated with this PR if available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants