fix(testing): puppeteer v10 support #2939
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit is a backport of #2934 - The intent is to allow folks developing for Stencil on the 2.X line with modern Mac machines to be able to run 'npm install' without resorting to workarounds regarding Puppeteer Changes: - Update puppeteer to v10.0.0 - Remove @types/puppeteer from root package.json file - Update programmatic library checks - Remove @types/puppeteer - Make puppeteer@10 the recommended version - Replace @types/puppeteer instances of PageCloseOptions - This interface was originally defined in v5.4.3 of the DefinitelyTyped type declaration file for Puppeteer https://github.com/DefinitelyTyped/DefinitelyTyped/blob/34edf5fb8fdf54f57ed6584f77f1611767af7f6b/types/puppeteer/index.d.ts#L1423 - It has since been removed, and replace with an object literal of the same shape https://github.com/puppeteer/puppeteer/blob/main/src/common/Page.ts#L2097 - Replace usages of NavigationOptions for WaitForOptions - WaitForOptions is structurally the same as @types/puppeteer's [NavigationOptions](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/34edf5fb8fdf54f57ed6584f77f1611767af7f6b/types/puppeteer/index.d.ts#L616) and is used as a drop in replacement - The page#goTo method in Puppeteer's definition in both v5.4.3 and v10 allow an optional 'referer' string. Since it was omitted in the original implementation, I did not include it in this update - Replace Response with HTTPResponse - Update ElementHandle#press to use KeyInput instead of string - Make typings of executionContext.evaluate explicit - Migrate EmulateOptions - Puppeteer no longer exports a type of name EmulateOptions, in favor of an object literal.
- Offer better compatability between Puppeteer 5 and 10 for projects that cannot upgrade
- TIL that lockfile V2 keeps track of caret/tildes in depedencies
ltm
approved these changes
Jun 25, 2021
|
This may resolve #2471, need to test further |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Important Front Matter
This PR is a port of #2934, which has largely already been reviewed:
The 'new stuff' includes:
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locallyand any changes were pushedPull request type
Please check the type of change your PR introduces:
What is the current behavior?
In this PR, we upgrade Stencil to allow support for v10.0.0 of Puppeteer. The version of Puppeteer (v5.5.0) supported in
stencil@2.6.0has two separate issues:npm installcannot be easily run in the Stencil repo itself on newer Mac machines (those using an M1). This was fixed on the Puppeteer side in feat(launcher): fix installation error on Apple M1 chips puppeteer/puppeteer#7099What is the new behavior?
@types/puppeteerDoes this introduce a breaking change?
Manual Testing
npm buildandnpm packfrom the root of the repo directory (on this branch)npm init stencilnpm tin my stencil app passedOther information