fix: associate preflight network request with context (#3572)

Addressing #3570

Author: sadym-chromium

src/bidiMapper/modules/network/NetworkModuleMocks.spec.ts

@@ -35,8 +35,9 @@ export class MockCdpNetworkEvents {
   requestId: string;
   fetchId: string;
   private loaderId: string;
-  private frameId: string;
+  private frameId: string | undefined;
   private type: Protocol.Network.ResourceType;
+  private initiator: Protocol.Network.Initiator;
 
   constructor(
     cdpClient: CdpClient,
@@ -47,13 +48,15 @@ export class MockCdpNetworkEvents {
       url,
       frameId,
       type,
+      initiator,
     }: Partial<{
       requestId: string;
       fetchId: string;
       loaderId: string;
       url: string;
-      frameId: string;
+      frameId: string | null;
       type: Protocol.Network.ResourceType;
+      initiator: Protocol.Network.Initiator;
     }> = {},
   ) {
     this.cdpClient = cdpClient;
@@ -62,8 +65,23 @@ export class MockCdpNetworkEvents {
     this.fetchId = fetchId ?? 'interception-job-1.0';
     this.loaderId = loaderId ?? '7760711DEFCFA23132D98ABA6B4E175C';
     this.url = url ?? MockCdpNetworkEvents.defaultUrl;
-    this.frameId = frameId ?? MockCdpNetworkEvents.defaultFrameId;
+    this.frameId =
+      frameId === null ? undefined : MockCdpNetworkEvents.defaultFrameId;
     this.type = type ?? 'XHR';
+    this.initiator = initiator ?? {
+      type: 'script',
+      stack: {
+        callFrames: [
+          {
+            functionName: '',
+            scriptId: '5',
+            url: '',
+            lineNumber: 0,
+            columnNumber: 0,
+          },
+        ],
+      },
+    };
   }
 
   requestWillBeSent() {
@@ -89,20 +107,7 @@ export class MockCdpNetworkEvents {
       },
       timestamp: 2111.55635,
       wallTime: 1637315638.473634,
-      initiator: {
-        type: 'script',
-        stack: {
-          callFrames: [
-            {
-              functionName: '',
-              scriptId: '5',
-              url: '',
-              lineNumber: 0,
-              columnNumber: 0,
-            },
-          ],
-        },
-      },
+      initiator: this.initiator,
       redirectHasExtraInfo: false,
       type: this.type,
       frameId: this.frameId,
@@ -342,7 +347,8 @@ export class MockCdpNetworkEvents {
         initialPriority: 'High',
         referrerPolicy: 'strict-origin-when-cross-origin',
       },
-      frameId: this.frameId,
+      // FrameId is required in fetch.
+      frameId: this.frameId ?? MockCdpNetworkEvents.defaultFrameId,
       resourceType: this.type,
       networkId: this.requestId,
     });
@@ -362,7 +368,8 @@ export class MockCdpNetworkEvents {
       responseStatusCode: 200,
       responseStatusText: '',
       responseHeaders: [],
-      frameId: this.frameId,
+      // FrameId is required in fetch.
+      frameId: this.frameId ?? MockCdpNetworkEvents.defaultFrameId,
       resourceType: this.type,
       networkId: this.requestId,
     });
@@ -386,7 +393,8 @@ export class MockCdpNetworkEvents {
         initialPriority: 'High',
         referrerPolicy: 'strict-origin-when-cross-origin',
       },
-      frameId: this.frameId,
+      // FrameId is required in fetch.
+      frameId: this.frameId ?? MockCdpNetworkEvents.defaultFrameId,
       resourceType: this.type,
       authChallenge: {
         source: 'Server',

src/bidiMapper/modules/network/NetworkRequest.ts

@@ -237,14 +237,33 @@ export class NetworkRequest {
     return bodySize;
   }
 
-  get #context() {
-    return (
+  get #context(): string | null {
+    const result =
       this.#response.paused?.frameId ??
       this.#request.info?.frameId ??
       this.#request.paused?.frameId ??
-      this.#request.auth?.frameId ??
-      null
-    );
+      this.#request.auth?.frameId;
+
+    if (result !== undefined) {
+      return result;
+    }
+
+    // Heuristic for associating a preflight request with context via it's initiator
+    // request. Useful for preflight requests.
+    // https://github.com/GoogleChromeLabs/chromium-bidi/issues/3570
+    if (
+      this.#request?.info?.initiator.type === 'preflight' &&
+      this.#request?.info?.initiator.requestId !== undefined
+    ) {
+      const maybeInitiator = this.#networkStorage.getRequestById(
+        this.#request?.info?.initiator.requestId,
+      );
+      if (maybeInitiator !== undefined) {
+        return maybeInitiator.#request.info?.frameId ?? null;
+      }
+    }
+
+    return null;
   }
 
   /** Returns the HTTP status code associated with this request if any. */

