Doc polish. Example consistency (#233)
This commit is contained in:
Eric Bidelman
Andrey Lushnikov
parent
0a55345060
commit
1ee47d868b
@ -15,9 +15,9 @@ You generally only need to submit a CLA once, so if you've already submitted one
|
||||
(even if it was for a different project), you probably don't need to do it
|
||||
again.
|
||||
|
||||
## Getting the Code
|
||||
## Getting setup
|
||||
|
||||
1. Clone repository
|
||||
1. Clone this repository
|
||||
```bash
|
||||
git clone https://github.com/GoogleChrome/puppeteer
|
||||
cd puppeteer
|
||||
@ -123,22 +123,26 @@ are used to test `phantom_shim`.
|
||||
|
||||
Every public API method or event should be called at least once in tests. To ensure this, there's a coverage command which tracks calls to public API and reports back if some methods/events were not called.
|
||||
|
||||
- To run coverage:
|
||||
Run coverage:
|
||||
|
||||
```
|
||||
npm run coverage
|
||||
```
|
||||
|
||||
## Debugging Puppeteer
|
||||
Puppeteer uses [DEBUG](https://github.com/visionmedia/debug) module to expose some of it's inner guts under the `puppeteer` namespace.
|
||||
Try putting the following script in the `script.js` and running it via `DEBUG=* node script.js`:
|
||||
Puppeteer uses [DEBUG](https://github.com/visionmedia/debug) module to expose some of it's inner guts under the `puppeteer` namespace. Try putting the following in a file called `script.js` and running it via `DEBUG=* node script.js`:
|
||||
|
||||
```js
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
browser.newPage().then(async page => {
|
||||
await page.goto('https://example.com');
|
||||
browser.close();
|
||||
});
|
||||
|
||||
(async() => {
|
||||
|
||||
const page = await browser.newPage();
|
||||
await page.goto('https://example.com');
|
||||
browser.close();
|
||||
|
||||
})();
|
||||
```
|
||||
|
||||
Tips-n-tricks:
|
||||
|
||||
137
README.md
137
README.md
@ -1,52 +1,107 @@
|
||||
# Puppeteer [](https://travis-ci.com/GoogleChrome/puppeteer)
|
||||
# Puppeteer [](https://travis-ci.com/GoogleChrome/puppeteer)
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/238208/28749789-e67693de-7487-11e7-85f9-2d9ad9025aae.png" height="150" align="right">
|
||||
|
||||
###### [API](docs/api.md) | [FAQ](#faq) | [Contributing](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIBUTING.md)
|
||||
|
||||
Puppeteer is a node library which provides a high-level API to control [headless](https://developers.google.com/web/updates/2017/04/headless-chrome) Chrome over the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). It can also be configured to use full (non-headless) Chrome.
|
||||
Puppeteer is a Node library which provides a high-level API to control [headless](https://developers.google.com/web/updates/2017/04/headless-chrome) Chrome over the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). It can also be configured to use full (non-headless) Chrome.
|
||||
|
||||
###### Use Cases
|
||||
* Up-to-date testing environment that supports the latest JavaScript features.
|
||||
* Crawl your site to generate pre-rendered content for your SPA.
|
||||
###### What can I do?
|
||||
|
||||
Most things that you can do manually in the browser can be done using Puppeteer! Here are a few examples to get you started:
|
||||
|
||||
* Generate screenshots and PDFs of pages.
|
||||
* Crawl a SPA and generate pre-rendered content (i.e. "SSR").
|
||||
* Scrape content from websites.
|
||||
|
||||
###### Features
|
||||
* Full Page Screenshots
|
||||
* Low-Level Input Emulation
|
||||
* Build-In Device Emulation
|
||||
|
||||
## Installation
|
||||
|
||||
To add Puppeteer to your project, run:
|
||||
```
|
||||
yarn add puppeteer
|
||||
```
|
||||
|
||||
> **NOTE** Puppeteer bundles a version of Chromium (~90Mb) which it is guaranteed to work with. However, you're free to point Puppeteer to any Chromium executable ([documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#new-browseroptions))
|
||||
|
||||
* Automate form submission, UI testing, keyboard input, etc.
|
||||
* Create an up-to-date, automated testing environment. Run your tests directly in the latest version of Chrome using the latest JavaScript and browser features.
|
||||
* Capture a [timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference) of your site to help diagnose performance issues.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To navigate to https://example.com and save a screenshot as *example.png*, save the following script as `example.js` and run it using `node example.js`:
|
||||
### Installation
|
||||
|
||||
*Puppeteer requires Node version 7.10 or greater*
|
||||
|
||||
To use Puppeteer in your project, run:
|
||||
```
|
||||
yarn add puppeteer
|
||||
# or "npm i puppeteer"
|
||||
```
|
||||
|
||||
> **Note**: When you install Puppeteer, it downloads a recent version of Chromium (~71Mb Mac, ~90Mb Linux, ~110Mb Win) that is guaranteed to work with the API. However, you can [tell Puppeteer to use any Chromium executable](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#new-browseroptions) installed on the machine.
|
||||
|
||||
### Usage
|
||||
|
||||
Puppeteer will be familiar to using other browser testing frameworks. You create an instance
|
||||
of `Browser`, open pages, and then manipulate them with [Puppeteer's API]((https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#).
|
||||
|
||||
**Example** - navigating to https://example.com and saving a screenshot as *example.png*:
|
||||
|
||||
```js
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
browser.newPage().then(async page => {
|
||||
await page.goto('https://example.com');
|
||||
await page.screenshot({path: 'example.png'});
|
||||
browser.close();
|
||||
(async() => {
|
||||
const page = await browser.newPage();
|
||||
await page.goto('https://example.com');
|
||||
await page.screenshot({path: 'example.png'});
|
||||
|
||||
browser.close();
|
||||
})();
|
||||
```
|
||||
|
||||
or, without `async`/`await`:
|
||||
|
||||
```js
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
browser.newPage().then(page => {
|
||||
page.goto('https://example.com').then(response => {
|
||||
page.screenshot({path: 'example.png'}).then(buffer => {
|
||||
browser.close();
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
A few notes:
|
||||
Puppeteer sets an initial page size to 800px x 600px, which defines the screenshot size. The page size can be customized with [`Page.setViewport()`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetviewportviewport).
|
||||
|
||||
1. By default, Puppeteer bundles chromium browser with which it works best. However, you can point Puppeteer to a different executable ([example](https://github.com/GoogleChrome/puppeteer/blob/master/examples/custom-chromium-revision.js))
|
||||
2. Puppeteer creates its own Chromium user profile which it cleans up on every run.
|
||||
3. Puppeteer sets an initial page size to 800px x 600px, which defines the screenshot size. The page size can be changed with `Page.setViewportSize()` method
|
||||
4. By default, browser is launched in a headless mode. This could be changed via ['headless' browser option](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#new-browseroptions)
|
||||
**Example** - create a PDF.
|
||||
|
||||
```js
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
(async() => {
|
||||
const page = await browser.newPage();
|
||||
await page.goto('https://news.ycombinator.com', {waitUntil: 'networkidle'});
|
||||
await page.pdf({path: 'hn.pdf', format: 'A4'});
|
||||
|
||||
browser.close();
|
||||
})();
|
||||
```
|
||||
|
||||
See [`Page.pdf()`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions) for more information about creating pdfs.
|
||||
|
||||
## Default runtime settings
|
||||
|
||||
**Uses Headless mode**
|
||||
|
||||
Puppeteer launches Chromium in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome). To launch a full version of Chromium, set the ['headless' option](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#new-browseroptions) when creating a browser:
|
||||
|
||||
```js
|
||||
const browser = new Browser({headless: false});
|
||||
```
|
||||
|
||||
**Runs a bundled version of Chromium**
|
||||
|
||||
By default, Puppeteer downloads and uses a specific version of Chromium but it can be configured to [use another install of Chrome](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#new-browseroptions)
|
||||
|
||||
**Creates a fresh user profile**
|
||||
|
||||
Puppeteer creates its own Chromium user profile which it **cleans up on every run**.
|
||||
|
||||
## API Documentation
|
||||
|
||||
@ -54,40 +109,28 @@ Explore the [API documentation](docs/api.md) and [examples](https://github.com/G
|
||||
|
||||
## Contributing to Puppeteer
|
||||
|
||||
Check out [contributing guide](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIBUTING.md) to get an overview of puppeteer development.
|
||||
Check out [contributing guide](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIBUTING.md) to get an overview of puppeteer development.
|
||||
|
||||
# FAQ
|
||||
|
||||
#### Q: What is Puppeteer?
|
||||
|
||||
Puppeteer is a light-weight Node module to control headless Chrome using the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
|
||||
Puppeteer is a light-weight Node module to control headless Chrome using the latest version of the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
|
||||
|
||||
#### Q: Which Chromium version does Puppeteer use?
|
||||
|
||||
Puppeteer bundles chromium it works best with. As chromium improves over time, new versions of puppeteer will be released which depend on a newer chromium versions.
|
||||
Look for `chromium_revision` in [package.json](https://github.com/GoogleChrome/puppeteer/blob/master/package.json).
|
||||
|
||||
Current chromium version is declared in [package.json](https://github.com/GoogleChrome/puppeteer/blob/master/package.json) as `chromium_revision` field.
|
||||
Puppeteer bundles Chromium to insure that the latest features it uses are guaranteed to be available. As the DevTools protocol and browser improve over time, Puppeteer will be updated to depend on newer versions of Chromium.
|
||||
|
||||
#### Q: Does Puppeteer work with headless Chromium?
|
||||
|
||||
Yes. Puppeteer runs chromium in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome) by default.
|
||||
Yes. Puppeteer runs Chromium in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome) by default.
|
||||
|
||||
#### Q: Why do most of the API methods return promises?
|
||||
|
||||
Since Puppeteer's code is run by Node, it exists out-of-process to the controlled Chromium instance. This requires most of the API calls to be asynchronous to allow the necessary roundtrips to the browser.
|
||||
|
||||
It is recommended to use `async/await` to consume asynchronous api:
|
||||
```js
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
browser.newPage().then(async page => {
|
||||
await page.setViewport({width: 1000, height: 1000});
|
||||
await page.pdf({path: 'blank.pdf'});
|
||||
browser.close();
|
||||
});
|
||||
```
|
||||
|
||||
#### Q: What is the "Phantom Shim"?
|
||||
|
||||
To make sure Puppeteer's API is comprehensive, we built [PhantomShim](https://github.com/GoogleChrome/puppeteer/tree/master/phantom_shim) - a lightweight phantomJS script runner built atop of Puppeteer API. We run phantomJS tests against PhantomShim with an ultimate goal to pass them all.
|
||||
|
||||
@ -14,11 +14,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
(async() => {
|
||||
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
(async() => {
|
||||
|
||||
const page = await browser.newPage();
|
||||
await page.setRequestInterceptor(request => {
|
||||
if (/\.(png|jpg|jpeg$)/.test(request.url))
|
||||
@ -28,6 +28,7 @@ await page.setRequestInterceptor(request => {
|
||||
});
|
||||
await page.goto('https://bbc.com');
|
||||
await page.screenshot({path: 'news.png', fullPage: true});
|
||||
|
||||
browser.close();
|
||||
|
||||
})();
|
||||
|
||||
@ -14,19 +14,9 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
(async() => {
|
||||
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
const page = await browser.newPage();
|
||||
await page.evaluateOnNewDocument(sniffDetector);
|
||||
await page.goto('https://www.google.com', {waitUntil: 'networkidle'});
|
||||
console.log('Sniffed: ' + (await page.evaluate(() => !!navigator.sniffed)));
|
||||
browser.close();
|
||||
|
||||
})();
|
||||
|
||||
function sniffDetector() {
|
||||
let userAgent = window.navigator.userAgent;
|
||||
let platform = window.navigator.platform;
|
||||
@ -41,3 +31,14 @@ function sniffDetector() {
|
||||
return platform;
|
||||
});
|
||||
}
|
||||
|
||||
(async() => {
|
||||
|
||||
const page = await browser.newPage();
|
||||
await page.evaluateOnNewDocument(sniffDetector);
|
||||
await page.goto('https://www.google.com', {waitUntil: 'networkidle'});
|
||||
console.log('Sniffed: ' + (await page.evaluate(() => !!navigator.sniffed)));
|
||||
|
||||
browser.close();
|
||||
|
||||
})();
|
||||
@ -14,11 +14,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
(async() => {
|
||||
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
(async() => {
|
||||
|
||||
const page = await browser.newPage();
|
||||
await page.goto('https://news.ycombinator.com', {waitUntil: 'networkidle'});
|
||||
// page.pdf() is currently supported only in headless mode.
|
||||
|
||||
@ -17,8 +17,12 @@
|
||||
const {Browser} = require('puppeteer');
|
||||
const browser = new Browser();
|
||||
|
||||
browser.newPage().then(async page => {
|
||||
await page.goto('http://example.com');
|
||||
await page.screenshot({path: 'example.png'});
|
||||
browser.close();
|
||||
});
|
||||
(async() => {
|
||||
|
||||
const page = await browser.newPage();
|
||||
await page.goto('http://example.com');
|
||||
await page.screenshot({path: 'example.png'});
|
||||
|
||||
browser.close();
|
||||
|
||||
})();
|
||||
|
||||
Loading…
Reference in New Issue
Block a user