986367 - paint_listener.js should ensure that paint suppression is not in place

Status: RESOLVED FIXED

(Testing :: Mochitest, defect)

Description

[Brian Birtles (:birtles)]

In debugging test failures for bug 975261 on B2G I spent a lot of time chasing down a situation where painting wasn't happening in time.

The cause turned out to be using paint_listener inside an onload handler which is run before nsDocumentViewer::LoadComplete unsuppresses painting.

We should make paint_listener.js check for paint suppression. At very least it should fail loudly. Better yet, it should actually wait until paint suppression has finished.

Comment 1

[Brian Birtles (:birtles)]

Attachment: Make paint_listener.js check for paint suppression

This patch adds an extra check for paint suppression when waiting for paint
events. This is because on some platforms (notably B2G) we can think all paints
have completed because paint suppression is in effect and as a result call the
callback too soon.

This patch use window.setTimeout(..., 0) to wait for paint suppression to finish
before preceding to check for pending paint events.

When the refresh driver is under test control, if we detect that paint events
are pending we need to force a refresh driver tick. This patch adds that tick.
I suppose we had previously never hit this situation before and never noticed
this.

This patch also rearranges the main loop so that early returns appear first and
calling the callback appears at the end.

Comment 2

[Brian Birtles (:birtles)]

Try run: https://tbpl.mozilla.org/?tree=Try&rev=2462f8f121ae

Comment 3

[Brian Birtles (:birtles)]

https://hg.mozilla.org/integration/mozilla-inbound/rev/827746f4c8ea

Comment 4

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/827746f4c8ea