@ecopages/core 0.2.0-alpha.1 → 0.2.0-alpha.10

package/src/adapters/shared/file-route-middleware-pipeline.ts

@@ -1,123 +0,0 @@
-import { createRequire } from '../../utils/locals-utils.ts';
-import type { Middleware, ApiHandlerContext, RequestLocals } from '../../public-types.ts';
-import type { PageCacheService } from '../../services/cache/page-cache-service.ts';
-import { ApiResponseBuilder } from './api-response.js';
-import { LocalsAccessError } from '../../errors/locals-access-error.ts';
-
-export const FILE_ROUTE_MIDDLEWARE_PIPELINE_ERRORS = {
-	CTX_RENDER_UNAVAILABLE: '[ecopages] ctx.render is not available in file-route middleware',
-	CTX_RENDER_PARTIAL_UNAVAILABLE: '[ecopages] ctx.renderPartial is not available in file-route middleware',
-	middlewareRequiresDynamic: (filePath: string) =>
-		`[ecopages] Page middleware requires cache: 'dynamic'. Page: ${filePath}`,
-} as const;
-
-/**
- * Executes middleware for file-based page routes.
- *
- * This pipeline owns the middleware-specific rules that are distinct from route
- * matching and rendering, including request-local storage, the middleware
- * execution context, and the invariant that page middleware only runs for
- * request-time dynamic rendering.
- */
-export class FileRouteMiddlewarePipeline {
-	constructor(private cacheService: PageCacheService | null) {}
-
-	/**
-	 * Enforces the current middleware contract for file-routed pages.
-	 *
-	 * Middleware depends on request-scoped locals and therefore must not run when
-	 * the page is treated as statically cacheable.
-	 *
-	 * @param input Middleware list, effective cache strategy, and page path.
-	 * @throws LocalsAccessError When middleware is configured for a non-dynamic page.
-	 */
-	assertValidConfiguration(input: {
-		middleware: Middleware[];
-		pageCacheStrategy: 'static' | 'dynamic' | { revalidate: number; tags?: string[] };
-		filePath: string;
-	}): void {
-		if (input.middleware.length > 0 && input.pageCacheStrategy !== 'dynamic') {
-			throw new LocalsAccessError(
-				FILE_ROUTE_MIDDLEWARE_PIPELINE_ERRORS.middlewareRequiresDynamic(input.filePath),
-			);
-		}
-	}
-
-	/**
-	 * Creates the request-scoped middleware context used by page middleware.
-	 *
-	 * The context intentionally disables `render()` and `renderPartial()` inside
-	 * file-route middleware because rendering is owned by the page route pipeline,
-	 * not by middleware stages.
-	 *
-	 * @param input Request details and the mutable locals store.
-	 * @returns Middleware execution context.
-	 */
-	createContext(input: {
-		request: Request;
-		params: Record<string, string>;
-		locals: RequestLocals;
-	}): ApiHandlerContext {
-		const context: ApiHandlerContext = {
-			request: input.request,
-			params: input.params,
-			response: new ApiResponseBuilder(),
-			server: null,
-			services: {
-				cache: this.cacheService,
-			},
-			locals: input.locals,
-			require: createRequire(() => context.locals as unknown as Record<string, unknown>),
-			render: async () => {
-				throw new Error(FILE_ROUTE_MIDDLEWARE_PIPELINE_ERRORS.CTX_RENDER_UNAVAILABLE);
-			},
-			renderPartial: async () => {
-				throw new Error(FILE_ROUTE_MIDDLEWARE_PIPELINE_ERRORS.CTX_RENDER_PARTIAL_UNAVAILABLE);
-			},
-			json: (data, options) => {
-				const builder = new ApiResponseBuilder();
-				if (options?.status) builder.status(options.status);
-				if (options?.headers) builder.headers(options.headers);
-				return builder.json(data);
-			},
-			html: (content, options) => {
-				const builder = new ApiResponseBuilder();
-				if (options?.status) builder.status(options.status);
-				if (options?.headers) builder.headers(options.headers);
-				return builder.html(content);
-			},
-		};
-
-		return context;
-	}
-
-	/**
-	 * Runs the middleware chain and eventually delegates to the render callback.
-	 *
-	 * Middleware may short-circuit by returning a response directly. If the chain
-	 * completes, the supplied `renderResponse` callback is executed exactly once.
-	 *
-	 * @param input Middleware context, chain, and terminal render callback.
-	 * @returns Response from middleware or final render stage.
-	 */
-	async run(input: {
-		middleware: Middleware[];
-		context: ApiHandlerContext;
-		renderResponse: () => Promise<Response>;
-	}): Promise<Response> {
-		if (input.middleware.length === 0) {
-			return input.renderResponse();
-		}
-
-		let index = 0;
-		const executeNext = async (): Promise<Response> => {
-			if (index < input.middleware.length) {
-				const current = input.middleware[index++];
-				return current(input.context, executeNext);
-			}
-			return input.renderResponse();
-		};
-
-		return executeNext();
-	}
-}

