Skip to content

Add property and event for debug attach#25788

Merged
SeeminglyScience merged 2 commits intoPowerShell:masterfrom
jborean93:debug-attach
Oct 7, 2025
Merged

Add property and event for debug attach#25788
SeeminglyScience merged 2 commits intoPowerShell:masterfrom
jborean93:debug-attach

Conversation

@jborean93
Copy link
Copy Markdown
Collaborator

@jborean93 jborean93 commented Jul 29, 2025

PR Summary

Adds the IsRemoteDebuggerAttached property to Runspace that indicates whether a debugger is attached to the Runspace through the Debug-Runspace cmdlet. Also adds a new engine event PowerShell.OnDebugAttach that is emitted when the debugger is attached.

PR Context

Fixes: #21392

Also see PowerShell/PowerShellEditorServices#2250 which is the driver behind the new event. Unfortunately the only safe way to notify that code is safe to continue and a debugger is attached is through PowerShell. Sending our own event before calling Debug-Runspace won't work because the code could continue before Debug-Runspace has set itself up. We cannot send an event after because the runspace will be busy running Debug-Runspace.

PR Checklist

This was referenced Jul 29, 2025
Draft
Closed
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 29, 2025
kilasuit
kilasuit reviewed Jul 29, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@kilasuit kilasuit left a comment

Choose a reason for hiding this comment

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

Looks good & only minor thought, can you see benefit in also adding a OnDebugDetach event too?

@jborean93
Copy link
Copy Markdown
Collaborator Author

jborean93 commented Jul 29, 2025

Looks good & only minor thought, can you see benefit in also adding a OnDebugDetach event too?

I debated adding it internally and I couldn't think of a scenario where an end user would want to wait for a detach before continuing. But in saying that if there is something I haven't thought off I can definitely add it.

@kilasuit
Copy link
Copy Markdown
Collaborator

kilasuit commented Jul 29, 2025

Lets leave adding that as a future enhancement for now as it seems to be small enough a change that should be a good win for someone else coming to the repo looking to contribute.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Aug 6, 2025
@SeeminglyScience SeeminglyScience added the WG-NeedsReview Needs a review by the labeled Working Group label Oct 1, 2025
@SeeminglyScience
Copy link
Copy Markdown
Contributor

SeeminglyScience commented Oct 1, 2025

Thanks Jordan! Gonna add this to the Engine WG queue just to 👍 the public API and new engine event.

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Oct 2, 2025

/azp run PowerShell-Windows-Packaging-CI, PowerShell-CI-linux-packaging

@azure-pipelines
Copy link
Copy Markdown

azure-pipelines bot commented Oct 2, 2025

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Oct 2, 2025
@kilasuit
Copy link
Copy Markdown
Collaborator

kilasuit commented Oct 6, 2025

The Engine WG was able to review this today & have signed off on adding this behaviour. We however would like additional code review to happen prior to merging.

@kilasuit kilasuit added WG-Engine core PowerShell engine, interpreter, and runtime WG-Reviewed A Working Group has reviewed this and made a recommendation and removed WG-NeedsReview Needs a review by the labeled Working Group labels Oct 6, 2025
@jborean93
Add property and event for debug attach
3adbd64 
Adds the `IsRemoteDebuggerAttached` property to `Runspace` that
indicates whether a debugger is attached to the Runspace through the
`Debug-Runspace` cmdlet. Also adds a new engine event
`PowerShell.OnDebugAttach` that is emitted when the debugger is
attached.
@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Oct 7, 2025

/azp run PowerShell-Windows-Packaging-CI, PowerShell-CI-linux-packaging

@azure-pipelines
Copy link
Copy Markdown

azure-pipelines bot commented Oct 7, 2025

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

SeeminglyScience
SeeminglyScience requested changes Oct 7, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@SeeminglyScience SeeminglyScience left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks Jordan! Just two minor suggestions. Feel free to ping me on discord when resolved and I'll merge after tests finish

@microsoft-github-policy-service microsoft-github-policy-service bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 7, 2025
@jborean93 @SeeminglyScience
Apply suggestions from code review
5c0cd99 
Co-authored-by: Patrick Meinecke <[email protected]>
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 7, 2025
SeeminglyScience
SeeminglyScience approved these changes Oct 7, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@SeeminglyScience SeeminglyScience left a comment

Choose a reason for hiding this comment

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

LGTM!

@SeeminglyScience
Copy link
Copy Markdown
Contributor

SeeminglyScience commented Oct 7, 2025

/azp run PowerShell-CI-linux-packaging, PowerShell-Windows-Packaging-CI

@azure-pipelines
Copy link
Copy Markdown

azure-pipelines bot commented Oct 7, 2025

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@SeeminglyScience SeeminglyScience merged commit 0ef738b into PowerShell:master Oct 7, 2025
37 checks passed
@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

microsoft-github-policy-service bot commented Oct 7, 2025 •
edited by unfurl-links bot
Loading

📣 Hey @@jborean93, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

@jborean93 jborean93 deleted the debug-attach branch October 7, 2025 22:48
@jborean93
Copy link
Copy Markdown
Collaborator Author

jborean93 commented Oct 7, 2025

Thanks for the reviews!

SIRMARGIN pushed a commit to SIRMARGIN/PowerShell that referenced this pull request Dec 12, 2025
@jborean93 @SIRMARGIN
Add property and event for debug attach (PowerShell#25788)
134c6e3 
Adds the `IsRemoteDebuggerAttached` property to `Runspace` that
indicates whether a debugger is attached to the Runspace through the
`Debug-Runspace` cmdlet. Also adds a new engine event
`PowerShell.OnDebugAttach` that is emitted when the debugger is
attached.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov approved these changes

@SeeminglyScience SeeminglyScience SeeminglyScience approved these changes

+1 more reviewer

@kilasuit kilasuit kilasuit approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@SeeminglyScience SeeminglyScience

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log WG-Engine core PowerShell engine, interpreter, and runtime WG-Reviewed A Working Group has reviewed this and made a recommendation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add a way to see if a remote debugger has attached

4 participants

@jborean93 @kilasuit @SeeminglyScience @iSazonov