Skip to content

Add Custom Remote Connections Feature - #17011

Merged
Paul Higinbotham (PaulHigin) merged 11 commits into
PowerShell:masterfrom
PaulHigin:custom_remote_connections3
Mar 23, 2022
Merged

Add Custom Remote Connections Feature#17011
Paul Higinbotham (PaulHigin) merged 11 commits into
PowerShell:masterfrom
PaulHigin:custom_remote_connections3

Conversation

@PaulHigin

Copy link
Copy Markdown
Contributor

PR Summary

This PR implements the Custom Remote Connections RFC:
https://github.com/PowerShell/PowerShell-RFC/blob/master/Archive/Draft/RFC0063-Custom-Remote-Connections.md

PR Context

These changes open up the internal PowerShell remoting API so that custom connections can be created as PowerShell modules. This PR does not introduce any new functions, and instead selectively makes some previously internal APIs public so that third parties can create custom remote connections without modifying PowerShell core engine code. See the above RFC for more details.

A new module repo has been created to serve as an example custom connection, by using the newly public API to create a named pipe custom remote connection. The module is also built in PowerShell CI to allow for testing.

This module will be transferred to the PowerShell repo at some point.
https://github.com/PaulHigin/NamedPipeConnection

PR Checklist

Comment thread build.psm1 Outdated
Comment thread src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs Outdated
@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Mar 17, 2022
@pull-request-quantifier-deprecated

Copy link
Copy Markdown

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


Quantification details

Label      : Extra Large
Size       : +796 -178
Percentile : 99.13%

Total files changed: 25

Change summary by file extension:
.psm1 : +37 -2
.cs : +478 -170
.resx : +3 -0
.ps1 : +197 -6
.config : +10 -0
.psd1 : +51 -0
.csproj : +20 -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 detetcted.
  • 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

Copy link
Copy Markdown
Contributor Author

Steve Lee (@SteveL-MSFT), ping...

@SteveL-MSFT Steve Lee (SteveL-MSFT) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@PaulHigin
Paul Higinbotham (PaulHigin) merged commit a6d0422 into PowerShell:master Mar 23, 2022
@ghost

Copy link
Copy Markdown

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

Handy links:

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026
* Changes for custom remote connections

* Remove NamedPipeConnection dependency on RemoteSessionNamedPipe.

* Enable custom connection tests and tool build for all platforms

* Fix CustomConnection.Tests.ps1

* Fix tests attempt 1

* Fix tool build

* Move test to elevated

* Fix non-Windows pipe name

* Update test for non-Windows

* Skip broken non-Windows timer

* Add comment for skipped test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants