@ontrails/trails 1.0.0-beta.13 → 1.0.0-beta.15

package/src/trails/guide.ts

@@ -4,11 +4,14 @@
  * Lists trails with descriptions and examples. Detailed guidance is planned for post-v1.
  */
 
-import type { Topo, Trail } from '@ontrails/core';
-import { Result, trail } from '@ontrails/core';
+import { NotFoundError, Result, trail } from '@ontrails/core';
 import { z } from 'zod';
 
 import { loadApp } from './load-app.js';
+import {
+  buildCurrentGuideEntries,
+  buildCurrentTopoDetail,
+} from './topo-read-support.js';
 
 // ---------------------------------------------------------------------------
 // Types
@@ -25,48 +28,30 @@ interface GuideEntry {
 // Helpers
 // ---------------------------------------------------------------------------
 
-const toGuideEntries = (app: Topo): GuideEntry[] => {
-  const entries: GuideEntry[] = [];
-
-  for (const item of app.list()) {
-    const raw = item as unknown as Record<string, unknown>;
-    entries.push({
-      description:
-        typeof raw['description'] === 'string'
-          ? raw['description']
-          : '(no description)',
-      exampleCount: Array.isArray(raw['examples'])
-        ? (raw['examples'] as unknown[]).length
-        : 0,
-      id: item.id,
-      kind: item.kind,
-    });
-  }
-
-  return entries;
-};
-
-const toGuideDetail = (item: Trail<unknown, unknown>): object => ({
-  description: item.description ?? null,
-  detours: item.detours ?? null,
-  examples: item.examples ?? [],
-  id: item.id,
-  kind: item.kind,
-});
-
 export const guideTrail = trail('guide', {
   blaze: async (input, ctx) => {
-    const app = await loadApp(input.module, ctx.cwd ?? '.');
+    const rootDir = ctx.cwd ?? '.';
+    const app = await loadApp(input.module, rootDir);
 
     if (input.trailId) {
-      const item = app.get(input.trailId);
-      if (!item) {
-        return Result.err(new Error(`Trail not found: ${input.trailId}`));
+      const detail = buildCurrentTopoDetail(app, input.trailId, { rootDir });
+      if (detail === undefined || detail.kind !== 'trail') {
+        return Result.err(
+          new NotFoundError(`Trail not found: ${input.trailId}`)
+        );
       }
-      return Result.ok(toGuideDetail(item as Trail<unknown, unknown>));
+      return Result.ok({
+        description: detail.description,
+        detours: detail.detours,
+        examples: detail.examples,
+        id: detail.id,
+        kind: detail.kind,
+      });
     }
 
-    return Result.ok(toGuideEntries(app));
+    return Result.ok(
+      buildCurrentGuideEntries(app, { rootDir }) as GuideEntry[]
+    );
   },
   description: 'Runtime guidance for trails',
   examples: [
@@ -77,10 +62,7 @@ export const guideTrail = trail('guide', {
     },
   ],
   input: z.object({
-    module: z
-      .string()
-      .default('./src/app.ts')
-      .describe('Path to the app module'),
+    module: z.string().optional().describe('Path to the app module'),
     trailId: z.string().optional().describe('Trail ID for detailed guidance'),
   }),
   intent: 'read',

package/src/trails/load-app.ts

@@ -1,37 +1,579 @@
-import { isAbsolute, resolve } from 'node:path';
-import { pathToFileURL } from 'node:url';
+import { existsSync, mkdirSync, readdirSync, rmSync, statSync } from 'node:fs';
+import {
+  dirname,
+  extname,
+  isAbsolute,
+  join,
+  parse as parsePath,
+  relative,
+  resolve,
+} from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
 
 import type { Topo } from '@ontrails/core';
+import { findAppModule } from '@ontrails/cli';
 
 const URL_SCHEME = /^[a-zA-Z][a-zA-Z\d+.-]*:/;
 
-/** Resolve a module path from cwd so CLI defaults behave like shell paths. */
-const resolveModuleSpecifier = (modulePath: string, cwd: string): string => {
-  if (URL_SCHEME.test(modulePath)) {
-    return modulePath;
+type TranspilerLoader = 'ts' | 'tsx' | 'js' | 'jsx';
+
+/** Extension → Bun.Transpiler loader, so JSX-bearing files parse correctly. */
+const LOADER_BY_EXTENSION: Record<string, TranspilerLoader> = {
+  '.cjs': 'js',
+  '.cts': 'ts',
+  '.js': 'js',
+  '.jsx': 'jsx',
+  '.mjs': 'js',
+  '.mts': 'ts',
+  '.ts': 'ts',
+  '.tsx': 'tsx',
+};
+
+const SCANNABLE_EXTENSIONS = new Set(Object.keys(LOADER_BY_EXTENSION));
+
+const TRANSPILER_CACHE = new Map<TranspilerLoader, Bun.Transpiler>();
+
+const getImportScanner = (loader: TranspilerLoader): Bun.Transpiler => {
+  const cached = TRANSPILER_CACHE.get(loader);
+  if (cached !== undefined) {
+    return cached;
+  }
+  const scanner = new Bun.Transpiler({ loader });
+  TRANSPILER_CACHE.set(loader, scanner);
+  return scanner;
+};
+
+/**
+ * Mirror roots kept alive for the lifetime of the process.
+ *
+ * @remarks
+ * A fresh-loaded module may expose functions whose deferred relative imports
+ * are resolved only when those functions run (for example inside a trail's
+ * `blaze`). If we deleted the mirror tree immediately after the initial
+ * `import()` resolved, those later resolutions would hit an ENOENT. We keep
+ * the mirrors on disk and clean them up once, on process exit.
+ */
+const ACTIVE_MIRROR_ROOTS = new Set<string>();
+const RETAINED_MIRROR_ROOTS = new Set<string>();
+
+const cleanupAllMirrorRoots = (): void => {
+  for (const root of [...ACTIVE_MIRROR_ROOTS, ...RETAINED_MIRROR_ROOTS]) {
+    rmSync(root, { force: true, recursive: true });
   }
+  ACTIVE_MIRROR_ROOTS.clear();
+  RETAINED_MIRROR_ROOTS.clear();
+};
+
+const mirrorCleanup = (() => {
+  let registered = false;
+  return {
+    ensureRegistered(): void {
+      if (registered) {
+        return;
+      }
+      registered = true;
+      process.once('exit', cleanupAllMirrorRoots);
+    },
+  };
+})();
 
+const ensureMirrorCleanupHook = (): void => {
+  mirrorCleanup.ensureRegistered();
+};
+
+/**
+ * Retain a fresh-import mirror for the lifetime of the process. A previously
+ * returned `loadApp` result may hold deferred relative `import()` calls whose
+ * resolution requires the mirror directory to still exist, so we cannot prune
+ * these by age without risking ENOENT in long-lived sessions (dev server,
+ * survey polling, concurrent fresh loads). Cleanup happens once on process
+ * exit via `cleanupAllMirrorRoots`.
+ */
+const retainMirrorRoot = (mirrorRoot: string): void => {
+  if (RETAINED_MIRROR_ROOTS.has(mirrorRoot)) {
+    return;
+  }
+  RETAINED_MIRROR_ROOTS.add(mirrorRoot);
+  ensureMirrorCleanupHook();
+};
+
+const acquireMirrorLease = (mirrorRoot: string): (() => void) => {
+  ACTIVE_MIRROR_ROOTS.add(mirrorRoot);
+  ensureMirrorCleanupHook();
+
+  let released = false;
+
+  return () => {
+    if (released) {
+      return;
+    }
+
+    released = true;
+    ACTIVE_MIRROR_ROOTS.delete(mirrorRoot);
+    rmSync(mirrorRoot, { force: true, recursive: true });
+  };
+};
+
+const resolveUrlModulePath = (modulePath: string): string => {
+  const url = new URL(modulePath);
+  return url.protocol === 'file:' ? fileURLToPath(url) : modulePath;
+};
+
+const resolveFilesystemModulePath = (
+  modulePath: string,
+  cwd: string
+): string => {
   const absolutePath = isAbsolute(modulePath)
     ? modulePath
     : resolve(cwd, modulePath);
-  return pathToFileURL(absolutePath).href;
+  if (!absolutePath.endsWith('.js') || existsSync(absolutePath)) {
+    return absolutePath;
+  }
+
+  const tsPath = absolutePath.replace(/\.js$/, '.ts');
+  return existsSync(tsPath) ? tsPath : absolutePath;
 };
 
-/** Load a Topo export from a module path relative to cwd. */
-export const loadApp = async (
+/** Resolve a module path from cwd so CLI defaults behave like shell paths. */
+const resolveAbsoluteModulePath = (modulePath: string, cwd: string): string =>
+  URL_SCHEME.test(modulePath)
+    ? resolveUrlModulePath(modulePath)
+    : resolveFilesystemModulePath(modulePath, cwd);
+
+const MIRROR_PARENT_DIRNAME = '.trails-tmp';
+
+const MIRROR_ENTRY_PREFIX = 'load-app-fresh-';
+
+/**
+ * Convert an absolute path to a drive-safe relative form before appending it
+ * to the mirror root. `path.parse(...).root` returns `'/'` on POSIX and
+ * `'C:\\'` (or similar) on Windows, so `relative` strips the platform root
+ * in both cases.
+ */
+const freshMirrorPath = (absolutePath: string, mirrorRoot: string): string =>
+  join(mirrorRoot, relative(parsePath(absolutePath).root, absolutePath));
+
+const isLocalFilesystemImport = (importPath: string): boolean =>
+  importPath.startsWith('.') ||
+  importPath.startsWith('/') ||
+  importPath.startsWith('file:');
+
+const isScannableModule = (modulePath: string): boolean =>
+  SCANNABLE_EXTENSIONS.has(extname(modulePath));
+
+const resolveImportedModulePath = (
+  importerPath: string,
+  importPath: string
+): string => {
+  const resolved = import.meta.resolve(
+    importPath,
+    pathToFileURL(importerPath).href
+  );
+  return resolveFilesystemModulePath(
+    fileURLToPath(resolved),
+    dirname(importerPath)
+  );
+};
+
+const collectImportedModulePaths = (
   modulePath: string,
+  source: string
+): readonly string[] => {
+  const extension = extname(modulePath);
+  const loader = LOADER_BY_EXTENSION[extension];
+  if (loader === undefined) {
+    return [];
+  }
+
+  return getImportScanner(loader)
+    .scanImports(source)
+    .map((entry) => entry.path)
+    .filter(isLocalFilesystemImport)
+    .map((importPath) => resolveImportedModulePath(modulePath, importPath));
+};
+
+/**
+ * Copy a single file into the mirror by raw bytes.
+ *
+ * @remarks
+ * Reading via `.bytes()` rather than `.text()` preserves binary payloads
+ * (`.wasm`, `.node`, compiled assets) that may sit alongside source files in
+ * the app's graph. Text decoding would corrupt them on the way through the
+ * mirror.
+ */
+const copyFileToMirror = async (
+  sourcePath: string,
+  mirrorRoot: string,
+  copied: Set<string>
+): Promise<void> => {
+  if (copied.has(sourcePath)) {
+    return;
+  }
+  copied.add(sourcePath);
+
+  const mirrorPath = freshMirrorPath(sourcePath, mirrorRoot);
+  mkdirSync(dirname(mirrorPath), { recursive: true });
+  const bytes = await Bun.file(sourcePath).bytes();
+  await Bun.write(mirrorPath, bytes);
+};
+
+/**
+ * Directory basenames that are never worth mirroring.
+ *
+ * @remarks
+ * These directories are excluded because they can be large and are never
+ * sources of resolvable imports — they hold VCS metadata, package installs,
+ * prior mirror artifacts, or build/tooling output that module resolution
+ * should not touch.
+ */
+const MIRROR_SKIP_DIRECTORIES = new Set([
+  '.cache',
+  '.git',
+  '.next',
+  '.nuxt',
+  '.output',
+  '.svelte-kit',
+  '.trails-tmp',
+  '.turbo',
+  'build',
+  'coverage',
+  'dist',
+  'node_modules',
+]);
+
+/**
+ * Recursively copy every regular file inside `directoryPath` into the
+ * mirror, skipping well-known heavy directories.
+ *
+ * @remarks
+ * `Bun.Transpiler#scanImports` only surfaces statically analyzable import
+ * specifiers. Computed dynamic imports such as `import(\`./${name}.ts\`)`
+ * never appear, so their targets would otherwise be missing from the
+ * mirror. Shadowing each directory touched by the static walk with its
+ * full subtree keeps those sibling modules resolvable under the mirror
+ * root at runtime without pulling in package installs or nested mirror
+ * artifacts.
+ */
+const readDirectoryEntries = (directoryPath: string): readonly string[] => {
+  try {
+    return readdirSync(directoryPath);
+  } catch {
+    return [];
+  }
+};
+
+const safeStat = (
+  entryPath: string
+): ReturnType<typeof statSync> | undefined => {
+  try {
+    return statSync(entryPath);
+  } catch {
+    return undefined;
+  }
+};
+
+/**
+ * Age threshold (ms) above which a mirror entry in `.trails-tmp/` is
+ * considered stale and safe to remove opportunistically.
+ *
+ * @remarks
+ * Fresh loads complete in seconds. Anything older than 10 minutes is almost
+ * certainly left over from a crashed or signal-killed process. We intentionally
+ * avoid registering SIGTERM/SIGINT handlers here because that would risk
+ * clobbering host-app signal handlers (and still wouldn't rescue SIGKILL).
+ * Opportunistic cleanup is self-healing across crashes from any cause.
+ */
+const STALE_MIRROR_THRESHOLD_MS = 10 * 60 * 1000;
+
+const isStaleMirrorEntry = (entryPath: string, now: number): boolean => {
+  if (
+    ACTIVE_MIRROR_ROOTS.has(entryPath) ||
+    RETAINED_MIRROR_ROOTS.has(entryPath)
+  ) {
+    return false;
+  }
+  const entryStat = safeStat(entryPath);
+  if (entryStat === undefined) {
+    return false;
+  }
+  const mtimeMs = Number(entryStat.mtimeMs);
+  return now - mtimeMs >= STALE_MIRROR_THRESHOLD_MS;
+};
+
+const removeStaleMirrorEntry = (entryPath: string): void => {
+  try {
+    rmSync(entryPath, { force: true, recursive: true });
+  } catch {
+    /*
+     * Another concurrent load may own it. Safe to ignore — the next sweep
+     * will retry.
+     */
+  }
+};
+
+/**
+ * Best-effort removal of stale mirror directories left by previous (crashed or
+ * signal-killed) processes. Called before creating a new mirror root.
+ */
+const cleanupStaleMirrorRoots = (mirrorParent: string): void => {
+  const entries = readDirectoryEntries(mirrorParent);
+  if (entries.length === 0) {
+    return;
+  }
+  const now = Date.now();
+  for (const entry of entries) {
+    if (!entry.startsWith(MIRROR_ENTRY_PREFIX)) {
+      continue;
+    }
+    const entryPath = join(mirrorParent, entry);
+    if (isStaleMirrorEntry(entryPath, now)) {
+      removeStaleMirrorEntry(entryPath);
+    }
+  }
+};
+
+const freshMirrorRootPath = (cwd: string): string => {
+  const mirrorParent = join(cwd, MIRROR_PARENT_DIRNAME);
+  cleanupStaleMirrorRoots(mirrorParent);
+  return join(
+    mirrorParent,
+    `${MIRROR_ENTRY_PREFIX}${Date.now()}-${Math.random().toString(36).slice(2)}`
+  );
+};
+
+interface MirrorWalkContext {
+  readonly mirrorRoot: string;
+  readonly copied: Set<string>;
+  readonly visitedDirectories: Set<string>;
+}
+
+type DirectoryEntryKind = 'directory' | 'file' | 'skip';
+
+const classifyDirectoryEntry = (
+  entry: string,
+  entryPath: string
+): DirectoryEntryKind => {
+  const entryStat = safeStat(entryPath);
+  if (entryStat === undefined) {
+    return 'skip';
+  }
+  if (entryStat.isDirectory()) {
+    return MIRROR_SKIP_DIRECTORIES.has(entry) ? 'skip' : 'directory';
+  }
+  return entryStat.isFile() ? 'file' : 'skip';
+};
+
+const copyDirectoryTreeToMirror = async (
+  directoryPath: string,
+  context: MirrorWalkContext
+): Promise<void> => {
+  if (context.visitedDirectories.has(directoryPath)) {
+    return;
+  }
+  context.visitedDirectories.add(directoryPath);
+
+  for (const entry of readDirectoryEntries(directoryPath)) {
+    const entryPath = join(directoryPath, entry);
+    const kind = classifyDirectoryEntry(entry, entryPath);
+    if (kind === 'directory') {
+      await copyDirectoryTreeToMirror(entryPath, context);
+    } else if (kind === 'file') {
+      await copyFileToMirror(entryPath, context.mirrorRoot, context.copied);
+    }
+  }
+};
+
+const mirrorImportedModule = async (
+  modulePath: string,
+  context: MirrorWalkContext
+): Promise<void> => {
+  const moduleDirectory = dirname(modulePath);
+  if (context.visitedDirectories.has(moduleDirectory)) {
+    await copyFileToMirror(modulePath, context.mirrorRoot, context.copied);
+    return;
+  }
+  await copyDirectoryTreeToMirror(moduleDirectory, context);
+};
+
+const scanAndVisitLocalImports = async (
+  modulePath: string,
+  visit: (path: string) => Promise<void>
+): Promise<void> => {
+  if (!isScannableModule(modulePath)) {
+    return;
+  }
+  const source = await Bun.file(modulePath).text();
+  for (const importedPath of collectImportedModulePaths(modulePath, source)) {
+    await visit(importedPath);
+  }
+};
+
+const mirrorFreshImportGraph = async (
+  entryPath: string,
+  mirrorRoot: string
+): Promise<string> => {
+  const scanned = new Set<string>();
+  const context: MirrorWalkContext = {
+    copied: new Set<string>(),
+    mirrorRoot,
+    visitedDirectories: new Set<string>(),
+  };
+
+  const visit = async (modulePath: string): Promise<void> => {
+    if (scanned.has(modulePath)) {
+      return;
+    }
+    scanned.add(modulePath);
+    await scanAndVisitLocalImports(modulePath, visit);
+    await mirrorImportedModule(modulePath, context);
+  };
+
+  await visit(entryPath);
+  return freshMirrorPath(entryPath, mirrorRoot);
+};
+
+/**
+ * Import a module bypassing the ESM cache for the local filesystem import graph.
+ *
+ * @remarks
+ * External packages and built-in modules still resolve normally. Only local
+ * filesystem imports are mirrored into the fresh temp root. The mirror tree
+ * is retained for the lifetime of the process so that deferred relative
+ * `import()`/`require()` calls originating from the loaded module (e.g.
+ * inside a trail's `blaze`) can still resolve. If the graph walk itself
+ * fails, the partially-written mirror is removed immediately so failed
+ * loads do not leak disk space.
+ */
+const importWithCacheBust = async (
+  absolutePath: string
+): Promise<Record<string, unknown>> => {
+  const url = new URL(absolutePath);
+  url.searchParams.set('t', Date.now().toString());
+  return (await import(url.href)) as Record<string, unknown>;
+};
+
+const prepareMirror = async (
+  absolutePath: string,
   cwd: string
-): Promise<Topo> => {
-  const mod = (await import(resolveModuleSpecifier(modulePath, cwd))) as Record<
+): Promise<{ mirrorRoot: string; freshPath: string }> => {
+  const mirrorRoot = freshMirrorRootPath(cwd);
+  try {
+    const freshPath = await mirrorFreshImportGraph(absolutePath, mirrorRoot);
+    return { freshPath, mirrorRoot };
+  } catch (error) {
+    rmSync(mirrorRoot, { force: true, recursive: true });
+    throw error;
+  }
+};
+
+const importFreshModule = async (
+  modulePath: string,
+  cwd: string
+): Promise<Record<string, unknown>> => {
+  const absolutePath = resolveAbsoluteModulePath(modulePath, cwd);
+  if (URL_SCHEME.test(absolutePath) && !absolutePath.startsWith('/')) {
+    return await importWithCacheBust(absolutePath);
+  }
+
+  const { mirrorRoot, freshPath } = await prepareMirror(absolutePath, cwd);
+  retainMirrorRoot(mirrorRoot);
+  return (await import(pathToFileURL(freshPath).href)) as Record<
     string,
     unknown
   >;
-  const app = (mod['default'] ?? mod['app']) as Topo | undefined;
+};
+
+const resolveLoadedTopo = (
+  effectivePath: string,
+  mod: Record<string, unknown>
+): Topo => {
+  const app = (mod['default'] ?? mod['graph'] ?? mod['app']) as
+    | Topo
+    | undefined;
   if (!app?.trails) {
     throw new Error(
-      `Could not find a Topo export in "${modulePath}". ` +
-        "Expected a default or named 'app' export created with topo()."
+      `Could not find a Topo export in "${effectivePath}". ` +
+        "Expected a default, 'graph', or 'app' named export created with topo()."
     );
   }
   return app;
 };
+
+export interface FreshAppLease {
+  readonly app: Topo;
+  readonly mirrorRoot: string;
+  readonly release: () => void;
+}
+
+const noopRelease = (): void => undefined;
+
+const createUrlSchemeLease = async (
+  absolutePath: string,
+  effectivePath: string
+): Promise<FreshAppLease> => ({
+  app: resolveLoadedTopo(
+    effectivePath,
+    await importWithCacheBust(absolutePath)
+  ),
+  mirrorRoot: absolutePath,
+  release: noopRelease,
+});
+
+const createFilesystemLease = async (
+  absolutePath: string,
+  cwd: string,
+  effectivePath: string
+): Promise<FreshAppLease> => {
+  const { mirrorRoot, freshPath } = await prepareMirror(absolutePath, cwd);
+  const release = acquireMirrorLease(mirrorRoot);
+
+  try {
+    const mod = (await import(pathToFileURL(freshPath).href)) as Record<
+      string,
+      unknown
+    >;
+
+    return {
+      app: resolveLoadedTopo(effectivePath, mod),
+      mirrorRoot,
+      release,
+    };
+  } catch (error) {
+    release();
+    throw error;
+  }
+};
+
+export const loadFreshAppLease = async (
+  modulePath: string | undefined,
+  cwd: string
+): Promise<FreshAppLease> => {
+  const effectivePath =
+    modulePath === undefined ? findAppModule(cwd) : modulePath;
+  const absolutePath = resolveAbsoluteModulePath(effectivePath, cwd);
+
+  return URL_SCHEME.test(absolutePath) && !absolutePath.startsWith('/')
+    ? await createUrlSchemeLease(absolutePath, effectivePath)
+    : await createFilesystemLease(absolutePath, cwd, effectivePath);
+};
+
+/** Load a Topo export from a module path relative to cwd. */
+export const loadApp = async (
+  modulePath: string | undefined,
+  cwd: string,
+  options: { fresh?: boolean | undefined } = {}
+): Promise<Topo> => {
+  const effectivePath =
+    modulePath === undefined ? findAppModule(cwd) : modulePath;
+  const resolvedModulePath = resolveAbsoluteModulePath(effectivePath, cwd);
+  const mod =
+    options.fresh === true
+      ? await importFreshModule(resolvedModulePath, cwd)
+      : ((await import(
+          URL_SCHEME.test(resolvedModulePath) &&
+            !resolvedModulePath.startsWith('/')
+            ? new URL(resolvedModulePath).href
+            : pathToFileURL(resolvedModulePath).href
+        )) as Record<string, unknown>);
+  return resolveLoadedTopo(effectivePath, mod);
+};