odata.net icon indicating copy to clipboard operation
odata.net copied to clipboard

fix ArgumentNullException exception when loading invalid CSDL

Open quanterion opened this issue 1 year ago • 3 comments

When loading invalid CSDL model via CsdlReader.Parse we get correct exception EdmException. But if we do it via CsdlReader.TryParse with ignoreUnexpectedAttributesAndElements option enabled we get instead System.ArgumentNullException: Value cannot be null. (Parameter 'key') because adding null version fails here https://github.com/OData/odata.net/blob/main/src/Microsoft.OData.Edm/Csdl/CsdlReader.cs#L339 and as get no critical errors due to https://github.com/OData/odata.net/blob/main/src/Microsoft.OData.Edm/Csdl/CsdlReader.cs#L483

quanterion avatar Apr 03 '24 13:04 quanterion

This PR has 4 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       : +2 -2
Percentile : 1.6%

Total files changed: 1

Change summary by file extension:
.cs : +2 -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? :thumbsup:  :ok_hand:  :thumbsdown: (Email) Customize PullRequestQuantifier for this repository.

Hi @quanterion. Thank you for your pull request contribution. Could you please add a test to confirm the behaviour resulting from your change?

gathogojr avatar Apr 11 '24 07:04 gathogojr

@quanterion Add tests

ElizabethOkerio avatar Jun 06 '24 12:06 ElizabethOkerio

@quanterion as there has been no activity or response on this PR for a while, I am going to close it for now. If you would like to continue working on it, please feel free to reopen it.

WanjohiSammy avatar Dec 05 '24 06:12 WanjohiSammy