@travetto/compiler 5.0.8 → 5.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/compiler",
-  "version": "5.0.8",
+  "version": "5.0.10",
   "description": "The compiler infrastructure for the Travetto framework",
   "keywords": [
     "compiler",

package/src/watch.ts

@@ -7,6 +7,9 @@ import { CompilerState } from './state';
 import { CompilerUtil } from './util';
 
 import { AsyncQueue } from '../support/queue';
+import { IpcLogger } from '../support/log';
+
+const log = new IpcLogger({ level: 'debug' });
 
 type WatchAction = 'create' | 'update' | 'delete';
 type WatchEvent = { action: WatchAction, file: string };
@@ -19,6 +22,8 @@ type FileShape = {
   action: WatchAction;
 };
 
+const DEFAULT_WRITE_LIMIT = 1000 * 60 * 5;
+
 /**
  * Watch support, based on compiler state and manifest details
  */
@@ -31,6 +36,30 @@ export class CompilerWatcher {
     this.#signal = signal;
   }
 
+  #watchDog(): { reset(file: string): void, close(): void } {
+    let lastWrite = Date.now();
+    let writeThreshold = DEFAULT_WRITE_LIMIT;
+    log.info('Starting watchdog');
+    const value = setInterval(() => {
+      if (Date.now() > (lastWrite + writeThreshold)) {
+        const delta = (Date.now() - lastWrite) / (1000 * 60);
+        log.info(`Watch has not seen changes in ${Math.trunc(delta)}m`);
+        writeThreshold += DEFAULT_WRITE_LIMIT;
+      }
+    }, DEFAULT_WRITE_LIMIT / 10);
+    return {
+      close: (): void => {
+        log.info('Closing watchdog');
+        clearInterval(value);
+      },
+      reset: (file: string): void => {
+        log.debug('Resetting watchdog', file);
+        lastWrite = Date.now();
+        writeThreshold = DEFAULT_WRITE_LIMIT;
+      }
+    };
+  }
+
   #reset(ev: WatchEvent): never {
     throw new Error('RESET', { cause: `${ev.action}:${ev.file}` });
   }
@@ -150,26 +179,41 @@ export class CompilerWatcher {
     }
 
     const manifest = this.#state.manifest;
-    const ROOT_LOCK = path.resolve(manifest.workspace.path, 'package-lock.json');
-    const ROOT_PKG = path.resolve(manifest.workspace.path, 'package.json');
-    const OUTPUT_PATH = path.resolve(manifest.workspace.path, manifest.build.outputFolder);
-    const COMPILER_PATH = path.resolve(manifest.workspace.path, manifest.build.compilerFolder);
+    const ROOT = manifest.workspace.path;
+    const ROOT_LOCK = 'package-lock.json';
+    const ROOT_PKG = 'package.json';
+    const OUTPUT_PATH = manifest.build.outputFolder;
+    const COMPILER_PATH = manifest.build.compilerFolder;
+    const TYPES_PATH = manifest.build.typesFolder;
+    const COMPILER_ROOT = path.dirname(COMPILER_PATH);
+
+    const IGNORE_RE = new RegExp(`^[.]|(${COMPILER_PATH}|${TYPES_PATH}|${OUTPUT_PATH})`);
+
+    const watchDog = this.#watchDog();
 
-    for await (const events of this.#watchFolder(this.#state.manifest.workspace.path)) {
+    for await (const events of this.#watchFolder(ROOT)) {
 
       const outEvents: CompilerWatchEvent[] = [];
 
       for (const ev of events) {
         const { action, file: sourceFile } = ev;
 
+        const relativeFile = sourceFile.replace(`${ROOT}/`, '');
+
         if (
-          sourceFile === ROOT_LOCK ||
-          sourceFile === ROOT_PKG ||
-          (action === 'delete' && (sourceFile === OUTPUT_PATH || sourceFile === COMPILER_PATH))
+          relativeFile === ROOT_LOCK ||
+          relativeFile === ROOT_PKG ||
+          (action === 'delete' && relativeFile === COMPILER_ROOT)
         ) {
           this.#reset(ev);
         }
 
+        if (IGNORE_RE.test(relativeFile)) {
+          continue;
+        }
+
+        watchDog.reset(relativeFile);
+
         const fileType = ManifestModuleUtil.getFileType(sourceFile);
         if (!CompilerUtil.validFile(fileType)) {
           continue;
@@ -179,6 +223,7 @@ export class CompilerWatcher {
 
         const mod = entry?.module ?? this.#state.manifestIndex.findModuleForArbitraryFile(sourceFile);
         if (!mod) { // Unknown module
+          log.debug(`Unknown module for a given file ${relativeFile}`);
           continue;
         }
 
@@ -188,8 +233,10 @@ export class CompilerWatcher {
         if (action === 'create') {
           entry = this.#state.registerInput(mod, moduleFile);
         } else if (!entry) {
+          log.debug(`Unknown file ${relativeFile}`);
           continue;
         } else if (action === 'update' && !this.#state.checkIfSourceChanged(entry.sourceFile)) {
+          log.debug(`Skipping update, as contents unchanged ${relativeFile}`);
           continue;
         } else if (action === 'delete') {
           this.#state.removeSource(entry.sourceFile);
@@ -198,8 +245,15 @@ export class CompilerWatcher {
         outEvents.push({ action, file: entry.sourceFile, entry });
       }
 
-      await this.#rebuildManifestsIfNeeded(outEvents);
+      try {
+        await this.#rebuildManifestsIfNeeded(outEvents);
+      } catch (err) {
+        log.info('Restarting due to manifest rebuild failure', err);
+        this.#reset(events[0]);
+      }
       yield* outEvents;
     }
+
+    watchDog.close();
   }
 }