brave-real-puppeteer-core 24.20.0 → 24.23.0

package/src/api/Page.ts

@@ -650,13 +650,11 @@ export function setDefaultScreenshotOptions(options: ScreenshotOptions): void {
  * ```ts
  * import puppeteer from 'puppeteer';
  *
- * (async () => {
- *   const browser = await puppeteer.launch();
- *   const page = await browser.newPage();
- *   await page.goto('https://example.com');
- *   await page.screenshot({path: 'screenshot.png'});
- *   await browser.close();
- * })();
+ * const browser = await puppeteer.launch();
+ * const page = await browser.newPage();
+ * await page.goto('https://example.com');
+ * await page.screenshot({path: 'screenshot.png'});
+ * await browser.close();
  * ```
  *
  * The Page class extends from Puppeteer's {@link EventEmitter} class and will
@@ -949,21 +947,19 @@ export abstract class Page extends EventEmitter<PageEvents> {
    *
    * ```ts
    * import puppeteer from 'puppeteer';
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   await page.setRequestInterception(true);
-   *   page.on('request', interceptedRequest => {
-   *     if (
-   *       interceptedRequest.url().endsWith('.png') ||
-   *       interceptedRequest.url().endsWith('.jpg')
-   *     )
-   *       interceptedRequest.abort();
-   *     else interceptedRequest.continue();
-   *   });
-   *   await page.goto('https://example.com');
-   *   await browser.close();
-   * })();
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * await page.setRequestInterception(true);
+   * page.on('request', interceptedRequest => {
+   *   if (
+   *     interceptedRequest.url().endsWith('.png') ||
+   *     interceptedRequest.url().endsWith('.jpg')
+   *   )
+   *     interceptedRequest.abort();
+   *   else interceptedRequest.continue();
+   * });
+   * await page.goto('https://example.com');
+   * await browser.close();
    * ```
    *
    * @param value - Whether to enable request interception.
@@ -1010,14 +1006,12 @@ export abstract class Page extends EventEmitter<PageEvents> {
    * import {PredefinedNetworkConditions} from 'puppeteer';
    * const slow3G = PredefinedNetworkConditions['Slow 3G'];
    *
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   await page.emulateNetworkConditions(slow3G);
-   *   await page.goto('https://www.google.com');
-   *   // other actions...
-   *   await browser.close();
-   * })();
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * await page.emulateNetworkConditions(slow3G);
+   * await page.goto('https://www.google.com');
+   * // other actions...
+   * await browser.close();
    * ```
    *
    * @param networkConditions - Passing `null` disables network condition
@@ -1552,21 +1546,19 @@ export abstract class Page extends EventEmitter<PageEvents> {
    * import puppeteer from 'puppeteer';
    * import crypto from 'crypto';
    *
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   page.on('console', msg => console.log(msg.text()));
-   *   await page.exposeFunction('md5', text =>
-   *     crypto.createHash('md5').update(text).digest('hex'),
-   *   );
-   *   await page.evaluate(async () => {
-   *     // use window.md5 to compute hashes
-   *     const myString = 'PUPPETEER';
-   *     const myHash = await window.md5(myString);
-   *     console.log(`md5 of ${myString} is ${myHash}`);
-   *   });
-   *   await browser.close();
-   * })();
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * page.on('console', msg => console.log(msg.text()));
+   * await page.exposeFunction('md5', text =>
+   *   crypto.createHash('md5').update(text).digest('hex'),
+   * );
+   * await page.evaluate(async () => {
+   *   // use window.md5 to compute hashes
+   *   const myString = 'PUPPETEER';
+   *   const myHash = await window.md5(myString);
+   *   console.log(`md5 of ${myString} is ${myHash}`);
+   * });
+   * await browser.close();
    * ```
    *
    * @example
@@ -1576,25 +1568,23 @@ export abstract class Page extends EventEmitter<PageEvents> {
    * import puppeteer from 'puppeteer';
    * import fs from 'node:fs';
    *
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   page.on('console', msg => console.log(msg.text()));
-   *   await page.exposeFunction('readfile', async filePath => {
-   *     return new Promise((resolve, reject) => {
-   *       fs.readFile(filePath, 'utf8', (err, text) => {
-   *         if (err) reject(err);
-   *         else resolve(text);
-   *       });
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * page.on('console', msg => console.log(msg.text()));
+   * await page.exposeFunction('readfile', async filePath => {
+   *   return new Promise((resolve, reject) => {
+   *     fs.readFile(filePath, 'utf8', (err, text) => {
+   *       if (err) reject(err);
+   *       else resolve(text);
    *     });
    *   });
-   *   await page.evaluate(async () => {
-   *     // use window.readfile to read contents of a file
-   *     const content = await window.readfile('/etc/hosts');
-   *     console.log(content);
-   *   });
-   *   await browser.close();
-   * })();
+   * });
+   * await page.evaluate(async () => {
+   *   // use window.readfile to read contents of a file
+   *   const content = await window.readfile('/etc/hosts');
+   *   console.log(content);
+   * });
+   * await browser.close();
    * ```
    *
    * @param name - Name of the function on the window object
@@ -1655,12 +1645,23 @@ export abstract class Page extends EventEmitter<PageEvents> {
    * @param userAgentData - Specific user agent client hint data to use in this
    * page
    * @returns Promise which resolves when the user agent is set.
+   * @deprecated Use {@link Page.(setUserAgent:2) } instead.
    */
   abstract setUserAgent(
     userAgent: string,
     userAgentMetadata?: Protocol.Emulation.UserAgentMetadata,
   ): Promise<void>;
 
+  /**
+   * @param options - Object containing user agent and optional user agent metadata
+   * @returns Promise which resolves when the user agent is set.
+   */
+  abstract setUserAgent(options: {
+    userAgent?: string;
+    userAgentMetadata?: Protocol.Emulation.UserAgentMetadata;
+    platform?: string;
+  }): Promise<void>;
+
   /**
    * Object containing metrics as key/value pairs.
    *
@@ -2014,7 +2015,7 @@ export abstract class Page extends EventEmitter<PageEvents> {
    *
    * @remarks
    * This method is a shortcut for calling two methods:
-   * {@link Page.setUserAgent} and {@link Page.setViewport}.
+   * {@link Page.(setUserAgent:2) } and {@link Page.setViewport}.
    *
    * This method will resize the page. A lot of websites don't expect phones to
    * change size, so you should emulate before navigating to the page.
@@ -2025,19 +2026,17 @@ export abstract class Page extends EventEmitter<PageEvents> {
    * import {KnownDevices} from 'puppeteer';
    * const iPhone = KnownDevices['iPhone 15 Pro'];
    *
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   await page.emulate(iPhone);
-   *   await page.goto('https://www.google.com');
-   *   // other actions...
-   *   await browser.close();
-   * })();
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * await page.emulate(iPhone);
+   * await page.goto('https://www.google.com');
+   * // other actions...
+   * await browser.close();
    * ```
    */
   async emulate(device: Device): Promise<void> {
     await Promise.all([
-      this.setUserAgent(device.userAgent),
+      this.setUserAgent({userAgent: device.userAgent}),
       this.setViewport(device.viewport),
     ]);
   }
@@ -2196,25 +2195,23 @@ export abstract class Page extends EventEmitter<PageEvents> {
    * ```ts
    * import puppeteer from 'puppeteer';
    *
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   await page.goto('https://v8.dev/blog/10-years');
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * await page.goto('https://v8.dev/blog/10-years');
    *
-   *   await page.emulateVisionDeficiency('achromatopsia');
-   *   await page.screenshot({path: 'achromatopsia.png'});
+   * await page.emulateVisionDeficiency('achromatopsia');
+   * await page.screenshot({path: 'achromatopsia.png'});
    *
-   *   await page.emulateVisionDeficiency('deuteranopia');
-   *   await page.screenshot({path: 'deuteranopia.png'});
+   * await page.emulateVisionDeficiency('deuteranopia');
+   * await page.screenshot({path: 'deuteranopia.png'});
    *
-   *   await page.emulateVisionDeficiency('blurredVision');
-   *   await page.screenshot({path: 'blurred-vision.png'});
+   * await page.emulateVisionDeficiency('blurredVision');
+   * await page.screenshot({path: 'blurred-vision.png'});
    *
-   *   await page.emulateVisionDeficiency('reducedContrast');
-   *   await page.screenshot({path: 'reduced-contrast.png'});
+   * await page.emulateVisionDeficiency('reducedContrast');
+   * await page.screenshot({path: 'reduced-contrast.png'});
    *
-   *   await browser.close();
-   * })();
+   * await browser.close();
    * ```
    *
    * @param type - the type of deficiency to simulate, or `'none'` to reset.
@@ -2983,22 +2980,21 @@ export abstract class Page extends EventEmitter<PageEvents> {
    *
    * ```ts
    * import puppeteer from 'puppeteer';
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   let currentURL;
-   *   page
-   *     .waitForSelector('img')
-   *     .then(() => console.log('First URL with image: ' + currentURL));
-   *   for (currentURL of [
-   *     'https://example.com',
-   *     'https://google.com',
-   *     'https://bbc.com',
-   *   ]) {
-   *     await page.goto(currentURL);
-   *   }
-   *   await browser.close();
-   * })();
+   *
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * let currentURL;
+   * page
+   *   .waitForSelector('img')
+   *   .then(() => console.log('First URL with image: ' + currentURL));
+   * for (currentURL of [
+   *   'https://example.com',
+   *   'https://google.com',
+   *   'https://bbc.com',
+   * ]) {
+   *   await page.goto(currentURL);
+   * }
+   * await browser.close();
    * ```
    *
    * @param selector -
@@ -3052,14 +3048,13 @@ export abstract class Page extends EventEmitter<PageEvents> {
    *
    * ```ts
    * import puppeteer from 'puppeteer';
-   * (async () => {
-   *   const browser = await puppeteer.launch();
-   *   const page = await browser.newPage();
-   *   const watchDog = page.waitForFunction('window.innerWidth < 100');
-   *   await page.setViewport({width: 50, height: 50});
-   *   await watchDog;
-   *   await browser.close();
-   * })();
+   *
+   * const browser = await puppeteer.launch();
+   * const page = await browser.newPage();
+   * const watchDog = page.waitForFunction('window.innerWidth < 100');
+   * await page.setViewport({width: 50, height: 50});
+   * await watchDog;
+   * await browser.close();
    * ```
    *
    * @example

package/src/bidi/Browser.ts

@@ -92,10 +92,12 @@ export class BidiBrowser extends Browser {
       },
     });
 
+    // Subscribe to all WebDriver BiDi events. Also subscribe to CDP events if CDP
+    // connection is available.
     await session.subscribe(
-      (session.capabilities.browserName.toLocaleLowerCase().includes('firefox')
-        ? BidiBrowser.subscribeModules
-        : [...BidiBrowser.subscribeModules, ...BidiBrowser.subscribeCdpEvents]
+      (opts.cdpConnection
+        ? [...BidiBrowser.subscribeModules, ...BidiBrowser.subscribeCdpEvents]
+        : BidiBrowser.subscribeModules
       ).filter(module => {
         if (!opts.networkEnabled) {
           return (

package/src/bidi/Frame.ts

@@ -136,7 +136,11 @@ export class BidiFrame extends Frame {
     });
 
     this.browsingContext.on('request', ({request}) => {
-      const httpRequest = BidiHTTPRequest.from(request, this);
+      const httpRequest = BidiHTTPRequest.from(
+        request,
+        this,
+        this.page().isNetworkInterceptionEnabled,
+      );
       request.once('success', () => {
         this.page().trustedEmitter.emit(PageEvent.RequestFinished, httpRequest);
       });

package/src/bidi/HTTPRequest.ts

@@ -9,6 +9,7 @@ import type * as Bidi from 'webdriver-bidi-protocol';
 import type {CDPSession} from '../api/CDPSession.js';
 import type {
   ContinueRequestOverrides,
+  InterceptResolutionState,
   ResponseForRequest,
 } from '../api/HTTPRequest.js';
 import {
@@ -16,6 +17,7 @@ import {
   STATUS_TEXTS,
   type ResourceType,
   handleError,
+  InterceptResolutionAction,
 } from '../api/HTTPRequest.js';
 import {PageEvent} from '../api/Page.js';
 import {UnsupportedOperation} from '../common/Errors.js';
@@ -34,9 +36,15 @@ export class BidiHTTPRequest extends HTTPRequest {
   static from(
     bidiRequest: Request,
     frame: BidiFrame,
+    isNetworkInterceptionEnabled: boolean,
     redirect?: BidiHTTPRequest,
   ): BidiHTTPRequest {
-    const request = new BidiHTTPRequest(bidiRequest, frame, redirect);
+    const request = new BidiHTTPRequest(
+      bidiRequest,
+      frame,
+      isNetworkInterceptionEnabled,
+      redirect,
+    );
     request.#initialize();
     return request;
   }
@@ -50,12 +58,13 @@ export class BidiHTTPRequest extends HTTPRequest {
   private constructor(
     request: Request,
     frame: BidiFrame,
+    isNetworkInterceptionEnabled: boolean,
     redirect?: BidiHTTPRequest,
   ) {
     super();
     requests.set(request, this);
 
-    this.interception.enabled = request.isBlocked;
+    this.interception.enabled = isNetworkInterceptionEnabled;
 
     this.#request = request;
     this.#frame = frame;
@@ -69,7 +78,12 @@ export class BidiHTTPRequest extends HTTPRequest {
 
   #initialize() {
     this.#request.on('redirect', request => {
-      const httpRequest = BidiHTTPRequest.from(request, this.#frame, this);
+      const httpRequest = BidiHTTPRequest.from(
+        request,
+        this.#frame,
+        this.interception.enabled,
+        this,
+      );
       this.#redirectChain.push(this);
 
       request.once('success', () => {
@@ -108,6 +122,17 @@ export class BidiHTTPRequest extends HTTPRequest {
     }
   }
 
+  protected canBeIntercepted(): boolean {
+    return this.#request.isBlocked;
+  }
+
+  override interceptResolutionState(): InterceptResolutionState {
+    if (!this.#request.isBlocked) {
+      return {action: InterceptResolutionAction.Disabled};
+    }
+    return super.interceptResolutionState();
+  }
+
   override url(): string {
     return this.#request.url;
   }

package/src/bidi/Page.ts

@@ -141,20 +141,45 @@ export class BidiPage extends Page {
   #userAgentInterception?: string;
   #userAgentPreloadScript?: string;
   override async setUserAgent(
-    userAgent: string,
+    userAgentOrOptions:
+      | string
+      | {
+          userAgent?: string;
+          userAgentMetadata?: Protocol.Emulation.UserAgentMetadata;
+          platform?: string;
+        },
     userAgentMetadata?: Protocol.Emulation.UserAgentMetadata,
   ): Promise<void> {
-    if (!this.#browserContext.browser().cdpSupported && userAgentMetadata) {
+    let userAgent: string;
+    let metadata: Protocol.Emulation.UserAgentMetadata | undefined;
+    let platform: string | undefined;
+
+    if (typeof userAgentOrOptions === 'string') {
+      userAgent = userAgentOrOptions;
+      metadata = userAgentMetadata;
+    } else {
+      userAgent =
+        userAgentOrOptions.userAgent ??
+        (await this.#browserContext.browser().userAgent());
+      metadata = userAgentOrOptions.userAgentMetadata;
+      platform = userAgentOrOptions.platform;
+    }
+
+    if (
+      !this.#browserContext.browser().cdpSupported &&
+      (metadata || platform)
+    ) {
       throw new UnsupportedOperation(
-        'Current Browser does not support `userAgentMetadata`',
+        'Current Browser does not support `userAgentMetadata` or `platform`',
       );
     } else if (
       this.#browserContext.browser().cdpSupported &&
-      userAgentMetadata
+      (metadata || platform)
     ) {
       return await this._client().send('Network.setUserAgentOverride', {
         userAgent: userAgent,
-        userAgentMetadata: userAgentMetadata,
+        userAgentMetadata: metadata,
+        platform: platform,
       });
     }
     const enable = userAgent !== '';
@@ -172,11 +197,20 @@ export class BidiPage extends Page {
       enable,
     );
 
-    const changeUserAgent = (userAgent: string) => {
+    const overrideNavigatorProperties = (
+      userAgent: string,
+      platform: string | undefined,
+    ) => {
       Object.defineProperty(navigator, 'userAgent', {
         value: userAgent,
         configurable: true,
       });
+      if (platform) {
+        Object.defineProperty(navigator, 'platform', {
+          value: platform,
+          configurable: true,
+        });
+      }
     };
 
     const frames = [this.#frame];
@@ -191,19 +225,27 @@ export class BidiPage extends Page {
     }
     const [evaluateToken] = await Promise.all([
       enable
-        ? this.evaluateOnNewDocument(changeUserAgent, userAgent)
+        ? this.evaluateOnNewDocument(
+            overrideNavigatorProperties,
+            userAgent,
+            platform || undefined,
+          )
         : undefined,
       // When we disable the UserAgent we want to
       // evaluate the original value in all Browsing Contexts
       ...frames.map(frame => {
-        return frame.evaluate(changeUserAgent, userAgent);
+        return frame.evaluate(
+          overrideNavigatorProperties,
+          userAgent,
+          platform || undefined,
+        );
       }),
     ]);
     this.#userAgentPreloadScript = evaluateToken?.identifier;
   }
 
   override async setBypassCSP(enabled: boolean): Promise<void> {
-    // TODO: handle CDP-specific cases such as mprach.
+    // TODO: handle CDP-specific cases such as MPArch.
     await this._client().send('Page.setBypassCSP', {enabled});
   }
 
@@ -584,7 +626,7 @@ export class BidiPage extends Page {
       );
       return;
     }
-    // TODO: handle CDP-specific cases such as mprach.
+    // TODO: handle CDP-specific cases such as MPArch.
     await this._client().send('Network.setCacheDisabled', {
       cacheDisabled: !enabled,
     });
@@ -669,11 +711,20 @@ export class BidiPage extends Page {
     return [...this.#workers];
   }
 
-  #userInterception?: string;
+  get isNetworkInterceptionEnabled(): boolean {
+    return (
+      Boolean(this.#requestInterception) ||
+      Boolean(this.#extraHeadersInterception) ||
+      Boolean(this.#authInterception) ||
+      Boolean(this.#userAgentInterception)
+    );
+  }
+
+  #requestInterception?: string;
   override async setRequestInterception(enable: boolean): Promise<void> {
-    this.#userInterception = await this.#toggleInterception(
+    this.#requestInterception = await this.#toggleInterception(
       [Bidi.Network.InterceptPhase.BeforeRequestSent],
-      this.#userInterception,
+      this.#requestInterception,
       enable,
     );
   }
@@ -1012,7 +1063,7 @@ export function bidiToPuppeteerCookie(
 ): Cookie {
   const partitionKey = bidiCookie[CDP_SPECIFIC_PREFIX + 'partitionKey'];
 
-  function getParitionKey(): {partitionKey?: Cookie['partitionKey']} {
+  function getPartitionKey(): {partitionKey?: Cookie['partitionKey']} {
     if (typeof partitionKey === 'string') {
       return {partitionKey};
     }
@@ -1054,7 +1105,7 @@ export function bidiToPuppeteerCookie(
       'partitionKeyOpaque',
       'priority',
     ),
-    ...getParitionKey(),
+    ...getPartitionKey(),
   };
 }
 

package/src/bidi/core/Browser.ts

@@ -7,6 +7,7 @@
 import type * as Bidi from 'webdriver-bidi-protocol';
 
 import type {BrowserContextOptions} from '../../api/Browser.js';
+import {UnsupportedOperation} from '../../common/Errors.js';
 import {EventEmitter} from '../../common/EventEmitter.js';
 import {inertIfDisposed, throwIfDisposed} from '../../util/decorators.js';
 import {DisposableStack, disposeSymbol} from '../../util/disposable.js';
@@ -232,11 +233,36 @@ export class Browser extends EventEmitter<{
             noProxy: options.proxyBypassList,
           };
     const {
-      result: {userContext: context},
+      result: {userContext},
     } = await this.session.send('browser.createUserContext', {
       proxy: proxyConfig,
     });
-    return this.#createUserContext(context);
+    if (options.downloadBehavior?.policy === 'allowAndName') {
+      throw new UnsupportedOperation(
+        '`allowAndName` is not supported in WebDriver BiDi',
+      );
+    }
+    if (options.downloadBehavior?.policy === 'allow') {
+      if (options.downloadBehavior.downloadPath === undefined) {
+        throw new UnsupportedOperation(
+          '`downloadPath` is required in `allow` download behavior',
+        );
+      }
+      await this.session.send('browser.setDownloadBehavior', {
+        downloadBehavior: {
+          type: 'allowed',
+          destinationFolder: options.downloadBehavior.downloadPath,
+        },
+        userContexts: [userContext],
+      });
+    }
+    if (options.downloadBehavior?.policy === 'deny') {
+      await this.session.send('browser.setDownloadBehavior', {
+        downloadBehavior: {type: 'denied'},
+        userContexts: [userContext],
+      });
+    }
+    return this.#createUserContext(userContext);
   }
 
   @throwIfDisposed<Browser>(browser => {

package/src/bidi/core/BrowsingContext.ts

@@ -713,7 +713,6 @@ export class BrowsingContext extends EventEmitter<{
 
   async setJavaScriptEnabled(enabled: boolean): Promise<void> {
     await this.userContext.browser.session.send(
-      // @ts-expect-error missing types
       'emulation.setScriptingEnabled',
       {
         // Enabled `null` means `default`, `false` means `disabled`.

package/src/cdp/Accessibility.ts

@@ -319,7 +319,6 @@ class AXNode {
   #name: string;
   #role: string;
   #ignored: boolean;
-  #cachedHasFocusableChild?: boolean;
   #realm: Realm;
 
   constructor(realm: Realm, payload: Protocol.Accessibility.AXNode) {
@@ -362,19 +361,6 @@ class AXNode {
     );
   }
 
-  #hasFocusableChild(): boolean {
-    if (this.#cachedHasFocusableChild === undefined) {
-      this.#cachedHasFocusableChild = false;
-      for (const child of this.children) {
-        if (child.#focusable || child.#hasFocusableChild()) {
-          this.#cachedHasFocusableChild = true;
-          break;
-        }
-      }
-    }
-    return this.#cachedHasFocusableChild;
-  }
-
   public find(predicate: (x: AXNode) => boolean): AXNode | null {
     if (predicate(this)) {
       return this;
@@ -420,16 +406,10 @@ class AXNode {
         break;
     }
 
-    // Here and below: Android heuristics
-    if (this.#hasFocusableChild()) {
-      return false;
-    }
-    if (this.#focusable && this.#name && this.#name !== 'Document') {
-      return true;
-    }
     if (this.#role === 'heading' && this.#name) {
       return true;
     }
+
     return false;
   }