npm - @ecopages/core - Versions diffs - 0.2.0-alpha.25 → 0.2.0-alpha.27 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (111) hide show

package/src/route-renderer/orchestration/route-render-orchestrator.test.ts ADDED Viewed

@@ -0,0 +1,265 @@
+import { describe, expect, it } from 'vitest';
+import type {
+	EcoComponent,
+	HtmlTemplateProps,
+	PageMetadataProps,
+	RouteRendererBody,
+	RouteRendererOptions,
+} from '../../types/public-types.ts';
+import {
+	type RouteHtmlFinalization,
+	type RouteRenderOrchestratorAdapter,
+	RouteRenderOrchestrator,
+} from './route-render-orchestrator.ts';
+function createFlowAdapter(input: {
+	resolvePageModule: (file: string) => Promise<{
+		Page: EcoComponent<Record<string, unknown>>;
+		integrationSpecificProps: Record<string, unknown>;
+		getStaticProps?: unknown;
+		getMetadata?: 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<any[]>;
+	buildPageBrowserGraph: (file: string) => Promise<{ assets: any[] } | undefined>;
+	shouldRenderPageComponent: (input: {
+		Page: EcoComponent;
+		Layout?: EcoComponent;
+		options: RouteRendererOptions;
+	}) => boolean;
+	renderPageComponent: (input: {
+		Page: EcoComponent;
+		Layout?: EcoComponent;
+		props: Record<string, unknown>;
+		routeOptions: RouteRendererOptions;
+	}) => Promise<any>;
+	renderRouteBody: () => Promise<RouteRendererBody>;
+	getRouteHtmlFinalization?: () => RouteHtmlFinalization;
+	transformRouteResponse: (response: Response) => Promise<RouteRendererBody>;
+}): RouteRenderOrchestratorAdapter<unknown> {
+	return {
+		name: 'test-renderer',
+		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,
+					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: input.renderRouteBody,
+		getRouteHtmlFinalization: input.getRouteHtmlFinalization ?? (() => ({})),
+		transformRouteResponse: input.transformRouteResponse,
+	};
+}
+describe('RouteRenderOrchestrator', () => {
+	const appConfig = {
+		cache: { defaultStrategy: 'static' },
+		defaultMetadata: { title: 'Default title', description: 'Default description' },
+		integrations: [],
+	} as any;
+	const assetProcessingService = {
+		processDependencies: async () => [],
+	} as any;
+	it('captures streamed render bodies before final HTML handling', async () => {
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
+		const encoder = new TextEncoder();
+		const result = await flow.captureHtmlRender(
+			async () =>
+				new ReadableStream({
+					start(controller) {
+						controller.enqueue(encoder.encode('<html><body><main>Streamed</main></body></html>'));
+						controller.close();
+					},
+				}) as unknown as BodyInit,
+		);
+		expect(result.body).toBeInstanceOf(ReadableStream);
+		expect(result.html).toContain('<main>Streamed</main>');
+	});
+	it('preserves streamed bodies when no foreign-subtree resolution or attribute stamping is required', async () => {
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
+		const encoder = new TextEncoder();
+		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
+		const Page = (() => '<main>Page</main>') as EcoComponent<Record<string, unknown>>;
+		(Page as EcoComponent<Record<string, unknown>> & { cache?: unknown }).cache = { revalidate: 60 };
+		const result = await flow.execute(
+			{
+				file: '/app/pages/index.tsx',
+				params: {},
+				query: {},
+			} as unknown as RouteRendererOptions,
+			createFlowAdapter({
+				resolvePageModule: async () => ({ Page, integrationSpecificProps: {} }),
+				getHtmlTemplate: async () => HtmlTemplate,
+				resolvePageData: async () => ({ props: {}, metadata: appConfig.defaultMetadata }),
+				resolveDependencies: async () => [],
+				buildPageBrowserGraph: async () => undefined,
+				shouldRenderPageComponent: () => true,
+				renderPageComponent: async () => ({
+					html: '<main>Page</main>',
+					canAttachAttributes: true,
+					integrationName: 'ghtml',
+				}),
+				renderRouteBody: async () =>
+					new ReadableStream({
+						start(controller) {
+							controller.enqueue(encoder.encode('<html><body><main>Streamed</main></body></html>'));
+							controller.close();
+						},
+					}) as unknown as BodyInit,
+				transformRouteResponse: async (response) => response.body as RouteRendererBody,
+			}),
+		);
+		expect(result.cacheStrategy).toEqual({ revalidate: 60 });
+		expect(result.body).toBeInstanceOf(ReadableStream);
+		expect(await new Response(result.body as BodyInit).text()).toContain('<main>Streamed</main>');
+	});
+	it('applies root and document attributes to fully resolved route HTML', async () => {
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
+		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
+		const Page = (() => '<main>Page</main>') as EcoComponent<Record<string, unknown>>;
+		(Page as EcoComponent<Record<string, unknown>> & { cache?: unknown }).cache = { revalidate: 60 };
+		const result = await flow.execute(
+			{
+				file: '/app/pages/index.tsx',
+				params: {},
+				query: {},
+			} as unknown as RouteRendererOptions,
+			createFlowAdapter({
+				resolvePageModule: async () => ({ Page, integrationSpecificProps: {} }),
+				getHtmlTemplate: async () => HtmlTemplate,
+				resolvePageData: async () => ({ props: {}, metadata: appConfig.defaultMetadata }),
+				resolveDependencies: async () => [],
+				buildPageBrowserGraph: async () => undefined,
+				shouldRenderPageComponent: () => true,
+				renderPageComponent: async () => ({
+					html: '<main>Page</main>',
+					canAttachAttributes: true,
+					integrationName: 'ghtml',
+					rootAttributes: { 'data-eco-component-id': 'eco-page-root' },
+				}),
+				renderRouteBody: async () => '<html><body><main>Resolved</main></body></html>',
+				getRouteHtmlFinalization: () => ({
+					finalizeHtml: (html) =>
+						html
+							.replace('<html', '<html data-eco-document-owner="react-router"')
+							.replace('<main', '<main data-eco-component-id="eco-page-root"'),
+				}),
+				transformRouteResponse: async (response) => await response.text(),
+			}),
+		);
+		expect(result.cacheStrategy).toEqual({ revalidate: 60 });
+		expect(result.body).toContain('<html data-eco-document-owner="react-router"><body>');
+		expect(result.body).toContain('<main data-eco-component-id="eco-page-root">Resolved</main>');
+	});
+	it('throws when route HTML contains escaped unresolved eco-marker artifacts', async () => {
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
+		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
+		const Page = (() => '<main>Page</main>') as EcoComponent<Record<string, unknown>>;
+		await expect(
+			flow.execute(
+				{
+					file: '/app/pages/index.tsx',
+					params: {},
+					query: {},
+				} as unknown as RouteRendererOptions,
+				createFlowAdapter({
+					resolvePageModule: async () => ({ Page, integrationSpecificProps: {} }),
+					getHtmlTemplate: async () => HtmlTemplate,
+					resolvePageData: async () => ({ props: {}, metadata: appConfig.defaultMetadata }),
+					resolveDependencies: async () => [],
+					buildPageBrowserGraph: async () => undefined,
+					shouldRenderPageComponent: () => true,
+					renderPageComponent: async () => ({
+						html: '<main>Page</main>',
+						canAttachAttributes: true,
+						integrationName: 'ghtml',
+					}),
+					renderRouteBody: async () =>
+						'<html><body>&amp;lt;eco-marker data-eco-node-id=&quot;n_2&quot; data-eco-component-ref=&quot;page-component&quot; data-eco-props-ref=&quot;p_2&quot;&amp;gt;&amp;lt;/eco-marker&amp;gt;</body></html>',
+					transformRouteResponse: async (response) => await response.text(),
+				}),
+			),
+		).rejects.toThrow('Full-route unresolved-marker fallback has been removed');
+	});
+	it('throws when route HTML returns unresolved eco-marker artifact HTML', async () => {
+		const flow = new RouteRenderOrchestrator(appConfig, assetProcessingService);
+		const HtmlTemplate = (() => '<html></html>') as EcoComponent<HtmlTemplateProps>;
+		const Page = (() => '<main>Page</main>') as EcoComponent<Record<string, unknown>>;
+		await expect(
+			flow.execute(
+				{
+					file: '/app/pages/index.tsx',
+					params: {},
+					query: {},
+				} as unknown as RouteRendererOptions,
+				createFlowAdapter({
+					resolvePageModule: async () => ({ Page, integrationSpecificProps: {} }),
+					getHtmlTemplate: async () => HtmlTemplate,
+					resolvePageData: async () => ({ props: {}, metadata: appConfig.defaultMetadata }),
+					resolveDependencies: async () => [],
+					buildPageBrowserGraph: async () => undefined,
+					shouldRenderPageComponent: () => true,
+					renderPageComponent: async () => ({
+						html: '<main>Page</main>',
+						canAttachAttributes: true,
+						integrationName: 'ghtml',
+					}),
+					renderRouteBody: async () =>
+						'<html><body><eco-marker data-eco-node-id="n_1" data-eco-component-ref="unexpected-marker" data-eco-props-ref="p_1"></eco-marker></body></html>',
+					transformRouteResponse: async (response) => await response.text(),
+				}),
+			),
+		).rejects.toThrow('Full-route unresolved-marker fallback has been removed');
+	});
+});