fix(runtime): slot name forwarding & attribute reset #4993
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tanner-reits
commented
Oct 26, 2023
| childNode.hidden = true; | ||
| break; | ||
| // Don't check the node against itself | ||
| if (siblingNode !== childNode) { |
There was a problem hiding this comment.
All I did here was wrap the existing logic in a check so we aren't hiding slot fallback content when comparing the exact same node
|
| 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
reviewed
Oct 26, 2023
src/runtime/vdom/vdom-render.ts
Outdated
| // When putting an element node back in it's original location, | ||
| // we need to reset the `slot` attribute back to the value it originally had | ||
| // so we can correctly relocate it again in the future | ||
| if (childNode.nodeType === NODE_TYPE.ElementNode && !childNode['s-sr']) { |
There was a problem hiding this comment.
For my own edification, why do we check that childNode['s-sr'] is falsy?
There was a problem hiding this comment.
Actually, good catch. We don't need to since a slot ref node can only be a text node or comment node, so they'd never pass the first check anyway
Co-authored-by: Ryan Waskiewicz <ryanwaskiewicz@gmail.com>
rwaskiewicz
approved these changes
Oct 26, 2023
alicewriteswrongs
approved these changes
Oct 26, 2023
rwaskiewicz
added
the
Resolution: Refine
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the current behavior?
There is a possible issue with slot relocation when moving nodes into nested components where slot names change along the path of relocation. Currently, Stencil will not execute the logic to change slot attributes on relocated elements unless they are being relocated into a Shadow element. This was causing issues with elements receiving the
hiddenattribute when relocated because we weren't resolving the slot reference node based on the correct slot name.GitHub Issue Number: N/A
What is the new behavior?
We now perform the same slot name forwarding logic we do when moving from a non-shadow to shadow component. The
putBackInOriginalLocationmethod was also updated to reset theslotattribute on re-relocated nodes back to their original value so relocation can work correctly on subsequent re-renders.Does this introduce a breaking change?
Testing
All current e2e and unit tests continue to pass. Added a e2e test for the specific slot-name forwarding case this was located in.
Other information
This behavior is only available with the
experimentalSlotFixesextras config flag active.