Restore `SetBreakpoints` API by rjmholt · Pull Request #11622 · PowerShell/PowerShell · GitHub

#11312 changed the SetBreakpoint() API in a breaking way. This PR restores the original API while continuing to make the new one available.

Tooling will be impacted by not crashing when targeting the SetBreakpoints API across PowerShell versions.

NOTE #11312 adds default parameters to other APIs (not broken since they were only added in the 7.0 timeframe). For compatibility it would be favourable to turn those into overloads instead.

Services #11619.

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:
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 tool ing 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).

NOTE #11312 adds default parameters to other APIs (not broken since they were only added in the 7.0 timeframe). For compatibility it would be favourable to turn those into overloads instead.

I spoke to Dongbo Wang (@daxian-dbw) about this back when I implemented #11312 and we decided that that breakage was fine.

we decided that that breakage was fine.

Well it's not mutually exclusive -- perhaps we can have both? Also, it feels like such a decision should be documented in either the PR or the extended commit message.

Yeah I thought that was captured but I guess not. I'll defer to Dongbo Wang (@daxian-dbw) for the right call here. I'm fine either way. Happy to add a comment on my old PR calling out the break.

I agree to have overloads.

Please review Paul Higinbotham (@PaulHigin)

Approving as maintainer

* Restore SetBreakpoints API * Remove default values in API methods * Fix inheriting APIs * Correct further comments * Fix breakpoint API use issues * Fix breakpoint API tests # Conflicts: # test/powershell/SDK/Breakpoint.Tests.ps1

🎉v7.0.0-rc.3 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

* Restore SetBreakpoints API * Remove default values in API methods * Fix inheriting APIs * Correct further comments * Fix breakpoint API use issues * Fix breakpoint API tests

ghost assigned Travis Plunk (TravisEz13) Jan 17, 2020

Rob Holt (rjmholt) mentioned this pull request Jan 17, 2020

Public APIs missing in PowerShell 7.0.0-rc.2 since 6.2.3 #11619

Closed

TylerLeonhardt requested review from TylerLeonhardt and Dongbo Wang (daxian-dbw) January 24, 2020 00:57

Steve Lee (SteveL-MSFT) added this to the GA-consider milestone Jan 24, 2020

PoshChan-Bot (PoshChan) reviewed Jan 28, 2020

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/Set-PSBreakpoint.cs Outdated

PoshChan-Bot (PoshChan) reviewed Jan 28, 2020

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/Set-PSBreakpoint.cs Outdated

PoshChan-Bot (PoshChan) reviewed Jan 28, 2020

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/Set-PSBreakpoint.cs Outdated

Rob Holt (rjmholt) and others added 6 commits January 29, 2020 10:24

Restore SetBreakpoints API

77cfbf8

Remove default values in API methods

92e56c6

Fix inheriting APIs

461edb7

Correct further comments

6fffccf

Fix breakpoint API use issues

1770888

Fix breakpoint API tests

b06bbe4

Rob Holt (rjmholt) force-pushed the restoreapi-setbreakpoints branch from ca802ba to b06bbe4 Compare January 29, 2020 18:26

TylerLeonhardt reviewed Jan 29, 2020

View reviewed changes

Comment thread src/System.Management.Automation/engine/remoting/server/ServerRunspacePoolDriver.cs

Paul Higinbotham (PaulHigin) approved these changes Jan 30, 2020

View reviewed changes

Travis Plunk (TravisEz13) added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Jan 30, 2020

Travis Plunk (TravisEz13) approved these changes Jan 30, 2020

View reviewed changes

Travis Plunk (TravisEz13) changed the title Restore SetBreakpoints API Restore SetBreakpoints API Jan 30, 2020

Travis Plunk (TravisEz13) merged commit f0fe356 into PowerShell:master Jan 30, 2020

Dongbo Wang (daxian-dbw) modified the milestones: GA-consider, GA-approved Jan 31, 2020

Travis Plunk (TravisEz13) modified the milestones: GA-approved, 7.0.0 Feb 8, 2020

Travis Plunk (TravisEz13) mentioned this pull request Oct 12, 2022

Back-port to 7.0: Update list of PowerShell team members in release tools #18266

Merged

22 tasks

Restore `SetBreakpoints` API by rjmholt · Pull Request #11622 · PowerShell/PowerShell · GitHub

Uh oh!

Restore SetBreakpoints API - #11622

Restore SetBreakpoints API#11622
Travis Plunk (TravisEz13) merged 6 commits into
PowerShell:masterfrom
rjmholt:restoreapi-setbreakpoints

Rob Holt (rjmholt) commented Jan 17, 2020

Uh oh!

TylerLeonhardt commented Jan 24, 2020 •
edited
Loading

Uh oh!

Uh oh!

Rob Holt (rjmholt) commented Jan 27, 2020

Uh oh!

TylerLeonhardt commented Jan 27, 2020

Uh oh!

Dongbo Wang (daxian-dbw) commented Jan 27, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Travis Plunk (TravisEz13) commented Jan 29, 2020

Uh oh!

Uh oh!

Travis Plunk (TravisEz13) left a comment

Uh oh!

Deleted user (ghost) commented Feb 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Restore `SetBreakpoints` API by rjmholt · Pull Request #11622 · PowerShell/PowerShell · GitHub

Uh oh!

Restore SetBreakpoints API - #11622

Restore SetBreakpoints API#11622Travis Plunk (TravisEz13) merged 6 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom rjmholt:restoreapi-setbreakpointsrjmholt/PowerShell:restoreapi-setbreakpointsCopy head branch name to clipboard

Conversation

Rob Holt (rjmholt) commented Jan 17, 2020

PR Checklist

Uh oh!

TylerLeonhardt commented Jan 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rob Holt (rjmholt) commented Jan 27, 2020

Uh oh!

TylerLeonhardt commented Jan 27, 2020

Uh oh!

Dongbo Wang (daxian-dbw) commented Jan 27, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Travis Plunk (TravisEz13) commented Jan 29, 2020

Uh oh!

Uh oh!

Travis Plunk (TravisEz13) left a comment

Choose a reason for hiding this comment

Uh oh!

Deleted user (ghost) commented Feb 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Restore SetBreakpoints API#11622
Travis Plunk (TravisEz13) merged 6 commits into
PowerShell:masterfrom
rjmholt:restoreapi-setbreakpoints

TylerLeonhardt commented Jan 24, 2020 •
edited
Loading