@ecopages/core 0.2.0-alpha.3 → 0.2.0-alpha.31

package/src/route-renderer/GRAPH.md

@@ -1,40 +1,16 @@
 # Rendering Logic Graph
 
-This document maps the end-to-end rendering logic in core, including request-time rendering, explicit route rendering, static generation, and marker graph orchestration.
+This document maps the rendering logic in core using the ownership, foreign-child, and foreign-subtree model.
 
 ## Design Principles
 
-These diagrams are based on a few architectural assumptions that seem important to preserve:
+- Rendering entry points stay separate, but they converge on the same integration renderer contracts.
+- Integration selection happens outside the renderer. Once selected, the integration renderer owns the render pipeline.
+- Ownership is preparation-time metadata. Runtime handoff still happens inside renderer-owned foreign-child interception.
+- Route-level fallback resolution is gone. Unresolved `<eco-marker>` artifacts are now a failure signal.
+- Asset emission converges into one final HTML transformation step.
 
-- **Rendering entry points are separate, but should converge on shared renderer contracts.**
-  Request-time page rendering, explicit view rendering, and static generation all eventually depend on the same integration renderer behavior.
-- **Integration choice should remain a boundary concern.**
-  Adapters and route matchers decide which renderer to use; once selected, the integration renderer owns the page render pipeline.
-- **Data resolution should happen before HTML transformation.**
-  Static props, metadata, dependency processing, and route assets are all upstream of final HTML injection.
-- **Marker graph orchestration should be a post-render reconciliation step.**
-  The initial integration render may emit deferred component markers; those are resolved after the first HTML pass, not during route matching.
-- **Marker emission is integration-defined boundary behavior.**
-  Markers are emitted when the active render boundary policy decides a component boundary must be deferred. If no `eco-marker` tokens are emitted, the marker graph stage is skipped entirely.
-- **The marker pipeline remains generic after emission.**
-  Once markers exist, core resolves them generically through marker graph extraction, integration renderer dispatch, asset collection, and HTML replacement. The current built-in React integration is one concrete consumer of that mechanism.
-- **Caching policy is authoritative at the page layer.**
-  Middleware, locals, and response reuse all depend on the effective page cache strategy.
-- **Asset emission should converge into one injection stage.**
-  Route-level assets, integration assets, page-root component assets, and marker-generated assets all end up in the HTML transformer.
-
-## Entry Points
-
-There are three main rendering entry points:
-
-1. **Runtime request rendering**
-    - handled through the server adapters and file-system route matching
-2. **Explicit rendering APIs**
-    - handled through `renderToResponse()` and route-handler render context helpers
-3. **Static site generation**
-    - handled through explicit route generation and route renderer reuse at build time
-
-## 1) Runtime Request Flow (Bun and Node)
+## 1) Runtime Request Flow
 
 ```mermaid
 flowchart TD
@@ -53,335 +29,117 @@ flowchart TD
   K --> L[RouteRenderer createRoute]
   L --> M[IntegrationRenderer execute]
   M --> N[response body and cache strategy]
-
-  J --> O{Static asset request?}
-  O -- Yes --> P[FileSystemServerResponseFactory createFileResponse]
-  O -- No --> Q[FileSystemServerResponseFactory createCustomNotFoundResponse]
-  Q --> R[routeRendererFactory createRenderer for 404 template]
-  R --> S[RouteRenderer createRoute]
 ```
 
-## 2) FS Route Rendering + Middleware + Cache
+## 2) Route Render Flow
 
