Add -Runspace parameter to all *-PSBreakpoint cmdlets by KirkMunro · Pull Request #10492 · PowerShell/PowerShell · GitHub

PR Summary

Adds an experimental -Runspace parameter Get-PSBreakpoint, Set-PSBreakpoint, Enable-PSBreakpoint, Disable-PSBreakpoint, and Remove-PSBreakpoint. This parameter is added to the "Microsoft.PowerShell.Utility.PSManageBreakpointsInRunspace" experimental flag that was added in PR Add APIs for breakpoint management in runspaces and enable attach to process without BreakAll for PSES #10338.
Refactors the classes behind the *-PSBreakpoint cmdlets so that they all work consistently. This refactoring did not change the behavior of these cmdlets beyond adding support for runspace breakpoint management, with one exception:
- Changed the default parameter set for Enable-PSBreakpoint so that it is more performant when passed in breakpoints via a pipeline. The previous configuration for this cmdlet would always result in the "Id" parameter set being used, even when you pipe in a breakpoint. This change does not impact the functionality of the cmdlet -- it still accepts pipeline input and command line input with named or unnamed parameters the same way. The only visible impact is that this cmdlet will prompt users for a breakpoint instead of an ID now. See Issue Parameter binding pipeline input, and how the default parameter set influences that behavior #10188 for a discussion related to this.

PR Context

