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): support watch for components with custom tag names #5767

Merged
merged 4 commits into from
May 15, 2024

Conversation

christian-bromann
Copy link
Member

What is the current behavior?

If users define their component with a custom tag name, the @Watch decorator doesn't work.

GitHub Issue Number: #3554
STENCIL-546

What is the new behavior?

Instead of using the component meta data we just pick the tag name for the component directly.

Documentation

n/a

Does this introduce a breaking change?

  • Yes
  • No

Testing

Added an unit test for this.

Other information

n/a

Copy link
Contributor

github-actions bot commented May 14, 2024

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1120 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/runtime/client-hydrate.ts 20
src/runtime/vdom/vdom-render.ts 20
src/screenshot/connector-base.ts 19
src/testing/puppeteer/puppeteer-element.ts 19
src/dev-server/request-handler.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/runtime/connected-callback.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/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
src/compiler/build/compiler-ctx.ts 11
Our most common errors
Typescript Error Code Count
TS2322 358
TS2345 344
TS18048 201
TS18047 77
TS2722 37
TS2532 24
TS2531 19
TS2454 14
TS2790 11
TS2352 9
TS2769 8
TS2416 7
TS2538 4
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 15 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 245 NODE_TYPES
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 116 Env
src/compiler/app-core/app-data.ts 118 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 May 14, 2024

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.18.1-dev.1715812295.9f7ce6a.tgz.zip && npm install ~/Downloads/stencil-core-4.18.1-dev.1715812295.9f7ce6a.tgz

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.

change makes sense to me! Just noticed I think one little typo in the comment and had one clarification

src/runtime/initialize-component.ts Outdated Show resolved Hide resolved
@@ -13,7 +13,8 @@ const testRequiresManualSetup =
window.__wdioSpec__.includes('custom-elements-output-tag-class-different') ||
window.__wdioSpec__.includes('custom-elements-delegates-focus') ||
window.__wdioSpec__.includes('custom-elements-output') ||
window.__wdioSpec__.includes('global-script');
window.__wdioSpec__.includes('global-script') ||
window.__wdioSpec__.endsWith('custom-tag-name.test.tsx');
Copy link
Contributor

Choose a reason for hiding this comment

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

we need this because we don't want the normal .define call to happen, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, so we avoid registering all the components to the registry to test the behavior where user would do this manually.

Copy link
Member

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

LGTM

Co-authored-by: Alice Pote <alice.writes.wrongs@gmail.com>
@christian-bromann christian-bromann added this pull request to the merge queue May 15, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 15, 2024
@christian-bromann christian-bromann added this pull request to the merge queue May 15, 2024
Merged via the queue into main with commit f561e0f May 15, 2024
92 of 93 checks passed
@christian-bromann christian-bromann deleted the cb/custom-tag-watch branch May 15, 2024 22:43
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