1617856 - Modify createHost helper in devtools/client/shared/test/head.js to return an object instead of an array

Status: RESOLVED FIXED

(DevTools :: Console, task, P3)

Description

[Nicolas Chevobbe [:nchevobbe]]

The createHost helper (devtools/client/shared/test/head.js#112-125 ) which is used in tests return an array with 3 element:

• host
• iframe.contentWindow
• iframe.contentDocument

most of the time, the test does not need all those, which can result in less than ideal destructuring (e.g. const [, , doc] = await createHost("bottom", TEST_URI);)

We should modify the function so it returns an object like with the host, contentWindow and contentDocument properties.

With that done, the tests calling the helper (https://searchfox.org/mozilla-central/search?q=createHost(&case=true&regexp=false&path=devtools%2Fclient%2Fshared%2F) should be updated.

Comment 1

[manas]

May I try to solve this?

Comment 2

[Nicolas Chevobbe [:nchevobbe]]

Hello manas, thanks for offering help!
The bug is now yours :)

If it's your first bug, you might want to read this https://docs.firefox-dev.tools/getting-started/ to setup the work environment.
Make sure to select "Artifact builds" when asked as it speeds up the workflow quite a bit :)

After you made the changes, you can run the tests with ./mach mochitest devtools/client/shared/test/ --headless to ensure everything is okay.

Also, you can come and chat on our Slack https://devtools-html-slack.herokuapp.com/

Comment 3

[manas]

Attachment: Bug 1617856 - Convert array destructuring to object destructuring. r=nchevobbe

Comment 4

[manas]

Hey, does this look okay now?

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c8426c08b6e7
Convert array destructuring to object destructuring. r=nchevobbe

Comment 6

[Nicolas Chevobbe [:nchevobbe]]

yes this looks good, I pushed the patch

Comment 7

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/c8426c08b6e7