Skip to content

Remove comment and simplify condition in WebCmdlets#19251

Merged
iSazonov merged 4 commits intoPowerShell:masterfrom
CarloToso:fix-comment-proxyusedefaultcredential
Mar 1, 2023
Merged

Remove comment and simplify condition in WebCmdlets#19251
iSazonov merged 4 commits intoPowerShell:masterfrom
CarloToso:fix-comment-proxyusedefaultcredential

Conversation

@CarloToso
Copy link
Copy Markdown
Contributor

@CarloToso CarloToso commented Mar 1, 2023 •
edited by iSazonov
Loading

PR Summary

Remove wrong comment.
We can't use both parameters toghether because of ValidateParameters() line 736

            // Proxy server
            if (ProxyUseDefaultCredentials && ProxyCredential is not null)
            {
                ErrorRecord error = GetValidationError(WebCmdletStrings.ProxyCredentialConflict, "WebCmdletProxyCredentialConflictException");
                ThrowTerminatingError(error);
            }

PR Context

Found in #19173 @iSazonov @stevenebutler

PR Checklist

@CarloToso CarloToso requested a review from PaulHigin as a code owner March 1, 2023 11:38
@ghost ghost assigned daxian-dbw Mar 1, 2023
@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Mar 1, 2023
@iSazonov iSazonov changed the title WebCmdlets remove wrong comment ProxyUseDefaultCredentials Remove wrong comment in WebCmdlets Mar 1, 2023
@iSazonov iSazonov self-requested a review March 1, 2023 12:28
iSazonov
iSazonov reviewed Mar 1, 2023
View reviewed changes
...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated
{
// If both ProxyCredential and ProxyUseDefaultCredentials are passed,
// UseDefaultCredentials will overwrite the supplied credentials.
webProxy.UseDefaultCredentials = true;
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Mar 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Hmm, I think really the comment is correct since we can iwr -UseDefaultCredentials:$false -Credentials $cred

Perhaps it makes sense to remove the if

                else
                {
                    // If both ProxyCredential and ProxyUseDefaultCredentials are passed,
                    // UseDefaultCredentials will overwrite the supplied credentials.
                    webProxy.UseDefaultCredentials = ProxyUseDefaultCredentials;
                }

Copy link
Copy Markdown
Contributor Author

@CarloToso CarloToso Mar 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

No this is wrong, we have both -Credentials -UseDefaultCredentials (for Authentication) and -ProxyCredentials -ProxyUseDefaultCredentials (for Proxy)

Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Mar 1, 2023

Choose a reason for hiding this comment

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

I updated my proposal above.

Also please remove last commit as unrelated the PR.

Copy link
Copy Markdown
Contributor Author

@CarloToso CarloToso Mar 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Cases:

iwr -Proxy $proxy
#GOOD proxy with no credentials

iwr -Proxy $proxy -ProxyCredential $credentials
#GOOD proxy with credentials

iwr -Proxy $proxy -ProxyUseDefaultCredentials:$true
#GOOD proxy with default credentials

iwr -Proxy $proxy -ProxyUseDefaultCredentials:$false
#GOOD proxy with no credentials

iwr -Proxy $proxy -ProxyCredential $credentials -ProxyUseDefaultCredentials:$true
#ERROR conflicting parameters

iwr -Proxy $proxy -ProxyCredential $credentials -ProxyUseDefaultCredentials:$false
#GOOD but redundant proxy with credentials

iwr -ProxyCredential $credentials -ProxyUseDefaultCredentials
#ERROR no proxy

I think we could implement your proposal but it won't change the current behaviour and we should still remove the comment

Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Mar 1, 2023

Choose a reason for hiding this comment

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

It seems the comment is not add critical information. So I suggest:

                else
                {
                    webProxy.UseDefaultCredentials = ProxyUseDefaultCredentials;
                }

@CarloToso CarloToso changed the title Remove wrong comment in WebCmdlets Fix wrong comment in WebCmdlets Mar 1, 2023
@CarloToso CarloToso changed the title Fix wrong comment in WebCmdlets Fix wrong comments in WebCmdlets Mar 1, 2023
@iSazonov iSazonov changed the title Fix wrong comments in WebCmdlets Remove comment and simplify condition in WebCmdlets Mar 1, 2023
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

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

This PR has 4 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       : +2 -2
Percentile : 1.6%

Total files changed: 1

Change summary by file extension:
.cs : +2 -2

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 89f0b0f into PowerShell:master Mar 1, 2023
@iSazonov iSazonov assigned iSazonov and unassigned daxian-dbw Mar 1, 2023
@CarloToso CarloToso deleted the fix-comment-proxyusedefaultcredential branch March 1, 2023 18:22
@ghost
Copy link
Copy Markdown

ghost commented Mar 14, 2023

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

Handy links:

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-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@CarloToso @iSazonov @daxian-dbw