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

Improve/create documentation for ReactTestUtils.renderIntoDocument() #28

Open
bvaughn opened this issue Oct 6, 2017 · 1 comment
Open

Comments

@bvaughn
Copy link
Contributor

bvaughn commented Oct 6, 2017

This issue was originally reported by @the-spyke via facebook/react/issues/10330

There is almost none documentation about how to actually use .renderIntoDocument() method. I can't find find answers on those questions on Jest's website or enzyme's (I know that it's not Facebook) either.

  • If I render a component into a DOM in a test, how will it be destroyed?
  • Should I clean up by myself?
  • What tools to use for this?
  • Just .unmountComponentAtNode()?
  • Where I will get the container to pass in?
  • What about additional component trees like in Popovers?
  • What are the best ways to test that there aren't any parts left after my component were unmounted?

It will be nice to see such information before people will met memory leaks in their tests, and also help to establish good practices for writing tests.

Additional notes:

  • Calling .renderIntoDocument() returns you an instance
  • This instance was rendered into freshly created DOM element, which now represents a detached tree
  • There's also a reference to the instance in ReactDOM's internal map
  • So, even if you remove all your references to this instance, on every call to .renderIntoDocument() you will get 1 detached tree hanging in memory + 1 instance of a React component with all its props not available for garbage collection
jhonmike pushed a commit to jhonmike/reactjs.org that referenced this issue Jul 1, 2020
* Add pt-BR translation to the special-props page

* Fix typos

* Update content/warnings/special-props.md

Co-Authored-By: andrescalco <andre@andrescalco.com>

* Update special-props.md

* Add small changes

* Add small changes

* Update content/warnings/special-props.md

Co-Authored-By: andrescalco <andre@andrescalco.com>
@Rishabhraghwendra18
Copy link

@bvaughn is this issue open ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants