[WIP] core: Use AtomWatcher on macOS

core/config.js

@@ -230,12 +230,12 @@ function loadOrDeleteFile(configPath /*: string */) /*: FileConfig */ {
 /** Detect which local watcher will be used. */
 function watcherType(
   fileConfig /*: FileConfig */ = {},
-  { env, platform } /*: * */ = process
+  { env } /*: * */ = process
 ) /*: WatcherType */ {
   return (
     fileWatcherType(fileConfig) ||
     environmentWatcherType(env) ||
-    platformDefaultWatcherType(platform)
+    platformDefaultWatcherType()
   )
 }
 
@@ -250,12 +250,7 @@ function environmentWatcherType(
   return validateWatcherType(COZY_FS_WATCHER)
 }
 
-function platformDefaultWatcherType(
-  platform /*: string */ = process.platform
-) /*: WatcherType */ {
-  if (platform === 'darwin') {
-    return 'chokidar'
-  }
+function platformDefaultWatcherType() /*: WatcherType */ {
   return 'atom'
 }
 

core/local/atom/producer.js

@@ -12,11 +12,12 @@ const watcher = require('@atom/watcher')
 const Channel = require('./channel')
 const { INITIAL_SCAN_DONE } = require('./event')
 const defaultStater = require('../stater')
+const LocalEventBuffer = require('../chokidar/event_buffer')
 const logger = require('../../utils/logger')
 
 /*::
 import type { Ignore } from '../../ignore'
-import type { AtomEvent } from './event'
+import type { AtomBatch, AtomEvent } from './event'
 
 export type Scanner = (string) => Promise<void>
 */
@@ -61,12 +62,21 @@ class Producer {
   syncPath: string
   ignore: Ignore
   watcher: *
+  macOSBuffer: ?LocalEventBuffer<AtomBatch>
   */
   constructor(opts /*: { syncPath: string, ignore: Ignore } */) {
     this.channel = new Channel()
     this.syncPath = opts.syncPath
     this.ignore = opts.ignore
     this.watcher = null
+    if (process.platform === 'darwin') {
+      const timeoutInMs = process.env.NODE_ENV === 'test' ? 1000 : 10000
+      this.macOSBuffer = new LocalEventBuffer(timeoutInMs, batches => {
+        for (const batch of batches) {
+          this.process(batch)
+        }
+      })
+    }
     autoBind(this)
   }
 
@@ -90,10 +100,15 @@ class Producer {
    * the recursive option.
    */
   async start() {
+    const macOSBuffer = this.macOSBuffer
+    const onEventBatch = macOSBuffer
+      ? macOSBuffer.push.bind(macOSBuffer)
+      : this.process
+
     this.watcher = await watcher.watchPath(
       this.syncPath,
       { recursive: true },
-      this.process
+      onEventBatch
     )
     log.info(`Now watching ${this.syncPath}`)
     if (process.platform === 'linux') {

core/local/atom/watcher.js

@@ -82,11 +82,7 @@ const steps = _.compact([
 
 /** The producer for the current platform. */
 const producer = opts => {
-  if (['linux', 'win32'].includes(process.platform)) {
-    return new Producer(opts)
-  } else {
-    throw new Error('The atom watcher is not available on this platform')
-  }
+  return new Producer(opts)
 }
 
 const stepsInitialState = (

test/scenarios/add_delete_dir_and_file/atom/darwin.json

@@ -0,0 +1,27 @@
+[
+  [
+    {
+      "action": "created",
+      "kind": "directory",
+      "path": "dir"
+    },
+    {
+      "action": "created",
+      "kind": "file",
+      "path": "file"
+    }
+  ],
+  [],
+  [
+    {
+      "action": "deleted",
+      "kind": "directory",
+      "path": "dir"
+    },
+    {
+      "action": "deleted",
+      "kind": "file",
+      "path": "file"
+    }
+  ]
+]

test/scenarios/add_file/atom/darwin.json

@@ -0,0 +1,9 @@
+[
+  [
+    {
+      "action": "created",
+      "kind": "file",
+      "path": "file"
+    }
+  ]
+]

test/scenarios/add_trash_dir/atom/darwin.json

@@ -0,0 +1,17 @@
+[
+  [
+    {
+      "action": "created",
+      "kind": "directory",
+      "path": "dir"
+    }
+  ],
+  [],
+  [
+    {
+      "action": "deleted",
+      "kind": "directory",
+      "path": "dir"
+    }
+  ]
+]

test/scenarios/add_trash_file/atom/darwin.json

@@ -0,0 +1,16 @@
+[
+  [
+    {
+      "action": "created",
+      "kind": "file",
+      "path": "file"
+    }
+  ],
+  [
+    {
+      "action": "deleted",
+      "kind": "file",
+      "path": "file"
+    }
+  ]
+]

test/scenarios/change_file/atom/darwin.json

@@ -0,0 +1,9 @@
+[
+  [
+    {
+      "action": "modified",
+      "kind": "file",
+      "path": "file"
+    }
+  ]
+]

test/scenarios/create_dir_into_moved_one/atom/darwin.json

@@ -0,0 +1,16 @@
+[
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "dst/dir1",
+      "oldPath": "src/dir1"
+    },
+    {
+      "action": "created",
+      "kind": "directory",
+      "path": "dst/dir1/dir2"
+    }
+  ],
+  []
+]

test/scenarios/create_dirs/atom/darwin.json

@@ -0,0 +1,43 @@
+[
+  [
+    {
+      "action": "created",
+      "kind": "directory",
+      "path": "foo"
+    },
+    {
+      "action": "created",
+      "kind": "directory",
+      "path": "foo/bar"
+    }
+  ],
+  [],
+  [
+    {
+      "action": "scan",
+      "path": "foo/bar",
+      "kind": "directory",
+      "stats": {
+        "dev": 16777226,
+        "mode": 16877,
+        "nlink": 2,
+        "uid": 501,
+        "gid": 20,
+        "rdev": 0,
+        "blksize": 4194304,
+        "ino": 8600863105,
+        "size": 64,
+        "blocks": 0,
+        "atimeMs": 1554478410553.5947,
+        "mtimeMs": 1554478410533.3728,
+        "ctimeMs": 1554478410533.3728,
+        "birthtimeMs": 1554478410533.3728,
+        "atime": "2019-04-05T15:33:30.554Z",
+        "mtime": "2019-04-05T15:33:30.533Z",
+        "ctime": "2019-04-05T15:33:30.533Z",
+        "birthtime": "2019-04-05T15:33:30.533Z"
+      }
+    }
+  ],
+  []
+]

test/scenarios/move_a_to_c_and_b_to_a_dir_dir_delay/atom/darwin.json

@@ -0,0 +1,18 @@
+[
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "c",
+      "oldPath": "a"
+    }
+  ],
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "a",
+      "oldPath": "b"
+    }
+  ]
+]

test/scenarios/move_and_trash_dir/atom/darwin.json

@@ -0,0 +1,24 @@
+[
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "dst/subdir",
+      "oldPath": "src/subdir"
+    }
+  ],
+  [
+    {
+      "action": "deleted",
+      "kind": "file",
+      "path": "dst/subdir/file"
+    }
+  ],
+  [
+    {
+      "action": "deleted",
+      "kind": "directory",
+      "path": "dst/subdir"
+    }
+  ]
+]

test/scenarios/move_and_trash_file/atom/darwin.json

@@ -0,0 +1,17 @@
+[
+  [
+    {
+      "action": "renamed",
+      "kind": "file",
+      "path": "dst/file",
+      "oldPath": "src/file"
+    }
+  ],
+  [
+    {
+      "action": "deleted",
+      "kind": "file",
+      "path": "dst/file"
+    }
+  ]
+]

test/scenarios/move_and_update_file/atom/darwin.json

@@ -0,0 +1,17 @@
+[
+  [
+    {
+      "action": "renamed",
+      "kind": "file",
+      "path": "dst/file",
+      "oldPath": "src/file"
+    }
+  ],
+  [
+    {
+      "action": "modified",
+      "kind": "file",
+      "path": "dst/file"
+    }
+  ]
+]

test/scenarios/move_dir_a_to_b_to_c_to_b/atom/darwin.json

@@ -0,0 +1,26 @@
+[
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "src/B",
+      "oldPath": "src/A"
+    }
+  ],
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "src/C",
+      "oldPath": "src/B"
+    }
+  ],
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "src/B",
+      "oldPath": "src/C"
+    }
+  ]
+]

test/scenarios/move_dir_and_update_subfile/atom/darwin.json

@@ -0,0 +1,17 @@
+[
+  [
+    {
+      "action": "renamed",
+      "kind": "directory",
+      "path": "dst",
+      "oldPath": "src"
+    }
+  ],
+  [
+    {
+      "action": "modified",
+      "kind": "file",
+      "path": "dst/file"
+    }
+  ]
+]