lib/internal/vfs/watcher.js - main - githubmirror/node

lib/internal/vfs/watcher.js
689 строк17 KB
Antoine du Hamel
lib: add lint rule to enforce use of `kEmptyObject`
10 июн 2026, 13:56
10 июн 2026, 13:561778eeb
'use strict';

const {
  ArrayPrototypePush,
  ObjectAssign,
  Promise,
  PromiseResolve,
  SafeMap,
  SafeSet,
  SymbolAsyncIterator,
} = primordials;

const { AbortError } = require('internal/errors');
const { Buffer } = require('buffer');
const { EventEmitter } = require('events');
const { basename, join } = require('path');
const {
  setInterval,
  clearInterval,
} = require('timers');
const { kEmptyObject } = require('internal/util');

/**
 * VFSWatcher - Polling-based file/directory watcher for VFS.
 * Emits 'change' events when the file content or stats change.
 * Compatible with fs.watch() return value interface.
 */
class VFSWatcher extends EventEmitter {
  #vfs;
  #path;
  #interval;
  #timer = null;
  #lastStats;
  #closed = false;
  #persistent;
  #recursive;
  #encoding;
  #trackedFiles;
  #signal;
  #abortHandler = null;

  /**
   * @param {VirtualProvider} provider The VFS provider
   * @param {string} path The path to watch (provider-relative)
   * @param {object} [options] Options
   * @param {number} [options.interval] Polling interval in ms (default: 100)
   * @param {boolean} [options.persistent] Keep process alive (default: true)
   * @param {boolean} [options.recursive] Watch subdirectories (default: false)
   * @param {AbortSignal} [options.signal] AbortSignal for cancellation
   */
  constructor(provider, path, options = kEmptyObject) {
    super();

    this.#vfs = provider;
    this.#path = path;
    this.#interval = options.interval ?? 100;
    this.#persistent = options.persistent !== false;
    this.#recursive = options.recursive === true;
    this.#encoding = options.encoding;
    this.#trackedFiles = new SafeMap(); // path -> { stats, relativePath }
    this.#signal = options.signal;

    // Handle AbortSignal
    if (this.#signal) {
      if (this.#signal.aborted) {
        this.close();
        return;
      }
      this.#abortHandler = () => this.close();
      this.#signal.addEventListener('abort', this.#abortHandler, { once: true });
    }

    // Get initial stats
    this.#lastStats = this.#getStats();

    // If watching a directory, build file list
    if (this.#lastStats?.isDirectory()) {
      if (this.#recursive) {
        this.#buildFileList(this.#path, '');
      } else {
        this.#buildChildList(this.#path);
      }
    }

    // Start polling
    this.#startPolling();
  }

