Scripts: Upgrade Puppeteer to v11 (#36040)

WordPress · Nov 24, 2021 · 9529992 · 9529992
1 parent bc80a6e
commit 9529992
Show file tree

Hide file tree

Showing 18 changed files with 103 additions and 53 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/e2e-test-utils/CHANGELOG.md b/packages/e2e-test-utils/CHANGELOG.md
@@ -2,8 +2,14 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+-   The peer `puppeteer` dependency has been replaced with `puppeteer-core` requiring version `>=11` (see [Breaking Changes](https://github.com/puppeteer/puppeteer/releases/tag/v11.0.0), [#36040](https://github.com/WordPress/gutenberg/pull/36040)).
+
 ## 5.4.6 (2021-11-07)
 
+### New Features
+
 -   Added `disablePageDialogAccept` - Disable auto-accepting dialogs enabled by `enablePageDialogAccept` [#35828](https://github.com/WordPress/gutenberg/pull/35828).
 
 ## 5.4.0 (2021-07-21)

diff --git a/packages/e2e-test-utils/package.json b/packages/e2e-test-utils/package.json
@@ -39,7 +39,7 @@
 	},
 	"peerDependencies": {
 		"jest": ">=26",
-		"puppeteer": ">=1.19.0"
+		"puppeteer-core": ">=11"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/e2e-test-utils/src/auto-accept-page-dialogs.js b/packages/e2e-test-utils/src/auto-accept-page-dialogs.js
@@ -1,4 +1,4 @@
-/** @typedef {import('puppeteer').Dialog} Dialog */
+/** @typedef {import('puppeteer-core').Dialog} Dialog */
 
 /**
  * Callback which automatically accepts dialog.

diff --git a/packages/e2e-test-utils/src/find-sidebar-panel-toggle-button-with-title.js b/packages/e2e-test-utils/src/find-sidebar-panel-toggle-button-with-title.js
@@ -3,7 +3,7 @@
  */
 import { first } from 'lodash';
 
-/** @typedef {import('puppeteer').ElementHandle} ElementHandle */
+/** @typedef {import('puppeteer-core').ElementHandle} ElementHandle */
 
 /**
  * Finds a sidebar panel with the provided title.

diff --git a/packages/e2e-test-utils/src/find-sidebar-panel-with-title.js b/packages/e2e-test-utils/src/find-sidebar-panel-with-title.js
@@ -1,4 +1,4 @@
-/** @typedef {import('puppeteer').ElementHandle} ElementHandle */
+/** @typedef {import('puppeteer-core').ElementHandle} ElementHandle */
 
 /**
  * Finds the button responsible for toggling the sidebar panel with the provided title.

diff --git a/packages/e2e-test-utils/src/preview.js b/packages/e2e-test-utils/src/preview.js
@@ -3,7 +3,7 @@
  */
 import { last } from 'lodash';
 
-/** @typedef {import('puppeteer').Page} Page */
+/** @typedef {import('puppeteer-core').Page} Page */
 
 /**
  * Opens the preview page of an edited post.

diff --git a/packages/e2e-tests/CHANGELOG.md b/packages/e2e-tests/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+-   The peer `puppeteer` dependency has been replaced with `puppeteer-core` requiring version `>=11` (see [Breaking Changes](https://github.com/puppeteer/puppeteer/releases/tag/v11.0.0), [#36040](https://github.com/WordPress/gutenberg/pull/36040)).
+
 ## 2.5.0 (2021-09-09)
 
 ### New Features

diff --git a/packages/e2e-tests/package.json b/packages/e2e-tests/package.json
@@ -38,7 +38,7 @@
 	"peerDependencies": {
 		"jest": ">=26",
 		"jest-snapshot": ">=26",
-		"puppeteer": ">=1.19.0"
+		"puppeteer-core": ">=11"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/e2e-tests/specs/editor/various/adding-patterns.test.js b/packages/e2e-tests/specs/editor/various/adding-patterns.test.js
@@ -7,7 +7,7 @@ import {
 	getEditedPostContent,
 } from '@wordpress/e2e-test-utils';
 
-/** @typedef {import('puppeteer').ElementHandle} ElementHandle */
+/** @typedef {import('puppeteer-core').ElementHandle} ElementHandle */
 
 describe( 'adding patterns', () => {
 	beforeEach( async () => {

diff --git a/packages/e2e-tests/specs/editor/various/inserting-blocks.test.js b/packages/e2e-tests/specs/editor/various/inserting-blocks.test.js
@@ -14,7 +14,7 @@ import {
 	pressKeyWithModifier,
 } from '@wordpress/e2e-test-utils';
 
-/** @typedef {import('puppeteer').ElementHandle} ElementHandle */
+/** @typedef {import('puppeteer-core').ElementHandle} ElementHandle */
 
 /**
  * Waits for all patterns in the inserter to have a height, which should

diff --git a/packages/e2e-tests/specs/editor/various/preview.test.js b/packages/e2e-tests/specs/editor/various/preview.test.js
@@ -14,7 +14,7 @@ import {
 	pressKeyWithModifier,
 } from '@wordpress/e2e-test-utils';
 
-/** @typedef {import('puppeteer').Page} Page */
+/** @typedef {import('puppeteer-core').Page} Page */
 
 /**
  * Given the Page instance for the editor, opens preview drodpdown, and

diff --git a/packages/jest-puppeteer-axe/CHANGELOG.md b/packages/jest-puppeteer-axe/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+-   The peer `puppeteer` dependency has been updated from requiring `>=1.19` to requiring `>=11` (see [Breaking Changes](https://github.com/puppeteer/puppeteer/releases/tag/v11.0.0), [#36040](https://github.com/WordPress/gutenberg/pull/36040)).
+
 ## 3.0.0 (2021-01-21)
 
 ### Breaking Changes

diff --git a/packages/jest-puppeteer-axe/package.json b/packages/jest-puppeteer-axe/package.json
@@ -36,7 +36,12 @@
 	},
 	"peerDependencies": {
 		"jest": ">=26",
-		"puppeteer": ">=1.19.0"
+		"puppeteer": ">=11"
+	},
+	"peerDependenciesMeta": {
+		"puppeteer": {
+			"optional": true
+		}
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/jest-puppeteer-axe/src/index.js b/packages/jest-puppeteer-axe/src/index.js
@@ -3,7 +3,7 @@
  */
 import AxePuppeteer from '@axe-core/puppeteer';
 
-/** @typedef {import('puppeteer').Page} Page */
+/** @typedef {import('puppeteer-core').Page} Page */
 
 /** @typedef {import('axe-core').RunOptions} RunOptions */
 

diff --git a/packages/scripts/CHANGELOG.md b/packages/scripts/CHANGELOG.md
@@ -2,9 +2,13 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+-   The `puppeteer-core` dependency has been updated from requiring `^10.1.0` to requiring `^11.0.0` (see [Breaking Changes](https://github.com/puppeteer/puppeteer/releases/tag/v11.0.0), [#36040](https://github.com/WordPress/gutenberg/pull/36040)).
+
 ### Bug Fixes
 
-- Prevent the `CleanWebpackPlugin` plugin from deleting webpack assets during multi-configuration builds [#35980](https://github.com/WordPress/gutenberg/issues/35980).
+-   Prevent the `CleanWebpackPlugin` plugin from deleting webpack assets during multi-configuration builds [#35980](https://github.com/WordPress/gutenberg/issues/35980).
 
 ## 19.2.0 (2021-11-15)
 

diff --git a/packages/scripts/config/jest-environment-puppeteer/config.js b/packages/scripts/config/jest-environment-puppeteer/config.js
@@ -69,11 +69,7 @@ async function readConfig() {
 function getPuppeteer( { browser } ) {
 	switch ( browser.toLowerCase() ) {
 		case 'chromium':
-			try {
-				return require( 'puppeteer' );
-			} catch ( e ) {
-				return require( 'puppeteer-core' );
-			}
+			return require( 'puppeteer-core' );
 		case 'firefox':
 			return require( 'puppeteer-firefox' );
 		default:

diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -71,7 +71,7 @@
 		"postcss": "^8.2.15",
 		"postcss-loader": "^6.1.1",
 		"prettier": "npm:wp-prettier@2.2.1-beta-1",
-		"puppeteer-core": "^10.1.0",
+		"puppeteer-core": "^11.0.0",
 		"read-pkg-up": "^1.0.1",
 		"resolve-bin": "^0.4.0",
 		"sass": "^1.35.2",