git-watchtower 1.6.0 → 1.7.0

package/bin/git-watchtower.js

@@ -66,6 +66,9 @@ const casinoSounds = require('../src/casino/sounds');
 // Gitignore utilities for file watcher
 const { loadGitignorePatterns, shouldIgnoreFile } = require('../src/utils/gitignore');
 
+// Telemetry (opt-in PostHog analytics)
+const telemetry = require('../src/telemetry');
+
 // Extracted modules
 const { formatTimeAgo } = require('../src/utils/time');
 const { openInBrowser: openUrl } = require('../src/utils/browser');
@@ -195,6 +198,7 @@ async function runConfigurationWizard() {
 
   // Save configuration
   saveConfig(config);
+  telemetry.capture('config_wizard_completed', { server_mode: config.server.mode });
 
   console.log('\n✓ Configuration saved to ' + CONFIG_FILE_NAME);
   console.log('  You can edit this file manually or delete it to reconfigure.\n');
@@ -367,6 +371,10 @@ let AUTO_PULL = true;
 const MAX_LOG_ENTRIES = 10;
 const MAX_SERVER_LOG_LINES = 500;
 
+// Telemetry session tracking
+let branchSwitchCount = 0;
+let sessionStartTime = null;
+
 // Server process management (for command mode)
 let serverProcess = null;
 
@@ -676,17 +684,27 @@ function stopServerProcess() {
 
   addLog('Stopping server...', 'update');
 
+  // Capture reference before nulling — needed for deferred SIGKILL
+  const proc = serverProcess;
+
   // Try graceful shutdown first
   if (process.platform === 'win32') {
-    spawn('taskkill', ['/pid', serverProcess.pid, '/f', '/t']);
+    spawn('taskkill', ['/pid', proc.pid.toString(), '/f', '/t']);
   } else {
-    serverProcess.kill('SIGTERM');
-    // Force kill after timeout
-    setTimeout(() => {
-      if (serverProcess) {
-        serverProcess.kill('SIGKILL');
+    proc.kill('SIGTERM');
+    // Force kill after grace period if process hasn't exited
+    const forceKillTimeout = setTimeout(() => {
+      try {
+        proc.kill('SIGKILL');
+      } catch (e) {
+        // Process may already be dead
       }
     }, 3000);
+
+    // Clear the force-kill timer if the process exits cleanly
+    proc.once('close', () => {
+      clearTimeout(forceKillTimeout);
+    });
   }
 
   serverProcess = null;
@@ -796,15 +814,28 @@ const LIVE_RELOAD_SCRIPT = `
 // Utility Functions
 // ============================================================================
 
+// Default timeout for execAsync (30 seconds) — prevents hung git/CLI commands
+// from permanently blocking the polling loop
+const EXEC_ASYNC_TIMEOUT = 30000;
+
 function execAsync(command, options = {}) {
+  const { timeout = EXEC_ASYNC_TIMEOUT, ...restOptions } = options;
   return new Promise((resolve, reject) => {
-    exec(command, { cwd: PROJECT_ROOT, ...options }, (error, stdout, stderr) => {
+    const child = exec(command, { cwd: PROJECT_ROOT, timeout, ...restOptions }, (error, stdout, stderr) => {
       if (error) {
         reject({ error, stdout, stderr });
       } else {
         resolve({ stdout: stdout.trim(), stderr: stderr.trim() });
       }
     });
+    // Also kill the child if the timeout fires (exec timeout sends SIGTERM
+    // but doesn't guarantee cleanup of process trees)
+    if (timeout > 0) {
+      const killTimer = setTimeout(() => {
+        try { child.kill('SIGKILL'); } catch (e) { /* already dead */ }
+      }, timeout + 5000);
+      child.on('close', () => clearTimeout(killTimer));
+    }
   });
 }
 
@@ -1396,6 +1427,7 @@ async function switchToBranch(branchName, recordHistory = true) {
       addLog(`Cannot switch: uncommitted changes in working directory`, 'error');
       pendingDirtyOperation = { type: 'switch', branch: branchName };
       showStashConfirm(`switch to ${branchName}`);
+      telemetry.capture('dirty_repo_encountered');
       return { success: false, reason: 'dirty' };
     }
 
@@ -1428,6 +1460,8 @@ async function switchToBranch(branchName, recordHistory = true) {
     }
 
     addLog(`Switched to ${safeBranchName}`, 'success');
+    telemetry.capture('branch_switched');
+    branchSwitchCount++;
     pendingDirtyOperation = null;
 
     // Restart server if configured (command mode)
@@ -1457,6 +1491,7 @@ async function switchToBranch(branchName, recordHistory = true) {
         truncate(errMsg, 100),
         'Check the activity log for details'
       );
+      telemetry.captureError(e);
     }
     return { success: false };
   }
@@ -1565,6 +1600,7 @@ async function stashAndRetry() {
   }
 
   addLog('Changes stashed successfully', 'success');
+  telemetry.capture('stash_performed');
 
   if (operation.type === 'switch') {
     const switchResult = await switchToBranch(operation.branch);
@@ -2010,6 +2046,16 @@ const server = http.createServer((req, res) => {
   pathname = path.normalize(pathname).replace(/^(\.\.[\/\\])+/, '');
   let filePath = path.join(STATIC_DIR, pathname);
 
+  // Security: ensure resolved path stays within STATIC_DIR to prevent path traversal
+  const resolvedPath = path.resolve(filePath);
+  const resolvedStaticDir = path.resolve(STATIC_DIR);
+  if (!resolvedPath.startsWith(resolvedStaticDir + path.sep) && resolvedPath !== resolvedStaticDir) {
+    res.writeHead(403, { 'Content-Type': 'text/html' });
+    res.end('<h1>403 Forbidden</h1>');
+    addServerLog(`GET ${logPath} → 403 (path traversal blocked)`, true);
+    return;
+  }
+
   if (fs.existsSync(filePath) && fs.statSync(filePath).isDirectory()) {
     filePath = path.join(filePath, 'index.html');
   }
@@ -2215,6 +2261,7 @@ function setupKeyboardInput() {
           openInBrowser(prUrl);
         } else if (!prInfo && prLoaded && cliReady) {
           // Create PR — only if we've confirmed no PR exists (prLoaded=true)
+          telemetry.capture('pr_action', { action: 'create' });
           addLog(`Creating ${prLabel} for ${aBranch.name}...`, 'update');
           render();
           try {
@@ -2256,6 +2303,7 @@ function setupKeyboardInput() {
         return;
       }
       if (key === 'a' && prInfo && cliReady) { // Approve PR
+        telemetry.capture('pr_action', { action: 'approve' });
         addLog(`Approving ${prLabel} #${prInfo.number}...`, 'update');
         render();
         try {
@@ -2275,6 +2323,7 @@ function setupKeyboardInput() {
         return;
       }
       if (key === 'm' && prInfo && cliReady) { // Merge PR
+        telemetry.capture('pr_action', { action: 'merge' });
         addLog(`Merging ${prLabel} #${prInfo.number}...`, 'update');
         render();
         try {
@@ -2373,6 +2422,7 @@ function setupKeyboardInput() {
           addLog(`Failed to delete ${f.name}: ${f.error}`, 'error');
         }
         if (result.deleted.length > 0) {
+          telemetry.capture('cleanup_branches_deleted', { count: result.deleted.length });
           addLog(`Cleaned up ${result.deleted.length} branch${result.deleted.length === 1 ? '' : 'es'}`, 'success');
           await pollGitChanges();
         }
@@ -2495,12 +2545,14 @@ function setupKeyboardInput() {
           render();
           const pvData = await getPreviewData(branch.name);
           store.setState({ previewData: pvData, previewMode: true });
+          telemetry.capture('preview_opened');
           render();
         }
         break;
 
       case '/': // Search mode
         applyUpdates(actions.enterSearchMode(actionState));
+        telemetry.capture('search_used');
         render();
         break;
 
@@ -2515,11 +2567,13 @@ function setupKeyboardInput() {
         break;
 
       case 'u': // Undo last switch
+        telemetry.capture('undo_branch_switch');
         await undoLastSwitch();
         await pollGitChanges();
         break;
 
       case 'p':
+        telemetry.capture('pull_forced');
         await pullCurrentBranch();
         await pollGitChanges();
         break;
@@ -2558,6 +2612,7 @@ function setupKeyboardInput() {
         const branch = displayBranches.length > 0 && curSelIdx < displayBranches.length
           ? displayBranches[curSelIdx] : null;
         if (branch) {
+          telemetry.capture('branch_actions_opened');
           // Phase 1: Open modal instantly with local/cached data
           const localData = gatherLocalActionData(branch);
           store.setState({ actionData: localData, actionMode: true, actionLoading: !localData.prLoaded });
@@ -2592,8 +2647,10 @@ function setupKeyboardInput() {
 
       case 's': {
         applyUpdates(actions.toggleSound(actionState));
-        addLog(`Sound notifications ${store.get('soundEnabled') ? 'enabled' : 'disabled'}`, 'info');
-        if (store.get('soundEnabled')) playSound();
+        const soundNowEnabled = store.get('soundEnabled');
+        addLog(`Sound notifications ${soundNowEnabled ? 'enabled' : 'disabled'}`, 'info');
+        telemetry.capture('sound_toggled', { enabled: soundNowEnabled });
+        if (soundNowEnabled) playSound();
         render();
         break;
       }
@@ -2612,6 +2669,7 @@ function setupKeyboardInput() {
       case 'c': { // Toggle casino mode
         const newCasinoState = casino.toggle();
         store.setState({ casinoModeEnabled: newCasinoState });
+        telemetry.capture('casino_mode_toggled', { enabled: newCasinoState });
         addLog(`Casino mode ${newCasinoState ? '🎰 ENABLED' : 'disabled'}`, newCasinoState ? 'success' : 'info');
         if (newCasinoState) {
           addLog(`Have you noticed this game has that 'variable rewards' thing going on? 🤔😉`, 'info');
@@ -2721,6 +2779,14 @@ async function shutdown() {
     await Promise.race([serverClosePromise, timeoutPromise]);
   }
 
+  // Flush telemetry
+  telemetry.capture('session_ended', {
+    duration_seconds: sessionStartTime ? Math.round((Date.now() - sessionStartTime) / 1000) : 0,
+    branch_switches: branchSwitchCount,
+    branches_count: store.get('branches').length,
+  });
+  await telemetry.shutdown();
+
   console.log('\n✓ Git Watchtower stopped\n');
   process.exit(0);
 }
@@ -2728,6 +2794,7 @@ async function shutdown() {
 process.on('SIGINT', shutdown);
 process.on('SIGTERM', shutdown);
 process.on('uncaughtException', (err) => {
+  telemetry.captureError(err);
   write(ansi.showCursor);
   write(ansi.restoreScreen);
   restoreTerminalTitle();
@@ -2754,6 +2821,19 @@ async function start() {
   const config = await ensureConfig(cliArgs);
   applyConfig(config);
 
+  // Telemetry: opt-in prompt (first run only) and initialization
+  await telemetry.promptIfNeeded(promptYesNo);
+  telemetry.init({ version: PACKAGE_VERSION });
+  sessionStartTime = Date.now();
+  telemetry.capture('tool_launched', {
+    version: PACKAGE_VERSION,
+    node_version: process.version,
+    os: process.platform,
+    server_mode: SERVER_MODE,
+    has_config: !!loadConfig(),
+    casino_mode: config.casinoMode || false,
+  });
+
   // Set up casino mode render callback for animations
   casino.setRenderCallback(render);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-watchtower",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Terminal-based Git branch monitor with activity sparklines and optional dev server with live reload",
   "main": "bin/git-watchtower.js",
   "bin": {
@@ -52,6 +52,8 @@
   },
   "files": [
     "bin/git-watchtower.js",
+    "src/",
+    "sounds/",
     "README.md",
     "LICENSE"
   ],
@@ -85,5 +87,8 @@
         }
       ]
     ]
+  },
+  "dependencies": {
+    "posthog-node": "^5.28.0"
   }
 }

package/sounds/README.md

@@ -0,0 +1,34 @@
+# Casino Mode Sound Effects
+
+Casino mode uses system sounds by default. For custom sounds, add `.wav` files to this directory:
+
+## Sound Files
+
+| File | Description |
+|------|-------------|
+| `win.wav` | Short victory sound (small/medium wins) |
+| `jackpot.wav` | Exciting fanfare (big wins, jackpots) |
+| `spin.wav` | Slot machine spinning sound |
+| `loss.wav` | Sad trombone / failure sound |
+
+## Free Sound Sources
+
+- [Freesound.org](https://freesound.org/) - Search for "slot machine", "casino win", "coin"
+- [Mixkit](https://mixkit.co/free-sound-effects/) - Game sounds category
+- [Zapsplat](https://www.zapsplat.com/) - Royalty-free effects
+
+## Recommended Search Terms
+
+- "slot machine win"
+- "casino jackpot"
+- "coin drop"
+- "cha-ching"
+- "sad trombone"
+- "wah wah"
+- "game over"
+
+## Format Notes
+
+- WAV format recommended for best compatibility
+- Keep files short (1-3 seconds)
+- Mono or stereo, any sample rate works