1602700 - Make it clearer that the webConsoleFront destroy method only does the heavy work once

Status: RESOLVED FIXED

(DevTools :: Framework, task, P3)

Description

[Nicolas Chevobbe [:nchevobbe]]

We could create a destroyer param on it the first time destroy is called, like we do in multiple places in the codebase already.

Comment 1

[Nicolas Chevobbe [:nchevobbe]]

in fact there's an early return on the truthiness of this._client, which is set to null later in the function, which means we actually only do the "real work" once.
I'll use this bug to add a comment to make this more clear.

Comment 2

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1602700 - Add a comment in webconsole front destroy function to make it clearer how it behaves. r=jdescottes.

This only highlights the fact that the front will only
do the heavy work once, since we set the _client property
to null, and the function is guarded against the _client
truthiness.

Comment 3

[Julian Descottes [:jdescottes]]

I filed Bug 1602727 to fix other issues related to incorrect _destroyer patterns in Devtools, leading to target-mixin and toolbox destroy being called several times

(and I just checked, fixing it will avoid calling webconsole front destroy twice on toolbox destroy)

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/544dbe923092
Add a comment in webconsole front destroy function to make it clearer how it behaves. r=jdescottes.

Comment 5

[Andrei Ciure[:aciure]]

https://hg.mozilla.org/mozilla-central/rev/544dbe923092