Support collapsing stack frames #50334

DanTup · 2018-05-23T09:56:17Z

Sometimes call stacks in the debugger contain a lot of frames from code that isn't the users (for example SDK code):

#0      Object._noSuchMethod (dart:core-patch/object_patch.dart:42)
#1      Object.noSuchMethod (dart:core-patch/object_patch.dart:46)
#2      HotRunner.validateReloadReport (package:flutter_tools/src/run_hot.dart:407)
#3      HotRunner._reloadSources.<anonymous closure> (package:flutter_tools/src/run_hot.dart:528)
#4      _rootRunUnary (dart:async/zone.dart:1128)
#5      _CustomZone.runUnary (dart:async/zone.dart:1012)
#6      _FutureListener.handleValue (dart:async/future_impl.dart:129)
#7      _Future._propagateToListeners.handleValueCallback (dart:async/future_impl.dart:636)
#8      _Future._propagateToListeners (dart:async/future_impl.dart:665)
#9      _Future._completeWithValue (dart:async/future_impl.dart:478)
#10     Future.wait.<anonymous closure> (dart:async/future.dart:392)
#11     _rootRunUnary (dart:async/zone.dart:1128)
#12     _CustomZone.runUnary (dart:async/zone.dart:1012)
#13     _FutureListener.handleValue (dart:async/future_impl.dart:129)
#14     _Future._propagateToListeners.handleValueCallback (dart:async/future_impl.dart:636)
#15     _Future._propagateToListeners (dart:async/future_impl.dart:665)
#16     _Future._complete (dart:async/future_impl.dart:468)
#17     _SyncCompleter.complete (dart:async/future_impl.dart:51)
#18     _completeOnAsyncReturn (dart:async-patch/async_patch.dart:246)
#19     Isolate.reloadSources (package:flutter_tools/src/vmservice.dart:1047)
#20     _asyncThenWrapperHelper.<anonymous closure> (dart:async-patch/async_patch.dart:30)
#21     _rootRunUnary (dart:async/zone.dart:1128)
#22     _CustomZone.runUnary (dart:async/zone.dart:1012)
#23     _FutureListener.handleValue (dart:async/future_impl.dart:129)
#24     _Future._propagateToListeners.handleValueCallback (dart:async/future_impl.dart:636)
#25     _Future._propagateToListeners (dart:async/future_impl.dart:665)
#26     _Future._complete (dart:async/future_impl.dart:468)
#27     _SyncCompleter.complete (dart:async/future_impl.dart:51)
#28     _completeOnAsyncReturn (dart:async-patch/async_patch.dart:246)

It would be good if we could somehow allow these to be collapsed so the user can focus on their own code, and only expand these if required.

Maybe it could even just be another presentationHint type for "unimportant" or "external" code, and VS Code can collapse consecutive frames with that hint, allowing them to be expanded by clicking?

The text was updated successfully, but these errors were encountered:

weinand · 2018-09-11T09:23:54Z

@isidorn we could collapse subsequent "uninteresting" stackframes into one expandable, right?

isidorn · 2018-09-18T08:00:29Z

@weinand yes, this could be easily done since we already use a tree for representing stack frames

weinand · 2018-09-18T08:24:22Z

Then we should plan to implement this.

isidorn · 2018-10-03T14:24:45Z

Currently we have a presentationHint both on the Source and on the StackFrame.
This feature should be based on the presenatationHint on the StackFrame imo. We could use the word deemphasize since we already use that as the presentationHint value for the Source. To be consistent and hopefully not confusing. An alternative is to have the value of something which corresponds to the UI. Or simply presentationHint: collapsed

The questions is how to name the expando element which would expand all subsequent deemphasized sources?
Foreign Stack Frames
Other Stack Frames
Collapsed Stack Frames

Also note that these unimportant stack frames will be indented. Tree does not allow me to do variable indentation based on item type, only on item depth.

fyi @roblourens

roblourens · 2018-10-03T16:10:12Z

Do we differentiate between different types of frames that might be collapsed separately? For example, if I have code that is "skipped by skipFiles" and code that is "skipped by smartStep", it might make sense for these to be marked differently so they would be collapsed as separate groups. I'm not sure what else debuggers are using presentationHint for.

