Skip to content
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.

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

Revert "Adjust PUT method behavior to POST one for default content type in WebCmdlets" #21049

Merged

Conversation

SteveL-MSFT
Copy link
Member

Reverts #19152

This has been reported as a regression for the cmdlet working against Azure Blob Storage. The added content-type with PUT is causing the request to be rejected. It seems that curl does add the content-type for POST, but not for PUT, so we should do the same with the cmdlets.

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       : +7 -15
Percentile : 8.8%

Total files changed: 2

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

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
Copy link
Collaborator

It seems that curl does add the content-type for POST, but not for PUT,

There was another comment from @CarloToso #16318 (comment)

Curl doesn't add any Content-Type for POST and PUT

Original request from #16318 was that all method should work identically.

Single difference from POST and PUT is #16318 (comment)

The difference between POST and PUT is that PUT requests are idempotent. That is, calling the same PUT request multiple times will always produce the same result. In contrast, calling a POST request repeatedly have side effects of creating the same resource multiple times.

Adding the Content Type to the PUT was an attempt to avoid regression in PowerShell scenarios compared to removing it from the POST.

If we still see regression, then we return to the original question of how to make methods with one behavior - remove ContentType from POST as in curl? And do we need to leave this default value there for hashtables as specific PowerShell scenario?


This change was made almost a year(!) ago at the beginning of milestone. I'm surprised why the team spends so much effort on releasing monthly previews if no one uses them even with Azure.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Jan 19, 2024
@SteveL-MSFT
Copy link
Member Author

@iSazonov agree that this should have been found earlier and I've given the reporting team feedback to be actively testing against our previews. When did we add the content-type to POST?

@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Jan 31, 2024
@iSazonov
Copy link
Collaborator

iSazonov commented Feb 1, 2024

When did we add the content-type to POST?

Feb 15, 2022 #19152

@SteveL-MSFT SteveL-MSFT added WG-Cmdlets general cmdlet issues WG-NeedsReview Needs a review by the labeled Working Group labels Feb 5, 2024
@SteveL-MSFT
Copy link
Member Author

The @PowerShell/wg-powershell-cmdlets reviewed this. Given that there hasn't been reports of experienced regression of the change in POST behavior with regards to the content-type header since that change was more than 2 years ago, we would suggest not changing that. However, since there has already been reports of users experiencing regressions moving to 7.4 with the new PUT behavior of adding the content-type header, we agreed to revert the PUT behavior change. Although curl does not add the content-type header whether POST or PUT is used, we can continue to keep the current POST behavior in the web cmdlets as there hasn't been reports of issues.

@SteveL-MSFT SteveL-MSFT added WG-Reviewed A Working Group has reviewed this and made a recommendation and removed WG-NeedsReview Needs a review by the labeled Working Group labels Feb 7, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added Review - Needed The PR is being reviewed labels Feb 14, 2024
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

LGTM

@daxian-dbw daxian-dbw merged commit 05ed2f2 into master Feb 26, 2024
38 checks passed
@daxian-dbw daxian-dbw deleted the revert-19152-Webcmdlets-automatic-ContentType-PUT branch February 26, 2024 19:51
@daxian-dbw daxian-dbw added CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log and removed Review - Needed The PR is being reviewed labels Feb 26, 2024
SeeminglyScience pushed a commit to SeeminglyScience/PowerShell that referenced this pull request Apr 4, 2024
daxian-dbw pushed a commit that referenced this pull request Apr 5, 2024
…efault content type in WebCmdlets" (#21049) (#21428)

Co-authored-by: Steve Lee <slee@microsoft.com>
@Moazzem-Hossain-pixel

This comment was marked as off-topic.

Copy link

@Moazzem-Hossain-pixel Moazzem-Hossain-pixel left a comment

Choose a reason for hiding this comment

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

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BackPort-7.4.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small WG-Cmdlets general cmdlet issues WG-Reviewed A Working Group has reviewed this and made a recommendation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants