Puppeteer extra plugin installation support added

Author: mdervisaygan

README.md

@@ -117,6 +117,42 @@ async function test() {
 
 **disableXvfb:** In Linux, when headless is false, a virtual screen is created and the browser is run there.  You can set this value to true if you want to see the browser.
 
+## How to Install Puppeteer-extra Plugins?
+Some plugins, such as puppeteer-extra-plugin-anonymize-ua, may cause you to be detected. You can use the plugin installation test in the library's test file to see if it will cause you to be detected.
+
+The following is an example of installing a plugin. You can install other plugins in the same way as this example.
+
+```bash
+npm i puppeteer-extra-plugin-click-and-wait
+```
+
+```js
+
+const test = require('node:test');
+const assert = require('node:assert');
+const { connect } = require('puppeteer-real-browser');
+
+test('Puppeteer Extra Plugin', async () => {
+    const { page, browser } = await connect({
+        args: ["--start-maximized"],
+        turnstile: true,
+        headless: false,
+        // disableXvfb: true,
+        customConfig: {},
+        connectOption: {
+            defaultViewport: null
+        },
+        plugins: [
+            require('puppeteer-extra-plugin-click-and-wait')()
+        ]
+    })
+    await page.goto("https://google.com", { waitUntil: "domcontentloaded" })
+    await page.clickAndWaitForNavigation('body')
+    await browser.close()
+})
+
+```
+
 ## Docker
 
 You can use the Dockerfile file in the main directory to use this library with docker. It has been tested with docker on Ubuntu server operating systems.

lib/cjs/index.js

@@ -1,10 +1,10 @@
-const puppeteer = require('puppeteer-core-patch')
+var puppeteer = require('puppeteer-core-patch')
 const { pageController } = require('./module/pageController.js')
 const Xvfb = require('xvfb');
 
 process.env.REBROWSER_PATCHES_RUNTIME_FIX_MODE = "alwaysIsolated"
 // process.env.REBROWSER_PATCHES_DEBUG = 1
-async function connect({ args = [], headless = false, customConfig = {}, proxy = {}, turnstile = false, connectOption = {}, disableXvfb = false }) {
+async function connect({ args = [], headless = false, customConfig = {}, proxy = {}, turnstile = false, connectOption = {}, disableXvfb = false, plugins = [] }) {
     const { launch, Launcher } = await import('chrome-launcher');
 
     let xvfbsession = null
@@ -33,14 +33,24 @@ async function connect({ args = [], headless = false, customConfig = {}, proxy =
         ...customConfig
     });
 
+    if (plugins.length > 0) {
+        const { addExtra } = await import('puppeteer-extra');
+
+        puppeteer = addExtra(puppeteer);
+
+        for (const item of plugins) {
+            puppeteer.use(item);
+        }
+    }
+
     const browser = await puppeteer.connect({
         browserURL: `http://127.0.0.1:${chrome.port}`,
         ...connectOption
     });
 
     let [page] = await browser.pages();
 
-    let pageControllerConfig = { browser, page, proxy, turnstile, xvfbsession, pid: chrome.pid }
+    let pageControllerConfig = { browser, page, proxy, turnstile, xvfbsession, pid: chrome.pid, plugins }
 
     page = await pageController(pageControllerConfig);
 

lib/cjs/module/pageController.js

@@ -8,7 +8,14 @@ function getRandomInt(min, max) {
     return Math.floor(Math.random() * (max - min + 1)) + min;
 }
 
-async function pageController({ browser, page, proxy, turnstile, xvfbsession, pid }) {
+async function pageController({ browser, page, proxy, turnstile, xvfbsession, pid, plugins }) {
+
+    if (plugins.length > 0) {
+        for (const plugin of plugins) {
+            plugin.onPageCreated(page)
+        }
+    }
+
     let solveStatus = turnstile
 
     page.on('close', () => {

lib/esm/index.mjs

@@ -5,7 +5,7 @@ import Xvfb from 'xvfb';
 
 process.env.REBROWSER_PATCHES_RUNTIME_FIX_MODE = "alwaysIsolated"
 // process.env.REBROWSER_PATCHES_DEBUG=1
-export async function connect({ args = [], headless = false, customConfig = {}, proxy = {}, turnstile = false, connectOption = {}, disableXvfb = false }) {
+export async function connect({ args = [], headless = false, customConfig = {}, proxy = {}, turnstile = false, connectOption = {}, disableXvfb = false, plugins = [] }) {
     let xvfbsession = null
     if (headless == 'auto') headless = false
 
@@ -31,15 +31,25 @@ export async function connect({ args = [], headless = false, customConfig = {},
         ],
         ...customConfig
     });
+    let pextra = null
+    if (plugins.length > 0) {
+        const { addExtra } = await import('puppeteer-extra');
 
-    const browser = await puppeteer.connect({
+        pextra = addExtra(puppeteer);
+
+        for (const item of plugins) {
+            pextra.use(item);
+        }
+    }
+
+    const browser = await (pextra ? pextra : puppeteer).connect({
         browserURL: `http://127.0.0.1:${chrome.port}`,
         ...connectOption
     });
 
     let [page] = await browser.pages();
 
-    let pageControllerConfig = { browser, page, proxy, turnstile, xvfbsession, pid: chrome.pid }
+    let pageControllerConfig = { browser, page, proxy, turnstile, xvfbsession, pid: chrome.pid, plugins }
 
     page = await pageController(pageControllerConfig);
 

lib/esm/module/pageController.mjs

@@ -8,7 +8,14 @@ function getRandomInt(min, max) {
     return Math.floor(Math.random() * (max - min + 1)) + min;
 }
 
-export async function pageController({ browser, page, proxy, turnstile, xvfbsession, pid }) {
+export async function pageController({ browser, page, proxy, turnstile, xvfbsession, pid, plugins }) {
+
+    if (plugins.length > 0) {
+        for (const plugin of plugins) {
+            plugin.onPageCreated(page)
+        }
+    }
+
     let solveStatus = turnstile
 
     page.on('close', () => {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "puppeteer-real-browser",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "This package is designed to bypass puppeteer's bot-detecting captchas such as Cloudflare. It acts like a real browser and can be managed with puppeteer.",
   "main": "lib/cjs/index.js",
   "module": "lib/esm/index.mjs",
@@ -39,6 +39,7 @@
     "chrome-launcher": "^1.1.2",
     "ghost-cursor": "^1.3.0",
     "puppeteer-core-patch": "^1.0.1",
+    "puppeteer-extra": "^3.3.6",
     "tree-kill": "^1.2.2",
     "xvfb": "^0.4.0"
   },

package.json

@@ -8,13 +8,28 @@ const realBrowserOption = {
     turnstile: true,
     headless: false,
     // disableXvfb: true,
-    customConfig: {
-    },
+    customConfig: {},
     connectOption: {
         defaultViewport: null
-    }
+    },
+    plugins: []
 }
 
+// test('Puppeteer Extra Plugin', async () => {
+//     /*
+//     Run with:
+//     npm i puppeteer-extra-plugin-click-and-wait
+//     */
+//     realBrowserOption.plugins = [
+//         require('puppeteer-extra-plugin-click-and-wait')()
+//     ]
+//     const { page, browser } = await connect(realBrowserOption)
+//     await page.goto("https://google.com", { waitUntil: "domcontentloaded" })
+//     await page.clickAndWaitForNavigation('body')
+//     await browser.close()
+// })
+
+
 test('DrissionPage Detector', async () => {
     const { page, browser } = await connect(realBrowserOption)
     await page.goto("https://drissionpage.pages.dev/");
@@ -83,11 +98,3 @@ test('Recaptcha V3 Score (hard)', async () => {
     // if (Number(score) >= 0.7) console.log('Recaptcha V3 Score: ' + score);
     assert.strictEqual(Number(score) >= 0.7, true, "Recaptcha V3 Score (hard) should be >=0.7. Score Result: " + score)
 })
-
-
-
-
-
-
-
-

test/cjs/test.js

@@ -7,14 +7,29 @@ const realBrowserOption = {
     turnstile: true,
     headless: false,
     // disableXvfb: true,
-    customConfig: {
-    },
+    customConfig: {},
     connectOption: {
         defaultViewport: null
-    }
+    },
+    plugins: []
 }
 
 
+// test('Puppeteer Extra Plugin', async () => {
+//     /*
+//     Run with:
+//     npm i puppeteer-extra-plugin-click-and-wait
+//     */
+//     const clickAndWait = await (await import('puppeteer-extra-plugin-click-and-wait')).default
+//     realBrowserOption.plugins = [
+//         clickAndWait()
+//     ]
+//     const { page, browser } = await connect(realBrowserOption)
+//     await page.goto("https://google.com", { waitUntil: "domcontentloaded" })
+//     await page.clickAndWaitForNavigation('body')
+//     await browser.close()
+// })
+
 test('DrissionPage Detector', async () => {
     const { page, browser } = await connect(realBrowserOption)
     await page.goto("https://drissionpage.pages.dev/");
@@ -82,12 +97,4 @@ test('Recaptcha V3 Score (hard)', async () => {
     await browser.close()
     // if (Number(score) >= 0.7) console.log('Recaptcha V3 Score: ' + score);
     assert.strictEqual(Number(score) >= 0.7, true, "Recaptcha V3 Score (hard) should be >=0.7. Score Result: " + score)
-})
-
-
-
-
-
-
-
-
+})