Add lock and null check to remoting internals (#16542)

[SergeyZalyadeev]

PR Summary

Lock and null check of the PrioritySendDataCollection.cs members to avoid race condition.

PR Context

Copy-Item cmdlet can throw unhandled exception that terminates the process.
The issue occures in WSManTransportManager internals.
The PrioritySendDataCollection class is used by 2 threads: first thread calls ReadOrRegisterCallback method, that gets _dataToBeSent field, when second thread calls Clear method, where _dataToBeSent member is disposed.

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
• Breaking changes
  • None
  • OR
  • Experimental feature(s) needed
    • Experimental feature name(s):
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • Make sure you've added a new test if existing tests do not effectively test the code changed
• Tooling
  • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
  • OR
  • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
    • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
      (which runs in a different PS Host).
      • Issue filed:
    • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
      • Issue filed:
    • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
      • Issue filed:
    • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
      • Issue filed:

[ghost]

All CLA requirements met.

[PaulHigin]

I am not comfortable adding extra locks here and possibly introducing deadlocks. This code has remained untouched for many years. We need to better understand of the race condition, @SergeyZalyadeev please add scenario information. The SerializedDataStreams already handle the dispose condition, and this may need to be extended for this particular scenario.

[SergeyZalyadeev]

@PaulHigin please take a look on the issue #16542
I can reproduce by using the following script

$User='localhost\Admin'
$password='Passw0rd1'

$attempts = 1000
$vm_ip_list = @('10.1.0.10', '10.1.0.11', '10.1.0.12', '10.1.0.13', '10.1.0.14', '10.1.0.15')

while(($attempts--)) {
	Write-Host "Attempt: $attempts"
	$vm_ip_list | foreach-object -Parallel { $cr = [pscredential]::new($User, (ConvertTo-SecureString $password -AsPlainText -Force));

		$sess = New-PSSession -ComputerName $_ -Credential $cr;
		Copy-Item -Path C:\Users\public\Downloads\50Mb.zip -Destination C:\50Mb.zip -ToSession $sess
}}

Dumps
https://pwshdumps.blob.core.windows.net/pub/pwsh.exe_220110_104242.zip
https://pwshdumps.blob.core.windows.net/pub/pwsh.exe_220109_223435.zip
https://pwshdumps.blob.core.windows.net/pub/pwsh721.exe_220110_131901.zip

[PaulHigin]

@SergeyZalyadeev Thanks for the scenario information and crash dumps. I agree with your analysis and fix, and have just a few minor comments. I would like to get this change in to 7.3 preview asap, after you make these minor fixes, so that the change can be well tested.

[PaulHigin]

LGTM

[PaulHigin]

@daxian-dbw Can you please review? I would like to get a second set of eyes on this change.

[pull-request-quantifier-deprecated]

This PR has 12 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       : +8 -4
Percentile : 4.8%

Total files changed: 1

Change summary by file extension:
.cs : +8 -4

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.

[iSazonov]

@SergeyZalyadeev Thanks for your contribution!

[floh96]

@PaulHigin this was merged without the cla signed

[PaulHigin]

@SergeyZalyadeev Can you please sign the CLA?

https://cla.opensource.microsoft.com/PowerShell/PowerShell?pullRequest=16683

Contributor License Agreement

[ghost]

🎉v7.3.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes