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

Fixed the handling of empty http attributes in Batch Requests #2705

Conversation

apiaskowski
Copy link
Contributor

Issues

This pull request fixes Issue-2656

Description

OData batching does return an HTTP 500 error, if the request includes a empty null value HTTP attributes.
This issue is caused by not proper validation of the JSON property value, when serializing it into a String variable.

Checklist (Uncheck if it is not completed)

  • Test cases added
  • Build and test with one-click build and test script passed

Additional work necessary

The current implementation does handle empty http attributes, by validating, if the JSON property is empty, i.e. null.
But as discussed in previous PR-2669, these should not be handled in this way and instead throw an ODataException.
If so, the odata specification need to be adjusted and highlight, that empty http attributes / JSON properties are not allowed.

Piaskowski, Adrian Jan | Eddy and others added 24 commits May 10, 2023 15:54
…PropertiesCache, throwing an exception for duplicate properties, except header properties.
…ded test cases for duplicate headers and properties
…dling of JSON property and removed corresponding unit tests.
…t-handling-of-duplicate-http-attributes

Bugfix/issue 2656/batch request handling of duplicate http attributes
…PropertiesCache, throwing an exception for duplicate properties, except header properties.
…dling of JSON property and removed corresponding unit tests.
@pull-request-quantifier-deprecated

This PR has 46 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       : +44 -2
Percentile : 18.4%

Total files changed: 2

Change summary by file extension:
.cs : +44 -2

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.

@apiaskowski
Copy link
Contributor Author

@gathogojr would it be possible to review this follow-up task of PR-2669?

@gathogojr gathogojr requested review from KenitoInc, habbes and xuzhg July 24, 2023 18:58
@gathogojr
Copy link
Contributor

Hi @apiaskowski We do squash the commits when merging but a reviewer who's not familiar with the background might wonder and indeed ask why there are so many commits. If it's not too much of a hassle, consider squashing them.

Copy link
Contributor

@gathogojr gathogojr left a comment

Choose a reason for hiding this comment

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

:shipit:

@gathogojr gathogojr linked an issue Jul 25, 2023 that may be closed by this pull request
@apiaskowski
Copy link
Contributor Author

Hi @apiaskowski We do squash the commits when merging but a reviewer who's not familiar with the background might wonder and indeed ask why there are so many commits. If it's not too much of a hassle, consider squashing them.

Sure, I'll do. Typically I'd "squash & merge", but since I am not able to do so here, I'd have to do it here manually by git rebase?

@gathogojr
Copy link
Contributor

Hi @apiaskowski We do squash the commits when merging but a reviewer who's not familiar with the background might wonder and indeed ask why there are so many commits. If it's not too much of a hassle, consider squashing them.

Sure, I'll do. Typically I'd "squash & merge", but since I am not able to do so here, I'd have to do it here manually by git rebase?

Yeah. Basically git rebase i HEAD~N where N is the number of commits you want squash and merge. If it becomes a challenge/too much work, just leave it be. I can just squash and merge from here...

@gathogojr gathogojr merged commit 0cf10e3 into OData:master Jul 25, 2023
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.

OData Batch Requests fails to handle duplicate http attributes
3 participants