1423209 - Drop ability to put a frame script to sleep

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, enhancement)

Description

[Andreas Tolfsen ❲:ato❳]

Marionette has a Marionette:sleepSession IPC command it uses to
put a content frame script “to sleep”.  This removes certain
message handlers and clears some state.

From what we can tell this is B2G-specific functionality we no
longer need.  In an effort to remove old cruft from Marionette
before tackling the window tracking refactoring [1] we want to
remove support for this.

The problem is that it interacts with this.curBrowser.frameManager
and the global message manager, which could be tricky to get right.

  [1] https://bugzil.la/marionette-window-tracking

Comment 1

[Andreas Tolfsen ❲:ato❳]

Did a first draft of a patch to drop
GeckoDriver#switchToGlobalMessageManager and triggered a try run [1].

Comment 2

[Andreas Tolfsen ❲:ato❳]

I have a suspicion that testing/marionette/frame.js is entirely B2G related and not used in Firefox/Fennec automation.  From reading the source code it is hard to tell if it  means content browsers by ‘OOP frames’, or if it means segregated chrome processes for B2G apps.  Note that I’m very fuzzy on the terminology here.

The message managers handled by frame.js decides whether to use a ‘targetted’ per-frame message manager call in GeckoDriver#sendAsync or whether to use a broadcasting technique, where the message name is appended with the content browser’s outerWindowID.  I have never once seen the first being used.  My suspicion was further solidified by looking at code coverage data [1].

  [1] https://codecov.io/gh/marco-c/gecko-dev/src/8faace152630a16ea00aa20337c8c132695e8f09/testing/marionette/driver.js#L347

Comment 3

[Andreas Tolfsen ❲:ato❳]

Link to try run mentioned in comment #1: https://treeherder.mozilla.org/#/jobs?repo=try&revision=6b7c262814371e2de84ced05e7666e111bb84894

Comment 4

[Andreas Tolfsen ❲:ato❳]

Attachment: Bug 1423209 - Drop ability to put frame script to sleep.

Marionette has a Marionette:sleepSession IPC command it uses to put a
content frame script "to sleep".  This removes certain message handlers
and clears some state by calling deleteSession() in listener.js.
The frame script can later be "restarted" by calling Marionette:restart.

This is B2G-specific functionality we no longer need.  In an effort
to remove old cruft from Marionette before tackling the window
tracking refactoring we want to remove support for this.

This removes the Marionette:sleepSession and Marionette:restart
IPC messages as well as GeckoDriver#switchToGlobalMessageManager.
The latter function additionally resets GeckoDriver#mm to the global
message manager which is fine, because for Firefox/Fennec we never
use the targetted message manager.

There will be a follow-up bug to remove OOP frame handling and the
targetted message manager used in GeckoDriver#sendAsync.

Review commit: https://reviewboard.mozilla.org/r/205494/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/205494/

Comment 5

[David Burns :automatedtester]

Comment on attachment 8934627 [details]
Bug 1423209 - Drop ability to put frame script to sleep.

https://reviewboard.mozilla.org/r/205494/#review211440

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b7b56045fab4
Drop ability to put frame script to sleep. r=automatedtester

Comment 7

[Dorel Luca [:dluca]]

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