-This is the most operationally important runtime path because it is where middleware, locals, and cache behavior are coordinated.
+`IntegrationRenderer.execute()` delegates shared route orchestration to `RouteRenderFlow`.
 
 ```mermaid
 flowchart TD
-  A[FileSystemResponseMatcher handleMatch] --> B[PageModuleImportService importModule]
-  B --> C[read Page cache and Page middleware]
-  C --> D[FileRouteMiddlewarePipeline assertValidConfiguration]
-  D --> E{Middleware exists?}
-
-  E -- Yes --> F{cache dynamic?}
-  F -- No --> G[throw LocalsAccessError]
-  F -- Yes --> H[FileRouteMiddlewarePipeline createContext]
-  H --> I[FileRouteMiddlewarePipeline run]
-
-  E -- No --> J[renderResponse]
-  I --> J
-
-  J --> K[PageRequestCacheCoordinator render]
-  K --> L{cache disabled OR dynamic page?}
-  L -- Yes --> M[renderFn directly]
-  L -- No --> N[PageCacheService getOrCreate]
-
-  M --> O[routeRenderer createRoute]
-  N --> O
-  O --> P[PageRequestCacheCoordinator bodyToString]
-  P --> Q[html and strategy]
-  Q --> R[createCachedResponse with cache headers]
-```
-
-## 3) RouteRendererFactory Selection Logic
-
-This is a small but important boundary. It centralizes integration selection and renderer reuse, which helps keep adapter code thin.
-
-```mermaid
-flowchart TD
-  A[createRenderer filePath] --> B[getRouteRendererEngine filePath]
-  B --> C[getIntegrationPlugin by template extension]
-  C --> D{renderer cached by integration name?}
-  D -- Yes --> E[Reuse renderer]
-  D -- No --> F[integrationPlugin.initializeRenderer]
-  F --> G[Cache renderer]
-  E --> H[RouteRenderer]
-  G --> H
-
-  I[getRendererByIntegration integrationName] --> J{plugin exists?}
-  J -- No --> K[return null]
-  J -- Yes --> L{renderer cached?}
-  L -- Yes --> M[Reuse renderer]
-  L -- No --> N[initializeRenderer + cache]
-```
-
-## 4) IntegrationRenderer Pipeline
-
-The original single graph was accurate but a bit dense. Splitting it into preparation and execution phases makes the orchestration easier to reason about.
-
-### 4.1 Render preparation via `RenderPreparationService`
-
-```mermaid
-flowchart TD
-  A[IntegrationRenderer prepareRenderOptions] --> B[RenderPreparationService prepare]
+  A[IntegrationRenderer.execute] --> B[RouteRenderFlow.prepareRenderOptions]
   B --> C[resolvePageModule]
-  C --> D[resolvePageData staticProps to metadata]
-  D --> E[resolveDependencies and used integration deps and route assets]
-  E --> F{shouldRenderPageComponent?}
-  F -- Yes --> G[renderPageRoot via renderComponent]
-  F -- No --> H[skip page root component render]
-  G --> I[merge component assets]
-  H --> I
-  I --> J[collect lazy triggers]
-  J --> K{triggers found?}
-  K -- Yes --> L[buildGlobalInjectorAssets]
-  K -- No --> M[continue]
-  L --> M
-  M --> N[HtmlPostProcessingService dedupeProcessedAssets]
-  N --> O[htmlTransformer setProcessedDependencies]
-  O --> P[return normalized render options]
-```
-
-### 4.2 Main execute flow via `RenderExecutionService`
-
-Important nuance: this phase does not always run marker graph resolution. It only does that when the first render pass actually produced `eco-marker` placeholders. In practice today, that usually means a non-React renderer crossed into React component rendering and deferred those nodes for the second pass.
-
-```mermaid
-flowchart TD
-  A[IntegrationRenderer execute] --> B[RenderExecutionService execute]
-  B --> C[prepareRenderOptions]
-  C --> D[runWithComponentRenderContext then render]
-  D --> E[normalize response body to renderedHtml]
-  E --> F[merge captured and explicit componentGraphContext]
-  F --> G{contains eco marker token?}
-  G -- Yes --> H[resolveMarkerGraphHtml]
-  G -- No --> I[skip graph resolution]
-  H --> J[HtmlPostProcessingService dedupeProcessedAssets]
-  J --> K[merge marker assets into transformer deps]
-  I --> L{root attributes attachable?}
+  C --> D[ownershipValidationService.validate]
+  D --> E[resolvePageData]
+  E --> F[ownershipPlanningService.buildPlan]
+  F --> G[resolveDependencies]
+  G --> H[buildPageBrowserGraph]
+  H --> I{shouldRenderPageComponent?}
+  I -- Yes --> J[renderPageComponent]
+  I -- No --> K[skip page-root render]
+  J --> L[merge component assets]
   K --> L
-  L -- Yes --> M[HtmlPostProcessingService applyAttributesToFirstBodyElement]
-  L -- No --> N[leave html unchanged]
-  M --> O[htmlTransformer transform]
-  N --> O
-  O --> P[return body stream and cache strategy]
-```
-
-### 4.3 Render preparation responsibilities
-
-```mermaid
-flowchart LR
-  A[Page module loader] --> B[static props]
-  B --> C[metadata]
-  C --> D[page props and locals]
-
-  E[dependency resolver] --> F[component assets]
-  F --> G[integration assets]
-  G --> H[route assets]
-  H --> I[global injector assets]
-
-  D --> J[prepared render options]
-  I --> J
+  L --> M[collect injector and eager SSR lazy assets]
+  M --> N[build pagePackage and prepared render options]
+  N --> O[callbacks.render]
+  O --> P[capture rendered body as html]
+  P --> Q[inspect unresolved marker artifacts]
+  Q --> R{unresolved eco-marker remains?}
+  R -- Yes --> S[throw unresolved artifact error]
+  R -- No --> T[stamp root or document attributes when needed]
+  T --> U[htmlTransformer transform]
+  U --> V[final body and cache strategy]
 ```
 
