imdone-core 1.54.11 → 1.54.12

package/lib/constants.js

@@ -50,13 +50,14 @@ module.exports = {
   SORT_FILE: path.join(CONFIG_DIR, 'sort.json'),
   TEMPLATES_DIR: path.join(CONFIG_DIR, 'templates'),
   IGNORE_FILE: '.imdoneignore',
+  PAUSE_FILE: '.imdonepause',
   DEFAULT_FILE_PATTERN: '^(readme\\.md|home\\.md|readme\\.w+|home\\.w+)$',
   DEFAULT_IGNORE,
   DEFAULT_IGNORE_DIRS,
   DEFAULT_IGNORE_EXTS,
   ERRORS: {
     NOT_A_FILE: 'file must be of type File',
-    CALLBACK_REQUIRED: 'Last paramter must be a callback function',
+    CALLBACK_REQUIRED: 'Last parameter must be a callback function',
     NO_CONTENT: 'File has no content',
     LIST_NOT_FOUND: 'List not found',
     TASK_NOT_FOUND: 'Task not found',

package/lib/mixins/repo-watched-fs-store.js

@@ -4,7 +4,8 @@ var fsStore = require('./repo-fs-store'),
   log = require('debug')('imdone-mixins:repo-watched-fs-store'),
   File = require('../file'),
   constants = require('../constants'),
-  sane = require('sane')
+  sane = require('sane'),
+  path = require('path')
 
 module.exports = mixin
 
@@ -18,6 +19,7 @@ function mixin(repo, fs = require('fs')) {
   var _destroy = repo.destroy
   var _init = repo.init
   var initializing = false
+  var paused = false
 
   repo.init = function (cb) {
     if (initializing) {
@@ -33,9 +35,17 @@ function mixin(repo, fs = require('fs')) {
         initializing = false
         return cb ? cb(err) : null
       }
-      repo.initWatcher(() => {
-        initializing = false
-        if (cb) cb(err, files)
+      // Check if pause file exists on init
+      const pauseFilePath = path.join(repo.path, constants.PAUSE_FILE)
+      fs.access(pauseFilePath, fs.constants.F_OK, (accessErr) => {
+        if (!accessErr) {
+          log('Pause file detected on init. Pausing repository.')
+          paused = true
+        }
+        repo.initWatcher(() => {
+          initializing = false
+          if (cb) cb(err, files)
+        })
       })
     })
   }
@@ -57,9 +67,19 @@ function mixin(repo, fs = require('fs')) {
         initializing = false
         return cb ? cb(err) : null
       }
-      repo.initWatcher(() => {
-        initializing = false
-        return cb ? cb(err, files) : null
+      // Check if pause file exists on refresh
+      const pauseFilePath = path.join(repo.path, constants.PAUSE_FILE)
+      fs.access(pauseFilePath, fs.constants.F_OK, (accessErr) => {
+        if (!accessErr) {
+          log('Pause file detected on refresh. Pausing repository.')
+          paused = true
+        } else {
+          paused = false
+        }
+        repo.initWatcher(() => {
+          initializing = false
+          return cb ? cb(err, files) : null
+        })
       })
     })
   }
@@ -72,6 +92,10 @@ function mixin(repo, fs = require('fs')) {
     return path === constants.IGNORE_FILE
   }
 
+  var _isImdonePause = function (path) {
+    return path === constants.PAUSE_FILE
+  }
+
   const onConfigChange = function (file) {
     console.info('Loading config.  Observed a change to:', file)
     const label = `Refresh repo: ${repo.path}`
@@ -85,6 +109,30 @@ function mixin(repo, fs = require('fs')) {
 
   const onIgnoreChange = onConfigChange
 
+  repo.pause = async function () {
+    log('Pausing watcher for:', repo.path)
+    paused = true
+    return Promise.resolve()
+  }
+
+  repo.resume = async function () {
+    log('Resuming watcher for:', repo.path)
+    paused = false
+    return new Promise((resolve, reject) => {
+      repo.refresh((err, files) => {
+        if (err) {
+          console.error('Error refreshing repo on resume', err)
+          return reject(err)
+        }
+        resolve(files)
+      })
+    })
+  }
+
+  repo.isPaused = function () {
+    return paused
+  }
+
   repo.initWatcher = function (cb) {
     console.log('initializing watcher for:', repo.path)
     repo.watcher = sane(repo.path, {
@@ -98,6 +146,11 @@ function mixin(repo, fs = require('fs')) {
           onIgnoreChange(file)
         }
 
+        // Don't ignore the pause file so we can detect it
+        if (_isImdonePause(file)) {
+          return false
+        }
+
         const ignore = !repo.shouldInclude(file)
         if (!ignore || /^.*\.(jpg|gif|pdf|png)$/i.test(file)) {
           repo.addFilePath(file)
@@ -119,6 +172,11 @@ function mixin(repo, fs = require('fs')) {
       })
       .on('add', function (path, root, stat) {
         console.log('Watcher received add event for file: ' + path)
+        if (_isImdonePause(path)) {
+          console.log('Pause file detected. Pausing repository.')
+          return repo.pause()
+        }
+        if (paused) return log('Watcher is paused. Ignoring add event for: ' + path)
         if (stat.isDirectory()) return
         var file = repo.getFile(path)
         if (file === undefined) {
@@ -148,6 +206,8 @@ function mixin(repo, fs = require('fs')) {
           `Watcher received change event for file: ${path} repoPath: ${repo.path}`,
           stat.mtime
         )
+        if (_isImdonePause(path)) return log('Ignoring change to pause file')
+        if (paused) return log('Watcher is paused. Ignoring change event for: ' + path)
         if (!path || stat.isDirectory()) return
         var file = repo.getFile(path) || path
         const isFile = File.isFile(file)
@@ -178,6 +238,11 @@ function mixin(repo, fs = require('fs')) {
       })
       .on('delete', function (path) {
         log('Watcher received unlink event for file: ' + path)
+        if (_isImdonePause(path)) {
+          console.log('Pause file deleted. Resuming repository.')
+          return repo.resume()
+        }
+        if (paused) return log('Watcher is paused. Ignoring delete event for: ' + path)
         repo.removeFilePath(path)
         var file = new File({
           repoId: repo.getId(),

package/lib/repository.js

@@ -624,6 +624,33 @@ Repository.prototype.readFileContent = function (file, cb) {
   inMixinsNoop(cb)
 }
 
+/**
+ * Pause file watching (Implemented in mixins)
+ * @method pause
+ * @return Promise
+ */
+Repository.prototype.pause = async function () {
+  return Promise.resolve()
+}
+
+/**
+ * Resume file watching (Implemented in mixins)
+ * @method resume
+ * @return Promise
+ */
+Repository.prototype.resume = async function () {
+  return Promise.resolve()
+}
+
+/**
+ * Check if file watching is paused (Implemented in mixins)
+ * @method isPaused
+ * @return Boolean
+ */
+Repository.prototype.isPaused = function () {
+  return false
+}
+
 /**
  * Description
  * @method readFile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "1.54.11",
+  "version": "1.54.12",
   "description": "imdone-core",
   "main": "index.js",
   "bin": {