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 — Fix webcmdlets so that an empty `Get` does not include a `content-length` header by SteveL-MSFT · Pull Request #16587 · PowerShell/PowerShell

Conversation

@SteveL-MSFT

@SteveL-MSFT Steve Lee (SteveL-MSFT) commented Dec 9, 2021 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

PR Summary

This change #10034 sets an empty string for the content which results in a content-length header with value 0. This was to fix a case where a web service doesn't accept explicit empty content for a put call. However, this broke a case with a get call where normally you don't send content and the server side is failing the request when we specify a content-length header with value 0.

So the change here is to only add the content-length header for empty content if it's not a get method call.

I was running the tests locally and the numerous progress bars being rendered created a different problem (hitting a debug assert), so to avoid that I suppressed all progress in the tests as it's not really used for the tests. Existing get test was modified to check that this header isn't being added.

Also had to update dotnet links so that static analysis passes as their old links no longer work.

PR Context

If you use:

invoke-restmethod https://api.npmjs.org/downloads/range/last-month/@microsoft/mgt

This fails with the server reporting a 500 (internal server error), but works with Windows PowerShell 5.1.

Fix #15186

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
@SteveL-MSFT
Fix webcmdlets so that an empty Get does not include a zero content…
f8e6d80
…-length
@SteveL-MSFT Steve Lee (SteveL-MSFT) added BackPort-7.1.x-Consider labels Dec 9, 2021
@SteveL-MSFT
Steve Lee (SteveL-MSFT) requested a review from Paul Higinbotham (PaulHigin) as a code owner December 9, 2021 21:29
@ghost ghost assigned Aditya Patwardhan (adityapatwardhan) Dec 9, 2021
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Small label Dec 9, 2021
@SteveL-MSFT
Fix handling of empty content
6f7ad24
PaulHigin
Paul Higinbotham (PaulHigin) suggested changes Dec 9, 2021
View reviewed changes
Comment thread ...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Resolved

Uh oh!

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

Comment thread test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1 Resolved

Uh oh!

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

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 9, 2021
@SteveL-MSFT
update cgmanifest
38aa7ff
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 9, 2021
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added Small and removed Extra Small labels Dec 9, 2021
@SteveL-MSFT
move check for Get to only have one check for null
0ca465f
PaulHigin
Paul Higinbotham (PaulHigin) approved these changes Dec 9, 2021
View reviewed changes
Comment thread cgmanifest.json Resolved

Uh oh!

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

PaulHigin
Paul Higinbotham (PaulHigin) approved these changes Dec 9, 2021
View reviewed changes
Steve Lee (SteveL-MSFT) added 2 commits December 9, 2021 15:11
@SteveL-MSFT
handle case where ContentType is specified
bdf6dd2
@SteveL-MSFT
fix test
a2264db
PaulHigin
Paul Higinbotham (PaulHigin) approved these changes Dec 9, 2021
View reviewed changes

@PaulHigin Paul Higinbotham (PaulHigin) left a comment

Copy link
Copy Markdown
Contributor

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.

Ok, I think this makes sense. There is no content but Get request expects content (and we know this because ContentType is non null) then we return empty content, and that is Ok with most servers. It feels like there is no breaking change here since we were returning empty content before anyway.

Sorry, something went wrong.

Uh oh!

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

SteveL-MSFT reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@SteveL-MSFT
update dotnet URLs
b0a6580
iSazonov
Ilya (iSazonov) reviewed Dec 10, 2021
View reviewed changes
Comment thread ...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Resolved

Uh oh!

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

@SteveL-MSFT
revert changes to cgmanifest and docs
1b624e1
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added Extra Small and removed Small labels Dec 10, 2021
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Dec 10, 2021

Copy link
Copy Markdown
Member Author

Will pickup cgmanifest and static analysis failures from doc hyperlinks once those PRs are merged to master rather than having those fixes as part of this PR

All reactions

Sorry, something went wrong.

Uh oh!

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

@iSazonov

Ilya (iSazonov) commented Dec 15, 2021

Copy link
Copy Markdown
Collaborator

Steve Lee (@SteveL-MSFT) We get another fix for #15186 in the PR #16563. It seems it cover more scenarios but doesn't have tests. How we will resolve the situation?

All reactions

Sorry, something went wrong.

Uh oh!

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

@iSazonov Ilya (iSazonov) mentioned this pull request Dec 15, 2021
WebCmdlets: empty body should not be added for Get Methods #16563
Closed
8 of 22 tasks
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Dec 17, 2021

Copy link
Copy Markdown
Member Author

Ilya (@iSazonov) unfortunately I didn't see that issue and the PR. I think I'll combine that PR into this one to cover other Get cases.

iSazonov reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

@SteveL-MSFT
fix to support custom Get
823f305
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Dec 17, 2021

Copy link
Copy Markdown

This PR has 28 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       : +27 -1
Percentile : 11.2%

Total files changed: 2

Change summary by file extension:
.cs : +3 -1
.ps1 : +24 -0

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.

All reactions

Sorry, something went wrong.

Uh oh!

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

@ghost

Deleted user (ghost) commented Dec 25, 2021

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.

