No rows returned by useVirtualizer in unit tests
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- react, typescript
- Domain
- frontend, testing-qa
Research direction
Start by running the provided React unit test and comparing behavior between v3.0.0-beta.62 and v3.0.1. Inspect the useVirtualizer path and the changes referenced in pull request #598; done means getVirtualItems() contains the expected rows and the test renders both names.
Written by the indexing model from the issue text.
Description
Describe the bug
In browser table rows are rendered as expected. In unit tests useVirtualizer returns an empty array from rowVirtualizer.getVirtualItems(). The bug is introduce with changes introduced by v3.0.0-beta.63. It also exists in the latest release v3.0.1
I think it was introduced by #598 here
Your minimal, reproducible example
below
Steps to reproduce
This unit test will pass for v3.0.0-beta.62 and fail for any version there after.
import { useVirtualizer } from "@tanstack/react-virtual";
import { render, screen } from "@testing-library/react";
import { styled } from "@mui/material";
import { useCallback, useRef } from "react";
const items = [
{ id: 1, name: "foo" },
{ id: 2, name: "bar" },
];
const Parent = styled("div")({ height: "100%", width: "100%", overflow: "auto" });
const Inner = styled("div")({ width: "100%", position: "relative" });
const Row = styled("div")({ position: "absolute", top: 0, left: 0, width: "100%" });
function VirtualTableComponent() {
const parentRef = useRef<HTMLDivElement>(null);
const rowVirtualizer = useVirtualizer({
count: items.length,
getScrollElement: () => parentRef.current,
estimateSize: useCallback(() => 56, []),
});
return (
<Parent ref={parentRef}>
<Inner sx={{ height: `${rowVirtualizer.getTotalSize()}px` }}> {/* set at 112px as expected */}
{rowVirtualizer.getVirtualItems().map((virtualRow) => ( // always an empty array
<Row
key={virtualRow.index}
data-index={virtualRow.index}
ref={rowVirtualizer.measureElement}
style={{ transform: `translateY(${virtualRow.start}px)` }}
>
<div>{items[virtualRow.index].name}</div>
</Row>
))}
</Inner>
</Parent>
);
}
describe("@tanstack/react-virtual", () => {
it("renders rows", () => {
render(<VirtualTableComponent />);
expect(screen.getByText(items[0].name)).toBeInTheDocument();
expect(screen.getByText(items[1].name)).toBeInTheDocument();
});
});
Expected behavior
As a user I expect the provided unit test to pass but it fails.
How often does this bug happen?
Every time
Screenshots or Videos
No response
Platform
macOS
tanstack-virtual version
v3.0.1
TypeScript version
v4.9.5
Additional context
I've console.log'd out the value of rowVirtualizer.getTotalSize() and it is given 112 as expected
Terms & Code of Conduct
- I agree to follow this project's Code of Conduct
- I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.
- Dominant language
- TypeScript
- Stars
- 7.2k
- Forks
- 495
- Avg merge
- 23h 16m
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from TanStack/virtual
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
With `useScrollendEvent`, scrollToIndex and scrollToEnd stop short when the target moves while they settlePossibly taken @Darkatse claimed this 8 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
svelte-virtual renders no rows when the scroll element is bound after the store subscribesPossibly taken @clean99 claimed this 13 days ago. Open
Difficulty 4/5 1-2 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
anchorTo: 'end' does not keep the reading position when only paddingStart changesPossibly taken @duongynhi000001-crypto claimed this 12 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 30/100
Maintainers usually reply within 1 day
-
anchorTo: 'end' loses the end when the scroll element shrinksPossibly taken @langleyd claimed this 41 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Maintainers usually reply within 1 day
All issues in TanStack/virtual
Similar issues
-
Difficulty 1/5 1-3 hours Newbie friendliness 83/100
gofish-graphics/gofish-graphics#1384 ·
Maintainers usually reply within 1 day
-
adapter bug
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
Olanetsoft/agent-lookout#353 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
vicharanashala/vibe#1542 ·
Maintainers usually reply within 1 day
-
bug chore P2 size:XS
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
josephfung/curia#2666 ·
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
devarshishimpi/codra#178 ·
Maintainers usually reply within 1 day