puppeteer/faq/index.html

109 lines
60 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-19.11.0 plugin-docs plugin-id-default docs-doc-id-faq">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.0">
<title data-rh="true">FAQ | Puppeteer</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pptr.dev/faq"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:counter" content="2"><meta data-rh="true" property="og:title" content="FAQ | Puppeteer"><meta data-rh="true" name="description" content="Q: Who maintains Puppeteer?"><meta data-rh="true" property="og:description" content="Q: Who maintains Puppeteer?"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/faq"><link data-rh="true" rel="alternate" href="https://pptr.dev/faq" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/faq" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://DVKY664LG7-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Puppeteer" href="/opensearch.xml">
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.3077b280.css">
<link rel="preload" href="/assets/js/runtime~main.95133fac.js" as="script">
<link rel="preload" href="/assets/js/main.db5a1e29.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Puppeteer</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">Docs</a><a class="navbar__item navbar__link" href="/api/puppeteer.puppeteernode">Puppeteer API</a><a class="navbar__item navbar__link" href="/browsers-api/">@puppeteer/browsers API</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/">19.11.0</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/next/faq">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/faq">19.11.0</a></li><li><hr class="dropdown-separator"></li><li class="dropdown-archived-versions"><b>Archived versions</b></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.10.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.10.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.10.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.10.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.9.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.9.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.9.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.9.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.8.5/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.8.5<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.8.4/docs/api/index.md" target="
expertise on the project! See our
<a href="https://pptr.dev/contributing" target="_blank" rel="noopener noreferrer">contributing guide</a>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="q-what-is-the-status-of-cross-browser-support">Q: What is the status of cross-browser support?<a href="#q-what-is-the-status-of-cross-browser-support" class="hash-link" aria-label="Direct link to Q: What is the status of cross-browser support?" title="Direct link to Q: What is the status of cross-browser support?"></a></h2><p>Official Firefox support is currently experimental. The ongoing collaboration
with Mozilla aims to support common end-to-end testing use cases, for which
developers expect cross-browser coverage. The Puppeteer team needs input from
users to stabilize Firefox support and to bring missing APIs to our attention.</p><p>From Puppeteer v2.1.0 onwards you can specify
<a href="/api/puppeteer.puppeteernode.launch"><code>puppeteer.launch({product: &#x27;firefox&#x27;})</code></a>
to run your Puppeteer scripts in Firefox Nightly, without any additional custom
patches. While
<a href="https://www.npmjs.com/package/puppeteer-firefox" target="_blank" rel="noopener noreferrer">an older experiment</a> required
a patched version of Firefox,
<a href="https://wiki.mozilla.org/Remote" target="_blank" rel="noopener noreferrer">the current approach</a> works with “stock”
Firefox.</p><p>We will continue to collaborate with other browser vendors to bring Puppeteer
support to browsers such as Safari. This effort includes exploration of a
standard for executing cross-browser commands (instead of relying on the
non-standard DevTools Protocol used by Chrome).</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="q-what-are-puppeteers-goals-and-principles">Q: What are Puppeteers goals and principles?<a href="#q-what-are-puppeteers-goals-and-principles" class="hash-link" aria-label="Direct link to Q: What are Puppeteers goals and principles?" title="Direct link to Q: What are Puppeteers goals and principles?"></a></h2><p>The goals of the project are:</p><ul><li>Provide a slim, canonical library that highlights the capabilities of the
<a href="https://chromedevtools.github.io/devtools-protocol/" target="_blank" rel="noopener noreferrer">DevTools Protocol</a>.</li><li>Provide a reference implementation for similar testing libraries. Eventually,
these other frameworks could adopt Puppeteer as their foundational layer.</li><li>Grow the adoption of headless/automated browser testing.</li><li>Help dogfood new DevTools Protocol features...and catch bugs!</li><li>Learn more about the pain points of automated browser testing and help fill
those gaps.</li></ul><p>We adapt
<a href="https://www.chromium.org/developers/core-principles" target="_blank" rel="noopener noreferrer">Chromium principles</a> to
help us drive product decisions:</p><ul><li><strong>Speed</strong>: Puppeteer has almost zero performance overhead over an automated
page.</li><li><strong>Security</strong>: Puppeteer operates off-process with respect to Chromium, making
it safe to automate potentially malicious pages.</li><li><strong>Stability</strong>: Puppeteer should not be flaky and should not leak memory.</li><li><strong>Simplicity</strong>: Puppeteer provides a high-level API thats easy to use,
understand, and debug.</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="q-is-puppeteer-replacing-seleniumwebdriver">Q: Is Puppeteer replacing Selenium/WebDriver?<a href="#q-is-puppeteer-replacing-seleniumwebdriver" class="hash-link" aria-label="Direct link to Q: Is Puppeteer replacing Selenium/WebDriver?" title="Direct link to Q: Is Puppeteer replacing Selenium/WebDriver?"></a></h2><p><strong>No</strong>. Both projects are valuable for very different reasons:</p><ul><li>Selenium/WebDriver focuses on cross-browser automation; its value proposition
is a single standard API that works across all major browsers.</li><li>Puppeteer focuses on Chromium; its value proposition is richer functionality
and higher reliability.</li></ul><p>That said, you <strong>can</strong> use Puppeteer to run tests against Chromium, e.g. using
the community-driven
<a href="https://github.com/smooth-code/jest-puppeteer" target="_blank" rel="noopener noreferrer">jest-puppeteer</a>. While this
probably shouldnt be your only testing solution, it does have a few good points
compared to WebDriver:</p><ul><li>Puppeteer requires zero setup and comes bundled with the Chromium version it
works best with, making it
<a href="https://github.com/puppeteer/puppeteer/#getting-started" target="_blank" rel="noopener noreferrer">very easy to start with</a>.
At the end of the day, its better to have a few tests running chromium-only,
than no tests at all.</li><li>Puppeteer has event-driven architecture, which removes a lot of potential
flakiness. Theres no need for evil “sleep(1000)” calls in puppeteer scripts.</li><li>Puppeteer runs headless by default, which makes it fast to run. Puppeteer
v1.5.0 also exposes browser contexts, making it possible to efficiently
parallelize test execution.</li><li>Puppeteer shines when it comes to debugging: flip the “headless” bit to false,
add “slowMo”, and youll see what the browser is doing. You can even open
Chrome DevTools to inspect the test environment.</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy">Q: Why doesnt Puppeteer v.XXX work with Chromium v.YYY?<a href="#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy" class="hash-link" aria-label="Direct link to Q: Why doesnt Puppeteer v.XXX work with Chromium v.YYY?" title="Direct link to Q: Why doesnt Puppeteer v.XXX work with Chromium v.YYY?"></a></h2><p>We see Puppeteer as an <strong>indivisible entity</strong> with Chromium. Each version of
Puppeteer bundles a specific version of Chromium <strong>the only</strong> version it is
guaranteed to work with.</p><p>This is not an artificial constraint: A lot of work on Puppeteer is actually
taking place in the Chromium repository. Heres a typical story:</p><ul><li>A Puppeteer bug is reported:
<a href="https://github.com/puppeteer/puppeteer/issues/2709" target="_blank" rel="noopener noreferrer">https://github.com/puppeteer/puppeteer/issues/2709</a></li><li>It turned out this is an issue with the DevTools protocol, so were fixing it
in Chromium: <a href="https://chromium-review.googlesource.com/c/chromium/src/+/1102154" target="_blank" rel="noopener noreferrer">https://chromium-review.googlesource.com/c/chromium/src/+/1102154</a></li><li>Once the upstream fix is landed, we roll updated Chromium into Puppeteer:
<a href="https://github.com/puppeteer/puppeteer/pull/2769" target="_blank" rel="noopener noreferrer">https://github.com/puppeteer/puppeteer/pull/2769</a></li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="q-which-chromium-version-does-puppeteer-use">Q: Which Chromium version does Puppeteer use?<a href="#q-which-chromium-version-does-puppeteer-use" class="hash-link" aria-label="Direct link to Q: Which Chromium version does Puppeteer use?" title="Direct link to Q: Which Chromium version does Puppeteer use?"></a></h2><p>Find the version using one of the following ways:</p><ul><li>Look for the <code>chromium</code> entry in
<a href="https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/revisions.ts" target="_blank" rel="noopener noreferrer">revisions.ts</a>.
To find the corresponding Chromium commit and version number, search for the
revision prefixed by an <code>r</code> in <a href="https://omahaproxy.appspot.com/" target="_blank" rel="noopener noreferrer">OmahaProxy</a>&#x27;s
&quot;Find Releases&quot; section.</li><li>Look for the <code>versionsPerRelease</code> map in
<a href="https://github.com/puppeteer/puppeteer/blob/main/versions.js" target="_blank" rel="noopener noreferrer">versions.js</a>
which contains mapping between Chromium and the smallest Puppeteer version
that supports it.</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="q-which-firefox-version-does-puppeteer-use">Q: Which Firefox version does Puppeteer use?<a href="#q-which-firefox-version-does-puppeteer-use" class="hash-link" aria-label="Direct link to Q: Which Firefox version does Puppeteer use?" title="Direct link to Q: Which Firefox version does Puppeteer use?"></a></h2><p>Since Firefox support is experimental, Puppeteer downloads the latest
<a href="https://wiki.mozilla.org/Nightly" target="_blank" rel="noopener noreferrer">Firefox Nightly</a> when the <code>PUPPETEER_PRODUCT</code>
environment variable is set to <code>firefox</code>. That&#x27;s also why the value of <code>firefox</code>
in
<a href="https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/revisions.ts" target="_blank" rel="noopener noreferrer">revisions.ts</a>
is <code>latest</code> -- Puppeteer isn&#x27;t tied to a particular Firefox version.</p><p>To fetch Firefox Nightly as part of Puppeteer installation:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token assign-left variable" style="color:#36acaa">PUPPETEER_PRODUCT</span><span class="token operator" style="color:#393A34">=</span><span class="token plain">firefox </span><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> i puppeteer</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="q-whats-considered-a-navigation">Q: Whats considered a “Navigation”?<a href="#q-whats-considered-a-navigation" class="hash-link" aria-label="Direct link to Q: Whats considered a “Navigation”?" title="Direct link to Q: Whats considered a “Navigation”?"></a></h4><p>From Puppeteers standpoint, <strong>“navigation” is anything that changes a pages
URL</strong>. Aside from regular navigation where the browser hits the network to fetch
a new document from the web server, this includes
<a href="https://www.w3.org/TR/html5/single-page.html#scroll-to-fragid" target="_blank" rel="noopener noreferrer">anchor navigations</a>
and <a href="https://developer.mozilla.org/en-US/docs/Web/API/History_API" target="_blank" rel="noopener noreferrer">History API</a>
usage.</p><p>With this definition of “navigation,” <strong>Puppeteer works seamlessly with
single-page applications.</strong></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="q-whats-the-difference-between-a-trusted-and-untrusted-input-event">Q: Whats the difference between a “trusted&quot; and &quot;untrusted&quot; input event?<a href="#q-whats-the-difference-between-a-trusted-and-untrusted-input-event" class="hash-link" aria-label="Direct link to Q: Whats the difference between a “trusted&quot; and &quot;untrusted&quot; input event?" title="Direct link to Q: Whats the difference between a “trusted&quot; and &quot;untrusted&quot; input event?"></a></h4><p>In browsers, input events could be divided into two big groups: trusted vs.
untrusted.</p><ul><li><strong>Trusted events</strong>: events generated by users interacting with the page, e.g.
using a mouse or keyboard.</li><li><strong>Untrusted event</strong>: events generated by Web APIs, e.g. <code>document.createEvent</code>
or <code>element.click()</code> methods.</li></ul><p>Websites can distinguish between these two groups:</p><ul><li>using an
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Event/isTrusted" target="_blank" rel="noopener noreferrer"><code>Event.isTrusted</code></a>
event flag</li><li>sniffing for accompanying events. For example, every trusted <code>&#x27;click&#x27;</code> event
is preceded by <code>&#x27;mousedown&#x27;</code> and <code>&#x27;mouseup&#x27;</code> events.</li></ul><p>For automation purposes its important to generate trusted events. <strong>All input
events generated with Puppeteer are trusted and fire proper accompanying
events.</strong> If, for some reason, one needs an untrusted event, its always
possible to hop into a page context with <code>page.evaluate</code> and generate a fake
event:</p><div class="language-ts codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-ts codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> page</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">evaluate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> document</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">querySelector</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&#x27;button[type=submit]&#x27;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">click</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="q-what-features-does-puppeteer-not-support">Q: What features does Puppeteer not support?<a href="#q-what-features-does-puppeteer-not-support" class="hash-link" aria-label="Direct link to Q: What features does Puppeteer not support?" title="Direct link to Q: What features does Puppeteer not support?"></a></h4><p>You may find that Puppeteer does not behave as expected when controlling pages
that incorporate audio and video. (For example,
<a href="https://github.com/puppeteer/puppeteer/issues/291" target="_blank" rel="noopener noreferrer">video playback/screenshots is likely to fail</a>.)
There are two reasons for this:</p><ul><li>Puppeteer is bundled with Chromium — not Chrome — and so by default, it
inherits all of
<a href="https://www.chromium.org/audio-video" target="_blank" rel="noopener noreferrer">Chromium&#x27;s media-related limitations</a>.
This means that Puppeteer does not support licensed formats such as AAC or
H.264. (However, it is possible to force Puppeteer to use a
separately-installed version Chrome instead of Chromium via the
<a href="/api/puppeteer.launchoptions"><code>executablePath</code> option to <code>puppeteer.launch</code></a>.
You should only use this configuration if you need an official release of
Chrome that supports these media formats.)</li><li>Since Puppeteer (in all configurations) controls a desktop version of
Chromium/Chrome, features that are only supported by the mobile version of
Chrome are not supported. This means that Puppeteer
<a href="https://caniuse.com/#feat=http-live-streaming" target="_blank" rel="noopener noreferrer">does not support HTTP Live Streaming (HLS)</a>.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="q-i-am-having-trouble-installing--running-puppeteer-in-my-test-environment-where-should-i-look-for-help">Q: I am having trouble installing / running Puppeteer in my test environment. Where should I look for help?<a href="#q-i-am-having-trouble-installing--running-puppeteer-in-my-test-environment-where-should-i-look-for-help" class="hash-link" aria-label="Direct link to Q: I am having trouble installing / running Puppeteer in my test environment. Where should I look for help?" title="Direct link to Q: I am having trouble installing / running Puppeteer in my test environment. Where should I look for help?"></a></h4><p>We have a
<a href="https://pptr.dev/troubleshooting" target="_blank" rel="noopener noreferrer">troubleshooting</a>
guide for various operating systems that lists the required dependencies.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="q-chromium-gets-downloaded-on-every-npm-ci-run-how-can-i-cache-the-download">Q: Chromium gets downloaded on every <code>npm ci</code> run. How can I cache the download?<a href="#q-chromium-gets-downloaded-on-every-npm-ci-run-how-can-i-cache-the-download" class="hash-link" aria-label="Direct link to q-chromium-gets-downloaded-on-every-npm-ci-run-how-can-i-cache-the-download" title="Direct link to q-chromium-gets-downloaded-on-every-npm-ci-run-how-can-i-cache-the-download"></a></h4><p>The default download path is <code>node_modules/puppeteer/.local-chromium</code>. However,
you can change that path with the <code>PUPPETEER_DOWNLOAD_PATH</code> environment
variable.</p><p>Puppeteer uses that variable to resolve the Chromium executable location during
launch, so you dont need to specify <code>PUPPETEER_EXECUTABLE_PATH</code> as well.</p><p>For example, if you wish to keep the Chromium download in <code>~/.npm/chromium</code>:</p><div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">export PUPPETEER_DOWNLOAD_PATH=~/.npm/chromium</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npm ci</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># by default the Chromium executable path is inferred</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># from the download path</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npm test</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># a new run of npm ci will check for the existence of</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Chromium in ~/.npm/chromium</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npm ci</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="q-i-have-more-questions-where-do-i-ask">Q: I have more questions! Where do I ask?<a href="#q-i-have-more-questions-where-do-i-ask" class="hash-link" aria-label="Direct link to Q: I have more questions! Where do I ask?" title="Direct link to Q: I have more questions! Where do I ask?"></a></h4><p>There are many ways to get help on Puppeteer:</p><ul><li><a href="https://github.com/puppeteer/puppeteer/issues" target="_blank" rel="noopener noreferrer">bugtracker</a></li><li><a href="https://stackoverflow.com/questions/tagged/puppeteer" target="_blank" rel="noopener noreferrer">Stack Overflow</a></li></ul><p>Make sure to search these channels before posting your question.</p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/contributing"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Contributing</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#q-who-maintains-puppeteer" class="table-of-contents__link toc-highlight">Q: Who maintains Puppeteer?</a></li><li><a href="#q-what-is-the-status-of-cross-browser-support" class="table-of-contents__link toc-highlight">Q: What is the status of cross-browser support?</a></li><li><a href="#q-what-are-puppeteers-goals-and-principles" class="table-of-contents__link toc-highlight">Q: What are Puppeteers goals and principles?</a></li><li><a href="#q-is-puppeteer-replacing-seleniumwebdriver" class="table-of-contents__link toc-highlight">Q: Is Puppeteer replacing Selenium/WebDriver?</a></li><li><a href="#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy" class="table-of-conte
<script src="/assets/js/runtime~main.95133fac.js"></script>
<script src="/assets/js/main.db5a1e29.js"></script>
</body>
</html>