Now that the SDK has been enhanced to support breakpoint management in runspaces (see PR #10338), this PR builds on that work, exposing a common -Runspace parameter in all *-PSBreakpoint cmdlets so that users can use the same cmdlets to manage breakpoints in their local session or in a remote runspace.

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed: Docs Issue #6259
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

Kirk Munro (@KirkMunro) At first look there is a lot of style changes in the PR. Could you please move them in another PR? It would be nice for code review.

Kirk Munro (@KirkMunro) At first look there is a lot of style changes in the PR. Could you please move them in another PR? It would be nice for code review.

Ilya (@iSazonov) I would rather not, unless I absolutely have to.

This PR was originally part of #10189, which they asked to be broken up into other PRs. After a side discussion between TylerLeonhardt, Paul Higinbotham (@PaulHigin) and Steve Lee (@SteveL-MSFT), they suggested this set of changes (adding the -Runspace parameter and refactoring under the base classes) as the second phase of the #10189 changes in an email.

The only real "style changes" are replacement of cmdlet parameter property/field pairs with just properties, using static strings where appropriate (for parameter set names), and adding regions to make the set of breakpoint cmdlet classes consistent with one another. They were made while setting up base classes for the breakpoint cmdlets, which makes the code much easier to maintain going forward. I don't think they should really get in the way of this code review.

Kirk Munro (@KirkMunro) I only want to speed up a code review of the PR. It is possible for reviewer to check up to 500 lines of code at a time. The PR has over 1000 changes. Also style changes distract and slows down code review too.

Also style changes distract and slows down code review too.

The end result of the refactoring is leaner, consistent, better defined, DRY code that is easier to work with and maintain going forward. In this case, I don't believe separating some of the changes out into a separate PR buys us anything except for more work all around.

Paul Higinbotham (@PaulHigin) Can you have a look at this?

I am not sure if this is the right direction to take for managing breakpoints in arbitrary runspaces. This has pretty big impact and so I feel there should be a formal design and sign-off before implementation. I'll add a committee review tag to get their opinion.

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.

Aditya Patwardhan (@adityapatwardhan) and Paul Higinbotham (@PaulHigin): I have merged in master and resolved all conflicts.

The single Codacy issue is incorrect, suggesting I should make a method static that cannot be made static. The PowerShell-CI-macos failures seem to have nothing to do with this PR.

I have also manually re-reviewed the code changes to ensure that nothing unexpected came from the merge.

From my perspective, this PR is good to go.

Paul Higinbotham (@PaulHigin) Please re-review the PR. Kirk Munro (@KirkMunro) Thanks for the updates

LGTM

Kirk Munro (@KirkMunro) Please open new issue in PowerShell-Docs repository.

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

Ilya (@iSazonov): Docs issue filed, and this PR has been updated with the link at the top, so it should be good to go.

Kirk Munro (@KirkMunro) Please resolve the merge conflict.

Aditya Patwardhan (@adityapatwardhan): Done.

Kirk Munro (@KirkMunro) Thank you for your contribution and your patience!

🎉v7.1.0-preview.6 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

…#10492)

add -runspace parameter to *-PSBreakpoint

491a687

Kirk Munro (KirkMunro) requested review from James Truher (JamesWTruher), Paul Higinbotham (PaulHigin), Travis Plunk (TravisEz13), Aditya Patwardhan (adityapatwardhan), Andrew (anmenaga) and Dongbo Wang (daxian-dbw) as code owners September 6, 2019 03:29

Kirk Munro (KirkMunro) mentioned this pull request Sep 6, 2019

WIP: Breakpoint management for runspaces #10189

Closed

15 tasks

Ilya (iSazonov) assigned Aditya Patwardhan (adityapatwardhan) Sep 6, 2019

Ilya (iSazonov) added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log CL-Experimental Indicates that a PR should be marked as an Experimental Feature in the Change Log labels Sep 6, 2019

Ilya (iSazonov) added this to the 7.0.0-preview.4 milestone Sep 6, 2019

Kirk Munro (KirkMunro) added 4 commits September 6, 2019 11:26

fix default param set assignment and pipeline input

854eec1

add pipeline input tests

4028aae

Codacy changes

971f0ac

Code Factor changes

67a7c43

Paul Higinbotham (PaulHigin) suggested changes Sep 12, 2019

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/PSBreakpointUpdaterCommandBase.cs

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 12, 2019

Paul Higinbotham (PaulHigin) added the Review - Committee The PR/Issue needs a review from the PowerShell Committee label Sep 12, 2019

Travis Plunk (TravisEz13) modified the milestones: 7.0.0-preview.4, 7.0.0-preview.5 Sep 12, 2019

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 12, 2019

Travis Plunk (TravisEz13) added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 16, 2019

Andrew (anmenaga) removed the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Sep 17, 2019

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 25, 2019

Travis Plunk (TravisEz13) added this to the 7.1.0-preview.4 milestone May 14, 2020

Travis Plunk (TravisEz13) removed this from the 7.1.0-preview.4 milestone May 22, 2020

ghost added the Stale label Jun 6, 2020

merge master

6f8b978

ghost removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept Stale labels Jun 13, 2020

CodeFactor changes

bc81908

Paul Higinbotham (PaulHigin) approved these changes Jun 16, 2020

View reviewed changes

ghost added the Review - Needed The PR is being reviewed label Jun 24, 2020

ghost removed the Review - Needed The PR is being reviewed label Jul 13, 2020

merge master

821e02d

Aditya Patwardhan (adityapatwardhan) approved these changes Jul 21, 2020

View reviewed changes

Aditya Patwardhan (adityapatwardhan) added this to the 7.1.0-preview.7 milestone Jul 21, 2020

Aditya Patwardhan (adityapatwardhan) merged commit 4729433 into PowerShell:master Jul 21, 2020

Kirk Munro (KirkMunro) mentioned this pull request Jul 23, 2020

Update PSBreakpoint documents for 7.1 (latest) once PR #10238 is merged MicrosoftDocs/PowerShell-Docs#6259

Closed

Andrew Sears (asears) mentioned this pull request Aug 5, 2020

Code coverage setup takes way longer when there are multiple analyzed files pester/Pester#1642

Closed

Travis Plunk (TravisEz13) modified the milestones: 7.1.0-preview.7, 7.1.0-preview.6 Aug 5, 2020

Ted B (lantrix) mentioned this pull request Aug 19, 2021

Add option to launch and debug external powershell.exe PowerShell/vscode-powershell#492

Closed

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026

Add -Runspace parameter to all *-PSBreakpoint cmdlets (PowerShell…

5c8a05c

…#10492)

Add -Runspace parameter to all *-PSBreakpoint cmdlets by KirkMunro · Pull Request #10492 · PowerShell/PowerShell · GitHub

Uh oh!

Add -Runspace parameter to all *-PSBreakpoint cmdlets - #10492

Conversation

Kirk Munro (KirkMunro) commented Sep 6, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

Ilya (iSazonov) commented Sep 6, 2019

Uh oh!

Kirk Munro (KirkMunro) commented Sep 6, 2019

Uh oh!

Ilya (iSazonov) commented Sep 6, 2019

Uh oh!

Kirk Munro (KirkMunro) commented Sep 6, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Sep 11, 2019

Uh oh!

Paul Higinbotham (PaulHigin) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Deleted user (ghost) commented Jun 6, 2020

Uh oh!

Kirk Munro (KirkMunro) commented Jun 14, 2020

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Jun 15, 2020

Uh oh!

Paul Higinbotham (PaulHigin) left a comment

Choose a reason for hiding this comment

Uh oh!

Ilya (iSazonov) commented Jun 16, 2020

Uh oh!

Deleted user (ghost) commented Jun 24, 2020

Uh oh!

Kirk Munro (KirkMunro) commented Jul 10, 2020

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Jul 13, 2020

Uh oh!

Kirk Munro (KirkMunro) commented Jul 15, 2020

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Jul 21, 2020

Uh oh!

Deleted user (ghost) commented Aug 17, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Kirk Munro (KirkMunro) commented Sep 6, 2019 •
edited
Loading

Kirk Munro (KirkMunro) commented Sep 6, 2019 •
edited
Loading