Move files, rename classes: "MacOS" watcher is used on Windows too. (#2274)

Author: davidmorgan

pkgs/watcher/lib/src/directory_watcher.dart

@@ -6,9 +6,8 @@ import 'dart:io';
 
 import '../watcher.dart';
 import 'custom_watcher_factory.dart';
-import 'directory_watcher/linux.dart';
-import 'directory_watcher/macos.dart';
-import 'directory_watcher/windows_resubscribable_watcher.dart';
+import 'directory_watcher/linux/linux_directory_watcher.dart';
+import 'directory_watcher/recursive/recursive_directory_watcher.dart';
 
 /// Watches the contents of a directory and emits [WatchEvent]s when something
 /// in the directory has changed.
@@ -52,9 +51,11 @@ abstract class DirectoryWatcher implements Watcher {
       );
       if (customWatcher != null) return customWatcher;
       if (Platform.isLinux) return LinuxDirectoryWatcher(directory);
-      if (Platform.isMacOS) return MacosDirectoryWatcher(directory);
+      if (Platform.isMacOS) {
+        return RecursiveDirectoryWatcher(directory, runInIsolate: false);
+      }
       if (Platform.isWindows) {
-        return WindowsDirectoryWatcher(directory,
+        return RecursiveDirectoryWatcher(directory,
             runInIsolate: runInIsolateOnWindows);
       }
     }

pkgs/watcher/lib/src/directory_watcher/linux.dart renamed to pkgs/watcher/lib/src/directory_watcher/linux/linux_directory_watcher.dart

@@ -4,10 +4,10 @@
 
 import 'dart:async';
 
-import '../directory_watcher.dart';
-import '../resubscribable.dart';
-import '../watch_event.dart';
-import 'linux/watch_tree_root.dart';
+import '../../directory_watcher.dart';
+import '../../resubscribable.dart';
+import '../../watch_event.dart';
+import 'watch_tree_root.dart';
 
 /// Resubscribable Linux directory watcher that watches using
 /// [_LinuxDirectoryWatcher].

pkgs/watcher/lib/src/directory_watcher/directory_list.dart renamed to pkgs/watcher/lib/src/directory_watcher/polling/directory_list.dart

@@ -5,11 +5,11 @@
 import 'dart:async';
 import 'dart:io';
 
-import '../async_queue.dart';
-import '../directory_watcher.dart';
-import '../polling.dart';
-import '../resubscribable.dart';
-import '../watch_event.dart';
+import '../../async_queue.dart';
+import '../../directory_watcher.dart';
+import '../../polling.dart';
+import '../../resubscribable.dart';
+import '../../watch_event.dart';
 import 'directory_list.dart';
 
 /// Periodically polls a directory for changes.

pkgs/watcher/lib/src/directory_watcher/polling.dart renamed to pkgs/watcher/lib/src/directory_watcher/polling/polling_directory_watcher.dart

@@ -7,7 +7,7 @@ import 'dart:io';
 import '../../paths.dart';
 import '../../testing.dart';
 import '../../watch_event.dart';
-import '../event_tree.dart';
+import 'event_tree.dart';
 
 /// MacOS or Windows directory tree.
 ///

pkgs/watcher/lib/src/directory_watcher/macos/directory_tree.dart renamed to pkgs/watcher/lib/src/directory_watcher/recursive/directory_tree.dart

@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import '../paths.dart';
+import '../../paths.dart';
 
 /// Tree of event paths relative to the watched path.
 ///

pkgs/watcher/lib/src/directory_watcher/event_tree.dart renamed to pkgs/watcher/lib/src/directory_watcher/recursive/event_tree.dart

@@ -5,12 +5,12 @@
 import 'dart:async';
 import 'dart:isolate';
 
-import '../resubscribable.dart';
-import '../testing.dart';
-import '../watch_event.dart';
-import 'windows.dart';
+import '../../resubscribable.dart';
+import '../../testing.dart';
+import '../../watch_event.dart';
+import 'recursive_directory_watcher.dart';
 
-/// Runs [WindowsManuallyClosedDirectoryWatcher] in an isolate to work around
+/// Runs [ManuallyClosedRecursiveDirectoryWatcher] in an isolate to work around
 /// a platform limitation.
 ///
 /// On Windows, Directory.watch fails if too many events arrive without being
@@ -21,7 +21,7 @@ import 'windows.dart';
 /// Running the watcher in an isolate makes buffer exhaustion much less likely
 /// as there is no unrelated work happening in the isolate that would block
 /// processing of events.
-class WindowsIsolateDirectoryWatcher implements ManuallyClosedWatcher {
+class IsolateRecursiveDirectoryWatcher implements ManuallyClosedWatcher {
   @override
   final String path;
   final ReceivePort _receivePort = ReceivePort();
@@ -33,7 +33,7 @@ class WindowsIsolateDirectoryWatcher implements ManuallyClosedWatcher {
 
   final void Function(LogEntry)? _log;
 
-  WindowsIsolateDirectoryWatcher(this.path)
+  IsolateRecursiveDirectoryWatcher(this.path)
       : _log = logSeparateIsolateForTesting {
     _startIsolate(path, _receivePort.sendPort, log: _log != null);
     _receivePort.listen((event) => _receiveFromIsolate(event as Event));
@@ -87,7 +87,7 @@ void _startIsolate(String path, SendPort sendPort, {required bool log}) async {
 
 class _WatcherIsolate {
   final String path;
-  final WindowsManuallyClosedDirectoryWatcher watcher;
+  final ManuallyClosedRecursiveDirectoryWatcher watcher;
   final SendPort sendPort;
   final bool log;
 
@@ -96,7 +96,7 @@ class _WatcherIsolate {
   final Completer<void> _closeCompleter = Completer();
 
   _WatcherIsolate(this.path, this.sendPort, {required this.log})
-      : watcher = WindowsManuallyClosedDirectoryWatcher(path) {
+      : watcher = ManuallyClosedRecursiveDirectoryWatcher(path) {
     if (log) {
       logForTesting = (message) => sendPort.send(Event.log(message));
     }

pkgs/watcher/lib/src/directory_watcher/windows_isolate_directory_watcher.dart renamed to pkgs/watcher/lib/src/directory_watcher/recursive/isolate_recursive_directory_watcher.dart

@@ -4,24 +4,34 @@
 
 import 'dart:async';
 
-import '../directory_watcher.dart';
-import '../resubscribable.dart';
-import '../watch_event.dart';
-import 'macos/watched_directory_tree.dart';
-
-/// Resubscribable MacOS directory watcher that watches using
-/// [_MacosDirectoryWatcher].
-class MacosDirectoryWatcher extends ResubscribableWatcher
+import '../../directory_watcher.dart';
+import '../../resubscribable.dart';
+import '../../watch_event.dart';
+import 'isolate_recursive_directory_watcher.dart';
+import 'watched_directory_tree.dart';
+
+/// Directory watcher that watches using [WatchedDirectoryTree].
+///
+/// Optionally, runs the watcher in a new isolate.
+class RecursiveDirectoryWatcher extends ResubscribableWatcher
     implements DirectoryWatcher {
   @override
   String get directory => path;
 
-  MacosDirectoryWatcher(String directory)
-      : super(directory, () => _MacosDirectoryWatcher(directory));
+  /// Watches [directory].
+  ///
+  /// If [runInIsolate], runs the watcher in an isolate to reduce the chance of
+  /// hitting the Windows-specific buffer exhaustion failure.
+  RecursiveDirectoryWatcher(String directory, {required bool runInIsolate})
+      : super(
+            directory,
+            () => runInIsolate
+                ? IsolateRecursiveDirectoryWatcher(directory)
+                : ManuallyClosedRecursiveDirectoryWatcher(directory));
 }
 
-/// Macos directory watcher that watches using [WatchedDirectoryTree].
-class _MacosDirectoryWatcher
+/// Manually closed directory watcher that watches using [WatchedDirectoryTree].
+class ManuallyClosedRecursiveDirectoryWatcher
     implements DirectoryWatcher, ManuallyClosedWatcher {
   @override
   final String path;
@@ -41,7 +51,7 @@ class _MacosDirectoryWatcher
 
   late final WatchedDirectoryTree _watchTree;
 
-  _MacosDirectoryWatcher(this.path) {
+  ManuallyClosedRecursiveDirectoryWatcher(this.path) {
     _watchTree = WatchedDirectoryTree(
         watchedDirectory: path,
         eventsController: _eventsController,

pkgs/watcher/lib/src/directory_watcher/macos.dart renamed to pkgs/watcher/lib/src/directory_watcher/recursive/recursive_directory_watcher.dart

@@ -9,17 +9,18 @@ import '../../event.dart';
 import '../../event_batching.dart';
 import '../../paths.dart';
 import '../../testing.dart';
-import '../event_tree.dart';
+import 'event_tree.dart';
 
-/// Recursively watches a directory with `Directory.watch` on MacOS or Windows.
+/// Watches a directory with `Directory.watch(recursive: true)` on MacOS or
+/// Windows.
 ///
 /// Handles incorrect closure of the watch due to a delete event from before
 /// the watch started, by re-opening the watch if the directory still exists.
 /// See https://github.com/dart-lang/sdk/issues/14373.
 ///
 /// Handles deletion of the watched directory on Windows by watching the parent
 /// directory.
-class NativeWatch {
+class RecursiveNativeWatch {
   final AbsolutePath watchedDirectory;
 
   /// Called when [watchedDirectory] is recreated.
@@ -43,7 +44,7 @@ class NativeWatch {
   /// Watches [watchedDirectory].
   ///
   /// Pass [watchedDirectoryWasDeleted], [onEvents] and [onError] handlers.
-  NativeWatch({
+  RecursiveNativeWatch({
     required this.watchedDirectory,
     required void Function() watchedDirectoryWasRecreated,
     required void Function() watchedDirectoryWasDeleted,

pkgs/watcher/lib/src/directory_watcher/macos/native_watch.dart renamed to pkgs/watcher/lib/src/directory_watcher/recursive/recursive_native_watch.dart

@@ -7,13 +7,15 @@ import 'dart:async';
 import '../../paths.dart';
 import '../../testing.dart';
 import '../../watch_event.dart';
-import '../event_tree.dart';
 import 'directory_tree.dart';
-import 'native_watch.dart';
+import 'event_tree.dart';
+import 'recursive_native_watch.dart';
 
-/// MacOS or Windows directory watcher using a [DirectoryTree].
+/// Directory watcher using `Directory.watch(recursive: true)` and
+/// [DirectoryTree].
 ///
-/// Various platform-specific issues are worked around.
+/// Recursive watch is available on MacOS and Windows; contains
+/// platform-specific workarounds for both.
 ///
 /// MacOS events from a native watcher can arrive out of order, including in
 /// different batches. For example, a modification of `a/1` followed by a
@@ -48,7 +50,7 @@ class WatchedDirectoryTree {
   final StreamController<WatchEvent> _eventsController;
   final Completer<void> _readyCompleter;
 
-  late final NativeWatch nativeWatch;
+  late final RecursiveNativeWatch nativeWatch;
   late final DirectoryTree directoryTree;
 
   WatchedDirectoryTree(
@@ -63,7 +65,7 @@ class WatchedDirectoryTree {
   }
 
   void _watch() async {
-    nativeWatch = NativeWatch(
+    nativeWatch = RecursiveNativeWatch(
       watchedDirectory: watchedDirectory,
       watchedDirectoryWasRecreated: _watchedDirectoryWasRecreated,
       watchedDirectoryWasDeleted: _watchedDirectoryWasDeleted,