1700390 - [meta] Review remaining marionette preferences

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, task)

Description

[Julian Descottes [:jdescottes]]

As we are moving parts of marionette's codebase to shared modules that should be reused for WebDriver bidi, we need to review existing marionette preferences which are driving the behavior of those modules.

For instance, the marionette format.js module relies on marionette.log.truncate (at https://searchfox.org/mozilla-central/rev/be906232eedb22c064b78f3806b38964c04f1fbc/testing/marionette/format.js#150). If we want to replace it by the shared remote module Format.jsm, we need to decide what to do with this preference. (Mentioned in Bug 1691481)

The list of remaining marionette preferences:

• marionette.debugging.clicktostart
• marionette.log.level
• marionette.log.truncate
• marionette.port
• marionette.prefs.recommended

Comment 1

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

(In reply to Julian Descottes [:jdescottes] from comment #0)

The list of remaining marionette preferences:

• marionette.debugging.clicktostart
• marionette.port

These are clearly Marionette specific. Not sure if we want the click to start behavior for Remote Agent.

• marionette.log.level
• marionette.log.truncate
• marionette.prefs.recommended

There is the question if we want to have those as webdriver.* (similar to what has already been landed on bug 1713779 for webdriver.log.level), or actually use remote.* for all the protocols as covered by the Remote Agent.

Comment 2

[Julian Descottes [:jdescottes]]

Do we agree that for every module under remote/, we will have a single *.log.level and a single *.log.truncate preference?
If the remaining question about those 2 preferences is just the name (webdriver or remote), I guess remote makes more sense, because it will apply to non-webdriver-related protocols (eg CDP for puppeteer).

A bit unfortunate we introduced webdriver.log in geckodriver, but we can still update this.

Comment 3

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

Via bug 1718052 all log related preferences will be changed to make use of the remote.log.* prefix.

Comment 4

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

Via bug 1700392 the marionette.log.truncate preference will change to remote.log.truncate.

Comment 5

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

And bug 1719667 will change marionette.prefs.recommended to remote.prefs.recommended.

Comment 6

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

The only remaining preference are the following, which are actually required:

marionette.debugging.clicktostart
marionette.port

As such we can finally close this bug.