1696157 - Breakpoints panel expands when clicking on a frame in the call stack panel

Status: RESOLVED FIXED

(DevTools :: Debugger, defect, P3)

Description

[Nicolas Chevobbe [:nchevobbe]]

Attachment: dbg_breakpoint_panel.html

Steps to reproduce

1. Open the attached file
2. Open DevTools
3. Select the debugger
4. Open dbg_breakpoint_panel.html and add a breakpoint in the c function (line 30)
5. Click on "Click me" button below
6. Once the debugger pauses, collapse the breakpoint panel
7. In the callstack panel, click on the a frame

Expected results

The breakpoints panel stays collapsed

Actual results

The breakpoints panel expands

Comment 1

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Thank you for the report Nicolas, I can easily reproduce it on my machine (Win10, Fx Nightly).

Honza

Comment 2

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Note that other side panels stay collapsed.

Here is the place where we expand/collapse the panel
https://searchfox.org/mozilla-central/rev/002023eb262be9db3479142355e1675645d52d52/devtools/client/debugger/src/components/SecondaryPanes/index.js#334-337

The opened prop should be set to false if the panel should be collapsed. Perhaps something is wrong with the logic or the condition?

This could be a good first bug...

Honza

Comment 3

[RAHUL SAWRA[:rsawra]]

Hi,
I would look to work on this issue!

Comment 4

[RAHUL SAWRA[:rsawra]]

(In reply to Jan Honza Odvarko [:Honza] (always need-info? me) from comment #2)

Note that other side panels stay collapsed.

Here is the place where we expand/collapse the panel
https://searchfox.org/mozilla-central/rev/002023eb262be9db3479142355e1675645d52d52/devtools/client/debugger/src/components/SecondaryPanes/index.js#334-337

The opened prop should be set to false if the panel should be collapsed. Perhaps something is wrong with the logic or the condition?

This could be a good first bug...

Honza

Here,

opened:
        prefs.breakpointsVisible ||
        pauseReason === "breakpoint" ||
        pauseReason === "resumeLimit",

While i logged pauseReason to console, it outputs breakpoint .Hence opened prop is always true because of OR condition.

opened:
        prefs.breakpointsVisible &&
        pauseReason === "breakpoint" ||
        pauseReason === "resumeLimit",

This condition works fine and breakpoint panel remains collapsed.

Comment 5

[Nicolas Chevobbe [:nchevobbe]]

(In reply to RAHUL SAWRA[:rsawra] from comment #3)

Hi,
I would look to work on this issue!

Thanks! I assigned you the bug

Comment 6

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Thanks for helping!
Honza

Comment 7

[RAHUL SAWRA[:rsawra]]

Attachment: Bug 1696157 - Breakpoints panel expands when clicking on a frame in the call stack panel . r?nchevobbe

This bug fixes the breakpoint panel that expands.

Depends on D107222

Comment 8

[RAHUL SAWRA[:rsawra]]

Attachment: Bug 1696157 - Breakpoints panel expands when clicking on a frame in the call stack panel .r?bomsy

Comment 9

[BugBot [:suhaib / :marco/ :calixte]]

This good-first-bug hasn't had any activity for 2 months, it is automatically unassigned.
For more information, please visit auto_nag documentation.

Comment 10

[Angelina]

(In reply to Jan Honza Odvarko [:Honza] (always need-info? me) from comment #6)

Hello! Can I work on this bug?

Comment 11

[munson.hj]

Very glad to find others are interested in this (well, one or two, anyway), and very much looking forward to the problem going away. Had I a clue as to how to go about helping to fix it, I would. Also glad to see recognition that the list is supposed to stay un-expanded exactly as the other lists. I was beginning to think there was something extra-special about Breakpoints.

I would like to add that it was difficult to find NIcholas' original complaint (or any similar). 99.99% of hits alluded to variations on the problem of phantom breakpoints, even searches for quoted string "breakpoints list". And there are a lot of that sort of hit.

Comment 12

[Jan Honza Odvarko [:Honza] (always need-info? me)]

(In reply to Angelina from comment #10)

(In reply to Jan Honza Odvarko [:Honza] (always need-info? me) from comment #6)

Hello! Can I work on this bug?

Assigned to you, thank you for the help.

Comment 13

[BugBot [:suhaib / :marco/ :calixte]]

This good-first-bug hasn't had any activity for 2 months, it is automatically unassigned.
For more information, please visit auto_nag documentation.

Comment 14

[Mike Conley (:mconley) (:⚙️)]

irwp has expressed an interest in hacking on this, so assigning!

Comment 15

[irwp]

Hi Honza! The fix suggested by :rsawra seemed to fix the unexpected behavior (changing the condition from || to && above). Another bit of unexpected behavior that was fixed by this change is that when the Log checkbox on the Event Listener Breakpoints panel is checked, the Breakpoints panel would opens. I am an outreachy applicant and hope that I have submitted the patch correctly (still getting used to mercurial; moz-phab returned some confusing output).

Finally, I think there might be followup bug lurking in this code, since even after the fix there are times when the variable prefs.breakpointsVisible can sometimes be false when the panel is opened and true when the panel is closed. The about:config setting for devtools.debugger.breakpoints-visible tracks this variable so the mismatch can be seen with that. I don't fully understand what causes this mismatch but would be happy to do some further testing on it.

Comment 16

[irwp]

Attachment: WIP: Bug 1696157 Fix unexpected expanding of Breakpoints panel

Comment 17

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Thank you for the patch irwp!

The bug is fixed, but now state of the "Breakpoints" side panel isn't properly persisted. It's always collapsed when opening the Debugger panel

STRs:

1. Load any page e.g. google.com
2. Open DevTool and select the Debugger panel, the Breakpoints side panel is collapsed
3. Expand the Breakpoints side panel
4. Close and Open the DevTools Toolbox
5. Check out the Breakpoints side panel, it's closed => BUG

I don't fully understand what causes this mismatch but would be happy to do some further testing on it.

Perfect, this would be great, thank you!

Honza

Comment 18

[BugBot [:suhaib / :marco/ :calixte]]

This good-first-bug hasn't had any activity for 2 months, it is automatically unassigned.
For more information, please visit auto_nag documentation.

Comment 19

[Luke Swiderski]

Attachment: Bug 1696157 - Fix unexpected opening of breakpoints panel r=bomsy

Previously when closing the breakpoints panel in secondary panes,
if an unselected call stack frame was selected, the breakpoints
panel would unexpectedly open. This patch makes sure it remains
closed when a user has closed it and then clicks other elements
in the secondary panes. The same issue was happening when
clicking the event listener breakpoint log checkbox, and or step
in, step out, and step over. This patch should also fix
Bug 1755337.

Comment 20

[BugBot [:suhaib / :marco/ :calixte]]

The bug assignee is inactive on Bugzilla, so the assignee is being reset.

Comment 21

[Suhaib Mujahid [:suhaib]]

Sorry, there was a problem with the detection of inactive users. I'm reverting the change.

Comment 22

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/98aa89bef0c4
Fix unexpected opening of breakpoints panel r=jdescottes

Comment 23

[Cristina Cozmuta (:CrissCozmuta)]

https://hg.mozilla.org/mozilla-central/rev/98aa89bef0c4