feat(webdriver): support fetchPostData (#14340)

Author: sadym-chromium

package-lock.json

@@ -149,7 +149,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@puppeteer/browsers": "2.10.12",
-    "chromium-bidi": "10.5.0",
+    "chromium-bidi": "10.5.1",
     "debug": "^4.4.3",
     "devtools-protocol": "0.0.1508733",
     "typed-query-selector": "^2.12.0",

packages/puppeteer-core/package.json

@@ -111,20 +111,28 @@ export class BidiBrowser extends Browser {
       }) as [string, ...string[]],
     );
 
-    try {
-      await session.send('network.addDataCollector', {
-        dataTypes: [Bidi.Network.DataType.Response],
-        // Buffer size of 20 MB is equivalent to the CDP:
-        maxEncodedDataSize: 20 * 1000 * 1000, // 20 MB
-      });
-    } catch (err) {
-      if (err instanceof ProtocolError) {
-        // Ignore protocol errors, as the data collectors can be not implemented.
-        debugError(err);
-      } else {
-        throw err;
-      }
-    }
+    await Promise.all(
+      [Bidi.Network.DataType.Request, Bidi.Network.DataType.Response].map(
+        // Data collectors might be not implemented for specific data type, so create them
+        // separately and ignore protocol errors.
+        async dataType => {
+          try {
+            await session.send('network.addDataCollector', {
+              dataTypes: [dataType],
+              // Buffer size of 20 MB is equivalent to the CDP:
+              maxEncodedDataSize: 20_000_000,
+            });
+          } catch (err) {
+            if (err instanceof ProtocolError) {
+              debugError(err);
+            } else {
+              throw err;
+            }
+          }
+        },
+      ),
+    );
+
     const browser = new BidiBrowser(session.browser, opts);
     browser.#initialize();
     return browser;

packages/puppeteer-core/src/bidi/Browser.ts

@@ -158,14 +158,11 @@ export class BidiHTTPRequest extends HTTPRequest {
   }
 
   override hasPostData(): boolean {
-    if (!this.#frame.page().browser().cdpSupported) {
-      throw new UnsupportedOperation();
-    }
     return this.#request.hasPostData;
   }
 
   override async fetchPostData(): Promise<string | undefined> {
-    throw new UnsupportedOperation();
+    return await this.#request.fetchPostData();
   }
 
   get #hasInternalHeaderOverwrite(): boolean {

packages/puppeteer-core/src/bidi/HTTPRequest.ts

@@ -6,7 +6,7 @@
 
 import * as Bidi from 'webdriver-bidi-protocol';
 
-import {ProtocolError} from '../../common/Errors.js';
+import {ProtocolError, UnsupportedOperation} from '../../common/Errors.js';
 import {EventEmitter} from '../../common/EventEmitter.js';
 import {inertIfDisposed} from '../../util/decorators.js';
 import {DisposableStack, disposeSymbol} from '../../util/disposable.js';
@@ -37,6 +37,7 @@ export class Request extends EventEmitter<{
   }
 
   #responseContentPromise: Promise<Uint8Array<ArrayBufferLike>> | null = null;
+  #requestBodyPromise: Promise<string> | null = null;
   #error?: string;
   #redirect?: Request;
   #response?: Bidi.Network.ResponseData;
