feat: scaffold network request interception (#1050)

Supersedes #957.

Bug: #644
DevTools:
https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/protocol/fetch_handler.cc
Doc:
[go/webdriver-bidi:network-request-interception-proposal](http://go/webdriver-bidi:network-request-interception-proposal)
Spec:
https://pr-preview.s3.amazonaws.com/w3c/webdriver-bidi/pull/429.html#network-intercepts
Puppeteer:
https://github.com/puppeteer/puppeteer/blob/main/test/src/requestinterception.spec.ts
Upstream: w3c/webdriver-bidi#429

src/bidiMapper/BidiNoOpParser.ts

@@ -19,6 +19,7 @@ import type {
   BrowsingContext,
   Cdp,
   Input,
+  Network,
   Script,
   Session,
 } from '../protocol/protocol.js';
@@ -112,6 +113,41 @@ export class BidiNoOpParser implements IBidiParser {
   }
   // keep-sorted end
 
+  // Network domain
+  // keep-sorted start block=yes
+  parseAddInterceptParams(params: unknown): Network.AddInterceptParameters {
+    return params as Network.AddInterceptParameters;
+  }
+  parseContinueRequestParams(
+    params: unknown
+  ): Network.ContinueRequestParameters {
+    return params as Network.ContinueRequestParameters;
+  }
+  parseContinueResponseParams(
+    params: unknown
+  ): Network.ContinueResponseParameters {
+    return params as Network.ContinueResponseParameters;
+  }
+  parseContinueWithAuthParams(
+    params: unknown
+  ): Network.ContinueWithAuthParameters {
+    return params as Network.ContinueWithAuthParameters;
+  }
+  parseFailRequestParams(params: unknown): Network.FailRequestParameters {
+    return params as Network.FailRequestParameters;
+  }
+  parseProvideResponseParams(
+    params: unknown
+  ): Network.ProvideResponseParameters {
+    return params as Network.ProvideResponseParameters;
+  }
+  parseRemoveInterceptParams(
+    params: unknown
+  ): Network.RemoveInterceptParameters {
+    return params as Network.RemoveInterceptParameters;
+  }
+  // keep-sorted end
+
   // Session domain
   // keep-sorted start block=yes
   parseSubscribeParams(params: unknown): Session.SubscriptionRequest {

src/bidiMapper/BidiParser.ts

@@ -19,6 +19,7 @@ import type {
   BrowsingContext,
   Cdp,
   Input,
+  Network,
   Script,
   Session,
 } from '../protocol/protocol.js';
@@ -56,6 +57,27 @@ export interface IBidiParser {
   parseReleaseActionsParams(params: unknown): Input.ReleaseActionsParameters;
   // keep-sorted end
 
+  // Network domain
+  // keep-sorted start block=yes
+  parseAddInterceptParams(params: unknown): Network.AddInterceptParameters;
+  parseContinueRequestParams(
+    params: unknown
+  ): Network.ContinueRequestParameters;
+  parseContinueResponseParams(
+    params: unknown
+  ): Network.ContinueResponseParameters;
+  parseContinueWithAuthParams(
+    params: unknown
+  ): Network.ContinueWithAuthParameters;
+  parseFailRequestParams(params: unknown): Network.FailRequestParameters;
+  parseProvideResponseParams(
+    params: unknown
+  ): Network.ProvideResponseParameters;
+  parseRemoveInterceptParams(
+    params: unknown
+  ): Network.RemoveInterceptParameters;
+  // keep-sorted end block=yes
+
   // Script domain
   // keep-sorted start block=yes
   parseAddPreloadScriptParams(

src/bidiMapper/CommandProcessor.ts

@@ -38,7 +38,9 @@ import {InputProcessor} from './domains/input/InputProcessor.js';
 import {PreloadScriptStorage} from './domains/script/PreloadScriptStorage.js';
 import {ScriptProcessor} from './domains/script/ScriptProcessor.js';
 import type {RealmStorage} from './domains/script/realmStorage.js';
+import {NetworkProcessor} from './domains/network/NetworkProcessor.js';
 import {SessionProcessor} from './domains/session/SessionProcessor.js';
+import {NetworkStorage} from './domains/network/NetworkStorage.js';
 
 export const enum CommandProcessorEvents {
   Response = 'response',
@@ -57,6 +59,7 @@ export class CommandProcessor extends EventEmitter<CommandProcessorEventsMap> {
   #browsingContextProcessor: BrowsingContextProcessor;
   #cdpProcessor: CdpProcessor;
   #inputProcessor: InputProcessor;
+  #networkProcessor: NetworkProcessor;
   #scriptProcessor: ScriptProcessor;
   #sessionProcessor: SessionProcessor;
   // keep-sorted end
@@ -76,6 +79,8 @@ export class CommandProcessor extends EventEmitter<CommandProcessorEventsMap> {
     super();
     this.#parser = parser;
     this.#logger = logger;
+
+    const networkStorage = new NetworkStorage(eventManager);
     const preloadScriptStorage = new PreloadScriptStorage();
 
     // keep-sorted start block=yes
@@ -86,6 +91,7 @@ export class CommandProcessor extends EventEmitter<CommandProcessorEventsMap> {
       eventManager,
       browsingContextStorage,
       realmStorage,
+      networkStorage,
       preloadScriptStorage,
       logger
     );
@@ -94,6 +100,10 @@ export class CommandProcessor extends EventEmitter<CommandProcessorEventsMap> {
       cdpConnection
     );
     this.#inputProcessor = new InputProcessor(browsingContextStorage);
+    this.#networkProcessor = new NetworkProcessor(
+      browsingContextStorage,
+      networkStorage
+    );
     this.#scriptProcessor = new ScriptProcessor(
       browsingContextStorage,
       realmStorage,
@@ -187,6 +197,38 @@ export class CommandProcessor extends EventEmitter<CommandProcessorEventsMap> {
         );
       // keep-sorted end
 
+      // Network domain
+      // keep-sorted start block=yes
+      case 'network.addIntercept':
+        return this.#networkProcessor.addIntercept(
+          this.#parser.parseAddInterceptParams(command.params)
+        );
+      case 'network.continueRequest':
+        return this.#networkProcessor.continueRequest(
+          this.#parser.parseContinueRequestParams(command.params)
+        );
+      case 'network.continueResponse':
+        return this.#networkProcessor.continueResponse(
+          this.#parser.parseContinueResponseParams(command.params)
+        );
+      case 'network.continueWithAuth':
+        return this.#networkProcessor.continueWithAuth(
+          this.#parser.parseContinueWithAuthParams(command.params)
+        );
+      case 'network.failRequest':
+        return this.#networkProcessor.failRequest(
+          this.#parser.parseFailRequestParams(command.params)
+        );
+      case 'network.provideResponse':
+        return this.#networkProcessor.provideResponse(
+          this.#parser.parseProvideResponseParams(command.params)
+        );
+      case 'network.removeIntercept':
+        return this.#networkProcessor.removeIntercept(
+          this.#parser.parseRemoveInterceptParams(command.params)
+        );
+      // keep-sorted end
+
       // Script domain
       // keep-sorted start block=yes
       case 'script.addPreloadScript':