  /**
   * Encodes a filename according to the watcher's encoding option.
   * @param {string} filename The filename to encode
   * @returns {string|Buffer} The encoded filename
   */
  #encodeFilename(filename) {
    if (this.#encoding === 'buffer') {
      return Buffer.from(filename);
    }
    return filename;
  }

  /**
   * Gets stats for the watched path.
   * @returns {Stats|null} The stats or null if file doesn't exist
   */
  #getStats() {
    try {
      return this.#vfs.statSync(this.#path);
    } catch {
      return null;
    }
  }

  /**
   * Starts the polling timer.
   */
  #startPolling() {
    if (this.#closed) return;

    this.#timer = setInterval(() => this.#poll(), this.#interval);

    // If not persistent, unref the timer to allow process to exit
    if (!this.#persistent && this.#timer.unref) {
      this.#timer.unref();
    }
  }

  /**
   * Polls for changes.
   */
  #poll() {
    if (this.#closed) return;

    // For directory watching, poll tracked children
    if (this.#lastStats?.isDirectory()) {
      this.#pollDirectory();
      return;
    }

    // For single file watching
    const newStats = this.#getStats();

    if (this.#statsChanged(this.#lastStats, newStats)) {
      const eventType = this.#determineEventType(this.#lastStats, newStats);
      const filename = this.#encodeFilename(basename(this.#path));
      this.emit('change', eventType, filename);
    }

    this.#lastStats = newStats;
  }

  /**
   * Polls directory children for changes, detecting new and deleted files.
   */
  #pollDirectory() {
    // Rescan for new files
    if (this.#recursive) {
      this.#rescanRecursive(this.#path, '');
    } else {
      this.#rescanChildren(this.#path);
    }

    // Check tracked files for changes/deletions
    for (const { 0: filePath, 1: info } of this.#trackedFiles) {
      const newStats = this.#getStatsFor(filePath);
      if (newStats === null && info.stats !== null) {
        // File was deleted
        this.emit('change', 'rename', this.#encodeFilename(info.relativePath));
        this.#trackedFiles.delete(filePath);
      } else if (this.#statsChanged(info.stats, newStats)) {
        const eventType = this.#determineEventType(info.stats, newStats);
        this.emit('change', eventType, this.#encodeFilename(info.relativePath));
        info.stats = newStats;
      }
    }
  }

  /**
   * Rescans direct children for new entries.
   * @param {string} dirPath The directory path
   */
  #rescanChildren(dirPath) {
    try {
      const entries = this.#vfs.readdirSync(dirPath);
      for (const name of entries) {
        const fullPath = join(dirPath, name);
        if (!this.#trackedFiles.has(fullPath)) {
          const stats = this.#getStatsFor(fullPath);
          this.#trackedFiles.set(fullPath, {
            stats,
            relativePath: name,
          });
          this.emit('change', 'rename', this.#encodeFilename(name));
        }
      }
    } catch {
      // Directory might not exist or be readable
    }
  }

  /**
   * Recursively rescans for new entries.
   * @param {string} dirPath The directory path
   * @param {string} relativePath The relative path from watched root
   */
  #rescanRecursive(dirPath, relativePath) {
    try {
      const entries = this.#vfs.readdirSync(dirPath, { withFileTypes: true });
      for (const entry of entries) {
        const fullPath = join(dirPath, entry.name);
        const relPath = relativePath ?
          join(relativePath, entry.name) : entry.name;

        if (entry.isDirectory()) {
          this.#rescanRecursive(fullPath, relPath);
        } else if (!this.#trackedFiles.has(fullPath)) {
          const stats = this.#getStatsFor(fullPath);
          this.#trackedFiles.set(fullPath, {
            stats,
            relativePath: relPath,
          });
          this.emit('change', 'rename', this.#encodeFilename(relPath));
        }
      }
    } catch {
      // Directory might not exist or be readable
    }
  }

  /**
   * Gets stats for a specific path.
   * @param {string} filePath The file path
   * @returns {Stats|null}
   */
  #getStatsFor(filePath) {
    try {
      return this.#vfs.statSync(filePath);
    } catch {
      return null;
    }
  }

  /**
   * Builds the list of files to track for recursive watching.
   * @param {string} dirPath The directory path
   * @param {string} relativePath The relative path from the watched root
   */
  #buildFileList(dirPath, relativePath) {
    try {
      const entries = this.#vfs.readdirSync(dirPath, { withFileTypes: true });
      for (const entry of entries) {
        const fullPath = join(dirPath, entry.name);
        const relPath = relativePath ? join(relativePath, entry.name) : entry.name;

        if (entry.isDirectory()) {
          // Recurse into subdirectory
          this.#buildFileList(fullPath, relPath);
        } else {
          // Track the file
          const stats = this.#getStatsFor(fullPath);
          this.#trackedFiles.set(fullPath, {
            stats,
            relativePath: relPath,
          });
        }
      }
    } catch {
      // Directory might not exist or be readable
    }
  }

  /**
   * Builds a list of direct children to track for non-recursive watching.
   * @param {string} dirPath The directory path
   */
  #buildChildList(dirPath) {
    try {
      const entries = this.#vfs.readdirSync(dirPath);
      for (const name of entries) {
        const fullPath = join(dirPath, name);
        const stats = this.#getStatsFor(fullPath);
        this.#trackedFiles.set(fullPath, {
          stats,
          relativePath: name,
        });
      }
    } catch {
      // Directory might not exist or be readable
    }
  }

  /**
   * Checks if stats have changed.
   * @param {Stats|null} oldStats Previous stats
   * @param {Stats|null} newStats Current stats
   * @returns {boolean} True if stats changed
   */
  #statsChanged(oldStats, newStats) {
    // File created or deleted
    if ((oldStats === null) !== (newStats === null)) {
      return true;
    }

    // Both null - no change
    if (oldStats === null && newStats === null) {
      return false;
    }

    // Compare mtime and size
    if (oldStats.mtimeMs !== newStats.mtimeMs) {
      return true;
    }
    if (oldStats.size !== newStats.size) {
      return true;
    }

    return false;
  }

  /**
   * Determines the event type based on stats change.
   * @param {Stats|null} oldStats Previous stats
   * @param {Stats|null} newStats Current stats
   * @returns {string} 'rename' or 'change'
   */
  #determineEventType(oldStats, newStats) {
    // File was created or deleted
    if ((oldStats === null) !== (newStats === null)) {
      return 'rename';
    }
    // Content changed
    return 'change';
  }

  /**
   * Closes the watcher and stops polling.
   */
  close() {
    if (this.#closed) return;
    this.#closed = true;

    if (this.#timer) {
      clearInterval(this.#timer);
      this.#timer = null;
    }

    // Clear tracked files
    this.#trackedFiles.clear();

    // Remove abort handler
    if (this.#signal && this.#abortHandler) {
      this.#signal.removeEventListener('abort', this.#abortHandler);
    }

    this.emit('close');
  }

  /**
   * Alias for close() - compatibility with FSWatcher.
   * @returns {this}
   */
  unref() {
    this.#timer?.unref?.();
    return this;
  }

  /**
   * Makes the timer keep the process alive - compatibility with FSWatcher.
   * @returns {this}
   */
  ref() {
    this.#timer?.ref?.();
    return this;
  }
}

/**
 * VFSStatWatcher - Polling-based stat watcher for VFS.
 * Emits 'change' events with current and previous stats.
 * Compatible with fs.watchFile() return value interface.
 */
class VFSStatWatcher extends EventEmitter {
  #vfs;
  #path;
  #interval;
  #persistent;
  #bigint;
  #closed = false;
  #timer = null;
  #lastStats;
  #listeners;

  /**
   * @param {VirtualProvider} provider The VFS provider
   * @param {string} path The path to watch (provider-relative)
   * @param {object} [options] Options
   * @param {number} [options.interval] Polling interval in ms (default: 5007)
   * @param {boolean} [options.persistent] Keep process alive (default: true)
   */
  constructor(provider, path, options = kEmptyObject) {
    super();

    this.#vfs = provider;
    this.#path = path;
    this.#interval = options.interval ?? 5007;
    this.#persistent = options.persistent !== false;
    this.#bigint = options.bigint === true;
    this.#listeners = new SafeSet();

    // Get initial stats
    this.#lastStats = this.#getStats();

    // Start polling
    this.#startPolling();
  }

  /**
   * Gets stats for the watched path.
   * @returns {Stats} The stats (with zeroed values if file doesn't exist)
   */
  #getStats() {
    try {
      return this.#vfs.statSync(this.#path, { bigint: this.#bigint });
    } catch {
      // Return a zeroed stats object for non-existent files
      // This matches Node.js behavior
      return this.#createZeroStats();
    }
  }

  /**
   * Creates a zeroed stats object for non-existent files.
   * @returns {object} Zeroed stats
   */
  #createZeroStats() {
    const { createZeroStats } = require('internal/vfs/stats');
    return createZeroStats({ bigint: this.#bigint });
  }

  /**
   * Starts the polling timer.
   */
  #startPolling() {
    if (this.#closed) return;

    this.#timer = setInterval(() => this.#poll(), this.#interval);

    // If not persistent, unref the timer to allow process to exit
    if (!this.#persistent && this.#timer.unref) {
      this.#timer.unref();
    }
  }

  /**
   * Polls for changes.
   */
  #poll() {
    if (this.#closed) return;

    const newStats = this.#getStats();

    if (this.#statsChanged(this.#lastStats, newStats)) {
      const prevStats = this.#lastStats;
      this.#lastStats = newStats;
      this.emit('change', newStats, prevStats);
    }
  }

  /**
   * Checks if stats have changed.
   * @param {Stats} oldStats Previous stats
   * @param {Stats} newStats Current stats
   * @returns {boolean} True if stats changed
   */
  #statsChanged(oldStats, newStats) {
    // Compare mtime and ctime
    if (oldStats.mtimeMs !== newStats.mtimeMs) {
      return true;
    }
    if (oldStats.ctimeMs !== newStats.ctimeMs) {
      return true;
    }
    if (oldStats.size !== newStats.size) {
      return true;
    }
    return false;
  }

  /**
   * Adds a listener for the given event.
   * Tracks 'change' listeners for internal bookkeeping.
   * @param {string} event The event name
   * @param {Function} listener The listener function
   * @returns {this}
   */
  addListener(event, listener) {
    if (event === 'change') {
      this.#listeners.add(listener);
    }
    super.addListener(event, listener);
    return this;
  }

  /**
   * Removes a listener for the given event.
   * @param {string} event The event name
   * @param {Function} listener The listener function
   * @returns {this}
   */
  removeListener(event, listener) {
    if (event === 'change') {
      this.#listeners.delete(listener);
    }
    super.removeListener(event, listener);
    return this;
  }

  /**
   * Removes all listeners for an event.
   * Overrides EventEmitter to also clear internal #listeners tracking.
   * @param {string} eventName The event name
   * @returns {this}
   */
  removeAllListeners(eventName) {
    if (eventName === 'change') {
      this.#listeners.clear();
    }
    super.removeAllListeners(eventName);
    return this;
  }

  /**
   * Returns true if there are no listeners.
   * @returns {boolean}
   */
  hasNoListeners() {
    return this.#listeners.size === 0;
  }

  /**
   * Stops the watcher.
   */
  stop() {
    if (this.#closed) return;
    this.#closed = true;

    if (this.#timer) {
      clearInterval(this.#timer);
      this.#timer = null;
    }

    this.emit('stop');
  }

  /**
   * Makes the timer not keep the process alive.
   * @returns {this}
   */
  unref() {
    this.#timer?.unref?.();
    return this;
  }

  /**
   * Makes the timer keep the process alive.
   * @returns {this}
   */
  ref() {
    this.#timer?.ref?.();
    return this;
  }
}

/**
 * VFSWatchAsyncIterable - Async iterable wrapper for VFSWatcher.
 * Compatible with fs.promises.watch() return value interface.
 */
const kMaxPendingEvents = 1024;

class VFSWatchAsyncIterable {
  #watcher;
  #closed = false;
  #pendingEvents = [];
  #pendingResolvers = [];

  /**
   * @param {VirtualProvider} provider The VFS provider
   * @param {string} path The path to watch (provider-relative)
   * @param {object} [options] Options
   */
  constructor(provider, path, options = kEmptyObject) {
    // Strip signal from options passed to VFSWatcher - we handle abort
    // at the iterable level to reject pending next() with AbortError
    // instead of resolving with done:true via the 'close' event.
    const signal = options.signal;
    const watcherOptions = ObjectAssign({ __proto__: null }, options);
    delete watcherOptions.signal;
    this.#watcher = new VFSWatcher(provider, path, watcherOptions);

    this.#watcher.on('change', (eventType, filename) => {
      const event = { eventType, filename };
      if (this.#pendingResolvers.length > 0) {
        const { resolve } = this.#pendingResolvers.shift();
        resolve({ done: false, value: event });
      } else if (this.#pendingEvents.length < kMaxPendingEvents) {
        ArrayPrototypePush(this.#pendingEvents, event);
      }
      // Drop events when queue is full to prevent unbounded memory growth
    });

    this.#watcher.on('close', () => {
      this.#closed = true;
      // Resolve any pending iterators
      while (this.#pendingResolvers.length > 0) {
        const { resolve } = this.#pendingResolvers.shift();
        resolve({ done: true, value: undefined });
      }
    });

    // Handle abort signal - reject pending next() with AbortError
    if (signal) {
      const onAbort = () => {
        this.#closed = true;
        const err = new AbortError(undefined, { cause: signal.reason });
        while (this.#pendingResolvers.length > 0) {
          const { reject } = this.#pendingResolvers.shift();
          reject(err);
        }
        this.#watcher.close();
      };
      if (signal.aborted) {
        onAbort();
      } else {
        signal.addEventListener('abort', onAbort, { once: true });
      }
    }
  }

  /**
   * Returns the async iterator.
   * @returns {AsyncIterator}
   */
  [SymbolAsyncIterator]() {
    return this;
  }

  /**
   * Gets the next event.
   * @returns {Promise<IteratorResult>}
   */
  next() {
    if (this.#closed) {
      return PromiseResolve({ done: true, value: undefined });
    }

    if (this.#pendingEvents.length > 0) {
      const event = this.#pendingEvents.shift();
      return PromiseResolve({ done: false, value: event });
    }

    return new Promise((resolve, reject) => {
      ArrayPrototypePush(this.#pendingResolvers, { resolve, reject });
    });
  }

  /**
   * Closes the iterator and underlying watcher.
   * @returns {Promise<IteratorResult>}
   */
  return() {
    this.#watcher.close();
    return PromiseResolve({ done: true, value: undefined });
  }

  /**
   * Handles iterator throw.
   * @param {Error} error The error to throw
   * @returns {Promise<IteratorResult>}
   */
  throw(error) {
    this.#watcher.close();
    return PromiseResolve({ done: true, value: undefined });
  }
}

module.exports = {
  VFSWatcher,
  VFSStatWatcher,
  VFSWatchAsyncIterable,
};