michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Validate Astro frontmatter JS/TS on compiler error (#2115)

Browse source 
* validate the astro component frontmatter ahead of compilation

* add test, update existing tests

* chore(lint): Prettier fix

* Update index.ts

* remove macos skip lines, no longer needed

Co-authored-by: GitHub Action <github-action@users.noreply.github.com>
This commit is contained in:
Fred K. Schott 2021-12-07 08:18:41 -08:00 committed by GitHub
parent 317c62a247
commit 0ef682c924
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 45 additions and 111 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/dirty-guests-wash.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Improve error message on bad JS/TS frontmatter

26
packages/astro/src/vite-plugin-astro/index.ts
View file

@ -10,6 +10,7 @@ import { transform } from '@astrojs/compiler';
import { AstroDevServer } from '../core/dev/index.js';
import { getViteTransform, TransformHook, transformWithVite } from './styles.js';
const FRONTMATTER_PARSE_REGEXP = /^\-\-\-(.*)^\-\-\-/ms;
interface AstroPluginOptions {
config: AstroConfig;
devServer?: AstroDevServer;
@ -87,7 +88,8 @@ export default function astro({ config, devServer }: AstroPluginOptions): vite.P
// throw CSS transform errors here if encountered
if (cssTransformError) throw cssTransformError;
// Compile `.ts` to `.js`
// Compile all TypeScript to JavaScript.
// Also, catches invalid JS/TS in the compiled output before returning.
const { code, map } = await esbuild.transform(tsResult.code, { loader: 'ts', sourcemap: 'external', sourcefile: id });
return {
@ -95,6 +97,28 @@ export default function astro({ config, devServer }: AstroPluginOptions): vite.P
map,
};
} catch (err: any) {
// Verify frontmatter: a common reason that this plugin fails is that
// the user provided invalid JS/TS in the component frontmatter.
// If the frontmatter is invalid, the `err` object may be a compiler
// panic or some other vague/confusing compiled error message.
//
// Before throwing, it is better to verify the frontmatter here, and
// let esbuild throw a more specific exception if the code is invalid.
// If frontmatter is valid or cannot be parsed, then continue.
const scannedFrontmatter = FRONTMATTER_PARSE_REGEXP.exec(source);
if (scannedFrontmatter) {
try {
await esbuild.transform(scannedFrontmatter[1], { loader: 'ts', sourcemap: false, sourcefile: id });
} catch (frontmatterErr: any) {
// Improve the error by replacing the phrase "unexpected end of file"
// with "unexpected end of frontmatter" in the esbuild error message.
if (frontmatterErr && frontmatterErr.message) {
frontmatterErr.message = frontmatterErr.message.replace('end of file', 'end of frontmatter');
}
throw frontmatterErr;
}
}
// improve compiler errors
if (err.stack.includes('wasm-function')) {
const search = new URLSearchParams({

121
packages/astro/test/errors.test.js
View file

@ -1,10 +1,6 @@
import { expect } from 'chai';
import os from 'os';
import { loadFixture } from './test-utils.js';
// TODO: fix these tests on macOS
const isMacOS = os.platform() === 'darwin';
let fixture;
let devServer;
@ -21,90 +17,56 @@ before(async () => {
describe('Error display', () => {
describe('Astro', () => {
// This test is redundant w/ runtime error since it no longer produces an Astro syntax error
it.skip('syntax error', async () => {
if (isMacOS) return;
it('syntax error in template', async () => {
const res = await fixture.fetch('/astro-syntax-error');
// 500 returned
expect(res.status).to.equal(500);
// error message includes "unrecoverable error"
const body = await res.text();
console.log(res.body);
expect(body).to.include('unrecoverable error');
expect(body).to.include('Unexpected &quot;}&quot;');
});
it('syntax error in frontmatter', async () => {
const res = await fixture.fetch('/astro-frontmatter-syntax-error');
expect(res.status).to.equal(500);
const body = await res.text();
console.log(res.body);
expect(body).to.include('Unexpected end of frontmatter');
});
it('runtime error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/astro-runtime-error');
// 500 returned
expect(res.status).to.equal(500);
// error message contains error
const body = await res.text();
expect(body).to.include('ReferenceError: title is not defined');
// TODO: improve stacktrace
// TODO: improve and test stacktrace
});
it('hydration error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/astro-hydration-error');
// 500 returned
expect(res.status).to.equal(500);
// error message contains error
const body = await res.text();
// error message contains error
expect(body).to.include('Error: invalid hydration directive');
});
it('client:media error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/astro-client-media-error');
// 500 returned
expect(res.status).to.equal(500);
// error message contains error
const body = await res.text();
// error message contains error
expect(body).to.include('Error: Media query must be provided');
});
});
describe('JS', () => {
it('syntax error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/js-syntax-error');
// 500 returnd
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Parse failure');
});
it('runtime error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/js-runtime-error');
// 500 returnd
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('ReferenceError: undefinedvar is not defined');
});
@ -112,27 +74,15 @@ describe('Error display', () => {
describe('Preact', () => {
it('syntax error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/preact-syntax-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Syntax error');
});
it('runtime error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/preact-runtime-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Error: PreactRuntimeError');
});
@ -140,27 +90,15 @@ describe('Error display', () => {
describe('React', () => {
it('syntax error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/react-syntax-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Syntax error');
});
it('runtime error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/react-runtime-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Error: ReactRuntimeError');
});
@ -168,27 +106,15 @@ describe('Error display', () => {
describe('Solid', () => {
it('syntax error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/solid-syntax-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Syntax error');
});
it('runtime error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/solid-runtime-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Error: SolidRuntimeError');
});
@ -196,27 +122,15 @@ describe('Error display', () => {
describe('Svelte', () => {
it('syntax error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/svelte-syntax-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('ParseError');
});
it('runtime error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/svelte-runtime-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.include('Error: SvelteRuntimeError');
});
@ -224,28 +138,15 @@ describe('Error display', () => {
describe('Vue', () => {
it('syntax error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/vue-syntax-error');
const body = await res.text();
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
expect(body).to.include('Parse failure');
});
it('runtime error', async () => {
if (isMacOS) return;
const res = await fixture.fetch('/vue-runtime-error');
// 500 returned
expect(res.status).to.equal(500);
// error message is helpful
const body = await res.text();
expect(body).to.match(/Cannot read.*undefined/); // note: error differs slightly between Node versions
});

4
packages/astro/test/fixtures/errors/src/pages/astro-frontmatter-syntax-error.astro vendored Normal file
View file

@ -0,0 +1,4 @@
---
{
---
<h1>Testing bad JS in frontmatter</h1>