Bug 1777951 - Enable partially implemented WebDriver BIDi features on…

… Nightly channel only. r=webdriver-reviewers,whimboo,jdescottes

Differential Revision: https://phabricator.services.mozilla.com/D151364

modules/libpref/init/all.js

@@ -4241,6 +4241,13 @@ pref("services.common.log.logger.tokenserverclient", "Debug");
   // 3: WebDriver BiDi + CDP
   pref("remote.active-protocols", 3);
 
+  // Enable WebDriver BiDi experimental commands and events.
+  #if defined(NIGHTLY_BUILD)
+    pref("remote.experimental.enabled", true);
+  #else
+    pref("remote.experimental.enabled", false);
+  #endif
+
   // Defines the verbosity of the internal logger.
   //
   // Available levels are, in descending order of severity, "Trace", "Debug",

remote/doc/Prefs.md

@@ -14,6 +14,11 @@ WebDriver BiDi (`1`), and CDP (`2`). Multiple protocols can be activated
 at the same time by using bitwise or with the values. Defaults to `3` (WebDriver
 BiDi and CDP).
 
+### `remote.experimental.enabled`
+
+Defines if WebDriver BiDi experimental commands and events are available for usage.
+Defaults to `true` in Nightly builds, and `false` otherwise.
+
 ### `remote.log.level`
 
 Defines the verbosity of the internal logger.  Available levels

remote/shared/messagehandler/Module.jsm

@@ -15,6 +15,11 @@ const lazy = {};
 XPCOMUtils.defineLazyModuleGetters(lazy, {
   ContextDescriptorType:
     "chrome://remote/content/shared/messagehandler/MessageHandler.jsm",
+  error: "chrome://remote/content/shared/webdriver/Errors.jsm",
+});
+
+XPCOMUtils.defineLazyGetter(lazy, "disabledExperimentalAPI", () => {
+  return !Services.prefs.getBoolPref("remote.experimental.enabled");
 });
 
 class Module {
@@ -108,6 +113,43 @@ class Module {
     );
   }
 
+  /**
+   * Assert if experimental commands are enabled.
+   *
+   * @param {String} methodName
+   *     Name of the command.
+   *
+   * @throws {UnknownCommandError}
+   *     If experimental commands are disabled.
+   */
+  assertExperimentalCommandsEnabled(methodName) {
+    // TODO: 1778987. Move it to a BiDi specific place.
+    if (lazy.disabledExperimentalAPI) {
+      throw new lazy.error.UnknownCommandError(methodName);
+    }
+  }
+
+  /**
+   * Assert if experimental events are enabled.
+   *
+   * @param {string} moduleName
+   *     Name of the module.
+   *
+   * @param {string} event
+   *     Name of the event.
+   *
+   * @throws {InvalidArgumentError}
+   *     If experimental events are disabled.
+   */
+  assertExperimentalEventsEnabled(moduleName, event) {
+    // TODO: 1778987. Move it to a BiDi specific place.
+    if (lazy.disabledExperimentalAPI) {
+      throw new lazy.error.InvalidArgumentError(
+        `Module ${moduleName} does not support event ${event}`
+      );
+    }
+  }
+
   /**
    * Remove session data for a given module and event.
    *

remote/webdriver-bidi/modules/root/script.jsm

@@ -149,6 +149,9 @@ class ScriptModule extends Module {
    *     If the target cannot be found.
    */
   async callFunction(options = {}) {
+    // TODO: Bug 1778976. Remove once command is fully supported.
+    this.assertExperimentalCommandsEnabled("script.callFunction");
+
     const {
       arguments: commandArguments = null,
       awaitPromise,
@@ -229,6 +232,9 @@ class ScriptModule extends Module {
    *     If the target cannot be found.
    */
   async evaluate(options = {}) {
+    // TODO: Bug 1778976. Remove once command is fully supported.
+    this.assertExperimentalCommandsEnabled("script.evaluate");
+
     const {
       awaitPromise,
       expression: source,

testing/profiles/web-platform/user.js

@@ -76,3 +76,5 @@ user_pref("layout.css.prefers-color-scheme.content-override", 1);
 user_pref("gfx.offscreencanvas.enabled", true);
 user_pref("dom.workers.requestAnimationFrame", true);
 user_pref("layout.css.font-loading-api.workers.enabled", true);
+// Enable WebDriver BiDi experimental commands and events during tests.
+user_pref("remote.experimental.enabled", true);