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.

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

Prevent errors in React components from crashing the dev server #4816

Merged
merged 3 commits into from
Sep 20, 2022
Merged

Prevent errors in React components from crashing the dev server #4816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0987f40
Prevent errors in React components from crashing the dev server
matthewp Sep 20, 2022
42f5b24
Add a changeset
matthewp Sep 20, 2022
5823b6d
Fix test when running in the build
matthewp Sep 20, 2022
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
5 changes: 5 additions & 0 deletions .changeset/tricky-walls-walk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/react': patch
---

Prevent errors in React components from crashing the dev server
7 changes: 7 additions & 0 deletions packages/astro/test/fixtures/react-component/src/components/ImportsThrowsAnError.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import ThrowsAnError from "./ThrowsAnError";

export default function() {
return <>
<ThrowsAnError />
</>
}
15 changes: 15 additions & 0 deletions packages/astro/test/fixtures/react-component/src/components/ThrowsAnError.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { useState } from 'react';

export default function() {
let player = undefined;
// This is tested in dev mode, so make it work during the build to prevent
// breaking other tests.
if(import.meta.env.MODE === 'production') {
player = {};
}
const [] = useState(player.currentTime || null);

return (
<div>Should have thrown</div>
)
}
11 changes: 11 additions & 0 deletions packages/astro/test/fixtures/react-component/src/pages/error-rendering.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
import ImportsThrowsAnError from '../components/ImportsThrowsAnError';
---
<html>
<head>
<title>Testing</title>
</head>
<body>
<ImportsThrowsAnError />
</body>
</html>
6 changes: 6 additions & 0 deletions packages/astro/test/react-component.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ describe('React Components', () => {
if (isWindows) return;

describe('dev', () => {
/** @type {import('./test-utils').Fixture} */
let devServer;

before(async () => {
Expand Down Expand Up @@ -145,5 +146,10 @@ describe('React Components', () => {
// test 1: react/jsx-runtime is used for the component
expect(jsxRuntime).to.be.ok;
});

it('When a nested component throws it does not crash the server', async () => {
const res = await fixture.fetch('/error-rendering');
await res.arrayBuffer();
});
});
});
5 changes: 4 additions & 1 deletion packages/integrations/react/server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,11 @@ async function renderToPipeableStreamAsync(vnode) {
async function renderToStaticNodeStreamAsync(vnode) {
const Writable = await getNodeWritable();
let html = '';
return new Promise((resolve) => {
return new Promise((resolve, reject) => {
let stream = ReactDOM.renderToStaticNodeStream(vnode);
stream.on('error', err => {
reject(err);
});
stream.pipe(
new Writable({
write(chunk, _encoding, callback) {
Expand Down