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 — Small cleanup Invoke-RestMethod by CarloToso · Pull Request #19490 · PowerShell/PowerShell

Conversation

@CarloToso

@CarloToso CarloToso commented Apr 11, 2023 •
edited by iSazonov
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor

PR Summary

Small cleanup Invoke-RestMethod

PR Context

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 7 commits April 9, 2023 21:52
@CarloToso
simplify CheckReturnType
d9dd8ba
@CarloToso
remove var
b5a5601
@CarloToso
encoding.HeaderName is never null or empty
60b148b
@CarloToso
reorder
6122df5
@CarloToso
capitalize comments
d81b18e
@CarloToso
out ErrorRecord
ec6014a
@CarloToso
remove base
0a43252
@CarloToso
CarloToso requested a review from Paul Higinbotham (PaulHigin) as a code owner April 11, 2023 23:00
@ghost ghost assigned Paul Higinbotham (PaulHigin) Apr 11, 2023
@CarloToso
Merge branch 'master' into cleanup-invokerestmethod
b8836e7
iSazonov
Ilya (iSazonov) reviewed Apr 12, 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
revert base
f2dff39
iSazonov
Ilya (iSazonov) reviewed Apr 12, 2023
View reviewed changes
Comment thread ...erShell.Commands.Utility/commands/utility/WebCmdlet/Common/InvokeRestMethodCommand.Common.cs Outdated

// NOTE: Tests use this verbose output to verify the encoding.
WriteVerbose(string.Create(System.Globalization.CultureInfo.InvariantCulture, $"Content encoding: {encodingVerboseName}"));
WriteVerbose(string.Create(System.Globalization.CultureInfo.InvariantCulture, $"Content encoding: {encoding.HeaderName}"));

@iSazonov Ilya (iSazonov) Apr 12, 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.

HeaderName can throw.

Sorry, something went wrong.

Uh oh!

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

@CarloToso CarloToso Apr 12, 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 don't think it will throw
Test:

[System.Text.Encoding]::GetEncodings().GetEncoding().Count -eq `
([System.Text.Encoding]::GetEncodings().GetEncoding() | % {$_.EncodingName}).Count -eq `
([System.Text.Encoding]::GetEncodings().GetEncoding() | % {$_.HeaderName}).Count -eq 116 #tested on windows

Sorry, something went wrong.

Uh oh!

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

@iSazonov Ilya (iSazonov) Apr 14, 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.

There is throw in implementation.

Sorry, something went wrong.

Uh oh!

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

@CarloToso CarloToso Apr 14, 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.

EncodingName: https://source.dot.net/#System.Private.CoreLib/src/libraries/System.Private.CoreLib/src/System/Text/Encoding.cs,355
HeaderName: https://source.dot.net/#System.Private.CoreLib/src/libraries/System.Private.CoreLib/src/System/Text/Encoding.cs,371
Both can throw in the same condition: https://source.dot.net/#System.Private.CoreLib/src/libraries/System.Private.CoreLib/src/System/Text/Encoding.cs,327

So I don't think the try-catch is correct

Sorry, something went wrong.

Uh oh!

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

@iSazonov Ilya (iSazonov) May 9, 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.

I don't understand - you point NotSupportedException in the implementation but says the try-catch is not correct.

Sorry, something went wrong.

Uh oh!

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

@CarloToso CarloToso May 10, 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'll try to explain better.

  1. We obtain the encoding from StreamHelper.DecodeStream() --> TryGetEncoding() --> this will always generate a valid encoding, if there is an unrecognized encoding it will be replaced by ContentHelper.GetDefaultEncoding() --> UTF8

  2. Every valid encoding (all 116 of them) has both encoding.EncodingName and encoding.HeaderName so we don't need to check string.IsNullOrEmpty(encoding.HeaderName) and we can simply choose the name we like best

  3. If an invalid encoding got to the encodingVerboseName try-catch:

                    string encodingVerboseName;
                    try
                    {
                        encodingVerboseName = string.IsNullOrEmpty(encoding.HeaderName) ? encoding.EncodingName : encoding.HeaderName;
                    }
                    catch (NotSupportedException)
                    {
                        encodingVerboseName = encoding.EncodingName;
                    }

both the names throw in the same condition (EncodingTable.GetCodePageDataItem(_codePage) is null) so both would throw:
Cases:

string.IsNullOrEmpty(encoding.HeaderName) --> encodingVerboseName = encoding.EncodingName --> throw --> catch --> encodingVerboseName = encoding.EncodingName --> throw

!string.IsNullOrEmpty(encoding.HeaderName) --> encodingVerboseName = encoding.HeaderName --> throw --> catch --> encodingVerboseName = encoding.EncodingName --> throw

Sorry, something went wrong.

Uh oh!

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

@iSazonov Ilya (iSazonov) May 10, 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.

3 is good catch and we could use String.Empty.
I cannot agree with 1. and 2. points since it is not safe as the previous code can be changed and also there is dynamic code pages registration.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CarloToso reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

@CarloToso CarloToso May 10, 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 updated the code following your suggestions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@ghost ghost added the Review - Needed The PR is being reviewed label Apr 21, 2023
@ghost

Deleted user (ghost) commented Apr 21, 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.
@daxian-dbw Dongbo Wang (daxian-dbw) added WG-Cmdlets general cmdlet issues Needs-Triage The issue is new and needs to be triaged by a work group. labels May 1, 2023
@StevenBucher98 Steven Bucher (StevenBucher98) added the PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update label May 8, 2023
@CarloToso
Merge branch 'master' into cleanup-invokerestmethod
4e40c77
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Small label May 8, 2023
CarloToso added 2 commits May 8, 2023 23:06
@CarloToso
fix nullable
53c23b0
@CarloToso
update code
45ec2ab
@iSazonov Ilya (iSazonov) closed this May 10, 2023
@iSazonov Ilya (iSazonov) reopened this May 10, 2023
@ghost ghost removed the Review - Needed The PR is being reviewed label May 10, 2023
iSazonov
Ilya (iSazonov) approved these changes May 10, 2023
View reviewed changes
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented May 10, 2023

Copy link
Copy Markdown

This PR has 20 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       : +9 -11
Percentile : 8%

Total files changed: 1

Change summary by file extension:
.cs : +9 -11

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 May 18, 2023
@ghost

Deleted user (ghost) commented May 18, 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.
@iSazonov
Ilya (iSazonov) merged commit 371abc5 into PowerShell:master May 22, 2023
@ghost ghost removed the Review - Needed The PR is being reviewed label May 22, 2023
@CarloToso
CarloToso deleted the cleanup-invokerestmethod branch May 22, 2023 17:52
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jun 28, 2023
@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
Small cleanup Invoke-RestMethod (PowerShell#19490)
cdf8a6b
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

@PaulHigin Paul Higinbotham (PaulHigin)

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small Needs-Triage The issue is new and needs to be triaged by a work group. PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update WG-Cmdlets general cmdlet issues

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.

6 participants

@CarloToso @iSazonov @daxian-dbw @adityapatwardhan @PaulHigin @StevenBucher98
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.