@timber-js/app 0.2.0-alpha.1 → 0.2.0-alpha.100

package/src/plugins/dev-server.ts

@@ -15,10 +15,22 @@
 import type { Plugin, ViteDevServer, DevEnvironment } from 'vite';
 import type { IncomingMessage, ServerResponse } from 'node:http';
 import { join } from 'node:path';
-import type { PluginContext } from '#/index.js';
-import { setViteServer } from '#/server/dev-warnings.js';
-import { sendErrorToOverlay, classifyErrorPhase, parseFirstAppFrame } from './dev-error-overlay.js';
-import { compressResponse } from '#/server/compress.js';
+import type { PluginContext } from '../plugin-context.js';
+import { setViteServer } from '../dev-tools/warnings.js';
+import {
+  sendErrorToOverlay,
+  classifyErrorPhase,
+  fixErrorStacktrace,
+  parseFirstAppFrame,
+  type ErrorPhase,
+} from '../dev-tools/overlay.js';
+import {
+  generateDevErrorPage,
+  extractHmrOptions,
+  type DevErrorHmrOptions,
+} from '../dev-tools/error-page.js';
+import { addVirtualModuleContext } from '../config-validation.js';
+import { compressResponse } from '../server/compress.js';
 
 // ─── Constants ────────────────────────────────────────────────────────────
 
