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

Fix: catch and report config errors from handleConfigError (#7316)

Browse source 
* fix: catch and report config errors from `handleConfigError`

* chore: changeset
This commit is contained in:
Ben Holmes 2023-06-07 09:59:20 -04:00 committed by GitHub
parent 9c525d3f11
commit e6bff651ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/large-keys-peel.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Fix Zod errors getting flagged as configuration errors

25
packages/astro/src/cli/index.ts
View file

@ -3,7 +3,7 @@ import fs from 'fs';
import * as colors from 'kleur/colors'; import * as colors from 'kleur/colors';
import type { Arguments as Flags } from 'yargs-parser'; import type { Arguments as Flags } from 'yargs-parser';
import yargs from 'yargs-parser'; import yargs from 'yargs-parser';
import { z } from 'zod'; import { ZodError } from 'zod';
import { import {
createSettings, createSettings,
openConfig, openConfig,
@ -94,15 +94,19 @@ function resolveCommand(flags: Arguments): CLICommand {
async function handleConfigError( async function handleConfigError(
e: any, e: any,
{ cwd, flags, logging }: { cwd?: string; flags?: Flags; logging: LogOptions } { cmd, cwd, flags, logging }: { cmd: string; cwd?: string; flags?: Flags; logging: LogOptions }
) { ) {
const path = await resolveConfigPath({ cwd, flags, fs }); const path = await resolveConfigPath({ cwd, flags, fs });
if (e instanceof Error) { error(logging, 'astro', `Unable to load ${path ? colors.bold(path) : 'your Astro config'}\n`);
if (path) { if (e instanceof ZodError) {
error(logging, 'astro', `Unable to load ${colors.bold(path)}\n`); console.error(formatConfigErrorMessage(e) + '\n');
} } else if (e instanceof Error) {
console.error(formatErrorMessage(collectErrorMetadata(e)) + '\n'); console.error(formatErrorMessage(collectErrorMetadata(e)) + '\n');
} }
const telemetryPromise = telemetry.record(eventConfigError({ cmd, err: e, isFatal: true }));
await telemetryPromise.catch((err2: Error) =>
debug('telemetry', `record() error: ${err2.message}`)
);
} }
/** /**
@ -181,7 +185,7 @@ async function runCommand(cmd: string, flags: yargs.Arguments) {
cmd, cmd,
logging, logging,
}).catch(async (e) => { }).catch(async (e) => {
await handleConfigError(e, { cwd: root, flags, logging }); await handleConfigError(e, { cmd, cwd: root, flags, logging });
return {} as any; return {} as any;
}); });
if (!initialAstroConfig) return; if (!initialAstroConfig) return;
@ -207,7 +211,7 @@ async function runCommand(cmd: string, flags: yargs.Arguments) {
logging, logging,
telemetry, telemetry,
handleConfigError(e) { handleConfigError(e) {
handleConfigError(e, { cwd: root, flags, logging }); handleConfigError(e, { cmd, cwd: root, flags, logging });
info(logging, 'astro', 'Continuing with previous valid configuration\n'); info(logging, 'astro', 'Continuing with previous valid configuration\n');
}, },
}); });
@ -284,14 +288,9 @@ async function throwAndExit(cmd: string, err: unknown) {
process.exit(1); process.exit(1);
} }
if (err instanceof z.ZodError) {
telemetryPromise = telemetry.record(eventConfigError({ cmd, err, isFatal: true }));
errorMessage = formatConfigErrorMessage(err);
} else {
const errorWithMetadata = collectErrorMetadata(createSafeError(err)); const errorWithMetadata = collectErrorMetadata(createSafeError(err));
telemetryPromise = telemetry.record(eventError({ cmd, err: errorWithMetadata, isFatal: true })); telemetryPromise = telemetry.record(eventError({ cmd, err: errorWithMetadata, isFatal: true }));
errorMessage = formatErrorMessage(errorWithMetadata); errorMessage = formatErrorMessage(errorWithMetadata);
}
// Timeout the error reporter (very short) because the user is waiting. // Timeout the error reporter (very short) because the user is waiting.
// NOTE(fks): It is better that we miss some events vs. holding too long. // NOTE(fks): It is better that we miss some events vs. holding too long.