@ecopages/core 0.2.0-beta.9 → 0.2.0-rc.1

package/src/services/cache/page-cache-service.js

@@ -1,152 +1,239 @@
-import { appLogger } from "../../global/app-logger.js";
-import { MemoryCacheStore } from "./memory-cache-store.js";
-class PageCacheService {
-  store;
-  enabled;
-  regenerationPromises = /* @__PURE__ */ new Map();
-  constructor(options = {}) {
-    this.store = options.store ?? new MemoryCacheStore();
-    this.enabled = options.enabled ?? true;
-  }
-  /**
-   * Generate a cache key from URL and optional params.
-   * Uses full URL (path + query) as the key.
-   */
-  generateCacheKey(url) {
-    return url;
-  }
-  /**
-   * Check if an entry is stale (past its revalidation time).
-   */
-  isStale(entry) {
-    if (entry.revalidateAfter === null) return false;
-    return Date.now() > entry.revalidateAfter;
-  }
-  /**
-   * Create a cache entry from rendered HTML.
-   */
-  createEntry(html, strategy) {
-    const now = Date.now();
-    let revalidateAfter = null;
-    let tags = [];
-    if (strategy === "static") {
-      revalidateAfter = null;
-    } else if (strategy === "dynamic") {
-      revalidateAfter = 0;
-    } else if (typeof strategy === "object") {
-      revalidateAfter = now + strategy.revalidate * 1e3;
-      tags = strategy.tags ?? [];
-    }
-    return {
-      html,
-      createdAt: now,
-      revalidateAfter,
-      tags,
-      strategy
-    };
-  }
-  /**
-   * Get cached content or create new content with stale-while-revalidate semantics.
-   * @param key - Cache key (URL path + query)
-   * @param defaultStrategy - Default strategy if page doesn't specify one
-   * @param renderFn - Function that renders the page and returns HTML + strategy
-   */
-  async getOrCreate(key, defaultStrategy, renderFn) {
-    if (!this.enabled) {
-      const { html, strategy } = await renderFn();
-      return { html, status: "miss", strategy };
-    }
-    const entry = await this.store.get(key);
-    if (!entry) {
-      const { html, strategy } = await renderFn();
-      const effectiveStrategy = strategy ?? defaultStrategy;
-      if (effectiveStrategy === "dynamic") {
-        return { html, status: "miss", strategy: effectiveStrategy };
-      }
-      const newEntry = this.createEntry(html, effectiveStrategy);
-      await this.store.set(key, newEntry);
-      return { html, status: "miss", strategy: effectiveStrategy };
-    }
-    if (!this.isStale(entry)) {
-      return { html: entry.html, status: "hit", strategy: entry.strategy };
-    }
-    this.regenerateInBackground(key, entry.strategy, renderFn);
-    return { html: entry.html, status: "stale", strategy: entry.strategy };
-  }
-  /**
-   * Regenerate content in the background without blocking the response.
-   * Uses promise deduplication to prevent multiple concurrent regenerations.
-   */
-  regenerateInBackground(key, fallbackStrategy, renderFn) {
-    if (this.regenerationPromises.has(key)) {
-      return;
-    }
-    const regeneratePromise = (async () => {
-      try {
-        const { html, strategy } = await renderFn();
-        const effectiveStrategy = strategy ?? fallbackStrategy;
-        const newEntry = this.createEntry(html, effectiveStrategy);
-        await this.store.set(key, newEntry);
-        return html;
-      } finally {
-        this.regenerationPromises.delete(key);
-      }
-    })();
-    this.regenerationPromises.set(key, regeneratePromise);
-    queueMicrotask(() => {
-      regeneratePromise.catch((error) => {
-        appLogger.error(`[PageCacheService] Failed to regenerate: ${key}`, error);
-      });
-    });
-  }
-  /**
-   * Invalidate cache entries by tags.
-   */
-  async invalidateByTags(tags) {
-    return this.store.invalidateByTags(tags);
-  }
-  /**
-   * Invalidate cache entries by paths.
-   */
-  async invalidateByPaths(paths) {
-    return this.store.invalidateByPaths(paths);
-  }
-  /**
-   * Clear all cached entries.
-   */
-  async clear() {
-    return this.store.clear();
-  }
-  /**
-   * Get cache statistics.
-   */
-  async stats() {
-    return this.store.stats?.() ?? { entries: 0 };
-  }
-  /**
-   * Get the underlying cache store.
-   */
-  getStore() {
-    return this.store;
-  }
+/**
+ * Page cache service with ISR (Incremental Static Regeneration) support.
+ * Handles stale-while-revalidate semantics and background regeneration.
+ * @module
+ */
+import { appLogger } from '../../global/app-logger.js';
+import { MemoryCacheStore } from './memory-cache-store.js';
+import { HtmlPageCacheDependencyIndex } from './html-page-cache-dependency-index.js';
+/**
+ * Core page caching service with ISR support.
+ */
+export class PageCacheService {
+    store;
+    enabled;
+    dependencyIndex;
+    regenerationPromises = new Map();
+    missPromises = new Map();
+    constructor(options = {}) {
+        this.store = options.store ?? new MemoryCacheStore();
+        this.enabled = options.enabled ?? true;
+        this.dependencyIndex = options.dependencyIndex ?? new HtmlPageCacheDependencyIndex();
+    }
+    /**
+     * Generate a cache key from URL and optional params.
+     * Uses full URL (path + query) as the key.
+     */
+    generateCacheKey(url) {
+        return url;
+    }
+    /**
+     * Check if an entry is stale (past its revalidation time).
+     */
+    isStale(entry) {
+        if (entry.revalidateAfter === null)
+            return false;
+        return Date.now() > entry.revalidateAfter;
+    }
+    /**
+     * Create a cache entry from rendered HTML.
+     */
+    createEntry(html, strategy) {
+        const now = Date.now();
+        let revalidateAfter = null;
+        let tags = [];
+        if (strategy === 'static') {
+            revalidateAfter = null;
+        }
+        else if (strategy === 'dynamic') {
+            revalidateAfter = 0;
+        }
+        else if (typeof strategy === 'object') {
+            revalidateAfter = now + strategy.revalidate * 1000;
+            tags = strategy.tags ?? [];
+        }
+        return {
+            html,
+            createdAt: now,
+            revalidateAfter,
+            tags,
+            strategy,
+        };
+    }
+    /**
+     * Get cached content or create new content with stale-while-revalidate semantics.
+     * @param key - Cache key (URL path + query)
+     * @param defaultStrategy - Default strategy if page doesn't specify one
+     * @param renderFn - Function that renders the page and returns HTML + strategy
+     */
+    async getOrCreate(key, defaultStrategy, renderFn, options) {
+        if (!this.enabled) {
+            const { html, strategy } = await renderFn();
+            return { html, status: 'miss', strategy };
+        }
+        const pendingMiss = this.missPromises.get(key);
+        if (pendingMiss) {
+            return pendingMiss;
+        }
+        const missPromise = this.resolveOrCreate(key, defaultStrategy, renderFn, options).finally(() => {
+            this.missPromises.delete(key);
+        });
+        this.missPromises.set(key, missPromise);
+        return missPromise;
+    }
+    async resolveOrCreate(key, defaultStrategy, renderFn, options) {
+        const entry = await this.store.get(key);
+        if (!entry) {
+            const { html, strategy, sourceDependencyPaths } = await renderFn();
+            const effectiveStrategy = strategy ?? defaultStrategy;
+            if (effectiveStrategy === 'dynamic') {
+                return { html, status: 'miss', strategy: effectiveStrategy };
+            }
+            const newEntry = this.createEntry(html, effectiveStrategy);
+            await this.store.set(key, newEntry);
+            this.registerDependencyPaths(key, options?.sourceDependencyPaths, sourceDependencyPaths);
+            return { html, status: 'miss', strategy: effectiveStrategy };
+        }
+        if (!this.isStale(entry)) {
+            return { html: entry.html, status: 'hit', strategy: entry.strategy };
+        }
+        this.regenerateInBackground(key, entry.strategy, renderFn);
+        return { html: entry.html, status: 'stale', strategy: entry.strategy };
+    }
+    registerDependencyPaths(key, initialPaths, renderedPaths) {
+        const mergedPaths = new Set();
+        for (const sourcePath of initialPaths ?? []) {
+            mergedPaths.add(sourcePath);
+        }
+        for (const sourcePath of renderedPaths ?? []) {
+            mergedPaths.add(sourcePath);
+        }
+        if (mergedPaths.size > 0) {
+            this.dependencyIndex.register(key, [...mergedPaths]);
+        }
+    }
+    /**
+     * Regenerate content in the background without blocking the response.
+     * Uses promise deduplication to prevent multiple concurrent regenerations.
+     */
+    regenerateInBackground(key, fallbackStrategy, renderFn) {
+        if (this.regenerationPromises.has(key)) {
+            return;
+        }
+        const regeneratePromise = (async () => {
+            try {
+                const { html, strategy, sourceDependencyPaths } = await renderFn();
+                const effectiveStrategy = strategy ?? fallbackStrategy;
+                const newEntry = this.createEntry(html, effectiveStrategy);
+                await this.store.set(key, newEntry);
+                this.registerDependencyPaths(key, undefined, sourceDependencyPaths);
+                return html;
+            }
+            finally {
+                this.regenerationPromises.delete(key);
+            }
+        })();
+        this.regenerationPromises.set(key, regeneratePromise);
+        queueMicrotask(() => {
+            regeneratePromise.catch((error) => {
+                appLogger.error(`[PageCacheService] Failed to regenerate: ${key}`, error);
+            });
+        });
+    }
+    /**
+     * Invalidate cache entries by tags.
+     */
+    async invalidateByTags(tags) {
+        return this.store.invalidateByTags(tags);
+    }
+    /**
+     * Invalidate cache entries by paths.
+     */
+    async invalidateByPaths(paths) {
+        return this.store.invalidateByPaths(paths);
+    }
+    /**
+     * Invalidates cached HTML entries that registered the given source paths.
+     */
+    async invalidateBySourceDependencyPaths(sourcePaths) {
+        const cacheKeys = this.dependencyIndex.resolveCacheKeysForSourcePaths(sourcePaths);
+        let count = 0;
+        for (const cacheKey of cacheKeys) {
+            if (await this.store.delete(cacheKey)) {
+                count += 1;
+            }
+            this.dependencyIndex.unregister(cacheKey);
+        }
+        return count;
+    }
+    getDependencyIndex() {
+        return this.dependencyIndex;
+    }
+    /**
+     * Clear all cached entries.
+     */
+    async clear() {
+        this.dependencyIndex.clear();
+        return this.store.clear();
+    }
+    /**
+     * Get cache statistics.
+     */
+    async stats() {
+        return this.store.stats?.() ?? { entries: 0 };
+    }
+    /**
+     * Get the underlying cache store.
+     */
+    getStore() {
+        return this.store;
+    }
+}
+/**
+ * Generate Cache-Control header value from cache strategy.
+ */
+export function getCacheControlHeader(strategy) {
+    if (strategy === 'disabled') {
+        return 'no-store, must-revalidate';
+    }
+    if (strategy === 'static') {
+        return 'public, max-age=31536000, immutable';
+    }
+    if (strategy === 'dynamic') {
+        return 'no-store, must-revalidate';
+    }
+    if (typeof strategy === 'object') {
+        const swr = strategy.revalidate * 2;
+        return `public, max-age=${strategy.revalidate}, stale-while-revalidate=${swr}`;
+    }
+    return 'no-store';
+}
+const pageCacheByAppConfig = new WeakMap();
+/**
+ * Registers the page cache service for one app config instance.
+ */
+export function registerAppPageCacheService(appConfig, service) {
+    if (service) {
+        pageCacheByAppConfig.set(appConfig, service);
+        return;
+    }
+    pageCacheByAppConfig.delete(appConfig);
+}
+/**
+ * Returns the registered page cache service for one app config, if any.
+ */
+export function getAppPageCacheService(appConfig) {
+    return pageCacheByAppConfig.get(appConfig) ?? null;
+}
+/**
+ * Clears rendered HTML cache entries for one app during development invalidation.
+ */
+export async function clearAppPageCache(appConfig) {
+    await getAppPageCacheService(appConfig)?.clear();
 }
-function getCacheControlHeader(strategy) {
-  if (strategy === "disabled") {
-    return "no-store, must-revalidate";
-  }
-  if (strategy === "static") {
-    return "public, max-age=31536000, immutable";
-  }
-  if (strategy === "dynamic") {
-    return "no-store, must-revalidate";
-  }
-  if (typeof strategy === "object") {
-    const swr = strategy.revalidate * 2;
-    return `public, max-age=${strategy.revalidate}, stale-while-revalidate=${swr}`;
-  }
-  return "no-store";
+/**
+ * Invalidates rendered HTML cache entries that depend on the given source paths.
+ */
+export async function invalidateAppPageCacheBySourcePaths(appConfig, sourcePaths) {
+    return (await getAppPageCacheService(appConfig)?.invalidateBySourceDependencyPaths(sourcePaths)) ?? 0;
 }
-export {
-  PageCacheService,
-  getCacheControlHeader
-};

package/src/services/cache/page-request-cache-coordinator.service.d.ts

@@ -10,7 +10,8 @@ import type { CacheStrategy, RenderResult } from './cache.types.js';
 export declare class PageRequestCacheCoordinator {
     private cacheService;
     private defaultCacheStrategy;
-    constructor(cacheService: PageCacheService | null, defaultCacheStrategy: CacheStrategy);
+    private readonly getRuntimeAssetGeneration?;
+    constructor(cacheService: PageCacheService | null, defaultCacheStrategy: CacheStrategy, getRuntimeAssetGeneration?: () => number);
     /**
      * Builds the cache key used for page lookups.
      *

package/src/services/cache/page-request-cache-coordinator.service.js

@@ -1,109 +1,119 @@
-import { getCacheControlHeader } from "./page-cache-service.js";
-class PageRequestCacheCoordinator {
-  cacheService;
-  defaultCacheStrategy;
-  constructor(cacheService, defaultCacheStrategy) {
-    this.cacheService = cacheService;
-    this.defaultCacheStrategy = defaultCacheStrategy;
-  }
-  /**
-   * Builds the cache key used for page lookups.
-   *
-   * Query parameters are part of the key so two requests that hit the same
-   * pathname but differ by search params do not share the same rendered entry.
-   *
-   * @param input Pathname plus optional query record.
-   * @returns Stable cache key for the request.
-   */
-  buildCacheKey(input) {
-    let key = input.pathname;
-    if (input.query && Object.keys(input.query).length > 0) {
-      const queryString = new URLSearchParams(input.query).toString();
-      key += `?${queryString}`;
+import { getCacheControlHeader } from './page-cache-service.js';
+import { getRequestPipelineMetricsHeaderName, isRequestPipelineMetricsEnabled, serializeRequestPipelineMetricsHeader, } from '../../diagnostics/request-pipeline-metrics.js';
+import { isDevelopmentRuntime } from '../../utils/runtime.js';
+/**
+ * Coordinates request-time page caching concerns around one render invocation.
+ *
+ * This service keeps `FileSystemResponseMatcher` from owning low-level cache
+ * policy mechanics such as cache key construction, `dynamic` bypass behavior,
+ * body normalization for cache storage, and final cache header generation.
+ */
+export class PageRequestCacheCoordinator {
+    cacheService;
+    defaultCacheStrategy;
+    getRuntimeAssetGeneration;
+    constructor(cacheService, defaultCacheStrategy, getRuntimeAssetGeneration) {
+        this.cacheService = cacheService;
+        this.defaultCacheStrategy = defaultCacheStrategy;
+        this.getRuntimeAssetGeneration = getRuntimeAssetGeneration;
     }
-    return key;
-  }
-  /**
-   * Resolves a render request through the configured cache policy.
-   *
-   * Pages using `dynamic` rendering, or applications without a cache service,
-   * bypass cache lookup entirely and still receive the same response header
-   * contract as cached pages.
-   *
-   * @param options Cache coordination inputs for one page request.
-   * @returns HTTP response with cache headers applied.
-   */
-  async render(options) {
-    if (!this.cacheService || options.pageCacheStrategy === "dynamic") {
-      const { html, strategy } = await options.renderFn();
-      return this.createCachedResponse(html, strategy, "disabled");
+    /**
+     * Builds the cache key used for page lookups.
+     *
+     * Query parameters are part of the key so two requests that hit the same
+     * pathname but differ by search params do not share the same rendered entry.
+     *
+     * @param input Pathname plus optional query record.
+     * @returns Stable cache key for the request.
+     */
+    buildCacheKey(input) {
+        let key = input.pathname;
+        if (input.query && Object.keys(input.query).length > 0) {
+            const queryString = new URLSearchParams(input.query).toString();
+            key += `?${queryString}`;
+        }
+        if (this.getRuntimeAssetGeneration && isDevelopmentRuntime()) {
+            key += `#__eco_rt=${this.getRuntimeAssetGeneration()}`;
+        }
+        return key;
     }
-    const result = await this.cacheService.getOrCreate(
-      options.cacheKey,
-      options.pageCacheStrategy,
-      options.renderFn
-    );
-    return this.createCachedResponse(result.html, result.strategy, result.status);
-  }
-  /**
-   * Exposes the underlying cache service for invalidation and adapter plumbing.
-   *
-   * @returns Configured cache service or `null` when caching is disabled.
-   */
-  getCacheService() {
-    return this.cacheService;
-  }
-  /**
-   * Returns the default render strategy used when a page does not declare one.
-   *
-   * @returns Application-level fallback cache strategy.
-   */
-  getDefaultCacheStrategy() {
-    return this.defaultCacheStrategy;
-  }
-  /**
-   * Normalizes various route render body shapes into a cacheable string.
-   *
-   * Page rendering may produce strings, buffers, byte arrays, or streams. The
-   * matcher needs a single representation before passing HTML through the cache
-   * layer, so this method centralizes the conversion rules.
-   *
-   * @param body Render output body in any supported form.
-   * @returns HTML string representation.
-   */
-  async bodyToString(body) {
-    if (typeof body === "string") {
-      return body;
+    /**
+     * Resolves a render request through the configured cache policy.
+     *
+     * Pages using `dynamic` rendering, or applications without a cache service,
+     * bypass cache lookup entirely and still receive the same response header
+     * contract as cached pages.
+     *
+     * @param options Cache coordination inputs for one page request.
+     * @returns HTTP response with cache headers applied.
+     */
+    async render(options) {
+        if (!this.cacheService || options.pageCacheStrategy === 'dynamic') {
+            const { html, strategy } = await options.renderFn();
+            return this.createCachedResponse(html, strategy, 'disabled');
+        }
+        const result = await this.cacheService.getOrCreate(options.cacheKey, options.pageCacheStrategy, options.renderFn);
+        return this.createCachedResponse(result.html, result.strategy, result.status);
     }
-    if (Buffer.isBuffer(body)) {
-      return body.toString("utf-8");
+    /**
+     * Exposes the underlying cache service for invalidation and adapter plumbing.
+     *
+     * @returns Configured cache service or `null` when caching is disabled.
+     */
+    getCacheService() {
+        return this.cacheService;
     }
-    if (body instanceof ReadableStream) {
-      return new Response(body).text();
+    /**
+     * Returns the default render strategy used when a page does not declare one.
+     *
+     * @returns Application-level fallback cache strategy.
+     */
+    getDefaultCacheStrategy() {
+        return this.defaultCacheStrategy;
     }
-    if (body instanceof Uint8Array) {
-      return new TextDecoder().decode(body);
+    /**
+     * Normalizes various route render body shapes into a cacheable string.
+     *
+     * Page rendering may produce strings, buffers, byte arrays, or streams. The
+     * matcher needs a single representation before passing HTML through the cache
+     * layer, so this method centralizes the conversion rules.
+     *
+     * @param body Render output body in any supported form.
+     * @returns HTML string representation.
+     */
+    async bodyToString(body) {
+        if (typeof body === 'string') {
+            return body;
+        }
+        if (Buffer.isBuffer(body)) {
+            return body.toString('utf-8');
+        }
+        if (body instanceof ReadableStream) {
+            return new Response(body).text();
+        }
+        if (body instanceof Uint8Array) {
+            return new TextDecoder().decode(body);
+        }
+        return String(body);
+    }
+    /**
+     * Creates the final HTML response with the current cache semantics encoded in
+     * response headers.
+     *
+     * @param html Rendered page HTML.
+     * @param strategy Effective cache strategy for the response.
+     * @param cacheStatus Status used for `X-Cache` and `Cache-Control` generation.
+     * @returns HTTP response ready to send to the client.
+     */
+    createCachedResponse(html, strategy, cacheStatus) {
+        const headers = {
+            'Content-Type': 'text/html',
+            'Cache-Control': getCacheControlHeader(cacheStatus === 'disabled' ? 'disabled' : strategy),
+            'X-Cache': cacheStatus.toUpperCase(),
+        };
+        if (isRequestPipelineMetricsEnabled()) {
+            headers[getRequestPipelineMetricsHeaderName()] = serializeRequestPipelineMetricsHeader();
+        }
+        return new Response(html, { headers });
     }
-    return String(body);
-  }
-  /**
-   * Creates the final HTML response with the current cache semantics encoded in
-   * response headers.
-   *
-   * @param html Rendered page HTML.
-   * @param strategy Effective cache strategy for the response.
-   * @param cacheStatus Status used for `X-Cache` and `Cache-Control` generation.
-   * @returns HTTP response ready to send to the client.
-   */
-  createCachedResponse(html, strategy, cacheStatus) {
-    const headers = {
-      "Content-Type": "text/html",
-      "Cache-Control": getCacheControlHeader(cacheStatus === "disabled" ? "disabled" : strategy),
-      "X-Cache": cacheStatus.toUpperCase()
-    };
-    return new Response(html, { headers });
-  }
 }
-export {
-  PageRequestCacheCoordinator
-};