feat: move astro config validation after astro:config:setup (#13482)

* feat: move astro config validation after astro:config:setup

* feat: superRefine

* fix: test

* feat: update test

* feat: update test

* fix: test

* feat: feedback

* feat: improve logging

* feat: refactor

* fix: no spread

* feat: split schemas

* chore: changeset

* Update packages/astro/src/core/config/schemas/README.md

Co-authored-by: Emanuele Stoppa <[email protected]>

* Update packages/astro/src/integrations/hooks.ts

* Update packages/astro/src/core/config/schemas/README.md

* Update .changeset/easy-vans-laugh.md

* Update .changeset/easy-vans-laugh.md

* grammar nit in changeset

---------

Co-authored-by: Emanuele Stoppa <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>

Co-authored-by: ematipico <[email protected]>
Co-authored-by: delucis <[email protected]>
Co-authored-by: sarah11918 <[email protected]>

Author: 4 people

.changeset/easy-vans-laugh.md

@@ -0,0 +1,9 @@
+---
+'astro': minor
+---
+
+Updates Astro config validation to also run for the Integration API. An error log will specify which integration is failing the validation.
+
+Now, Astro will first validate the user configuration, then validate the updated configuration after each integration `astro:config:setup` hook has run. This means `updateConfig()` calls will no longer accept invalid configuration.
+
+This fixes a situation where integrations could potentially update a project with a malformed configuration. These issues should now be caught and logged so that you can update your integration to only set valid configurations.

.changeset/three-masks-see.md

@@ -0,0 +1,7 @@
+---
+'astro': minor
+---
+
+Improves integrations error handling
+
+If an error is thrown from an integration hook, an error log will now provide information about the concerned integration and hook

packages/astro/src/container/index.ts

@@ -1,7 +1,7 @@
 import './polyfill.js';
 import { posix } from 'node:path';
 import { getDefaultClientDirectives } from '../core/client-directive/index.js';
-import { ASTRO_CONFIG_DEFAULTS } from '../core/config/schema.js';
+import { ASTRO_CONFIG_DEFAULTS } from '../core/config/schemas/index.js';
 import { validateConfig } from '../core/config/validate.js';
 import { createKey } from '../core/encryption.js';
 import { Logger } from '../core/logger/core.js';

packages/astro/src/core/build/index.ts

@@ -173,7 +173,7 @@ class AstroBuilder {
 
 	/** Run the build logic. build() is marked private because usage should go through ".run()" */
 	private async build({ viteConfig }: { viteConfig: vite.InlineConfig }) {
-		await runHookBuildStart({ config: this.settings.config, logging: this.logger });
+		await runHookBuildStart({ config: this.settings.config, logger: this.logger });
 		this.validateConfig();
 
 		this.logger.info('build', `output: ${blue('"' + this.settings.config.output + '"')}`);
@@ -248,7 +248,7 @@ class AstroBuilder {
 				.flat()
 				.map((pageData) => pageData.route)
 				.concat(hasServerIslands ? getServerIslandRouteData(this.settings.config) : []),
-			logging: this.logger,
+			logger: this.logger,
 		});
 
 		if (this.logger.level && levels[this.logger.level()] <= levels['info']) {

packages/astro/src/core/config/index.ts

@@ -6,6 +6,6 @@ export {
 } from './config.js';
 export { createNodeLogger } from './logging.js';
 export { mergeConfig } from './merge.js';
-export type { AstroConfigType } from './schema.js';
+export type { AstroConfigType } from './schemas/index.js';
 export { createSettings } from './settings.js';
 export { loadTSConfig, updateTSConfigForFramework } from './tsconfig.js';

packages/astro/src/core/config/schemas/README.md

@@ -0,0 +1,7 @@
+# Config schemas
+
+There are 3 zod schemas needed to validate the Astro config properly:
+
+- `AstroConfigSchema` (base): a schema that matches the `AstroConfig` type
+- `createRelativeSchema` (relative): a function that uses the base schema, and adds transformations relative to the project root. Transformations occur at runtime, and the paths are resolved against the `cwd` of the CLI.
+- `AstroConfigRefinedSchema` (refined): a schema that handles extra validations. Due to constraints imposed by the Astro architecture, refinements can't be done on the `AstroConfig` schema because integrations deal with the output of the `AstroConfig` schema. As a result, this schema runs after parsing the user config and after every integration `astro:config:setup` hook (to make sure `updateConfig() has been called with valid config)`.