feat: support rspack native fs watcher (#10658)

* feat: support rspack native fs watcher

* Refactor watcher module: Enhance event handling and introduce Executor

- Updated `Cargo.toml` to include the "time" feature for Tokio.
- Refactored `WatcherDirectoriesAnalyzer` to use `WatchTarget` instead of `WatchInfo`.
- Introduced `Executor` struct to manage file system event handling and aggregation.
- Removed the old `WatcherExecutor` implementation and replaced it with the new `Executor`.
- Improved `DiskWatcher` to manage watched paths more effectively.
- Enhanced `Trigger` to facilitate dependency resolution for file system events.
- Updated the `FsWatcher` struct to integrate the new `Executor` and streamline event processing.
- Added detailed documentation for new and modified structs and methods.

* Refactor watcher module Introduce PathManager and PathAccessor

- Removed the PathRegister and its associated logic, replacing it with PathManager to manage paths, directories, and missing paths.
- Introduced PathAccessor for accessing registered paths.
- Updated Analyzer trait to work with the new PathAccessor.
- Modified DiskWatcher to handle WatchPattern instead of raw paths.
- Enhanced Executor to manage event execution with aggregate handling.
- Updated NativeWatchFileSystem to include pause functionality and improved callback handling.
- Added tests for PathManager and related structures to ensure correct functionality.

* feat: implement Scanner for path existence checks and event triggering

* Refactor path handling to use ArcPath for improved memory efficiency

* fix: pass testing

* Refactor NativeWatcher and executor for improved pause functionality and add native watcher support in test tools

* refactor: clean up code formatting and improve readability across multiple files

* Smplify NativeWatcher implementation and update RecommendedAnalyzer result

* Add NativeWatcher module for file system watching capabilities

* Update API report files for consistency

* format js

* update Zod shema and split test into nativeWatcher.test.js

* fix typo

* Adjest ts import order

* fix typo

* Adjust using FxHashMap instead of std hashmap

* Update path_manager comments

* fix: add external dependencies to skip list in deny.toml

* Add nativeWatcher experiment option for improved file change monitoring

* feat: add safety documentation for NativeWatcher watch method and improve import order in watch.ts

* fix: update concurrent mode for native watcher and remove platform check

* Remove unused import

* fix: update path manager references and enhance DiskWatcher initialization

* fix: improve documentation for nativeWatcher performance issues

* fix: enhance safety documentation for NativeWatcher methods and update method signatures to async

* fix: update NativeWatcher safety documentation and adjust internal dependency accessors

* fix: correct variable name from 'close' to 'closed' and update default symlink behavior in NativeWatcher

* fix: update NativeWatcher ignored option to synchronous and enhance glob pattern handling

* fix: remove trailing newline at the end of experiments documentation

* fix: update native watcher to disable concurrent mode

* fix: add conditional check for WASM platform in nativeWatcher tests

* fix: refactor nativeWatcher tests to always run without WASM condition

* fix: remove WASM condition for NativeWatcher test in jest config

* fix: temporarily skip NativeWatcher tests due to instability in CI

* fix: temporarily skip NativeWatcher tests due to instability in CI

* fix: correct file extension for NativeWatcher test exclusion in Jest config

* fix: update nativeWatcher ApiMeta version to 1.4.4

* Set default-features=false to notify dependency for reduce binary size

* feat: update NativeWatcher API to use NativeWatchResult and improve event handling

* fix: allow clippy warning for too many arguments in NativeWatcher::watch method

* fix: remove unused parameter from watch method in MultiCompiler test

* fix: skip test due to parse error in MultiCompiler

* feat: implement watcher instance with close, pause, and getInfo methods in MultiCompiler

* chore: update nativeWatcher version to 1.4.6 in documentation

* Update core.api.md

* refactor: simplify Analyzer trait and improve Watcher analyzers for incremental path management

* docs: update experiments documentation for `nativeWatcher` and add details for `inlineConst` feature

* chore: update glob-to-regexp dependency in package.json and prebundle.config.mjs

* refactor: update WatcherIncrementalDependencies to use Iterable types with added and removed properties

* fix: correct file reference in MultiCompiler test for first run condition

* fix: update missingDependencies to reference addedMissingDependencies instead of removedMissingDependencies

Author: GiveMe-A-Name

Cargo.lock

@@ -63,6 +63,7 @@ micromegas-perfetto = { version = "0.9.0", default-features = false }
 miette              = { version = "7.5.0", default-features = false }
 mimalloc            = { version = "0.2.4", package = "mimalloc-rspack", default-features = false }
 mime_guess          = { version = "2.0.5", default-features = false, features = ["rev-mappings"] }
+notify              = { version = "8.1.0", default-features = false }
 num-bigint          = { version = "0.4.6", default-features = false }
 once_cell           = { version = "1.20.2", default-features = false }
 oneshot             = { version = "0.1.8", default-features = false, features = ["std", "async"] }

Cargo.toml

@@ -441,6 +441,25 @@ export declare class ModuleGraphConnection {
   get originModule(): Module | null
 }
 
+export declare class NativeWatcher {
+  constructor(options: NativeWatcherOptions)
+  watch(files: [Array<string>, Array<string>], directories: [Array<string>, Array<string>], missing: [Array<string>, Array<string>], callback: (err: Error | null, result: NativeWatchResult) => void, callbackUndelayed: (path: string) => void): void
+  /**
+   * # Safety
+   *
+   * This function is unsafe because it uses `&mut self` to call the watcher asynchronously.
+   * It's important to ensure that the watcher is not used in any other places before this function is finished.
+   * You must ensure that the watcher not call watch, close or pause in the same time, otherwise it may lead to undefined behavior.
+   */
+  close(): Promise<void>
+  pause(): void
+}
+
+export declare class NativeWatchResult {
+  changedFiles: Array<string>
+  removedFiles: Array<string>
+}
+
 
 export declare class RawExternalItemFnCtx {
   data(): RawExternalItemFnCtxData
@@ -1487,6 +1506,14 @@ export declare function minify(source: string, options: string): Promise<Transfo
 
 export declare function minifySync(source: string, options: string): TransformOutput
 
+export interface NativeWatcherOptions {
+  followSymlinks?: boolean
+  pollInterval?: number
+  aggregateTimeout?: number
+  /** A function that will be called with the path of a file or directory that is ignored. */
+  ignored?: (path: string) => boolean
+}
+
 export interface NodeFsStats {
   isFile: boolean
   isDirectory: boolean

crates/node_binding/binding.d.ts

@@ -56,6 +56,7 @@ mod module;
 mod module_graph;
 mod module_graph_connection;
 mod modules;
+mod native_watcher;
 mod normal_module_factory;
 mod options;
 mod panic;
@@ -99,6 +100,7 @@ pub use module::*;
 pub use module_graph::*;
 pub use module_graph_connection::*;
 pub use modules::*;
+pub use native_watcher::*;
 pub use normal_module_factory::*;
 pub use options::*;
 pub use path_data::*;