Enable more nullable annotations in WebCmdlets

[CarloToso]

PR Summary

Enable more nullable comments in WebCmdlets, please review carefully.

PR Context

Follow up to #19291

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:

[iSazonov]

Hmm, I think it is wrong. Encoding.GetEncoding(null) returns OS default but Encoding.GetEncoding(string.Empty) throw. We should investigate the last case and if it is a bug we should fix in another PR.

[CarloToso]

I think the desired behaviour is that both cases (characterSet == null; characterSet == string.Empty) should should return result = false and encoding = UTF8 (the default). Do you agree?

[iSazonov]

The code is in try-catch. So it makes no sense. Please remove.

[CarloToso]

I know it doesn't make sense, I added it to avoid a possible null reference error for characterSet, could you point me to a better solution?

[iSazonov]

Null reference error? In TryGetEncoding? It is impossible since Encoding.GetEncoding(null) returns OS default, for string.Empty try-catch will catch and set default too. Also it will set default if .Net doesn't know a value in characterSet.

[CarloToso]

The warning before the last 2 commits was Possible null reference argument for parameter 'name' in 'Encoding Encoding.GetEncoding(string name)'., and the build fails on warnings

[iSazonov]

Since [System.Text.Encoding]::GetEncoding($null) return OS default without exception I suggest to open new issue in .Net.
Today we could use a workaround with ! operator and comment with reference to the new .Net issue.

[CarloToso]

I looked a bit more into it
Test:

$source = @"
using System;
using System.Text;

    public class EncodingTest
    {
        public static Encoding GetEncoding1(string name)
        {
            return Encoding.GetEncoding(name);
        }

        public static Encoding GetEncoding2(int name)
        {
            return Encoding.GetEncoding(name);
        }
    }
"@

Add-Type -TypeDefinition $source -Language CSharp -ReferencedAssemblies netstandard, System.Text.Encoding

[EncodingTest]::GetEncoding1($null)
#--> ERROR
[EncodingTest]::GetEncoding2($null)
#--> windows-1252

[EncodingTest]::GetEncoding1("")
#--> ERROR
[EncodingTest]::GetEncoding2("")
#--> windows-1252
[EncodingTest]::GetEncoding2(0)
#--> windows-1252

In our case we are using Encoding.GetEncoding(string name) so it throws an error with null or empty that gets caught, we don't have a bug everything works as planned. Unfortunalely Encoding.GetEncoding(string name) with null gives us a warning, as you said we could use ! operator.

If Encoding.GetEncoding(string name) with name == null returned windows-1252 that wouldn't be a desired behaviour for us in this case, because we want to default to UTF-8

[CarloToso]

Unrelated error

[pull-request-quantifier-deprecated]

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

---

Quantification details

Label      : Medium
Size       : +86 -69
Percentile : 51%

Total files changed: 14

Change summary by file extension:
.cs : +86 -69

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.

[ghost]

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

[CarloToso]

@iSazonov can you merge this PR?

[iSazonov]

@CarloToso Please look test fails.

[CarloToso]

@iSazonov all tests pass

[ghost]

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes