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

Add HasExplicitODataId to ODataResourceBase #2620

Open
wants to merge 2 commits into
base: release-7.x
Choose a base branch
from

Conversation

KenitoInc
Copy link
Contributor

Issues

When deserializing a resource, we set the Id property in 2 ways:

  • Getting it over the wire from @odata.id
  • Computing it. e.g if we have a key property with Id=1 and the resource is of type Customer we generate an Id Customers(1) using the MetadataBuilder.
    Also, since the Id can be set publicly, we could do as follows:
ODataResource resource = new ODataResource()
{
    Id = new Uri("Customers(1)")
}

Considering the above, it's not possible to determine if resource.Id was populated from @odata.id or not.
In bulk operation handlers, if resource.Id was populated from @odata.id we should call TryAddRelatedObject since we are linking an existing object.

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.

@pull-request-quantifier-deprecated

This PR has 41 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       : +40 -1
Percentile : 16.4%

Total files changed: 11

Change summary by file extension:
.cs : +33 -1
.txt : +4 -0
.bsl : +3 -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.

@xuzhg
Copy link
Member

xuzhg commented Feb 21, 2023

others look good to me. :shipit:

}

[Fact]
public void ReadSingletonWithIdSpecifiedTest()
public void ReadSingletonWithODataIdSpecifiedTest()
Copy link
Contributor

@ElizabethOkerio ElizabethOkerio Feb 22, 2023

Choose a reason for hiding this comment

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

There is no @id here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Check line 81

@@ -213,6 +213,14 @@ public ICollection<ODataInstanceAnnotation> InstanceAnnotations
set { this.SetInstanceAnnotations(value); }
}

/// <summary>Gets or sets the value that shows if the resource has @odata.id or @id.</summary>
/// <returns>true if the resource has @odata.id or @id, false otherwise.</returns>
public bool HasExplicitODataId
Copy link
Member

Choose a reason for hiding this comment

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

internal set? or totally as internal property?

Change "Gets or sets" for Internal set

@@ -213,6 +213,14 @@ public ICollection<ODataInstanceAnnotation> InstanceAnnotations
set { this.SetInstanceAnnotations(value); }
}

/// <summary>Gets or sets the value that shows if the resource has @odata.id or @id.</summary>
/// <returns>true if the resource has @odata.id or @id, false otherwise.</returns>
public bool HasExplicitODataId
Copy link
Member

Choose a reason for hiding this comment

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

HasExplicitODataId

how does this relate to NonComputedId?

Copy link
Member

@mikepizzo mikepizzo left a comment

Choose a reason for hiding this comment

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

🕐

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