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

Scripts: Fork jest-environment-puppeteer to use puppeteer-core directly #29418

Merged
merged 2 commits into from
Mar 8, 2021

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Mar 1, 2021

Description

https://github.com/smooth-code/jest-puppeteer didn't get any updates in the last 15 months even though there were a few enhancements merged. The repository is still looking for maintainers. One of the merged changes would allow us to avoid using an npm alias puppeteer for puppeteer-core: argos-ci/jest-puppeteer#315. There are reports of issues with npm aliases used as dependencies in packages published to npm, see #21872.

I did some explorations and it looks like we mostly need the latest version jest-environment-puppeteer. I thought that since it's only 3 files, we could as well fork this package and inline it in the @wordpress/scripts package. This way we no longer need to use the npm alias for puppeteer and we should be able to have better control over the e2e configuration.

I included the copyright note in all ported files:

/**
 * Parts of this source were derived and modified from the package
 * jest-environment-puppeteer, released under the MIT license.
 *
 * https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-environment-puppeteer
 *
 * Copyright 2018 Smooth Code
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

How has this been tested?

npm run test-e2e still works.

Types of changes

Enhancement.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@gziolo gziolo added [Type] Enhancement A suggestion for improvement. [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Tool] WP Scripts /packages/scripts labels Mar 1, 2021
@gziolo gziolo requested review from ajitbohra, nerrad and ntwb as code owners March 1, 2021 06:47
@gziolo gziolo self-assigned this Mar 1, 2021
testMatch: [ '**/specs/**/*.[jt]s', '**/?(*.)spec.[jt]s' ],
testPathIgnorePatterns: [ '/node_modules/' ],
reporters:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We no longer use Travis so this code is not used. I also don't think that travis-fold-passes-reporter.js file is still present in the Jest preset.

return require( 'puppeteer-core' );
}
case 'firefox':
return require( 'puppeteer-firefox' );
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside:
I have just learned that https://www.npmjs.com/package/puppeteer-firefox is deprecated.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's now integrated into puppeteer proper, and can be run via the --puppeteer-product=firefox arg, see e.g. #28498.

We could drop this case branch (which amounts to re-organizing -- or even dropping -- the whole getPuppeteer function).

@github-actions
Copy link

github-actions bot commented Mar 1, 2021

Size Change: +9.8 kB (+1%)

Total Size: 1.4 MB

Filename Size Change
build/a11y/index.js 1.14 kB -1 B (0%)
build/annotations/index.js 3.78 kB -11 B (0%)
build/api-fetch/index.js 3.4 kB -8 B (0%)
build/autop/index.js 2.82 kB -17 B (-1%)
build/blob/index.js 664 B -1 B (0%)
build/block-directory/index.js 8.63 kB -471 B (-5%)
build/block-directory/style-rtl.css 1 kB -6 B (-1%)
build/block-directory/style.css 1.01 kB -5 B (0%)
build/block-editor/index.js 125 kB +44 B (0%)
build/block-library/blocks/navigation/editor-rtl.css 1.34 kB +2 B (0%)
build/block-library/blocks/navigation/editor.css 1.34 kB +3 B (0%)
build/block-library/blocks/page-list/editor-rtl.css 215 B +1 B (0%)
build/block-library/blocks/page-list/editor.css 215 B +1 B (0%)
build/block-library/blocks/spacer/editor-rtl.css 317 B +15 B (+5%) 🔍
build/block-library/blocks/spacer/editor.css 317 B +15 B (+5%) 🔍
build/block-library/common-rtl.css 1.1 kB +18 B (+2%)
build/block-library/common.css 1.1 kB +20 B (+2%)
build/block-library/editor-rtl.css 9.54 kB +17 B (0%)
build/block-library/editor.css 9.53 kB +17 B (0%)
build/block-library/index.js 148 kB -283 B (0%)
build/block-library/style-rtl.css 8.86 kB +10 B (0%)
build/block-library/style.css 8.86 kB +10 B (0%)
build/block-serialization-default-parser/index.js 1.87 kB -8 B (0%)
build/blocks/index.js 48.3 kB -71 B (0%)
build/components/index.js 283 kB +10.7 kB (+4%)
build/components/style-rtl.css 15.6 kB +8 B (0%)
build/components/style.css 15.5 kB +7 B (0%)
build/compose/index.js 11.1 kB -15 B (0%)
build/core-data/index.js 16.7 kB -54 B (0%)
build/customize-widgets/index.js 3.96 kB -130 B (-3%)
build/data-controls/index.js 828 B -3 B (0%)
build/data/index.js 8.88 kB +7 B (0%)
build/date/index.js 31.8 kB -1 B (0%)
build/dom-ready/index.js 577 B +1 B (0%)
build/dom/index.js 4.94 kB -16 B (0%)
build/edit-navigation/index.js 11 kB -27 B (0%)
build/edit-post/index.js 306 kB -610 B (0%)
build/edit-site/index.js 27 kB +581 B (+2%)
build/edit-site/style-rtl.css 4.47 kB +53 B (+1%)
build/edit-site/style.css 4.46 kB +53 B (+1%)
build/edit-widgets/index.js 20.1 kB -78 B (0%)
build/editor/index.js 42.1 kB -38 B (0%)
build/element/index.js 4.61 kB -10 B (0%)
build/format-library/index.js 6.75 kB -16 B (0%)
build/hooks/index.js 2.28 kB -2 B (0%)
build/html-entities/index.js 623 B +1 B (0%)
build/i18n/index.js 4.01 kB -3 B (0%)
build/is-shallow-equal/index.js 699 B +1 B (0%)
build/keyboard-shortcuts/index.js 2.53 kB -16 B (-1%)
build/keycodes/index.js 1.95 kB -8 B (0%)
build/list-reusable-blocks/index.js 3.15 kB +2 B (0%)
build/media-utils/index.js 5.34 kB -16 B (0%)
build/notices/index.js 1.85 kB -7 B (0%)
build/nux/index.js 3.4 kB -10 B (0%)
build/plugins/index.js 2.9 kB +287 B (+11%) ⚠️
build/primitives/index.js 1.42 kB -6 B (0%)
build/react-i18n/index.js 1.45 kB +1 B (0%)
build/redux-routine/index.js 2.83 kB -3 B (0%)
build/reusable-blocks/index.js 3.78 kB -24 B (-1%)
build/rich-text/index.js 13.4 kB -69 B (-1%)
build/server-side-render/index.js 2.82 kB -1 B (0%)
build/token-list/index.js 1.27 kB +1 B (0%)
build/url/index.js 3.02 kB -1 B (0%)
build/viewport/index.js 1.86 kB +1 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/block-editor/style-rtl.css 12.1 kB 0 B
build/block-editor/style.css 12.1 kB 0 B
build/block-library/blocks/archives/editor-rtl.css 61 B 0 B
build/block-library/blocks/archives/editor.css 60 B 0 B
build/block-library/blocks/audio/editor-rtl.css 58 B 0 B
build/block-library/blocks/audio/editor.css 58 B 0 B
build/block-library/blocks/audio/style-rtl.css 103 B 0 B
build/block-library/blocks/audio/style.css 103 B 0 B
build/block-library/blocks/block/editor-rtl.css 161 B 0 B
build/block-library/blocks/block/editor.css 161 B 0 B
build/block-library/blocks/button/editor-rtl.css 475 B 0 B
build/block-library/blocks/button/editor.css 474 B 0 B
build/block-library/blocks/button/style-rtl.css 479 B 0 B
build/block-library/blocks/button/style.css 479 B 0 B
build/block-library/blocks/buttons/editor-rtl.css 315 B 0 B
build/block-library/blocks/buttons/editor.css 315 B 0 B
build/block-library/blocks/buttons/style-rtl.css 364 B 0 B
build/block-library/blocks/buttons/style.css 363 B 0 B
build/block-library/blocks/calendar/style-rtl.css 208 B 0 B
build/block-library/blocks/calendar/style.css 208 B 0 B
build/block-library/blocks/categories/editor-rtl.css 84 B 0 B
build/block-library/blocks/categories/editor.css 83 B 0 B
build/block-library/blocks/categories/style-rtl.css 79 B 0 B
build/block-library/blocks/categories/style.css 79 B 0 B
build/block-library/blocks/code/style-rtl.css 90 B 0 B
build/block-library/blocks/code/style.css 90 B 0 B
build/block-library/blocks/columns/editor-rtl.css 190 B 0 B
build/block-library/blocks/columns/editor.css 190 B 0 B
build/block-library/blocks/columns/style-rtl.css 421 B 0 B
build/block-library/blocks/columns/style.css 421 B 0 B
build/block-library/blocks/cover/editor-rtl.css 390 B 0 B
build/block-library/blocks/cover/editor.css 389 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.25 kB 0 B
build/block-library/blocks/cover/style.css 1.25 kB 0 B
build/block-library/blocks/embed/editor-rtl.css 486 B 0 B
build/block-library/blocks/embed/editor.css 486 B 0 B
build/block-library/blocks/embed/style-rtl.css 396 B 0 B
build/block-library/blocks/embed/style.css 395 B 0 B
build/block-library/blocks/file/editor-rtl.css 199 B 0 B
build/block-library/blocks/file/editor.css 198 B 0 B
build/block-library/blocks/file/style-rtl.css 248 B 0 B
build/block-library/blocks/file/style.css 248 B 0 B
build/block-library/blocks/freeform/editor-rtl.css 2.45 kB 0 B
build/block-library/blocks/freeform/editor.css 2.45 kB 0 B
build/block-library/blocks/gallery/editor-rtl.css 689 B 0 B
build/block-library/blocks/gallery/editor.css 690 B 0 B
build/block-library/blocks/gallery/style-rtl.css 1.07 kB 0 B
build/block-library/blocks/gallery/style.css 1.06 kB 0 B
build/block-library/blocks/group/editor-rtl.css 318 B 0 B
build/block-library/blocks/group/editor.css 317 B 0 B
build/block-library/blocks/group/style-rtl.css 57 B 0 B
build/block-library/blocks/group/style.css 57 B 0 B
build/block-library/blocks/heading/editor-rtl.css 129 B 0 B
build/block-library/blocks/heading/editor.css 129 B 0 B
build/block-library/blocks/heading/style-rtl.css 76 B 0 B
build/block-library/blocks/heading/style.css 76 B 0 B
build/block-library/blocks/html/editor-rtl.css 281 B 0 B
build/block-library/blocks/html/editor.css 281 B 0 B
build/block-library/blocks/image/editor-rtl.css 717 B 0 B
build/block-library/blocks/image/editor.css 716 B 0 B
build/block-library/blocks/image/style-rtl.css 477 B 0 B
build/block-library/blocks/image/style.css 478 B 0 B
build/block-library/blocks/latest-comments/editor-rtl.css 159 B 0 B
build/block-library/blocks/latest-comments/editor.css 158 B 0 B
build/block-library/blocks/latest-comments/style-rtl.css 269 B 0 B
build/block-library/blocks/latest-comments/style.css 269 B 0 B
build/block-library/blocks/latest-posts/editor-rtl.css 137 B 0 B
build/block-library/blocks/latest-posts/editor.css 137 B 0 B
build/block-library/blocks/latest-posts/style-rtl.css 523 B 0 B
build/block-library/blocks/latest-posts/style.css 522 B 0 B
build/block-library/blocks/list/editor-rtl.css 65 B 0 B
build/block-library/blocks/list/editor.css 65 B 0 B
build/block-library/blocks/list/style-rtl.css 63 B 0 B
build/block-library/blocks/list/style.css 63 B 0 B
build/block-library/blocks/media-text/editor-rtl.css 191 B 0 B
build/block-library/blocks/media-text/editor.css 191 B 0 B
build/block-library/blocks/media-text/style-rtl.css 535 B 0 B
build/block-library/blocks/media-text/style.css 532 B 0 B
build/block-library/blocks/more/editor-rtl.css 434 B 0 B
build/block-library/blocks/more/editor.css 434 B 0 B
build/block-library/blocks/navigation-link/editor-rtl.css 681 B 0 B
build/block-library/blocks/navigation-link/editor.css 683 B 0 B
build/block-library/blocks/navigation-link/style-rtl.css 694 B 0 B
build/block-library/blocks/navigation-link/style.css 692 B 0 B
build/block-library/blocks/navigation/style-rtl.css 213 B 0 B
build/block-library/blocks/navigation/style.css 214 B 0 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B 0 B
build/block-library/blocks/nextpage/editor.css 395 B 0 B
build/block-library/blocks/page-list/style-rtl.css 527 B 0 B
build/block-library/blocks/page-list/style.css 526 B 0 B
build/block-library/blocks/paragraph/editor-rtl.css 109 B 0 B
build/block-library/blocks/paragraph/editor.css 109 B 0 B
build/block-library/blocks/paragraph/style-rtl.css 288 B 0 B
build/block-library/blocks/paragraph/style.css 289 B 0 B
build/block-library/blocks/post-author/editor-rtl.css 209 B 0 B
build/block-library/blocks/post-author/editor.css 209 B 0 B
build/block-library/blocks/post-author/style-rtl.css 183 B 0 B
build/block-library/blocks/post-author/style.css 184 B 0 B
build/block-library/blocks/post-comments-form/style-rtl.css 250 B 0 B
build/block-library/blocks/post-comments-form/style.css 250 B 0 B
build/block-library/blocks/post-content/editor-rtl.css 139 B 0 B
build/block-library/blocks/post-content/editor.css 139 B 0 B
build/block-library/blocks/post-excerpt/editor-rtl.css 73 B 0 B
build/block-library/blocks/post-excerpt/editor.css 73 B 0 B
build/block-library/blocks/post-featured-image/editor-rtl.css 338 B 0 B
build/block-library/blocks/post-featured-image/editor.css 338 B 0 B
build/block-library/blocks/post-featured-image/style-rtl.css 100 B 0 B
build/block-library/blocks/post-featured-image/style.css 100 B 0 B
build/block-library/blocks/preformatted/style-rtl.css 63 B 0 B
build/block-library/blocks/preformatted/style.css 63 B 0 B
build/block-library/blocks/pullquote/editor-rtl.css 183 B 0 B
build/block-library/blocks/pullquote/editor.css 183 B 0 B
build/block-library/blocks/pullquote/style-rtl.css 316 B 0 B
build/block-library/blocks/pullquote/style.css 316 B 0 B
build/block-library/blocks/query-loop/editor-rtl.css 90 B 0 B
build/block-library/blocks/query-loop/editor.css 89 B 0 B
build/block-library/blocks/query-loop/style-rtl.css 315 B 0 B
build/block-library/blocks/query-loop/style.css 317 B 0 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B 0 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B 0 B
build/block-library/blocks/query-pagination/editor-rtl.css 270 B 0 B
build/block-library/blocks/query-pagination/editor.css 262 B 0 B
build/block-library/blocks/query-pagination/style-rtl.css 168 B 0 B
build/block-library/blocks/query-pagination/style.css 168 B 0 B
build/block-library/blocks/query/editor-rtl.css 814 B 0 B
build/block-library/blocks/query/editor.css 812 B 0 B
build/block-library/blocks/quote/editor-rtl.css 61 B 0 B
build/block-library/blocks/quote/editor.css 61 B 0 B
build/block-library/blocks/quote/style-rtl.css 169 B 0 B
build/block-library/blocks/quote/style.css 169 B 0 B
build/block-library/blocks/rss/editor-rtl.css 201 B 0 B
build/block-library/blocks/rss/editor.css 202 B 0 B
build/block-library/blocks/rss/style-rtl.css 290 B 0 B
build/block-library/blocks/rss/style.css 290 B 0 B
build/block-library/blocks/search/editor-rtl.css 165 B 0 B
build/block-library/blocks/search/editor.css 165 B 0 B
build/block-library/blocks/search/style-rtl.css 342 B 0 B
build/block-library/blocks/search/style.css 344 B 0 B
build/block-library/blocks/separator/editor-rtl.css 99 B 0 B
build/block-library/blocks/separator/editor.css 99 B 0 B
build/block-library/blocks/separator/style-rtl.css 236 B 0 B
build/block-library/blocks/separator/style.css 236 B 0 B
build/block-library/blocks/shortcode/editor-rtl.css 504 B 0 B
build/block-library/blocks/shortcode/editor.css 504 B 0 B
build/block-library/blocks/site-logo/editor-rtl.css 201 B 0 B
build/block-library/blocks/site-logo/editor.css 201 B 0 B
build/block-library/blocks/site-logo/style-rtl.css 115 B 0 B
build/block-library/blocks/site-logo/style.css 115 B 0 B
build/block-library/blocks/social-link/editor-rtl.css 164 B 0 B
build/block-library/blocks/social-link/editor.css 165 B 0 B
build/block-library/blocks/social-links/editor-rtl.css 696 B 0 B
build/block-library/blocks/social-links/editor.css 696 B 0 B
build/block-library/blocks/social-links/style-rtl.css 1.32 kB 0 B
build/block-library/blocks/social-links/style.css 1.32 kB 0 B
build/block-library/blocks/spacer/style-rtl.css 48 B 0 B
build/block-library/blocks/spacer/style.css 48 B 0 B
build/block-library/blocks/subhead/editor-rtl.css 99 B 0 B
build/block-library/blocks/subhead/editor.css 99 B 0 B
build/block-library/blocks/subhead/style-rtl.css 80 B 0 B
build/block-library/blocks/subhead/style.css 80 B 0 B
build/block-library/blocks/table/editor-rtl.css 478 B 0 B
build/block-library/blocks/table/editor.css 478 B 0 B
build/block-library/blocks/table/style-rtl.css 390 B 0 B
build/block-library/blocks/table/style.css 390 B 0 B
build/block-library/blocks/tag-cloud/editor-rtl.css 118 B 0 B
build/block-library/blocks/tag-cloud/editor.css 118 B 0 B
build/block-library/blocks/tag-cloud/style-rtl.css 94 B 0 B
build/block-library/blocks/tag-cloud/style.css 94 B 0 B
build/block-library/blocks/template-part/editor-rtl.css 557 B 0 B
build/block-library/blocks/template-part/editor.css 556 B 0 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B 0 B
build/block-library/blocks/text-columns/editor.css 95 B 0 B
build/block-library/blocks/text-columns/style-rtl.css 166 B 0 B
build/block-library/blocks/text-columns/style.css 166 B 0 B
build/block-library/blocks/verse/editor-rtl.css 62 B 0 B
build/block-library/blocks/verse/editor.css 62 B 0 B
build/block-library/blocks/verse/style-rtl.css 87 B 0 B
build/block-library/blocks/verse/style.css 87 B 0 B
build/block-library/blocks/video/editor-rtl.css 504 B 0 B
build/block-library/blocks/video/editor.css 503 B 0 B
build/block-library/blocks/video/style-rtl.css 193 B 0 B
build/block-library/blocks/video/style.css 193 B 0 B
build/block-library/theme-rtl.css 736 B 0 B
build/block-library/theme.css 736 B 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/customize-widgets/style-rtl.css 168 B 0 B
build/customize-widgets/style.css 168 B 0 B
build/deprecated/index.js 769 B 0 B
build/edit-navigation/style-rtl.css 1.26 kB 0 B
build/edit-navigation/style.css 1.25 kB 0 B
build/edit-post/style-rtl.css 6.81 kB 0 B
build/edit-post/style.css 6.8 kB 0 B
build/edit-widgets/style-rtl.css 3.2 kB 0 B
build/edit-widgets/style.css 3.2 kB 0 B
build/editor/editor-styles-rtl.css 543 B 0 B
build/editor/editor-styles.css 545 B 0 B
build/editor/style-rtl.css 3.9 kB 0 B
build/editor/style.css 3.9 kB 0 B
build/escape-html/index.js 735 B 0 B
build/format-library/style-rtl.css 637 B 0 B
build/format-library/style.css 639 B 0 B
build/list-reusable-blocks/style-rtl.css 629 B 0 B
build/list-reusable-blocks/style.css 628 B 0 B
build/nux/style-rtl.css 731 B 0 B
build/nux/style.css 727 B 0 B
build/priority-queue/index.js 791 B 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/shortcode/index.js 1.7 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

