@ecopages/core 0.2.0-alpha.25 → 0.2.0-alpha.26

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

@@ -1,127 +0,0 @@
-import { createRequire } from '../../utils/locals-utils.ts';
-import type { Middleware, ApiHandlerContext, RequestLocals } from '../../types/public-types.ts';
-import type { PageCacheService } from '../../services/cache/page-cache-service.ts';
-import { ApiResponseBuilder } from './api-response.ts';
-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 {
-	private cacheService: PageCacheService | null;
-
-	constructor(cacheService: PageCacheService | null) {
-		this.cacheService = cacheService;
-	}
-
-	/**
-	 * 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.test.ts

@@ -1,187 +0,0 @@
-import { beforeAll, describe, expect, it, vi } from 'vitest';
-import {
-	FIXTURE_APP_PROJECT_DIR,
-	FIXTURE_EXISTING_CSS_FILE_IN_DIST,
-	FIXTURE_EXISTING_SVG_FILE_IN_DIST_PATH,
-} from '../../../__fixtures__/constants.js';
-import { appLogger } from '../../global/app-logger.ts';
-import { ConfigBuilder } from '../../config/config-builder.ts';
-import { STATUS_MESSAGE } from '../../config/constants.ts';
-import { RouteRendererFactory } from '../../route-renderer/route-renderer.ts';
-import { FileSystemServerResponseFactory } from './fs-server-response-factory.ts';
-
-let appConfig: Awaited<ReturnType<ConfigBuilder['build']>>;
-let responseFactory: FileSystemServerResponseFactory;
-
-describe('FileSystemServerResponseFactory', () => {
-	beforeAll(async () => {
-		appConfig = await new ConfigBuilder().setRootDir(FIXTURE_APP_PROJECT_DIR).build();
-
-		for (const integration of appConfig.integrations) {
-			integration.setConfig(appConfig);
-			integration.setRuntimeOrigin(appConfig.baseUrl);
-		}
-
-		responseFactory = new FileSystemServerResponseFactory({
-			appConfig,
-			routeRendererFactory: new RouteRendererFactory({
-				appConfig,
-				runtimeOrigin: appConfig.baseUrl,
-			}),
-			options: {
-				watchMode: false,
-			},
-		});
-	});
-
-	describe('isHtml', () => {
-		it('should return true for text/html content type', () => {
-			const result = responseFactory.isHtml('text/html');
-			expect(result).toBe(true);
-		});
-
-		it('should return false for text/plain content type', () => {
-			const result = responseFactory.isHtml('text/plain');
-			expect(result).toBe(false);
-		});
-
-		it('should return false for other content types', () => {
-			const result = responseFactory.isHtml('application/json');
-			expect(result).toBe(false);
-		});
-	});
-
-	describe('shouldEnableGzip', () => {
-		it('should return false in watch mode', () => {
-			const responseFactoryWatch = new FileSystemServerResponseFactory({
-				appConfig,
-				routeRendererFactory: new RouteRendererFactory({
-					appConfig,
-					runtimeOrigin: appConfig.baseUrl,
-				}),
-				options: {
-					watchMode: true,
-				},
-			});
-
-			const result = responseFactoryWatch.shouldEnableGzip('text/javascript');
-			expect(result).toBe(false);
-		});
-
-		it('should return true for text/javascript content type', () => {
-			const result = responseFactory.shouldEnableGzip('text/javascript');
-			expect(result).toBe(true);
-		});
-
-		it('should return true for text/css content type', () => {
-			const result = responseFactory.shouldEnableGzip('text/css');
-			expect(result).toBe(true);
-		});
-
-		it('should return false for other content types', () => {
-			const result = responseFactory.shouldEnableGzip('application/json');
-			expect(result).toBe(false);
-		});
-	});
-
-	describe('createResponseWithBody', () => {
-		it('should create a response with the given route renderer body', async () => {
-			const routeRendererBody = '<html><body>Test</body></html>';
-			const response = await responseFactory.createResponseWithBody(routeRendererBody);
-			const body = await response.text();
-			expect(body).toBe(routeRendererBody);
-			expect(response.headers.get('Content-Type')).toBe('text/html');
-		});
-	});
-
-	describe('createDefaultNotFoundResponse', () => {
-		it('should create a response with status 404 and body "file not found"', async () => {
-			const response = await responseFactory.createDefaultNotFoundResponse();
-			expect(response.status).toBe(404);
-			expect(await response.text()).toBe(STATUS_MESSAGE[404]);
-		});
-	});
-
-	describe('createCustomNotFoundResponse', () => {
-		it('should create a response with status 404 if error404 template file does not exist', async () => {
-			const customAppConfig = {
-				...appConfig,
-				absolutePaths: {
-					...appConfig.absolutePaths,
-					error404TemplatePath: 'non-existent-file',
-				},
-			};
-
-			const responseFactoryNo404Template = new FileSystemServerResponseFactory({
-				appConfig: customAppConfig,
-				routeRendererFactory: new RouteRendererFactory({
-					appConfig: customAppConfig,
-					runtimeOrigin: customAppConfig.baseUrl,
-				}),
-				options: {
-					watchMode: false,
-				},
-			});
-
-			const response = await responseFactoryNo404Template.createCustomNotFoundResponse();
-			expect(response.status).toBe(404);
-			expect(await response.text()).toBe(STATUS_MESSAGE[404]);
-		});
-
-		it('should create a response with the route renderer body if error404 template file exists', async () => {
-			const response = await responseFactory.createCustomNotFoundResponse();
-			const body = await response.text();
-			expect(body).toContain('<h1>404 - Page Not Found</h1>');
-			expect(response.headers.get('Content-Type')).toBe('text/html');
-			expect(response.status).toBe(404);
-		});
-	});
-
-	describe('createFileResponse', () => {
-		it('should create a response with the file content and content type', async () => {
-			const response = await responseFactory.createFileResponse(
-				FIXTURE_EXISTING_SVG_FILE_IN_DIST_PATH,
-				'image/svg+xml',
-			);
-			expect(response.headers.get('Content-Type')).toBe('image/svg+xml');
-		});
-
-		it('should return custom 404 page if the file does not exist', async () => {
-			const response = await responseFactory.createFileResponse('/path/to/nonexistent.txt', 'text/plain');
-			const body = await response.text();
-			expect(body).toContain('<h1>404 - Page Not Found</h1>');
-			expect(response.status).toBe(404);
-		});
-
-		it('should log debug for ENOENT errors', async () => {
-			const debugSpy = vi.spyOn(appLogger, 'debug');
-			const errorSpy = vi.spyOn(appLogger, 'error');
-
-			await responseFactory.createFileResponse('/path/to/nonexistent-debug.txt', 'text/plain');
-
-			expect(debugSpy).toHaveBeenCalled();
-			expect(errorSpy).not.toHaveBeenCalled();
-
-			debugSpy.mockRestore();
-			errorSpy.mockRestore();
-		});
-
-		it('should serve gzip file with Content-Encoding header when gzip is enabled', async () => {
-			const cssFilePath = `${appConfig.absolutePaths.distDir}/${FIXTURE_EXISTING_CSS_FILE_IN_DIST}`;
-			const response = await responseFactory.createFileResponse(cssFilePath, 'text/css');
-
-			expect(response.headers.get('Content-Type')).toBe('text/css');
-			expect(response.headers.get('Content-Encoding')).toBe('gzip');
-		});
-
-		it('should not set Content-Encoding header for non-gzip content types', async () => {
-			const response = await responseFactory.createFileResponse(
-				FIXTURE_EXISTING_SVG_FILE_IN_DIST_PATH,
-				'image/svg+xml',
-			);
-
-			expect(response.headers.get('Content-Type')).toBe('image/svg+xml');
-			expect(response.headers.get('Content-Encoding')).toBeNull();
-		});
-	});
-});

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

@@ -1,118 +0,0 @@
-import { STATUS_MESSAGE } from '../../config/constants.ts';
-import { appLogger } from '../../global/app-logger.ts';
-import type { EcoPagesAppConfig, FileSystemServerOptions } from '../../types/internal-types.ts';
-import type { RouteRendererBody } from '../../types/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();
-		}
-	}
-}