feat(test): jest 29 support

[rwaskiewicz]

What is the current behavior?

Stencil lacks support for Jest 29

GitHub Issue Number: N/A

Note to Reviewers

This PR is meant to follow along with the steps for adding a new version of Jest, currently ready for review (#4952). I suggest reading that in tandem with this PR, each commit in this PR can be directly tied back to a step (there may be >1 commit per step) in that document.

This PR is a child of #4979. I plan on merging that first, then this one. I'll probably wait until both are approved to begin the merging/squashing/rebasing of the two branches

What is the new behavior?

Add support for Jest 29 to Stencil

Does this introduce a breaking change?

• Yes
• No

Testing

To test, I generated a dev build of the branch - @stencil/core@4.6.0-dev.1698239124.bd2fbc0

• Dev Release Workflow
• NPM Registry Entry

Component Starter Testing

I tested this on a Stencil Component Starter (manually).

I started by generating a new project with the dev build:

cd /tmp \
&& npm init stencil@latest component jest-test \
&& cd $_ \
&& npm i @stencil/core@4.6.0-dev.1698239124.bd2fbc0

Then installed each version of jest and tested them:

npm i jest@24 jest-cli@24 @types/jest@24 && npm t -- --no-cache && \
npm i jest@25 jest-cli@25 @types/jest@25 && npm t -- --no-cache && \
npm i jest@26 jest-cli@26 @types/jest@26 && npm t -- --no-cache && \
npm i jest@27 jest-cli@27 @types/jest@27 && npm t -- --no-cache && \
npm i jest@28 jest-cli@28 @types/jest@28 && npm t -- --no-cache && \
npm i jest@29 jest-cli@29 @types/jest@29 && npm t -- --no-cache

Ionic Framework

I tested this branch in the Ionic Framework as well.

Note: Node 18 is required to run tests here.

1. Pull the latest Ionic Framework code, check out main
2. cd core/ && npm i @stencil/core@4.6.0-dev.1698239124.bd2fbc0
3. npm i jest@29 @types/jest@29 jest-cli@29 @jest/core@29
4. npm run test.spec -- --no-cache
5. At this point, an error should appear
6. Apply the following patch:

diff --git a/core/src/components/datetime/test/data.spec.ts b/core/src/components/datetime/test/data.spec.ts
index 4484224402..0306d09f9c 100644
--- a/core/src/components/datetime/test/data.spec.ts
+++ b/core/src/components/datetime/test/data.spec.ts
@@ -482,7 +482,7 @@ describe('generateTime()', () => {
 
 describe('getToday', () => {
   beforeAll(() => {
-    jest.useFakeTimers('modern');
+    jest.useFakeTimers();

7. Rerun the tests, everything ought to pass now 👍

Other information

Docs PR: ionic-team/stencil-site#1257

Note to self When it's time to merge, please squash this, add the STENCIL- ticket number and the 'fixes' contents to the squashed commit

[github-actions]

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1393 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/build/build-stats.ts	27
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts	25
src/compiler/style/test/optimize-css.spec.ts	23
src/testing/puppeteer/puppeteer-element.ts	23
src/compiler/prerender/prerender-main.ts	22
src/runtime/vdom/vdom-render.ts	20
src/runtime/client-hydrate.ts	19
src/screenshot/connector-base.ts	19
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/build/build-finish.ts	13
src/compiler/prerender/prerender-queue.ts	13

Our most common errors

Typescript Error Code	Count
TS2345	418
TS2322	398
TS18048	310
TS18047	100
TS2722	38
TS2532	34
TS2531	23
TS2454	14
TS2352	13
TS2769	10
TS2790	10
TS2538	8
TS2344	5
TS2416	4
TS2493	3
TS18046	2
TS2684	1
TS2488	1
TS2430	1

Unused exports report

There are 12 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/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	62	satisfies
src/compiler/types/validate-primary-package-output-target.ts	62	Record
src/testing/puppeteer/puppeteer-declarations.ts	485	WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts	7	writeFetchSuccessSync

[rwaskiewicz]

Note, Steps 3-5 are a little different in the README PR for adding new Jest support after this commit - 09129f4

[tanner-reits]

Seems like a straightforward port of Jest 28 support