Skip to content

Add Breakpoint Label frame to optimize debug stepping performance#2190

Merged
JustinGrote merged 3 commits intomainfrom
feature/breakpointLabelFrame
Dec 3, 2024
Merged

Add Breakpoint Label frame to optimize debug stepping performance#2190
JustinGrote merged 3 commits intomainfrom
feature/breakpointLabelFrame

Conversation

@JustinGrote
Copy link
Collaborator

@JustinGrote JustinGrote commented Oct 12, 2024 •
edited
Loading

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 JustinGrote self-assigned this Oct 12, 2024
@JustinGrote 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 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
Open
@JustinGrote JustinGrote enabled auto-merge October 12, 2024 22:28
@JustinGrote
Copy link
Collaborator Author

JustinGrote commented Oct 12, 2024 •
edited
Loading

@SeeminglyScience @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
Copy link
Member

andyleejordan commented Oct 14, 2024

@SeeminglyScience @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 JustinGrote mentioned this pull request Oct 14, 2024
Open
andyleejordan
andyleejordan reviewed Oct 17, 2024
View reviewed changes
Copy link
Member

@andyleejordan andyleejordan left a comment

Choose a reason for hiding this comment

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

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

@JustinGrote JustinGrote removed a link to an issue Oct 17, 2024
Lazily Evaluate Variables/threads/stacktrace for better stepping performance #2189
Open
@JustinGrote JustinGrote mentioned this pull request Oct 26, 2024
Open
@JustinGrote JustinGrote force-pushed the feature/breakpointLabelFrame branch from 3fbc7b7 to cc2e2a1 Compare November 16, 2024 16:50
@andyleejordan andyleejordan requested a review from a team as a code owner November 18, 2024 18:53
@andyleejordan andyleejordan force-pushed the main branch 2 times, most recently from 80b2351 to 9ce8911 Compare November 18, 2024 19:05
@JustinGrote JustinGrote force-pushed the feature/breakpointLabelFrame branch from cc2e2a1 to f052fa5 Compare November 19, 2024 00:24
@JustinGrote
Copy link
Collaborator Author

JustinGrote commented Nov 19, 2024

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

SeeminglyScience
SeeminglyScience previously requested changes Nov 26, 2024
View reviewed changes
Copy link
Collaborator

@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.

Thanks Justin! Couple of questions and minor requests

andyleejordan
andyleejordan requested changes Nov 26, 2024
View reviewed changes
Copy link
Member

@andyleejordan andyleejordan left a comment

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.

@JustinGrote JustinGrote requested a review from Copilot November 26, 2024 20:05
Copilot AI reviewed Nov 26, 2024
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

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
Copy link
Collaborator Author

JustinGrote commented Nov 26, 2024

@andyleejordan @SeeminglyScience your opinions have officially been deemed irrelevant by our AI overlords, please approve as is /s
image

@JustinGrote JustinGrote force-pushed the feature/breakpointLabelFrame branch from 939e2c4 to 84b55f8 Compare November 27, 2024 03:33
@JustinGrote JustinGrote force-pushed the feature/breakpointLabelFrame branch 2 times, most recently from 47a2634 to 9414af6 Compare December 2, 2024 05:27
@JustinGrote JustinGrote force-pushed the feature/breakpointLabelFrame branch from 9414af6 to 414599f Compare December 2, 2024 05:51
@JustinGrote
Copy link
Collaborator Author

JustinGrote commented Dec 2, 2024

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.

@JustinGrote JustinGrote disabled auto-merge December 2, 2024 05:56
@JustinGrote JustinGrote enabled auto-merge (squash) December 2, 2024 05:56
andyleejordan
andyleejordan approved these changes Dec 3, 2024
View reviewed changes
Copy link
Member

@andyleejordan andyleejordan left a comment

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 JustinGrote merged commit a5aaad8 into main Dec 3, 2024
@JustinGrote JustinGrote deleted the feature/breakpointLabelFrame branch December 3, 2024 22:41
@JustinGrote
Copy link
Collaborator Author

JustinGrote commented Dec 3, 2024

@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 left review comments

@andyleejordan andyleejordan andyleejordan approved these changes

@SeeminglyScience SeeminglyScience Awaiting requested review from SeeminglyScience

Assignees

@JustinGrote JustinGrote

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JustinGrote @andyleejordan @SeeminglyScience