package/src/adapters/shared/fs-server-response-factory.ts

@@ -1,118 +0,0 @@
-import { STATUS_MESSAGE } from '../../constants.ts';
-import { appLogger } from '../../global/app-logger.ts';
-import type { EcoPagesAppConfig, FileSystemServerOptions } from '../../internal-types.ts';
-import type { RouteRendererBody } from '../../public-types.ts';
-import type { RouteRendererFactory } from '../../route-renderer/route-renderer.ts';
-import { fileSystem } from '@ecopages/file-system';
-
-export class FileSystemServerResponseFactory {
-	private appConfig: EcoPagesAppConfig;
-	private routeRendererFactory: RouteRendererFactory;
-	private options: FileSystemServerOptions;
-
-	constructor({
-		appConfig,
-		routeRendererFactory,
-		options,
-	}: {
-		appConfig: EcoPagesAppConfig;
-		routeRendererFactory: RouteRendererFactory;
-		options: FileSystemServerOptions;
-	}) {
-		this.appConfig = appConfig;
-		this.routeRendererFactory = routeRendererFactory;
-		this.options = options;
-	}
-
-	isHtml(contentType: string) {
-		return contentType === 'text/html';
-	}
-
-	shouldEnableGzip(contentType: string) {
-		if (this.options.watchMode) return false;
-		const gzipEnabledExtensions = ['text/javascript', 'text/css'];
-		return gzipEnabledExtensions.includes(contentType);
-	}
-
-	async createResponseWithBody(
-		body: RouteRendererBody,
-		init: ResponseInit = {
-			headers: {
-				'Content-Type': 'text/html',
-			},
-		},
-	) {
-		return new Response(body as BodyInit, init);
-	}
-
-	async createDefaultNotFoundResponse() {
-		return new Response(STATUS_MESSAGE[404], {
-			status: 404,
-		});
-	}
-
-	async createCustomNotFoundResponse() {
-		const error404TemplatePath = this.appConfig.absolutePaths.error404TemplatePath;
-
-		try {
-			fileSystem.verifyFileExists(error404TemplatePath);
-		} catch {
-			appLogger.debug(
-				'Custom 404 template not found, falling back to default 404 response',
-				error404TemplatePath,
-			);
-			return this.createDefaultNotFoundResponse();
-		}
-
-		const routeRenderer = this.routeRendererFactory.createRenderer(error404TemplatePath);
-
-		const result = await routeRenderer.createRoute({
-			file: error404TemplatePath,
-		});
-
-		return await this.createResponseWithBody(result.body, {
-			status: 404,
-			statusText: STATUS_MESSAGE[404],
-			headers: {
-				'Content-Type': 'text/html',
-			},
-		});
-	}
-
-	async createFileResponse(filePath: string, contentType: string) {
-		try {
-			let file: Buffer;
-			const contentEncodingHeader: HeadersInit = {};
-
-			if (this.shouldEnableGzip(contentType)) {
-				const gzipPath = `${filePath}.gz`;
-				if (fileSystem.exists(gzipPath)) {
-					file = fileSystem.readFileAsBuffer(gzipPath);
-					contentEncodingHeader['Content-Encoding'] = 'gzip';
-					contentEncodingHeader['Vary'] = 'Accept-Encoding';
-				} else {
-					appLogger.debug('Gzip file not found, serving uncompressed', gzipPath);
-					file = fileSystem.readFileAsBuffer(filePath);
-				}
-			} else {
-				file = fileSystem.readFileAsBuffer(filePath);
-			}
-
-			return await this.createResponseWithBody(file as unknown as BodyInit, {
-				headers: {
-					'Content-Type': contentType,
-					...contentEncodingHeader,
-				},
-			});
-		} catch (error) {
-			const err = error as Error & { code?: string; cause?: { code?: string } };
-			const code = err.code || err.cause?.code;
-			if (code === 'ENOENT') {
-				appLogger.debug('File not found', filePath);
-			} else {
-				appLogger.error('Error reading file', filePath, err);
-			}
-			return this.createCustomNotFoundResponse();
-		}
-	}
-}

