1679414 - MarionetteCommands actor leaks observers of dialog observer instance

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect, P1)

Description

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Just noticed that the MarionetteCommand actor creates an instance of the DialogObserver within actorCreated, and registers for all the following observer notifications:

Services.obs.addObserver(this, "common-dialog-loaded");
Services.obs.addObserver(this, "tabmodal-dialog-loaded");
Services.obs.addObserver(this, "toplevel-window-ready");

Sadly we do not remove those listeners in didDestroy, and as such these are going to leak.

As result I see tons of toplevel-window-ready notifications for TestClickCloseContext.test_click_close_window when running all tests in that file.

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Marking as being soft-blocked by bug 1678708 given that I want to add some tests and the other bug lays the basics for it.

Comment 2

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Actually I cannot find a way with xpcshell tests to get this tested. We would need browser chrome tests but those aren't available for Marionette.

Comment 3

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Attachment: Bug 1679414 - [marionette] Don't leak dialogObserver instances in MarionetteCommands actor.

Comment 4

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Attachment: Bug 1679414 - [marionette] Don't leak registered dialogObserver listeners in MarionetteCommands actor.

Comment 5

[Chris Peterson [:cpeterson]]

Tracking marionette-fission-mvp bugs for Fission M7 Beta milestone.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b735561c9242
[marionette] Don't leak registered dialogObserver listeners in MarionetteCommands actor. r=marionette-reviewers,maja_zf

Comment 7

[Cosmin Sabou [:CosminS]]

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

Comment 8

[Ryan VanderMeulen [:RyanVM]]

Does this need a Beta uplift?

Comment 9

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Comment on attachment 9189882 [details]
Bug 1679414 - [marionette] Don't leak registered dialogObserver listeners in MarionetteCommands actor.

Beta/Release Uplift Approval Request

• User impact if declined: When Firefox is under remote control eg by running Selenium tests the new actor implementation is leaking memory by not unregistering listeners and observer notifications.
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): Ensures to unregister all listeners and observers when the JSWindowActor gets destroyed.
• String changes made/needed:

Comment 10

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9189882 [details]
Bug 1679414 - [marionette] Don't leak registered dialogObserver listeners in MarionetteCommands actor.

Approved for 84.0b7.

Comment 11

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/674dbf4b015b