-### 4.4 Service boundary map
-
-```mermaid
-flowchart LR
-  A[IntegrationRenderer] --> B[RenderPreparationService]
-  A --> C[RenderExecutionService]
-  A --> D[MarkerGraphResolver]
-  A --> E[HtmlPostProcessingService]
-  A --> F[PageModuleLoaderService]
-  A --> G[DependencyResolverService]
-  A --> H[HtmlTransformerService]
-
-  B --> F
-  B --> G
-  B --> E
-  C --> D
-  C --> E
-  C --> H
-```
-
-## 5) Marker Emission + Graph Resolution
-
-This part is architecturally interesting because it introduces a second render stage. The first pass captures boundaries; the second pass resolves them in dependency order.
-
-If this feels complex, the simplest mental model is:
-
-- first pass: render everything that can be rendered safely right now
-- when a boundary cannot be rendered safely in the current integration pass, emit a placeholder marker instead
-- second pass: revisit those placeholders and render them using the correct integration renderer
-- final pass: merge any emitted assets and perform the normal HTML transformation
-
-In the current implementation, this marker path exists to defer React subtrees that cannot be rendered inline during the active non-React integration pass.
-
-Important clarification: not every integration automatically goes through this stage. The marker pipeline is conditional.
-
-- If the first render pass returns plain HTML with no `eco-marker` tokens, rendering continues directly to post-processing and HTML transformation.
-- If the first render pass emits `eco-marker` tokens, the marker graph is built and resolved before the final HTML rewrite.
-- In the current implementation, marker emission is triggered when the active render pass boundary policy decides that entering React should be deferred. The policy is injected through component render context, and the React integration currently opts into that deferred behavior.
-
-### Why this exists
-
-The marker pipeline exists because some component boundaries cannot always be rendered eagerly inside the current integration pass.
-
-Typical reasons include:
-
-- the child component belongs to a different integration/runtime
-- the child integration needs its own renderer entry point
-- the parent render needs to preserve ordering and slots before the child subtree is resolved
-- the child render may emit its own assets or root attributes that must be merged back into the final document
+## 3) Mixed-Integration Render Model
 
-So the first pass captures a stable placeholder plus serialized render context, and the second pass resolves those placeholders using the correct integration renderer.
+The renderer-level mental model is:
 
-Responsibility split:
-
-- core resolves the deferred marker mechanically: graph shape, refs, slot relationships, and target renderer lookup
-- the selected integration renderer resolves the actual component render once it receives `component`, `props`, and optional `children`
-
-Another way to say it:
-
-- a marker is a promise that says "this subtree will be rendered later by another renderer"
-- the marker stores just enough information to make that later render deterministic
-- the graph exists so nested deferred boundaries resolve from leaves to parents, preserving child insertion order and slot structure
-
-### 5.1 Marker emission in `eco.component` factory
-
-The key rule here today is: markers are not a general-purpose placeholder for every component. During an active component render pass, `eco.component` asks the current render boundary context whether the next boundary should be deferred. When the answer is defer, it captures props/refs/slot links and returns an `eco-marker` token instead of rendering the component immediately.
-
-For the current built-in integrations, this is how non-React renders defer React subtrees until the marker resolution pass.
+1. declared dependencies describe ownership
+2. active render context intercepts foreign children
+3. the owning renderer returns a foreign subtree
 
 ```mermaid
 flowchart TD
-  A[eco component render] --> B[getComponentRenderContext]
-  B --> C[boundaryContext decideBoundaryRender]
-  C --> D{decision is defer?}
-  D -- No --> E[render component content immediately]
-  D -- Yes --> F[create nodeId + propsRef]
-  F --> G[store props in propsByRef]
-  G --> H{children include eco-marker tokens?}
-  H -- Yes --> I[create slotRef and slotChildrenByRef links]
-  H -- No --> J[no slot links]
-  I --> K[createComponentMarker]
-  J --> K
-  K --> L[return eco marker token]
+  A[eco.component render] --> B[getComponentRenderContext]
+  B --> C[foreignChildRuntime interceptForeignChildSync]
+  C --> D{same integration?}
+  D -- Yes --> E[render inline]
+  D -- No --> F[delegate to owning renderer]
+  F --> G[owning renderer renderComponentWithForeignChildren]
+  G --> H[owning renderer renderForeignSubtree when payload form is needed]
+  H --> I[resolved html plus assets and attachment policy]
 ```
 
