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

Jump to bottom

Throw when too many parameter sets are defined #17881

Merged
merged 2 commits into from Aug 22, 2022
Merged

Throw when too many parameter sets are defined #17881

merged 2 commits into from Aug 22, 2022

Conversation

fflaten
Copy link
Contributor

@fflaten fflaten commented Aug 12, 2022 •
edited

PR Summary

Fixes a bug that caused an exception for ParsingTooManyParameterSets to never be thrown when a command has more than 32 parameter sets.

PR Context

Due to use of uint bitmask for parameter sets lookup, a maximum of 32 parameter sets are allowed in commands/scriptblocks. The intended exception when 33+ sets are defined was never thrown due to a bug, causing an index overflow that registers parameters in set 33 and higher in existing sets.

Fix #9372

PR Checklist

@fflaten
Copy link
Contributor Author

fflaten commented Aug 12, 2022

This is technically a breaking change, but it was never intended to work and works based on luck since the parameter sets get corrupted (33rd set adds parameters to set 1 etc.).

The limit is already documented as part of MicrosoftDocs/PowerShell-Docs#4778

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Aug 12, 2022
@pull-request-quantifier
Copy link

This PR has 11 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       : +10 -1
Percentile : 4.4%

Total files changed: 2

Change summary by file extension:
.cs : +2 -1
.ps1 : +8 -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? 👍  👌  👎 (Email)
Customize PullRequestQuantifier for this repository.

daxian-dbw
daxian-dbw approved these changes Aug 12, 2022
View changes
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

@msftbot msftbot bot added the Review - Needed The PR is being reviewed label Aug 20, 2022
@msftbot
Copy link

msftbot bot commented Aug 20, 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

@msftbot msftbot bot removed the Review - Needed The PR is being reviewed label Aug 22, 2022
@daxian-dbw daxian-dbw merged commit a15bfcb into PowerShell:master Aug 22, 2022
39 checks passed
@fflaten fflaten deleted the max-parametersets branch August 22, 2022 19:26
@iSazonov
Copy link
Collaborator

@fflaten Thanks for your contribution!

@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
@msftbot
Copy link

msftbot bot commented Dec 20, 2022

🎉v7.4.0-preview.1 has been released which incorporates this pull request.🎉

Handy links:

@msftbot msftbot bot mentioned this pull request Dec 20, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@iSazonov iSazonov iSazonov approved these changes

@SteveL-MSFT SteveL-MSFT

Assignees

@daxian-dbw daxian-dbw

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.

Limit of 32 parameter sets
4 participants
@fflaten @iSazonov @daxian-dbw @adityapatwardhan