core(types): use union of puppeteer and puppeteer-core
#14435
Conversation
There was a problem hiding this comment.
Ha, well I disagree with closing that issue (seems like that's exactly what puppeteer-core should be), but Lighthouse shouldn't be casting stones when it comes to what types should be exported by a project :)
This seems like it could cause problems down the line (parameters of unions of functions—and even worse, parameters of unions of functions that are callback parameters in unions of functions—often act unexpectedly), but I don't think there's a better solution right now, and we often have to cast things like pptr event listener callbacks anyway, so seems good for now.
|
|
||
| /** | ||
| * @fileoverview Lighthouse should be compatible with puppeteer and puppeteer-core even though the types can be slightly different between the two packages. | ||
| * Anytime we want to use a Puppeteer type within Lighthouse, we should pull the union type from here rather than one of the packages directly. |
There was a problem hiding this comment.
this is probably a good candidate for pulling in as imported typedefs, but we can keep the global for now (someday it'll be ergonomic...)
The types between these two packages are independent puppeteer/puppeteer#9018
If we want to support both, we should use the union between them to ensure proper type safety.
Some scripts import puppeteer themselves but use the types in
LH.Puppeteer. These scripts should now be using the types from whatever puppeteer they pull in.