@@ -96,6 +108,21 @@ export function timberDevServer(ctx: PluginContext): Plugin {
       // Pre-hook — registers middleware before Vite's internals
       server.middlewares.use(createTimberMiddleware(server, ctx.root));
 
+      // Wrap server.listen() to close the holding server immediately
+      // before Vite binds the port — no gap where nothing is listening.
+      // The holding server was started in rootSync's config() hook to
+      // serve a loading page during initialization.
+      // See design/21-dev-server.md §"Startup Holding Server", TIM-665.
+      if (ctx.holdingServer) {
+        const originalListen = server.listen.bind(server);
+        const holdingRef = ctx.holdingServer;
+        ctx.holdingServer = null;
+        server.listen = async (port?: number, isRestart?: boolean) => {
+          await holdingRef.close().catch(() => {});
+          return originalListen(port, isRestart);
+        };
+      }
+
       // Log startup timing summary. configureServer runs on all plugins
       // before the server listens, so this captures the full cold start.
       ctx.timer.end('dev-server-setup');
@@ -122,6 +149,10 @@ export function timberDevServer(ctx: PluginContext): Plugin {
  * calls next() to let Vite handle them.
  */
 function createTimberMiddleware(server: ViteDevServer, projectRoot: string) {
+  // Extract HMR connection options once so the error page can construct
+  // a correct WebSocket URL (TIM-789).
+  const hmrOptions = extractHmrOptions(server.config);
+
   return async (req: IncomingMessage, res: ServerResponse, next: () => void): Promise<void> => {
     const url = req.url;
     if (!url) {
@@ -161,12 +192,38 @@ function createTimberMiddleware(server: ViteDevServer, projectRoot: string) {
 
       // Wire pipeline errors into the browser error overlay.
       // setDevPipelineErrorHandler is only defined in dev (rsc-entry.ts exports it).
+      // The handler receives optional RSC debug component data (component names,
+      // environments, stack frames) from the Flight debug channel for render errors.
       const setHandler = rscModule.setDevPipelineErrorHandler as
-        | ((fn: (error: Error, phase: string) => void) => void)
+        | ((
+            fn: (
+              error: Error,
+              phase: string,
+              debugComponents?: Array<{ name: string; env: string | null; stack: unknown[] | null }>
+            ) => void
+          ) => void)
         | undefined;
       if (typeof setHandler === 'function') {
-        setHandler((error) => {
-          sendErrorToOverlay(server, error, classifyErrorPhase(error, projectRoot), projectRoot);
+        setHandler((error, _phase, debugComponents) => {
+          sendErrorToOverlay(
+            server,
+            error,
+            classifyErrorPhase(error, projectRoot),
+            projectRoot,
+            debugComponents
+          );
+        });
+      }
+
+      // Wire source-map handler so error pages show original positions.
+      // fixErrorStacktrace rewrites the error's stack trace in-place using
+      // the Vite dev server's module graph. See TIM-811.
+      const setSourceMap = rscModule.setDevSourceMapHandler as
+        | ((fn: (error: Error) => void) => void)
+        | undefined;
+      if (typeof setSourceMap === 'function') {
+        setSourceMap((error: Error) => {
+          fixErrorStacktrace(server, error);
         });
       }
     } catch (error) {
@@ -174,9 +231,11 @@ function createTimberMiddleware(server: ViteDevServer, projectRoot: string) {
       // Vite may already show its own overlay for these, but we still
       // log to stderr with frame dimming for the terminal.
       if (error instanceof Error) {
+        // Add context for virtual:timber-* module errors
+        addTimberContext(error);
         sendErrorToOverlay(server, error, 'module-transform', projectRoot);
       }
-      respond500(res, error);
+      respond500(res, error, 'module-transform', projectRoot, hmrOptions);
       return;
     }
 
@@ -191,8 +250,20 @@ function createTimberMiddleware(server: ViteDevServer, projectRoot: string) {
       // Convert Node IncomingMessage → Web Request
       const webRequest = toWebRequest(req);
 
-      // Run the full pipeline
-      const webResponse = await handler(webRequest);
+      // Check for a platform-specific request wrapper (e.g., Cloudflare
+      // dev bindings). The cloudflareDevBindings() plugin stores a wrapper
+      // function on the server instance using a well-known Symbol. The
+      // wrapper runs the handler inside an ALS context so platform APIs
+      // like getCloudflareBindings() work during dev.
+      // See design/35-cloudflare-primitives.md §"Dev Experience".
+      const wrapper = (server as any)[Symbol.for('timber:dev-request-wrapper')] as
+        | (<T>(fn: () => T) => T)
+        | undefined;
+
+      // Run the full pipeline (wrapped if a platform dev plugin is active)
+      const webResponse = wrapper
+        ? await wrapper(() => handler(webRequest))
+        : await handler(webRequest);
 
       // Compress the response if the client supports it.
       // In dev mode, compression is always enabled for parity with production.
@@ -205,26 +276,68 @@ function createTimberMiddleware(server: ViteDevServer, projectRoot: string) {
       // Pipeline error — classify the phase, send to overlay, respond 500.
       // The dev server remains running for recovery on file fix + HMR.
       if (error instanceof Error) {
-        const phase = classifyErrorPhase(error, projectRoot);
-        sendErrorToOverlay(server, error, phase, projectRoot);
+        // Unwrap SsrStreamError to show the real cause in the error overlay.
+        // SsrStreamError wraps the original RSC render error with a generic
+        // message; the developer needs to see the actual error (e.g.,
+        // "useSegmentParams is not a function"), not the wrapper.
+        const displayError =
+          error.name === 'SsrStreamError' && error.cause instanceof Error ? error.cause : error;
+        const phase = classifyErrorPhase(displayError, projectRoot);
+        sendErrorToOverlay(server, displayError, phase, projectRoot);
+        respond500(res, displayError, phase, projectRoot, hmrOptions);
       } else {
         process.stderr.write(`\x1b[31m[timber] Dev server error:\x1b[0m ${String(error)}\n`);
+        respond500(res, error, 'render', projectRoot, hmrOptions);
       }
-      respond500(res, error);
     }
   };
 }
 
 /**
  * Send a 500 response without crashing the dev server.
+ *
+ * In dev mode, renders a styled HTML error page with source context,
+ * classified stack trace, and auto-reload on HMR. Falls back to
+ * text/plain if the HTML generator fails (must never crash).
  */
-function respond500(res: ServerResponse, error: unknown): void {
-  if (!res.headersSent) {
-    res.statusCode = 500;
-    res.setHeader('content-type', 'text/plain');
-    res.end(
-      `[timber] Internal server error\n\n${error instanceof Error ? (error.stack ?? error.message) : String(error)}`
-    );
+function respond500(
+  res: ServerResponse,
+  error: unknown,
+  phase: ErrorPhase,
+  projectRoot: string,
+  hmrOptions?: DevErrorHmrOptions
+): void {
+  if (res.headersSent) return;
+
+  // Try to render the rich HTML error page
+  if (error instanceof Error) {
+    try {
+      const html = generateDevErrorPage(error, phase, projectRoot, hmrOptions);
+      res.statusCode = 500;
+      res.setHeader('content-type', 'text/html; charset=utf-8');
+      res.end(html);
+      return;
+    } catch {
+      // Fall through to text/plain if the HTML generator fails
+    }
+  }
+
+  // Fallback: plain text (same as before)
+  res.statusCode = 500;
+  res.setHeader('content-type', 'text/plain');
+  res.end(
+    `[timber] Internal server error\n\n${error instanceof Error ? (error.stack ?? error.message) : String(error)}`
+  );
+}
+
+/**
+ * Add timber-specific context to an error's message if it references
+ * internal virtual modules (virtual:timber-*). Mutates the error in place.
+ */
+function addTimberContext(error: Error): void {
+  const enriched = addVirtualModuleContext(error.message);
+  if (enriched !== error.message) {
+    error.message = enriched;
   }
 }
 
@@ -317,6 +430,17 @@ async function sendWebResponse(nodeRes: ServerResponse, webResponse: Response):
   nodeRes.flushHeaders();
 
   const reader = webResponse.body.getReader();
+
+  // Cancel the reader when the client disconnects. This causes any pending
+  // reader.read() to reject, breaking the pump loop. Critical for SSE and
+  // other infinite streams — without this, disconnected clients leak readers.
+  let clientDisconnected = false;
+  const onClose = () => {
+    clientDisconnected = true;
+    reader.cancel('Client disconnected').catch(() => {});
+  };
+  nodeRes.on('close', onClose);
+
   try {
     while (true) {
       const { done, value } = await reader.read();
@@ -325,9 +449,18 @@ async function sendWebResponse(nodeRes: ServerResponse, webResponse: Response):
       // don't need back-pressure here — just keep pushing chunks.
       nodeRes.write(value);
     }
+  } catch (err) {
+    // reader.cancel() from the close handler causes read() to reject.
+    // This is expected on client disconnect — not an error.
+    if (!clientDisconnected) {
+      throw err;
+    }
   } finally {
+    nodeRes.off('close', onClose);
     reader.releaseLock();
-    nodeRes.end();
+    if (!nodeRes.writableEnded) {
+      nodeRes.end();
+    }
   }
 }
 

package/src/plugins/entries.ts

@@ -15,7 +15,7 @@ import type { Plugin } from 'vite';
 import { resolve, dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { existsSync } from 'node:fs';
-import type { PluginContext } from '#/index.js';
+import type { PluginContext } from '../plugin-context.js';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
@@ -34,6 +34,7 @@ const VIRTUAL_IDS = {
   browserEntry: 'virtual:timber-browser-entry',
   config: 'virtual:timber-config',
   instrumentation: 'virtual:timber-instrumentation',
+  cacheHandler: 'virtual:timber-cache-handler',
 } as const;
 
 /**
@@ -48,7 +49,7 @@ const VIRTUAL_IDS = {
 const ENTRY_FILE_MAP: Record<string, string> = {
   [VIRTUAL_IDS.rscEntry]: resolve(SRC_DIR, 'server', 'rsc-entry', 'index.ts'),
   [VIRTUAL_IDS.ssrEntry]: resolve(SRC_DIR, 'server', 'ssr-entry.ts'),
-  [VIRTUAL_IDS.browserEntry]: resolve(SRC_DIR, 'client', 'browser-entry.ts'),
+  [VIRTUAL_IDS.browserEntry]: resolve(SRC_DIR, 'client', 'browser-entry', 'index.ts'),
 };
 
 /** The \0-prefixed resolved ID for virtual:timber-config */
@@ -57,6 +58,9 @@ const RESOLVED_CONFIG_ID = `\0${VIRTUAL_IDS.config}`;
 /** The \0-prefixed resolved ID for virtual:timber-instrumentation */
 const RESOLVED_INSTRUMENTATION_ID = `\0${VIRTUAL_IDS.instrumentation}`;
 
+/** The \0-prefixed resolved ID for virtual:timber-cache-handler */
+const RESOLVED_CACHE_HANDLER_ID = `\0${VIRTUAL_IDS.cacheHandler}`;
+
 /**
  * Strip the \0 prefix from a module ID.
  *
@@ -94,12 +98,39 @@ function stripRootPrefix(id: string, root: string): string {
  *
  * Serializes output mode and feature flags for runtime consumption.
  */
-function generateConfigModule(ctx: PluginContext): string {
-  // Resolve cookie secrets: `secret` shorthand expands to `secrets: [secret]`
-  const cookieSecrets =
-    ctx.config.cookies?.secrets ??
-    (ctx.config.cookies?.secret ? [ctx.config.cookies.secret] : undefined);
+/**
+ * Extract the JSON-serializable subset of `forms` config.
+ *
+ * Drops function-valued `stripSensitiveFields` with a build-time warning —
+ * functions cannot cross the JSON boundary to the runtime, so users must
+ * configure function predicates per-action via `createActionClient` instead.
+ */
+function serializeFormsConfig(
+  forms: { stripSensitiveFields?: unknown } | undefined
+): { stripSensitiveFields?: boolean | readonly string[] } | undefined {
+  if (!forms) return undefined;
+  const opt = forms.stripSensitiveFields;
+  if (opt === undefined) return {};
+  if (typeof opt === 'boolean') return { stripSensitiveFields: opt };
+  if (Array.isArray(opt)) {
+    // Coerce to a string array and drop any non-string entries.
+    const names = opt.filter((v): v is string => typeof v === 'string');
+    return { stripSensitiveFields: names };
+  }
+  if (typeof opt === 'function') {
+    console.warn(
+      '[timber] forms.stripSensitiveFields was set to a function in timber.config.ts — ' +
+        'this is not supported at the global level (functions cannot be serialized ' +
+        'into the runtime config). Use a per-action override via ' +
+        '`createActionClient({ stripSensitiveFields: (name) => ... })` instead. ' +
+        'The built-in deny-list will be used globally.'
+    );
+    return {};
+  }
+  return {};
+}
 
+function generateConfigModule(ctx: PluginContext): string {
   const runtimeConfig = {
     output: ctx.config.output ?? 'server',
     csrf: ctx.config.csrf ?? true,
@@ -108,8 +139,24 @@ function generateConfigModule(ctx: PluginContext): string {
     dev: ctx.dev ?? false,
     slowPhaseMs: ctx.config.dev?.slowPhaseMs ?? 200,
     slowRequestMs: ctx.config.slowRequestMs ?? 3000,
-    cookieSecrets,
     topLoader: ctx.config.topLoader,
+    debug: ctx.config.debug ?? false,
+    serverTiming: ctx.config.serverTiming,
+    renderTimeoutMs: ctx.config.renderTimeoutMs ?? 30_000,
+    // Auto-generated sitemap config — opt-in via timber.config.ts.
+    // See design/16-metadata.md §"Auto-generated Sitemap"
+    sitemap: ctx.config.sitemap,
+    // Forms config — only the serializable subset. `stripSensitiveFields`
+    // accepts boolean | string[] at the global level. Functions must be
+    // configured per-action via `createActionClient({ stripSensitiveFields })`
+    // because JSON.stringify would silently drop them here. See TIM-816.
+    forms: serializeFormsConfig(ctx.config.forms),
+    // Per-build deployment ID for version skew detection (TIM-446).
+    // Null in dev mode — HMR handles code updates without full reloads.
+    deploymentId: ctx.deploymentId ?? null,
+    // Note: project root is NOT included here — it was leaking server
+    // filesystem paths to client bundles (TIM-787). Dev error pages get
+    // the root through the dev server, not the runtime config.
   };
 
   return [
@@ -128,11 +175,14 @@ function generateConfigModule(ctx: PluginContext): string {
  * Checks for instrumentation.ts, .js, and .mjs — matching the same
  * extensions as timber.config.ts detection.
  */
-function detectInstrumentationFile(root: string): string | null {
+export function detectInstrumentationFile(root: string): string | null {
   const extensions = ['.ts', '.js', '.mjs'];
-  for (const ext of extensions) {
-    const candidate = resolve(root, `instrumentation${ext}`);
-    if (existsSync(candidate)) return candidate;
+  const dirs = [root, resolve(root, 'src')];
+  for (const dir of dirs) {
+    for (const ext of extensions) {
+      const candidate = resolve(dir, `instrumentation${ext}`);
+      if (existsSync(candidate)) return candidate;
+    }
   }
   return null;
 }
@@ -172,6 +222,53 @@ export function generateInstrumentationModule(instrumentationPath: string | null
   ].join('\n');
 }
 
+/**
+ * Detect the user's timber.config file at the project root.
+ * Returns the absolute path or null if not found.
+ */
+function detectConfigFile(root: string): string | null {
+  const names = ['timber.config.ts', 'timber.config.js', 'timber.config.mjs'];
+  for (const name of names) {
+    const candidate = resolve(root, name);
+    if (existsSync(candidate)) return candidate;
+  }
+  return null;
+}
+
+/**
+ * Generate the virtual:timber-cache-handler module source.
+ *
+ * When the user's config has a cacheHandler, generates a module that
+ * dynamically imports the config file and extracts the cacheHandler.
+ * The cacheHandler is a class instance (e.g. RedisCacheHandler) that
+ * cannot be JSON-serialized into virtual:timber-config, so it must
+ * be loaded at runtime via dynamic import. See TIM-599.
+ */
+function generateCacheHandlerModule(configPath: string | null, hasCacheHandler: boolean): string {
+  if (configPath && hasCacheHandler) {
+    return [
+      '// Auto-generated cache handler loader — do not edit.',
+      '// Generated by timber-entries plugin.',
+      '',
+      `export default async function loadCacheHandler() {`,
+      `  const mod = await import(${JSON.stringify(configPath)});`,
+      `  const config = mod.default ?? mod;`,
+      `  return config.cacheHandler ?? null;`,
+      `}`,
+    ].join('\n');
+  }
+
+  return [
+    '// Auto-generated cache handler loader — do not edit.',
+    '// Generated by timber-entries plugin.',
+    '// No cacheHandler configured in timber.config.',
+    '',
+    `export default async function loadCacheHandler() {`,
+    `  return null;`,
+    `}`,
+  ].join('\n');
+}
+
 /**
  * Create the timber-entries Vite plugin.
  *
@@ -214,6 +311,11 @@ export function timberEntries(ctx: PluginContext): Plugin {
         return RESOLVED_INSTRUMENTATION_ID;
       }
 
+      // Check cache handler virtual module
+      if (cleanId === VIRTUAL_IDS.cacheHandler) {
+        return RESOLVED_CACHE_HANDLER_ID;
+      }
+
       return null;
     },
 
@@ -231,6 +333,11 @@ export function timberEntries(ctx: PluginContext): Plugin {
         const instrumentationPath = detectInstrumentationFile(ctx.root);
         return generateInstrumentationModule(instrumentationPath);
       }
+      if (id === RESOLVED_CACHE_HANDLER_ID) {
+        const configPath = detectConfigFile(ctx.root);
+        const hasCacheHandler = ctx.config.cacheHandler != null;
+        return generateCacheHandlerModule(configPath, hasCacheHandler);
+      }
       return null;
     },