@abreen/tada 1.13.4 → 1.13.9

package/build/watch/engine.ts

@@ -0,0 +1,199 @@
+import chokidar from 'chokidar';
+import { applyCommitPlan } from './fs-commit';
+import type {
+  ChangeBatch,
+  CompilerBuildResult,
+  WatchEngineOptions,
+  WatchEventKind,
+  WatchLifecycleEvent,
+} from './types';
+import type { TadaSnapshot } from './snapshot';
+
+function normalizeBatch(changes: Map<string, WatchEventKind>): ChangeBatch {
+  return {
+    changes: [...changes.entries()]
+      .sort(([a], [b]) => a.localeCompare(b))
+      .map(([path, kind]) => ({ path, kind })),
+  };
+}
+
+function mapBatch(batch: ChangeBatch): Map<string, WatchEventKind> {
+  return new Map(batch.changes.map(change => [change.path, change.kind]));
+}
+
+function mergeChangeKind(
+  previous: WatchEventKind | undefined,
+  next: WatchEventKind,
+): WatchEventKind {
+  if (!previous) {
+    return next;
+  }
+  if (previous === 'add' && next === 'unlink') {
+    return 'change';
+  }
+  if (previous === 'unlink' && next === 'add') {
+    return 'change';
+  }
+  if (previous === 'add' || next === 'add') {
+    return 'add';
+  }
+  if (previous === 'unlink' || next === 'unlink') {
+    return 'unlink';
+  }
+  return 'change';
+}
+
+function toDiagnostics(error: unknown): { message: string }[] {
+  if (error instanceof Error) {
+    return [{ message: error.message }];
+  }
+  return [{ message: String(error) }];
+}
+
+export async function runWatchEngine(
+  options: WatchEngineOptions,
+): Promise<void> {
+  const debounceMs = options.debounceMs ?? 300;
+  let snapshot: TadaSnapshot | undefined;
+  let uncommitted = new Map<string, WatchEventKind>();
+  let pending = new Map<string, WatchEventKind>();
+  let timer: ReturnType<typeof setTimeout> | null = null;
+  let running = false;
+
+  async function emit(event: WatchLifecycleEvent): Promise<void> {
+    await options.onEvent?.(event);
+  }
+
+  async function waitForQuietPeriod(): Promise<void> {
+    await new Promise(resolve => setTimeout(resolve, debounceMs));
+  }
+
+  async function runBuild(batch?: ChangeBatch): Promise<CompilerBuildResult> {
+    await emit({ kind: 'build-started', batch });
+    try {
+      return await options.compiler.build(snapshot, batch);
+    } catch (error) {
+      return { ok: false, diagnostics: toDiagnostics(error) };
+    }
+  }
+
+  async function flush(): Promise<void> {
+    if (running) {
+      return;
+    }
+    running = true;
+    try {
+      let finalSuccess:
+        | {
+            batch?: ChangeBatch;
+            result: Extract<CompilerBuildResult, { ok: true }>;
+          }
+        | undefined;
+
+      while (pending.size > 0) {
+        const changes = new Map(uncommitted);
+        for (const [filePath, kind] of pending) {
+          changes.set(filePath, mergeChangeKind(changes.get(filePath), kind));
+        }
+
+        const batch = normalizeBatch(changes);
+        pending = new Map();
+        const outcome = await runBuild(batch);
+
+        if (!outcome.ok) {
+          uncommitted = mapBatch(batch);
+          await emit({
+            kind: 'build-failed',
+            batch,
+            diagnostics: outcome.diagnostics,
+          });
+          return;
+        }
+
+        applyCommitPlan(outcome.commit);
+        snapshot = outcome.snapshot;
+        uncommitted = new Map();
+        finalSuccess = { batch, result: outcome };
+
+        if (pending.size === 0) {
+          await waitForQuietPeriod();
+        }
+      }
+
+      if (finalSuccess) {
+        await emit({
+          kind: 'build-succeeded',
+          batch: finalSuccess.batch,
+          meta: finalSuccess.result.meta,
+        });
+      }
+    } finally {
+      running = false;
+      if (pending.size > 0) {
+        schedule();
+      }
+    }
+  }
+
+  function schedule(): void {
+    if (timer) {
+      clearTimeout(timer);
+    }
+    timer = setTimeout(() => {
+      timer = null;
+      void flush();
+    }, debounceMs);
+  }
+
+  function onFileChange(filePath: string, kind: WatchEventKind): void {
+    pending.set(filePath, mergeChangeKind(pending.get(filePath), kind));
+    schedule();
+  }
+
+  const startupOutcome = await runBuild();
+  if (!startupOutcome.ok) {
+    await emit({
+      kind: 'build-failed',
+      diagnostics: startupOutcome.diagnostics,
+    });
+  } else {
+    applyCommitPlan(startupOutcome.commit);
+    snapshot = startupOutcome.snapshot;
+    await emit({ kind: 'build-succeeded', meta: startupOutcome.meta });
+  }
+
+  const watcherEntries = options.compiler
+    .getWatchTargets()
+    .map(target => ({
+      target,
+      watcher: chokidar.watch(target.path, {
+        ignoreInitial: true,
+        atomic: true,
+        awaitWriteFinish: { stabilityThreshold: 100 },
+        ...target.chokidar,
+      }),
+    }));
+
+  let readyCount = 0;
+  const readyGoal = watcherEntries.length;
+  const onReady = async () => {
+    readyCount += 1;
+    if (readyCount === readyGoal) {
+      await emit({ kind: 'watching' });
+    }
+  };
+
+  for (const { watcher, target } of watcherEntries) {
+    const emitIfIncluded = (filePath: string, kind: WatchEventKind) => {
+      if (!target.filter || target.filter(filePath)) {
+        onFileChange(filePath, kind);
+      }
+    };
+    watcher.on('add', filePath => emitIfIncluded(filePath, 'add'));
+    watcher.on('change', filePath => emitIfIncluded(filePath, 'change'));
+    watcher.on('unlink', filePath => emitIfIncluded(filePath, 'unlink'));
+    watcher.on('ready', () => void onReady());
+  }
+
+  return new Promise(() => {});
+}

package/{watch → build/watch}/fs-commit.ts

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import path from 'path';
-import { globals, type Globals } from '../build/globals';
+import { globals, type Globals } from '../globals';
 import type {
   ApplyMutationsCommitPlan,
   CommitPlan,
@@ -87,8 +87,6 @@ function applyFileMutation(
   const stagedPath = path.join(stagedRoot, mutation.path);
 
   if (mutation.kind === 'write') {
-    ensureParentDir(stagedPath);
-    fs.writeFileSync(stagedPath, mutation.content);
     ensureParentDir(targetPath);
     renameWithRetry(stagedPath, targetPath, globals);
     return;

package/build/watch/index.ts

@@ -1,5 +1,5 @@
 import { getDistDir } from '../util';
-import { runWatchEngine } from '../../watch/engine';
+import { runWatchEngine } from './engine';
 import { TadaWatchCompiler } from './compiler';
 import { TadaWatchRuntime } from './runtime';
 

package/build/watch/mutations.ts

@@ -1,4 +1,5 @@
-import type { TadaSnapshot } from './snapshot';
+import type { FileMutation } from './types';
+import type { TadaOutputOwner, TadaSnapshot } from './snapshot';
 
 function outputsEqual(
   left: string | Buffer | undefined,
@@ -15,16 +16,25 @@ function outputsEqual(
   return Buffer.compare(leftBuffer, rightBuffer) === 0;
 }
 
+function getOutputContent(
+  snapshot: TadaSnapshot,
+  owner: TadaOutputOwner | undefined,
+  outputPath: string,
+): string | Buffer | undefined {
+  if (!owner) {
+    return undefined;
+  }
+  const records =
+    owner.kind === 'content' ? snapshot.contentRecords : snapshot.publicRecords;
+  return records.get(owner.sourcePath)?.outputs.get(outputPath);
+}
+
 export function computeMutations(
   previous: TadaSnapshot,
   next: TadaSnapshot,
   forceSourcePaths: Set<string> = new Set(),
-): { path: string; kind: 'write' | 'delete'; content?: string | Buffer }[] {
-  const mutations: {
-    path: string;
-    kind: 'write' | 'delete';
-    content?: string | Buffer;
-  }[] = [];
+): FileMutation[] {
+  const mutations: FileMutation[] = [];
   const allPaths = new Set([
     ...previous.outputOwners.keys(),
     ...next.outputOwners.keys(),
@@ -34,24 +44,12 @@ export function computeMutations(
     const previousOwner = previous.outputOwners.get(outputPath);
     const nextOwner = next.outputOwners.get(outputPath);
 
-    const previousContent =
-      previousOwner?.kind === 'content'
-        ? previous.contentRecords
-            .get(previousOwner.sourcePath)
-            ?.outputs.get(outputPath)
-        : previousOwner
-          ? previous.publicRecords
-              .get(previousOwner.sourcePath)
-              ?.outputs.get(outputPath)
-          : undefined;
-    const nextContent =
-      nextOwner?.kind === 'content'
-        ? next.contentRecords.get(nextOwner.sourcePath)?.outputs.get(outputPath)
-        : nextOwner
-          ? next.publicRecords
-              .get(nextOwner.sourcePath)
-              ?.outputs.get(outputPath)
-          : undefined;
+    const previousContent = getOutputContent(
+      previous,
+      previousOwner,
+      outputPath,
+    );
+    const nextContent = getOutputContent(next, nextOwner, outputPath);
 
     if (!nextOwner) {
       mutations.push({ path: outputPath, kind: 'delete' });

package/build/watch/planner.ts

@@ -1,16 +1,12 @@
 import path from 'path';
-import {
-  getProjectConfigBaseName,
-  getSiteConfigBaseName,
-  getSupportedConfigFilePaths,
-} from '../config-files';
 import { loadProjectConfig } from '../config-loader';
 import { getProjectConfigDir } from '../templates';
-import type { ChangeBatch } from '../../watch/types';
+import type { ChangeBatch } from './types';
 import type { TadaProjectScan, TadaSnapshot } from './snapshot';
+import { classifyWatchConfigPath } from './config-paths';
 
-export interface TadaWatchPlan {
-  kind: 'full' | 'incremental';
+export interface TadaIncrementalWatchPlan {
+  kind: 'incremental';
   scan: TadaProjectScan;
   contentToRender: Set<string>;
   publicToRender: Set<string>;
@@ -18,6 +14,8 @@ export interface TadaWatchPlan {
   publicToRemove: Set<string>;
 }
 
+export type TadaWatchPlan = { kind: 'full' } | TadaIncrementalWatchPlan;
+
 export function diffAuthorKeys(previous: unknown, next: unknown): Set<string> {
   const previousMap =
     previous && typeof previous === 'object'
@@ -60,7 +58,7 @@ export function createTadaWatchPlan({
   batch,
   scan,
 }: {
-  snapshot: TadaSnapshot | undefined;
+  snapshot: TadaSnapshot;
   batch: ChangeBatch;
   scan: TadaProjectScan;
 }): TadaWatchPlan {
@@ -69,66 +67,24 @@ export function createTadaWatchPlan({
   const contentToRemove = new Set<string>();
   const publicToRemove = new Set<string>();
   const projectConfigDir = getProjectConfigDir();
-  const siteConfigPaths = new Set(
-    getSupportedConfigFilePaths('.', getSiteConfigBaseName('dev')).map(
-      filePath => path.resolve(filePath),
-    ),
-  );
-  const navPaths = new Set(
-    getSupportedConfigFilePaths(
-      projectConfigDir,
-      getProjectConfigBaseName('nav'),
-    ).map(filePath => path.resolve(filePath)),
-  );
-  const authorsPaths = new Set(
-    getSupportedConfigFilePaths(
-      projectConfigDir,
-      getProjectConfigBaseName('authors'),
-    ).map(filePath => path.resolve(filePath)),
-  );
-
-  if (!snapshot) {
-    return {
-      kind: 'full',
-      scan,
-      contentToRender,
-      publicToRender,
-      contentToRemove,
-      publicToRemove,
-    };
-  }
 
   for (const change of batch.changes) {
-    const resolvedPath = path.resolve(change.path);
-    if (siteConfigPaths.has(resolvedPath) || navPaths.has(resolvedPath)) {
-      return {
-        kind: 'full',
-        scan,
-        contentToRender,
-        publicToRender,
-        contentToRemove,
-        publicToRemove,
-      };
+    const configKind = classifyWatchConfigPath(change.path);
+    if (configKind === 'site' || configKind === 'nav') {
+      return { kind: 'full' };
     }
   }
 
   for (const change of batch.changes) {
     const resolvedPath = path.resolve(change.path);
-    if (authorsPaths.has(resolvedPath)) {
+    if (classifyWatchConfigPath(resolvedPath) === 'authors') {
       const nextAuthorsData = loadProjectConfig(
         projectConfigDir,
         'authors',
         snapshot.siteVariables,
       )?.value;
       if (snapshot.authorsData === undefined || nextAuthorsData === undefined) {
-        return {
-          kind: 'full',
-          scan,
-          contentToRender,
-          publicToRender,
-          contentToRemove,
-          publicToRemove,
-        };
+        return { kind: 'full' };
       }
       const changedAuthorKeys = diffAuthorKeys(
         snapshot.authorsData,
@@ -144,17 +100,6 @@ export function createTadaWatchPlan({
       contentToRender.add(resolvedPath);
     } else if (snapshot.contentRecords.has(resolvedPath)) {
       contentToRemove.add(resolvedPath);
-      const previousRecord = snapshot.contentRecords.get(resolvedPath)!;
-      for (const partialPath of previousRecord.partialDeps) {
-        addDependents(
-          contentToRender,
-          snapshot.reversePartialDeps,
-          partialPath,
-        );
-      }
-      for (const tracePath of previousRecord.traceDeps) {
-        addDependents(contentToRender, snapshot.reverseTraceDeps, tracePath);
-      }
     }
 
     if (scan.publicFiles.has(resolvedPath)) {
@@ -168,15 +113,13 @@ export function createTadaWatchPlan({
   }
 
   const changedTargets = new Set<string>();
-  const removedTargets = new Set<string>();
-  for (const target of snapshot.validTargets) {
+  for (const target of snapshot.scan.validTargets) {
     if (!scan.validTargets.has(target)) {
       changedTargets.add(target);
-      removedTargets.add(target);
     }
   }
   for (const target of scan.validTargets) {
-    if (!snapshot.validTargets.has(target)) {
+    if (!snapshot.scan.validTargets.has(target)) {
       changedTargets.add(target);
     }
   }
@@ -184,13 +127,6 @@ export function createTadaWatchPlan({
     addDependents(contentToRender, snapshot.reverseInternalTargetDeps, target);
   }
 
-  if (removedTargets.size > 0 && contentToRender.size === 0) {
-    const rootOwner = snapshot.outputOwners.get('index.html');
-    if (rootOwner?.kind === 'content') {
-      contentToRender.add(rootOwner.sourcePath);
-    }
-  }
-
   for (const [outputPath, owner] of snapshot.outputOwners) {
     const nextContentOwner = scan.contentOwners.get(outputPath);
     const nextPublicOwner = scan.publicOwners.get(outputPath);

package/build/watch/runtime.ts

@@ -3,9 +3,7 @@ import { B } from '../colors';
 import { makeLogger, printFlair } from '../log';
 import { startServer } from '../serve';
 import { WatchPagefindRunner } from '../pagefind';
-import type { TadaBuildMeta } from './compiler-types';
-import type { TadaSnapshot } from './snapshot';
-import type { WatchLifecycleEvent } from '../../watch/types';
+import type { WatchLifecycleEvent } from './types';
 import {
   WATCH_RELOAD_MESSAGE_REBUILDING,
   WATCH_RELOAD_MESSAGE_RELOAD,
@@ -30,7 +28,6 @@ export class TadaWatchRuntime {
   private httpPort: number | undefined;
   private distDir: string;
   private server: Bun.Server<undefined> | null;
-  private lastBuildFailed: boolean;
   private pagefindRunner: WatchPagefindRunner | undefined;
   private pagefindSiteVariablesKey: string | undefined;
 
@@ -38,7 +35,6 @@ export class TadaWatchRuntime {
     this.httpPort = httpPort;
     this.distDir = distDir;
     this.server = null;
-    this.lastBuildFailed = false;
     this.pagefindSiteVariablesKey = undefined;
   }
 
@@ -68,51 +64,45 @@ export class TadaWatchRuntime {
     wslog.debug`WebSocket server listening at ws://localhost:${this.server.port}${WATCH_RELOAD_PATH}`;
   }
 
-  async onEvent(
-    event: WatchLifecycleEvent<TadaSnapshot, TadaBuildMeta>,
-  ): Promise<void> {
+  async onEvent(event: WatchLifecycleEvent): Promise<void> {
     switch (event.kind) {
       case 'build-started':
-        if (!event.initial) {
-          for (const change of event.batch?.changes || []) {
-            log.event`${B`${path.basename(change.path)}`} ${describeChange(change.kind)}`;
-          }
-          this.broadcast(WATCH_RELOAD_MESSAGE_REBUILDING);
+        if (!event.batch) {
+          return;
+        }
+        for (const change of event.batch.changes) {
+          log.event`${B`${path.basename(change.path)}`} ${describeChange(change.kind)}`;
         }
+        this.broadcast(WATCH_RELOAD_MESSAGE_REBUILDING);
         return;
       case 'build-succeeded': {
-        const recoveredFromFailure = this.lastBuildFailed;
-        this.lastBuildFailed = false;
         printFlair();
         this.ensureServerStarted();
-        if (!event.initial && (event.changed || recoveredFromFailure)) {
+        if (event.batch) {
           this.broadcast(WATCH_RELOAD_MESSAGE_RELOAD);
         }
-        if (event.meta && event.changed) {
-          if (event.meta.siteVariables.features.search !== false) {
-            const siteVariablesKey = JSON.stringify(event.meta.siteVariables);
-            if (
-              !this.pagefindRunner ||
-              this.pagefindSiteVariablesKey !== siteVariablesKey
-            ) {
-              this.pagefindRunner = new WatchPagefindRunner();
-              this.pagefindSiteVariablesKey = siteVariablesKey;
-            }
-            this.pagefindRunner.update(
-              this.distDir,
-              event.meta.htmlAssetsByPath,
-              event.meta.htmlAnalysisByPath,
-            );
-            setImmediate(() => this.pagefindRunner!.run());
-          } else {
-            this.pagefindRunner = undefined;
-            this.pagefindSiteVariablesKey = undefined;
+        if (event.meta.siteVariables.features.search !== false) {
+          const siteVariablesKey = JSON.stringify(event.meta.siteVariables);
+          if (
+            !this.pagefindRunner ||
+            this.pagefindSiteVariablesKey !== siteVariablesKey
+          ) {
+            this.pagefindRunner = new WatchPagefindRunner();
+            this.pagefindSiteVariablesKey = siteVariablesKey;
           }
+          this.pagefindRunner.update(
+            this.distDir,
+            event.meta.htmlAssetsByPath,
+            event.meta.htmlAnalysisByPath,
+          );
+          setImmediate(() => this.pagefindRunner!.run());
+        } else {
+          this.pagefindRunner = undefined;
+          this.pagefindSiteVariablesKey = undefined;
         }
         return;
       }
       case 'build-failed':
-        this.lastBuildFailed = true;
         for (const diagnostic of event.diagnostics) {
           log.error`${diagnostic.message}`;
         }
@@ -120,8 +110,6 @@ export class TadaWatchRuntime {
       case 'watching':
         log.info`Watching for changes...`;
         return;
-      case 'build-skipped':
-        return;
     }
   }
 }