puppeteer-extra-plugin-portal

A puppeteer-extra plugin to let you interact with headless sessions remotely

Usage no npm install needed!

<script type="module">
  import puppeteerExtraPluginPortal from 'https://cdn.skypack.dev/puppeteer-extra-plugin-portal';
</script>

README

puppeteer-extra-plugin-portal

A puppeteer-extra plugin that hosts a webserver to remotely view puppeteer sessions. Essentially opening a "portal" to the page.

Install

yarn add puppeteer-extra-plugin-portal
# - or -
npm install puppeteer-extra-plugin-portal

If this is your first puppeteer-extra plugin here's everything you need:

yarn add puppeteer puppeteer-extra puppeteer-extra-plugin-portal
# - or -
npm install puppeteer puppeteer-extra puppeteer-extra-plugin-portal

Usage

// puppeteer-extra is a drop-in replacement for puppeteer,
// it augments the installed puppeteer with plugin functionality
import puppeteer from 'puppeteer-extra';


// add portal plugin
import PortalPlugin from 'puppeteer-extra-plugin-portal';
puppeteer.use(
  PortalPlugin({
    // This is a typical configuration when hosting behind a secured reverse proxy
    webPortalConfig: {
        listenOpts: {
          port: 3000,
        },
        baseUrl: 'https://portal.example.com',
      },
  })
)

// puppeteer usage as normal
puppeteer.launch({ headless: true }).then(async browser => {
  const page = await browser.newPage();
  await page.goto('https://www.google.com/recaptcha/api2/demo');

  // Open a portal to get a link to it. 
  const portalUrl = await page.openPortal();
  console.log('Portal URL:', portalUrl);

  // Wait a long time for the success condition to be met
  const successDiv = await page.waitForSelector('.recaptcha-success', {
      timeout: 86400 * 1000, // 24 hours
    });
  
  await page.closePortal(); // You can manually close a portal with
  await page.close(); // Closing the page will automatically close its portal.
  await browser.close(); // Closing the browser will automatically close the portals opened on it.
  // When all portals are closed, the web server will automatically shut down
})