claw-dashboard 2.1.0 → 2.2.0

package/tests/config-watcher.test.js

@@ -1,594 +0,0 @@
-/**
- * Tests for config-watcher module
- * Debouncing, polling, reload events, and file watching
- */
-
-import {
-  ConfigWatcher,
-  createConfigWatcher,
-  watchSettingsFile,
-  watchPluginsDirectory,
-  getConfigWatcher,
-  DEFAULT_WATCHER_OPTIONS,
-} from '../src/config-watcher.js';
-
-import { writeFileSync, unlinkSync, mkdirSync, rmdirSync, existsSync, readdirSync } from 'fs';
-import { join } from 'path';
-import { mkdtempSync } from 'fs';
-import { tmpdir } from 'os';
-
-// Simple mock function for tests
-const createMockHandler = () => {
-  const calls = [];
-  const fn = (...args) => {
-    calls.push(args);
-  };
-  fn.getCalls = () => calls;
-  fn.mockClear = () => {
-    calls.length = 0;
-  };
-  return fn;
-};
-
-describe('config-watcher', () => {
-  let testDir;
-
-  beforeEach(() => {
-    // Create a temporary directory for test files
-    testDir = mkdtempSync(join(tmpdir(), 'config-watcher-test-'));
-  });
-
-  afterEach(async () => {
-    // Clean up: stop all watchers and remove temp directory
-    try {
-      const { rmdirSync, unlinkSync, readdirSync } = await import('fs');
-
-      // Stop any existing watchers
-      const watcher = getConfigWatcher();
-      if (watcher) {
-        watcher.unwatchAll();
-      }
-
-      // Remove test directory
-      if (existsSync(testDir)) {
-        const files = readdirSync(testDir);
-        for (const file of files) {
-          unlinkSync(join(testDir, file));
-        }
-        rmdirSync(testDir);
-      }
-    } catch (e) {
-      // Ignore cleanup errors
-    }
-  });
-
-  describe('DEFAULT_WATCHER_OPTIONS', () => {
-    test('should have correct default values', () => {
-      expect(DEFAULT_WATCHER_OPTIONS.debounceMs).toBe(500);
-      expect(DEFAULT_WATCHER_OPTIONS.persistent).toBe(true);
-      expect(DEFAULT_WATCHER_OPTIONS.encoding).toBe('utf8');
-      expect(DEFAULT_WATCHER_OPTIONS.usePolling).toBe(false);
-      expect(DEFAULT_WATCHER_OPTIONS.pollInterval).toBe(1000);
-      expect(DEFAULT_WATCHER_OPTIONS.ignoreInitial).toBe(true);
-    });
-  });
-
-  describe('ConfigWatcher constructor', () => {
-    test('should create instance with default options', () => {
-      const watcher = new ConfigWatcher();
-      expect(watcher.options).toEqual(DEFAULT_WATCHER_OPTIONS);
-      expect(watcher.watchers.size).toBe(0);
-      expect(watcher.pollWatchers.size).toBe(0);
-      expect(watcher.watchedFiles.size).toBe(0);
-      expect(watcher.isRunning).toBe(false);
-    });
-
-    test('should merge custom options with defaults', () => {
-      const customOptions = { debounceMs: 1000, usePolling: true };
-      const watcher = new ConfigWatcher(customOptions);
-      expect(watcher.options.debounceMs).toBe(1000);
-      expect(watcher.options.usePolling).toBe(true);
-      expect(watcher.options.pollInterval).toBe(DEFAULT_WATCHER_OPTIONS.pollInterval); // default preserved
-    });
-  });
-
-  describe('watchFile', () => {
-    test('should return false for invalid file path', () => {
-      const watcher = new ConfigWatcher();
-      expect(watcher.watchFile(null)).toBe(false);
-      expect(watcher.watchFile('')).toBe(false);
-      expect(watcher.watchFile(123)).toBe(false);
-    });
-
-    test('should return false for non-existent file', () => {
-      const watcher = new ConfigWatcher();
-      expect(watcher.watchFile('/nonexistent/file.json')).toBe(false);
-    });
-
-    test('should return true for already watched file', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher();
-      expect(watcher.watchFile(testFile)).toBe(true);
-      expect(watcher.watchFile(testFile)).toBe(true); // second call
-
-      watcher.unwatchAll();
-    });
-
-    test('should start watching file and set isRunning to true', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher();
-      const result = watcher.watchFile(testFile);
-
-      expect(result).toBe(true);
-      expect(watcher.isRunning).toBe(true);
-      expect(watcher.isWatching(testFile)).toBe(true);
-      expect(watcher.getWatchedFiles()).toContain(testFile);
-
-      watcher.unwatchAll();
-    });
-
-    test('should support polling mode', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher({ usePolling: true });
-      const result = watcher.watchFile(testFile);
-
-      expect(result).toBe(true);
-      expect(watcher.pollWatchers.size).toBe(1);
-
-      watcher.unwatchAll();
-    });
-
-    test('should allow per-file option override', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher({ debounceMs: 100 });
-      const result = watcher.watchFile(testFile, { debounceMs: 200 });
-
-      expect(result).toBe(true);
-
-      watcher.unwatchAll();
-    });
-  });
-
-  describe('unwatchFile', () => {
-    test('should do nothing for non-watched file', () => {
-      const watcher = new ConfigWatcher();
-      watcher.unwatchFile('/nonexistent');
-      expect(watcher.watchedFiles.size).toBe(0);
-    });
-
-    test('should stop watching file', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher();
-      watcher.watchFile(testFile);
-      expect(watcher.isWatching(testFile)).toBe(true);
-
-      watcher.unwatchFile(testFile);
-      expect(watcher.isWatching(testFile)).toBe(false);
-      expect(watcher.getWatchedFiles()).not.toContain(testFile);
-    });
-
-    test('should set isRunning to false when all watchers closed', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher();
-      watcher.watchFile(testFile);
-      expect(watcher.isRunning).toBe(true);
-
-      watcher.unwatchFile(testFile);
-      expect(watcher.isRunning).toBe(false);
-    });
-  });
-
-  describe('watchFiles', () => {
-    test('should watch multiple files', () => {
-      const file1 = join(testDir, 'file1.json');
-      const file2 = join(testDir, 'file2.json');
-      writeFileSync(file1, '{}');
-      writeFileSync(file2, '{}');
-
-      const watcher = new ConfigWatcher();
-      const result = watcher.watchFiles([file1, file2]);
-
-      expect(result.successful).toHaveLength(2);
-      expect(result.failed).toHaveLength(0);
-
-      watcher.unwatchAll();
-    });
-
-    test('should track failed files', () => {
-      const file1 = join(testDir, 'exists.json');
-      const file2 = join(testDir, 'missing.json');
-      writeFileSync(file1, '{}');
-
-      const watcher = new ConfigWatcher();
-      const result = watcher.watchFiles([file1, file2]);
-
-      expect(result.successful).toContain(file1);
-      expect(result.failed).toContain(file2);
-
-      watcher.unwatchAll();
-    });
-  });
-
-  describe('unwatchAll', () => {
-    test('should unwatch all files', () => {
-      const file1 = join(testDir, 'file1.json');
-      const file2 = join(testDir, 'file2.json');
-      writeFileSync(file1, '{}');
-      writeFileSync(file2, '{}');
-
-      const watcher = new ConfigWatcher();
-      watcher.watchFile(file1);
-      watcher.watchFile(file2);
-
-      expect(watcher.getWatchedFiles()).toHaveLength(2);
-
-      watcher.unwatchAll();
-
-      expect(watcher.getWatchedFiles()).toHaveLength(0);
-      expect(watcher.isRunning).toBe(false);
-    });
-  });
-
-  describe('getWatchedFiles', () => {
-    test('should return empty array when nothing watched', () => {
-      const watcher = new ConfigWatcher();
-      expect(watcher.getWatchedFiles()).toEqual([]);
-    });
-
-    test('should return array of watched file paths', () => {
-      const file1 = join(testDir, 'file1.json');
-      const file2 = join(testDir, 'file2.json');
-      writeFileSync(file1, '{}');
-      writeFileSync(file2, '{}');
-
-      const watcher = new ConfigWatcher();
-      watcher.watchFile(file1);
-      watcher.watchFile(file2);
-
-      const files = watcher.getWatchedFiles();
-      expect(files).toHaveLength(2);
-      expect(files).toContain(file1);
-      expect(files).toContain(file2);
-
-      watcher.unwatchAll();
-    });
-  });
-
-  describe('isWatching', () => {
-    test('should return false for non-watched file', () => {
-      const watcher = new ConfigWatcher();
-      expect(watcher.isWatching('/nonexistent')).toBe(false);
-    });
-
-    test('should return true for watched file', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher();
-      watcher.watchFile(testFile);
-
-      expect(watcher.isWatching(testFile)).toBe(true);
-
-      watcher.unwatchAll();
-    });
-  });
-
-  describe('getStats', () => {
-    test('should return zero stats when not running', () => {
-      const watcher = new ConfigWatcher();
-      const stats = watcher.getStats();
-
-      expect(stats.isRunning).toBe(false);
-      expect(stats.watchedFiles).toBe(0);
-      expect(stats.nativeWatchers).toBe(0);
-      expect(stats.pollWatchers).toBe(0);
-      expect(stats.pendingDebounces).toBe(0);
-    });
-
-    test('should return correct stats when watching', () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher();
-      watcher.watchFile(testFile);
-
-      const stats = watcher.getStats();
-
-      expect(stats.isRunning).toBe(true);
-      expect(stats.watchedFiles).toBe(1);
-      expect(stats.nativeWatchers).toBe(1);
-      expect(stats.pollWatchers).toBe(0);
-
-      watcher.unwatchAll();
-    });
-  });
-
-  describe('reload events', () => {
-    test('should emit reload event on file change', async () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{"initial": true}');
-
-      const watcher = new ConfigWatcher({ debounceMs: 100 });
-      watcher.watchFile(testFile);
-
-      const reloadPromise = new Promise((resolve) => {
-        watcher.on('reload', ({ filePath, timestamp }) => {
-          resolve({ filePath, timestamp });
-        });
-      });
-
-      // Modify the file
-      await new Promise(resolve => setTimeout(resolve, 50));
-      writeFileSync(testFile, '{"changed": true}');
-
-      // Wait for debounce
-      const result = await reloadPromise;
-
-      expect(result.filePath).toBe(testFile);
-      expect(result.timestamp).toBeDefined();
-
-      watcher.unwatchAll();
-    }, 5000);
-
-    test('should debounce multiple rapid changes', async () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      let reloadCount = 0;
-      const watcher = new ConfigWatcher({ debounceMs: 200 });
-      watcher.watchFile(testFile);
-
-      watcher.on('reload', () => {
-        reloadCount++;
-      });
-
-      // Make multiple rapid changes
-      for (let i = 0; i < 5; i++) {
-        await new Promise(resolve => setTimeout(resolve, 50));
-        writeFileSync(testFile, `{ "change": ${i} }`);
-      }
-
-      // Wait for debounce to settle
-      await new Promise(resolve => setTimeout(resolve, 400));
-
-      // Should only get one reload event due to debouncing
-      expect(reloadCount).toBe(1);
-
-      watcher.unwatchAll();
-    }, 5000);
-
-    test('should emit error event on watcher error', async () => {
-      const watcher = new ConfigWatcher();
-
-      const errorPromise = new Promise((resolve) => {
-        watcher.on('error', ({ filePath, error }) => {
-          resolve({ filePath, errorMessage: error.message });
-        });
-      });
-
-      // Try to watch a non-existent file (this might trigger an error)
-      watcher.watchFile('/invalid/path/that/does/not/exist');
-
-      // The watcher might just return false rather than emit error
-      // So let's just verify basic functionality works
-      expect(watcher.getWatchedFiles()).toEqual([]);
-    });
-  });
-
-  describe('createConfigWatcher', () => {
-    test('should create ConfigWatcher instance', () => {
-      const watcher = createConfigWatcher();
-      expect(watcher).toBeInstanceOf(ConfigWatcher);
-    });
-
-    test('should pass options to ConfigWatcher', () => {
-      const watcher = createConfigWatcher({ debounceMs: 1000 });
-      expect(watcher.options.debounceMs).toBe(1000);
-    });
-  });
-
-  describe('getConfigWatcher', () => {
-    test('should return singleton instance', () => {
-      const watcher1 = getConfigWatcher();
-      const watcher2 = getConfigWatcher();
-
-      expect(watcher1).toBe(watcher2);
-    });
-
-    test('should create instance with options if none exists', () => {
-      // Note: This test might interact with other tests using getConfigWatcher
-      // In a clean environment, this would work properly
-      const watcher = getConfigWatcher({ debounceMs: 500 });
-      expect(watcher).toBeInstanceOf(ConfigWatcher);
-    });
-  });
-
-  describe('watchSettingsFile', () => {
-    test('should return null for non-existent settings file', () => {
-      const result = watchSettingsFile('/nonexistent/settings.json', () => {});
-      expect(result).toBeNull();
-    });
-
-    test('should watch settings file and call callback on change', async () => {
-      const settingsFile = join(testDir, 'settings.json');
-      writeFileSync(settingsFile, JSON.stringify({ theme: 'dark' }));
-
-      let receivedSettings = null;
-      const watcher = watchSettingsFile(settingsFile, (settings) => {
-        receivedSettings = settings;
-      }, { debounceMs: 100 });
-
-      expect(watcher).not.toBeNull();
-      expect(watcher.isWatching(settingsFile)).toBe(true);
-
-      // Wait for initial setup
-      await new Promise(resolve => setTimeout(resolve, 50));
-
-      // Change the file
-      writeFileSync(settingsFile, JSON.stringify({ theme: 'light' }));
-
-      // Wait for reload
-      await new Promise(resolve => setTimeout(resolve, 300));
-
-      expect(receivedSettings).toEqual({ theme: 'light' });
-
-      watcher.unwatchAll();
-    }, 5000);
-  });
-
-  describe('watchPluginsDirectory', () => {
-    test('should return null for non-existent plugins directory', () => {
-      const result = watchPluginsDirectory('/nonexistent/plugins', () => {});
-      expect(result).toBeNull();
-    });
-
-    test('should watch plugin.json files in directory', async () => {
-      const pluginsDir = join(testDir, 'plugins');
-      mkdirSync(pluginsDir);
-
-      // Create a test plugin
-      const pluginDir = join(pluginsDir, 'test-plugin');
-      mkdirSync(pluginDir);
-      writeFileSync(join(pluginDir, 'plugin.json'), JSON.stringify({
-        name: 'Test Plugin',
-        version: '1.0.0',
-      }));
-
-      let receivedPluginId = null;
-      let receivedManifest = null;
-
-      const watcher = watchPluginsDirectory(pluginsDir, (pluginId, manifest) => {
-        receivedPluginId = pluginId;
-        receivedManifest = manifest;
-      }, { debounceMs: 100 });
-
-      expect(watcher).not.toBeNull();
-
-      // Wait for watcher to scan directory
-      await new Promise(resolve => setTimeout(resolve, 100));
-
-      // Modify the plugin.json
-      writeFileSync(join(pluginDir, 'plugin.json'), JSON.stringify({
-        name: 'Test Plugin',
-        version: '1.0.1',
-      }));
-
-      // Wait for reload
-      await new Promise(resolve => setTimeout(resolve, 300));
-
-      expect(receivedPluginId).toBe('test-plugin');
-      expect(receivedManifest.name).toBe('Test Plugin');
-
-      watcher.unwatchAll();
-    }, 5000);
-
-    test('should handle directory with no plugins', () => {
-      const emptyDir = join(testDir, 'empty-plugins');
-      mkdirSync(emptyDir);
-
-      const watcher = watchPluginsDirectory(emptyDir, () => {});
-
-      expect(watcher).not.toBeNull();
-      // Should return watcher but watch 0 files
-      expect(watcher.getWatchedFiles()).toHaveLength(0);
-    });
-
-    test('should ignore non-directory entries', () => {
-      const pluginsDir = join(testDir, 'plugins2');
-      mkdirSync(pluginsDir);
-
-      // Create some files (not directories)
-      writeFileSync(join(pluginsDir, 'readme.txt'), 'Readme');
-      writeFileSync(join(pluginsDir, 'config.json'), '{}');
-
-      const watcher = watchPluginsDirectory(pluginsDir, () => {});
-
-      expect(watcher).not.toBeNull();
-      expect(watcher.getWatchedFiles()).toHaveLength(0);
-    });
-  });
-
-  describe('EventEmitter integration', () => {
-    test('should support on/emit pattern', () => {
-      const watcher = new ConfigWatcher();
-
-      const calls = [];
-      const handler = (...args) => {
-        calls.push(args);
-      };
-      watcher.on('testEvent', handler);
-
-      watcher.emit('testEvent', { data: 'test' });
-
-      expect(calls).toHaveLength(1);
-      expect(calls[0]).toEqual([{ data: 'test' }]);
-    });
-
-    test('should support removing listeners', () => {
-      const watcher = new ConfigWatcher();
-
-      const calls = [];
-      const handler = (...args) => {
-        calls.push(args);
-      };
-      watcher.on('testEvent', handler);
-      watcher.removeListener('testEvent', handler);
-
-      watcher.emit('testEvent');
-
-      expect(calls).toHaveLength(0);
-    });
-  });
-
-  describe('edge cases', () => {
-    test('should handle very short debounce', async () => {
-      const testFile = join(testDir, 'test.json');
-      writeFileSync(testFile, '{}');
-
-      let eventCount = 0;
-      const watcher = new ConfigWatcher({ debounceMs: 10 });
-      watcher.watchFile(testFile);
-
-      watcher.on('reload', () => {
-        eventCount++;
-      });
-
-      writeFileSync(testFile, '{ "a": 1 }');
-      await new Promise(resolve => setTimeout(resolve, 50));
-      writeFileSync(testFile, '{ "b": 2 }');
-      await new Promise(resolve => setTimeout(resolve, 50));
-
-      // Wait for all debounces
-      await new Promise(resolve => setTimeout(resolve, 100));
-
-      expect(eventCount).toBeGreaterThan(0);
-
-      watcher.unwatchAll();
-    }, 5000);
-
-    test('should handle special characters in file paths', () => {
-      const testFile = join(testDir, 'test file with spaces.json');
-      writeFileSync(testFile, '{}');
-
-      const watcher = new ConfigWatcher();
-      const result = watcher.watchFile(testFile);
-
-      expect(result).toBe(true);
-      expect(watcher.isWatching(testFile)).toBe(true);
-
-      watcher.unwatchAll();
-    });
-  });
-});