src/bidiMapper/domains/context/browsingContextProcessor.ts

@@ -27,6 +27,7 @@ import {LogType, type LoggerFn} from '../../../utils/log.js';
 import type {EventManager} from '../events/EventManager.js';
 import type {RealmStorage} from '../script/realmStorage.js';
 import type {PreloadScriptStorage} from '../script/PreloadScriptStorage.js';
+import type {NetworkStorage} from '../network/NetworkStorage.js';
 
 import {BrowsingContextImpl} from './browsingContextImpl.js';
 import type {BrowsingContextStorage} from './browsingContextStorage.js';
@@ -38,6 +39,7 @@ export class BrowsingContextProcessor {
   readonly #eventManager: EventManager;
 
   readonly #browsingContextStorage: BrowsingContextStorage;
+  readonly #networkStorage: NetworkStorage;
   readonly #preloadScriptStorage: PreloadScriptStorage;
   readonly #realmStorage: RealmStorage;
 
@@ -49,6 +51,7 @@ export class BrowsingContextProcessor {
     eventManager: EventManager,
     browsingContextStorage: BrowsingContextStorage,
     realmStorage: RealmStorage,
+    networkStorage: NetworkStorage,
     preloadScriptStorage: PreloadScriptStorage,
     logger?: LoggerFn
   ) {
@@ -57,6 +60,7 @@ export class BrowsingContextProcessor {
     this.#eventManager = eventManager;
     this.#browsingContextStorage = browsingContextStorage;
     this.#preloadScriptStorage = preloadScriptStorage;
+    this.#networkStorage = networkStorage;
     this.#realmStorage = realmStorage;
     this.#logger = logger;
 
@@ -336,7 +340,8 @@ export class BrowsingContextProcessor {
       sessionId,
       this.#realmStorage,
       this.#eventManager,
-      this.#preloadScriptStorage
+      this.#preloadScriptStorage,
+      this.#networkStorage
     );
 
     if (maybeContext) {

src/bidiMapper/domains/context/cdpTarget.ts

@@ -26,6 +26,7 @@ import {NetworkManager} from '../network/NetworkManager.js';
 import type {ChannelProxy} from '../script/channelProxy.js';
 import type {RealmStorage} from '../script/realmStorage.js';
 import type {PreloadScriptStorage} from '../script/PreloadScriptStorage.js';
+import type {NetworkStorage} from '../network/NetworkStorage.js';
 import type {Result} from '../../../utils/result.js';
 
 export class CdpTarget {
@@ -34,6 +35,7 @@ export class CdpTarget {
   readonly #cdpSessionId: Protocol.Target.SessionID;
   readonly #eventManager: EventManager;
   readonly #preloadScriptStorage: PreloadScriptStorage;
+  readonly #networkStorage: NetworkStorage;
 
   readonly #targetUnblocked = new Deferred<Result<void>>();
 
@@ -43,18 +45,20 @@ export class CdpTarget {
     cdpSessionId: Protocol.Target.SessionID,
     realmStorage: RealmStorage,
     eventManager: EventManager,
-    preloadScriptStorage: PreloadScriptStorage
+    preloadScriptStorage: PreloadScriptStorage,
+    networkStorage: NetworkStorage
   ): CdpTarget {
     const cdpTarget = new CdpTarget(
       targetId,
       cdpClient,
       cdpSessionId,
       eventManager,
-      preloadScriptStorage
+      preloadScriptStorage,
+      networkStorage
     );
 
     LogManager.create(cdpTarget, realmStorage, eventManager);
-    NetworkManager.create(cdpClient, eventManager);
+    NetworkManager.create(cdpTarget, networkStorage);
 
     cdpTarget.#setEventListeners();
 
@@ -70,13 +74,15 @@ export class CdpTarget {
     cdpClient: ICdpClient,
     cdpSessionId: Protocol.Target.SessionID,
     eventManager: EventManager,
-    preloadScriptStorage: PreloadScriptStorage
+    preloadScriptStorage: PreloadScriptStorage,
+    networkStorage: NetworkStorage
   ) {
     this.#targetId = targetId;
     this.#cdpClient = cdpClient;
     this.#cdpSessionId = cdpSessionId;
     this.#eventManager = eventManager;
     this.#preloadScriptStorage = preloadScriptStorage;
+    this.#networkStorage = networkStorage;
   }
 
   /** Returns a promise that resolves when the target is unblocked. */
@@ -92,13 +98,37 @@ export class CdpTarget {
     return this.#cdpClient;
   }
 
-  /**
-   * Needed for CDP escape path.
-   */
+  /** Needed for CDP escape path. */
   get cdpSessionId(): Protocol.Target.SessionID {
     return this.#cdpSessionId;
   }
 
+  /** Calls `Fetch.enable` with the added network intercepts. */
+  async fetchEnable() {
+    await this.#cdpClient.sendCommand(
+      'Fetch.enable',
+      this.#networkStorage.getFetchEnableParams()
+    );
+  }
+
+  /** Calls `Fetch.disable`. */
+  async fetchDisable() {
+    await this.#cdpClient.sendCommand('Fetch.disable');
+  }
+
+  /**
+   * Calls `Fetch.disable` followed by `Fetch.enable`.
+   * The order is important. Do not use `Promise.all`.
+   *
+   * This is necessary because `Fetch.disable` removes all intercepts.
+   * In a situation where there are two or more intercepts and one of them is
+   * removed, the `Fetch.enable` call will restore the remaining intercepts.
+   */
+  async fetchApply() {
+    await this.fetchDisable();
+    await this.fetchEnable();
+  }
+
   /**
    * Enables all the required CDP domains and unblocks the target.
    */
@@ -117,6 +147,7 @@ export class CdpTarget {
         // XXX: #1080: Do not always enable the network domain globally.
         // TODO: enable Network domain for OOPiF targets.
         this.#cdpClient.sendCommand('Network.enable'),
+        this.fetchApply(),
         this.#cdpClient.sendCommand('Target.setAutoAttach', {
           autoAttach: true,
           waitForDebuggerOnStart: true,