@dbx-tools/projen 0.6.13 → 0.6.14

package/package.json

@@ -32,7 +32,7 @@
   },
   "main": "index.ts",
   "license": "Apache-2.0",
-  "version": "0.6.13",
+  "version": "0.6.14",
   "types": "index.ts",
   "type": "module",
   "exports": {

package/src/watch.ts

@@ -4,7 +4,8 @@
  * `watchLoop` wraps `@dbx-tools/path`'s chokidar watcher with the
  * behavior every dbx-tools watcher wants: it debounces bursts, serializes runs (a
  * change mid-run re-runs once afterwards), drops generated paths (barrels/manifests/
- * decls - reacting to our own output would loop), and shuts down on SIGINT. Callers
+ * decls - reacting to our own output would loop), exits on a watcher error chokidar
+ * cannot recover from ({@link FATAL_WATCH_ERROR_CODES}), and shuts down on SIGINT. Callers
  * pass the paths to watch and an `onBatch` handler; the concern-specific glue - which
  * barrels to rebuild, when to regenerate openapi, when to re-synth - lives in the task
  * that owns it (`tasks/barrels.ts`, `tasks/openapi.ts`, `tasks/projenrc.ts`), each
@@ -16,12 +17,36 @@
  */
 import { isAbsolute, resolve } from "node:path";
 import { watch as fileScan } from "@dbx-tools/path";
-import { log } from "@dbx-tools/shared-core";
+import { async, log } from "@dbx-tools/shared-core";
 import { isGeneratedFile, recordedRoots, repoRoot } from "./packages.ts";
 
 const logger = log.logger("projen:watch");
 const DEBOUNCE_MS = 250;
 
+/** How long to let chokidar release its watches before exiting regardless. */
+const CLOSE_GRACE_MS = 2_000;
+
+/**
+ * Watcher errors no amount of waiting recovers from: the process is out of file
+ * descriptors (`EMFILE`/`ENFILE`) or the kernel watch table is full (`ENOSPC`).
+ *
+ * These have to end the process, because chokidar only EMITS them - it never closes
+ * itself or marks the instance dead (its own source carries a
+ * `TODO: emit errors properly. Example: EMFILE on Macos.`). A handler that just logs
+ * therefore leaves the watcher open, still holding every descriptor it took, while
+ * silently delivering no further events; and since the process stays alive, `sync`'s
+ * `restartTries: -1` supervisor never sees an exit to respawn. The watcher looks
+ * healthy and its outputs quietly go stale. Exiting non-zero instead hands the
+ * restart to `concurrently`, which is what makes a transient exhaustion recover on
+ * its own and a persistent one loud (a respawn every `RESTART_DELAY_MS`).
+ *
+ * Every other error is left as a logged warning: chokidar has already filtered the
+ * benign `ENOENT`/`ENOTDIR` cases, and what remains (an unreadable path, say) costs
+ * that one path while the rest of the tree keeps working - a restart would only hit
+ * it again.
+ */
+const FATAL_WATCH_ERROR_CODES = new Set(["EMFILE", "ENFILE", "ENOSPC"]);
+
 /** node-path's built-in ignore-group toggles (`{ dot, temp, test, lock, defaults }`). */
 export type IgnoreGroupOptions = NonNullable<
   Parameters<typeof fileScan.watchFiles>[1]
@@ -45,7 +70,11 @@ function ignoredPath(path: string): boolean {
  * Shared debounce/flush machinery backed by `watchFiles`. Watches `paths` and, on
  * each debounced batch of non-generated changes, calls `onBatch` with the absolute
  * changed paths. Runs are serialized (a change during a run re-runs once afterwards);
- * watches until SIGINT.
+ * watches until SIGINT, or until a {@link FATAL_WATCH_ERROR_CODES} error makes the
+ * watcher blind, which exits non-zero so `sync` respawns it.
+ *
+ * A failing `onBatch` is NOT fatal - the offending edit is usually the one the next
+ * save fixes - so it is logged and the watch continues.
  *
  * `ignoreOptions` toggles node-path's built-in ignore groups for this watcher only
  * (e.g. the projenrc watcher passes `{ dot: false }` so its lone dotfile target,
@@ -92,16 +121,34 @@ export function watchLoop(
     ignore: (path) => ignoredPath(path),
     ignoreOptions,
   });
+  let closing = false;
+
+  /**
+   * Release the watches and leave with `code`. Closing is raced against
+   * {@link CLOSE_GRACE_MS} so a wedged chokidar cannot hold up a Ctrl-C, and exiting
+   * reclaims the descriptors either way.
+   */
+  async function shutdown(code: number): Promise<void> {
+    if (closing) return;
+    closing = true;
+    clearTimeout(timer);
+    await Promise.race([watcher.close().catch(() => {}), async.sleep(CLOSE_GRACE_MS)]);
+    process.exit(code);
+  }
+
   watcher.on("all", (_event, path) => {
     pending.add(path);
     clearTimeout(timer);
     timer = setTimeout(() => void flush(), DEBOUNCE_MS);
   });
-  watcher.on("error", (err) => logger.error(`${tag} watcher error:`, err));
+  watcher.on("error", (err) => {
+    logger.error(`${tag} watcher error:`, err);
+    const code = (err as NodeJS.ErrnoException | undefined)?.code;
+    if (code === undefined || !FATAL_WATCH_ERROR_CODES.has(code)) return;
+    logger.error(`${tag}: ${code} leaves the watcher blind - exiting so it is restarted`);
+    void shutdown(1);
+  });
   watcher.on("ready", () => logger.info(`${tag}: watching for changes … (Ctrl-C to stop)`));
 
-  process.on("SIGINT", () => {
-    void watcher.close();
-    process.exit(0);
-  });
+  process.on("SIGINT", () => void shutdown(0));
 }