fix(runtime): don't register listener before connected to DOM by christian-bromann · Pull Request #5844 · stenciljs/core

christian-bromann · 2024-06-20T19:33:33Z

What is the current behavior?

What is the new behavior?

Remove all addHostEventListeners calls before the element isn't connected to the DOM.

Documentation

Does this introduce a breaking change?

Yes
No

This may be a potential breaking change. However I think this behavior is the desired one and what we had before was basically a bug.

Testing

I may add more e2e tests to ensure this also works in the browser.

Other information

n/a

github-actions · 2024-06-20T19:35:04Z

@stencil/core@4.18.3 ts
tsc --noEmit --project scripts/tsconfig.json && tsx scripts/tech-debt-burndown-report.ts

`--strictNullChecks` error report

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

Unfortunately, it looks like that's an increase of 3 over main 😞.

Violations Not on `main` (may be more than the count above)

Path	Location	Error
src/hydrate/platform/hydrate-app.ts	(187, 35)	TS2345
src/hydrate/platform/hydrate-app.ts	(191, 15)	TS2722
src/hydrate/platform/hydrate-app.ts	(196, 27)	TS18048
src/hydrate/platform/hydrate-app.ts	(196, 50)	TS18048
src/hydrate/platform/hydrate-app.ts	(218, 11)	TS18048
src/hydrate/platform/hydrate-app.ts	(320, 7)	TS2322
src/runtime/bootstrap-custom-element.ts	(76, 35)	TS2345
src/runtime/bootstrap-custom-element.ts	(125, 9)	TS18048
src/runtime/bootstrap-custom-element.ts	(126, 23)	TS18048
src/runtime/bootstrap-custom-element.ts	(128, 43)	TS2345
src/runtime/bootstrap-custom-element.ts	(129, 52)	TS2538
src/runtime/bootstrap-custom-element.ts	(129, 52)	TS2538
src/runtime/bootstrap-custom-element.ts	(135, 9)	TS18048
src/runtime/bootstrap-custom-element.ts	(135, 9)	TS2322
src/runtime/bootstrap-custom-element.ts	(137, 22)	TS2345
src/runtime/bootstrap-lazy.ts	(57, 21)	TS2345
src/runtime/bootstrap-lazy.ts	(153, 41)	TS2345
src/runtime/bootstrap-lazy.ts	(173, 18)	TS2532
src/testing/platform/testing-host-ref.ts	(11, 23)	TS2345
src/testing/platform/testing-host-ref.ts	(38, 3)	TS18048
src/testing/platform/testing-host-ref.ts	(39, 37)	TS2345

reports and statistics

Our most error-prone files

Path	Error Count
src/dev-server/index.ts	37
src/dev-server/server-process.ts	32
src/compiler/prerender/prerender-main.ts	22
src/runtime/vdom/vdom-render.ts	22
src/runtime/client-hydrate.ts	20
src/runtime/vdom/test/patch.spec.ts	19
src/runtime/vdom/test/util.spec.ts	19
src/screenshot/connector-base.ts	19
src/testing/puppeteer/puppeteer-element.ts	19
src/dev-server/request-handler.ts	15
src/runtime/connected-callback.ts	15
src/compiler/prerender/prerender-optimize.ts	14
src/compiler/sys/stencil-sys.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/set-value.ts	13
src/compiler/output-targets/output-www.ts	12
src/compiler/transformers/test/parse-vdom.spec.ts	12
src/compiler/transformers/transform-utils.ts	12

Our most common errors

Typescript Error Code	Count
TS2322	337
TS2345	328
TS18048	185
TS18047	99
TS2722	27
TS2532	23
TS2531	19
TS2790	11
TS2454	10
TS2352	9
TS2769	8
TS2416	7
TS2538	4
TS2493	3
TS18046	2
TS2684	1
TS2430	1

Unused exports report

There are 15 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	22	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	245	NODE_TYPES
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	116	Env
src/compiler/app-core/app-data.ts	118	NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts	123	updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts	82	satisfies
src/compiler/types/validate-primary-package-output-target.ts	82	Record
src/testing/puppeteer/puppeteer-declarations.ts	496	WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts	7	writeFetchSuccessSync

github-actions · 2024-06-20T19:35:06Z

PR built and packed!

Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/9617770624/artifacts/1625806109

If your browser saves files to ~/Downloads you can install it like so:

unzip -d ~/Downloads ~/Downloads/stencil-core-4.18.3-dev.1718992535.ef88224.tgz.zip && npm install ~/Downloads/stencil-core-4.18.3-dev.1718992535.ef88224.tgz

### Release Notes <details> <summary>ionic-team/stencil (@stencil/core)</summary> ### [`v4.19.0`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4190-2024-06-26) [Compare Source](https://togithub.com/ionic-team/stencil/compare/v4.18.3...v4.19.0) ### Bug Fixes * **compiler:** support rollup's external input option ([#3227](stenciljs/core#3227)) ([2c68849](stenciljs/core@2c68849)), fixes [#3226](stenciljs/core#3226) * **emit:** don't emit test files ([#5789](stenciljs/core#5789)) ([50892f1](stenciljs/core@50892f1)), fixes [#5788](stenciljs/core#5788) * **hyrdate:** support vdom annotation in nested dsd structures ([#5856](stenciljs/core#5856)) ([61bb5e3](stenciljs/core@61bb5e3)) * label attribute not toggling input ([#3474](stenciljs/core#3474)) ([13db920](stenciljs/core@13db920)), fixes [#3473](stenciljs/core#3473) * **mock-doc:** expose ShadowRoot and DocumentFragment globals ([#5827](stenciljs/core#5827)) ([98bbd7c](stenciljs/core@98bbd7c)), fixes [#3260](stenciljs/core#3260) * **runtime:** allow watchers to fire w/ no Stencil members ([#5855](stenciljs/core#5855)) ([850ad4f](stenciljs/core@850ad4f)), fixes [#5854](stenciljs/core#5854) * **runtime:** catch errors in async lifecycle methods ([#5826](stenciljs/core#5826)) ([87e5b33](stenciljs/core@87e5b33)), fixes [#5824](stenciljs/core#5824) * **runtime:** don't register listener before connected to DOM ([#5844](stenciljs/core#5844)) ([9d7021f](stenciljs/core@9d7021f)), fixes [#4067](stenciljs/core#4067) * **runtime:** properly assign style declarations ([#5838](stenciljs/core#5838)) ([5c10ebf](stenciljs/core@5c10ebf)) * **testing:** allow to re-use pages across it blocks ([#5830](stenciljs/core#5830)) ([561eab4](stenciljs/core@561eab4)), fixes [#3720](stenciljs/core#3720) * **typescript:** remove unsupported label property ([#5840](stenciljs/core#5840)) ([d26ea2b](stenciljs/core@d26ea2b)), fixes [#3473](stenciljs/core#3473) ### Features * **cli:** support generation of sass and less files ([#5857](stenciljs/core#5857)) ([1883812](stenciljs/core@1883812)), closes [#2155](stenciljs/core#2155) * **compiler:** generate export maps on build ([#5809](stenciljs/core#5809)) ([b6d2404](stenciljs/core@b6d2404)) * **complier:** support type import aliasing ([#5836](stenciljs/core#5836)) ([7ffb25d](stenciljs/core@7ffb25d)), closes [#2335](stenciljs/core#2335) * **runtime:** support declarative shadow DOM ([#5792](stenciljs/core#5792)) ([c837063](stenciljs/core@c837063)), closes [#4010](stenciljs/core#4010) * **testing:** add `toHaveLastReceivedEventDetail` event spy matcher ([#5829](stenciljs/core#5829)) ([63491de](stenciljs/core@63491de)), closes [#2488](stenciljs/core#2488) * **testing:** allow to disable network error logging via 'logFailingNetworkRequests' option ([#5839](stenciljs/core#5839)) ([dac3e33](stenciljs/core@dac3e33)), closes [#2572](stenciljs/core#2572) * **testing:** expose captureBeyondViewport in pageCompareScreenshot ([#5828](stenciljs/core#5828)) ([cf6a450](stenciljs/core@cf6a450)), closes [#3188](stenciljs/core#3188) </details>

fix(runtime): don't register listener before connected to DOM

58f61fd

christian-bromann added 4 commits June 20, 2024 14:53

prettier

16c6a07

register host listeners in connectedCallback

0a231c3

consolify

dc36c15

don't register twice

7544592

christian-bromann marked this pull request as ready for review June 20, 2024 22:37

christian-bromann requested a review from a team as a code owner June 20, 2024 22:37

christian-bromann requested review from gnbm and tanner-reits June 20, 2024 22:37

christian-bromann added 2 commits June 20, 2024 15:37

Merge branch 'main' into cb/event-listener

7f8f668

prettier

bc955e6

tanner-reits approved these changes Jun 21, 2024

View reviewed changes

christian-bromann added this pull request to the merge queue Jun 21, 2024

github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Jun 21, 2024

christian-bromann added 3 commits June 21, 2024 10:50

Merge branch 'main' into cb/event-listener

71a0939

remove unnecessary import

04bf004

more explicit tests

e9336b1

christian-bromann enabled auto-merge June 21, 2024 17:59

christian-bromann added this pull request to the merge queue Jun 21, 2024

Merged via the queue into main with commit 9d7021f Jun 21, 2024

christian-bromann deleted the cb/event-listener branch June 21, 2024 18:12

brandyscarney mentioned this pull request Jun 26, 2024

chore(deps): update dependency @stencil/core to v4.19.0 ionic-team/ionic-framework#29666

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(runtime): don't register listener before connected to DOM#5844

fix(runtime): don't register listener before connected to DOM#5844
christian-bromann merged 10 commits intomainfrom
cb/event-listener

christian-bromann commented Jun 20, 2024

Uh oh!

github-actions bot commented Jun 20, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Jun 20, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

christian-bromann commented Jun 20, 2024

What is the current behavior?

What is the new behavior?

Documentation

Does this introduce a breaking change?

Testing

Other information

Uh oh!

github-actions bot commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

--strictNullChecks error report

reports and statistics

Unused exports report

Uh oh!

github-actions bot commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR built and packed!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Jun 20, 2024 •

edited

Loading

`--strictNullChecks` error report

github-actions bot commented Jun 20, 2024 •

edited

Loading