@veraxhq/verax 0.2.0 → 0.2.1

package/src/cli/commands/run.js

@@ -1,8 +1,8 @@
-import { resolve, join } from 'path';
+import { resolve } from 'path';
 import { existsSync, readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
 import { dirname } from 'path';
-import { UsageError, DataError, CrashError } from '../util/errors.js';
+import { UsageError, DataError } from '../util/errors.js';
 import { generateRunId } from '../util/run-id.js';
 import { getRunPaths, ensureRunDirectories } from '../util/paths.js';
 import { atomicWriteJson, atomicWriteText } from '../util/atomic-write.js';
@@ -16,6 +16,7 @@ import { writeObserveJson } from '../util/observe-writer.js';
 import { detectFindings } from '../util/detection-engine.js';
 import { writeFindingsJson } from '../util/findings-writer.js';
 import { writeSummaryJson } from '../util/summary-writer.js';
+import { computeRuntimeBudget, withTimeout } from '../util/runtime-budget.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -61,6 +62,7 @@ export async function runCommand(options) {
   
   // Setup event handlers
   if (json) {
+    // In JSON mode, emit events as JSONL (one JSON object per line)
     events.on('*', (event) => {
       console.log(JSON.stringify(event));
     });
@@ -75,6 +77,73 @@ export async function runCommand(options) {
   let runId = null;
   let paths = null;
   let startedAt = null;
+  let watchdogTimer = null;
+  let budget = null;
+  let timedOut = false;
+  
+  // Graceful finalization function
+  const finalizeOnTimeout = async (reason) => {
+    if (timedOut) return; // Prevent double finalization
+    timedOut = true;
+    
+    events.stopHeartbeat();
+    
+    if (paths && runId && startedAt) {
+      try {
+        const failedAt = new Date().toISOString();
+        atomicWriteJson(paths.runStatusJson, {
+          status: 'FAILED',
+          runId,
+          startedAt,
+          failedAt,
+          error: reason,
+        });
+        
+        atomicWriteJson(paths.runMetaJson, {
+          veraxVersion: getVersion(),
+          nodeVersion: process.version,
+          platform: process.platform,
+          cwd: projectRoot,
+          command: 'run',
+          args: { url, src, out },
+          url,
+          src: srcPath,
+          startedAt,
+          completedAt: failedAt,
+          error: reason,
+        });
+        
+        try {
+          writeSummaryJson(paths.summaryJson, {
+            runId,
+            status: 'FAILED',
+            startedAt,
+            completedAt: failedAt,
+            command: 'run',
+            url,
+            notes: `Run timed out: ${reason}`,
+          }, {
+            expectationsTotal: 0,
+            attempted: 0,
+            observed: 0,
+            silentFailures: 0,
+            coverageGaps: 0,
+            unproven: 0,
+            informational: 0,
+          });
+        } catch (summaryError) {
+          // Ignore summary write errors during timeout handling
+        }
+      } catch (statusError) {
+        // Ignore errors when writing failure status
+      }
+    }
+    
+    events.emit('error', {
+      message: reason,
+      type: 'timeout',
+    });
+  };
   
   try {
     // Generate run ID
@@ -148,14 +217,53 @@ export async function runCommand(options) {
       error: null,
     });
     
-    // Simulate learning phase (placeholder)
+    // Extract expectations first to compute budget
     events.emit('phase:started', {
       phase: 'Learn',
       message: 'Analyzing project structure...',
     });
     
-    // Extract expectations
-    const { expectations, skipped } = await extractExpectations(projectProfile, projectProfile.sourceRoot);
+    events.startHeartbeat('Learn', json);
+    
+    let expectations, skipped;
+    try {
+      // Extract expectations (quick operation, no timeout needed here)
+      const result = await extractExpectations(projectProfile, projectProfile.sourceRoot);
+      expectations = result.expectations;
+      skipped = result.skipped;
+    } finally {
+      events.stopHeartbeat();
+    }
+    
+    // Compute runtime budget based on expectations count
+    budget = computeRuntimeBudget({
+      expectationsCount: expectations.length,
+      mode: 'run',
+      framework: projectProfile.framework,
+      fileCount: projectProfile.fileCount || expectations.length,
+    });
+    
+    // Set up global watchdog timer
+    watchdogTimer = setTimeout(async () => {
+      await finalizeOnTimeout(`Global timeout exceeded: ${budget.totalMaxMs}ms`);
+      // Exit with code 0 (tool executed, just timed out)
+      process.exit(0);
+    }, budget.totalMaxMs);
+    
+    // Wrap Learn phase with timeout
+    try {
+      await withTimeout(
+        budget.learnMaxMs,
+        Promise.resolve(), // Learn phase already completed
+        'Learn'
+      );
+    } catch (error) {
+      if (error.message.includes('timeout')) {
+        await finalizeOnTimeout(`Learn phase timeout: ${budget.learnMaxMs}ms`);
+        process.exit(0);
+      }
+      throw error;
+    }
     
     // For now, emit a placeholder trace event
     events.emit('phase:completed', {
@@ -163,39 +271,60 @@ export async function runCommand(options) {
       message: 'Project analysis complete',
     });
     
-    // Observe phase
+    // Observe phase with timeout
     events.emit('phase:started', {
       phase: 'Observe',
       message: 'Launching browser and observing expectations...',
     });
     
+    events.startHeartbeat('Observe', json);
+    
     let observeData = null;
-    if (expectations.length > 0) {
-      try {
-        observeData = await observeExpectations(
-          expectations,
-          url,
-          paths.evidenceDir,
-          (progress) => {
-            events.emit(progress.event, progress);
+    try {
+      if (expectations.length > 0) {
+        try {
+          observeData = await withTimeout(
+            budget.observeMaxMs,
+            observeExpectations(
+              expectations,
+              url,
+              paths.evidenceDir,
+              (progress) => {
+                events.emit(progress.event, progress);
+              }
+            ),
+            'Observe'
+          );
+        } catch (error) {
+          if (error.message.includes('timeout')) {
+            events.emit('observe:error', {
+              message: `Observe phase timeout: ${budget.observeMaxMs}ms`,
+            });
+            observeData = {
+              observations: [],
+              stats: { attempted: 0, observed: 0, notObserved: 0 },
+              observedAt: new Date().toISOString(),
+            };
+          } else {
+            events.emit('observe:error', {
+              message: error.message,
+            });
+            observeData = {
+              observations: [],
+              stats: { attempted: 0, observed: 0, notObserved: 0 },
+              observedAt: new Date().toISOString(),
+            };
           }
-        );
-      } catch (error) {
-        events.emit('observe:error', {
-          message: error.message,
-        });
+        }
+      } else {
         observeData = {
           observations: [],
           stats: { attempted: 0, observed: 0, notObserved: 0 },
           observedAt: new Date().toISOString(),
         };
       }
-    } else {
-      observeData = {
-        observations: [],
-        stats: { attempted: 0, observed: 0, notObserved: 0 },
-        observedAt: new Date().toISOString(),
-      };
+    } finally {
+      events.stopHeartbeat();
     }
     
     events.emit('phase:completed', {
@@ -203,32 +332,53 @@ export async function runCommand(options) {
       message: 'Browser observation complete',
     });
     
-      // Detect phase
+      // Detect phase with timeout
       events.emit('phase:started', {
         phase: 'Detect',
         message: 'Analyzing findings and detecting silent failures...',
       });
     
+      events.startHeartbeat('Detect', json);
+    
       let detectData = null;
       try {
-        // Use already-extracted expectations
-        const learnData = {
-          expectations,
-          skipped,
-        };
-      
-        detectData = await detectFindings(learnData, observeData, projectRoot, (progress) => {
-          events.emit(progress.event, progress);
-        });
-      } catch (error) {
-        events.emit('detect:error', {
-          message: error.message,
-        });
-        detectData = {
-          findings: [],
-          stats: { total: 0, silentFailures: 0, observed: 0, coverageGaps: 0, unproven: 0, informational: 0 },
-          detectedAt: new Date().toISOString(),
-        };
+        try {
+          // Use already-extracted expectations
+          const learnData = {
+            expectations,
+            skipped,
+          };
+        
+          detectData = await withTimeout(
+            budget.detectMaxMs,
+            detectFindings(learnData, observeData, projectRoot, (progress) => {
+              events.emit(progress.event, progress);
+            }),
+            'Detect'
+          );
+        } catch (error) {
+          if (error.message.includes('timeout')) {
+            events.emit('detect:error', {
+              message: `Detect phase timeout: ${budget.detectMaxMs}ms`,
+            });
+            detectData = {
+              findings: [],
+              stats: { total: 0, silentFailures: 0, observed: 0, coverageGaps: 0, unproven: 0, informational: 0 },
+              detectedAt: new Date().toISOString(),
+            };
+          } else {
+            events.emit('detect:error', {
+              message: error.message,
+            });
+            detectData = {
+              findings: [],
+              stats: { total: 0, silentFailures: 0, observed: 0, coverageGaps: 0, unproven: 0, informational: 0 },
+              detectedAt: new Date().toISOString(),
+            };
+          }
+        }
+      } finally {
+        events.stopHeartbeat();
       }
     
       events.emit('phase:completed', {
@@ -236,12 +386,20 @@ export async function runCommand(options) {
         message: 'Silent failure detection complete',
       });
     
+    // Clear watchdog timer on successful completion
+    if (watchdogTimer) {
+      clearTimeout(watchdogTimer);
+      watchdogTimer = null;
+    }
+    
     // Emit finalize phase
     events.emit('phase:started', {
       phase: 'Finalize Artifacts',
       message: 'Writing run results...',
     });
     
+    events.stopHeartbeat();
+    
     const completedAt = new Date().toISOString();
     
     // Write completed status
@@ -267,6 +425,20 @@ export async function runCommand(options) {
       error: null,
     });
     
+    const runDurationMs = completedAt && startedAt ? (Date.parse(completedAt) - Date.parse(startedAt)) : 0;
+    const metrics = {
+      learnMs: observeData?.timings?.learnMs || 0,
+      observeMs: observeData?.timings?.observeMs || observeData?.timings?.totalMs || 0,
+      detectMs: detectData?.timings?.detectMs || detectData?.timings?.totalMs || 0,
+      totalMs: runDurationMs > 0 ? runDurationMs : (budget?.ms || 0)
+    };
+    const findingsCounts = detectData?.findingsCounts || {
+      HIGH: 0,
+      MEDIUM: 0,
+      LOW: 0,
+      UNKNOWN: 0,
+    };
+
     // Write summary with stable digest
     writeSummaryJson(paths.summaryJson, {
       runId,
@@ -276,6 +448,8 @@ export async function runCommand(options) {
       command: 'run',
       url,
       notes: 'Run completed successfully',
+      metrics,
+      findingsCounts,
     }, {
       expectationsTotal: expectations.length,
       attempted: observeData.stats?.attempted || 0,
@@ -284,36 +458,18 @@ export async function runCommand(options) {
       coverageGaps: detectData.stats?.coverageGaps || 0,
       unproven: detectData.stats?.unproven || 0,
       informational: detectData.stats?.informational || 0,
+      ...metrics,
+      ...findingsCounts,
     });
     
     // Write detect results (or empty if detection failed)
     writeFindingsJson(paths.baseDir, detectData);
     
-    // Write traces (at least phase events)
-    const traces = [
-      {
-        type: 'phase:started',
-        timestamp: startedAt,
-        phase: 'Detect Project',
-      },
-      {
-        type: 'phase:completed',
-        timestamp: new Date().toISOString(),
-        phase: 'Detect Project',
-      },
-      {
-        type: 'phase:started',
-        timestamp: new Date().toISOString(),
-        phase: 'Learn',
-      },
-      {
-        type: 'phase:completed',
-        timestamp: completedAt,
-        phase: 'Learn',
-      },
-    ];
-    
-    const tracesContent = traces.map(t => JSON.stringify(t)).join('\n') + '\n';
+    // Write traces (include all events including heartbeats)
+    const allEvents = events.getEvents();
+    const tracesContent = allEvents
+      .map(e => JSON.stringify(e))
+      .join('\n') + '\n';
     atomicWriteText(paths.tracesJsonl, tracesContent);
     
     // Write project profile
@@ -330,6 +486,26 @@ export async function runCommand(options) {
       message: 'Run artifacts written',
     });
     
+    // Emit final summary event
+    if (json) {
+      events.emit('run:complete', {
+        runId,
+        url,
+        command: 'run',
+        findingsCounts,
+        metrics,
+        digest: {
+          expectationsTotal: expectations.length,
+          attempted: observeData.stats?.attempted || 0,
+          observed: observeData.stats?.observed || 0,
+          silentFailures: detectData.stats?.silentFailures || 0,
+          coverageGaps: detectData.stats?.coverageGaps || 0,
+          unproven: detectData.stats?.unproven || 0,
+          informational: detectData.stats?.informational || 0,
+        }
+      });
+    }
+    
     // Print summary if not JSON mode
     if (!json) {
       console.log('\nRun complete.');
@@ -339,6 +515,14 @@ export async function runCommand(options) {
     
     return { runId, paths, success: true };
   } catch (error) {
+    // Clear watchdog timer on error
+    if (watchdogTimer) {
+      clearTimeout(watchdogTimer);
+      watchdogTimer = null;
+    }
+    
+    events.stopHeartbeat();
+    
     // Mark run as FAILED if we have paths
     if (paths && runId && startedAt) {
       try {

package/src/cli/entry.js

@@ -22,7 +22,7 @@ import { defaultCommand } from './commands/default.js';
 import { runCommand } from './commands/run.js';
 import { inspectCommand } from './commands/inspect.js';
 import { doctorCommand } from './commands/doctor.js';
-import { getExitCode, UsageError, DataError, CrashError } from './util/errors.js';
+import { getExitCode, UsageError } from './util/errors.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -74,7 +74,7 @@ async function main() {
         throw new UsageError('run command requires --url <url> argument');
       }
       
-      const result = await runCommand({ url, src, out, json, verbose });
+      await runCommand({ url, src, out, json, verbose });
       process.exit(0);
     }
     
@@ -87,7 +87,7 @@ async function main() {
       const runPath = args[1];
       const json = args.includes('--json');
       
-      const result = await inspectCommand(runPath, { json });
+      await inspectCommand(runPath, { json });
       process.exit(0);
     }
 
@@ -96,7 +96,7 @@ async function main() {
       const allowedFlags = new Set(['--json']);
       const extraFlags = args.slice(1).filter((a) => a.startsWith('-') && !allowedFlags.has(a));
       const json = args.includes('--json');
-      const result = await doctorCommand({ json, extraFlags });
+      await doctorCommand({ json, extraFlags });
       process.exit(0);
     }
     
@@ -114,7 +114,7 @@ async function main() {
     const json = args.includes('--json');
     const verbose = args.includes('--verbose');
     
-    const result = await defaultCommand({ url, src, out, json, verbose });
+    await defaultCommand({ url, src, out, json, verbose });
     process.exit(0);
   } catch (error) {
     // Print error message

package/src/cli/util/detection-engine.js

@@ -4,7 +4,8 @@
  * Produces exactly one finding per expectation with deterministic confidence and impact.
  */
 
-export async function detectFindings(learnData, observeData, projectPath, onProgress) {
+export async function detectFindings(learnData, observeData, projectPath, onProgress, options = {}) {
+  const log = options.silent ? () => {} : console.log;
   const findings = [];
   const stats = {
     total: 0,
@@ -58,8 +59,8 @@ export async function detectFindings(learnData, observeData, projectPath, onProg
   }
 
   // Terminal narration (one line per finding + summary)
-  narration.forEach((line) => console.log(line));
-  console.log(`SUMMARY findings=${findings.length} observed=${stats.observed} silent-failure=${stats.silentFailures} coverage-gap=${stats.coverageGaps} unproven=${stats.unproven}`);
+  narration.forEach((line) => log(line));
+  log(`SUMMARY findings=${findings.length} observed=${stats.observed} silent-failure=${stats.silentFailures} coverage-gap=${stats.coverageGaps} unproven=${stats.unproven}`);
 
   // Emit completion event
   if (onProgress) {

package/src/cli/util/events.js

@@ -5,6 +5,10 @@ export class RunEventEmitter {
   constructor() {
     this.events = [];
     this.listeners = [];
+    this.heartbeatInterval = null;
+    this.heartbeatStartTime = null;
+    this.currentPhase = null;
+    this.heartbeatIntervalMs = 2500; // 2.5 seconds
   }
   
   on(event, handler) {
@@ -31,4 +35,76 @@ export class RunEventEmitter {
   getEvents() {
     return this.events;
   }
+
+  /**
+   * Start heartbeat for a phase
+   * @param {string} phase - Current phase name
+   * @param {boolean} jsonMode - Whether in JSON output mode
+   */
+  startHeartbeat(phase, jsonMode = false) {
+    this.currentPhase = phase;
+    this.heartbeatStartTime = Date.now();
+    
+    if (this.heartbeatInterval) {
+      clearInterval(this.heartbeatInterval);
+    }
+
+    this.heartbeatInterval = setInterval(() => {
+      const elapsedMs = Date.now() - this.heartbeatStartTime;
+      const elapsedSeconds = Math.floor(elapsedMs / 1000);
+      
+      const heartbeatEvent = {
+        type: 'heartbeat',
+        phase: this.currentPhase,
+        elapsedMs,
+        elapsedSeconds,
+        timestamp: new Date().toISOString(),
+      };
+
+      // Add to events array
+      this.events.push(heartbeatEvent);
+
+      // Emit to listeners
+      this.listeners.forEach(({ event: listenEvent, handler }) => {
+        if (listenEvent === 'heartbeat' || listenEvent === '*') {
+          if (jsonMode) {
+            // In JSON mode, emit as JSON line
+            handler(heartbeatEvent);
+          } else {
+            // Human-readable format: single line, overwrite-friendly
+            process.stdout.write(`\r…still working (phase=${this.currentPhase}, elapsed=${elapsedSeconds}s)`);
+          }
+        }
+      });
+    }, this.heartbeatIntervalMs);
+    
+    // CRITICAL: Unref the interval so it doesn't keep the process alive
+    // This allows tests to exit cleanly even if stopHeartbeat() is not called
+    if (this.heartbeatInterval && this.heartbeatInterval.unref) {
+      this.heartbeatInterval.unref();
+    }
+  }
+
+  /**
+   * Stop heartbeat
+   */
+  stopHeartbeat() {
+    if (this.heartbeatInterval) {
+      clearInterval(this.heartbeatInterval);
+      this.heartbeatInterval = null;
+    }
+    // Clear the progress line in human mode
+    process.stdout.write('\r' + ' '.repeat(60) + '\r');
+    this.currentPhase = null;
+    this.heartbeatStartTime = null;
+  }
+
+  /**
+   * Update current phase for heartbeat
+   * @param {string} phase - New phase name
+   */
+  updatePhase(phase) {
+    this.currentPhase = phase;
+    this.heartbeatStartTime = Date.now();
+  }
 }

package/src/cli/util/expectation-extractor.js

@@ -7,7 +7,7 @@ import { expIdFromHash, compareExpectations } from './idgen.js';
  * Extracts explicit, static expectations from source files
  */
 
-export async function extractExpectations(projectProfile, srcPath) {
+export async function extractExpectations(projectProfile, _srcPath) {
   const expectations = [];
   const skipped = {
     dynamic: 0,
@@ -68,6 +68,16 @@ function getScanPaths(projectProfile, sourceRoot) {
     return [sourceRoot];
   }
   
+  // Unknown framework or no framework detected - check if it's a static HTML project
+  // (This handles cases where framework detection failed but HTML files exist)
+  if (framework === 'unknown') {
+    const htmlFiles = readdirSync(sourceRoot, { withFileTypes: true })
+      .filter(e => e.isFile() && e.name.endsWith('.html'));
+    if (htmlFiles.length > 0) {
+      return [sourceRoot];
+    }
+  }
+  
   // Unknown framework - scan src if it exists
   const srcPath = resolve(sourceRoot, 'src');
   try {

package/src/cli/util/findings-writer.js

@@ -16,6 +16,7 @@ export function writeFindingsJson(runDir, findingsData) {
   
   const payload = {
     findings: findingsWithIds,
+    total: findingsData.stats?.total || 0,
     stats: {
       total: findingsData.stats?.total || 0,
       silentFailures: findingsData.stats?.silentFailures || 0,