I can imagine it making sense to hide "smartStep" skipped frames entirely, since I never care about them, while "skipFiles" frames I may want to inspect but don't want them to be in my face.

Maybe the DA should be able to label the collapsed group with a label that describes what's in it.

And think about the case where the collapsed frames are at the top of the stack. e.g. I break on an exception in a "skipped" file. Chrome devtools will collapse the blackboxed frames at the top of the stack and focus the first non-blackboxed frame, and show the error at that non-blackboxed frame. I'm not sure whether I like that or not, typically in that case I end up expanding the frames and looking at the real line of code that errored. But it's worth thinking about different scenarios.

DanTup · 2018-10-08T18:45:29Z

I'm not sure what else debuggers are using presentationHint for.

In Dart/Flutter we use a few:

label for async boundary markers
subtle for frames we don't have source for (I'm not totally sure why we'd have this, but it's in the code!)
deemphasize for non-debuggable code (eg. SDK or third party packages; users can toggle these) - this hint is on the source property

Probably we'd want to collapse them all together. Eg. imagine the stack looks like:

User code
Framework Code
Async boundary
Framework Code
Async boundary
Framework Code
Unknown Source
User Code

Having them collapse individually wouldn't make sense here (so doing it automatically by presentationHint would probably suck); though allowing the DA to assign a named group so they can control it might make sense.

e.g. I break on an exception in a "skipped" file. Chrome devtools will collapse the blackboxed frames at the top of the stack and focus the first non-blackboxed frame

I would love something like this. One of my gripes with the Dart debugger right now is that it breaks on exceptions inside code I've marked non-debuggable and I couldn't see an obvious way to jump back to the first debuggable source frame.

isidorn · 2018-10-25T15:50:38Z

I have pushed an initial version of this. Please try it out in tomorrow's insiders

In short it will collapse all subsequent stack frames with source that has presentation hint demphasized. The parent element will have the title Show More Stack Frame + source.origin if they all share the origin.
In the future we can do a more sophisticated grouping based on origin.

Here's an example how it looks

roblourens · 2018-10-25T15:57:16Z

Awesome. Would be great to show the number of hidden frames (Show N more frames)

isidorn · 2018-10-25T15:59:15Z

Suggestion accepted. Great idea

#50334

DanTup · 2018-10-31T13:41:39Z

