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(hydrate): support server side rendering of components with listener #5877

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

christian-bromann
Copy link
Member

What is the current behavior?

Server side rendering fails when the component has a event listener attached to it. e.g.:

import { Component, Element, Host, h, Listen } from '@stencil/core';

@Component({
  tag: 'my-whatever-component',
  styleUrl: 'my-whatever-component.css',
  shadow: true,
})
export class MyWhateverComponent {
  @Element() hostElement;
  private slotRef: HTMLSlotElement;

  @Listen('click', { capture: true }) // Crashes, incorrect binding in hydrate index.js
  handleKeyPress(): void {
  }

  render() {
    return (
      <Host>
        <slot ref={(el: HTMLSlotElement) => this.slotRef = el}></slot>
      </Host>
    );
  }
}

Culprit here was that addHostEventListeners was called without this attached to it, causing the function to throw an error and stopping the vdom annotation process to continue, leaving some nested components without annotations which caused double render.

GitHub Issue Number: fixes #5869

What is the new behavior?

Attach this context and require this in the TypeScript definition so this error can be caught during development.

Documentation

n/a

Does this introduce a breaking change?

  • Yes
  • No

Testing

Added an e2e test for this.

Other information

n/a

Copy link
Contributor

github-actions bot commented Jul 1, 2024

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.19.1-dev.1719875209.70739cb.tgz.zip && npm install ~/Downloads/stencil-core-4.19.1-dev.1719875209.70739cb.tgz

Copy link
Contributor

github-actions bot commented Jul 1, 2024

@stencil/core@4.19.1 ts
tsc --noEmit --project scripts/tsconfig.json && tsx scripts/tech-debt-burndown-report.ts

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1078 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/vdom/vdom-render.ts 22
src/runtime/client-hydrate.ts 20
src/runtime/vdom/test/patch.spec.ts 19
src/runtime/vdom/test/util.spec.ts 19
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
Our most common errors
Typescript Error Code Count
TS2322 338
TS2345 328
TS18048 188
TS18047 99
TS2722 27
TS2532 23
TS2531 19
TS2790 11
TS2454 10
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 22 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 82 satisfies
src/compiler/types/validate-primary-package-output-target.ts 82 Record
src/testing/puppeteer/puppeteer-declarations.ts 496 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

@christian-bromann christian-bromann added this pull request to the merge queue Jul 2, 2024
Merged via the queue into main with commit 2c5b7f8 Jul 2, 2024
93 checks passed
@christian-bromann christian-bromann deleted the cb/ssr-listen-components branch July 2, 2024 15:44
github-merge-queue bot pushed a commit to ionic-team/ionic-framework that referenced this pull request Jul 2, 2024
Issue number: resolves #29681

---------

### Release Notes

<details>
<summary>ionic-team/stencil (@&#8203;stencil/core)</summary>

###
[`v4.19.2`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4192-2024-07-02)

[Compare
Source](https://togithub.com/ionic-team/stencil/compare/v4.19.1...v4.19.2)

### Bug Fixes

* **hydrate:** partially revert
[#5838](ionic-team/stencil#5838)
([#5876](ionic-team/stencil#5876))
([dfbc340](ionic-team/stencil@dfbc340))
* **hydrate:** support server side rendering of components with listener
([#5877](ionic-team/stencil#5877))
([2c5b7f8](ionic-team/stencil@2c5b7f8)),
fixes [#5869](ionic-team/stencil#5869)
* **testing:** add testing sub module to export map
([#5873](ionic-team/stencil#5873))
([bb2e04f](ionic-team/stencil@bb2e04f)),
fixes [#5871](ionic-team/stencil#5871) and
[#5868](ionic-team/stencil#5868)

</details>
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: hydrate crashes if component uses @Listen
2 participants