github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update the extensions guide (#12290)

Browse Source
This commit is contained in:
Alex Rudenko 2024-04-18 12:33:30 +02:00 committed by GitHub
parent ef8c4c808a
commit 3b70667a47
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 57 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
docs/guides/chrome-extensions.md
View File

@ -4,8 +4,14 @@ Puppeteer can be used for testing Chrome Extensions.
:::caution :::caution
Extensions in Chrome/Chromium currently only work in non-headless mode and Extensions are not available in chrome-headless-shell (headless: 'shell'),
experimental Chrome headless mode. also known as the old headless mode.
:::
:::note
See https://developer.chrome.com/docs/extensions/how-to/test/end-to-end-testing for more details.
::: :::
@ -17,22 +23,19 @@ an extension whose source is located in `./my-extension`:
import puppeteer from 'puppeteer'; import puppeteer from 'puppeteer';
import path from 'path'; import path from 'path';
(async () => { const pathToExtension = path.join(process.cwd(), 'my-extension');
const pathToExtension = path.join(process.cwd(), 'my-extension'); const browser = await puppeteer.launch({
const browser = await puppeteer.launch({ args: [
headless: 'new', `--disable-extensions-except=${pathToExtension}`,
args: [ `--load-extension=${pathToExtension}`,
`--disable-extensions-except=${pathToExtension}`, ],
`--load-extension=${pathToExtension}`, });
], const backgroundPageTarget = await browser.waitForTarget(
}); target => target.type() === 'background_page'
const backgroundPageTarget = await browser.waitForTarget( );
target => target.type() === 'background_page' const backgroundPage = await backgroundPageTarget.page();
); // Test the background page as you would any other page.
const backgroundPage = await backgroundPageTarget.page(); await browser.close();
// Test the background page as you would any other page.
await browser.close();
})();
``` ```
:::note :::note
@ -42,8 +45,43 @@ Chrome Manifest V3 extensions have a background ServiceWorker of type
::: :::
```ts
import puppeteer from 'puppeteer';
import path from 'path';
const pathToExtension = path.join(process.cwd(), 'my-extension');
const browser = await puppeteer.launch({
args: [
`--disable-extensions-except=${pathToExtension}`,
`--load-extension=${pathToExtension}`,
],
});
const workerTarget = await browser.waitForTarget(
// Assumes that there is only one service worker created by the extension and its URL ends with background.js.
target =>
target.type() === 'service_worker' && target.url().endsWith('background.js')
);
const worker = await workerTarget.worker();
// Open a popup (available for Canary channels).
await worker.evaluate('chrome.action.openPopup();');
const popupTarget = await browser.waitForTarget(
// Assumes that there is only one page with the URL ending with popup.html and that is the popup created by the extension.
target => target.type() === 'page' && target.url().endsWith('popup.html')
);
const popupPage = popupTarget.asPage();
// Test the popup page as you would any other page.
await browser.close();
```
:::note :::note
It is not yet possible to test extension popups or content scripts. It is not yet possible to test extension content scripts.
::: :::