build: migrate puppeteer@22 (#567)

* build: migrate puppeteer@22 * test: skip headless shell * fix: waitForTimeout * test: downgrade ava * test: update snapshot
microlinkhq · Mar 2, 2024 · 554fe53 · 554fe53
1 parent bcdc61c
commit 554fe53
Show file tree

Hide file tree

Showing 19 changed files with 30 additions and 21 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -5,6 +5,9 @@ on:
     branches:
       - master
 
+env:
+  PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD: true
+
 jobs:
   contributors:
     if: "${{ github.event.head_commit.message != 'build: contributors' }}"

diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -8,6 +8,9 @@ on:
     branches:
       - master
 
+env:
+  PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD: true
+
 jobs:
   matrix:
     runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -182,7 +182,7 @@ Every browser context is isolated. They won't share cookies/cache with other bro
 
 #### options
 
-Any [browser.createIncognitoBrowserContext#options](https://pptr.dev/next/api/puppeteer.browsercontextoptions) can be passed.
+Any [browser.createBrowserContext#options](https://pptr.dev/next/api/puppeteer.browsercontextoptions) can be passed.
 
 Additionally, you can setup:
 
@@ -437,7 +437,7 @@ browserless.getDevice({ device: 'Macbook Pro 15' })
 // }
 ```
 
-It extends from [puppeteer.devices](https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#puppeteerdevices), adding some missing devices there.
+It extends from [puppeteer.KnownDevices](https://pptr.dev/api/puppeteer.knowndevices/), adding some missing devices there.
 
 #### options
 
@@ -716,7 +716,7 @@ Wait a quantity of time, selector or function using [page.waitForSelector](https
 
 type:`number`
 
-Wait a quantity of time, selector or function using [page.waitForTimeout](/~https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagewaitfortimeoutmilliseconds).
+Wait a quantity time in milliseconds.
 
 ##### waitUntil
 

diff --git a/package.json b/package.json
@@ -113,6 +113,7 @@
     "dev": "concurrently \"gulp\" \"npm run dev:server\"",
     "dev:server": "browser-sync start --server --files \"index.html, README.md, static/**/*.(css|js)\"",
     "lint": "standard",
+    "postinstall": "node node_modules/puppeteer/install.mjs",
     "prerelease": "pnpm run update:check",
     "pretest": "pnpm run lint",
     "release": "lerna publish --yes --sort --conventional-commits -m \"chore(release): %s\" --create-release github",

diff --git a/packages/browserless/example.png b/packages/browserless/example.png
diff --git a/packages/browserless/package.json b/packages/browserless/package.json
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@browserless/test": "^10.2.4",
-    "ava": "latest",
+    "ava": "5",
     "ps-list": "7",
     "tinyspawn": "latest"
   },

diff --git a/packages/browserless/src/driver.js b/packages/browserless/src/driver.js
@@ -32,7 +32,7 @@ const spawn = ({
   puppeteer = requireOneOf(['puppeteer', 'puppeteer-core', 'puppeteer-firefox']),
   mode = 'launch',
   args = defaultArgs,
-  headless = 'new',
+  headless = true,
   ...launchOpts
 } = {}) => puppeteer[mode]({ ignoreHTTPSErrors: true, args, headless, ...launchOpts })
 

diff --git a/packages/browserless/src/index.js b/packages/browserless/src/index.js
@@ -59,7 +59,7 @@ module.exports = ({ timeout: globalTimeout = 30000, ...launchOpts } = {}) => {
   let browserProcessPromise = spawn()
 
   const createBrowserContext = contextOpts =>
-    getBrowser().then(browser => browser.createIncognitoBrowserContext(contextOpts))
+    getBrowser().then(browser => browser.createBrowserContext(contextOpts))
 
   const getBrowser = async () => {
     if (isClosed) return browserProcessPromise

diff --git a/packages/devices/package.json b/packages/devices/package.json
@@ -33,7 +33,7 @@
     "require-one-of": "~1.0.19"
   },
   "devDependencies": {
-    "ava": "latest",
+    "ava": "5",
     "lodash": "latest"
   },
   "engines": {

diff --git a/packages/devices/src/index.js b/packages/devices/src/index.js
@@ -10,7 +10,7 @@ module.exports = ({
   puppeteer = requireOneOf(['puppeteer', 'puppeteer-core', 'puppeteer-firefox']),
   lossyDeviceName = true
 } = {}) => {
-  const { devices: puppeteerDevices } = puppeteer
+  const { KnownDevices: puppeteerDevices } = puppeteer
   const devices = { ...puppeteerDevices, ...customDevices }
   const deviceDescriptors = Object.keys(devices)
 

diff --git a/packages/errors/package.json b/packages/errors/package.json
@@ -34,7 +34,7 @@
     "whoops": "~4.1.7"
   },
   "devDependencies": {
-    "ava": "latest"
+    "ava": "5"
   },
   "engines": {
     "node": ">= 12"

diff --git a/packages/function/package.json b/packages/function/package.json
@@ -41,7 +41,7 @@
   },
   "devDependencies": {
     "@browserless/test": "^10.2.4",
-    "ava": "latest",
+    "ava": "5",
     "browserless": "^10.2.6",
     "lodash": "latest"
   },

diff --git a/packages/goto/package.json b/packages/goto/package.json
@@ -43,7 +43,7 @@
   },
   "devDependencies": {
     "@browserless/test": "^10.2.4",
-    "ava": "latest",
+    "ava": "5",
     "p-wait-for": "3"
   },
   "engines": {

diff --git a/packages/goto/src/index.js b/packages/goto/src/index.js
@@ -2,6 +2,7 @@
 
 const { PuppeteerBlocker } = require('@cliqz/adblocker-puppeteer')
 const { shallowEqualObjects } = require('shallow-equal')
+const { setTimeout } = require('node:timers/promises')
 const createDevices = require('@browserless/devices')
 const toughCookie = require('tough-cookie')
 const pReflect = require('p-reflect')
@@ -203,7 +204,6 @@ module.exports = ({ defaultDevice = 'Macbook Pro 13', timeout: globalTimeout, ..
       waitForFunction,
       waitForSelector,
       waitForTimeout,
-      waitForXPath,
       waitUntil = 'auto',
       waitUntilAuto = _waitUntilAuto,
       onPageRequest,
@@ -370,15 +370,17 @@ module.exports = ({ defaultDevice = 'Macbook Pro 13', timeout: globalTimeout, ..
 
     for (const [key, value] of Object.entries({
       waitForSelector,
-      waitForXPath,
-      waitForFunction,
-      waitForTimeout
+      waitForFunction
     })) {
       if (value) {
         await run({ fn: page[key](value), timeout: gotoTimeout, debug: { [key]: value } })
       }
     }
 
+    if (waitForTimeout) {
+      await setTimeout(waitForTimeout)
+    }
+
     await inject(page, {
       timeout: actionTimeout,
       mediaType,

diff --git a/packages/lighthouse/package.json b/packages/lighthouse/package.json
@@ -28,7 +28,7 @@
   },
   "devDependencies": {
     "@browserless/test": "^10.2.4",
-    "ava": "latest"
+    "ava": "5"
   },
   "engines": {
     "node": ">= 12"

diff --git a/packages/screencast/package.json b/packages/screencast/package.json
@@ -37,7 +37,7 @@
   },
   "devDependencies": {
     "@browserless/test": "^10.2.4",
-    "ava": "latest",
+    "ava": "5",
     "file-type": "16"
   },
   "engines": {

diff --git a/packages/screenshot/package.json b/packages/screenshot/package.json
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@browserless/test": "^10.2.4",
-    "ava": "latest",
+    "ava": "5",
     "cheerio": "latest"
   },
   "engines": {

diff --git a/packages/screenshot/test/index.js b/packages/screenshot/test/index.js
@@ -36,7 +36,7 @@ test('graphics features', async t => {
           'Canvas out-of-process rasterization': 'Disabled',
           'Direct Rendering Display Compositor': 'Disabled',
           Compositing: 'Software only. Hardware acceleration disabled',
-          'Multiple Raster Threads': 'Disabled',
+          'Multiple Raster Threads': 'Enabled',
           OpenGL: 'Disabled',
           Rasterization: 'Software only. Hardware acceleration disabled',
           'Raw Draw': 'Disabled',

diff --git a/packages/test/package.json b/packages/test/package.json
@@ -29,12 +29,12 @@
     "test"
   ],
   "devDependencies": {
-    "ava": "latest",
+    "ava": "5",
     "browserless": "latest",
     "fs-extra": "latest",
     "img-diff-js": "latest",
     "pdf-parse": "latest",
-    "puppeteer": "~21.10.0",
+    "puppeteer": "~22.0.0",
     "signal-exit": "latest",
     "temperment": "latest"
   },
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,9 @@ on: @@
         branches:
           - master
+    env:
+      PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD: true
     jobs:
       matrix:
         runs-on: ubuntu-latest
@@ Expand Down @@