@@ -195,8 +196,7 @@ export class Request extends EventEmitter<{
   }
 
   get hasPostData(): boolean {
-    // @ts-expect-error non-standard attribute.
-    return this.#event.request['goog:hasPostData'] ?? false;
+    return (this.#event.request.bodySize ?? 0) > 0;
   }
 
   async continueRequest({
@@ -237,6 +237,29 @@ export class Request extends EventEmitter<{
     });
   }
 
+  async fetchPostData(): Promise<string | undefined> {
+    if (!this.hasPostData) {
+      return undefined;
+    }
+    if (!this.#requestBodyPromise) {
+      this.#requestBodyPromise = (async () => {
+        const data = await this.#session.send('network.getData', {
+          dataType: Bidi.Network.DataType.Request,
+          request: this.id,
+        });
+        if (data.result.bytes.type === 'string') {
+          return data.result.bytes.value;
+        }
+
+        // TODO: support base64 response.
+        throw new UnsupportedOperation(
+          `Collected request body data of type ${data.result.bytes.type} is not supported`,
+        );
+      })();
+    }
+    return await this.#requestBodyPromise;
+  }
+
   async getResponseContent(): Promise<Uint8Array> {
     if (!this.#responseContentPromise) {
       this.#responseContentPromise = (async () => {
@@ -258,7 +281,7 @@ export class Request extends EventEmitter<{
             )
           ) {
             throw new ProtocolError(
-              'Could not load body for this request. This might happen if the request is a preflight request.',
+              'Could not load response body for this request. This might happen if the request is a preflight request.',
             );
           }
 

packages/puppeteer-core/src/bidi/core/Request.ts

@@ -139,7 +139,7 @@ export class CdpHTTPResponse extends HTTPResponse {
                 'No resource with given identifier found'
             ) {
               throw new ProtocolError(
-                'Could not load body for this request. This might happen if the request is a preflight request.',
+                'Could not load response body for this request. This might happen if the request is a preflight request.',
               );
             }
 

packages/puppeteer-core/src/cdp/HTTPResponse.ts

@@ -132,7 +132,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@puppeteer/browsers": "2.10.12",
-    "chromium-bidi": "10.5.0",
+    "chromium-bidi": "10.5.1",
     "cosmiconfig": "^9.0.0",
     "devtools-protocol": "0.0.1508733",
     "puppeteer-core": "24.25.0",

packages/puppeteer/package.json

@@ -453,13 +453,6 @@
     "expectations": ["FAIL"],
     "comment": "TODO: add a comment explaining why this expectation is required (include links to issues)"
   },
-  {
-    "testIdPattern": "[network.spec] network Request.postData should work with blobs",
-    "platforms": ["darwin", "linux", "win32"],
-    "parameters": ["webDriverBiDi"],
-    "expectations": ["FAIL"],
-    "comment": "https://github.com/w3c/webdriver-bidi/issues/747"
-  },
   {
     "testIdPattern": "[network.spec] network Request.resourceType *",
     "platforms": ["darwin", "linux", "win32"],
@@ -1285,6 +1278,20 @@
     "expectations": ["FAIL", "PASS"],
     "comment": "TODO: add a comment explaining why this expectation is required (include links to issues)"
   },
+  {
+    "testIdPattern": "[network.spec] network Request.fetchPostData should work",
+    "platforms": ["darwin", "linux", "win32"],
+    "parameters": ["firefox", "webDriverBiDi"],
+    "expectations": ["FAIL"],
+    "comment": "network.getData(request) is not yet supported"
+  },
+  {
+    "testIdPattern": "[network.spec] network Request.fetchPostData should work with blobs",
+    "platforms": ["darwin", "linux", "win32"],
+    "parameters": ["firefox", "webDriverBiDi"],
+    "expectations": ["FAIL"],
+    "comment": "network.getData(request) is not yet supported"
+  },
   {
     "testIdPattern": "[network.spec] network Request.postData should be |undefined| when there is no post data",
     "platforms": ["darwin", "linux", "win32"],
@@ -1299,6 +1306,13 @@
     "expectations": ["FAIL"],
     "comment": "TODO: add a comment explaining why this expectation is required (include links to issues)"
   },
