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(compiler): correctly generate CSS rules using ::slotted outside shadow DOM #4969

Merged
merged 3 commits into from
Nov 1, 2023

Conversation

tanner-reits
Copy link
Member

What is the current behavior?

Using a ::slotted pseudo-selector outside a shadow DOM component can result in styles not working as expected. The issue is with how we transform the CSS to account for our pseudo-slot behavior (relocation).

GitHub Issue Number: #3977

What is the new behavior?

The CSS in transformed into the correct rule(s) to account for nested elements. Also updated the logic so we replace all instances of the pre-transformed string in the CSS text, rather than just the first.

Does this introduce a breaking change?

  • Yes
  • No

Testing

Automated tests
Updated the existing tests to account for the change in logic (which is what they should have been in the first place)

Manual testing
Install a build of this branch into the linked issue reproduction case and verify the button styles for the "scoped" button are applied as expected to match the other buttons.

Other information

@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2023

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1391 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/client-hydrate.ts 19
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 18
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 395
TS18048 310
TS18047 101
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 15 unused exports on this PR. Unfortunately, it looks like that's an increase of 1 over main 😞.

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 232 resolve
src/utils/index.ts 246 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 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.

This doesn't resolve all the problems in the linked issue, just the styling stuff. Once I finish patching textContent and innerText, I'll have that PR be the one to close out the issue

* @param text The string potentially containing special characters.
* @returns The string with all special characters escaped.
*/
export const escapeRegExpSpecialCharacters = (text: string) => {
Copy link
Member Author

Choose a reason for hiding this comment

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

Made this a util since I could see this coming up again. If something like this already exists, or we do something similar in other places, I can update accordingly

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know of anything but this looks like it will be handy in the future!

@@ -471,15 +473,32 @@ const scopeCssText = (
cssText = scopeSelectors(cssText, scopeId, hostScopeId, slotScopeId, commentOriginalSelector);
}

cssText = cssText.replace(/-shadowcsshost-no-combinator/g, `.${hostScopeId}`);
cssText = replaceShadowCssHost(cssText, hostScopeId);
Copy link
Member Author

Choose a reason for hiding this comment

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

Tried to reorder this code so we didn't have to worry about doing this replacement in multiple places, but that caused other problems, so figured this was the solution that would cause the least headaches for now

@tanner-reits tanner-reits marked this pull request as ready for review October 25, 2023 20:38
@tanner-reits tanner-reits requested a review from a team as a code owner October 25, 2023 20:38
src/utils/regular-expression.ts Outdated Show resolved Hide resolved
src/utils/regular-expression.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@alicewriteswrongs alicewriteswrongs left a comment

Choose a reason for hiding this comment

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

tried it out and all looks good!

@tanner-reits tanner-reits added this pull request to the merge queue Nov 1, 2023
Merged via the queue into main with commit 4fd0ecd Nov 1, 2023
120 checks passed
@tanner-reits tanner-reits deleted the treits/fix/scope-css-replace-slotted-selectors branch November 1, 2023 15:47
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.

None yet

3 participants