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

Implement asynchronous support in ODataJsonLightSerializer #2030

Merged

Conversation

gathogojr
Copy link
Contributor

@gathogojr gathogojr commented Mar 23, 2021

Issues

This pull request is a partial fulfilment of issue #2019.

Description

Implement asynchronous support in ODataJsonLightSerializer, ODataJsonLightValueSerializer, ODataJsonLightPropertySerializer and JsonLightInstanceAnnotationWriter

Disclaimer:
This PR ended up affecting 5 classes due to dependencies that were not easy to go around without ending up with an incomplete/non-functional API. For the following reasons:

  • ODataJsonLightSerializer class has a hard-coded dependency on JsonLightInstanceAnnotationWriter and invokes particular methods to write instance annotations.
  • JsonLightInstanceAnnotationWriter class has a hard-coded dependency on ODataJsonLightSerializer and ODataJsonLightValueSerializer classes and invokes methods from both classes in the course of writing instance annotations.
  • ODataJsonLightValueSerializer class has a hard-coded dependency on ODataJsonLightPropertySerializer class
  • Both ODataJsonLightValueSerializer and ODataJsonLightPropertySerializer subclass ODataJsonLightSerializer

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.

@gathogojr gathogojr changed the title Feature/odatajsonlightserializer async api Implement asynchronous support in ODataJsonLightSerializer Mar 23, 2021
@gathogojr gathogojr force-pushed the feature/odatajsonlightserializer-async-api branch 3 times, most recently from 86d7704 to 225286f Compare March 31, 2021 10:19
@gathogojr gathogojr added the Ready for review Use this label if a pull request is ready to be reviewed label Apr 8, 2021
@gathogojr gathogojr force-pushed the feature/odatajsonlightserializer-async-api branch 2 times, most recently from b16b4d7 to 2be0ac4 Compare April 8, 2021 06:18
@gathogojr gathogojr force-pushed the feature/odatajsonlightserializer-async-api branch from 2be0ac4 to ffb0111 Compare April 9, 2021 06:20
Copy link
Member

@marabooy marabooy left a comment

Choose a reason for hiding this comment

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

LGTM

/// </summary>
/// <param name="property">The property to write.</param>
/// <returns>A task that represents the asynchronous write operation.</returns>
internal Task WriteTopLevelPropertyAsync(ODataProperty property)
Copy link
Member

Choose a reason for hiding this comment

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

Task [](start = 17, length = 4)

why no async key word?

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 Eliding is recommended when a method is a pass-through. See this article on the subject
https://blog.stephencleary.com/2016/12/eliding-async-await.html#recommended-guidelines:~:text=Recommended%20Guidelines
This method qualifies as a pass-through since it merely calls another method to do the job.
Eliding will save us the overhead of creating and later garbage-collecting the state machine.
For that reason, I'm eliding the async and await whenever the method is just a pass-through

@@ -12,6 +12,7 @@
using Microsoft.OData.JsonLight;
using Microsoft.OData.Edm;
using Xunit;
using System.Threading.Tasks;
Copy link
Member

@xuzhg xuzhg Apr 9, 2021

Choose a reason for hiding this comment

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

System.Threading.Tasks; [](start = 6, length = 23)

sort #Resolved

Copy link
Member

@xuzhg xuzhg left a comment

Choose a reason for hiding this comment

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

:shipit:

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Large
Size       : +1347 -41
Percentile : 100%

Total files changed: 10

Change summary by file extension:
.cs : +1347 -41

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.

@gathogojr gathogojr merged commit 59bfcdf into OData:master Apr 12, 2021
@gathogojr gathogojr deleted the feature/odatajsonlightserializer-async-api branch April 12, 2021 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Extra Large Ready for review Use this label if a pull request is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants