Implement asynchronous support in ODataJsonLightParameterDeserializer #2311

gathogojr · 2022-02-08T04:25:52Z

Issues

This pull request partially fulfills #2019.

Description

Implement asynchronous support in ODataJsonLightParameterDeserializer.

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.

marabooy · 2022-02-08T18:15:19Z

...tionalTests/Microsoft.OData.Core.Tests/JsonLight/ODataJsonLightParameterDeserializerTests.cs

+        public async Task ReadPrimitiveParameterAsync()
+        {
+            var payload = "{\"rating\":4}";
+            var setRatingAction = new EdmAction("NS", "SetRating", null);


nit: Move this closer to usage for consistency.

marabooy · 2022-02-08T18:17:35Z

src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterDeserializer.cs

+                await this.ProcessPropertyAsync(
+                    propertyAndAnnotationCollector,
+                    propertyAnnotationValueReaderAsync,
+                    async (propertyParsingResult, parameterName) =>


A good candidate for a future update on this lambda so it captures less items. 😄

I plan to tackle in a separate to address the same concern in related PRs

ElizabethOkerio · 2022-02-14T06:51:54Z

src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterDeserializer.cs

@@ -25,6 +26,11 @@ internal sealed class ODataJsonLightParameterDeserializer : ODataJsonLightProper
        private static readonly Func<string, object> propertyAnnotationValueReader =
            annotationName => { throw new ODataException(ODataErrorStrings.ODataJsonLightParameterDeserializer_PropertyAnnotationForParameters); };

+        /// <summary>OData property annotation asynchronous reader for parameter payloads.</summary>


I don't think this statement is necessary here. Its contradicting the second statement. You can get rid of this and just leave the second one.

Addressed by moving the statement about ODataJsonLightParameterDeserializer not supporting reading of property annotations to the body of the delegate

KenitoInc

Approved with minor comments

KenitoInc · 2022-02-14T08:36:56Z

src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterDeserializer.cs

+            Debug.Assert(propertyAndAnnotationCollector != null, "propertyAndAnnotationCollector != null");
+            this.AssertJsonCondition(JsonNodeType.Property, JsonNodeType.EndObject);
+
+            bool parameterRead = false;


Suggested change

bool parameterRead = false;

bool parameterRead = false;

KenitoInc · 2022-02-14T08:37:18Z

src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterDeserializer.cs

+
+                                ODataParameterReaderState state;
+                                object parameterValue;
+                                EdmTypeKind parameterTypeKind = parameterTypeReference.TypeKind();


Suggested change

EdmTypeKind parameterTypeKind = parameterTypeReference.TypeKind();

EdmTypeKind parameterTypeKind = parameterTypeReference.TypeKind();

KenitoInc · 2022-02-14T08:37:34Z

src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterDeserializer.cs

+                                switch (parameterTypeKind)
+                                {
+                                    case EdmTypeKind.Primitive:
+                                        IEdmPrimitiveTypeReference primitiveTypeReference = parameterTypeReference.AsPrimitive();


Suggested change

IEdmPrimitiveTypeReference primitiveTypeReference = parameterTypeReference.AsPrimitive();

IEdmPrimitiveTypeReference primitiveTypeReference = parameterTypeReference.AsPrimitive();

pull-request-quantifier-deprecated · 2022-02-14T08:48:44Z

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

Quantification details

Label      : Large
Size       : +371 -0
Percentile : 77.1%

Total files changed: 4

Change summary by file extension:
.cs : +371 -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.

pull-request-quantifier-deprecated bot added the Medium label Feb 8, 2022

gathogojr marked this pull request as draft February 8, 2022 04:26

gathogojr force-pushed the feature/odatajsonlightparameterdeserializer-async branch from 5e2a6f1 to 6603b5e Compare February 8, 2022 07:33

pull-request-quantifier-deprecated bot added Large and removed Medium labels Feb 8, 2022

gathogojr marked this pull request as ready for review February 8, 2022 07:33

gathogojr requested review from ElizabethOkerio, habbes, KenitoInc and marabooy February 8, 2022 07:33

marabooy reviewed Feb 8, 2022

View reviewed changes

gathogojr force-pushed the feature/odatajsonlightparameterdeserializer-async branch 3 times, most recently from 08a5656 to 8546f08 Compare February 11, 2022 19:38

habbes approved these changes Feb 13, 2022

View reviewed changes

ElizabethOkerio reviewed Feb 14, 2022

View reviewed changes

ElizabethOkerio approved these changes Feb 14, 2022

View reviewed changes

gathogojr force-pushed the feature/odatajsonlightparameterdeserializer-async branch from 8546f08 to 66b8565 Compare February 14, 2022 08:16

KenitoInc approved these changes Feb 14, 2022

View reviewed changes

Implement asynchronous support in ODataJsonLightParameterDeserializer

ce8f2c6

gathogojr force-pushed the feature/odatajsonlightparameterdeserializer-async branch from 66b8565 to ce8f2c6 Compare February 14, 2022 08:48

gathogojr merged commit 9770082 into OData:master Feb 14, 2022

gathogojr deleted the feature/odatajsonlightparameterdeserializer-async branch February 14, 2022 09:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement asynchronous support in ODataJsonLightParameterDeserializer #2311

Implement asynchronous support in ODataJsonLightParameterDeserializer #2311

gathogojr commented Feb 8, 2022 •

edited

Loading

marabooy Feb 8, 2022 •

edited

Loading

gathogojr Feb 9, 2022

marabooy Feb 8, 2022

gathogojr Feb 9, 2022

ElizabethOkerio Feb 14, 2022

gathogojr Feb 14, 2022

KenitoInc left a comment

KenitoInc Feb 14, 2022

KenitoInc Feb 14, 2022

KenitoInc Feb 14, 2022

pull-request-quantifier-deprecated bot commented Feb 14, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

	EdmTypeKind parameterTypeKind = parameterTypeReference.TypeKind();
	EdmTypeKind parameterTypeKind = parameterTypeReference.TypeKind();

	IEdmPrimitiveTypeReference primitiveTypeReference = parameterTypeReference.AsPrimitive();
	IEdmPrimitiveTypeReference primitiveTypeReference = parameterTypeReference.AsPrimitive();

Implement asynchronous support in ODataJsonLightParameterDeserializer #2311

Implement asynchronous support in ODataJsonLightParameterDeserializer #2311

Conversation

gathogojr commented Feb 8, 2022 • edited Loading

Issues

Description

Checklist (Uncheck if it is not completed)

Additional work necessary

marabooy Feb 8, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KenitoInc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pull-request-quantifier-deprecated bot commented Feb 14, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

gathogojr commented Feb 8, 2022 •

edited

Loading

marabooy Feb 8, 2022 •

edited

Loading