GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Enable more nullable annotations in WebCmdlets by CarloToso · Pull Request #19359 · PowerShell/PowerShell

Conversation

@CarloToso

@CarloToso CarloToso commented Mar 17, 2023 •
edited by iSazonov
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
CarloToso added 15 commits March 16, 2023 23:41
@CarloToso
content helper nullable
3c1221f
@CarloToso
webresponseobject nullable
e59425b
@CarloToso
stream helper nullable
68fc544
@CarloToso
webproxy nullable
d727763
@CarloToso
fixes
8b558e3
@CarloToso
nullable headernames
e8fefea
@CarloToso
nullable invokerestmethod
a4b1103
@CarloToso
nullable webcmdletelementcollection
07f1104
@CarloToso
fixes
fe375e8
@CarloToso
psuseragent nullable
815e673
@CarloToso
webresponseobjectfactory nullable
19016a7
@CarloToso
formobject nullable
cf1790c
@CarloToso
formobjectcollection nullable
522c630
@CarloToso
small changes
ea74629
@CarloToso
basichtmlresponseobject nullable WIP
ec5af71
@CarloToso
CarloToso requested a review from Paul Higinbotham (PaulHigin) as a code owner March 17, 2023 01:32
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Medium label Mar 17, 2023
@ghost ghost assigned Andrew (anmenaga) Mar 17, 2023
@CarloToso
!TryGetEncoding(characterSet, out encoding);
c329321
iSazonov
Ilya (iSazonov) reviewed Mar 17, 2023
View reviewed changes
Comment thread ...hell.Commands.Utility/commands/utility/WebCmdlet/Common/BasicHtmlWebResponseObject.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@CarloToso CarloToso mentioned this pull request Mar 17, 2023
Initialize Regex lazy in BasicHtmlWebResponseObject #19361
Merged
7 of 22 tasks
@CarloToso
Merge branch 'master' into nullable-webcmdlets
1328a0f
iSazonov
Ilya (iSazonov) reviewed Mar 18, 2023
View reviewed changes
Comment thread ...hell.Commands.Utility/commands/utility/WebCmdlet/Common/BasicHtmlWebResponseObject.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

iSazonov
Ilya (iSazonov) reviewed Mar 18, 2023
View reviewed changes
Comment thread ...hell.Commands.Utility/commands/utility/WebCmdlet/Common/BasicHtmlWebResponseObject.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

iSazonov
Ilya (iSazonov) reviewed Mar 18, 2023
View reviewed changes
Comment thread ...hell.Commands.Utility/commands/utility/WebCmdlet/Common/BasicHtmlWebResponseObject.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

iSazonov
Ilya (iSazonov) reviewed Mar 18, 2023
View reviewed changes
Comment thread ...rosoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/ContentHelper.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@CarloToso @iSazonov
Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Web…
cfcd17f
…Cmdlet/Common/ContentHelper.Common.cs

Co-authored-by: Ilya <[email protected]>
iSazonov
Ilya (iSazonov) reviewed Mar 18, 2023
View reviewed changes
Comment thread ...rosoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/ContentHelper.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

iSazonov
Ilya (iSazonov) reviewed Mar 18, 2023
View reviewed changes
Comment thread ...erShell.Commands.Utility/commands/utility/WebCmdlet/Common/InvokeRestMethodCommand.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

iSazonov
Ilya (iSazonov) reviewed Mar 18, 2023
View reviewed changes
Comment thread ...erShell.Commands.Utility/commands/utility/WebCmdlet/Common/InvokeRestMethodCommand.Common.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

