Dom-testing-library: getByTitle finds any element text?

[awesomeunleashed]

• @testing-library/dom version: 7.22.2
• Testing Framework and version: Jest 26.0.10
• DOM Environment: jsdom 11.12.0

Relevant code or config:

// component
export default () => <div title="WrongTitle">HelloWorld</div>;

// test
const wantTitle = "HelloWorld";
const { getByTitle } = render(<Hello />);

// I would expect this to fail here
expect(getByTitle(wantTitle)).toBeInTheDocument();

// ...but it fails here
expect(getByTitle(wantTitle).title).toBe(wantTitle);

What you did:

I have a React component with some text, and a title attribute that matches that text. I was modifying the component (and tests) to have a different title (but the same text) when I disabled it.

What happened:

I started getting unexpected behavior from my tests because they were expecting the title to have changed, and getByTitle was finding the element text.

Reproduction:

CodeSandbox

Problem description:

Maybe I'm missing something, but it seems very unintuitive that this line:
expect(getByTitle(wantTitle).title).toBe(wantTitle)
can fail on the toBe. If it's going to fail, shouldn't it fail on the getByTitle?

Suggested solution:

Looking at queries/title.js, I see this part:

return Array.from(container.querySelectorAll('[title], svg > title')).filter(
    node =>
      matcher(node.getAttribute('title'), node, text, matchNormalizer) ||
      matcher(getNodeText(node), node, text, matchNormalizer),
  )

I assume the matcher(getNodeText(node) part is intended for svg title elements, which makes sense, but it looks to me like this will find the text for any element. Forcing that second condition to only be true for title elements would solve it, I think.

[kentcdodds]

Hi @awesomeunleashed,

You found a bug! 🐛 Thanks. I think that you're right, we should probably scope that second part to only apply to svg > title elements. Would you like to work on fixing this?

[awesomeunleashed]

I can certainly make an attempt at it when I get the time.

[nersoh]

I can give it a try if you guys need help.

[kentcdodds]

Anyone is welcome to work on this. Just post in here when you start working on it so we don't have multiple people working on it at once :)

[wyze]

I did the initial implementation, and I got a PR ready to go on this.

[kentcdodds]

:tada: This issue has been resolved in version 7.22.6 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket:

[awesomeunleashed]

Thanks folks, looks like it works as expected now!