1592297 - Turn the DOCSHELL/DOMWINDOW output off by default, unless needed, or enabled with an env var

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, enhancement, P3)

Description

[Tom Ritter [:tjr] (OOTO until 4/30 at least)]

Right now you can pass MOZ_QUIET to silence this output. But I don't think most people need it in their own work, and most tests don't need it. So it would be beneficial to change it to opt-in (with MOZ_LOUD?) unless needed.

mccr8 pointed me at this code which parses the logs looking for leaks, but my understanding is this only runs on certain tests, so the output be auto-enabled there while disabling it elsewhere. He also said "The leak checking logic could probably be moved into the browser itself, but that would be a bit of work."

Comment 1

[Andrew McCreight [:mccr8]]

The browser chrome tests use DOMWINDOW and DOCSHELL to check that windows and docshells created during a test go away during that test, but other tests like mochitest plain don't need it, so it sounds reasonable to make it opt-in.

Comment 2

[Andrew McCreight [:mccr8]]

IMO, an opt-in should be specific to this window/docshell behavior. If you want one thing quiet, presumably you want all things quiet, but you probably want to opt-in to verbosity on a case-by-case basis.

Comment 3

[Tom Ritter [:tjr] (OOTO until 4/30 at least)]

Try: https://treeherder.mozilla.org/#/jobs?repo=try&revision=0716a6f278e951e5bc30e5560eac677eedb7a554&selectedJob=275391369

» grep -l "DOMWINDOW ==" *
test-linux64_debug-mochitest-browser-chrome-e10s-10_GsFuJ7qpRF6rPHg55ZRfRg_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-11_Dafl2uCISvWurLNUy5R74A_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-12_aEBOueBdSnKcgPXtmFLveA_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-13_Mi1FvE07R76Vz3kQ1lq3xA_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-14_cchlb7pURzaWOWc-krCgDg_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-15_J21R1CJAQpaFMVoWJ0omrw_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-16_Inx3wugSTdOCqetT6u4Gpw_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-1_Kha3uSR0TSGSwW4cPOS_Iw_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-2_BqiBh_5SQgyMIWcltKA18g_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-3_ew-NiYEaS6qSQqsevRryZg_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-4_Ftu94muaR0Gtqc7TYjfWBw_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-5_NKJprD_rSS2-rGHq4qhl3Q_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-6_FFQMtEMiTfqgKzHa3mVBYg_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-7_Xj-4NIpDRGSpPinyMiqDJA_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-8_Ck7Nv7sfT02Sc-DoQmtr8A_0.log
test-linux64_debug-mochitest-browser-chrome-e10s-9_DOqsbrRxRCSGfnC_UJx5dw_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-10_RfTlf9SfSRi7TWx9VCvLBQ_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-11_AQShLhZQSMCTtRNKG5TXmw_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-12_C9kA37N4QZGL87o5KEySlA_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-13_C4E7iLS4T2OZ2w0HmR6m1w_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-14_IZkQwTwtQGGJbpRZdXL3fA_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-15_ANBn1K2oRpav6YtIYL1-jw_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-16_YgnPt-2DRjqrFmTehVz5Yw_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-1_cSNq2sfcT3S03J9JktRTOQ_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-2_TuPhJsobTHqyLMT_6Z1nbw_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-3_RPYSO4sMT5-bAR5CSjQNKw_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-4_NcbIchdqRI2XplnqpHkH2w_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-5_ZzPenZVpR7eAcCCy7XOh9g_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-6_d5uwRxGRRau_Z6tgkc4jkA_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-7_EcxHcyxAQgm1L4hiGSHO9Q_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-8_LLw7GHScRbam5xwQ9cyhpw_0.log
test-linux64_debug-mochitest-browser-chrome-sw-e10s-9_QVIj55qCQ0K4TzClsziO0w_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-10_GmcyEe-KT0yX4You3xiZQA_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-11_WoC_4y-PRtiiiQJueONqgw_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-12_VBwEKDnFRUacowQrLTXrmQ_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-1_Klb8cJYaQuKna6kL2TEw2A_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-2_CWItqv4TQzmUnQzSKBcAPQ_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-3_YwoHMxMURtSr6ZdFLW3weg_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-4_VdOxKWaoTbOjKuU9GvTnAw_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-5_NCpxzghSTz2kAPd9rV9VZQ_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-6_L-PPFXSUSa-5IEmYbs6tIA_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-7_UX-UkuQlR_uPB48Q1y8LQA_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-8_fPgM-U3mTwOIcng_jcs3JA_0.log
test-linux64_debug-mochitest-devtools-chrome-e10s-9_a2YFPNWnR3qJoGX3FPMtPw_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-10_d5qu8wF9T1adK1gx61wGzw_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-11_a4Qu9WuyT7OrnhkVsbsqvg_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-12_GKVwoXqrTSWUc7bXtCPLJQ_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-1_CDo0DhaMRFKh_Y1wprnuww_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-2_YP7jCYSwTsmGMdXBF-VE5w_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-3_R1VrfqNWR6e68JOZhv5S2Q_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-4_a5XUNhamSJSPg2DA9NAPhA_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-5_KSwC3FbaR_G7z1oFln_vfA_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-6_OyMmyYGJRNyvOL5sRDClnA_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-7_YzA1o534QyelQKqz6yH0Eg_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-8_WYMH7MlHQTGgM6eos598hg_0.log
test-linux64_debug-mochitest-devtools-chrome-sw-e10s-9_KR33fMKoQGOqP_Dthm6OZA_0.log
test-linux64_debug-mochitest-remote-e10s_VbOyz6J4Q-C78bI-93t3RA_0.log
test-linux64_debug-mochitest-remote-sw-e10s_WSnTyvfzQc6vxFYpSRzlIA_0.log

Comment 4

[Tom Ritter [:tjr] (OOTO until 4/30 at least)]

Attachment: Bug 1592297 - Remove MOZ_QUIET and disable this output by default. r?mccr8

Instead of setting MOZ_QUIET to hide the DOMWINDOW and DOCSHELL log messages, you
now must set MOZ_LOUD to enable them. They are automatically enabled on tests
that rely on these messages are leak checking.

One disadvantage of this change is that you cannot set MOZ_QUIET to hide these
messages when running those tests (primarily browser-chrome).

Comment 5

[Andrew McCreight [:mccr8]]

Peter, is changing things so that by default the DOMWINDOW/DOCSHELL stuff is not shown okay with you, as the DOM module owner? I personally find it useful, but I think for people who aren't concerned with DOM stuff it is just a lot of noise, so it seems reasonable to not have it on by default.

Comment 6

[Peter Van der Beken [:peterv]]

We discussed this at the DOM peers meeting. Everyone ended up being ok with this chance, though I think we're generally worried this will make people care even less about window leaks (which has been an issue for a long time already).
We would like a different name than MOZ_LOUD though, something that makes it clear that it turns on this particular logging. We don't want to end up burying this in whatever anyone else might want to put behind MOZ_LOUD.

Comment 7

[Tom Ritter [:tjr] (OOTO until 4/30 at least)]

Okay this is good to go, waiting until after the freeze

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/724d7b936078
Remove MOZ_QUIET and disable this output by default. r=mccr8,jdescottes

Comment 9

[Stefan Hindli [:stefan_hindli]]

https://hg.mozilla.org/mozilla-central/rev/724d7b936078