@isidorn This currently shows undefined in the message for my existing code (before I've changed anything); I don't think that's expected:

Edit: Looks like this comes from origin which I don't set because it's marked optional. I guess it just needs a check before displaying.

DanTup · 2018-10-31T13:43:16Z

Also - it feels slightly strange to re-collapse as you're clicking on them. If you do want to navigate up the stack while debugging. I don't have a suggestion to fix that though; it'd need some other way to re-collapse 🤔

DanTup · 2018-10-31T13:48:19Z

Also, is there a better description for what we can/should put in origin? The comment says:

/** The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc. */

But the etc. isn't very helpful. The comment here suggests that it may have specific meanings (beyond just a string), though it seems like it might really just be a text label?

The values I'd like to put in it are for SDK sources and for third party packages.

weinand · 2018-10-31T13:50:32Z

origin is just a string shown in the UI but not interpreted by VS Code in any way.

DanTup · 2018-10-31T13:54:32Z

@weinand Great, thanks - I'll add suitable labels then :-)

(though the undefined label should still be fixed, I guess a lot of code might not provide it).

weinand · 2018-10-31T14:04:34Z

@isidorn please fix the "undefined" label for October.

DanTup · 2018-10-31T14:31:54Z

Also - it feels slightly strange to re-collapse as you're clicking on them

Seems like this behaviour is specific to when a frame has no source. If the frame has source, it navigates there and leaves the section expanded.

isidorn · 2018-10-31T15:02:19Z

I have fixed the undefined label via 9f4969b

#50334

roblourens · 2018-10-31T16:13:20Z

Also - it feels slightly strange to re-collapse as you're clicking on them

Yeah I thought I couldn't recollapse them, is this a bug or how do I do that?

isidorn · 2018-10-31T16:24:06Z

You can not recolapse. This is a design decision made by @weinand and me since they collapse again after you step.
Let's go with this design for now, and if you hate it after trying it out a bit more we can reconsider this.
Thanks

DanTup · 2018-10-31T19:12:49Z

Yeah I thought I couldn't recollapse them, is this a bug or how do I do that?

Based on the above, it's not supposed to collapse. However it seems to be a bug that if you don't have source code for a frame (you return an error from sourceRequest) then it does collapse immediately when you click on that frame.

DanTup mentioned this issue May 23, 2018

Better breakpoint stack on async function Dart-Code/Dart-Code#713

Closed

weinand added debug Debug viewlet, configurations, breakpoints, adapter issues feature-request Request for new features or functionality labels May 23, 2018

weinand self-assigned this May 23, 2018

microsoft deleted a comment from vscodebot bot Sep 11, 2018

weinand assigned isidorn and unassigned weinand Sep 11, 2018

weinand added this to the On Deck milestone Sep 11, 2018

isidorn modified the milestones: On Deck, October 2018 Oct 3, 2018

kieferrm mentioned this issue Oct 7, 2018

Iteration Plan for October 2018 #60106

Closed

38 tasks

isidorn added the on-testplan label Oct 25, 2018

isidorn closed this as completed in 1e9717a Oct 25, 2018

isidorn mentioned this issue Oct 25, 2018

Test: debug collapsing uninteresting stack frames #61809

Closed

2 tasks

isidorn added a commit that referenced this issue Oct 25, 2018

show the number of hidden frames (Show N more frames)

a3e49ca

#50334

isidorn added a commit that referenced this issue Oct 31, 2018

do not show undefined label

9f4969b

#50334

isidorn added the release-notes Release notes issues label Nov 2, 2018

vscodebot bot locked and limited conversation to collaborators Dec 10, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support collapsing stack frames #50334

Support collapsing stack frames #50334

DanTup commented May 23, 2018

weinand commented Sep 11, 2018

isidorn commented Sep 18, 2018

weinand commented Sep 18, 2018

isidorn commented Oct 3, 2018 •

edited

Loading

roblourens commented Oct 3, 2018

DanTup commented Oct 8, 2018 •

edited

Loading

isidorn commented Oct 25, 2018

roblourens commented Oct 25, 2018

isidorn commented Oct 25, 2018 •

edited

Loading

DanTup commented Oct 31, 2018 •

edited

Loading

DanTup commented Oct 31, 2018

DanTup commented Oct 31, 2018

weinand commented Oct 31, 2018

DanTup commented Oct 31, 2018

weinand commented Oct 31, 2018

DanTup commented Oct 31, 2018

isidorn commented Oct 31, 2018

roblourens commented Oct 31, 2018

isidorn commented Oct 31, 2018

DanTup commented Oct 31, 2018

Support collapsing stack frames #50334

Support collapsing stack frames #50334

Comments

DanTup commented May 23, 2018

weinand commented Sep 11, 2018

isidorn commented Sep 18, 2018

weinand commented Sep 18, 2018

isidorn commented Oct 3, 2018 • edited Loading

roblourens commented Oct 3, 2018

DanTup commented Oct 8, 2018 • edited Loading

isidorn commented Oct 25, 2018

roblourens commented Oct 25, 2018

isidorn commented Oct 25, 2018 • edited Loading

DanTup commented Oct 31, 2018 • edited Loading

DanTup commented Oct 31, 2018

DanTup commented Oct 31, 2018

weinand commented Oct 31, 2018

DanTup commented Oct 31, 2018

weinand commented Oct 31, 2018

DanTup commented Oct 31, 2018

isidorn commented Oct 31, 2018

roblourens commented Oct 31, 2018

isidorn commented Oct 31, 2018

DanTup commented Oct 31, 2018

isidorn commented Oct 3, 2018 •

edited

Loading

DanTup commented Oct 8, 2018 •

edited

Loading

isidorn commented Oct 25, 2018 •

edited

Loading

DanTup commented Oct 31, 2018 •

edited

Loading