1659376 - Browser toolbox doesn't work with the new print preview UI

Status: VERIFIED FIXED

(DevTools :: Inspector, defect)

Description

[Hiroyuki Ikezoe (:hiro)]

STR;

1. Open the new print preview
2. Open the browser toolbox

Comment 1

[Blake Winton (:bwinton) (:☕️)]

That's a weird one…

Comment 2

[:Gijs (he/him)]

Nicolas, would you have any idea what's going on here? The console and debugger seem fine, but the inspector is upset (blank) for some reason.

Comment 3

[Nicolas Chevobbe [:nchevobbe]]

So, while opening the Browser Toolbox, there's no specific error, it just seems to wait for ever.
When I closed it, I was able to get that stack:

JavaScript error: resource://devtools/shared/protocol/Front.js, line 77: Error: Connection closed, pending request to server4.conn0.windowGlobal4294967300/inspectorActor3, type getHighlighter failed

Request stack:
request@resource://devtools/shared/protocol/Front.js:260:14
generateRequestMethods/</frontProto[name]@resource://devtools/shared/protocol/Front/FrontClassWithSpec.js:46:19
_getHighlighter@resource://devtools/client/fronts/inspector.js:70:35
initialize@resource://devtools/client/fronts/inspector.js:44:12
manage@resource://devtools/shared/protocol/Front.js:120:19
getFront@resource://devtools/shared/protocol/types.js:609:18
getFront@resource://devtools/client/fronts/targets/target-mixin.js:328:15
module.exports@resource://devtools/shared/resources/legacy-listeners/root-node.js:51:44
_watchResourcesForTarget@resource://devtools/shared/resources/resource-watcher.js:475:41
_startListening@resource://devtools/shared/resources/resource-watcher.js:450:26
watchResources@resource://devtools/shared/resources/resource-watcher.js:115:20

It looked like we were waiting on the getHighlighter method.
With my best dump abilities, I traced it back to https://searchfox.org/mozilla-central/rev/fa7f47027917a186fb2052dee104cd06c21dd76f/devtools/server/actors/highlighters.js#127-130
Here, readyState equals to "uninitialized" for the about:printpreview document , so we don't resolve the Promise we're waiting on (we're waiting for a "navigate" event that won't come).

I don't know if it's a regular state for this document?

CC'ing Razvan as he knows this part of the code way better than I do

Comment 4

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1659376 - Extract isDocumentReady from WalkerActor to inspector utils file. r=rcaliman.

Comment 5

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1659376 - Fix Browser Toolbox inspector when print preview is displayed.r=rcaliman.

The issue was that the getHighlighter request for the about:printpreview
target never settled. It appears that the document always stays in an
unitialized readyState, which was causing trouble.
Instead of relying only on readyState, we now call isDocumentReady, which
also checks if the document is loading.

Depends on D87755

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/86e77b35c75d
Extract isDocumentReady from WalkerActor to inspector utils file. r=rcaliman.
https://hg.mozilla.org/integration/autoland/rev/61e3dea03a62
Fix Browser Toolbox inspector when print preview is displayed.r=rcaliman.

Comment 7

[Narcis Beleuzu [:NarcisB]]

Backed out for dt failures on browser_dbg-content-script-sources.js

Backout link: https://hg.mozilla.org/integration/autoland/rev/432e42cbbc4139efd2319952ec33efe8ff9add3c
Log link: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=313673751&repo=autoland&lineNumber=22878

Comment 8

[Nicolas Chevobbe [:nchevobbe]]

(In reply to Narcis Beleuzu [:NarcisB] from comment #7)

Backed out for dt failures on browser_dbg-content-script-sources.js

Backout link: https://hg.mozilla.org/integration/autoland/rev/432e42cbbc4139efd2319952ec33efe8ff9add3c
Log link: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=313673751&repo=autoland&lineNumber=22878

I'll investigate

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/67abf3def9a6
Extract isDocumentReady from WalkerActor to inspector utils file. r=rcaliman.
https://hg.mozilla.org/integration/autoland/rev/d4727eb42233
Fix Browser Toolbox inspector when print preview is displayed.r=rcaliman.

Comment 10

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/67abf3def9a6
https://hg.mozilla.org/mozilla-central/rev/d4727eb42233

Comment 11

[Negritas Sergiu, Desktop QA]

Hello I have managed to reproduce the issue following using firefox Nightly 81.0a1(2020-08-15) on Windows.
I can confirm that the issue is fixed on firefox 82.0b2 and 83.0a1(2020-09-25) on all OS platforms.