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

package/src/route-renderer/orchestration/{render-preparation.service.test.ts → route-render-orchestrator.prepare-render-options.test.ts}

@@ -2,20 +2,22 @@ import { describe, expect, it, vi } from 'vitest';
 import { eco } from '../../eco/eco.ts';
 import type { EcoPagesAppConfig } from '../../types/internal-types.ts';
 import type {
-	BoundaryPlan,
+	OwnershipPlan,
 	EcoComponent,
 	EcoPageComponent,
 	HtmlTemplateProps,
+	PageMetadataProps,
 	RouteRendererOptions,
 } from '../../types/public-types.ts';
 import { LocalsAccessError } from '../../errors/locals-access-error.ts';
-import { BoundaryPlanningService } from './boundary-planning.service.ts';
+import { OwnershipPlanningService } from './ownership-planning.service.ts';
 import type {
 	AssetDefinition,
 	AssetProcessingService,
 	ProcessedAsset,
 } from '../../services/assets/asset-processing-service/index.ts';
-import { RenderPreparationService } from './render-preparation.service.ts';
+import { OwnershipValidationService } from './ownership-validation.service.ts';
+import { type RouteRenderOrchestratorAdapter, RouteRenderOrchestrator } from './route-render-orchestrator.ts';
 
 declare module '../../types/public-types.ts' {
 	interface RequestLocals {
@@ -24,7 +26,81 @@ declare module '../../types/public-types.ts' {
 	}
 }
 
-describe('RenderPreparationService', () => {
+function createFlowAdapter<C>(input: {
+	resolvePageModule: (file: string) => Promise<{
+		Page: EcoPageComponent<any> | EcoComponent;
+		getStaticProps?: unknown;
+		getMetadata?: unknown;
+		integrationSpecificProps: Record<string, unknown>;
+	}>;
+	getHtmlTemplate: () => Promise<EcoComponent<HtmlTemplateProps>>;
+	resolvePageData: (
+		pageModule: {
+			getStaticProps?: unknown;
+			getMetadata?: unknown;
+		},
+		routeOptions: RouteRendererOptions,
+	) => Promise<{ props: Record<string, unknown>; metadata: PageMetadataProps }>;
+	resolveDependencies: (components: (EcoComponent | Partial<EcoComponent>)[]) => Promise<ProcessedAsset[]>;
+	buildPageBrowserGraph: (file: string) => Promise<{ assets: ProcessedAsset[] } | undefined>;
+	shouldRenderPageComponent: (input: {
+		Page: EcoComponent;
+		Layout?: EcoComponent;
+		options: RouteRendererOptions;
+	}) => boolean;
+	renderPageComponent: (input: {
+		Page: EcoComponent;
+		Layout?: EcoComponent;
+		props: Record<string, unknown>;
+		routeOptions: RouteRendererOptions;
+	}) => Promise<any>;
+}): RouteRenderOrchestratorAdapter<C> {
+	return {
+		name: 'ghtml',
+		resolveRouteRenderInputs: async (routeOptions) => {
+			const pageModule = await input.resolvePageModule(routeOptions.file);
+			const HtmlTemplate = await input.getHtmlTemplate();
+			const Layout = pageModule.Page.config?.layout;
+			const { props, metadata } = await input.resolvePageData(pageModule, routeOptions);
+
+			return {
+				Page: pageModule.Page,
+				HtmlTemplate,
+				Layout,
+				props,
+				metadata,
+				integrationSpecificProps: pageModule.integrationSpecificProps,
+				shouldRenderPageComponent: input.shouldRenderPageComponent({
+					Page: pageModule.Page as EcoComponent,
+					Layout,
+					options: routeOptions,
+				}),
+			};
+		},
+		resolveRouteAssets: async ({ routeOptions, components }) => ({
+			resolvedDependencies: await input.resolveDependencies(components),
+			pageBrowserGraph: await input.buildPageBrowserGraph(routeOptions.file),
+		}),
+		resolveRoutePageComponentRender: async (renderInput) => {
+			if (
+				!input.shouldRenderPageComponent({
+					Page: renderInput.Page,
+					Layout: renderInput.Layout,
+					options: renderInput.routeOptions,
+				})
+			) {
+				return undefined;
+			}
+
+			return await input.renderPageComponent(renderInput);
+		},
+		renderRouteBody: async () => '',
+		getRouteHtmlFinalization: () => ({}),
+		transformRouteResponse: async (response) => await response.text(),
+	};
+}
+
+describe('RouteRenderOrchestrator prepareRenderOptions', () => {
 	it('should prepare dynamic render options and merge renderer-owned assets', async () => {
 		const integrationDependency = {
 			kind: 'script',
@@ -59,7 +135,7 @@ describe('RenderPreparationService', () => {
 				},
 			],
 		} as unknown as EcoPagesAppConfig;
-		const service = new RenderPreparationService(appConfig, assetProcessingService);
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const Nested = (() => '<aside>Nested</aside>') as EcoComponent<Record<string, unknown>>;
 		Nested.config = {
@@ -79,27 +155,30 @@ describe('RenderPreparationService', () => {
 			query: { preview: '1' },
 			locals: { user: 'andee' },
 		} as unknown as RouteRendererOptions;
-		const result = await service.prepare(routeOptions, 'ghtml', {
-			resolvePageModule: async () => ({
-				Page,
-				integrationSpecificProps: { layoutMode: 'full' },
-			}),
-			getHtmlTemplate: async () => HtmlTemplate,
-			resolvePageData: async () => ({
-				props: { title: 'Hello' },
-				metadata: { title: 'Hello', description: 'Hello description' },
-			}),
-			resolveDependencies: async () => [resolvedDependency],
-			buildRouteRenderAssets: async () => [pageDependency],
-			shouldRenderPageComponent: () => true,
-			renderPageComponent: async () => ({
-				html: '<main>Page</main>',
-				canAttachAttributes: true,
-				rootTag: 'main',
-				integrationName: 'ghtml',
-				assets: [componentAsset],
+		const result = await flow.prepareRenderOptions(
+			routeOptions,
+			createFlowAdapter({
+				resolvePageModule: async () => ({
+					Page,
+					integrationSpecificProps: { layoutMode: 'full' },
+				}),
+				getHtmlTemplate: async () => HtmlTemplate,
+				resolvePageData: async () => ({
+					props: { title: 'Hello' },
+					metadata: { title: 'Hello', description: 'Hello description' },
+				}),
+				resolveDependencies: async () => [resolvedDependency],
+				buildPageBrowserGraph: async () => ({ assets: [pageDependency] }),
+				shouldRenderPageComponent: () => true,
+				renderPageComponent: async () => ({
+					html: '<main>Page</main>',
+					canAttachAttributes: true,
+					rootTag: 'main',
+					integrationName: 'ghtml',
+					assets: [componentAsset],
+				}),
 			}),
-		});
+		);
 
 		expect(result.locals).toEqual({ user: 'andee' });
 		expect(result.pageLocals).toEqual({ user: 'andee' });
@@ -121,7 +200,7 @@ describe('RenderPreparationService', () => {
 			cache: { defaultStrategy: 'static' },
 			integrations: [],
 		} as unknown as EcoPagesAppConfig;
-		const service = new RenderPreparationService(appConfig, assetProcessingService);
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const DeferredChild = eco.component<{}, string>({
 			integration: 'react',
@@ -129,10 +208,9 @@ describe('RenderPreparationService', () => {
 		});
 		const Page = (() => '<main>Page</main>') as unknown as EcoPageComponent<any>;
 
-		const result = await service.prepare(
+		const result = await flow.prepareRenderOptions(
 			{ file: '/app/pages/index.tsx', params: {}, query: {} } as unknown as RouteRendererOptions,
-			'ghtml',
-			{
+			createFlowAdapter({
 				resolvePageModule: async () => ({
 					Page,
 					integrationSpecificProps: {},
@@ -143,7 +221,7 @@ describe('RenderPreparationService', () => {
 					metadata: { title: 'Page', description: 'Page description' },
 				}),
 				resolveDependencies: async () => [],
-				buildRouteRenderAssets: async () => [],
+				buildPageBrowserGraph: async () => ({ assets: [] }),
 				shouldRenderPageComponent: () => true,
 				renderPageComponent: async () => ({
 					html: DeferredChild({}),
@@ -151,7 +229,7 @@ describe('RenderPreparationService', () => {
 					rootTag: 'span',
 					integrationName: 'ghtml',
 				}),
-			},
+			}),
 		);
 
 		expect(result.componentRender).toEqual(
@@ -165,9 +243,8 @@ describe('RenderPreparationService', () => {
 	});
 
 	it('inlines the global injector bootstrap when resolved lazy triggers are present', async () => {
-		const processDependencies = vi
-			.fn<AssetProcessingService['processDependencies']>()
-			.mockImplementation(async (dependencies) =>
+		const processDependencies = vi.fn<AssetProcessingService['processDependencies']>().mockImplementation(
+			async (dependencies) =>
 				dependencies.map((dependency) => ({
 					kind: dependency.kind,
 					position: dependency.position,
@@ -176,7 +253,7 @@ describe('RenderPreparationService', () => {
 					inline: dependency.inline,
 					packageRole: dependency.packageRole,
 				})) as ProcessedAsset[],
-			);
+		);
 		const assetProcessingService = {
 			processDependencies,
 		} as unknown as AssetProcessingService;
@@ -184,7 +261,7 @@ describe('RenderPreparationService', () => {
 			cache: { defaultStrategy: 'static' },
 			integrations: [],
 		} as unknown as EcoPagesAppConfig;
-		const service = new RenderPreparationService(appConfig, assetProcessingService);
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const Page = (() => '<main>Page</main>') as unknown as EcoPageComponent<any>;
 		Page.config = {
@@ -196,10 +273,9 @@ describe('RenderPreparationService', () => {
 			],
 		};
 
-		await service.prepare(
+		await flow.prepareRenderOptions(
 			{ file: '/app/pages/index.tsx', params: {}, query: {} } as unknown as RouteRendererOptions,
-			'ghtml',
-			{
+			createFlowAdapter({
 				resolvePageModule: async () => ({
 					Page,
 					integrationSpecificProps: {},
@@ -210,10 +286,10 @@ describe('RenderPreparationService', () => {
 					metadata: { title: 'Page', description: 'Page description' },
 				}),
 				resolveDependencies: async () => [],
-				buildRouteRenderAssets: async () => [],
+				buildPageBrowserGraph: async () => ({ assets: [] }),
 				shouldRenderPageComponent: () => false,
 				renderPageComponent: vi.fn(),
-			},
+			}),
 		);
 
 		expect(processDependencies).toHaveBeenCalledOnce();
@@ -238,20 +314,19 @@ describe('RenderPreparationService', () => {
 			cache: { defaultStrategy: 'static' },
 			integrations: [],
 		} as unknown as EcoPagesAppConfig;
-		const service = new RenderPreparationService(appConfig, assetProcessingService);
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const Page = (() => '<main>Page</main>') as unknown as EcoPageComponent<any>;
 		const renderPageComponent = vi.fn();
 
-		const result = await service.prepare(
+		const result = await flow.prepareRenderOptions(
 			{
 				file: '/app/pages/index.tsx',
 				params: {},
 				query: {},
 				locals: { hidden: true },
 			} as unknown as RouteRendererOptions,
-			'ghtml',
-			{
+			createFlowAdapter({
 				resolvePageModule: async () => ({
 					Page,
 					integrationSpecificProps: {},
@@ -262,10 +337,10 @@ describe('RenderPreparationService', () => {
 					metadata: { title: 'Static page', description: 'Static page description' },
 				}),
 				resolveDependencies: async () => [],
-				buildRouteRenderAssets: async () => [],
+				buildPageBrowserGraph: async () => ({ assets: [] }),
 				shouldRenderPageComponent: () => false,
 				renderPageComponent,
-			},
+			}),
 		);
 
 		expect(result.locals).toBeUndefined();
@@ -299,7 +374,7 @@ describe('RenderPreparationService', () => {
 			cache: { defaultStrategy: 'static' },
 			integrations: [],
 		} as unknown as EcoPagesAppConfig;
-		const service = new RenderPreparationService(appConfig, assetProcessingService);
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const LitCounter = (() => '<lit-counter count="0"></lit-counter>') as unknown as EcoComponent<object>;
 		LitCounter.config = {
@@ -315,10 +390,9 @@ describe('RenderPreparationService', () => {
 			},
 		};
 
-		await service.prepare(
+		await flow.prepareRenderOptions(
 			{ file: '/app/pages/index.tsx', params: {}, query: {} } as unknown as RouteRendererOptions,
-			'ghtml',
-			{
+			createFlowAdapter({
 				resolvePageModule: async () => ({
 					Page,
 					integrationSpecificProps: {},
@@ -329,10 +403,10 @@ describe('RenderPreparationService', () => {
 					metadata: { title: 'Static page', description: 'Static page description' },
 				}),
 				resolveDependencies: async () => [],
-				buildRouteRenderAssets: async () => [],
+				buildPageBrowserGraph: async () => ({ assets: [] }),
 				shouldRenderPageComponent: () => false,
 				renderPageComponent: vi.fn(),
-			},
+			}),
 		);
 
 		expect(processDependencies).toHaveBeenCalledOnce();
@@ -373,7 +447,7 @@ describe('RenderPreparationService', () => {
 			cache: { defaultStrategy: 'static' },
 			integrations: [],
 		} as unknown as EcoPagesAppConfig;
-		const service = new RenderPreparationService(appConfig, assetProcessingService);
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const LitCounter = (() => '<lit-counter count="0"></lit-counter>') as unknown as EcoComponent<object>;
 		LitCounter.config = {
@@ -389,10 +463,9 @@ describe('RenderPreparationService', () => {
 			},
 		};
 
-		const result = await service.prepare(
+		const result = await flow.prepareRenderOptions(
 			{ file: '/app/pages/index.tsx', params: {}, query: {} } as unknown as RouteRendererOptions,
-			'ghtml',
-			{
+			createFlowAdapter({
 				resolvePageModule: async () => ({
 					Page,
 					integrationSpecificProps: {},
@@ -403,10 +476,10 @@ describe('RenderPreparationService', () => {
 					metadata: { title: 'Static page', description: 'Static page description' },
 				}),
 				resolveDependencies: async () => [],
-				buildRouteRenderAssets: async () => [],
+				buildPageBrowserGraph: async () => ({ assets: [] }),
 				shouldRenderPageComponent: () => false,
 				renderPageComponent: vi.fn(),
-			},
+			}),
 		);
 
 		expect(result.pagePackage).toEqual(
@@ -435,7 +508,7 @@ describe('RenderPreparationService', () => {
 				},
 			],
 		} as unknown as EcoPagesAppConfig;
-		const service = new RenderPreparationService(appConfig, assetProcessingService);
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const Nested = (() => '<aside>Nested</aside>') as EcoComponent<Record<string, unknown>>;
 		Nested.config = {
@@ -449,10 +522,9 @@ describe('RenderPreparationService', () => {
 			},
 		};
 		await expect(
-			service.prepare(
+			flow.prepareRenderOptions(
 				{ file: '/app/pages/404.tsx', params: {}, query: {} } as unknown as RouteRendererOptions,
-				'ghtml',
-				{
+				createFlowAdapter({
 					resolvePageModule: async () => ({
 						Page,
 						integrationSpecificProps: {},
@@ -463,10 +535,10 @@ describe('RenderPreparationService', () => {
 						metadata: { title: '404', description: 'Not found' },
 					}),
 					resolveDependencies: async () => [],
-					buildRouteRenderAssets: async () => [],
+					buildPageBrowserGraph: async () => ({ assets: [] }),
 					shouldRenderPageComponent: () => false,
 					renderPageComponent: vi.fn(),
-				},
+				}),
 			),
 		).resolves.toEqual(
 			expect.objectContaining({
@@ -474,10 +546,9 @@ describe('RenderPreparationService', () => {
 			}),
 		);
 
-		const result = await service.prepare(
+		const result = await flow.prepareRenderOptions(
 			{ file: '/app/pages/404.tsx', params: {}, query: {} } as unknown as RouteRendererOptions,
-			'ghtml',
-			{
+			createFlowAdapter({
 				resolvePageModule: async () => ({
 					Page,
 					integrationSpecificProps: {},
@@ -488,10 +559,10 @@ describe('RenderPreparationService', () => {
 					metadata: { title: '404', description: 'Not found' },
 				}),
 				resolveDependencies: async () => [],
-				buildRouteRenderAssets: async () => [],
+				buildPageBrowserGraph: async () => ({ assets: [] }),
 				shouldRenderPageComponent: () => false,
 				renderPageComponent: vi.fn(),
-			},
+			}),
 		);
 
 		expect(result.pagePackage).toEqual(
@@ -501,7 +572,7 @@ describe('RenderPreparationService', () => {
 		);
 	});
 
-	it('uses an injected boundary planning service when provided', async () => {
+	it('uses an injected ownership planning service when provided', async () => {
 		const assetProcessingService = {
 			processDependencies: vi.fn(async () => []),
 		} as unknown as AssetProcessingService;
@@ -509,7 +580,7 @@ describe('RenderPreparationService', () => {
 			cache: { defaultStrategy: 'static' },
 			integrations: [],
 		} as unknown as EcoPagesAppConfig;
-		const boundaryPlan = {
+		const ownershipPlan = {
 			root: {
 				id: 'route:/app/pages/index.tsx',
 				source: 'route',
@@ -527,20 +598,23 @@ describe('RenderPreparationService', () => {
 			foreignEdgeCount: 0,
 			hasValidationErrors: false,
 			validationErrors: [],
-		} satisfies BoundaryPlan;
-		const injectedBoundaryPlanningService = {
-			buildPlan: vi.fn(() => boundaryPlan),
-		} as unknown as BoundaryPlanningService;
-		const service = new RenderPreparationService(appConfig, assetProcessingService, {
-			boundaryPlanningService: injectedBoundaryPlanningService,
+		} satisfies OwnershipPlan;
+		const injectedOwnershipPlanningService = {
+			buildPlan: vi.fn(() => ownershipPlan),
+		} as unknown as OwnershipPlanningService;
+		const injectedOwnershipValidationService = {
+			validate: vi.fn(() => []),
+		} as unknown as OwnershipValidationService;
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService, {
+			ownershipPlanningService: injectedOwnershipPlanningService,
+			ownershipValidationService: injectedOwnershipValidationService,
 		});
 		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
 		const Page = (() => '<main>Page</main>') as unknown as EcoPageComponent<any>;
 
-		const result = await service.prepare(
+		const result = await flow.prepareRenderOptions(
 			{ file: '/app/pages/index.tsx', params: {}, query: {} } as unknown as RouteRendererOptions,
-			'ghtml',
-			{
+			createFlowAdapter({
 				resolvePageModule: async () => ({
 					Page,
 					integrationSpecificProps: {},
@@ -551,19 +625,20 @@ describe('RenderPreparationService', () => {
 					metadata: { title: 'Page', description: 'Page description' },
 				}),
 				resolveDependencies: async () => [],
-				buildRouteRenderAssets: async () => [],
+				buildPageBrowserGraph: async () => ({ assets: [] }),
 				shouldRenderPageComponent: () => false,
 				renderPageComponent: vi.fn(),
-			},
+			}),
 		);
 
-		expect(injectedBoundaryPlanningService.buildPlan).toHaveBeenCalledWith({
+		expect(injectedOwnershipPlanningService.buildPlan).toHaveBeenCalledWith({
 			routeFile: '/app/pages/index.tsx',
 			currentIntegrationName: 'ghtml',
 			HtmlTemplate,
 			Layout: undefined,
 			Page,
+			validationErrors: [],
 		});
-		expect(result.boundaryPlan).toBe(boundaryPlan);
+		expect(result.ownershipPlan).toBe(ownershipPlan);
 	});
 });