Skip to content

Add Breakpoint Label frame to optimize debug stepping performance - #2190

Merged
Justin Grote (JustinGrote) merged 3 commits into
mainfrom
feature/breakpointLabelFrame
Dec 3, 2024
Merged

Add Breakpoint Label frame to optimize debug stepping performance#2190
Justin Grote (JustinGrote) merged 3 commits into
mainfrom
feature/breakpointLabelFrame

Conversation

@JustinGrote

@JustinGrote Justin Grote (JustinGrote) commented Oct 12, 2024 •
edited
Loading

Copy link
Copy Markdown
Collaborator

PR Summary

Implements DAP DelayedStackTraceLoading and returns an artificial breakpoint label frame based on the invocation info ASAP once the debugger stops. The rest of the stack trace is then returned on a future request that doesn't block the client UI.

Capture.mp4

PR Context

Debug stepping takes 300ms+ due to waiting for stack trace collection via the slow Get-PSCallStack "hack". Further improvements will come around this later.

@JustinGrote Justin Grote (JustinGrote) changed the title Add Breakpoint label frame to optimize debug stepping performance Add Breakpoint Label frame to optimize debug stepping performance Oct 12, 2024
@JustinGrote Justin Grote (JustinGrote) linked an issue Oct 12, 2024 that may be closed by this pull request
Lazily Evaluate Variables/threads/stacktrace for better stepping performance #2189
Closed
@JustinGrote

Justin Grote (JustinGrote) commented Oct 12, 2024 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Patrick Meinecke (@SeeminglyScience) Andy Jordan (@andyleejordan) I made this a fairly minimal PR to be easy to review. Additional things I plan to do next as future incrementals

  • Add start/end/column positioning to all stack frames (it's available in the position property, just has to be serialized properly)
  • Separate variable and frame processing into independent resolution paths
  • Implement "fast path" for local runspace sessions to use the runspace debugger properties and methods rather than going thru the pipeline to fetch the frame info, ~2-3ms vs 300ms-800ms
  • Move all the scope/stack/variable resolution to a new async-based DebugStoppedContext class that can be disposed and re-instantiated cleanly and kept separate from the DebugService concerns, since LSP spec says no IDs/etc. should be reused between debug adapter stop/resumes

@andyleejordan

Andy Jordan (andyleejordan) commented Oct 14, 2024

Copy link
Copy Markdown
Member

Patrick Meinecke (@SeeminglyScience) Andy Jordan (@andyleejordan) I made this a fairly minimal PR to be easy to review. Additional things I plan to do next as future incrementals

  • Add start/end/column positioning to all stack frames (it's available in the position property, just has to be serialized properly)
  • Separate variable and frame processing into independent resolution paths
  • Implement "fast path" for local runspace sessions to use the runspace debugger properties and methods rather than going thru the pipeline to fetch the frame info, ~2-3ms vs 300ms-800ms
  • Move all the scope/stack/variable resolution to a new async-based DebugStoppedContext class that can be disposed and re-instantiated cleanly and kept separate from the DebugService concerns, since LSP spec says no IDs/etc. should be reused between debug adapter stop/resumes

I'm super excited for all of this.

@JustinGrote Justin Grote (JustinGrote) mentioned this pull request Oct 14, 2024
Closed
andyleejordan
Andy Jordan (andyleejordan) reviewed Oct 17, 2024
View reviewed changes

@andyleejordan Andy Jordan (andyleejordan) 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.

Patrick Meinecke (@SeeminglyScience) and I are going to take a closer look at this just to be sure nothing got missed.

Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs Outdated
@JustinGrote Justin Grote (JustinGrote) removed a link to an issue Oct 17, 2024
Lazily Evaluate Variables/threads/stacktrace for better stepping performance #2189
Closed
@JustinGrote Justin Grote (JustinGrote) mentioned this pull request Oct 26, 2024
Open
@andyleejordan
Andy Jordan (andyleejordan) requested a review from a team as a code owner November 18, 2024 18:53
@JustinGrote

Justin Grote (JustinGrote) commented Nov 19, 2024

Copy link
Copy Markdown
Collaborator Author

This has been rebased to the latest prerelease and is good for re-review.

SeeminglyScience
Patrick Meinecke (SeeminglyScience) previously requested changes Nov 26, 2024
View reviewed changes

@SeeminglyScience Patrick Meinecke (SeeminglyScience) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks Justin! Couple of questions and minor requests

Comment thread src/PowerShellEditorServices/Services/DebugAdapter/DebugService.cs Outdated
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs Outdated
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs Outdated
andyleejordan
Andy Jordan (andyleejordan) requested changes Nov 26, 2024
View reviewed changes

@andyleejordan Andy Jordan (andyleejordan) 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.

Loving this, we finally got to review through it. Just a couple changes requested and then we want to get into pre-release.

Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/ScopesHandler.cs Outdated
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs Outdated
Comment thread src/PowerShellEditorServices/Utility/LspDebugUtils.cs
Comment thread src/PowerShellEditorServices/Services/DebugAdapter/Handlers/StackTraceHandler.cs Outdated
Copilot AI reviewed Nov 26, 2024
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated no suggestions.

@JustinGrote

Justin Grote (JustinGrote) commented Nov 26, 2024

Copy link
Copy Markdown
Collaborator Author

Andy Jordan (@andyleejordan) Patrick Meinecke (@SeeminglyScience) your opinions have officially been deemed irrelevant by our AI overlords, please approve as is /s
image

@JustinGrote
Add Breakpoint label frame to optimize debug stepping performance
5888844
@JustinGrote @SeeminglyScience
Incorporate PR Review Feedback
b8b3aa2 
Co-authored-by: Patrick Meinecke <SeeminglyScience@users.noreply.github.com>
@JustinGrote
Justin Grote (JustinGrote) force-pushed the feature/breakpointLabelFrame branch 2 times, most recently from 47a2634 to 9414af6 Compare December 2, 2024 05:27
@JustinGrote

Justin Grote (JustinGrote) commented Dec 2, 2024

Copy link
Copy Markdown
Collaborator Author

All feedback should be addressed. I also removed some of the TraceOutput log stuff I was experimenting with, I'm going to submit a separate test-specific PR to revamp the DAP E2E tests.

andyleejordan
Andy Jordan (andyleejordan) approved these changes Dec 3, 2024
View reviewed changes

@andyleejordan Andy Jordan (andyleejordan) 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.

YOLO, I mean I love it and it's been thoroughly reviewed. Thanks Justin! Excited to get this out.

@JustinGrote
Justin Grote (JustinGrote) deleted the feature/breakpointLabelFrame branch December 3, 2024 22:41
@JustinGrote

Justin Grote (JustinGrote) commented Dec 3, 2024

Copy link
Copy Markdown
Collaborator Author

Andy Jordan (@andyleejordan) this wording sounded so unnecessarily passive aggressive, LOL
image

Thanks! Excited to speed this up, it's annoyed me for YEARS.

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

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@andyleejordan Andy Jordan (andyleejordan) andyleejordan approved these changes
@SeeminglyScience Patrick Meinecke (SeeminglyScience) Awaiting requested review from SeeminglyScience

Assignees

@JustinGrote Justin Grote (JustinGrote)

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@JustinGrote @andyleejordan @SeeminglyScience