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.

Sign up for GitHub

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

Jump to bottom

Implement asynchronous support in ODataJsonLightParameterReader #2353

Merged
merged 3 commits into from
Mar 29, 2022
Merged

Implement asynchronous support in ODataJsonLightParameterReader #2353

merged 3 commits into from
Mar 29, 2022

Conversation

gathogojr
Copy link
Contributor

Issues

This pull request partially fulfills #2019.

Description

Implement asynchronous support in ODataJsonLightParameterReader.

  • 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 force-pushed the feature/odatajsonlightparameterreader-async branch 2 times, most recently from f00d2dc to 1038041 Compare March 17, 2022 05:52
@gathogojr gathogojr force-pushed the feature/odatajsonlightparameterreader-async branch 2 times, most recently from 7d5bd02 to 08f5e01 Compare March 23, 2022 04:46
@gathogojr gathogojr force-pushed the feature/odatajsonlightparameterreader-async branch from d534cf8 to 645e9fc Compare March 23, 2022 06:19
@pull-request-quantifier-deprecated
Copy link

This PR has 954 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       : +898 -56
Percentile : 98.47%

Total files changed: 9

Change summary by file extension:
.cs : +886 -56
.txt : +3 -0
.bsl : +9 -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.

KenitoInc
KenitoInc previously approved these changes Mar 23, 2022
View reviewed changes
marabooy
marabooy previously approved these changes Mar 24, 2022
View reviewed changes
@gathogojr gathogojr dismissed stale reviews from marabooy and KenitoInc via 1ac05ea March 28, 2022 19:05
habbes
habbes reviewed Mar 29, 2022
View reviewed changes
src/Microsoft.OData.Core/ODataParameterReaderCore.cs
@@ -192,7 +194,7 @@ public override sealed bool Read()
public override sealed Task<bool> ReadAsync()
{
this.VerifyCanRead(false);
return this.ReadAsynchronously().FollowOnFaultWith(t => this.EnterScope(ODataParameterReaderState.Exception, null, null));
return this.InterceptExceptionAsync((thisParam) => thisParam.ReadAsynchronously());
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you update the this.ReadAsynchronously to be "truly async"? I don't think I've seen it on the diff.

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 The "truly async" implementation of ReadAsynchronously is in ODataParameterReaderCoreAsync class

src/Microsoft.OData.Core/ODataParameterReaderCore.cs
@@ -432,6 +434,27 @@ protected virtual Task<bool> ReadAsynchronously()
return TaskUtils.GetTaskForSynchronousOperation<bool>(this.ReadImplementation);
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this be "truly async" as well?

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 The "truly async" implementation of ReadAsynchronously is contained in ODataParameterReaderCoreAsync. Because ReadAsync method is declared as abstract and ODataParameterReaderCore needs to override it, we're just wrapping the synchronous method in a task as a stub implementation.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, is that worth mentioning in a comment?

habbes
habbes approved these changes Mar 29, 2022
View reviewed changes
src/Microsoft.OData.Core/ODataParameterReaderCore.cs
@@ -432,6 +434,27 @@ protected virtual Task<bool> ReadAsynchronously()
return TaskUtils.GetTaskForSynchronousOperation<bool>(this.ReadImplementation);
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, is that worth mentioning in a comment?

@gathogojr gathogojr merged commit 73d29b0 into OData:master Mar 29, 2022
@gathogojr gathogojr deleted the feature/odatajsonlightparameterreader-async branch March 29, 2022 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marabooy marabooy marabooy approved these changes

@habbes habbes habbes approved these changes

@KenitoInc KenitoInc KenitoInc left review comments

@ElizabethOkerio ElizabethOkerio Awaiting requested review from ElizabethOkerio

@Nthemba Nthemba Awaiting requested review from Nthemba

Assignees
No one assigned
Labels
Extra Large
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gathogojr @marabooy @KenitoInc @habbes