Merge upstream/master into master (0.31.2-lum.14 => 0.33.3-lum.15)

Author: kevinbrd123

.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+jobs:
+  Tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Dump Chrome version
+        run: |
+          "$CHROME_BIN" --version
+      - name: Dump Node.js version
+        run: |
+          node --version
+      - name: Dump NPM version
+        run: |
+          npm --version
+      - name: Install dependencies
+        run: |
+          npm install
+      - name: Start headless Chrome
+        run: |
+          $CHROME_BIN \
+              --disable-extensions \
+              --disable-gpu \
+              --headless \
+              --no-first-run \
+              --no-sandbox \
+              --remote-debugging-port=9222 \
+              --user-data-dir="$(mktemp -d)" \
+              about:blank &
+      - name: Wait for Chrome to start listening
+        run: |
+          while ! curl --silent --fail http://localhost:9222; do sleep 1; done
+      - name: Run tests
+        run: |
+          npm test

.travis.yml

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Andrea Cardaci <cyrus.and@gmail.com>
+Copyright (c) 2025 Andrea Cardaci <cyrus.and@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

LICENSE

@@ -1,17 +1,12 @@
-# chrome-remote-interface [![Build Status][]][travis]
+# chrome-remote-interface
 
-[Build Status]: https://app.travis-ci.com/cyrus-and/chrome-remote-interface.svg?branch=master
-[travis]: https://app.travis-ci.com/cyrus-and/chrome-remote-interface
+[![CI status](https://github.com/cyrus-and/chrome-remote-interface/actions/workflows/ci.yml/badge.svg)](https://github.com/cyrus-and/chrome-remote-interface/actions?query=workflow:CI)
 
 [Chrome Debugging Protocol] interface that helps to instrument Chrome (or any
 other suitable [implementation](#implementations)) by providing a simple
 abstraction of commands and notifications using a straightforward JavaScript
 API.
 
-This module is one of the many [third-party protocol clients][3rd-party].
-
-[3rd-party]: https://developer.chrome.com/devtools/docs/debugging-clients#chrome-remote-interface
-
 ## Sample API usage
 
 The following snippet loads `https://github.com` and dumps every request made:
@@ -131,14 +126,14 @@ Since version 59, additionally use the `--headless` option, for example:
 
 #### Android
 
-Plug the device and enable the [port forwarding][adb], for example:
+Plug the device and make sure to authorize the connection from the device itself. Then
+enable the port forwarding, for example:
 
-    adb forward tcp:9222 localabstract:chrome_devtools_remote
+    adb -d forward tcp:9222 localabstract:chrome_devtools_remote
 
-Note that in Android, Chrome does not have its own protocol available, a local
-version must be used. See [here](#chrome-debugging-protocol-versions) for more information.
-
-[adb]: https://developer.chrome.com/devtools/docs/remote-debugging-legacy
+After that you should be able to use `http://127.0.0.1:9222` as usual, but note that in
+Android, Chrome does not have its own protocol available, so a local version must be used.
+See [here](#chrome-debugging-protocol-versions) for more information.
 
 ##### WebView
 
@@ -400,6 +395,7 @@ To generate a JavaScript file that can be used with a `<script>` element:
     </script>
     <script src="chrome-remote-interface.js"></script>
     ```
+
 ## TypeScript Support
 
 [TypeScript][] definitions are kindly provided by [Khairul Azhar Kasmiran][] and [Seth Westphal][], and can be installed from [DefinitelyTyped][]:
@@ -408,6 +404,12 @@ To generate a JavaScript file that can be used with a `<script>` element:
 npm install --save-dev @types/chrome-remote-interface
 ```
 
+Note that the TypeScript definitions are automatically generated from the npm package `devtools-protocol@0.0.927104`. For other versions of devtools-protocol:
+
+1. Install patch-package using [the instructions given](https://github.com/ds300/patch-package#set-up).
+2. Copy the contents of the corresponding https://github.com/ChromeDevTools/devtools-protocol/tree/master/types folder (according to commit) into `node_modules/devtools-protocol/types`.
+3. Run `npx patch-package devtools-protocol` so that the changes persist across an `npm install`.
+
 [TypeScript]: https://www.typescriptlang.org/
 [Khairul Azhar Kasmiran]: https://github.com/kazarmy
 [Seth Westphal]: https://github.com/westy92

README.md

@@ -225,7 +225,12 @@ class Chrome extends EventEmitter {
                 if (this.secure) {
                     this.webSocketUrl = this.webSocketUrl.replace(/^ws:/i, 'wss:');
                 }
-                this._ws = new WebSocket(this.webSocketUrl, [], options);
+                this._ws = new WebSocket(this.webSocketUrl, [], {
+                    maxPayload: 256 * 1024 * 1024,
+                    perMessageDeflate: false,
+                    followRedirects: true,
+                    ...options,
+                });
             } catch (err) {
                 // handles bad URLs
                 reject(err);

lib/chrome.js

@@ -7,16 +7,16 @@ const defaults = require('./defaults.js');
 const externalRequest = require('./external-request.js');
 
 // options.path must be specified; callback(err, data)
-function devToolsInterface(options, callback) {
-    options.host = options.host || defaults.HOST;
-    options.port = options.port || defaults.PORT;
-    options.secure = !!(options.secure);
-    options.useHostName = !!(options.useHostName);
-    options.alterPath = options.alterPath || ((path) => path);
-    // allow the user to alter the path
-    const newOptions = {...options};
-    newOptions.path = options.alterPath(options.path);
-    externalRequest(options.secure ? https : http, newOptions, callback);
+function devToolsInterface(path, options, callback) {
+    const transport = options.secure ? https : http;
+    const requestOptions = {
+        method: options.method,
+        host: options.host || defaults.HOST,
+        port: options.port || defaults.PORT,
+        useHostName: options.useHostName,
+        path: (options.alterPath ? options.alterPath(path) : path)
+    };
+    externalRequest(transport, requestOptions, callback);
 }
 
 // wrapper that allows to return a promise if the callback is omitted, it works
@@ -55,8 +55,7 @@ function Protocol(options, callback) {
         return;
     }
     // try to fetch the protocol remotely
-    options.path = '/json/protocol';
-    devToolsInterface(options, (err, descriptor) => {
+    devToolsInterface('/json/protocol', options, (err, descriptor) => {
         if (err) {
             callback(err);
         } else {
@@ -66,8 +65,7 @@ function Protocol(options, callback) {
 }
 
 function List(options, callback) {
-    options.path = '/json/list';
-    devToolsInterface(options, (err, tabs) => {
+    devToolsInterface('/json/list', options, (err, tabs) => {
         if (err) {
             callback(err);
         } else {
@@ -77,12 +75,12 @@ function List(options, callback) {
 }
 
 function New(options, callback) {
-    options.path = '/json/new';
-    options.method = 'PUT';
+    let path = '/json/new';
     if (Object.prototype.hasOwnProperty.call(options, 'url')) {
-        options.path += `?${options.url}`;
+        path += `?${options.url}`;
     }
-    devToolsInterface(options, (err, tab) => {
+    options.method = options.method || 'PUT'; // see #497
+    devToolsInterface(path, options, (err, tab) => {
         if (err) {
             callback(err);
         } else {
@@ -92,8 +90,7 @@ function New(options, callback) {
 }
 
 function Activate(options, callback) {
-    options.path = '/json/activate/' + options.id;
-    devToolsInterface(options, (err) => {
+    devToolsInterface('/json/activate/' + options.id, options, (err) => {
         if (err) {
             callback(err);
         } else {
@@ -103,8 +100,7 @@ function Activate(options, callback) {
 }
 
 function Close(options, callback) {
-    options.path = '/json/close/' + options.id;
-    devToolsInterface(options, (err) => {
+    devToolsInterface('/json/close/' + options.id, options, (err) => {
         if (err) {
             callback(err);
         } else {
@@ -114,8 +110,7 @@ function Close(options, callback) {
 }
 
 function Version(options, callback) {
-    options.path = '/json/version';
-    devToolsInterface(options, (err, versionInfo) => {
+    devToolsInterface('/json/version', options, (err, versionInfo) => {
         if (err) {
             callback(err);
         } else {

lib/devtools.js

@@ -37,15 +37,14 @@ async function externalRequest(transport, options, callback) {
     if (!options.useHostName) {
         try {
             const {address} = await util.promisify(dns.lookup)(options.host);
-            options = Object.assign({}, options);
             options.host = address;
         } catch (err) {
             callback(err);
             return;
         }
     }
     // perform the actual request
-    const request = transport.get(options, (response) => {
+    const request = transport.request(options, (response) => {
         if (
             needRedirect(response, options) &&
             makeRedirect(response, transport, options, callback)
@@ -69,6 +68,7 @@ async function externalRequest(transport, options, callback) {
         request.abort();
     });
     request.on('error', callback);
+    request.end();
 }
 
 module.exports = externalRequest;