fix(testing): make Puppeteer an optional dependency

[christian-bromann]

What is the current behavior?

Currently it seems required to have Puppeteer installed to build a Stencil component. It seems that the compiler imports parts of the testing module to compile a project which causes "/testing/puppeteer/puppeteer-declarations.d.ts" to be loaded.

STENCIL-881
fixes #4526

What is the new behavior?

To solve the type dependency the easiest is to add a Rollup plugin that simply adds a "@ts-ignore" before the import. If Puppeteer is not installed, it will not throw any errors, if it is installed, all types are propagated correctly.

Does this introduce a breaking change?

• Yes
• No

Testing

To verify this change:

• create a new stencil project npm init stencil
• install all dependencies via npm install
• build project npm run build and see build succeeding
• now remove Puppeteer as dependency rm -r ./node_modules/puppeteer
• build project npm run build and see build failing
• now install this branch to the project
• remove Puppeteer as dependency rm -r ./node_modules/puppeteer
• build project npm run build and see build succeeding

Other information

While this is a rather undesired thing to do, in hopes we eventually get rid of Jest and Puppeteer as required test harness, this will be code that will be removed eventually anyway.

[github-actions]

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1323 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files

Path	Error Count
src/dev-server/index.ts	37
src/mock-doc/serialize-node.ts	36
src/dev-server/server-process.ts	32
src/compiler/style/test/optimize-css.spec.ts	23
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts	22
src/compiler/prerender/prerender-main.ts	22
src/testing/puppeteer/puppeteer-element.ts	22
src/runtime/client-hydrate.ts	20
src/screenshot/connector-base.ts	19
src/runtime/vdom/vdom-render.ts	18
src/compiler/config/test/validate-paths.spec.ts	16
src/dev-server/request-handler.ts	15
src/compiler/prerender/prerender-optimize.ts	14
src/compiler/sys/stencil-sys.ts	14
src/compiler/transpile/transpile-module.ts	14
src/runtime/vdom/vdom-annotations.ts	14
src/sys/node/node-sys.ts	14
src/compiler/prerender/prerender-queue.ts	13
src/compiler/sys/in-memory-fs.ts	13
src/runtime/connected-callback.ts	13

Our most common errors

Typescript Error Code	Count
TS2345	399
TS2322	374
TS18048	286
TS18047	101
TS2722	37
TS2532	30
TS2531	23
TS2454	14
TS2352	13
TS2790	10
TS2769	8
TS2538	8
TS2416	6
TS2344	5
TS2493	3
TS2488	2
TS18046	2
TS2684	1
TS2430	1

Unused exports report

There are 14 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports

File	Line	Identifier
src/runtime/bootstrap-lazy.ts	21	setNonce
src/screenshot/screenshot-fs.ts	18	readScreenshotData
src/testing/testing-utils.ts	198	withSilentWarn
src/utils/index.ts	145	CUSTOM
src/utils/index.ts	269	normalize
src/utils/index.ts	7	escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts	25	BUILD
src/compiler/app-core/app-data.ts	115	Env
src/compiler/app-core/app-data.ts	117	NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts	123	updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts	61	satisfies
src/compiler/types/validate-primary-package-output-target.ts	61	Record
src/testing/puppeteer/puppeteer-declarations.ts	485	WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts	7	writeFetchSuccessSync

[alicewriteswrongs]

tried it out locally and works great!

[christian-bromann]

Released in v4.8.2