Skip to content

Latest commit

 

History

History
112 lines (74 loc) · 4.97 KB

README.md

File metadata and controls

112 lines (74 loc) · 4.97 KB
Raw

puppeteer-devtools

CircleCI Version

Extended puppeteer methods for getting extension devtools contexts.

This package relies on using internal puppeteer methods to return the Chrome devtools panel, along with extension panels. Since it is dependent on undocumented puppeteer apis, it could break in future versions of Chrome/puppeteer so use at your own risk.

Install

npm install --save-dev puppeteer-devtools

Usage

const puppeteer = require('puppeteer')
const {
  getDevtoolsPanel,
  setCaptureContentScriptExecutionContexts,
  getContentScriptExcecutionContext
} = require('puppeteer-devtools')
const path = require('path')

const extension = path.resolve('/path/to/extension')

const browser = await puppeteer.launch({
  args: [
    `--disable-extensions-except=${extension}`,
    `--load-extension=${extension}`
  ],
  devtools: true,
  headless: false
})

const [page] = await browser.pages()
await setCaptureContentScriptExecutionContexts(page)

await page.goto('https://google.com', { waitUntil: 'networkidle0' })
const panel = await getDevtoolsPanel(page, { panelName: 'panel.html' })
const contentScriptExecutionContext = await getContentScriptExecutionContext(
  page
)

Note: devtools must be enabled, and headless mode must be turned off. Chrome does not currently support extensions in headless mode.

Using a different browser executable

puppeteer-devtools currently is limited to versions of puppeteer < 16.1.0, meaning that in order to use versions of Chrome that are newer than the packaged version, you must use some variation of executable path:

browser.launch

await puppeteer.launch({
  ...options,
  executablePath: '/path/to/chrome'
})

Env Var

PUPPETEER_EXECUTABLE_PATH=/path/to/chrome npm run tests

Methods

async getDevtools( page, options? )

Returns the underlying Chrome devtools:// page as a Promise<Page>.

  • page - <Page> Puppeteer page object.
  • options - <object>
    • timeout - <number | null> Maximum time in milliseconds to wait for the devtools page to become available. Uses puppeteer's default timeout if not set.

async getDevtoolsPanel( page, options? )

Returns the underlying Chrome chrome-extension:// panel as a Promise<Frame>.

  • page - <Page> Puppeteer page object.
  • options - <object>
    • panelName - <string> The file name of the extension panel to find. A devtools page with chrome.devtools.panels.create('name', 'icon.png', 'panel.html', (panel) => { ... }) would have panel.html as its value.
    • timeout - <number | null> Maximum time in milliseconds to wait for the chrome extension panel to become available. Uses puppeteer's default timeout if not set.

async getBackground( page, options? )

Returns the underlying Chrome background page as a Promise<Page>.

  • page - <Page> Puppeteer page object.
  • options - <object>
    • timeout - <number | null> Maximum time in milliseconds to wait for the background page to become available. Uses puppeteer's default timeout if not set.

async setCaptureContentScriptExecutionContexts( page )

Activating capture content script execution contexts will allow for the usage of an extension's content script ExecutionContext. This must be activated before a page is navigated.

  • page - <Page> Puppeteer page object.

async getContentScriptExcecutionContext( page )

If setCaptureContentScriptExecutionContexts has been enabled for a page, this returns the extension's content script ExecutionContext. This will error for pages that the extension does not have permissions for or for extensions that do not have content scripts.

  • page - <Page> Puppeteer page object.

License

MPL 2.0

Copyright

Copyright (c) 2019-2024 Deque Systems, Inc.