patchright

🎭 Patchright NodeJS

Patchright is a patched and undetected version of the Playwright Testing and Automation Framework.
It can be used as a drop-in replacement for Playwright.

[!NOTE]
This repository serves the Patchright-NodeJS Package. To use Patchright with Python, check out the Python Package. Also check out the main Patchright Driver Repository

Install it from NPM

# Install Patchright from NPM
npm i patchright

# Install Chromium-Driver for Patchright
npx patchright install chromium

Usage

Just change the import and use it like playwright. Patchright is a drop-in-replacement for Playwright!

[!IMPORTANT]
Patchright only patches CHROMIUM based browsers. Firefox and Webkit are not supported.

// patchright here!
const { chromium } = require('patchright');

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  await page.goto('http://example.com');
  // other actions...
  await browser.close();
})();

Best Practice - use Chrome without Fingerprint Injection

To be completely undetected, use the following configuration:

chromium.launchPersistentContext("...", {
    channel: "chrome",
    headless: false,
    viewport: null,
    // do NOT add custom browser headers or userAgent
});

[!NOTE] We recommend using Google Chrome instead of Chromium. You can install it via npx patchright install chrome (or via any other installation method) and use it with channel: "chrome".

Patches

Runtime.enable Leak

This is the biggest Patch Patchright uses. To avoid detection by this leak, patchright avoids using Runtime.enable by executing Javascript in (isolated) ExecutionContexts.

Console.enable Leak

Patchright patches this leak by disabling the Console API all together. This means, console functionality will not work in Patchright. If you really need the console, you might be better off using Javascript loggers, although they also can be easily detected.

Command Flags Leaks

Patchright tweaks the Playwright Default Args to avoid detection by Command Flag Leaks. This (most importantly) affects:

• --disable-blink-features=AutomationControlled (added) to avoid navigator.webdriver detection.
• --enable-automation (removed) to avoid navigator.webdriver detection.
• --disable-popup-blocking (removed) to avoid popup crashing.
• --disable-component-update (removed) to avoid detection as a Stealth Driver.
• --disable-default-apps (removed) to enable default apps.
• --disable-extensions (removed) to enable extensions

General Leaks

Patchright patches some general leaks in the Playwright codebase. This mainly includes poor setups and obvious detection points.

Closed Shadow Roots

Patchright is able to interact with elements in Closed Shadow Roots. Just use normal locators and Patchright will do the rest.
Patchright is now also able to use XPaths in Closed Shadow Roots.

Stealth

With the right setup, Patchright currently is considered undetectable. Patchright passes:

• Brotector ✅ (with CDP-Patches)
• Cloudflare ✅
• Kasada ✅
• Akamai ✅
• Shape/F5 ✅
• Bet365 ✅
• Datadome ✅
• Fingerprint.com ✅
• CreepJS ✅
• Sannysoft ✅
• Incolumitas ✅
• IPHey ✅
• Browserscan ✅
• Pixelscan ✅

Documentation and API Reference

See the original Playwright Documentation and API Reference

Extended Patchright API

evaluate Method _{(Frame.evaluate, Page.evaluate, Locator.evaluate, Worker.evaluate, JSHandle.evaluate)}

• Added isolatedContext to choose Execution Context (Main/Isolated). Bool (optional, Defaults to true)

object.evaluate(
    pageFunction: Function | string,
    arg?: Arg,
    ...,
+   isolatedContext: boolean = true
)

evaluateHandle Method _{(Frame.evaluateHandle, Page.evaluateHandle, Locator.evaluateHandle, Worker.evaluateHandle, JSHandle.evaluateHandle)}

• Added isolatedContext to choose Execution Context (Main/Isolated). Bool (optional, Defaults to true)

object.evaluateHandle(
    pageFunction: Function | string,
    arg?: Arg,
    ...,
+   isolatedContext: boolean = true
)

Bugs

The bugs are documented in the Patchright Driver Repository.

TODO

The TODO is documented in the Patchright Driver Repository.

Development

Deployment of new Patchright versions are automatic, but bugs due to Playwright codebase changes may occur. Fixes for these bugs might take a few days to be released.

Support our work

If you choose to support our work, please contact @vinyzu or @steve_abcdef on Discord.

Copyright and License

© Vinyzu

Patchright is licensed Apache 2.0

Disclaimer

This repository is provided for educational purposes only.
No warranties are provided regarding accuracy, completeness, or suitability for any purpose. Use at your own risk—the authors and maintainers assume no liability for any damages, legal issues, or warranty breaches resulting from use, modification, or distribution of this code.
Any misuse or legal violations are the sole responsibility of the user.

Authors

Active Maintainer: Vinyzu
Co-Maintainer: Kaliiiiiiiiii