testing-library / react-testing-library

🐐 Simple and complete React DOM testing utilities that encourage good testing practices.
https://testing-library.com/react
MIT License
18.84k stars 1.09k forks source link

When `container` is `document`, cleanup steps fails with "TypeError: Cannot read properties of null (reading 'removeChild')" #1329

Open quisido opened 2 months ago

quisido commented 2 months ago

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.

MatanBobi commented 1 month ago

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

quisido commented 1 month ago

@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.

MatanBobi commented 1 month ago

Two points here:

  1. 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.
  2. 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