feat: support async act#10
Conversation
| }) | ||
|
|
||
| test('renders a suspended component', async () => { | ||
| const { getByText } = await render(<HelloWorld name="Vitest" />, { |
There was a problem hiding this comment.
This component won't trigger the suspense boundary since it doesn't throw a promise / use. Testing this behavior will need a specific component implementation. A positive assertion of the suspense boundary being present should help ensure the test is valid.
If React 19 isn't ready to be used in this project yet, maybe something like this?
test('renders a suspended component', async () => {
let resolve: (() => void) | undefined = undefined;
const promise = new Promise((res) => {
resolve = res;
});
function TestComponent() {
throw promise;
return <div>Hello world</div>;
}
const { getByText } = await render(<TestComponent />, ... );
await expect.element(getByText('Suspended!')).toBeInTheDocument();
resolve?.();
await expect.element(getByText('Hello world')).toBeInTheDocument();I think React somehow resumes execution if the thrown promise is already resolved, but if not a boolean flag could be added to gate the throw.
There was a problem hiding this comment.
Thanks for the feedback.
Two things:
- AFAIU, what we're trying to see here is that we're not seeing the
Suspensefallback and it has already flushed as part of mounting (that's why we're wrapping therenderfunction). The use case you're mentioning should be covered by the asynchronous nature of the locators. This test is from a reproduction in the issue attached :) I'll rename the test case to make that clear. - The change in this PR is still wanted even if it doesn't satisfy suspended components.
actshould be awaited and the sync version ofactwill be deprecated at some point (per theactdocs).
There was a problem hiding this comment.
If you're referring to #10, that was my reproduction! My point is mainly that if the component doesn't actually suspend, the boundary will not have been rendered in the first place. I have tested non-suspending components wrapped in suspense boundaries and they work without problems as-is; it's only suspending components which present an issue.
You'll see in the reproduction that the HelloWorld component implementation was altered to suspend via use of a promise: https://github.com/a-type/vitest-browser-react-suspense-repro/blob/main/vitest-example/HelloWorld.tsx#L14
That said, I only wanted to point out that the test wasn't verifying the behavior in question. I don't have an opinion on whether a test is necessary for that behavior, and I'm not a contributor / maintainer anyway!
There was a problem hiding this comment.
Thanks @a-type :) That's my bad, I totally missed the purpose of the test. Let me have a look and try to implement that.
That said, I only wanted to point out that the test wasn't verifying the behavior in question. I don't have an opinion on whether a test is necessary for that behavior, and I'm not a contributor / maintainer anyway!
Your point is valid and I try to take any comment seriously even if it's not from maintainers :)
There was a problem hiding this comment.
@a-type I pushed a fix though I'm hesitating a bit. I wasn't able to figure out yet if the suspense behavior is consistent. In some cases - React will not show the fallback and just show the content (it looks like that depends on how much time we suspend - as can be seen in the failure in CI. If we extend the timeout - the test will pass). I'm trying to figure that out but I don't have a lot of free time right now :)
There was a problem hiding this comment.
Yeah, timeout works but isn't ideal for testing. I'd recommend either using fake timers, or a 'gate' boolean that is flipped on the first render and resolves the second one.
Do you want me to contribute here? I have a lot of experience working with Suspense as a library author.
There was a problem hiding this comment.
Feel free :)
I didn't fix this yet as I wanted to get a clear answer from the React team on what's the threshold for client side suspense to present the fallback.
I was aiming to use fake timers, just didn't want to guess the number and have it break in next react releases.
|
Any news on this? |
|
Sorry @sheremet-va, got busy with some other stuff. Closing this as I see someone else followed up :) |
Resolves #9
Still need to add a test for a suspended component, will work on it soon.Test added.