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(testing): prevent find from throwing error when query has no match #5641

Merged
merged 3 commits into from
Apr 9, 2024

Conversation

tanner-reits
Copy link
Member

What is the current behavior?

An error will get thrown when using page.find() for Puppeteer e2e tests if a query returns no elements.

Fixes: #5639

What is the new behavior?

This commit fixes an issue w/ our Puppeteer testing implementation where the find() method would throw an error if the query had no matching elements.

We do not need to make any changes to findAll since the logic there will only attempt to use any returned handles if they exist in an array. Otherwise, no entries will be pushed to the returned array so the result will be an empty array as expected.

Documentation

Does this introduce a breaking change?

  • Yes
  • No

Testing

Tested changes in the linked issue reproduction case.

Also added tests to our e2e suite so we can avoid regressions related to these functions moving forward.

Other information

This commit fixes an issue w/ our Puppeteer testing implementation where the `find()` method would throw an error if the query had no matching elements.

Fixes: #5639

STENCIL-1256
@tanner-reits tanner-reits requested a review from a team as a code owner April 8, 2024 20:30
Copy link
Contributor

github-actions bot commented Apr 8, 2024

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1137 errors on this branch.

That's 1 fewer than on main! 🎉🎉🎉

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/testing/puppeteer/puppeteer-element.ts 20
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 17
src/dev-server/request-handler.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/connected-callback.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/compiler/transpile/transpile-module.ts 12
src/mock-doc/test/attribute.spec.ts 12
Our most common errors
Typescript Error Code Count
TS2322 361
TS2345 344
TS18048 204
TS18047 82
TS2722 37
TS2532 24
TS2531 21
TS2454 14
TS2790 11
TS2352 9
TS2769 8
TS2538 8
TS2416 7
TS2493 3
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

Copy link
Contributor

github-actions bot commented Apr 8, 2024

PR built and packed!

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

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

unzip -d ~/Downloads ~/Downloads/stencil-core-4.15.0-dev.1712673241.a888a7c.tgz.zip && npm install ~/Downloads/stencil-core-4.15.0-dev.1712673241.a888a7c.tgz

Copy link
Contributor

@rwaskiewicz rwaskiewicz left a comment

Choose a reason for hiding this comment

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

All in all looks good! I have an ask for an additional test suite with a non-encapsulated component, but nothing too serious. LMK if you have any questions

