feat(testing): add `toHaveLastReceivedEventDetail` event spy matcher by tanner-reits · Pull Request #5829 · stenciljs/core

tanner-reits · 2024-06-13T18:56:35Z

What is the current behavior?

Stencil offers event matchers for toHaveFirstReceivedEventDetail and toHaveNthReceivedEventDetail.

GitHub Issue Number: Closes #2488

What is the new behavior?

Adds a matcher for toHaveLastReceivedEventDetail that will check the detail content of an event emitted from a Stencil component

Does this introduce a breaking change?

Yes
No

Testing

Tested the matchers (for first and last event) in a component starter.

Other information

github-actions · 2024-06-13T18:58:03Z

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

`--strictNullChecks` error report

Typechecking with --strictNullChecks resulted in 1084 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	21
src/runtime/client-hydrate.ts	20
src/screenshot/connector-base.ts	19
src/testing/puppeteer/puppeteer-element.ts	19
src/dev-server/request-handler.ts	15
src/runtime/connected-callback.ts	15
src/compiler/prerender/prerender-optimize.ts	14
src/compiler/sys/stencil-sys.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	352
TS2345	333
TS18048	193
TS18047	76
TS2722	27
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	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

github-actions · 2024-06-13T18:58:12Z

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.18.3-dev.1718896583.63613f8.tgz.zip && npm install ~/Downloads/stencil-core-4.18.3-dev.1718896583.63613f8.tgz

tanner-reits · 2024-06-13T20:02:56Z

src/testing/jest/jest-27-and-under/matchers/events.ts


  const pass = deepEqual(eventSpy.firstEvent.detail, eventDetail);

+  expect(eventSpy.firstEvent.detail).toEqual(eventDetail);


Don't like how Git is showing the diff, but this line used to be: expect(eventSpy.lastEvent.detail).toEqual(eventDetail)

Changed it to use firstEvent, since, well, this is supposed to be checking what event data the spy first received. Idk why this was lastEvent before, but, in testing, I setup a component to emit multiple events and checked that the assertions using toHaveFirstReceivedEventDetail and toHaveLastReceivedEventDetail were working as expected with the emitted values.

I'm not sure if this is a breaking change, but seems like the original implementation was wrong in the first place 😅

(made the change for each adapter version)

christian-bromann

Do you think we can add a test for this matcher?

tanner-reits · 2024-06-18T20:13:29Z

@christian-bromann I don't know if I'll be able to test this. The matchers use expect under-the-hood, so testing failed cases results in the test failing early because the assertion within the matcher fails

christian-bromann · 2024-06-18T20:55:54Z

The matchers use expect under-the-hood

I thought it would be possible somewhere in test/end-to-end where we call npm run test.spec which triggers the Stencil testrunner.

christian-bromann

LGTM 👍

