Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: log useful error for Node v14 breakage #5732

Merged
merged 3 commits into from Apr 27, 2020
Merged

chore: log useful error for Node v14 breakage #5732

merged 3 commits into from Apr 27, 2020

Commits on Apr 24, 2020

  1. chore: Useful error for Node v14 breakage

    There is currently a bug with extract-zip and Node v14.0.0 that
    causes extractZip to silently fail:
    #5719
    
    Rather than silenty fail if the user is on Node 14 we instead
    detect that and throw an error directing the user to that bug. The
    rejection message below is surfaced to the user in the command line.
    
    The issue seems to be in streams never resolving so we wrap the call in
    a timeout and give it 100ms to resolve before deciding on an error. If
    the user is on Node < 14 we maintain the behaviour we had before this
    patch.
    
    Here's how this change impacts the output on Node 14 and Node 10:
    
    Node 10:
    
    ```
    npm run tsc && rm -r .local-* && node install
    
    > puppeteer@3.0.1-post tsc /Users/jacktfranklin/src/puppeteer
    > tsc --version && tsc -p . && cp src/protocol.d.ts lib/ && cp src/externs.d.ts lib/
    
    Version 3.8.3
    Downloading Chromium r737027 - 118.4 Mb [====================] 100% 0.0s
    Chromium (737027) downloaded to /Users/jacktfranklin/src/puppeteer/.local-chromium/mac-737027
    ```
    
    ---
    
    Node 14 without this patch:
    
    ```
    npm run tsc && rm -r .local-* && node install
    
    > puppeteer@3.0.1-post tsc /Users/jacktfranklin/src/puppeteer
    > tsc --version && tsc -p . && cp src/protocol.d.ts lib/ && cp src/externs.d.ts lib/
    
    Version 3.8.3
    Downloading Chromium r737027 - 118.4 Mb [====================] 100% 0.0s
    ```
    
    Note that whilst it doesn't error, it doesn't complete the install. We
    don't get the success message that we saw above in the Node 10 install.
    
    ---
    
    Node 14 with this patch:
    
    ```npm run tsc && rm -r .local-* && node install
    
    > puppeteer@3.0.1-post tsc /Users/jacktfranklin/src/puppeteer
    > tsc --version && tsc -p . && cp src/protocol.d.ts lib/ && cp src/externs.d.ts lib/
    
    Version 3.8.3
    Downloading Chromium r737027 - 118.4 Mb [====================] 100% 0.0s
    ERROR: Failed to set up Chromium r737027! Set "PUPPETEER_SKIP_DOWNLOAD" env variable to skip download.
    Puppeteer currently does not work on Node v14 due to an upstream bug. Please see #5719 for details.
    ```
    
    The explicit message should save users a good amount of debugging time.
    jackfranklin committed Apr 24, 2020
    Copy the full SHA
    449da6c View commit details
    Browse the repository at this point in the history
  2. Run on all Node versions

    jackfranklin committed Apr 24, 2020
    Copy the full SHA
    af5a622 View commit details
    Browse the repository at this point in the history

Commits on Apr 27, 2020

  1. 10 seconds

    jackfranklin committed Apr 27, 2020
    Copy the full SHA
    d52c856 View commit details
    Browse the repository at this point in the history