render() {
return <Host>I have no children!</Host>;
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add a similar component (and matching suite of tests) where it doesn't use shadow? I don't think it matters if it's totally non-encapsulated or used scoped - I just want to make sure that in the case there's not an actual shadow root, we handle that case as well.

@kensodemann
Copy link
Member

I have also tested this PR using the Esri sample project and it passes there without issue.

@tanner-reits tanner-reits requested a review from rwaskiewicz April 9, 2024 14:33
@tanner-reits tanner-reits added this pull request to the merge queue Apr 9, 2024
Merged via the queue into main with commit b3886aa Apr 9, 2024
121 checks passed
@tanner-reits tanner-reits deleted the tr/fix-puppeteer-find-error branch April 9, 2024 17:42
jcfranco added a commit to Esri/calcite-design-system that referenced this pull request Apr 16, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@stencil/core](https://stenciljs.com/)
([source](https://togithub.com/ionic-team/stencil)) | [`4.13.0` ->
`4.15.0`](https://renovatebot.com/diffs/npm/@stencil%2fcore/4.13.0/4.15.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/@stencil%2fcore/4.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@stencil%2fcore/4.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@stencil%2fcore/4.13.0/4.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@stencil%2fcore/4.13.0/4.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

### 

[`v4.16.0`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4150-2024-04-08)

[Compare 
Source](ionic-team/stencil@v4.15.0...v4.16.0)

##### Bug Fixes

* **cli:** fix a bug in CLI argument parsing
([#5646](ionic-team/stencil#5646))
([1fdea63](ionic-team/stencil@1fdea63)),
refs [#5640](ionic-team/stencil#5640)
* **testing:** prevent `find` from throwing error when query has no
match ([#5641](ionic-team/stencil#5641))
([b3886aa](ionic-team/stencil@b3886aa)),
closes [#5639](ionic-team/stencil#5639)

##### Features

* **dev-server:** dark mode support
([#5642](ionic-team/stencil#5642))
([89a5e40](ionic-team/stencil@89a5e40))
* **typescript:** Update dependency typescript to v5.4.5
([#5663](ionic-team/stencil#5663))
([2596536](ionic-team/stencil@2596536))

###

[`v4.15.0`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4150-2024-04-08)

[Compare

Source](https://togithub.com/ionic-team/stencil/compare/v4.14.1...v4.15.0)

##### Features

- **compiler:** perform automatic key insertion in more situations
([#&#8203;5594](https://togithub.com/ionic-team/stencil/issues/5594))

([8ee071b](https://togithub.com/ionic-team/stencil/commit/8ee071bf3aae4b2240b50f7af433035c8bf8aa49))
- **typescript:** Update dependency typescript to v5.4.4
([#&#8203;5636](https://togithub.com/ionic-team/stencil/issues/5636))

([a463871](https://togithub.com/ionic-team/stencil/commit/a46387123082d1af9fc17b5909530597dc5b5c68))

####

[`4.14.1`](https://togithub.com/ionic-team/stencil/compare/v4.14.0...v4.14.1)

##### Bug Fixes

- **compiler:** don't mistake aliased paths for collections imports
([#&#8203;5620](https://togithub.com/ionic-team/stencil/issues/5620))

([af22bb8](https://togithub.com/ionic-team/stencil/commit/af22bb858d64b60a97ce93c86f5585ef36b31c3f)),
closes
[#&#8203;2319](https://togithub.com/ionic-team/stencil/issues/2319)
- **runtime:** nested multiple default slot relocation
([#&#8203;5403](https://togithub.com/ionic-team/stencil/issues/5403))

([363c07b](https://togithub.com/ionic-team/stencil/commit/363c07b4723941954dc748189a744eec01d5b74c)),
partially closes
[#&#8203;5335](https://togithub.com/ionic-team/stencil/issues/5335)
- **runtime:** prevent ref callbacks from being called too early
([#&#8203;5614](https://togithub.com/ionic-team/stencil/issues/5614))

([81fa375](https://togithub.com/ionic-team/stencil/commit/81fa37587eb853d42bc7f92102318a3446cdea7b)),
closes
[#&#8203;4074](https://togithub.com/ionic-team/stencil/issues/4074)

###

[`v4.14.1`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4141-2024-04-04)

[Compare

Source](https://togithub.com/ionic-team/stencil/compare/v4.14.0...v4.14.1)

##### Bug Fixes

- **compiler:** don't mistake aliased paths for collections imports
([#&#8203;5620](https://togithub.com/ionic-team/stencil/issues/5620))

([af22bb8](https://togithub.com/ionic-team/stencil/commit/af22bb858d64b60a97ce93c86f5585ef36b31c3f)),
closes
[#&#8203;2319](https://togithub.com/ionic-team/stencil/issues/2319)
- **runtime:** nested multiple default slot relocation
([#&#8203;5403](https://togithub.com/ionic-team/stencil/issues/5403))

([363c07b](https://togithub.com/ionic-team/stencil/commit/363c07b4723941954dc748189a744eec01d5b74c)),
partially closes
[#&#8203;5335](https://togithub.com/ionic-team/stencil/issues/5335)
- **runtime:** prevent ref callbacks from being called too early
([#&#8203;5614](https://togithub.com/ionic-team/stencil/issues/5614))

([81fa375](https://togithub.com/ionic-team/stencil/commit/81fa37587eb853d42bc7f92102318a3446cdea7b)),
closes
[#&#8203;4074](https://togithub.com/ionic-team/stencil/issues/4074)

###

[`v4.14.0`](https://togithub.com/ionic-team/stencil/blob/HEAD/CHANGELOG.md#-4140-2024-04-01)

[Compare

Source](https://togithub.com/ionic-team/stencil/compare/v4.13.0...v4.14.0)

##### Bug Fixes

- **mock-doc:** provide a local name
([#&#8203;5480](https://togithub.com/ionic-team/stencil/issues/5480))

([2f67b35](https://togithub.com/ionic-team/stencil/commit/2f67b3526c7160a0c9ac71727c401a438d282474)),
closes
[#&#8203;5342](https://togithub.com/ionic-team/stencil/issues/5342)
- **mock-doc:** resolve type issue for localName
([#&#8203;5595](https://togithub.com/ionic-team/stencil/issues/5595))

([d91af87](https://togithub.com/ionic-team/stencil/commit/d91af87d4e309a2da3cb145165cf7fe3c79ac1e7)),
closes
[#&#8203;5342](https://togithub.com/ionic-team/stencil/issues/5342)

##### Features

- **testing:** allow to set screenshot timeout option in Jest v28+
([#&#8203;5537](https://togithub.com/ionic-team/stencil/issues/5537))

([6df12b2](https://togithub.com/ionic-team/stencil/commit/6df12b2a445ffe431f8412758f298a6e1c8fe3ac))
- **testing:** support deep piercing with Puppeteer
([#&#8203;5481](https://togithub.com/ionic-team/stencil/issues/5481))

([13d5d41](https://togithub.com/ionic-team/stencil/commit/13d5d4188ac0d3d8d002ce93c4ec7abdde5c8086))
- **typescript:** Update dependency typescript to v5.4.3
([#&#8203;5588](https://togithub.com/ionic-team/stencil/issues/5588))

([9d489e4](https://togithub.com/ionic-team/stencil/commit/9d489e42a60391d2eb88cb0f7827a9368de18140))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 5am every weekday" in timezone
America/Los_Angeles, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Esri/calcite-design-system).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI5My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Ben Elan <no-reply@benelan.dev>
Co-authored-by: JC Franco <jfranco@esri.com>
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: E2EPage.find() throws error when using piercing selector targeting a non-existing element
4 participants