fix: Consider metadata elements as visible in waitForSelector
#37265
Conversation
This comment has been minimized.
This comment has been minimized.
Test results for "tests 1"1 failed 2 flaky46737 passed, 817 skipped Merge workflow run. |
|
What would be an accidental location of The point being that |
|
I'm mostly worried that the list of elements we deem "metadata" isn't the right one for some users. For example, should You're the first one to report this, so it's probably not a big issue outside of framework testing. Do we want to make the vast majority of Playwright users read through "Metadata elements are always considered visible"? The average reader is not asserting on their metadata elements because they don't work on a framework; but we still made them read and understand this new complexity. And it might throw them off while they're debugging something. So essentially it's a tradeoff between complexity beared by the average Playwright user, and complexity beared by framework authors like yourself. And since framework authors tend to have an excellent understanding of the DOM, we need to be especially mindful of the average Playwright user here. |
|
Closing per the comment above, looks like there is no consensus on this change. Feel free to file an issue if you disagree and we can continue the discussion there. |
Treats
<base>,<link>,<meta>,<script>,<style>and<title>as visible if attached inwaitForSelector(selector).The default of checking for visibility is generally desired. However, when selecting these metadata elements, you don't care about visibility since the user agent will never directly render the elements. You almost always just want to assert on their properties (text content of
<title>orvalueattributes in<meta>). E.g. in vercel/next.js we have to switch the asserted state toattachedwhenever we want to select metadata elements. This provides no additional clarity in the test. Worse, we had to adjust the selectors to make it clear thatstate: 'attached'is safe for this specific selector.Having to include
state: 'attached'for these elements is cumbersome since you have to double check that the selector is actually targeting a metadata element to not risk accidentally selecting elements that should render something but aren't visible.I excluded
<template>from this lists since that may be a footgun to assert on its contents and consider it "visible".