Skip to content

Webcmdlets set default charset encoding to UTF8 - #18219

Merged
Ilya (iSazonov) merged 12 commits into
PowerShell:masterfrom
CarloToso:master
Nov 2, 2022
Merged

Ilya (iSazonov) merged 12 commits into
PowerShell:masterfrom
CarloToso:master

Conversation

@CarloToso

@CarloToso CarloToso commented Oct 4, 2022 •

Copy link
Copy Markdown
Contributor

PR Summary

Changes the default charset encoding of webcmdlets from Ascii to UTF8
It's just a small fix, it does not solve BOM related problems #11547

PR Context

Fixes #10971

PR Checklist

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Oct 11, 2022
@ghost

Deleted user (ghost) commented Oct 12, 2022 •

Copy link
Copy Markdown

CLA assistant check
All CLA requirements met.

@iSazonov

Copy link
Copy Markdown
Collaborator

Steve Lee (@SteveL-MSFT) I think the PR makes sense but we need WG/Committee conclusion since we are moving away from RFC standard.

@CarloToso

Copy link
Copy Markdown
Contributor Author

Steve Lee (@SteveL-MSFT) do you have any updates?

@iSazonov Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Oct 20, 2022
@iSazonov

Copy link
Copy Markdown
Collaborator

CarloToso Please fix tests.

@iSazonov

Copy link
Copy Markdown
Collaborator

CarloToso You should sign CLA before we can merge.

@daxian-dbw

Copy link
Copy Markdown
Member

Marking Cmdlet WG to review.

@SteveL-MSFT

Copy link
Copy Markdown
Member

Added to WG queue

@pull-request-quantifier-deprecated

Copy link
Copy Markdown

This PR has 39 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 -32
Percentile : 15.6%

Total files changed: 3

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

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.

@ghost ghost added the Review - Needed The PR is being reviewed label Nov 1, 2022
@ghost

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

@SteveL-MSFT

Copy link
Copy Markdown
Member

@PowerShell/wg-powershell-cmdlets reviewed this and compared the behavior to curl which correctly handles the UTF-8 BOM so we agree that the default should be UTF-8 instead of Ascii"

@ghost ghost removed the Review - Needed The PR is being reviewed label Nov 2, 2022
@iSazonov Ilya (iSazonov) added the Review - Needed The PR is being reviewed label Nov 2, 2022
@iSazonov Ilya (iSazonov) removed the Review - Needed The PR is being reviewed label Nov 2, 2022
@iSazonov
Ilya (iSazonov) merged commit 489e316 into PowerShell:master Nov 2, 2022
@iSazonov

Copy link
Copy Markdown
Collaborator

CarloToso Thanks for your contribution!

@CarloToso

Copy link
Copy Markdown
Contributor Author

Ilya (@iSazonov) Thank you for your guidance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Invoke-RestMethod/Invoke-WebRequest should set charset=utf-8 for application/json by default

6 participants