Skip to content

DevEnterpriseSoftware/patchright-dotnet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎭 Patchright .NET


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

Note

This repository serves the Patchright .NET Package. To use Patchright with Python or NodeJS, check out the Python Package or the NodeJS Package. Also check out the main Patchright Driver Repository


Installation

Patchright can be found on NuGet and can be installed by copying and pasting the following command into your Package Manager Console within Visual Studio (Tools > NuGet Package Manager > Package Manager Console).

Install-Package Patchright

Alternatively if you're using .NET Core then you can install Patchright via the command line interface with the following command:

dotnet add package Patchright

Usage

Instead of using the Microsoft.Playwright package just install the Patchright package instead. Patchright is a drop-in-replacement for Playwright!

Warning

Patchright only patches CHROMIUM based browsers. Firefox and Webkit are not supported.

using Microsoft.Playwright;
using System.Threading.Tasks;

class Program
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Chromium.LaunchAsync();
        var page = await browser.NewPageAsync();
        await page.GotoAsync("https://playwright.dev");
        await page.ScreenshotAsync(new() { Path = "screenshot.png" });
    }
}

Best Practice - use Chrome without Fingerprint Injection

To be completely undetected, use the following configuration:

await using var context = await playwright.Chromium.LaunchPersistentContextAsync(
    userDataDir: "...",
    new BrowserTypeLaunchPersistentContextOptions 
    {
        Channel = "chrome",
        Headless = false,
        NoViewport = true,
        // do NOT add custom browser headers or userAgent
    });

Note

We recommend using Google Chrome instead of Chromium. You can install it via ./playwright.ps1 install --with-deps chrome (or via any other installation method) and use it with Channel = "chrome".


Patches

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

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:

Documentation and API Reference

See the original Playwright .NET Documentation and API Reference

Extended Patchright API

  • Added isolatedContext to choose Execution Context (Main/Isolated). bool (optional, Defaults to true)
Task<T> EvaluateAsync<T>(
    string expression, 
    object? arg = default,
+   bool isolatedContext = true);
  • Added isolatedContext to choose Execution Context (Main/Isolated). bool (optional, Defaults to true)
Task<IJSHandle> EvaluateHandleAsync(
    string expression, 
    object? arg = default,
+   bool isolatedContext = true);

EvaluateAllAsync Method (ILocator.EvaluateAllAsync)

  • Added isolatedContext to choose Execution Context (Main/Isolated). bool (optional, Defaults to true)
Task<IJSHandle> EvaluateAllAsync(
    string expression, 
    object? arg = default,
+   bool isolatedContext = true);
  • Added isolatedContext to choose Execution Context (Main/Isolated). bool (optional, Defaults to true)
Task<T> EvalOnSelectorAsync<T>(
    string selector,
    string expression,
    object? arg = default,
    EvalOnSelectorOptions? options = default,
+   bool isolatedContext = true);
  • Added isolatedContext to choose Execution Context (Main/Isolated). bool (optional, Defaults to true)
Task<T> EvalOnSelectorAllAsync<T>(
    string selector,
    string expression,
    object? arg = default,
+   bool isolatedContext = 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 not automatic (yet), and bugs due to Playwright codebase changes may occur. Fixes for these bugs might take a few days to be released manually.


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: Werner van Deventer