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): relocate slot content from non-shadow to shadow components w/ slot name change #4940

Merged

Conversation

tanner-reits
Copy link
Member

@tanner-reits tanner-reits commented Oct 17, 2023

What is the current behavior?

It is possible for content to not be relocated correctly when it is relocated from a non-shadow to a shadow component if a slot is slotted into another slot and the names are different. A basic example may look something like:

// index.html
<host-cmp>
  <b slot="main-content">main slotted content</b>
  <b slot="secondary-content">secondary slotted content</b>
</host-cmp>
// host.tsx
<div>
  <parent-cmp>
    <slot name="main-content" slot="main-content" />
    <div slot="slotted-content-element">
      <child-cmp>
        <slot name="secondary-content" />
      </child-cmp>
    </div>
  </parent-cmp>
</div>

// parent.tsx
<div>
  <slot name="main-content" />
  <slot name="slotted-content-element" />
</div>

// child.tsx
<div>
  <p>content before</p>
  <slot />
  <p>content after</p>
</div>

In the above example, the "secondary slotted content" text won't render at all since we don't correctly remove the slot attribute for it to render in the default slot in it's final location.

Fixes: #4525

What is the new behavior?

When we move the node under the shadow component, we check the element's slot attribute against the slot ref node to make sure the two slot names match.

Does this introduce a breaking change?

  • Yes
  • No

Testing

Manual Testing

Install a build of this branch into the reproduction case for the issue (#4525)

Automated Testing

New e2e test added for reproduction case. All other unit & e2e tests continue to pass

Other information

Only available when the experimentalSlotFixes config extras flag is enabled

@github-actions
Copy link
Contributor

github-actions bot commented Oct 17, 2023

--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

Copy link
Member Author

@tanner-reits tanner-reits left a comment

Choose a reason for hiding this comment

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

Just noting one thing. Also, the added test was pulled directly from the associated issue

Comment on lines +1023 to +1024
nodeToRelocate.nodeType === NODE_TYPE.ElementNode &&
slotRefNode.parentElement?.shadowRoot != null &&
Copy link
Member Author

Choose a reason for hiding this comment

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

Couple things here for context:

  1. I decided to just ignore non-element nodes for now (i.e. comment nodes and text nodes). Per our discussion, the edge-case where these types of nodes is relevant is highly unlikely, so seems okay to hold on that until we have a need to fix it.
  2. We check the shadowRoot here because we only need to deal with these slot slot (yes, the double "slot" there is intentional) values if we're moving the content into a shadow component since the native shadow DOM will handle things from there.

@tanner-reits tanner-reits marked this pull request as ready for review October 18, 2023 00:40
@tanner-reits tanner-reits requested a review from a team as a code owner October 18, 2023 00:40
@tanner-reits tanner-reits requested review from rwaskiewicz and alicewriteswrongs and removed request for a team October 18, 2023 00:40
Copy link
Member

@rwaskiewicz rwaskiewicz left a comment

Choose a reason for hiding this comment

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

Two non-blocking asks

Base automatically changed from treits/fix/hidden-slots-after-relocation to main October 23, 2023 20:16
@tanner-reits tanner-reits added this pull request to the merge queue Oct 23, 2023
Merged via the queue into main with commit 0fe78c7 Oct 23, 2023
96 checks passed
@tanner-reits tanner-reits deleted the treits/fix/non-shadow-to-shadow-slot-name-forwarding branch October 23, 2023 20:45
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.

bug: Missing slotted content when slot is forwarded from a non-shadow component
3 participants