Remove support for simple objects in endpoints

.changeset/clever-beds-notice.md

@@ -0,0 +1,9 @@
+---
+'astro': major
+---
+
+Removes support for returning simple objects from endpoints (deprecated since Astro 3.0). You should return a `Response` instead.
+
+`ResponseWithEncoding` is also removed. You can refactor the code to return a response with an array buffer instead, which is encoding agnostic.
+
+The types for middlewares are also cleaned up. To type a middleware function, you should now use `MiddlewareHandler` instead of `MiddlewareResponseHandler`. If you used `defineMiddleware()` to type the function, no changes are needed.

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

@@ -19,7 +19,6 @@ import type { AstroConfigType } from '../core/config/index.js';
 import type { AstroTimer } from '../core/config/timer.js';
 import type { TSConfig } from '../core/config/tsconfig.js';
 import type { AstroCookies } from '../core/cookies/index.js';
-import type { ResponseWithEncoding } from '../core/endpoint/index.js';
 import type { AstroIntegrationLogger, Logger, LoggerLevel } from '../core/logger/core.js';
 import type { AstroDevOverlay, DevOverlayCanvas } from '../runtime/client/dev-overlay/overlay.js';
 import type { DevOverlayHighlight } from '../runtime/client/dev-overlay/ui-library/highlight.js';
@@ -2059,8 +2058,6 @@ export interface AstroAdapter {
 	supportedAstroFeatures?: AstroFeatureMap;
 }
 
-type Body = string;
-
 export type ValidRedirectStatus = 300 | 301 | 302 | 303 | 304 | 307 | 308;
 
 // Shared types between `Astro` global and API context object