CarloToso added 2 commits March 30, 2023 00:33
@CarloToso
follow suggestions
8652eaf
@CarloToso
WebResponseHelper.CoreClr nullable enable
585d7e0
iSazonov
Ilya (iSazonov) reviewed Mar 30, 2023
View reviewed changes
Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/StreamHelper.cs Outdated
bool result = false;
try
{
ArgumentException.ThrowIfNullOrEmpty(characterSet);

@iSazonov Ilya (iSazonov) Mar 30, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@CarloToso CarloToso Mar 30, 2023

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@iSazonov Ilya (iSazonov) Mar 30, 2023

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@CarloToso CarloToso Mar 30, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@iSazonov Ilya (iSazonov) Mar 31, 2023

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@CarloToso CarloToso Mar 31, 2023

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@iSazonov Ilya (iSazonov) Apr 1, 2023

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@CarloToso CarloToso Apr 1, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@CarloToso
remove ArgumentException.ThrowIfNullOrEmpty(characterSet);
64af5c8
iSazonov
Ilya (iSazonov) reviewed Apr 1, 2023
View reviewed changes
Comment thread ....PowerShell.Commands.Utility/commands/utility/WebCmdlet/CoreCLR/WebResponseHelper.CoreClr.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

CarloToso added 2 commits April 1, 2023 14:07
@CarloToso
Encoding.GetEncoding(characterSet!)
b33f28a
@CarloToso
fix
0070ddc
@CarloToso

CarloToso commented Apr 1, 2023

Copy link
Copy Markdown
Contributor Author

Unrelated error

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

iSazonov
Ilya (iSazonov) approved these changes Apr 1, 2023
View reviewed changes
@iSazonov Ilya (iSazonov) added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Apr 1, 2023
@iSazonov Ilya (iSazonov) changed the title WebCmdlets more nullable comments Enable more nullable comments in WebCmdlets Apr 1, 2023
@iSazonov Ilya (iSazonov) changed the title Enable more nullable comments in WebCmdlets Enable more nullable annotations in WebCmdlets Apr 1, 2023
@CarloToso CarloToso mentioned this pull request Apr 3, 2023
WebRequestPSCmdlet.Common.cs nullable comments #19162
Open
22 tasks
@CarloToso
Merge branch 'master' into nullable-webcmdlets
d6abd7d
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Apr 4, 2023

Copy link
Copy Markdown

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added the Review - Needed The PR is being reviewed label Apr 11, 2023
@ghost

Deleted user (ghost) commented Apr 11, 2023

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@CarloToso

CarloToso commented Apr 20, 2023

Copy link
Copy Markdown
Contributor Author

Ilya (@iSazonov) can you merge this PR?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iSazonov
Ilya (iSazonov) enabled auto-merge (squash) April 22, 2023 18:15
@iSazonov
Ilya (iSazonov) disabled auto-merge April 22, 2023 19:06
@iSazonov

Ilya (iSazonov) commented Apr 22, 2023

Copy link
Copy Markdown
Collaborator

CarloToso Please look test fails.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost removed the Review - Needed The PR is being reviewed label Apr 22, 2023
CarloToso added 2 commits April 23, 2023 11:03
@CarloToso
Merge branch 'PowerShell:master' into nullable-webcmdlets
2705e66
@CarloToso
fix codefactor
0546067
@CarloToso

CarloToso commented Apr 23, 2023

Copy link
Copy Markdown
Contributor Author

Ilya (@iSazonov) all tests pass

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iSazonov
Ilya (iSazonov) merged commit 543b20b into PowerShell:master Apr 24, 2023
@CarloToso CarloToso mentioned this pull request May 5, 2023
Microsoft.PowerShell.Commands.WebProxy replace System.Net.IWebProxy with System.Net.WebProxy #19609
Closed
22 tasks
@CarloToso
CarloToso deleted the nullable-webcmdlets branch May 22, 2023 17:53
@ghost

Deleted user (ghost) commented Jun 29, 2023

Copy link
Copy Markdown

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

Handy links:

  • Release Notes
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@CarloToso
Enable more nullable annotations in WebCmdlets (PowerShell#19359)
d81537a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov Ilya (iSazonov) iSazonov approved these changes
@PaulHigin Paul Higinbotham (PaulHigin) Awaiting requested review from PaulHigin

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@anmenaga Andrew (anmenaga)

Labels

CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log Medium

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@CarloToso @iSazonov @anmenaga
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.