+  {
+    "testIdPattern": "[network.spec] network Request.postData should work with blobs",
+    "platforms": ["darwin", "linux", "win32"],
+    "parameters": ["firefox", "webDriverBiDi"],
+    "expectations": ["FAIL"],
+    "comment": "network.getData(request) is not yet supported"
+  },
   {
     "testIdPattern": "[network.spec] network Response.text should throw when requesting body of redirected response",
     "platforms": ["darwin", "linux", "win32"],

test/TestExpectations.json

@@ -0,0 +1,76 @@
+/**
+ * @license
+ * Copyright 2025 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import expect from 'expect';
+import type {HTTPRequest} from 'puppeteer-core/internal/api/HTTPRequest.js';
+
+import {getTestState, setupTestBrowserHooks} from '../mocha-utils.js';
+import {isFavicon, waitEvent} from '../utils.js';
+
+describe('network', function () {
+  setupTestBrowserHooks();
+
+  describe('Request.postData', function () {
+    it('should work', async () => {
+      const {page, server} = await getTestState();
+
+      await page.goto(server.EMPTY_PAGE);
+      server.setRoute('/post', (_req, res) => {
+        return res.end();
+      });
+
+      const [request] = await Promise.all([
+        waitEvent<HTTPRequest>(page, 'request', r => {
+          return !isFavicon(r);
+        }),
+        page.evaluate(() => {
+          return fetch('./post', {
+            method: 'POST',
+            body: JSON.stringify({foo: 'bar'}),
+          });
+        }),
+      ]);
+
+      expect(request).toBeTruthy();
+      expect(request.postData()).toBe('{"foo":"bar"}');
+    });
+
+    it('should be |undefined| when there is no post data', async () => {
+      const {page, server} = await getTestState();
+
+      const response = (await page.goto(server.EMPTY_PAGE))!;
+      expect(response.request().postData()).toBe(undefined);
+    });
+
+    it('should work with blobs', async () => {
+      const {page, server} = await getTestState();
+
+      await page.goto(server.EMPTY_PAGE);
+      server.setRoute('/post', (_req, res) => {
+        return res.end();
+      });
+
+      const [request] = await Promise.all([
+        waitEvent<HTTPRequest>(page, 'request', r => {
+          return !isFavicon(r);
+        }),
+        page.evaluate(() => {
+          return fetch('./post', {
+            method: 'POST',
+            body: new Blob([JSON.stringify({foo: 'bar'})], {
+              type: 'application/json',
+            }),
+          });
+        }),
+      ]);
+
+      expect(request).toBeTruthy();
+      expect(request.postData()).toBe(undefined);
+      expect(request.hasPostData()).toBe(true);
+      expect(await request.fetchPostData()).toBe('{"foo":"bar"}');
+    });
+  });
+});

test/src/cdp/network.spec.ts

@@ -241,7 +241,7 @@ describe('network', function () {
     });
   });
 
-  describe('Request.postData', function () {
+  describe('Request.fetchPostData', function () {
     it('should work', async () => {
       const {page, server} = await getTestState();
 
@@ -263,14 +263,17 @@ describe('network', function () {
       ]);
 
       expect(request).toBeTruthy();
-      expect(request.postData()).toBe('{"foo":"bar"}');
+      expect(request.hasPostData()).toBeTruthy();
+      expect(await request.fetchPostData()).toBe('{"foo":"bar"}');
     });
 
     it('should be |undefined| when there is no post data', async () => {
       const {page, server} = await getTestState();
 
       const response = (await page.goto(server.EMPTY_PAGE))!;
-      expect(response.request().postData()).toBe(undefined);
+      expect(response.request().hasPostData()).toBeFalsy();
+
+      expect(await response.request().fetchPostData()).toBe(undefined);
     });
 
     it('should work with blobs', async () => {
@@ -296,7 +299,6 @@ describe('network', function () {
       ]);
 
       expect(request).toBeTruthy();
-      expect(request.postData()).toBe(undefined);
       expect(request.hasPostData()).toBe(true);
       expect(await request.fetchPostData()).toBe('{"foo":"bar"}');
     });
@@ -450,7 +452,7 @@ describe('network', function () {
 
       const response = await responsePromise;
       await expect(response.buffer()).rejects.toThrow(
-        'Could not load body for this request. This might happen if the request is a preflight request.',
+        'Could not load response body for this request. This might happen if the request is a preflight request.',
       );
     });
   });