ODataNotificationWriter and ODataNotificationStream wrapper classes should not dispose the passed TextWriter and Stream respectively

[gathogojr]

Description

ODataNotificationWriter and ODataNotificationStream wrapper classes should not dispose the passed TextWriter and Stream respectively.

Reference to merged PRs 2079 and 2080 implementing support for asynchronous invocation of IODataStreamListener.StreamDisposedAsync from ODataNotificationWriter and ODataNotificationStream wrapper classes, a line was added such that the passed TextWriter and Stream respectively are disposed when the Dispose method is called.
This can cause a problem if the owner of TextWriter or Stream chose to use it after - though that does not happen currently. This pull request addresses that loop hole, leaving the owner to do the disposing.

NOTE: Confirmation of the fix is in the change made to the tests where the test class is able to read from the stream even after the ODataNotificationWriter or ODataNotificationStream instance is disposed.

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.

[pull-request-quantifier-deprecated]

This PR has 24 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       : +10 -14
Percentile : 9.6%

Total files changed: 4

Change summary by file extension:
.cs : +10 -14

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.

[habbes]

Why this change necessary? Is this.stream used in the test? Do you make a check to verify that it was not disposed?

[gathogojr]

Please observe that I'm verifying that StreamDisposed or StreamDiposedAsync are invoked by reading the content of the stream they wrote to when they were invoked. In the previous case, StreamDisposed/StreamDiposedAsync were writing to a stream entirely different to the one passed to ODataNotificationStream constructor. Since ODataNotifictionStream is not disposing the stream after the change, I was able to make StreamDisposed/StreamDiposedAsync write to the same stream passed to the constructor with the assurance that it'll still be available for the the helper ReadStreamContents/ReadStreamContentsAsync methods to read from. That is why I noted in the PR description that the change I made to the tests is the confirmation needed to verify that the stream is not disposed