a727fe82ad
Mirror the wiki content into a docs/ tree so GitBook Git Sync can connect to this repo. Adds SUMMARY.md for the table of contents, .gitbook.yaml pointing GitBook at docs/, and converts wiki page links to relative .md paths.
125 lines
2.5 KiB
Markdown
125 lines
2.5 KiB
Markdown
## Setup
|
|
|
|
```bash
|
|
obscura serve --port 9222
|
|
npm install puppeteer-core
|
|
```
|
|
|
|
## Connect
|
|
|
|
```js
|
|
const puppeteer = require('puppeteer-core');
|
|
|
|
const browser = await puppeteer.connect({
|
|
browserWSEndpoint: 'ws://127.0.0.1:9222',
|
|
});
|
|
```
|
|
|
|
Use `puppeteer-core`, not `puppeteer`. The `puppeteer` package bundles a Chrome download.
|
|
|
|
## Navigate
|
|
|
|
```js
|
|
const page = await browser.newPage();
|
|
await page.goto('https://example.com');
|
|
await page.goto('https://example.com', { waitUntil: 'load' });
|
|
await page.goto('https://example.com', { waitUntil: 'networkidle0', timeout: 60000 });
|
|
```
|
|
|
|
Default `waitUntil` is `domcontentloaded`. Other values: `load`, `networkidle2`, `networkidle0`.
|
|
|
|
## Evaluate
|
|
|
|
```js
|
|
const title = await page.evaluate(() => document.title);
|
|
|
|
const items = await page.evaluate(() => {
|
|
return Array.from(document.querySelectorAll('.item')).map(el => ({
|
|
text: el.textContent,
|
|
href: el.querySelector('a')?.href,
|
|
}));
|
|
});
|
|
```
|
|
|
|
## Interact
|
|
|
|
```js
|
|
await page.click('#login-button');
|
|
await page.type('#username', 'alice');
|
|
await page.fill('#password', 'secret'); // alias of .type for compat
|
|
|
|
await page.waitForSelector('#dashboard');
|
|
await page.waitForFunction(() => window.appReady === true);
|
|
```
|
|
|
|
## Cookies
|
|
|
|
```js
|
|
await page.setCookie({
|
|
name: 'session',
|
|
value: 'abc123',
|
|
domain: 'example.com',
|
|
path: '/',
|
|
httpOnly: true,
|
|
secure: true,
|
|
});
|
|
|
|
const cookies = await page.cookies();
|
|
```
|
|
|
|
For session persistence across runs see [Persist cookies and storage](Persist-cookies-and-storage.md).
|
|
|
|
## Intercept requests
|
|
|
|
```js
|
|
await page.setRequestInterception(true);
|
|
|
|
page.on('request', req => {
|
|
if (req.resourceType() === 'image') {
|
|
req.abort();
|
|
} else {
|
|
req.continue();
|
|
}
|
|
});
|
|
```
|
|
|
|
See [Intercept and modify requests](Intercept-and-modify-requests.md).
|
|
|
|
## Expose a Node callback
|
|
|
|
```js
|
|
await page.exposeFunction('logFromPage', (msg) => {
|
|
console.log('page:', msg);
|
|
});
|
|
|
|
await page.evaluate(() => {
|
|
window.logFromPage('hello from the browser');
|
|
});
|
|
```
|
|
|
|
## Multiple pages
|
|
|
|
```js
|
|
const page1 = await browser.newPage();
|
|
const page2 = await browser.newPage();
|
|
|
|
await Promise.all([
|
|
page1.goto('https://a.example.com'),
|
|
page2.goto('https://b.example.com'),
|
|
]);
|
|
```
|
|
|
|
Pages share one V8 isolate. Concurrent JS execution serializes through a lock. CPU-bound JS on one page blocks the others.
|
|
|
|
## Disconnect
|
|
|
|
```js
|
|
await browser.disconnect(); // leaves obscura serve running
|
|
```
|
|
|
|
## Not supported
|
|
|
|
- `page.screenshot()` and `page.pdf()`: no pixel rendering.
|
|
- `page.emulate()` device emulation: viewport metadata only, no real layout.
|
|
- Service workers: not implemented.
|