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

React: Force act running always in sequence #30191

Merged
merged 4 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions code/renderers/react/src/__test__/portable-stories.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ describe('renders', () => {
});

it('should throw error when rendering a component with a render error', async () => {
await expect(() => ThrowsError.run()).rejects.toThrowError('Error in render');
await expect(ThrowsError.run()).rejects.toThrowError('Error in render');
});

it('should render component mounted in play function', async () => {
Expand All @@ -77,8 +77,8 @@ describe('renders', () => {
expect(screen.getByTestId('loaded-data').textContent).toEqual('loaded data');
});

it('should throw an error in play function', () => {
expect(() => MountInPlayFunctionThrow.run()).rejects.toThrowError('Error thrown in play');
it('should throw an error in play function', async () => {
await expect(MountInPlayFunctionThrow.run()).rejects.toThrowError('Error thrown in play');
});

it('should call and compose loaders data', async () => {
Expand Down
31 changes: 29 additions & 2 deletions code/renderers/react/src/renderToCanvas.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,23 @@ class ErrorBoundary extends ReactComponent<{

const Wrapper = FRAMEWORK_OPTIONS?.strictMode ? StrictMode : Fragment;

const actQueue: (() => Promise<void>)[] = [];
let isActing = false;

const processActQueue = async () => {
if (isActing || actQueue.length === 0) {
return;
}

isActing = true;
const actTask = actQueue.shift();
if (actTask) {
await actTask();
}
isActing = false;
processActQueue();
};

export async function renderToCanvas(
{
storyContext,
Expand Down Expand Up @@ -81,8 +98,18 @@ export async function renderToCanvas(
unmountElement(canvasElement);
}

await act(async () => {
await renderElement(element, canvasElement, storyContext?.parameters?.react?.rootOptions);
await new Promise<void>(async (resolve, reject) => {
actQueue.push(async () => {
try {
await act(async () => {
await renderElement(element, canvasElement, storyContext?.parameters?.react?.rootOptions);
});
resolve();
} catch (e) {
reject(e);
}
});
processActQueue();
});

return async () => {
Expand Down
Loading