@@ -2217,7 +2214,6 @@ export interface APIContext<
 	 * ```
 	 */
 	locals: App.Locals;
-	ResponseWithEncoding: typeof ResponseWithEncoding;
 
 	/**
 	 * Available only when `experimental.i18n` enabled and in SSR.
@@ -2253,22 +2249,12 @@ export interface APIContext<
 	currentLocale: string | undefined;
 }
 
-export type EndpointOutput =
-	| {
-			body: Body;
-			encoding?: BufferEncoding;
-	  }
-	| {
-			body: Uint8Array;
-			encoding: 'binary';
-	  };
-
 export type APIRoute<Props extends Record<string, any> = Record<string, any>> = (
 	context: APIContext<Props>
-) => EndpointOutput | Response | Promise<EndpointOutput | Response>;
+) => Response | Promise<Response>;
 
 export interface EndpointHandler {
-	[method: string]: APIRoute | ((params: Params, request: Request) => EndpointOutput | Response);
+	[method: string]: APIRoute | ((params: Params, request: Request) => Response);
 }
 
 export type Props = Record<string, unknown>;
@@ -2373,20 +2359,16 @@ export interface AstroIntegration {
 	};
 }
 
-export type MiddlewareNext<R> = () => Promise<R>;
-export type MiddlewareHandler<R> = (
+export type MiddlewareNext = () => Promise<Response>;
+export type MiddlewareHandler = (
 	context: APIContext,
-	next: MiddlewareNext<R>
-) => Promise<R> | R | Promise<void> | void;
-
-export type MiddlewareResponseHandler = MiddlewareHandler<Response>;
-export type MiddlewareEndpointHandler = MiddlewareHandler<Response | EndpointOutput>;
-export type MiddlewareNextResponse = MiddlewareNext<Response>;
+	next: MiddlewareNext
+) => Promise<Response> | Response | Promise<void> | void;
 
 // NOTE: when updating this file with other functions,
 // remember to update `plugin-page.ts` too, to add that function as a no-op function.
-export type AstroMiddlewareInstance<R> = {
-	onRequest?: MiddlewareHandler<R>;
+export type AstroMiddlewareInstance = {
+	onRequest?: MiddlewareHandler;
 };
 
 export type AstroIntegrationMiddleware = {

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

@@ -1,7 +1,6 @@
 import type {
 	EndpointHandler,
 	ManifestData,
-	MiddlewareEndpointHandler,
 	RouteData,
 	SSRElement,
 	SSRManifest,
@@ -181,16 +180,14 @@ export class App {
 			);
 			if (i18nMiddleware) {
 				if (mod.onRequest) {
-					this.#pipeline.setMiddlewareFunction(
-						sequence(i18nMiddleware, mod.onRequest as MiddlewareEndpointHandler)
-					);
+					this.#pipeline.setMiddlewareFunction(sequence(i18nMiddleware, mod.onRequest));
 				} else {
 					this.#pipeline.setMiddlewareFunction(i18nMiddleware);
 				}
 				this.#pipeline.onBeforeRenderRoute(i18nPipelineHook);
 			} else {
 				if (mod.onRequest) {
-					this.#pipeline.setMiddlewareFunction(mod.onRequest as MiddlewareEndpointHandler);
+					this.#pipeline.setMiddlewareFunction(mod.onRequest);
 				}
 			}
 			response = await this.#pipeline.renderRoute(renderContext, pageModule);
@@ -322,7 +319,7 @@ export class App {
 				);
 				const page = (await mod.page()) as any;
 				if (skipMiddleware === false && mod.onRequest) {
-					this.#pipeline.setMiddlewareFunction(mod.onRequest as MiddlewareEndpointHandler);
+					this.#pipeline.setMiddlewareFunction(mod.onRequest);
 				}
 				if (skipMiddleware) {
 					// make sure middleware set by other requests is cleared out
@@ -367,8 +364,8 @@ export class App {
 		const status = override?.status
 			? override.status
 			: oldResponse.status === 200
-			? newResponse.status
-			: oldResponse.status;
+			  ? newResponse.status
+			  : oldResponse.status;
 
 		return new Response(newResponse.body, {
 			status,

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

@@ -8,7 +8,6 @@ import type {
 	AstroSettings,
 	ComponentInstance,
 	GetStaticPathsItem,
-	MiddlewareEndpointHandler,
 	RouteData,
 	RouteType,
 	SSRError,
@@ -244,10 +243,7 @@ export async function generatePages(opts: StaticBuildOptions, internals: BuildIn
 
 		await queue.onIdle();
 		const assetsTimeEnd = performance.now();
-		logger.info(
-			null,
-			green(`✓ Completed in ${getTimeStat(assetsTimer, assetsTimeEnd)}.\n`)
-		);
+		logger.info(null, green(`✓ Completed in ${getTimeStat(assetsTimer, assetsTimeEnd)}.\n`));
 
 		delete globalThis?.astroAsset?.addStaticImage;
 	}
@@ -286,15 +282,13 @@ async function generatePage(
 	);
 	if (config.experimental.i18n && i18nMiddleware) {
 		if (onRequest) {
-			pipeline.setMiddlewareFunction(
-				sequence(i18nMiddleware, onRequest as MiddlewareEndpointHandler)
-			);
+			pipeline.setMiddlewareFunction(sequence(i18nMiddleware, onRequest));
 		} else {
 			pipeline.setMiddlewareFunction(i18nMiddleware);
 		}
 		pipeline.onBeforeRenderRoute(i18nPipelineHook);
 	} else if (onRequest) {
-		pipeline.setMiddlewareFunction(onRequest as MiddlewareEndpointHandler);
+		pipeline.setMiddlewareFunction(onRequest);
 	}
 	if (!pageModulePromise) {
 		throw new Error(
@@ -390,13 +384,13 @@ async function getPathsForRoute(
 				throw err;
 			});
 
-		const label = staticPaths.length === 1 ? 'page' : 'pages';
-		logger.debug(
-			'build',
-			`├── ${bold(green('✔'))} ${route.component} → ${magenta(
-				`[${staticPaths.length} ${label}]`
-			)}`
-		);
+			const label = staticPaths.length === 1 ? 'page' : 'pages';
+			logger.debug(
+				'build',
+				`├── ${bold(green('✔'))} ${route.component} → ${magenta(
+					`[${staticPaths.length} ${label}]`
+				)}`
+			);
 
 			paths.push(
 				...staticPaths
@@ -587,7 +581,6 @@ async function generatePath(pathname: string, gopts: GeneratePathOptions, pipeli
 		});
 
 		let body: string | Uint8Array;
-		let encoding: BufferEncoding | undefined;
 
 		let response: Response;
 		try {
@@ -630,15 +623,14 @@ async function generatePath(pathname: string, gopts: GeneratePathOptions, pipeli
 			// If there's no body, do nothing
 			if (!response.body) return;
 			body = Buffer.from(await response.arrayBuffer());
-			encoding = (response.headers.get('X-Astro-Encoding') as BufferEncoding | null) ?? 'utf-8';
 		}
 
 		const outFolder = getOutFolder(pipeline.getConfig(), pathname, route.type);
 		const outFile = getOutFile(pipeline.getConfig(), outFolder, pathname, route.type);
 		route.distURL = outFile;
 
 		await fs.promises.mkdir(outFolder, { recursive: true });
-		await fs.promises.writeFile(outFile, body, encoding);
+		await fs.promises.writeFile(outFile, body);
 	}
 }
 

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

@@ -161,7 +161,7 @@ class AstroBuilder {
 		this.logger.info('build', `output: ${blue('"' + this.settings.config.output + '"')}`);
 		this.logger.info('build', `directory: ${blue(fileURLToPath(this.settings.config.outDir))}`);
 		if (this.settings.adapter) {
-		  this.logger.info('build', `adapter: ${green(this.settings.adapter.name)}`);
+			this.logger.info('build', `adapter: ${green(this.settings.adapter.name)}`);
 		}
 		this.logger.info('build', 'Collecting build info...');
 		this.timer.loadStart = performance.now();
@@ -253,32 +253,6 @@ class AstroBuilder {
 				`the outDir cannot be the root folder. Please build to a folder such as dist.`
 			);
 		}
-
-		// TODO: Remove in Astro 4.0
-		if (config.build.split === true) {
-			if (config.output === 'static') {
-				this.logger.warn(
-					'config',
-					'The option `build.split` won\'t take effect, because `output` is not `"server"` or `"hybrid"`.'
-				);
-			}
-			this.logger.warn(
-				'deprecated',
-				'The option `build.split` is deprecated. Use the adapter options.'
-			);
-		}
-		if (config.build.excludeMiddleware === true) {
-			if (config.output === 'static') {
-				this.logger.warn(
-					'config',
-					'The option `build.excludeMiddleware` won\'t take effect, because `output` is not `"server"` or `"hybrid"`.'
-				);
-			}
-			this.logger.warn(
-				'deprecated',
-				'The option `build.excludeMiddleware` is deprecated. Use the adapter options.'
-			);
-		}
 	}
 
 	/** Stats */

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

@@ -54,7 +54,7 @@ export interface SinglePageBuiltModule {
 	/**
 	 * The `onRequest` hook exported by the middleware
 	 */
-	onRequest?: MiddlewareHandler<unknown>;
+	onRequest?: MiddlewareHandler;
 	renderers: SSRLoadedRenderer[];
 }