Roll forward r30205.
Unlike previous versions of this CL, the debug info will only be printed when
running directory_watcher/mac_os_test, so it won't break the pub bots.
R=rnystrom@google.com
BUG=15042
Review URL: https://codereview.chromium.org//71353011
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart/pkg/watcher@30254 260f80e4-7a28-3924-810f-c04153c831b5
diff --git a/pkgs/watcher/lib/src/directory_watcher/mac_os.dart b/pkgs/watcher/lib/src/directory_watcher/mac_os.dart
index 5b1feb3..09fdd66 100644
--- a/pkgs/watcher/lib/src/directory_watcher/mac_os.dart
+++ b/pkgs/watcher/lib/src/directory_watcher/mac_os.dart
@@ -7,6 +7,8 @@
import 'dart:async';
import 'dart:io';
+import 'package:path/path.dart' as p;
+
import '../constructable_file_system_event.dart';
import '../path_set.dart';
import '../utils.dart';
@@ -24,6 +26,9 @@
/// This also works around issues 14793, 14806, and 14849 in the implementation
/// of [Directory.watch].
class MacOSDirectoryWatcher extends ResubscribableDirectoryWatcher {
+ // TODO(nweiz): remove this when issue 15042 is fixed.
+ static bool logDebugInfo = false;
+
MacOSDirectoryWatcher(String directory)
: super(directory, () => new _MacOSDirectoryWatcher(directory));
}
@@ -78,7 +83,12 @@
if (entity is! Directory) _files.add(entity.path);
},
onError: _emitError,
- onDone: _readyCompleter.complete,
+ onDone: () {
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("watcher is ready");
+ }
+ _readyCompleter.complete();
+ },
cancelOnError: true);
}
@@ -94,12 +104,38 @@
/// The callback that's run when [Directory.watch] emits a batch of events.
void _onBatch(List<FileSystemEvent> batch) {
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("======== batch:");
+ for (var event in batch) {
+ print(" ${_formatEvent(event)}");
+ }
+
+ print("known files:");
+ for (var foo in _files.toSet()) {
+ print(" ${p.relative(foo, from: directory)}");
+ }
+ }
+
batches++;
_sortEvents(batch).forEach((path, events) {
+ var relativePath = p.relative(path, from: directory);
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("events for $relativePath:\n");
+ for (var event in events) {
+ print(" ${_formatEvent(event)}");
+ }
+ }
+
var canonicalEvent = _canonicalEvent(events);
events = canonicalEvent == null ?
_eventsBasedOnFileSystem(path) : [canonicalEvent];
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("canonical event for $relativePath: "
+ "${_formatEvent(canonicalEvent)}");
+ print("actionable events for $relativePath: "
+ "${events.map(_formatEvent)}");
+ }
for (var event in events) {
if (event is FileSystemCreateEvent) {
@@ -113,7 +149,12 @@
if (entity is Directory) return;
_emitEvent(ChangeType.ADD, entity.path);
_files.add(entity.path);
- }, onError: _emitError, cancelOnError: true);
+ }, onError: (e, stackTrace) {
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("got error listing $relativePath: $e");
+ }
+ _emitError(e, stackTrace);
+ }, cancelOnError: true);
} else if (event is FileSystemModifyEvent) {
assert(!event.isDirectory);
_emitEvent(ChangeType.MODIFY, path);
@@ -125,6 +166,10 @@
}
}
});
+
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("========");
+ }
}
/// Sort all the events in a batch into sets based on their path.
@@ -261,6 +306,13 @@
var fileExists = new File(path).existsSync();
var dirExists = new Directory(path).existsSync();
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("file existed: $fileExisted");
+ print("dir existed: $dirExisted");
+ print("file exists: $fileExists");
+ print("dir exists: $dirExists");
+ }
+
var events = [];
if (fileExisted) {
if (fileExists) {
@@ -330,6 +382,10 @@
// watch beginning.
if (type == ChangeType.ADD && _files.contains(path)) return;
+ if (MacOSDirectoryWatcher.logDebugInfo) {
+ print("emitting $type ${p.relative(path, from: directory)}");
+ }
+
_eventsController.add(new WatchEvent(type, path));
}
@@ -350,4 +406,23 @@
}, cancelOnError: cancelOnError);
_subscriptions.add(subscription);
}
+
+ // TODO(nweiz): remove this when issue 15042 is fixed.
+ /// Return a human-friendly string representation of [event].
+ String _formatEvent(FileSystemEvent event) {
+ if (event == null) return 'null';
+
+ var path = p.relative(event.path, from: directory);
+ var type = event.isDirectory ? 'directory' : 'file';
+ if (event is FileSystemCreateEvent) {
+ return "create $type $path";
+ } 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)}";
+ }
+ }
}
diff --git a/pkgs/watcher/test/directory_watcher/mac_os_test.dart b/pkgs/watcher/test/directory_watcher/mac_os_test.dart
index f7f8176..78ff889 100644
--- a/pkgs/watcher/test/directory_watcher/mac_os_test.dart
+++ b/pkgs/watcher/test/directory_watcher/mac_os_test.dart
@@ -11,6 +11,7 @@
main() {
initConfig();
+ MacOSDirectoryWatcher.logDebugInfo = true;
watcherFactory = (dir) => new MacOSDirectoryWatcher(dir);
