Skip to content

Enable creating composite subsystem implementation in modules #18888

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
daxian-dbw merged 4 commits into from
Jan 5, 2023
Merged

Enable creating composite subsystem implementation in modules #18888

daxian-dbw merged 4 commits into from
Jan 5, 2023

Conversation

@daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Jan 4, 2023

PR Summary

Fix #18853

Enable creating composite subsystem implementation in modules.
It turns out the Kind member in ISubsystem is not needed. Whether an implementation derives from the target subsystem interface should be the only criteria to check if this implementation can be registered to the target subsystem.

Refactored the subsystem code to remove the Kind member from the base interface ISubsystem, so as to allow one class to implement multiple subsystem interfaces.

This is not a breaking change because the Kind member was made internal to prevent users from directly implement it. Now one can directly implements ISubsystem, but that implementation won't be able to be registered to PowerShell.

PR Checklist

@daxian-dbw daxian-dbw requested a review from SteveL-MSFT January 4, 2023 19:53
@daxian-dbw daxian-dbw self-assigned this Jan 4, 2023
@daxian-dbw daxian-dbw added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log and removed CL-Engine Indicates that a PR should be marked as an engine change in the Change Log labels Jan 4, 2023
@SteveL-MSFT
Copy link
Member

SteveL-MSFT commented Jan 4, 2023

@daxian-dbw please address the codefactor isses

@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Jan 4, 2023

This PR has 186 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Medium
Size       : +125 -61
Percentile : 57.2%

Total files changed: 10

Change summary by file extension:
.cs : +120 -56
.resx : +5 -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? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@daxian-dbw
Copy link
Member Author

daxian-dbw commented Jan 4, 2023

@SteveL-MSFT I fixed those CodeFactor issues that can be addressed. The remaining 2 are by design.

@daxian-dbw daxian-dbw merged commit eb31d32 into PowerShell:master Jan 5, 2023
@daxian-dbw daxian-dbw deleted the compositeSubsystem branch January 5, 2023 17:51
@ghost
Copy link

ghost commented Mar 14, 2023

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

Handy links:

@ghost ghost mentioned this pull request Mar 14, 2023
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SteveL-MSFT SteveL-MSFT SteveL-MSFT approved these changes

@iSazonov iSazonov iSazonov approved these changes

Assignees

@daxian-dbw daxian-dbw

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Medium

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Cannot implement both IFeedbackProvider and ICommandPredictor in same class

3 participants

@daxian-dbw @SteveL-MSFT @iSazonov