Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 3.53 KB

PuppeteerPageLoadOption.md

File metadata and controls

21 lines (15 loc) · 3.53 KB
Raw

Analysis of Puppeteer's page.goto() WaitUntil Options

While investigating timeout issues in the Blacklight tool, we specifically explored tweaking the waitUntil option in Puppeteer's page.goto() method. This option determines when the navigation is considered complete.

The page.goto() method is used to navigate the page to a URL. The waitUntil option controls when Puppeteer considers the navigation successful:

  • 'load' - Wait for full page load
  • 'domcontentloaded' - Wait for DOM only
  • 'networkidle0' - Wait for no network activity
  • 'networkidle2' - Wait for 2 or fewer connections

In the end, no single option solved the timeout issues completely. However, these notes capture our analysis of the tradeoffs between the different strategies.

We ultimately combined multiple approaches for the optimal solution. But this table represents a piece of the investigative journey to better understand Puppeteer page load behavior:

Options Advantages Disadvantages
load - Ensures all resources are fully loaded.
- Straightforward and easy to understand.		 - Can result in longer load times.
- Can result in unnecessary waiting if our script doesn't interact with or depend on all resources.
- If any resource fails to load, the load event will not fire, and Puppeteer will wait until the timeout.
domcontentloaded - Faster than load because it doesn't wait for stylesheets, images, and subframes to finish loading.
- Suitable if our script only interacts with the DOM.		 - If our script interacts with or depends on resources that load after the DOM, it might run before these resources are ready.
networkidle0 - Useful for pages that load additional resources after the load event.
- Waits until there are no more network connections for at least 500 ms.		 - Can result in longer load times.
- If the page continuously makes new network requests, the networkidle0 event might never occur, and Puppeteer will wait until the timeout.
networkidle2 - Similar to networkidle0, but allows for up to 2 network connections.
- Useful for pages that keep a couple of connections open indefinitely.		 - Can result in longer load times.
- If the page continuously makes more than 2 new network requests, the networkidle' event might never occur, and Puppeteer will wait until the timeout.