New patches: change sourceURL, change utility world name, expose browser's CDP session.

Author: nwebson

README.md

@@ -52,6 +52,35 @@ REBROWSER_PATCHES_RUNTIME_FIX_MODE=alwaysIsolated node app.js
 |--------| --- |
 | ![before](https://github.com/user-attachments/assets/daf4fee7-538c-49aa-946a-f9e939fe8fe5) | ![after](https://github.com/user-attachments/assets/0680a6f1-2fd9-4a49-ad7f-ae32758715ec) |
 
+### Change sourceURL to generic script name
+By default, Puppeteer adds `//# sourceURL=pptr:...` to every script in `page.evaluate()`. A remote website can detect this behavior and raise red flags. 
+This patch changes it to `//# sourceURL=app.js`. You can also adjust it via environment variable:
+```shell
+# use any generic filename
+process.env.REBROWSER_PATCHES_SOURCE_URL = "jquery.min.js"
+# use 0 to completely disable this patch
+process.env.REBROWSER_PATCHES_SOURCE_URL = "0"
+```
+
+### Method to access browser CDP connection
+Sometimes, it could be very useful to access a CDP session at a browser level. For example, when you want to implement some custom CDP command. There is a method `page._client()` that returns CDP session for the current page instance, but there is no such method for browser instance. 
+This patch adds a new method `_connection()` to Browser class, so you can use it like this:
+```js
+browser._connection().on('Rebrowser.addRunEvent', (params) => { ... })
+```
+*Note: it's not detectable by external website scripts, it's just for your convenience.*
+
+### Change default utility world name
+The default utility world name is `'__puppeteer_utility_world__' + packageVersion`. Sometimes you might want to change it to something else. This patch changes it to `util` and allows you to customize it via env variable:
+```shell
+REBROWSER_PATCHES_UTILITY_WORLD_NAME = "customUtilityWorld"
+# use 0 to completely disable this patch
+REBROWSER_PATCHES_UTILITY_WORLD_NAME = "0"
+```
+*This env variable cannot be changed on the fly, you have to set it before running your script because it's used at the moment when the module is getting imported.*
+
+*Note: it's not detectable by external website scripts, but Google might use this information in their proprietary Chrome; we never know.*
+
 ## Usage
 This package is designed to be run against an installed library. Install the Puppeteer library, then call the patcher, and it's ready to go.
 
@@ -76,7 +105,7 @@ You can see all command-line options by running `npx rebrowser-patches@latest --
 ⚠️ Be aware that after running `npm install` or `yarn install` in your project folder, it might override all the changes from the patches. You'll need to run the patcher again to keep the patches in place.
 
 ## How to update the patches?
-If you already have your package patched and want to update to the latest version of rebrowser-patches, the easiest way would be to delete `node_modules/puppeteer-core`, then run `npm install`, and then run `npx rebrowser-patches@latest patch`.
+If you already have your package patched and want to update to the latest version of rebrowser-patches, the easiest way would be to delete `node_modules/puppeteer-core`, then run `npm install` or `yarn install --check-files`, and then run `npx rebrowser-patches@latest patch`.
 
 ## Supported versions
 

package.json

@@ -54,11 +54,5 @@
   },
   "dependencies": {
     "yargs": "^17.7.2"
-  },
-  "devDependencies": {
-    "eslint": "^8.51.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-plugin-unused-imports": "^3.0.0"
   }
 }

…peteer-core/22.13.x/fixRuntimeLeak.patch patches/puppeteer-core/22.13.x.patchpatches/puppeteer-core/22.13.x/fixRuntimeLeak.patch renamed to patches/puppeteer-core/22.13.x.patch patches/puppeteer-core/22.13.x/fixRuntimeLeak.patch renamed to patches/puppeteer-core/22.13.x.patch

@@ -1,3 +1,18 @@
+--- a/src/cdp/Browser.ts	
++++ b/src/cdp/Browser.ts	
+@@ -338,6 +338,11 @@
+     return await this.#defaultContext.newPage();
+   }
+ 
++  // rebrowser-patches: expose browser CDP session
++  _connection(): Connection {
++    return this.#connection;
++  }
++
+   async _createPageInContext(contextId?: string): Promise<Page> {
+     const {targetId} = await this.#connection.send('Target.createTarget', {
+       url: 'about:blank',
+
 --- a/src/cdp/ExecutionContext.ts	
 +++ b/src/cdp/ExecutionContext.ts	
 @@ -78,6 +78,7 @@
@@ -290,6 +305,56 @@
 
    mainRealm(): Realm {
 
+--- a/src/common/util.ts	
++++ b/src/common/util.ts	
+@@ -328,7 +328,9 @@
+  * @internal
+  */
+ export const UTILITY_WORLD_NAME =
+-  '__puppeteer_utility_world__' + packageVersion;
++  // rebrowser-patches: change utility world name
++  process.env['REBROWSER_PATCHES_UTILITY_WORLD_NAME'] !== '0' ? (process.env['REBROWSER_PATCHES_UTILITY_WORLD_NAME'] || 'util') :
++    '__puppeteer_utility_world__' + packageVersion;
+ 
+ /**
+  * @internal
+@@ -338,6 +340,10 @@
+  * @internal
+  */
+ export function getSourceUrlComment(url: string): string {
++  // rebrowser-patches: change sourceUrl to generic script name
++  if (process.env['REBROWSER_PATCHES_SOURCE_URL'] !== '0') {
++    url = process.env['REBROWSER_PATCHES_SOURCE_URL'] || 'app.js'
++  }
+   return `//# sourceURL=${url}`;
+ }
+ 
+
+--- a/lib/cjs/puppeteer/cdp/Browser.d.ts	
++++ b/lib/cjs/puppeteer/cdp/Browser.d.ts	
+@@ -32,6 +32,7 @@
+     _disposeContext(contextId?: string): Promise<void>;
+     wsEndpoint(): string;
+     newPage(): Promise<Page>;
++    _connection(): Connection;
+     _createPageInContext(contextId?: string): Promise<Page>;
+     targets(): CdpTarget[];
+     target(): CdpTarget;
+
+--- a/lib/cjs/puppeteer/cdp/Browser.js	
++++ b/lib/cjs/puppeteer/cdp/Browser.js	
+@@ -176,6 +176,10 @@
+     async newPage() {
+         return await this.#defaultContext.newPage();
+     }
++    // rebrowser-patches: expose browser CDP session
++    _connection() {
++        return this.#connection;
++    }
+     async _createPageInContext(contextId) {
+         const { targetId } = await this.#connection.send('Target.createTarget', {
+             url: 'about:blank',
+
 --- a/lib/cjs/puppeteer/cdp/ExecutionContext.d.ts	
 +++ b/lib/cjs/puppeteer/cdp/ExecutionContext.d.ts	
 @@ -22,6 +22,7 @@
@@ -585,6 +650,57 @@
      mainRealm() {
          return this.#world;
 
+--- a/lib/cjs/puppeteer/common/util.js	
++++ b/lib/cjs/puppeteer/common/util.js	
+@@ -294,7 +294,10 @@
+ /**
+  * @internal
+  */
+-exports.UTILITY_WORLD_NAME = '__puppeteer_utility_world__' + version_js_1.packageVersion;
++exports.UTILITY_WORLD_NAME = 
++// rebrowser-patches: change utility world name
++process.env['REBROWSER_PATCHES_UTILITY_WORLD_NAME'] !== '0' ? (process.env['REBROWSER_PATCHES_UTILITY_WORLD_NAME'] || 'util') :
++    '__puppeteer_utility_world__' + version_js_1.packageVersion;
+ /**
+  * @internal
+  */
+@@ -303,6 +306,10 @@
+  * @internal
+  */
+ function getSourceUrlComment(url) {
++    // rebrowser-patches: change sourceUrl to generic script name
++    if (process.env['REBROWSER_PATCHES_SOURCE_URL'] !== '0') {
++        url = process.env['REBROWSER_PATCHES_SOURCE_URL'] || 'app.js';
++    }
+     return `//# sourceURL=${url}`;
+ }
+ exports.getSourceUrlComment = getSourceUrlComment;
+
+--- a/lib/esm/puppeteer/cdp/Browser.d.ts	
++++ b/lib/esm/puppeteer/cdp/Browser.d.ts	
+@@ -32,6 +32,7 @@
+     _disposeContext(contextId?: string): Promise<void>;
+     wsEndpoint(): string;
+     newPage(): Promise<Page>;
++    _connection(): Connection;
+     _createPageInContext(contextId?: string): Promise<Page>;
+     targets(): CdpTarget[];
+     target(): CdpTarget;
+
+--- a/lib/esm/puppeteer/cdp/Browser.js	
++++ b/lib/esm/puppeteer/cdp/Browser.js	
+@@ -173,6 +173,10 @@
+     async newPage() {
+         return await this.#defaultContext.newPage();
+     }
++    // rebrowser-patches: expose browser CDP session
++    _connection() {
++        return this.#connection;
++    }
+     async _createPageInContext(contextId) {
+         const { targetId } = await this.#connection.send('Target.createTarget', {
+             url: 'about:blank',
+
 --- a/lib/esm/puppeteer/cdp/ExecutionContext.d.ts	
 +++ b/lib/esm/puppeteer/cdp/ExecutionContext.d.ts	
 @@ -22,6 +22,7 @@
@@ -879,3 +995,29 @@
      }
      mainRealm() {
          return this.#world;
+
+--- a/lib/esm/puppeteer/common/util.js	
++++ b/lib/esm/puppeteer/common/util.js	
+@@ -254,7 +254,10 @@
+ /**
+  * @internal
+  */
+-export const UTILITY_WORLD_NAME = '__puppeteer_utility_world__' + packageVersion;
++export const UTILITY_WORLD_NAME = 
++// rebrowser-patches: change utility world name
++process.env['REBROWSER_PATCHES_UTILITY_WORLD_NAME'] !== '0' ? (process.env['REBROWSER_PATCHES_UTILITY_WORLD_NAME'] || 'util') :
++    '__puppeteer_utility_world__' + packageVersion;
+ /**
+  * @internal
+  */
+@@ -263,6 +266,10 @@
+  * @internal
+  */
+ export function getSourceUrlComment(url) {
++    // rebrowser-patches: change sourceUrl to generic script name
++    if (process.env['REBROWSER_PATCHES_SOURCE_URL'] !== '0') {
++        url = process.env['REBROWSER_PATCHES_SOURCE_URL'] || 'app.js';
++    }
+     return `//# sourceURL=${url}`;
+ }
+ /**

scripts/patcher.js

@@ -9,15 +9,13 @@ import { hideBin } from 'yargs/helpers'
 import {
   exec,
   fatalError,
-  getAvailablePatchesNames,
   getPatchBaseCmd,
   getPatcherPackagePath,
   log,
 } from './utils/index.js';
 
 (async () => {
   // config and preparations
-  const patchesNames = await getAvailablePatchesNames()
   const cliArgs = yargs(hideBin(process.argv))
     .usage('Usage: <command> [options]')
     .command('patch', 'Apply patch')
@@ -26,18 +24,14 @@ import {
     .describe('packageName', 'Target package name: puppeteer-core, playwright')
     .default('packageName', 'puppeteer-core')
     .describe('packagePath', 'Path to the target package')
-    .describe('patchName', `Patch name: ${patchesNames.join(', ')}`)
-    .default('patchName', 'fixRuntimeLeak')
     .boolean('debug')
     .describe('debug', 'Enable debugging mode')
-    .demandOption(['patchName', 'packageName'])
     .demandCommand(1, 1, 'Error: choose a command (patch, unpatch, check)')
     .parse()
 
   let {
     packageName,
     packagePath,
-    patchName,
     debug,
   } = cliArgs
 
@@ -56,10 +50,10 @@ import {
     fatalError(`Unknown command: ${command}`)
   }
 
-  const patchFilePath = resolve(getPatcherPackagePath(), `./patches/${packageName}/22.13.x/fixRuntimeLeak.patch`)
+  const patchFilePath = resolve(getPatcherPackagePath(), `./patches/${packageName}/22.13.x.patch`)
 
   log('Config:')
-  log(`command = ${command}, packageName = ${packageName}, patchName = ${patchName}`)
+  log(`command = ${command}, packageName = ${packageName}`)
   log(`packagePath = ${packagePath}`)
   log(`patchFilePath = ${patchFilePath}`)
   log('------')

scripts/utils/index.js

@@ -25,13 +25,6 @@ export const getPatcherPackagePath = () => {
   return resolve(dirname(fileURLToPath(import.meta.url)), '../..')
 }
 
-export const getAvailablePatchesNames = async () => {
-  const pptrBaseDir = resolve(getPatcherPackagePath(), './patches/puppeteer-core/')
-  const pptrVersions = await readdir(pptrBaseDir)
-  const latestVersionPatches = await readdir(resolve(pptrBaseDir, pptrVersions[0]))
-  return latestVersionPatches.map(p => p.split('.')[0])
-}
-
 export const fatalError = (...args) => {
   console.error('❌ FATAL ERROR:', ...args)
   process.exit(1)