Skip to content

Adjust PUT method behavior to POST one for default content type in WebCmdlets #19152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
iSazonov merged 5 commits into from
Mar 2, 2023
Merged

Adjust PUT method behavior to POST one for default content type in WebCmdlets #19152

iSazonov merged 5 commits into from
Mar 2, 2023

Conversation

@CarloToso
Copy link
Contributor

@CarloToso CarloToso commented Feb 14, 2023 •
edited
Loading

PR Summary

If -ContentType is null, -Headers don't contain Content-Type and -Method is POST or PUT --> WebSession.ContentHeaders[HttpKnownHeaderNames.ContentType] = "application/x-www-form-urlencoded"

@iSazonov

PR Context

Fixes #16318

PR Checklist

@CarloToso CarloToso requested a review from PaulHigin as a code owner February 14, 2023 22:36
@iSazonov
Copy link
Collaborator

iSazonov commented Feb 15, 2023 •
edited
Loading

@CarloToso Please add new test like It "Validate Invoke-WebRequest default ContentType for CustomMethod POST" { (For Invoke-RestMethod too)

@iSazonov iSazonov changed the title HttpMethod.Put -> application/x-www-form-urlencoded Adjust PUT method behavior to POST one for default content type in WebCmdlets Feb 15, 2023
@iSazonov
Copy link
Collaborator

iSazonov commented Feb 15, 2023 •
edited
Loading

I think I found a BUG (line 1491) it should check for WebSession.ContentHeaders[HttpKnownHeaderNames.ContentType] instrad of ContentType (this should be ok because if both are present ContentType overwrites WebSession.ContentHeaders[HttpKnownHeaderNames.ContentType]) unfortunately I don't know how to test it, if confirmed I'll open another PR to fix it

Please open new issue to discuss.

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Feb 15, 2023
@CarloToso
Copy link
Contributor Author

CarloToso commented Feb 15, 2023

Unrelated test failure

@iSazonov
Copy link
Collaborator

iSazonov commented Feb 15, 2023

@CarloToso Please remove unrelated information from PR description.

@ghost ghost added the Review - Needed The PR is being reviewed label Feb 22, 2023
@ghost
Copy link

ghost commented Feb 22, 2023

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
Copy link
Contributor Author

CarloToso commented Mar 1, 2023

@iSazonov can we merge this? Do we need documentation?

@iSazonov iSazonov added the Documentation Needed in this repo Documentation is needed in this repo label Mar 2, 2023
@iSazonov
Copy link
Collaborator

iSazonov commented Mar 2, 2023

Yes, please open doc issue and update the PR description to make it more clear for doc writer.

@ghost ghost removed the Review - Needed The PR is being reviewed label Mar 2, 2023
@CarloToso CarloToso mentioned this pull request Mar 2, 2023
Closed
2 tasks
@iSazonov iSazonov removed the Documentation Needed in this repo Documentation is needed in this repo label Mar 2, 2023
@iSazonov iSazonov assigned iSazonov and unassigned adityapatwardhan Mar 2, 2023
@iSazonov iSazonov enabled auto-merge (squash) March 2, 2023 17:15
@iSazonov iSazonov closed this Mar 2, 2023
auto-merge was automatically disabled March 2, 2023 17:19

Pull request was closed

@iSazonov iSazonov reopened this Mar 2, 2023
@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Mar 2, 2023

This PR has 22 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       : +15 -7
Percentile : 8.8%

Total files changed: 2

Change summary by file extension:
.cs : +1 -1
.ps1 : +14 -6

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.

@iSazonov iSazonov merged commit 8b9544b into PowerShell:master Mar 2, 2023
@ghost
Copy link

ghost commented Mar 14, 2023

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

Handy links:

@ghost ghost mentioned this pull request Mar 14, 2023
Closed
5 tasks
@CarloToso CarloToso deleted the Webcmdlets-automatic-ContentType-PUT branch March 15, 2023 22:06
@SteveL-MSFT SteveL-MSFT mentioned this pull request Jan 11, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov approved these changes

@PaulHigin PaulHigin Awaiting requested review from PaulHigin

Assignees

@iSazonov iSazonov

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Invoke-RestMethod doesn't include automatic ContentType value when not using POST method

3 participants

@CarloToso @iSazonov @adityapatwardhan