package/src/adapters/shared/fs-server-response-matcher.ts

@@ -1,198 +0,0 @@
-import path from 'node:path';
-import { appLogger } from '../../global/app-logger.ts';
-import type { MatchResult } from '../../internal-types.ts';
-import type { RouteRendererFactory } from '../../route-renderer/route-renderer.ts';
-import type { FSRouter } from '../../router/fs-router.ts';
-import type { PageCacheService } from '../../services/cache/page-cache-service.ts';
-import type { CacheStrategy, RenderResult } from '../../services/cache/cache.types.ts';
-import { PageModuleImportService } from '../../services/page-module-import.service.ts';
-import { PageRequestCacheCoordinator } from '../../services/page-request-cache-coordinator.service.ts';
-import { ServerUtils } from '../../utils/server-utils.module.ts';
-import type { Middleware, RequestLocals } from '../../public-types.ts';
-import { FileRouteMiddlewarePipeline } from './file-route-middleware-pipeline.ts';
-import { LocalsAccessError } from '../../errors/locals-access-error.ts';
-import { isDevelopmentRuntime } from '../../utils/runtime.ts';
-import type { FileSystemServerResponseFactory } from './fs-server-response-factory.ts';
-
-export const FILE_SYSTEM_RESPONSE_MATCHER_ERRORS = {
-	transpilePageModuleFailed: (details: string) => `Error transpiling page module: ${details}`,
-	noTranspiledOutputForPageModule: (filePath: string) =>
-		`No transpiled output generated for page module: ${filePath}`,
-} as const;
-
-export interface FileSystemResponseMatcherOptions {
-	router: FSRouter;
-	routeRendererFactory: RouteRendererFactory;
-	fileSystemResponseFactory: FileSystemServerResponseFactory;
-	/** Optional cache service. When null, caching is disabled. */
-	cacheService?: PageCacheService | null;
-	/** Default cache strategy when caching is enabled. @default 'static' */
-	defaultCacheStrategy?: CacheStrategy;
-}
-
-/**
- * Matches file-system routes to rendered HTML responses.
- *
- * This class sits at the request-time boundary between router matches and the
- * render pipeline. It coordinates page module inspection, request-local policy,
- * renderer invocation, middleware execution, cache integration, and fallback
- * error translation.
- */
-export class FileSystemResponseMatcher {
-	private router: FSRouter;
-	private routeRendererFactory: RouteRendererFactory;
-	private fileSystemResponseFactory: FileSystemServerResponseFactory;
-	private pageModuleImportService: PageModuleImportService;
-	private pageRequestCacheCoordinator: PageRequestCacheCoordinator;
-	private fileRouteMiddlewarePipeline: FileRouteMiddlewarePipeline;
-
-	constructor({
-		router,
-		routeRendererFactory,
-		fileSystemResponseFactory,
-		cacheService = null,
-		defaultCacheStrategy = 'static',
-	}: FileSystemResponseMatcherOptions) {
-		this.router = router;
-		this.routeRendererFactory = routeRendererFactory;
-		this.fileSystemResponseFactory = fileSystemResponseFactory;
-		this.pageModuleImportService = new PageModuleImportService();
-		this.pageRequestCacheCoordinator = new PageRequestCacheCoordinator(cacheService, defaultCacheStrategy);
-		this.fileRouteMiddlewarePipeline = new FileRouteMiddlewarePipeline(cacheService);
-	}
-
-	/**
-	 * Resolves unmatched paths either as static asset requests or as the custom
-	 * not-found page.
-	 *
-	 * @param requestUrl Incoming pathname.
-	 * @returns Static file response or rendered 404 response.
-	 */
-	async handleNoMatch(requestUrl: string): Promise<Response> {
-		const isStaticFileRequest = ServerUtils.hasKnownExtension(requestUrl);
-
-		if (!isStaticFileRequest) {
-			return this.fileSystemResponseFactory.createCustomNotFoundResponse();
-		}
-
-		const relativeUrl = requestUrl.startsWith('/') ? requestUrl.slice(1) : requestUrl;
-		const filePath = path.join(this.router.assetPrefix, relativeUrl);
-		const contentType = ServerUtils.getContentType(filePath);
-
-		return this.fileSystemResponseFactory.createFileResponse(filePath, contentType);
-	}
-
-	/**
-	 * Handles a matched file-system page route.
-	 *
-	 * The method inspects page metadata needed for request-time execution,
-	 * prepares the renderer invocation, validates middleware/cache constraints,
-	 * and delegates caching plus middleware execution to dedicated collaborators.
-	 *
-	 * @param match Router match result.
-	 * @param request Optional incoming request. A synthetic GET request is created when omitted.
-	 * @returns Final response for the matched route.
-	 */
-	async handleMatch(match: MatchResult, request?: Request): Promise<Response> {
-		const cacheKey = this.pageRequestCacheCoordinator.buildCacheKey(match);
-
-		try {
-			const resolvedRequest =
-				request ??
-				new Request(new URL(cacheKey, this.router.origin).toString(), {
-					method: 'GET',
-				});
-
-			const localsStore: RequestLocals = {};
-			const pageModule = await this.importPageModule(match.filePath);
-			const Page = (pageModule as any)?.default;
-			const pageMiddleware = (Page?.middleware ?? []) as Middleware[];
-			const pageCacheStrategy =
-				(Page?.cache as CacheStrategy | undefined) ??
-				this.pageRequestCacheCoordinator.getDefaultCacheStrategy();
-			const localsForRender: RequestLocals | undefined =
-				pageCacheStrategy === 'dynamic' ? localsStore : undefined;
-
-			this.fileRouteMiddlewarePipeline.assertValidConfiguration({
-				middleware: pageMiddleware,
-				pageCacheStrategy,
-				filePath: match.filePath,
-			});
-
-			const routeRenderer = this.routeRendererFactory.createRenderer(match.filePath);
-			const middlewareContext = this.fileRouteMiddlewarePipeline.createContext({
-				request: resolvedRequest,
-				params: match.params as Record<string, string>,
-				locals: localsStore,
-			});
-
-			const renderFn = async (): Promise<RenderResult> => {
-				const result = await routeRenderer.createRoute({
-					file: match.filePath,
-					params: match.params,
-					query: match.query,
-					locals: localsForRender,
-				});
-				const html = await this.pageRequestCacheCoordinator.bodyToString(result.body);
-				const strategy = result.cacheStrategy ?? this.pageRequestCacheCoordinator.getDefaultCacheStrategy();
-				return { html, strategy };
-			};
-			const renderResponse = async (): Promise<Response> => {
-				return this.pageRequestCacheCoordinator.render({
-					cacheKey,
-					pageCacheStrategy,
-					renderFn,
-				});
-			};
-
-			return await this.fileRouteMiddlewarePipeline.run({
-				middleware: pageMiddleware,
-				context: middlewareContext,
-				renderResponse,
-			});
-		} catch (error) {
-			if (error instanceof Response) {
-				return error;
-			}
-			if (error instanceof LocalsAccessError) {
-				return new Response(error.message, {
-					status: 500,
-					headers: { 'Content-Type': 'text/plain; charset=utf-8' },
-				});
-			}
-			if (error instanceof Error) {
-				if (isDevelopmentRuntime() || appLogger.isDebugEnabled()) {
-					appLogger.error(`[FileSystemResponseMatcher] ${error.message} at ${match.pathname}`);
-				}
-			}
-			return this.fileSystemResponseFactory.createCustomNotFoundResponse();
-		}
-	}
-
-	/**
-	 * Loads the matched page module for request-time inspection.
-	 *
-	 * The matcher needs access to page-level metadata such as `cache` and
-	 * `middleware` before full rendering starts, so it uses the shared module
-	 * import service directly rather than going through route rendering.
-	 *
-	 * @param filePath Absolute page module path.
-	 * @returns Imported page module.
-	 */
-	private async importPageModule(filePath: string): Promise<unknown> {
-		return this.pageModuleImportService.importModule({
-			filePath,
-			rootDir: path.dirname(this.router.assetPrefix),
-			outdir: path.join(this.router.assetPrefix, '.server-modules-meta'),
-			transpileErrorMessage: FILE_SYSTEM_RESPONSE_MATCHER_ERRORS.transpilePageModuleFailed,
-			noOutputMessage: FILE_SYSTEM_RESPONSE_MATCHER_ERRORS.noTranspiledOutputForPageModule,
-		});
-	}
-
-	/**
-	 * Get the underlying cache service for external invalidation.
-	 */
-	getCacheService(): PageCacheService | null {
-		return this.pageRequestCacheCoordinator.getCacheService();
-	}
-}

package/src/adapters/shared/render-context.ts

@@ -1,105 +0,0 @@
-import type { EcoComponent, RenderContext, RenderOptions, ResponseOptions } from '../../public-types.ts';
-import type { IntegrationRenderer, RenderToResponseContext } from '../../route-renderer/integration-renderer.ts';
-import type { IntegrationPlugin } from '../../plugins/integration-plugin.ts';
-import { invariant } from '../../utils/invariant.ts';
-
-export interface CreateRenderContextOptions {
-	integrations: IntegrationPlugin[];
-}
-
-/**
- * Merges request locals into component props as a dedicated 'locals' property.
- * This prevents naming conflicts and maintains type safety by keeping locals
- * separate from other props.
- *
- * @param props - The original component props
- * @param locals - Optional request-scoped locals from middleware
- * @returns Props with locals merged in, or original props if no locals provided
- */
-function mergePropsWithLocals<P>(props: P, locals: Record<string, unknown> | undefined): P {
-	if (!locals || typeof props !== 'object' || props === null) {
-		return props;
-	}
-	return { ...(props as Record<string, unknown>), locals } as P;
-}
-
-/**
- * Creates a render context for route handlers.
- * Provides render(), renderPartial(), json(), and html() methods that can be used
- * within route handlers to generate responses.
- *
- * @param options - Configuration options including available integrations
- * @returns A RenderContext object with methods for rendering views and creating responses
- */
-export function createRenderContext(options: CreateRenderContextOptions): RenderContext {
-	const { integrations } = options;
-
-	/**
-	 * Resolves the appropriate renderer for a given view component based on its integration.
-	 * Throws an error if the integration cannot be determined or is not found.
-	 */
-	const getRendererForView = <P>(view: EcoComponent<P>): IntegrationRenderer => {
-		const integrationName = view.config?.integration ?? view.config?.__eco?.integration;
-		invariant(
-			!!integrationName,
-			'Cannot determine integration for view. Set view.config.integration explicitly or ensure the view is defined with eco.page() in a file with a recognized extension.',
-		);
-
-		const integration = integrations.find((i) => i.name === integrationName);
-		invariant(!!integration, `No integration found for: ${integrationName}`);
-
-		return integration.initializeRenderer();
-	};
-
-	return {
-		async render<P>(view: EcoComponent<P>, props: P, renderOptions?: RenderOptions): Promise<Response> {
-			const locals = (this as { locals?: Record<string, unknown> } | undefined)?.locals;
-			const mergedProps = mergePropsWithLocals(props, locals);
-
-			const renderer = getRendererForView(view);
-			const ctx: RenderToResponseContext = {
-				partial: false,
-				status: renderOptions?.status,
-				headers: renderOptions?.headers,
-			};
-			return renderer.renderToResponse(view, mergedProps, ctx);
-		},
-
-		async renderPartial<P>(view: EcoComponent<P>, props: P, renderOptions?: RenderOptions): Promise<Response> {
-			const locals = (this as { locals?: Record<string, unknown> } | undefined)?.locals;
-			const mergedProps = mergePropsWithLocals(props, locals);
-
-			const renderer = getRendererForView(view);
-			const ctx: RenderToResponseContext = {
-				partial: true,
-				status: renderOptions?.status,
-				headers: renderOptions?.headers,
-			};
-			return renderer.renderToResponse(view, mergedProps, ctx);
-		},
-
-		json(data: unknown, responseOptions?: ResponseOptions): Response {
-			const headers = new Headers({ 'Content-Type': 'application/json; charset=utf-8' });
-			if (responseOptions?.headers) {
-				const incomingHeaders = new Headers(responseOptions.headers);
-				incomingHeaders.forEach((value, key) => headers.set(key, value));
-			}
-			return new Response(JSON.stringify(data), {
-				status: responseOptions?.status ?? 200,
-				headers,
-			});
-		},
-
-		html(content: string, responseOptions?: ResponseOptions): Response {
-			const headers = new Headers({ 'Content-Type': 'text/html; charset=utf-8' });
-			if (responseOptions?.headers) {
-				const incomingHeaders = new Headers(responseOptions.headers);
-				incomingHeaders.forEach((value, key) => headers.set(key, value));
-			}
-			return new Response(content, {
-				status: responseOptions?.status ?? 200,
-				headers,
-			});
-		},
-	};
-}