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): make style getter behavior consistent between default and native components #5144

Merged
merged 3 commits into from
Dec 11, 2023

Conversation

christian-bromann
Copy link
Member

@christian-bromann christian-bromann commented Dec 8, 2023

What is the current behavior?

Currently our nightly build is broken due changes introduced in #5131 (see https://github.com/ionic-team/ionic-framework/actions/runs/7124408050). Investigating this issue was difficult as it happens to be random behavior. However I found that the static style property wasn't applied correctly in the failing cases which gave me a hint to the location of this fix.

What is the new behavior?

I made changes in the order of if statements in getSingleStyle and getMultipleModeStyle
and have recognised a file with similar implementation features: /src/compiler/transformers/component-native/native-static-style.ts. Afaik this is done if transformOpts.componentExport is set to customelement.

It turns out that after aligning the order of if statements in addSingleStyleGetter with how it is in getSingleStyle the component was rendered correctly in a consistent fashion.

Does this introduce a breaking change?

  • Yes
  • No

Testing

Added some tests but you can reproduce the issue by:

  • create a stencil project npm init stencil
  • change the stencil dependency to be nightly in package.json: "@stencil/core": "nightly"
  • npm install
  • add another output target:
     {
       type: 'dist-custom-elements',
       dir: 'components',
     },
    
  • go in components/my-component.js and verify that MyComponentStyle is not defined

No to verify the fix pack the build of this branch and link it to that project. After rebuilding the component you should see a myComponentCss defined.

Other information

Copy link
Contributor

github-actions bot commented Dec 8, 2023

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1323 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/style/test/optimize-css.spec.ts 23
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts 22
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 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/prerender/prerender-queue.ts 13
src/compiler/sys/in-memory-fs.ts 13
src/runtime/connected-callback.ts 13
Our most common errors
Typescript Error Code Count
TS2345 399
TS2322 374
TS18048 286
TS18047 101
TS2722 37
TS2532 30
TS2531 23
TS2454 14
TS2352 13
TS2790 10
TS2769 8
TS2538 8
TS2416 6
TS2344 5
TS2493 3
TS2488 2
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

@@ -33,20 +33,20 @@ const addMultipleModeStyleGetter = (
const styleLiteral = createStyleLiteral(cmp, style);
Copy link
Contributor

Choose a reason for hiding this comment

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

GH won't allow me to comment on a line higher than this one - can we add a comment before this conditional starts (above the if statement) that the order of the conditional must match add-static-style.ts#getSingleStyle?

Copy link
Contributor

Choose a reason for hiding this comment

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

on this point, I was thinking it might make sense to circle back after the bugfix is out and factor out this logic into a helper function since it looks essentially the same in these two spots

@@ -65,18 +65,18 @@ const addSingleStyleGetter = (
// static get style() { return "string"; }
Copy link
Contributor

Choose a reason for hiding this comment

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

GH won't allow me to comment on a line higher than this one - can we add a comment before this conditional starts (above the if statement) that the order of the conditional must match add-static-style.ts#getSingleStyle?

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.

I tried out the fix locally and it looks good!

@christian-bromann
Copy link
Member Author

@rwaskiewicz added comments, can I go ahead and merge?

@christian-bromann
Copy link
Member Author

Got a 👍 through our internal communication platform. Going ahead and merge.

@christian-bromann christian-bromann added this pull request to the merge queue Dec 11, 2023
Merged via the queue into main with commit 6abe250 Dec 11, 2023
@christian-bromann christian-bromann deleted the cb/fix-nightly branch December 11, 2023 18:11
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.

4 participants