Skip to content

Fix enum-ranges for ValidateRange in proxy commands #17572

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 2 commits into from
Jul 20, 2022
Merged

Fix enum-ranges for ValidateRange in proxy commands #17572

iSazonov merged 2 commits into from
Jul 20, 2022

Conversation

@fflaten
Copy link
Contributor

@fflaten fflaten commented Jun 23, 2022 •
edited
Loading

PR Summary

In proxy commands, ValidateRange-attributes using enum-values as MinRange\MaxRange arguments will be generated properly.

PR Context

Enum-values used as MinRange\MaxRange in ValidateRangeAttribute are currently generated as unquoted strings in proxy commands. This causes an exception when trying to execute the proxy command.

# after PR, this will be generated properly
[ValidateRange([MyEnum]::Low, [MyEnum]::High)]

# these are unaffected, not forgotten
# if min OR max are int, then both are converted to int in the CommandMetadata, so they already work as expected in proxys
[ValidateRange(0, [MyEnum]::High)]
[ValidateRange([MyEnum]::Low, 1000)]

Fix #17546

PR Checklist

@ghost ghost assigned anmenaga Jun 23, 2022
@daxian-dbw daxian-dbw closed this Jun 28, 2022
@daxian-dbw daxian-dbw reopened this Jun 28, 2022
@daxian-dbw
Copy link
Member

daxian-dbw commented Jun 28, 2022

Reopen PR to re-trigger the CI runs.

@ghost ghost added the Review - Needed The PR is being reviewed label Jul 6, 2022
@ghost
Copy link

ghost commented Jul 6, 2022

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 SteveL-MSFT requested a review from PaulHigin July 18, 2022 20:41
PaulHigin
PaulHigin suggested changes Jul 18, 2022
View reviewed changes
@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed labels Jul 18, 2022
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 19, 2022
@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Jul 19, 2022

This PR has 33 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       : +32 -1
Percentile : 13.2%

Total files changed: 2

Change summary by file extension:
.cs : +5 -1
.ps1 : +27 -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 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.

PaulHigin
PaulHigin approved these changes Jul 19, 2022
View reviewed changes
Copy link
Contributor

@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

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

LGTM

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 20, 2022
@iSazonov iSazonov assigned iSazonov and unassigned anmenaga Jul 20, 2022
@iSazonov iSazonov merged commit 9ccaf10 into PowerShell:master Jul 20, 2022
@iSazonov
Copy link
Collaborator

iSazonov commented Jul 20, 2022

@fflaten Thanks for your contribution!

@fflaten fflaten deleted the fix-proxy-enumrange branch July 20, 2022 06:56
@ghost
Copy link

ghost commented Aug 12, 2022

🎉v7.3.0-preview.7 has been released which incorporates this pull request.:tada:

Handy links:

@ghost ghost mentioned this pull request Aug 12, 2022
Closed
5 tasks
@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements

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.

ProxyCommand breaks ValidateRange for enum-parameters

5 participants

@fflaten @daxian-dbw @iSazonov @PaulHigin @anmenaga