Skip to content

Confused about cleanup #205

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.

Sign up for GitHub

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

Jump to bottom
Closed
vrde opened this issue Sep 1, 2022 · 2 comments · Fixed by #207
Closed

Confused about cleanup #205

vrde opened this issue Sep 1, 2022 · 2 comments · Fixed by #207
Labels
released

Comments

@vrde
Copy link

vrde commented Sep 1, 2022

👋 I just started learning testing-library, I really like it so far!

I don't understand how cleanup works, from the docs:

Unmounts the component from the container and destroys the container.

My expectation is that tests are isolated, so if I render a component in a test, that component is destroyed (cleaned up?) at the end of the test. But I see a different behavior.

Comp.svelte

<script lang="ts">
  export let name: string;

  let buttonText = "Button";

  function handleClick() {
    buttonText = "Button Clicked";
  }
</script>

<h1>Hello {name}!</h1>

<button on:click={handleClick}>{buttonText}</button>

comp.test.ts

import "@testing-library/jest-dom";
import { render, fireEvent, screen } from "@testing-library/svelte";
import Comp from "../Comp.svelte";

test("shows proper heading when rendered", () => {
  render(Comp, { name: "World" });
  const heading = screen.getByText("Hello World!");
  expect(heading).toBeInTheDocument();

  render(Comp, { name: "There" });
});

// Note: This is as an async test as we are using `fireEvent`
test("changes button text on click", async () => {
  render(Comp, { name: "World" });
  const button = screen.getByRole("button");

  // Using await when firing events is unique to the svelte testing library because
  // we have to wait for the next `tick` so that Svelte flushes all pending state changes.
  await fireEvent.click(button);

  expect(button).toHaveTextContent("Button Clicked");
});

The test suite fails with the following message:

 FAIL  src/tests/something.test.ts > changes button text on click
TestingLibraryElementError: Found multiple elements with the role "button"

Here are the matching elements:

Ignored nodes: comments, script, style
<button>
  Button
</button>

Ignored nodes: comments, script, style
<button>
  Button
</button>

(If this is intentional, then use the `*AllBy*` variant of the query (like `queryAllByText`, `getAllByText`, or `findAllByText`)).

Ignored nodes: comments, script, style
<body>
  <div>
    <h1>
      Hello 
      World
      !
    </h1>
     
    <button>
      Button
    </button>
  </div>
  <div>
    <h1>
      Hello 
      World
      !
    </h1>
     
    <button>
      Button
    </button>
  </div>
</body>
 ❯ Object.getElementError node_modules/.pnpm/@[email protected]/node_modules/@testing-library/dom/dist/config.js:40:19
 ❯ getElementError node_modules/.pnpm/@[email protected]/node_modules/@testing-library/dom/dist/query-helpers.js:25:35
 ❯ getMultipleElementsFoundError node_modules/.pnpm/@[email protected]/node_modules/@testing-library/dom/dist/query-helpers.js:29:10
 ❯ node_modules/.pnpm/@[email protected]/node_modules/@testing-library/dom/dist/query-helpers.js:66:13
 ❯ node_modules/.pnpm/@[email protected]/node_modules/@testing-library/dom/dist/query-helpers.js:111:19
 ❯ src/tests/something.test.ts:28:24
     26| test("changes button text on click", async () => {
     27|   render(Comp, { name: "World" });
     28|   const button = screen.getByRole("button");
       |                        ^
     29| 
     30|   // Using await when firing events is unique to the svelte testing library because


Test Files  1 failed (1)
     Tests  1 failed | 2 passed (3)
  Start at  19:37:41
  Duration  822ms

As far as I understand, the components in the first test are still in the DOM. I tried to manually call cleanup but I got the same result. I also don't see Hello There.

What am I doing wrong?
@yanick
Copy link
Collaborator

yanick commented Sep 5, 2022

I think I know what is going on.

In your first test, you render two components. And if I understand how the cache that gets cleared after a test works, it expects only one and -- when you actually render twice -- the second render clobbers the entry of the first in the cache, resulting in it not being cleared. Hence the leftover button that messed up test number 2.

I think I know how to solve this. Hopefully a patch will come something during the week.

yanick added a commit that referenced this issue Sep 6, 2022
@yanick
cache many components per container
cd43dfd 
The way the cache was set up, we could only have one render
element per test. Which, mind you, is the most common use-case,
but it can create surprises.

Fixes #205
@yanick yanick mentioned this issue Sep 6, 2022
Merged
yanick added a commit that referenced this issue Sep 6, 2022
@yanick
fix: cache many components per container
facb45f 
The way the cache was set up, we could only have one render
element per test. Which, mind you, is the most common use-case,
but it can create surprises.

Fixes #205
@yanick yanick closed this as completed in 373a666 Oct 6, 2022
@github-actions
Copy link

github-actions bot commented Oct 6, 2022

🎉 This issue has been resolved in version 3.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: cache many components per container testing-library/svelte-testing-library
2 participants
@yanick @vrde