@ockham
Copy link
Contributor

ockham commented Mar 1, 2021

I did some explorations and it looks like we mostly need the latest version jest-environment-puppeteer. I thought that since it's only 3 files, we could as well fork this package and inline it in the @wordpress/scripts package. This way we no longer need to use the npm alias for puppeteer and we should be able to have better control over the e2e configuration.

Can you explain why we needed the npm alias in the first place? Is it not possible to have it as `"puppeteer-core": "5.5.0" there, and require it as such?

Alternatively: AFAIU, the main reason for using puppeteer-core over puppeteer is that it doesn't download the Chromium binary at npm install time. It seems possible to avoid that via the PUPPETEER_SKIP_CHROMIUM_DOWNLOAD env var; would that be an alternative?

@gziolo
Copy link
Member Author

gziolo commented Mar 1, 2021

Can you explain why we needed the npm alias in the first place? Is it not possible to have it as `"puppeteer-core": "5.5.0" there, and require it as such?

As noted in the description:

One of the merged changes would allow us to avoid using an npm alias puppeteer for puppeteer-core: argos-ci/jest-puppeteer#315. There are reports of issues with npm aliases used as dependencies in packages published to npm, see #21872.

The patch referenced removes the hard dependency on puppeteer but it wasn't published to npm.

Alternatively: AFAIU, the main reason for using puppeteer-core over puppeteer is that it doesn't download the Chromium binary at npm install time. It seems possible to avoid that via the PUPPETEER_SKIP_CHROMIUM_DOWNLOAD env var; would that be an alternative?

Yes, that's the main reason. It's inconvenient to teach all projects to use the flag you mentioned in their setup to avoid downloading Chromium. There is no simple way to define the same flag on the @wordpress/scripts level that would be respected by npm install.

@ockham
Copy link
Contributor

ockham commented Mar 1, 2021

Can you explain why we needed the npm alias in the first place? Is it not possible to have it as `"puppeteer-core": "5.5.0" there, and require it as such?

As noted in the description:

One of the merged changes would allow us to avoid using an npm alias puppeteer for puppeteer-core: smooth-code/jest-puppeteer#315. There are reports of issues with npm aliases used as dependencies in packages published to npm, see #21872.

Yes, I read that before asking my question. Maybe you meant to point me to smooth-code/jest-puppeteer#315 specifically? Upon reading that PR's diff, I see that current versions of puppeteer have an explicit require( 'puppeteer' ), which explains why we currently need the npm alias.

Base automatically changed from master to trunk March 1, 2021 15:46
Copy link
Contributor

@ockham ockham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good overall -- thanks a lot for tackling this!

I left one note which we should probably address prior to merging this -- otherwise I think it's ready.

In the future, we might consider trimming down our copy of jest-environment-puppeteer further, or replace it by a simpler stub, as e.g. demonstrated at https://jestjs.io/docs/en/puppeteer#custom-example-without-jest-puppeteer-preset.

@gziolo
Copy link
Member Author

gziolo commented Mar 8, 2021

In the future, we might consider trimming down our copy of jest-environment-puppeteer further, or replace it by a simpler stub, as e.g. demonstrated at https://jestjs.io/docs/en/puppeteer#custom-example-without-jest-puppeteer-preset.

Yes, we should consider both options. It would be a breaking change but we can always leave a note in the CHANGELOG how to update projects. For now, by using a copy of jest-environment-puppeteer we don't have to duplicate documentation because the reference to how config is structured is still valid. Well, we probably should decide sooner than later what we want to support moving forward.

@gziolo gziolo merged commit 398a9e7 into trunk Mar 8, 2021
@gziolo gziolo deleted the update/jest-environment-puppeteer branch March 8, 2021 18:13
@github-actions github-actions bot added this to the Gutenberg 10.2 milestone Mar 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Tool] WP Scripts /packages/scripts [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants