Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(runtime): remove forceUpdate in appendChild patch #5437

Merged
merged 1 commit into from
Mar 11, 2024

Conversation

tanner-reits
Copy link
Member

What is the current behavior?

Stencil's patch for appendChild for slot emulation includes a call to forceUpdate() that is no longer needed and should not have been included in the first place (see new behavior section for more info).

GitHub Issue Number: N/A

What is the new behavior?

This commit removes a call to forceUpdate that was added to Stencil's patch for appendChild for slot emulation. The call was originally added to fix a failing test in Framework that we've now identified was the result of the patch's DOM manipulation in tandem with a mutation observer in framework.

Instead, the mutation observer in framework was modified to observe changes in the element subtree, removing the need for this call.

STENCIL-1192

Documentation

N/A

Does this introduce a breaking change?

  • Yes
  • No

Testing

Automated unit and e2e tests continue to pass.

Tested this in a use case in Framework (see STENCIL-1192)

Other information

This commit removes a call to `forceUpdate` that was added to Stencil's patch for `appendChild` for slot emulation. The call was originally added to fix a failing test in Framework that we've now identified was the result of the patch's DOM manipulation in tandem with a mutation observer in framework.

Instead, the mutation observer in framework was modified to observe changes in the element subtree, removing the need for this call.

STENCIL-1192
Copy link
Contributor

github-actions bot commented Mar 5, 2024

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1139 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/dev-server/server-process.ts 32
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 17
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/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
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
src/mock-doc/test/attribute.spec.ts 12
Our most common errors
Typescript Error Code Count
TS2322 361
TS2345 349
TS18048 201
TS18047 82
TS2722 37
TS2532 24
TS2531 21
TS2454 14
TS2790 11
TS2352 10
TS2769 8
TS2538 8
TS2416 6
TS2493 3
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

Copy link
Contributor

github-actions bot commented Mar 5, 2024

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.12.5-dev.1709676883.3781523.tgz.zip && npm install ~/Downloads/stencil-core-4.12.5-dev.1709676883.3781523.tgz

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recon that we added the forceUpdate without putting it behind the experimentialSlotFixes flag and removing it could have a an impact on users that for some reasons rely on it. I don't think anyone does but there is a chance.

LGTM 👍

@tanner-reits tanner-reits added this pull request to the merge queue Mar 11, 2024
Merged via the queue into main with commit e03795b Mar 11, 2024
121 checks passed
@tanner-reits tanner-reits deleted the tr/remove-force-update-in-append-child-patch branch March 11, 2024 15:55
@christian-bromann
Copy link
Member

This has been released with Stencil 🚞 v4.13.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants