@timber-js/app 0.2.0-alpha.21 → 0.2.0-alpha.211

package/src/adapters/nitro-preview.ts

@@ -0,0 +1,476 @@
+// Nitro local preview — standalone server codegen and process spawning.
+//
+// `buildOutput` writes `_preview-server.mjs` into the Nitro output directory,
+// generated from the build's own artifacts; `timber preview` runs the
+// adapter's preview(), which spawns it. See design/25-production-deployments.md
+// §Preview.
+
+import { execFile } from 'node:child_process';
+import { IMMUTABLE_CACHE, STATIC_CACHE } from './shared.ts';
+
+/**
+ * Content-Type by file extension for the preview server. Static hosts decide
+ * this themselves; the table covers the file types a web build ships so the
+ * preview does not turn ordinary files into downloads. An extension missing
+ * here is served as `application/octet-stream`.
+ */
+const PREVIEW_MIME_TYPES: Readonly<Record<string, string>> = {
+  // Documents and code
+  '.html': 'text/html; charset=utf-8',
+  '.htm': 'text/html; charset=utf-8',
+  '.css': 'text/css; charset=utf-8',
+  '.js': 'text/javascript; charset=utf-8',
+  '.mjs': 'text/javascript; charset=utf-8',
+  '.cjs': 'text/javascript; charset=utf-8',
+  '.map': 'application/json; charset=utf-8',
+  '.json': 'application/json; charset=utf-8',
+  '.jsonld': 'application/ld+json',
+  '.webmanifest': 'application/manifest+json',
+  '.xml': 'application/xml',
+  '.rss': 'application/rss+xml',
+  '.atom': 'application/atom+xml',
+  '.txt': 'text/plain; charset=utf-8',
+  '.md': 'text/markdown; charset=utf-8',
+  '.csv': 'text/csv; charset=utf-8',
+  '.ics': 'text/calendar; charset=utf-8',
+  '.vtt': 'text/vtt; charset=utf-8',
+  '.pdf': 'application/pdf',
+  '.wasm': 'application/wasm',
+  '.zip': 'application/zip',
+  '.gz': 'application/gzip',
+  // Images
+  '.png': 'image/png',
+  '.apng': 'image/apng',
+  '.jpg': 'image/jpeg',
+  '.jpeg': 'image/jpeg',
+  '.gif': 'image/gif',
+  '.svg': 'image/svg+xml',
+  '.ico': 'image/x-icon',
+  '.webp': 'image/webp',
+  '.avif': 'image/avif',
+  '.bmp': 'image/bmp',
+  '.tif': 'image/tiff',
+  '.tiff': 'image/tiff',
+  // Fonts
+  '.woff': 'font/woff',
+  '.woff2': 'font/woff2',
+  '.ttf': 'font/ttf',
+  '.otf': 'font/otf',
+  // Audio and video
+  '.mp3': 'audio/mpeg',
+  '.wav': 'audio/wav',
+  '.ogg': 'audio/ogg',
+  '.oga': 'audio/ogg',
+  '.m4a': 'audio/mp4',
+  '.flac': 'audio/flac',
+  '.mp4': 'video/mp4',
+  '.webm': 'video/webm',
+  '.ogv': 'video/ogg',
+  '.mov': 'video/quicktime',
+};
+
+/** What the generated preview server serves, as `buildOutput` knows it. */
+export type PreviewScriptOptions = StaticPreviewScriptOptions | ServerPreviewScriptOptions;
+
+interface PreviewScriptOptionsBase {
+  /**
+   * `BuildArtifacts.immutableDirs` — served with a one-year immutable
+   * `Cache-Control`, every other file with a revalidating one.
+   */
+  immutableDirs: readonly string[];
+  /**
+   * The deployment base, normalized (`/` or `/repo/`). Requests arrive in
+   * deployed-URL space; files are laid out in route space, so the script
+   * strips it before looking anything up.
+   */
+  base: string;
+}
+
+/** A static build: serve the pre-rendered site and nothing else. */
+export interface StaticPreviewScriptOptions extends PreviewScriptOptionsBase {
+  output: 'static';
+  /** `StaticBuildArtifacts.contentTypes` — extensionless API route outputs. */
+  contentTypes: Readonly<Record<string, string>>;
+}
+
+/** A server build: serve `public/`, route everything else to the RSC handler. */
+export interface ServerPreviewScriptOptions extends PreviewScriptOptionsBase {
+  output: 'server';
+  /** Value for `TIMBER_RUNTIME`, set before the handler evaluates. */
+  runtimeName: string;
+  /** Import specifier of the RSC handler, relative to the script. */
+  rscEntry: string;
+  /**
+   * Whether this build wrote `_timber-manifest-init.js` beside the script.
+   * Recorded from the build, never probed: the Nitro output directory is not
+   * cleaned between server builds, so a file on disk can be a stale one.
+   */
+  hasManifestInit: boolean;
+}
+
+/**
+ * Generate a standalone preview server script that uses Node's built-in
+ * HTTP server. This bypasses Nitro entirely — the Nitro entry.ts imports
+ * h3 which isn't available outside a Nitro build. For local preview we
+ * just need to serve static files and, in a server build, route requests
+ * to the RSC handler.
+ *
+ * Generated at build time rather than at preview time, so everything it
+ * serves comes from the build's artifacts instead of guesses about the
+ * directory it runs in.
+ *
+ * @internal Exported for testing.
+ */
+export function generatePreviewScript(options: PreviewScriptOptions): string {
+  const immutablePrefixes = options.immutableDirs.map((dir) => `/${dir}/`);
+  const contentTypes = options.output === 'static' ? options.contentTypes : {};
+
+  // A server build loads its handler (after the runtime and manifest are in
+  // place); a static build has no handler to load.
+  const handlerSetup =
+    options.output === 'server'
+      ? `// Set runtime before importing the handler.
+process.env.TIMBER_RUNTIME = ${JSON.stringify(options.runtimeName)};
+${
+  options.hasManifestInit
+    ? `
+// Load the build manifest before the handler reads it.
+await import('./_timber-manifest-init.js');
+`
+    : ''
+}
+// Import the RSC handler (default export is the fetch-like handler).
+const { default: handler, runWithEarlyHintsSender } = await import(${JSON.stringify(options.rscEntry)});
+
+// Import compression helper for self-hosted response compression.
+const { compressResponse } = await import('./_compress.mjs');
+
+// Web→Node response bridge with backpressure (TIM-1154).
+const { sendNodeResponse } = await import('./_send-response.mjs');
+`
+      : '';
+
+  // What happens when no file matches: a static build answers with its own
+  // 404 page, a server build hands the request to the RSC handler.
+  const fallback =
+    options.output === 'static'
+      ? `  if (badPath) {
+    res.writeHead(400, { 'Content-Type': 'text/plain' });
+    res.end('Bad Request');
+    return;
+  }
+  const notFound = await findFile('/404.html');
+  if (notFound) {
+    await sendFile(req, res, notFound, 404, 'text/html', 'public, max-age=0, must-revalidate');
+    return;
+  }
+  res.writeHead(404, { 'Content-Type': 'text/plain' });
+  res.end('Not Found');
+`
+      : `  await handleDynamic(req, res, url);
+`;
+
+  const dynamicHandler =
+    options.output === 'server'
+      ? `
+async function handleDynamic(req, res, url) {
+  // Convert Node request to Web Request.
+  const headers = new Headers();
+  for (const [key, value] of Object.entries(req.headers)) {
+    if (value) {
+      if (Array.isArray(value)) {
+        for (const v of value) headers.append(key, v);
+      } else {
+        headers.set(key, value);
+      }
+    }
+  }
+
+  let body = undefined;
+  if (req.method !== 'GET' && req.method !== 'HEAD') {
+    body = await new Promise((resolve) => {
+      const chunks = [];
+      req.on('data', (chunk) => chunks.push(chunk));
+      req.on('end', () => resolve(Buffer.concat(chunks)));
+    });
+  }
+
+  const webRequest = new Request(url.href, {
+    method: req.method,
+    headers,
+    body,
+    duplex: body ? 'half' : undefined,
+  });
+
+  try {
+    // Support 103 Early Hints when available.
+    const earlyHintsSender = (typeof res.writeEarlyHints === 'function')
+      ? (links) => { try { res.writeEarlyHints({ link: links }); } catch {} }
+      : undefined;
+
+    const rawResponse = earlyHintsSender && runWithEarlyHintsSender
+      ? await runWithEarlyHintsSender(earlyHintsSender, () => handler(webRequest))
+      : await handler(webRequest);
+
+    // Compress the response for self-hosted deployments.
+    const webResponse = compressResponse(webRequest, rawResponse);
+
+    // Write the response to Node's ServerResponse. sendNodeResponse handles
+    // status, headers (including Set-Cookie splitting via [...headers]),
+    // body streaming with backpressure, and client disconnect cleanup.
+    // See TIM-1154.
+    await sendNodeResponse(res, webResponse);
+  } catch (err) {
+    console.error('[timber preview] Request error:', err);
+    if (!res.headersSent) {
+      res.writeHead(500, { 'Content-Type': 'text/plain' });
+    }
+    res.end('Internal Server Error');
+  }
+}
+`
+      : '';
+
+  return `// Generated by @timber-js/app — standalone preview server.
+// Do not edit — this file is regenerated on each build.
+// Uses Node's built-in HTTP server to serve the build's files${
+    options.output === 'server' ? ' and route\n// dynamic requests through the RSC handler' : ''
+  }. No Nitro/h3 dependency.
+
+import { createServer } from 'node:http';
+import { readFile, stat } from 'node:fs/promises';
+import { join, extname, sep } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { canonicalize } from './_canonicalize.mjs';
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
+
+${handlerSetup}
+const MIME_TYPES = ${JSON.stringify(PREVIEW_MIME_TYPES, null, 2)};
+
+// Recorded by the build: content-hashed directories, and the Content-Type of
+// each extensionless API route output (a file name cannot say it). Both are
+// decoded route-space paths, matched against the decoded request path.
+const IMMUTABLE_PREFIXES = ${JSON.stringify(immutablePrefixes)};
+const BASE = ${JSON.stringify(options.base)};
+const CONTENT_TYPES = ${JSON.stringify(contentTypes)};
+const SERVE_DIRECTORY_INDEX = ${options.output === 'static'};
+
+const publicDir = join(__dirname, 'public');
+
+/**
+ * The file under publicDir that a decoded URL path names, or null. A static
+ * build lays its pages out as <path>/index.html, so a directory serves its
+ * index there.
+ */
+async function findFile(pathname) {
+  const filePath = join(publicDir, pathname);
+  // Prevent path traversal (and a sibling like public-other/ passing a bare
+  // prefix check).
+  if (!filePath.startsWith(publicDir + sep)) return null;
+  try {
+    const fileStat = await stat(filePath);
+    if (fileStat.isFile()) return filePath;
+    if (SERVE_DIRECTORY_INDEX && fileStat.isDirectory()) {
+      const index = join(filePath, 'index.html');
+      if ((await stat(index)).isFile()) return index;
+    }
+  } catch {
+    // Not found.
+  }
+  return null;
+}
+
+/**
+ * The route-space path for a request path, or null when the request is
+ * outside the deployment base (it names no file of this build).
+ */
+function stripBase(pathname) {
+  if (BASE === '/') return pathname;
+  if (pathname === BASE.slice(0, -1)) return '/';
+  if (!pathname.startsWith(BASE)) return null;
+  return pathname.slice(BASE.length - 1);
+}
+
+async function sendFile(req, res, filePath, status, contentType, cacheControl) {
+  const body = await readFile(filePath);
+  res.writeHead(status, {
+    'Content-Type': contentType,
+    'Content-Length': body.length,
+    'Cache-Control': cacheControl,
+  });
+  res.end(req.method === 'HEAD' ? undefined : body);
+}
+${dynamicHandler}
+// Port resolution (TIM-842):
+//   - Default to 3000
+//   - If PORT env var is set, honor it strictly (fail loudly on conflict)
+//   - Otherwise auto-bump from 3000 until a free port is found
+// Mirrors the dev server behavior so timber dev/preview/production all
+// behave the same way around port selection.
+const envPort = process.env.PORT ? parseInt(process.env.PORT, 10) : null;
+const portIsExplicit = envPort != null && Number.isFinite(envPort) && envPort > 0;
+const startPort = portIsExplicit ? envPort : 3000;
+const host = process.env.HOST || 'localhost';
+
+// Set after listenWithBump() resolves so request handlers can build
+// absolute URLs from the actual bound port (which may differ from
+// startPort after an auto-bump).
+let boundPort = startPort;
+
+const server = createServer(async (req, res) => {
+  // Scheme from the socket's TLS state — a hardcoded http:// breaks CSRF
+  // origin comparison and absolute-URL construction when TLS is terminated
+  // at this server (TIM-1073; mirrors the dev-server fix in TIM-1067).
+  // X-Forwarded-Proto is intentionally not consulted here: on a direct
+  // connection it would be attacker-controlled. The CSRF layer honors it
+  // separately for reverse-proxy deployments.
+  const scheme = req.socket?.encrypted ? 'https' : 'http';
+  const url = new URL(req.url || '/', \`\${scheme}://\${host}:\${boundPort}\`);
+
+  // The runtime's own request-boundary canonicalizer (_canonicalize.mjs,
+  // compiled from server/canonicalize.ts): one decode, and the same 400s for
+  // encoded separators, null bytes, malformed encoding, and escaping the root
+  // (design/13-security.md). The base is stripped from its canonical result,
+  // so an encoded spelling of the base is the same path. What remains, in
+  // route space, is looked up in public/; null names no file.
+  const canonical = canonicalize(url.pathname, false);
+  const badPath = !canonical.ok;
+  const pathname = canonical.ok ? stripBase(canonical.pathname) : null;
+  const filePath = pathname === null ? null : await findFile(pathname);
+  if (filePath) {
+    const contentType =
+      CONTENT_TYPES[pathname] || MIME_TYPES[extname(filePath).toLowerCase()] || 'application/octet-stream';
+    // Hashed assets get immutable cache, others get short cache.
+    const isImmutable = IMMUTABLE_PREFIXES.some((prefix) => pathname.startsWith(prefix));
+    const cacheControl = isImmutable ? ${JSON.stringify(IMMUTABLE_CACHE)} : ${JSON.stringify(STATIC_CACHE)};
+    await sendFile(req, res, filePath, 200, contentType, cacheControl);
+    return;
+  }
+
+${fallback}});
+
+function listenWithBump(port, attempt = 0) {
+  return new Promise((resolveListen, rejectListen) => {
+    const onError = (err) => {
+      server.removeListener('listening', onListening);
+      if (err && err.code === 'EADDRINUSE' && !portIsExplicit && attempt < 100) {
+        if (attempt === 0) {
+          console.log(\`  [timber] Port \${port} in use, trying \${port + 1}...\`);
+        }
+        listenWithBump(port + 1, attempt + 1).then(resolveListen, rejectListen);
+        return;
+      }
+      rejectListen(err);
+    };
+    const onListening = () => {
+      server.removeListener('error', onError);
+      resolveListen(port);
+    };
+    server.once('error', onError);
+    server.once('listening', onListening);
+    server.listen(port, host);
+  });
+}
+
+try {
+  boundPort = await listenWithBump(startPort);
+  if (boundPort !== startPort) {
+    console.log();
+    console.log(\`  [timber] Port \${startPort} in use, using \${boundPort}\`);
+  }
+  console.log();
+  console.log('  ⚡ timber preview server running at:');
+  console.log();
+  console.log(\`    ➜  http://\${host}:\${boundPort}\`);
+  console.log();
+} catch (err) {
+  if (err && err.code === 'EADDRINUSE') {
+    console.error(\`[timber] Port \${startPort} is already in use. \` +
+      'Set PORT to a free port, or unset PORT to auto-pick.');
+  } else {
+    console.error('[timber] Failed to start preview server:', err);
+  }
+  process.exit(1);
+}
+`;
+}
+
+/** Spawn a Nitro preview process and pipe stdio. */
+export function spawnNitroPreview(command: string, args: string[], cwd: string): Promise<void> {
+  return new Promise<void>((resolve, reject) => {
+    const child = execFile(command, args, { cwd }, (err) => {
+      if (err) reject(err);
+      else resolve();
+    });
+    child.stdout?.pipe(process.stdout);
+    child.stderr?.pipe(process.stderr);
+  });
+}
+
+/**
+ * Generate a standalone ESM module that exports sendNodeResponse.
+ *
+ * Mirrors srvx/node's sendNodeResponse: status + headers via writeHead,
+ * body streaming with backpressure (waits for drain on write() === false),
+ * and client disconnect cleanup. Written to `_send-response.mjs` during
+ * buildOutput for use by the preview server script. See TIM-1154.
+ *
+ * @internal Exported for testing.
+ */
+export function generateSendResponseModule(): string {
+  return `// Generated by @timber-js/app — Web→Node response bridge.
+// Do not edit — this file is regenerated on each build.
+// Mirrors srvx/node's sendNodeResponse with backpressure support.
+
+export function sendNodeResponse(nodeRes, webRes) {
+  if (!webRes) {
+    nodeRes.statusCode = 500;
+    return new Promise((resolve) => nodeRes.end(resolve));
+  }
+  const rawHeaders = [...webRes.headers];
+  const writeHeaders = rawHeaders.flat();
+  if (!nodeRes.headersSent) {
+    if (nodeRes.req?.httpVersion === '2.0') {
+      nodeRes.writeHead(webRes.status, writeHeaders);
+    } else {
+      nodeRes.writeHead(webRes.status, webRes.statusText, writeHeaders);
+    }
+  }
+  if (!webRes.body) {
+    return new Promise((resolve) => nodeRes.end(resolve));
+  }
+  // Stream with backpressure: pause reading when the kernel buffer is
+  // full (write() returns false) and resume on 'drain'.
+  if (nodeRes.destroyed) {
+    webRes.body.cancel();
+    return;
+  }
+  const reader = webRes.body.getReader();
+  function streamCancel(error) {
+    reader.cancel(error).catch(() => {});
+    if (error) nodeRes.destroy(error);
+  }
+  function streamHandle({ done, value }) {
+    try {
+      if (done) {
+        nodeRes.end();
+      } else if (nodeRes.write(value)) {
+        reader.read().then(streamHandle, streamCancel);
+      } else {
+        nodeRes.once('drain', () => reader.read().then(streamHandle, streamCancel));
+      }
+    } catch (error) {
+      streamCancel(error instanceof Error ? error : undefined);
+    }
+  }
+  nodeRes.on('close', streamCancel);
+  nodeRes.on('error', streamCancel);
+  reader.read().then(streamHandle, streamCancel);
+  return reader.closed.catch(streamCancel).finally(() => {
+    nodeRes.off('close', streamCancel);
+    nodeRes.off('error', streamCancel);
+  });
+}
+`;
+}