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
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
- User-facing changes
- Testing - New and feature
- 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).
- Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
- Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
- Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
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
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
Uh oh!
There was an error while loading. Please reload this page.
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
Uh oh!
There was an error while loading. Please reload this page.
|
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
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
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
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.

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.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
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
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
🎉v7.3.0-preview.2 has been released which incorporates this pull request.:tada:
Handy links:
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@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.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@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.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@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
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
/backport to release/v7.2.4
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
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!
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
🎉v7.2.4 has been released which incorporates this pull request.:tada:
Handy links:
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Reviewers
+1 more reviewer
Reviewers whose approvals may not affect merge requirements
Uh oh!
There was an error while loading. Please reload this page.
Milestone
No milestone
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.
|