POC for writing instance annotations and odata.count for expanded resource sets

[KenitoInc]

Issues

POC for writing instance annotations for expanded resoource sets

Description

• We need to support read/write instance annotations for expanded resource sets.
• We need to enable writing count value for expanded resource set without writing the resource set value.

In this POC, we are adding 2 properties to the ODataNestedResourceInfo

• public long? Count
• public ICollection<ODataInstanceAnnotation> InstanceAnnotations
  So we can write the instance annotations and odata.count for an expanded resource set as follows:

var entryToWrite = new ODataResource { Properties = new[] { new ODataProperty { Name = "ID", Value = 1 } } };
odataWriter.WriteStart(entryToWrite);

ODataNestedResourceInfo navLink = new ODataNestedResourceInfo { Name = "ResourceSetNavigationProperty", Url = new Uri("http://service/navLink", UriKind.RelativeOrAbsolute), IsCollection = true };
navLink.Count = 10;
navLink.InstanceAnnotations.Add(new ODataInstanceAnnotation("custom.StartFeedAnnotation", PrimitiveValue1));
odataWriter.WriteStart(navLink);

odataWriter.WriteEnd();
odataWriter.WriteEnd();

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.

[xuzhg]

WriteAnnotationAndCountAtStartExpandedFeedShouldPass

it seems this new private method is only used in the new test case. Maybe it's not needed.

[xuzhg]

[xuzhg]

what about if the nested resource info is single?

[KenitoInc]

I have added a validation!

[pull-request-quantifier-deprecated]

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

---

Quantification details

Label      : Small
Size       : +98 -0
Percentile : 39.2%

Total files changed: 8

Change summary by file extension:
.cs : +97 -0
.txt : +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 detetcted.
• 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.

[mikepizzo]

Noet: you don't really need the section for a property -- you cover what it returns in the summary.

[mikepizzo]

@corranrogue9 -- This is a good item to put on the 8.0 list. We don't have a good way to fix this in 7.x without being a breaking change. @KenitoInc has more context, and a design doc that describes the different options.