### Release Notes <details> <summary>ionic-team/stencil (@stencil/core)</summary> ### [`v4.19.0`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4190-2024-06-26) [Compare Source](https://togithub.com/ionic-team/stencil/compare/v4.18.3...v4.19.0) ### Bug Fixes * **compiler:** support rollup's external input option ([#3227](stenciljs/core#3227)) ([2c68849](stenciljs/core@2c68849)), fixes [#3226](stenciljs/core#3226) * **emit:** don't emit test files ([#5789](stenciljs/core#5789)) ([50892f1](stenciljs/core@50892f1)), fixes [#5788](stenciljs/core#5788) * **hyrdate:** support vdom annotation in nested dsd structures ([#5856](stenciljs/core#5856)) ([61bb5e3](stenciljs/core@61bb5e3)) * label attribute not toggling input ([#3474](stenciljs/core#3474)) ([13db920](stenciljs/core@13db920)), fixes [#3473](stenciljs/core#3473) * **mock-doc:** expose ShadowRoot and DocumentFragment globals ([#5827](stenciljs/core#5827)) ([98bbd7c](stenciljs/core@98bbd7c)), fixes [#3260](stenciljs/core#3260) * **runtime:** allow watchers to fire w/ no Stencil members ([#5855](stenciljs/core#5855)) ([850ad4f](stenciljs/core@850ad4f)), fixes [#5854](stenciljs/core#5854) * **runtime:** catch errors in async lifecycle methods ([#5826](stenciljs/core#5826)) ([87e5b33](stenciljs/core@87e5b33)), fixes [#5824](stenciljs/core#5824) * **runtime:** don't register listener before connected to DOM ([#5844](stenciljs/core#5844)) ([9d7021f](stenciljs/core@9d7021f)), fixes [#4067](stenciljs/core#4067) * **runtime:** properly assign style declarations ([#5838](stenciljs/core#5838)) ([5c10ebf](stenciljs/core@5c10ebf)) * **testing:** allow to re-use pages across it blocks ([#5830](stenciljs/core#5830)) ([561eab4](stenciljs/core@561eab4)), fixes [#3720](stenciljs/core#3720) * **typescript:** remove unsupported label property ([#5840](stenciljs/core#5840)) ([d26ea2b](stenciljs/core@d26ea2b)), fixes [#3473](stenciljs/core#3473) ### Features * **cli:** support generation of sass and less files ([#5857](stenciljs/core#5857)) ([1883812](stenciljs/core@1883812)), closes [#2155](stenciljs/core#2155) * **compiler:** generate export maps on build ([#5809](stenciljs/core#5809)) ([b6d2404](stenciljs/core@b6d2404)) * **complier:** support type import aliasing ([#5836](stenciljs/core#5836)) ([7ffb25d](stenciljs/core@7ffb25d)), closes [#2335](stenciljs/core#2335) * **runtime:** support declarative shadow DOM ([#5792](stenciljs/core#5792)) ([c837063](stenciljs/core@c837063)), closes [#4010](stenciljs/core#4010) * **testing:** add `toHaveLastReceivedEventDetail` event spy matcher ([#5829](stenciljs/core#5829)) ([63491de](stenciljs/core@63491de)), closes [#2488](stenciljs/core#2488) * **testing:** allow to disable network error logging via 'logFailingNetworkRequests' option ([#5839](stenciljs/core#5839)) ([dac3e33](stenciljs/core@dac3e33)), closes [#2572](stenciljs/core#2572) * **testing:** expose captureBeyondViewport in pageCompareScreenshot ([#5828](stenciljs/core#5828)) ([cf6a450](stenciljs/core@cf6a450)), closes [#3188](stenciljs/core#3188) </details>

add toHaveLastReceivedEventDetail matcher

40d1b93

tanner-reits commented Jun 13, 2024

View reviewed changes

tanner-reits marked this pull request as ready for review June 13, 2024 20:04

tanner-reits requested a review from a team as a code owner June 13, 2024 20:04

tanner-reits requested review from christian-bromann and gnbm June 13, 2024 20:04

christian-bromann reviewed Jun 13, 2024

View reviewed changes

update e2e event test for new matcher

16c531b

tanner-reits requested a review from christian-bromann June 20, 2024 15:24

christian-bromann approved these changes Jun 20, 2024

View reviewed changes

tanner-reits added this pull request to the merge queue Jun 20, 2024

Merged via the queue into main with commit 63491de Jun 20, 2024

tanner-reits deleted the tr/last-event-matcher branch June 20, 2024 17:20

brandyscarney mentioned this pull request Jun 26, 2024

chore(deps): update dependency @stencil/core to v4.19.0 ionic-team/ionic-framework#29666

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(testing): add `toHaveLastReceivedEventDetail` event spy matcher#5829

feat(testing): add `toHaveLastReceivedEventDetail` event spy matcher#5829
tanner-reits merged 2 commits intomainfrom
tr/last-event-matcher

tanner-reits commented Jun 13, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Jun 13, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Jun 13, 2024 •

edited

Loading

Uh oh!

tanner-reits Jun 13, 2024 •

edited

Loading

Uh oh!

christian-bromann left a comment

Uh oh!

tanner-reits commented Jun 18, 2024

Uh oh!

christian-bromann commented Jun 18, 2024

Uh oh!

christian-bromann left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		const pass = deepEqual(eventSpy.firstEvent.detail, eventDetail);

		expect(eventSpy.firstEvent.detail).toEqual(eventDetail);

Uh oh!

Conversation

tanner-reits commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is the current behavior?

What is the new behavior?

Does this introduce a breaking change?

Testing

Other information

Uh oh!

github-actions bot commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

--strictNullChecks error report

reports and statistics

Unused exports report

Uh oh!

github-actions bot commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR built and packed!

Uh oh!

tanner-reits Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christian-bromann left a comment

Choose a reason for hiding this comment

Uh oh!

tanner-reits commented Jun 18, 2024

Uh oh!

christian-bromann commented Jun 18, 2024

Uh oh!

christian-bromann left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tanner-reits commented Jun 13, 2024 •

edited

Loading

github-actions bot commented Jun 13, 2024 •

edited

Loading

`--strictNullChecks` error report

github-actions bot commented Jun 13, 2024 •

edited

Loading

tanner-reits Jun 13, 2024 •

edited

Loading