Bug 1826198 - [bidi] Add support for the network.authRequired event r=webdriver-reviewers,whimboo

Depends on D189515

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

remote/shared/listeners/NetworkEventRecord.sys.mjs

@@ -231,6 +231,10 @@ export class NetworkEventRecord {
    */
   addServerTimings(serverTimings) {}
 
+  onAuthPrompt(authDetails, authCallbacks) {
+    this.#emitAuthRequired(authCallbacks);
+  }
+
   /**
    * Convert the provided request timing to a timing relative to the beginning
    * of the request. All timings are numbers representing high definition
@@ -254,6 +258,22 @@ export class NetworkEventRecord {
     return timing - requestTime;
   }
 
+  #emitAuthRequired(authCallbacks) {
+    this.#updateDataFromTimedChannel();
+
+    this.#networkListener.emit("auth-required", {
+      authCallbacks,
+      contextId: this.#contextId,
+      isNavigationRequest: this.#isMainDocumentChannel,
+      requestChannel: this.#requestChannel,
+      redirectCount: this.#redirectCount,
+      requestData: this.#requestData,
+      responseChannel: this.#responseChannel,
+      responseData: this.#responseData,
+      timestamp: Date.now(),
+    });
+  }
+
   #emitBeforeRequestSent() {
     this.#updateDataFromTimedChannel();
 

remote/shared/listeners/NetworkListener.sys.mjs

@@ -65,6 +65,10 @@ export class NetworkListener {
       onNetworkEvent: this.#onNetworkEvent,
     });
 
+    // Enable the auth prompt listening to support the auth-required event and
+    // phase.
+    this.#devtoolsNetworkObserver.setAuthPromptListenerEnabled(true);
+
     this.#listening = true;
   }
 

remote/webdriver-bidi/modules/root/network.sys.mjs

@@ -260,12 +260,14 @@ class NetworkModule extends Module {
     this.#subscribedEvents = new Set();
 
     this.#networkListener = new lazy.NetworkListener();
+    this.#networkListener.on("auth-required", this.#onAuthRequired);
     this.#networkListener.on("before-request-sent", this.#onBeforeRequestSent);
     this.#networkListener.on("response-completed", this.#onResponseEvent);
     this.#networkListener.on("response-started", this.#onResponseEvent);
   }
 
   destroy() {
+    this.#networkListener.off("auth-required", this.#onAuthRequired);
     this.#networkListener.off("before-request-sent", this.#onBeforeRequestSent);
     this.#networkListener.off("response-completed", this.#onResponseEvent);
     this.#networkListener.off("response-started", this.#onResponseEvent);
@@ -482,6 +484,77 @@ class NetworkModule extends Module {
     return navigation ? navigation.navigationId : null;
   }
 
+  #onAuthRequired = (name, data) => {
+    const {
+      authCallbacks,
+      contextId,
+      isNavigationRequest,
+      redirectCount,
+      requestData,
+      responseData,
+      timestamp,
+    } = data;
+
+    try {
+      const browsingContext = lazy.TabManager.getBrowsingContextById(contextId);
+      if (!browsingContext) {
+        // Do not emit events if the context id does not match any existing
+        // browsing context.
+        return;
+      }
+
+      const protocolEventName = "network.authRequired";
+
+      // Process the navigation to create potentially missing navigation ids
+      // before the early return below.
+      const navigation = this.#getNavigationId(
+        protocolEventName,
+        isNavigationRequest,
+        browsingContext,
+        requestData.url
+      );
+
+      const isListening = this.messageHandler.eventsDispatcher.hasListener(
+        protocolEventName,
+        { contextId }
+      );
+      if (!isListening) {
+        // If there are no listeners subscribed to this event and this context,
+        // bail out.
+        return;
+      }
+
+      const baseParameters = this.#processNetworkEvent(protocolEventName, {
+        contextId,
+        navigation,
+        redirectCount,
+        requestData,
+        timestamp,
+      });
+
+      const authRequiredEvent = this.#serializeNetworkEvent({
+        ...baseParameters,
+        response: responseData,
+      });
+
+      const authChallenges = this.#extractChallenges(responseData);
+      // authChallenges should never be null for a request which triggered an
+      // authRequired event.
+      authRequiredEvent.response.authChallenges = authChallenges;
+
+      this.emitEvent(
+        protocolEventName,
+        authRequiredEvent,
+        this.#getContextInfo(browsingContext)
+      );
+    } finally {
+      // Bug 1852223: Until we handle intercepted requests in the authRequired
+      // phase, we should always forward the auth prompt notification so that it
+      // can be handled by the browser.
+      authCallbacks.forwardAuthPrompt();
+    }
+  };
+
   #onBeforeRequestSent = (name, data) => {
     const {
       contextId,
@@ -804,6 +877,7 @@ class NetworkModule extends Module {
 
   static get supportedEvents() {
     return [
+      "network.authRequired",
       "network.beforeRequestSent",
       "network.responseCompleted",
       "network.responseStarted",