-### 5.2 Marker graph execution
+## 4) Queued Foreign-Subtree Resolution
 
-Once markers exist in the HTML, the second pass is integration-agnostic at execution time. Each marker carries its target integration name, so the resolver can ask the right renderer to render that specific node. Even though marker emission is currently React-focused, the resolution phase itself is generic and works off the marker payload plus renderer lookup.
-
-This means the marker itself is not interpreted by the integration renderer. Core interprets the marker and reconstructs render input; the integration renderer only performs the final component render.
+Some renderers cannot hand off foreign children inline. Those renderers can use the queue service during one render pass.
 
 ```mermaid
 flowchart TD
-  A[resolveMarkerGraphHtml] --> B[buildComponentRefRegistry]
-  B --> C[extractComponentGraph from html and slot registry]
-  C --> D[resolveComponentGraph in reverse levels]
-  D --> E[for each marker node]
-  E --> F[resolve component by componentRef]
-  F --> G[resolve props by propsRef]
-  G --> H[stitch child html from slotRef node ids]
-  H --> I[getIntegrationRendererForName]
-  I --> J[renderer.renderComponent]
-  J --> K[collect component assets]
-  K --> L[apply root attributes to first element]
-  L --> M[replace marker token in HTML]
-  M --> N[resolved html and assets]
+  A[current renderer encounters foreign child] --> B{can resolve inline?}
+  B -- Yes --> C[return resolved renderer-owned output]
+  B -- No --> D[queue foreign-subtree token]
+  D --> E[finish current render pass]
+  E --> F[QueuedForeignSubtreeResolutionService resolveQueuedHtml]
+  F --> G[resolve nested queued tokens first]
+  G --> H[dispatch foreign subtree to owning renderer]
+  H --> I[merge emitted assets and root attributes]
+  I --> J[replace token in html]
 ```
 
-## 6) Explicit Rendering Paths (outside FS page matching)
+## 5) Explicit Rendering Paths
 
-These paths are simpler than request-time file-system rendering because they bypass most router and cache orchestration.
+These paths bypass most filesystem routing, but they still converge on the same renderer contracts.
 
 ```mermaid
 flowchart TD
   A[ExplicitStaticRouteMatcher handleMatch] --> B[route loader returns view]
-  B --> C[read view integration metadata]
-  C --> D[routeRendererFactory getRendererByIntegration]
-  D --> E[optional view.staticProps]
-  E --> F[renderer renderToResponse]
-
-  G[createRenderContext render or renderPartial] --> H[get renderer from integrations list]
-  H --> I[merge props + locals]
-  I --> J[renderer renderToResponse]
-
-  K[StaticSiteGenerator explicit routes] --> L[getRendererByIntegration]
-  L --> M[optional staticPaths and staticProps]
-  M --> N[renderer renderToResponse]
-  N --> O[write html to dist]
-```
-
-## 7) Current Concrete Integration in core
+  B --> C[get renderer by integration]
+  C --> D[renderer renderToResponse]
 
-Today the concrete in-core renderer is `GhtmlRenderer`. That makes it a useful reference implementation for the abstract integration renderer contract.
+  E[render context render or renderPartial] --> F[get renderer from integrations list]
+  F --> G[renderer renderToResponse]
 
