react-testing-library When `container` is `document`, cleanup steps fails with "TypeError: Cannot read properties of null (reading 'removeChild')"

Just opening this for tracking with the associated PR: #1330 .

When:

render(<Component />, { container: document });

(Untested: This bug may require that Component render a <body> element.)

Then:

TypeError: Cannot read properties of null (reading 'removeChild')

Because:

// pure.js
    if (container.parentNode === document.body) {
      document.body.removeChild(container);
    }

If we first check that document.body is not null, then this error will not occur.

May 20 '24 20:05 quisido

@quisido Can you please add a reproduction for this? As long as a document exists, JSDOM implicitly creates document.body for you.

May 22 '24 08:05 MatanBobi

@quisido Can you please add a reproduction for this? As long as a document exists, JSDOM implicitly creates document.body for you.

Are you unable to reproduce it? I've hit this in two separate projects just by setting container to document.

As far as I'm aware, using container: document in any existing test is the only step required to reproduce this.

May 22 '24 08:05 quisido

Two points here:

We do not have the capacity to try and reproduce every issue that's raised in this repo, that's why we ask people who create issues to provide a cloneable reproduction.
When testing layout components was raised here, I created a solution and It doesn't reproduce there: https://stackblitz.com/edit/rtl-template-68mwxh?file=src%2FApp.test.tsx

May 22 '24 08:05 MatanBobi

@MatanBobi Running into same issue as described here. Here is reproducible example (clone from your StackBlitz but switched from vitest to jest): https://stackblitz.com/edit/stackblitz-starters-3sze3m?file=app%2Flayout.spec.tsx

Oct 10 '24 13:10 m-zuro

@m-zuro Thanks. In the reproduction you've attached here, the test isn't passing:

● Test Suite › Test

Expected value   undefined
Received:
  undefined

Message:
  Unable to find an element with the text: Test. This could be because the text is broken up by multiple elements. In this case, you can provide a function for your text matcher to make your matcher more flexible.

Ignored nodes: comments, script, style
<body />

So I think there's a misconfiguration there.

Oct 10 '24 13:10 MatanBobi

@MatanBobi sorry, copy/paste job. Updated now, can you re try pls?

● Test Suite › Test

Expected value   undefined

  Received:
    undefined
  
  Message:
    null is not an object (evaluating 'document.body.removeChild')

Oct 10 '24 13:10 m-zuro

Sorry it took me a while @m-zuro. This error is odd to me, the only place we're calling document.body.removeChild is after this if statement:

container.parentNode === document.body

When I run this test locally in our repo, it passes. I'm trying to understand if there's anything different here.

Dec 07 '24 20:12 MatanBobi