Skip to content

fix: error overlay message escape #12305

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

Merged
merged 5 commits into from
Nov 8, 2024
Merged

fix: error overlay message escape #12305

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d96080e
fix: error overlay message escape
florian-lefebvre Oct 25, 2024
a0350a6
fix: e2e test
florian-lefebvre Oct 28, 2024
9774933
fix: try enhancing directly when we emit the error
Princesseuh Nov 5, 2024
a2aa403
Discard changes to packages/astro/e2e/errors.test.js
florian-lefebvre Nov 5, 2024
f6dc9c2
Discard changes to packages/astro/src/core/errors/overlay.ts
florian-lefebvre Nov 5, 2024
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/breezy-plums-clap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Fixes a case where the error overlay would not escape the message
2 changes: 1 addition & 1 deletion packages/astro/e2e/errors.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ test.describe('Error display', () => {
await page.goto(astro.resolveUrl('/astro-syntax-error'), { waitUntil: 'networkidle' });

const message = (await getErrorOverlayContent(page)).message;
expect(message).toMatch('Unexpected "while"');
expect(message).toMatch('Unexpected "while"');

await Promise.all([
// Wait for page reload
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/core/errors/overlay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,10 @@ class ErrorOverlay extends HTMLElement {

this.text('#name', err.name);
this.text('#title', err.title);
this.text('#message-content', err.message, true);
// Only set as html if escaped. We're only sure it's escaped if name is part
// of the error, ie. we transformed it as we wanted.
// TODO: capture error at the source and transform it there
this.text('#message-content', err.message, 'name' in err);

const cause = this.root.querySelector<HTMLElement>('#cause');
if (cause && err.cause) {
Expand Down
Loading