Bug 1756619 - [bidi] Implement "browsingContext.load" event. r=webdriver-reviewers,jdescottes,whimboo

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

remote/shared/listeners/LoadListener.jsm

@@ -32,7 +32,7 @@ XPCOMUtils.defineLazyModuleGetters(lazy, {
  * ```
  *
  * @emits message
- *    The LoadListener emits "DOMContentLoaded" events,
+ *    The LoadListener emits "DOMContentLoaded" and "load" events,
  *    with the following object as payload:
  *      - {Document} target
  *            The target document.
@@ -72,6 +72,11 @@ class LoadListener {
         signal: this.#abortController.signal,
       }
     );
+
+    this.#window.addEventListener("load", this.#onLoad, {
+      mozSystemGroup: true,
+      signal: this.#abortController.signal,
+    });
   }
 
   stopListening() {
@@ -86,4 +91,8 @@ class LoadListener {
   #onDOMContentLoaded = event => {
     this.emit("DOMContentLoaded", { target: event.target });
   };
+
+  #onLoad = event => {
+    this.emit("load", { target: event.target });
+  };
 }

remote/webdriver-bidi/jar.mn

@@ -26,4 +26,5 @@ remote.jar:
   content/webdriver-bidi/modules/windowglobal/script.jsm (modules/windowglobal/script.jsm)
 
   # WebDriver BiDi windowglobal-in-root modules
+  content/webdriver-bidi/modules/windowglobal-in-root/browsingContext.jsm (modules/windowglobal-in-root/browsingContext.jsm)
   content/webdriver-bidi/modules/windowglobal-in-root/log.jsm (modules/windowglobal-in-root/log.jsm)

remote/webdriver-bidi/modules/ModuleRegistry.jsm

@@ -25,6 +25,8 @@ XPCOMUtils.defineLazyModuleGetters(modules.root, {
 });
 
 XPCOMUtils.defineLazyModuleGetters(modules["windowglobal-in-root"], {
+  browsingContext:
+    "chrome://remote/content/webdriver-bidi/modules/windowglobal-in-root/browsingContext.jsm",
   log:
     "chrome://remote/content/webdriver-bidi/modules/windowglobal-in-root/log.jsm",
 });

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

@@ -564,7 +564,7 @@ class BrowsingContextModule extends Module {
   }
 
   static get supportedEvents() {
-    return ["browsingContext.contextCreated"];
+    return ["browsingContext.contextCreated", "browsingContext.load"];
   }
 }
 

remote/webdriver-bidi/modules/windowglobal-in-root/browsingContext.jsm

@@ -0,0 +1,38 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+const EXPORTED_SYMBOLS = ["browsingContext"];
+
+const { XPCOMUtils } = ChromeUtils.importESModule(
+  "resource://gre/modules/XPCOMUtils.sys.mjs"
+);
+
+const { Module } = ChromeUtils.import(
+  "chrome://remote/content/shared/messagehandler/Module.jsm"
+);
+
+const lazy = {};
+
+XPCOMUtils.defineLazyModuleGetters(lazy, {
+  TabManager: "chrome://remote/content/shared/TabManager.jsm",
+});
+
+class BrowsingContextModule extends Module {
+  destroy() {}
+
+  interceptEvent(name, payload) {
+    if (name == "browsingContext.load") {
+      // Resolve browsing context to a TabManager id.
+      payload.context = lazy.TabManager.getIdForBrowsingContext(
+        payload.context
+      );
+    }
+
+    return payload;
+  }
+}
+
+const browsingContext = BrowsingContextModule;

remote/webdriver-bidi/modules/windowglobal/browsingContext.jsm

@@ -21,6 +21,8 @@ XPCOMUtils.defineLazyModuleGetters(lazy, {
 });
 
 class BrowsingContextModule extends Module {
+  #listeningToDOMContentLoaded;
+  #listeningToLoad;
   #loadListener;
 
   constructor(messageHandler) {
@@ -29,32 +31,69 @@ class BrowsingContextModule extends Module {
     // Setup the LoadListener as early as possible.
     this.#loadListener = new lazy.LoadListener(this.messageHandler.window);
     this.#loadListener.on("DOMContentLoaded", this.#onDOMContentLoaded);
+    this.#loadListener.on("load", this.#onLoad);
   }
 
   destroy() {
     this.#loadListener.destroy();
   }
 
-  #subscribeEvent(event) {
-    if (event === "browsingContext.DOMContentLoaded") {
+  #startListening() {
+    if (!this.#listeningToDOMContentLoaded && !this.#listeningToLoad) {
       this.#loadListener.startListening();
     }
   }
 
+  #subscribeEvent(event) {
+    switch (event) {
+      case "browsingContext.DOMContentLoaded":
+        this.#startListening();
+        this.#listeningToDOMContentLoaded = true;
+        break;
+      case "browsingContext.load":
+        this.#startListening();
+        this.#listeningToLoad = true;
+        break;
+    }
+  }
+
   #unsubscribeEvent(event) {
-    if (event === "browsingContext.DOMContentLoaded") {
+    switch (event) {
+      case "browsingContext.DOMContentLoaded":
+        this.#listeningToDOMContentLoaded = false;
+        break;
+      case "browsingContext.load":
+        this.#listeningToLoad = false;
+        break;
+    }
+
+    if (!this.#listeningToDOMContentLoaded && !this.#listeningToLoad) {
       this.#loadListener.stopListening();
     }
   }
 
   #onDOMContentLoaded = (eventName, data) => {
-    this.messageHandler.emitEvent("browsingContext.DOMContentLoaded", {
-      baseURL: data.target.baseURI,
-      contextId: this.messageHandler.contextId,
-      documentURL: data.target.URL,
-      innerWindowId: this.messageHandler.innerWindowId,
-      readyState: data.target.readyState,
-    });
+    if (this.#listeningToDOMContentLoaded) {
+      this.messageHandler.emitEvent("browsingContext.DOMContentLoaded", {
+        baseURL: data.target.baseURI,
+        contextId: this.messageHandler.contextId,
+        documentURL: data.target.URL,
+        innerWindowId: this.messageHandler.innerWindowId,
+        readyState: data.target.readyState,
+      });
+    }
+  };
+
+  #onLoad = (eventName, data) => {
+    if (this.#listeningToLoad) {
+      this.emitEvent("browsingContext.load", {
+        context: this.messageHandler.context,
+        // TODO: The navigation id should be a real id mapped to the navigation.
+        // See https://bugzilla.mozilla.org/show_bug.cgi?id=1763122
+        navigation: null,
+        url: data.target.baseURI,
+      });
+    }
   };
 
   /**