adityapatwardhan
Aditya Patwardhan (adityapatwardhan) approved these changes Jan 3, 2022
View reviewed changes
@adityapatwardhan
Aditya Patwardhan (adityapatwardhan) merged commit 7a2b445 into PowerShell:master Jan 3, 2022
@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 3, 2022
@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 Jan 3, 2022
@SteveL-MSFT
Steve Lee (SteveL-MSFT) deleted the web-empty-get branch January 4, 2022 16:29
TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
@SteveL-MSFT @TrapGodBrim
Fix web cmdlets so that an empty Get does not include a `content-le…
7c7466b
…ngth` header (PowerShell#16587)
@ghost

Deleted user (ghost) commented Feb 24, 2022

Copy link
Copy Markdown

🎉v7.3.0-preview.2 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.

@ghost ghost mentioned this pull request Feb 24, 2022
Invoke-WebRequest/Invoke-RestMethod: PR #10034 violates RFC7230 and therefore breaks HTTP Desync Mitigation modes #15186
Closed
@TravisEz13

Travis Plunk (TravisEz13) commented Mar 2, 2022

Copy link
Copy Markdown
Member

@PowerShell/powershell-maintainers
We only take security fixes and regression to LTS. This is appropriate for 7.3. This is not a regression from PowerShell 6.0 and newer. There is some concern about stability. Rejecting back-port for now.

Let's give this some bake time in 7.3 and reconsider.

All reactions

Sorry, something went wrong.

Uh oh!

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

@daxian-dbw Dongbo Wang (daxian-dbw) removed the BackPort-7.1.x-Consider label Mar 2, 2022
@TravisEz13 Travis Plunk (TravisEz13) added the Review - Committee The PR/Issue needs a review from the PowerShell Committee label Mar 29, 2022
@TravisEz13

Travis Plunk (TravisEz13) commented Mar 29, 2022

Copy link
Copy Markdown
Member

@PowerShell/powershell-committee This issue was introduced 2 LTS (during 7.0 preview) ago and doesn't meeting the servicing criteria that the maintainers understand they have the authority to approve. Please clarify if this meets the backport criteria.

All reactions

Sorry, something went wrong.

Uh oh!

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

@SteveL-MSFT Steve Lee (SteveL-MSFT) added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Apr 27, 2022
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Apr 27, 2022

Copy link
Copy Markdown
Member Author

@PowerShell/powershell-committee reviewed this. Given this is a regression from 5.1 and PSCore6.x as well as real world impact based on the IETF RFC that we SHOULD not be sending content-length for empty payload, we recommend taking this to 7.2

All reactions

Sorry, something went wrong.

Uh oh!

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

@TravisEz13

Travis Plunk (TravisEz13) commented May 4, 2022

Copy link
Copy Markdown
Member

/backport to release/v7.2.4

All reactions

Sorry, something went wrong.

Uh oh!

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

@TravisEz13 Travis Plunk (TravisEz13) added Backport-7.2.x-Approved and removed Backport-7.2.x-Consider labels May 4, 2022
@github-actions

github-actions Bot commented May 4, 2022 •
edited by unfurl-links Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor

Started backporting to release/v7.2.4: https://github.com/PowerShell/PowerShell/actions/runs/2271259009

GitHub
Fix webcmdlets so that an empty `Get` does not include a `content-length` header · PowerShell/PowerShell@de04e8d
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.
All reactions

Sorry, something went wrong.

Uh oh!

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

@github-actions

github-actions Bot commented May 4, 2022

Copy link
Copy Markdown
Contributor

Travis Plunk (@TravisEz13) backporting to release/v7.2.4 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix webcmdlets so that an empty `Get` does not include a zero content-length
Applying: Fix handling of empty content
Applying: update cgmanifest
Using index info to reconstruct a base tree...
A	cgmanifest.json
Falling back to patching base and 3-way merge...
Auto-merging tools/cgmanifest.json
CONFLICT (content): Merge conflict in tools/cgmanifest.json
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0003 update cgmanifest
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

All reactions

Sorry, something went wrong.

Uh oh!

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

Aditya Patwardhan (adityapatwardhan) pushed a commit that referenced this pull request May 9, 2022
@SteveL-MSFT @adityapatwardhan
Fix web cmdlets so that an empty Get does not include a `content-le…
1023013
…ngth` header (#16587)
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) added Backport-7.2.x-Done and removed Backport-7.2.x-Approved labels May 9, 2022
@ghost

Deleted user (ghost) commented May 17, 2022

Copy link
Copy Markdown

🎉v7.2.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.

@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request May 24, 2022
Update TLS test based on current platform settings #17424
Merged
@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request Jun 7, 2022
Backport test fixes for 7.2 #17494
Merged
22 tasks
@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request Apr 16, 2024
WIP: add more detail to suspicious scriptblock logging #21475
Closed
@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request Jul 9, 2024
Add script to update SDK for release branches #24034
Merged
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@SteveL-MSFT
Fix web cmdlets so that an empty Get does not include a `content-le…
480c693
…ngth` header (PowerShell#16587)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) adityapatwardhan approved these changes
@iSazonov Ilya (iSazonov) iSazonov approved these changes
+1 more reviewer
@PaulHigin Paul Higinbotham (PaulHigin) PaulHigin approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

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

Assignees

@adityapatwardhan Aditya Patwardhan (adityapatwardhan)

Labels

Backport-7.2.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Committee-Reviewed PS-Committee has reviewed this and made a decision Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Invoke-WebRequest/Invoke-RestMethod: PR #10034 violates RFC7230 and therefore breaks HTTP Desync Mitigation modes

Uh oh!

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

6 participants

@SteveL-MSFT @iSazonov @TravisEz13 @adityapatwardhan @PaulHigin @daxian-dbw
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.