src/bidiMapper/modules/network/NetworkStorage.spec.ts

@@ -242,6 +242,30 @@ describe('NetworkStorage', () => {
       const event = await getEvent('network.beforeRequestSent');
       expect(event).to.exist;
     });
+
+    it('should report right context for preflight requests', async () => {
+      const initialRequest = new MockCdpNetworkEvents(cdpClient);
+      initialRequest.requestWillBeSent();
+
+      const preflightRrequest = new MockCdpNetworkEvents(cdpClient, {
+        requestId: 'ANOTHER_REQUEST_ID',
+        // Preflight requests don't have `frameId`.
+        frameId: null,
+        initiator: {
+          type: 'preflight',
+          url: initialRequest.url,
+          requestId: initialRequest.requestId,
+        },
+      });
+      preflightRrequest.requestWillBeSent();
+      preflightRrequest.requestWillBeSentExtraInfo();
+
+      const event = await getEvent('network.beforeRequestSent');
+      expect(event).to.exist;
+      expect((event as Network.BeforeRequestSentParameters).context).to.equal(
+        MockCdpNetworkEvents.defaultFrameId,
+      );
+    });
   });
 
   describe('network.responseStarted', () => {

tests/conftest.py

@@ -613,11 +613,14 @@ def url_hang_forever_download(local_server_http):
 @pytest.fixture
 def html(local_server_http, local_server_http_another_host):
     """Return a factory for URL with the given content."""
-    def html(content="", same_origin=True):
+    def html(content="",
+             same_origin=True,
+             headers: dict[str, str] | None = None):
         if same_origin:
-            return local_server_http.url_200(content=content)
+            return local_server_http.url_200(content=content, headers=headers)
         else:
-            return local_server_http_another_host.url_200(content=content)
+            return local_server_http_another_host.url_200(content=content,
+                                                          headers=headers)
 
     return html
 

tests/network/test_network.py

@@ -523,3 +523,70 @@ async def test_network_should_not_block_queue_shared_workers_with_data_url(
             "timestamp": ANY_TIMESTAMP
         }
     })
+
+
+@pytest.mark.asyncio
+async def test_network_preflight(websocket, context_id, html, url_example,
+                                 read_messages):
+    """ https://github.com/GoogleChromeLabs/chromium-bidi/issues/3570 """
+    url = html("hello world!",
+               same_origin=False,
+               headers={
+                   "Access-Control-Allow-Origin": "*",
+                   "Access-Control-Allow-Headers": "x-ping"
+               })
+
+    await goto_url(websocket, context_id, url)
+
+    await subscribe(websocket, ["network.beforeRequestSent"])
+
+    # Initiate a non-trivial CORS request.
+    await send_JSON_command(
+        websocket, {
+            "method": "script.evaluate",
+            "params": {
+                "expression": f"""
+                    fetch('{url_example}', {{
+                        method: 'PUT',
+                    }})
+                """,
+                "target": {
+                    "context": context_id
+                },
+                "awaitPromise": False,
+            }
+        })
+
+    [_, preflight_request, post_request] = await read_messages(3, sort=True)
+
+    assert preflight_request == AnyExtending({
+        'method': 'network.beforeRequestSent',
+        'params': {
+            'context': context_id,
+            'initiator': {
+                'request': ANY_STR,
+                'type': 'preflight',
+            },
+            'request': {
+                'method': 'OPTIONS',
+                'request': ANY_STR,
+                'url': url_example,
+            },
+        },
+        'type': 'event',
+    })
+    initiator_request_id = preflight_request['params']['initiator']['request']
+
+    assert post_request == AnyExtending({
+        'method': 'network.beforeRequestSent',
+        'params': {
+            'context': context_id,
+            'request': {
+                'initiatorType': 'fetch',
+                'method': 'PUT',
+                'request': initiator_request_id,
+                'url': url_example,
+            },
+        },
+        'type': 'event',
+    })