Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gajus/puppeteer-proxy
Proxies Puppeteer Page requests.
https://github.com/gajus/puppeteer-proxy
http proxy puppeteer
Last synced: about 2 months ago
JSON representation
Proxies Puppeteer Page requests.
- Host: GitHub
- URL: https://github.com/gajus/puppeteer-proxy
- Owner: gajus
- License: other
- Created: 2020-01-29T17:19:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T02:41:31.000Z (about 2 years ago)
- Last Synced: 2024-07-18T22:15:32.376Z (2 months ago)
- Topics: http, proxy, puppeteer
- Language: JavaScript
- Size: 57.6 KB
- Stars: 197
- Watchers: 5
- Forks: 24
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# puppeteer-proxy 🎎
[](https://travis-ci.org/gajus/puppeteer-proxy)
[](https://coveralls.io/github/gajus/puppeteer-proxy)
[](https://www.npmjs.org/package/puppeteer-proxy)
[](https://github.com/gajus/canonical)
[](https://twitter.com/kuizinas)
Proxies [Puppeteer](https://github.com/puppeteer/puppeteer) Page requests.
* Allows to change proxy per Page and per Request.
* Allows to authenticate using http://username:password@proxy schema.
* Handles cookies.
* Handles binary files.
* Supports custom [HTTP(S) agents](https://nodejs.org/api/http.html#http_class_http_agent).
## Motivation
This package addresses several issues with Puppeteer:
* It allows to set a proxy per Page and per Request ([#678](https://github.com/puppeteer/puppeteer/issues/678))
* It allows to authenticate against proxy when making HTTPS requests ([#3253](https://github.com/puppeteer/puppeteer/issues/3253))
The side-benefit of this [implementation](#implementation) is that it allows to route all traffic through Node.js, i.e. you can use externally hosted Chrome instance (such as [Browserless.io](https://www.browserless.io/)) to render DOM & evaluate JavaScript, and route all HTTP traffic through your Node.js instance.
The downside of this implementation is that it will introduce additional latency, i.e. requests will take longer to execute as request/ response will need to be always exchanged between Puppeteer and Node.js.
## Implementation
puppeteer-proxy intercepts requests after it receives the request metadata from Puppeteer. puppeteer-proxy uses Node.js to make the HTTP requests. The response is then returned to the browser. When using puppeteer-proxy, browser never makes outbound HTTP requests.
## Setup
You must call [`page.setRequestInterception(true)`](https://pptr.dev/#?product=Puppeteer&version=v2.1.0&show=api-pagesetrequestinterceptionvalue) before using `pageProxy.proxyRequest`.
## API
```js
import {
Agent as HttpAgent,
} from 'http';
import {
Agent as HttpsAgent,
} from 'https';
import type {
Page,
Request,
} from 'puppeteer';
import {
proxyRequest,
} from 'puppeteer-proxy';
/**
* @property agent HTTP(s) agent to use when making the request.
* @property page Instance of Puppeteer Page.
* @property proxyUrl HTTP proxy URL. A different proxy can be set for each request.
* @property request Instance of Puppeteer Request.
*/
type ProxyRequestConfigurationType = {|
+agent?: HttpAgent | HttpsAgent,
+page: Page,
+proxyUrl?: string | { http: string, https: string },
+request: Request,
|};
proxyRequest(configuration: ProxyRequestConfigurationType): PageProxyType;
```
## Usage
### Making a GET request using proxy
```js
import puppeteer from 'puppeteer';
import {
proxyRequest,
} from 'puppeteer-proxy';
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.setRequestInterception(true);
page.on('request', async (request) => {
await proxyRequest({
page,
proxyUrl: 'http://127.0.0.1:3000',
request,
});
});
await page.goto('http://gajus.com');
})();
```