Revert "Mac no longer fire bogus events. Fix Mac watcher."

pkg/watcher/lib/src/directory_watcher/mac_os.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // 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.
 
 library watcher.directory_watcher.mac_os;
 
 import 'dart:async';
 import 'dart:io';
 
 import 'package:path/path.dart' as p;
@@ skipping 55 matching lines @@
   StreamSubscription<FileSystemEvent> _watchSubscription;
 
   /// The subscription to the [Directory.list] call for the initial listing of
   /// the directory to determine its initial state.
   StreamSubscription<FileSystemEntity> _initialListSubscription;
 
   /// The subscription to the [Directory.list] call for listing the contents of
   /// a subdirectory that was moved into the watched directory.
   StreamSubscription<FileSystemEntity> _listSubscription;
 
+  /// The timer for tracking how long we wait for an initial batch of bogus
+  /// events (see issue 14373).
+  Timer _bogusEventTimer;
+
   _MacOSDirectoryWatcher(String directory, int parentId)
       : directory = directory,
         _files = new PathSet(directory),
         _id = "$parentId/${_count++}" {
-    _listDir().then((_) {
-      if (MacOSDirectoryWatcher.logDebugInfo) {
-        print("[$_id] finished initial directory list");
-      }
-      _startWatch();
+    _startWatch();
+
+    // Before we're ready to emit events, wait for [_listDir] to complete and
+    // for enough time to elapse that if bogus events (issue 14373) would be
+    // emitted, they will be.
+    //
+    // If we do receive a batch of events, [_onBatch] will ensure that these
+    // futures don't fire and that the directory is re-listed.
+    Future.wait([
+      _listDir().then((_) {
+        if (MacOSDirectoryWatcher.logDebugInfo) {
+          print("[$_id] finished initial directory list");
+        }
+      }),
+      _waitForBogusEvents()
+    ]).then((_) {
       if (MacOSDirectoryWatcher.logDebugInfo) {
         print("[$_id] watcher is ready, known files:");
         for (var file in _files.toSet()) {
           print("[$_id]   ${p.relative(file, from: directory)}");
         }
       }
       _readyCompleter.complete();
     });
   }
 
@@ skipping 17 matching lines @@
       for (var event in batch) {
         print("[$_id]   ${_formatEvent(event)}");
       }
 
       print("[$_id] known files:");
       for (var file in _files.toSet()) {
         print("[$_id]   ${p.relative(file, from: directory)}");
       }
     }
 
+    // If we get a batch of events before we're ready to begin emitting events,
+    // it's probable that it's a batch of pre-watcher events (see issue 14373).
+    // Ignore those events and re-list the directory.
+    if (!isReady) {
+      if (MacOSDirectoryWatcher.logDebugInfo) {
+        print("[$_id] not ready to emit events, re-listing directory");
+      }
+
+      // Cancel the timer because bogus events only occur in the first batch, so
+      // we can fire [ready] as soon as we're done listing the directory.
+      _bogusEventTimer.cancel();
+      _listDir().then((_) {
+        if (MacOSDirectoryWatcher.logDebugInfo) {
+          print("[$_id] watcher is ready, known files:");
+          for (var file in _files.toSet()) {
+            print("[$_id]   ${p.relative(file, from: directory)}");
+          }
+        }
+        _readyCompleter.complete();
+      });
+      return;
+    }
+
     _sortEvents(batch).forEach((path, events) {
       var relativePath = p.relative(path, from: directory);
       if (MacOSDirectoryWatcher.logDebugInfo) {
         print("[$_id] events for $relativePath:");
         for (var event in events) {
           print("[$_id]   ${_formatEvent(event)}");
         }
       }
 
       var canonicalEvent = _canonicalEvent(events);
@@ skipping 215 matching lines @@
 
     return events;
   }
 
   /// The callback that's run when the [Directory.watch] stream is closed.
   void _onDone() {
     if (MacOSDirectoryWatcher.logDebugInfo) print("[$_id] stream closed");
 
     _watchSubscription = null;
 
+    // If the directory still exists and we're still expecting bogus events,
+    // this is probably issue 14849 rather than a real close event. We should
+    // just restart the watcher.
+    if (!isReady && new Directory(directory).existsSync()) {
+      if (MacOSDirectoryWatcher.logDebugInfo) {
+        print("[$_id] fake closure (issue 14849), re-opening stream");
+      }
+      _startWatch();
+      return;
+    }
+
     // FSEvents can fail to report the contents of the directory being removed
     // when the directory itself is removed, so we need to manually mark the
     // files as removed.
     for (var file in _files.toSet()) {
       _emitEvent(ChangeType.REMOVE, file);
     }
     _files.clear();
     close();
   }
 
@@ skipping 19 matching lines @@
     var stream = Chain.track(new Directory(directory).list(recursive: true));
     _initialListSubscription = stream.listen((entity) {
       if (entity is! Directory) _files.add(entity.path);
     },
         onError: _emitError,
         onDone: completer.complete,
         cancelOnError: true);
     return completer.future;
   }
 
+  /// Wait 200ms for a batch of bogus events (issue 14373) to come in.
+  ///
+  /// 200ms is short in terms of human interaction, but longer than any Mac OS
+  /// watcher tests take on the bots, so it should be safe to assume that any
+  /// bogus events will be signaled in that time frame.
+  Future _waitForBogusEvents() {
+    var completer = new Completer();
+    _bogusEventTimer = new Timer(
+        new Duration(milliseconds: 200),
+        completer.complete);
+    return completer.future;
+  }
+
   /// Emit an event with the given [type] and [path].
   void _emitEvent(ChangeType type, String path) {
     if (!isReady) return;
 
     if (MacOSDirectoryWatcher.logDebugInfo) {
       print("[$_id] emitting $type ${p.relative(path, from: directory)}");
     }
 
     _eventsController.add(new WatchEvent(type, path));
   }
@@ skipping 20 matching lines @@
     } else if (event is FileSystemDeleteEvent) {
       return "delete $type $path";
     } else if (event is FileSystemModifyEvent) {
       return "modify $type $path";
     } else if (event is FileSystemMoveEvent) {
       return "move $type $path to "
           "${p.relative(event.destination, from: directory)}";
     }
   }
 }