-```mermaid
-flowchart TD
-  A[GhtmlRenderer.render] --> B[Page params/query/props/locals]
-  B --> C{Layout exists?}
-  C -- Yes --> D[Layout wraps page content]
-  C -- No --> E[use page content]
-  D --> F[HtmlTemplate metadata + children + pageProps]
-  E --> F
-  F --> G[prepend DOCTYPE]
-
-  H[GhtmlRenderer renderToResponse] --> I{partial?}
-  I -- Yes --> J[return component html only]
-  I -- No --> K[resolve Layout and HtmlTemplate and metadata]
-  K --> L[prepend DOCTYPE]
-  J --> M[createHtmlResponse]
-  L --> M
+  H[StaticSiteGenerator explicit routes] --> I[get renderer by integration]
+  I --> J[renderer renderToResponse]
+  J --> K[write html to dist]
 ```
 
-## 8) Reading Order
+## 6) Reading Order
 
-For someone new to the rendering system, this is probably the most useful order to read the code:
+The most useful reading order is:
 
-1. `server-route-handler.ts`
-2. `fs-server-response-matcher.ts`
-3. `file-route-middleware-pipeline.ts`
-4. `page-request-cache-coordinator.service.ts`
-5. `route-renderer.ts`
-6. `integration-renderer.ts`
-7. `render-preparation.service.ts`
-8. `render-execution.service.ts`
-9. `marker-graph-resolver.ts`
-10. `html-post-processing.service.ts`
-11. `page-module-loader.ts`
-12. `dependency-resolver.ts`
-13. `component-marker.ts`
-14. `component-graph.ts`
-15. `component-graph-executor.ts`
-16. `eco.ts`
-17. `component-render-context.ts`
-18. `html-transformer.service.ts`
+1. `route-renderer.ts`
+2. `orchestration/route-render-flow.ts`
+3. `orchestration/integration-renderer.ts`
+4. `orchestration/ownership-validation.service.ts`
+5. `orchestration/ownership-planning.service.ts`
+6. `orchestration/component-render-context.ts`
+7. `orchestration/queued-foreign-subtree-resolution.service.ts`
+8. `page-loading/page-module-loader.ts`
+9. `page-loading/dependency-resolver.ts`
+10. `eco/eco.ts`
 
-## 9) Key Files
+## 7) Key Files
 
-- `packages/core/src/adapters/shared/server-adapter.ts`
-- `packages/core/src/adapters/shared/server-route-handler.ts`
-- `packages/core/src/adapters/shared/fs-server-response-matcher.ts`
-- `packages/core/src/adapters/shared/file-route-middleware-pipeline.ts`
-- `packages/core/src/adapters/shared/fs-server-response-factory.ts`
-- `packages/core/src/adapters/shared/explicit-static-route-matcher.ts`
-- `packages/core/src/adapters/shared/render-context.ts`
 - `packages/core/src/route-renderer/route-renderer.ts`
-- `packages/core/src/route-renderer/integration-renderer.ts`
-- `packages/core/src/route-renderer/render-preparation.service.ts`
-- `packages/core/src/route-renderer/render-execution.service.ts`
-- `packages/core/src/route-renderer/html-post-processing.service.ts`
-- `packages/core/src/route-renderer/marker-graph-resolver.ts`
-- `packages/core/src/route-renderer/component-marker.ts`
-- `packages/core/src/route-renderer/component-graph.ts`
-- `packages/core/src/route-renderer/component-graph-executor.ts`
-- `packages/core/src/route-renderer/page-module-loader.ts`
-- `packages/core/src/route-renderer/dependency-resolver.ts`
-- `packages/core/src/services/page-module-import.service.ts`
-- `packages/core/src/services/page-request-cache-coordinator.service.ts`
-- `packages/core/src/eco/component-render-context.ts`
+- `packages/core/src/route-renderer/orchestration/route-render-flow.ts`
+- `packages/core/src/route-renderer/orchestration/integration-renderer.ts`
+- `packages/core/src/route-renderer/orchestration/ownership-validation.service.ts`
+- `packages/core/src/route-renderer/orchestration/ownership-planning.service.ts`
+- `packages/core/src/route-renderer/orchestration/component-render-context.ts`
+- `packages/core/src/route-renderer/orchestration/queued-foreign-subtree-resolution.service.ts`
+- `packages/core/src/route-renderer/page-loading/page-module-loader.ts`
+- `packages/core/src/route-renderer/page-loading/dependency-resolver.ts`
 - `packages/core/src/eco/eco.ts`
-- `packages/core/src/services/html-transformer.service.ts`
-- `packages/core/src/services/cache/page-cache-service.ts`
-- `packages/core/src/integrations/ghtml/ghtml-renderer.ts`