1662503 - Use only one helper to wait for a condition in devtools tests

Status: NEW

(DevTools :: General, task, P3)

Description

[Alexandre Poirot [:ochameau]]

Today, DevTools codebase uses XXX helpers to wait for an async condition to become true:

• waitFor:
  https://searchfox.org/mozilla-central/search?q=+waitFor%28&path=devtools%2F&case=false&regexp=false
• waitUntil:
  https://searchfox.org/mozilla-central/search?q=+waitFor%28&path=devtools%2F&case=false&regexp=false
• asyncWaitUntil:
  https://searchfox.org/mozilla-central/search?q=+waitUntil%28&path=devtools%2F&case=false&regexp=false
• BrowserTestUtils.waitForCondition:
  https://searchfox.org/mozilla-central/search?q=BrowserTestUtils.waitForCondition%28&path=devtools%2F&case=false&regexp=false

waitFor and waitUntil are used a lot, the others, much less.

waitUntil never throws, waitFor is probably more helpful for debugging failure, especially after your patch lands.
Also, waitFor supports async conditions, so i guess we could directly replace asyncWaitUntil with waitFor?

I see two options from here:

• migrate everything to waitFor. It would still be a devtools specific helper
• migrate everything to BrowserTestUtils.waitForCondition. Then devtools would just use same helper as the rest of mozilla-central

The issue with the second is that we would miss the small tweak of bug 1662066, which displays the stack trace and the condition function in case of failure.

Comment 1

[Alexandre Poirot [:ochameau]]

Note that waitUntil doesn't timeout, so when migrating from waitUntil to waitFor we might lever new times of intermittents.