feat(env): server/secret variables (#10954)

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

packages/astro/package.json

@@ -93,8 +93,7 @@
     "env.d.ts",
     "client.d.ts",
     "jsx-runtime.d.ts",
-    "content-types.template.d.ts",
-    "content-module.template.mjs",
+    "templates",
     "astro-jsx.d.ts",
     "types/content.d.ts",
     "types.d.ts",

packages/astro/src/@types/astro.ts

@@ -2428,6 +2428,11 @@ export type AstroFeatureMap = {
 	 * List of features that orbit around the i18n routing
 	 */
 	i18nDomains?: SupportsKind;
+
+	/**
+	 * The adapter is able to support `astro:env`
+	 */
+	env?: SupportsKind;
 };
 
 export interface AstroAssetsFeature {

packages/astro/src/content/utils.ts

@@ -16,14 +16,14 @@ import { AstroError, AstroErrorData } from '../core/errors/index.js';
 
 import { MarkdownError } from '../core/errors/index.js';
 import { isYAMLException } from '../core/errors/utils.js';
-import { CONTENT_FLAGS, CONTENT_TYPES_FILE, PROPAGATED_ASSET_FLAG } from './consts.js';
+import { CONTENT_FLAGS, PROPAGATED_ASSET_FLAG } from './consts.js';
 import { errorMap } from './error-map.js';
 import { createImage } from './runtime-assets.js';
 
 /**
  * Amap from a collection + slug to the local file path.
  * This is used internally to resolve entry imports when using `getEntry()`.
- * @see `content-module.template.mjs`
+ * @see `templates/content/module.mjs`
  */
 export type ContentLookupMap = {
 	[collectionName: string]: { type: 'content' | 'data'; entries: { [lookupId: string]: string } };
@@ -438,8 +438,8 @@ export function getContentPaths(
 	return {
 		contentDir: new URL('./content/', srcDir),
 		assetsDir: new URL('./assets/', srcDir),
-		typesTemplate: new URL('content-types.template.d.ts', pkgBase),
-		virtualModTemplate: new URL('content-module.template.mjs', pkgBase),
+		typesTemplate: new URL('templates/content/types.d.ts', pkgBase),
+		virtualModTemplate: new URL('templates/content/module.mjs', pkgBase),
 		config: configStats,
 	};
 }

packages/astro/src/content/vite-plugin-content-virtual-mod.ts

@@ -203,7 +203,7 @@ function getStringifiedCollectionFromLookup(
 /**
  * Generate a map from a collection + slug to the local file path.
  * This is used internally to resolve entry imports when using `getEntry()`.
- * @see `content-module.template.mjs`
+ * @see `templates/content/module.mjs`
  */
 export async function generateLookupMap({
 	settings,

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

@@ -34,6 +34,8 @@ import { matchRoute } from '../routing/match.js';
 import { createOriginCheckMiddleware } from './middlewares.js';
 import { AppPipeline } from './pipeline.js';
 export { deserializeManifest } from './common.js';
+import type { GetEnv } from '../../env/types.js';
+import { setGetEnv } from '../../runtime/server/astro-env.js';
 
 export interface RenderOptions {
 	/**
@@ -65,6 +67,9 @@ export interface RenderOptions {
 	 * Default: `app.match(request)`
 	 */
 	routeData?: RouteData;
+
+	/** TODO: add docs in a later PR */
+	getEnv?: GetEnv;
 }
 
 export interface RenderErrorOptions {
@@ -260,13 +265,15 @@ export class App {
 		let locals: object | undefined;
 		let clientAddress: string | undefined;
 		let addCookieHeader: boolean | undefined;
+		let getEnv: GetEnv | undefined;
 
 		if (
 			routeDataOrOptions &&
 			('addCookieHeader' in routeDataOrOptions ||
 				'clientAddress' in routeDataOrOptions ||
 				'locals' in routeDataOrOptions ||
-				'routeData' in routeDataOrOptions)
+				'routeData' in routeDataOrOptions ||
+				'getEnv' in routeDataOrOptions)
 		) {
 			if ('addCookieHeader' in routeDataOrOptions) {
 				addCookieHeader = routeDataOrOptions.addCookieHeader;
@@ -280,6 +287,9 @@ export class App {
 			if ('locals' in routeDataOrOptions) {
 				locals = routeDataOrOptions.locals;
 			}
+			if ('getEnv' in routeDataOrOptions) {
+				getEnv = routeDataOrOptions.getEnv;
+			}
 		} else {
 			routeData = routeDataOrOptions as RouteData | undefined;
 			locals = maybeLocals;
@@ -307,6 +317,9 @@ export class App {
 		if (!routeData) {
 			return this.#renderError(request, { locals, status: 404 });
 		}
+		if (this.#manifest.experimentalEnv && getEnv) {
+			setGetEnv(getEnv);
+		}
 		const pathname = this.#getPathnameFromRequest(request);
 		const defaultStatus = this.#getDefaultStatusCode(routeData, pathname);
 		const mod = await this.#getModuleForRoute(routeData);

packages/astro/src/core/app/types.ts

@@ -65,6 +65,7 @@ export type SSRManifest = {
 	i18n: SSRManifestI18n | undefined;
 	middleware: MiddlewareHandler;
 	checkOrigin: boolean;
+	experimentalEnv: boolean;
 };
 
 export type SSRManifestI18n = {

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

@@ -616,5 +616,6 @@ function createBuildManifest(
 		buildFormat: settings.config.build.format,
 		middleware,
 		checkOrigin: settings.config.experimental.security?.csrfProtection?.origin ?? false,
+		experimentalEnv: !!settings.config.experimental.env,
 	};
 }

packages/astro/src/core/build/plugins/plugin-manifest.ts

@@ -277,5 +277,6 @@ function buildManifest(
 		i18n: i18nManifest,
 		buildFormat: settings.config.build.format,
 		checkOrigin: settings.config.experimental.security?.csrfProtection?.origin ?? false,
+		experimentalEnv: !!settings.config.experimental.env,
 	};
 }

packages/astro/src/core/errors/errors-data.ts

@@ -1162,10 +1162,22 @@ export const i18nNotEnabled = {
  * The failing environment variable does not match the type and constraints defined in `experimental.env.schema`.
  */
 export const EnvInvalidVariables = {
-	name: 'EnvInvalidVariable',
-	title: 'Invalid Environment variable',
+	name: 'EnvInvalidVariables',
+	title: 'Invalid Environment Variables',
 	message: (variables: string) =>
-		`The following environment variable does not match the type and constraints defined in \`experimental.env.schema\`:\n\n${variables}\n`,
+		`The following environment variables do not match the type and constraints defined in \`experimental.env.schema\`:\n\n${variables}\n`,
+} satisfies ErrorData;
+
+/**
+ * @docs
+ * @description
+ * The failing environment variable does not match the type and constraints defined in `experimental.env.schema`.
+ */
+export const EnvInvalidVariable = {
+	name: 'EnvInvalidVariable',
+	title: 'Invalid Environment Variable',
+	message: (key: string, type: string) =>
+		`The following environment variable does not match the type and constraints defined in \`experimental.env.schema\`: "${key}" is not of type ${type}`,
 } satisfies ErrorData;
 
 /**

packages/astro/src/env/constants.ts

@@ -1,7 +1,12 @@
-export const VIRTUAL_CLIENT_MODULE_ID = 'astro:env/client';
-export const RESOLVED_VIRTUAL_CLIENT_MODULE_ID = '\0astro:env/client';
-export const VIRTUAL_SERVER_MODULE_ID = 'astro:env/server';
-export const RESOLVED_VIRTUAL_SERVER_MODULE_ID = '\0astro:env/server';
+export const VIRTUAL_MODULES_IDS = {
+	client: 'astro:env/client',
+	server: 'astro:env/server',
+	internal: 'virtual:astro:env/internal',
+};
 
 export const PUBLIC_PREFIX = 'PUBLIC_';
-export const ENV_TYPES_FILE = 'astro-env.d.ts';
+export const ENV_TYPES_FILE = 'env.d.ts';
+
+const PKG_BASE = new URL('../../', import.meta.url);
+export const MODULE_TEMPLATE_URL = new URL('templates/env/module.mjs', PKG_BASE);
+export const TYPES_TEMPLATE_URL = new URL('templates/env/types.d.ts', PKG_BASE);

packages/astro/src/env/types.ts

@@ -0,0 +1 @@
+export type GetEnv = (key: string) => string | undefined;