The Wayback Machine - https://web.archive.org/web/20221004045500/https://github.com/PowerShell/PowerShell/pull/15846
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

Convert SessionStateScopeEnumerator to struct #15846

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Convert SessionStateScopeEnumerator to struct #15846

wants to merge 2 commits into from

Conversation

xtqqczze
Copy link
Contributor

@xtqqczze xtqqczze commented Jul 30, 2021 •
edited

@msftbot msftbot bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Aug 2, 2021
@msftbot msftbot bot added the Stale label Aug 17, 2021
@msftbot
Copy link

msftbot bot commented Aug 17, 2021

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

@msftbot msftbot bot removed Stale Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Aug 17, 2021
@vexx32
Copy link
Collaborator

vexx32 commented Aug 18, 2021

Do we need to audit usages of the enumerator to ensure this won't cause issues in code areas that access the enumerator directly, if there are any?

@msftbot msftbot bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Aug 21, 2021
@msftbot msftbot bot added the Stale label Sep 7, 2021
@msftbot
Copy link

msftbot bot commented Sep 7, 2021

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

@msftbot msftbot bot closed this Sep 18, 2021
@iSazonov iSazonov reopened this Sep 18, 2021
@xtqqczze
Copy link
Contributor Author

xtqqczze commented Sep 18, 2021

Do we need to audit usages of the enumerator to ensure this won't cause issues in code areas that access the enumerator directly, if there are any?

How do you mean "access the enumerator directly"? Like this?

PowerShell/src/System.Management.Automation/engine/SessionStateCmdletAPIs.cs

Lines 54 to 55 in 6588373

SessionStateScopeEnumerator scopeEnumerator =
new SessionStateScopeEnumerator(_currentScope);

@msftbot msftbot bot removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept Stale labels Sep 18, 2021
@xtqqczze xtqqczze marked this pull request as ready for review Sep 18, 2021
@msftbot msftbot bot added the Review - Needed The PR is being reviewed label Sep 26, 2021
@msftbot
Copy link

msftbot bot commented Sep 26, 2021

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

@xtqqczze xtqqczze closed this Sep 21, 2022
@xtqqczze xtqqczze reopened this Sep 21, 2022
iSazonov
iSazonov approved these changes Sep 22, 2022
View changes
Copy link
Collaborator

@iSazonov iSazonov left a comment

LGTM.

I suggest to add #nullable enable on top of SessionStateScopeEnumerator.cs file

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

pull-request-quantifier bot commented Sep 27, 2022

This PR has 9 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       : +4 -5
Percentile : 3.6%

Total files changed: 2

Change summary by file extension:
.cs : +4 -5

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.

@xtqqczze xtqqczze marked this pull request as draft Sep 28, 2022
@xtqqczze
Copy link
Contributor Author

xtqqczze commented Sep 28, 2022

I'm not sure this change is worthwhile unless the enumerator can be refactored so that it is a ref struct, converting to draft.

@iSazonov
Copy link
Collaborator

iSazonov commented Sep 29, 2022

I'm not sure this change is worthwhile unless the enumerator can be refactored so that it is a ref struct, converting to draft.

I don't understand. Using struct for enumerator is best practice. Roslyng generates optimal code for this.

@msftbot msftbot bot 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 Sep 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iSazonov iSazonov

@daxian-dbw daxian-dbw

@SeeminglyScience SeeminglyScience

Assignees

@anmenaga anmenaga

Labels
CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@xtqqczze @vexx32 @iSazonov @anmenaga