Merge pull request #220 from humphd/guid

Make Filer node guid pluggable, default to de-duping ids on generation.

src/constants.js

@@ -35,6 +35,7 @@ module.exports = {
   FS_FORMAT: 'FORMAT',
   FS_NOCTIME: 'NOCTIME',
   FS_NOMTIME: 'NOMTIME',
+  FS_NODUPEIDCHECK: 'FS_NODUPEIDCHECK',
 
   // FS File Open Flags
   O_READ: O_READ,

src/filesystem/implementation.js

@@ -177,9 +177,15 @@ function make_node(context, path, mode, callback) {
       callback(error);
     } else {
       parentNodeData = result;
-      node = new Node(undefined, mode);
+      Node.create({guid: context.guid, mode: mode}, function(error, result) {
+        if(error) {
+          callback(error);
+          return;
+        }
+        node = result;
         node.nlinks += 1;
         context.put(node.id, node, update_parent_node_data);
+      });
     }
   }
 
@@ -364,8 +370,14 @@ function make_root_directory(context, callback) {
     } else if(error && !(error instanceof Errors.ENOENT)) {
       callback(error);
     } else {
-      superNode = new SuperNode();
+      SuperNode.create({guid: context.guid}, function(error, result) {
+        if(error) {
+          callback(error);
+          return;
+        }
+        superNode = result;
         context.put(superNode.id, superNode, write_directory_node);
+      });
     }
   }
 
@@ -373,9 +385,15 @@ function make_root_directory(context, callback) {
     if(error) {
       callback(error);
     } else {
-      directoryNode = new Node(superNode.rnode, MODE_DIRECTORY);
+      Node.create({guid: context.guid, id: superNode.rnode, mode: MODE_DIRECTORY}, function(error, result) {
+        if(error) {
+          callback(error);
+          return;
+        }
+        directoryNode = result;
         directoryNode.nlinks += 1;
         context.put(directoryNode.id, directoryNode, write_directory_data);
+      });
     }
   }
 
@@ -428,9 +446,15 @@ function make_directory(context, path, callback) {
       callback(error);
     } else {
       parentDirectoryData = result;
-      directoryNode = new Node(undefined, MODE_DIRECTORY);
+      Node.create({guid: context.guid, mode: MODE_DIRECTORY}, function(error, result) {
+        if(error) {
+          callback(error);
+          return;
+        }
+        directoryNode = result;
         directoryNode.nlinks += 1;
         context.put(directoryNode.id, directoryNode, write_directory_data);
+      });
     }
   }
 
@@ -657,9 +681,15 @@ function open_file(context, path, flags, callback) {
   }
 
   function write_file_node() {
-    fileNode = new Node(undefined, MODE_FILE);
+    Node.create({guid: context.guid, mode: MODE_FILE}, function(error, result) {
+      if(error) {
+        callback(error);
+        return;
+      }
+      fileNode = result;
       fileNode.nlinks += 1;
       context.put(fileNode.id, fileNode, write_file_data);
+    });
   }
 
   function write_file_data(error) {
@@ -1122,11 +1152,17 @@ function make_symbolic_link(context, srcpath, dstpath, callback) {
   }
 
   function write_file_node() {
-    fileNode = new Node(undefined, MODE_SYMBOLIC_LINK);
+    Node.create({guid: context.guid, mode: MODE_SYMBOLIC_LINK}, function(error, result) {
+      if(error) {
+        callback(error);
+        return;
+      }
+      fileNode = result;
       fileNode.nlinks += 1;
       fileNode.size = srcpath.length;
       fileNode.data = srcpath;
       context.put(fileNode.id, fileNode, update_directory_data);
+    });
   }
 
   function update_time(error) {

src/filesystem/interface.js

@@ -9,6 +9,7 @@ var FS_FORMAT = Constants.FS_FORMAT;
 var FS_READY = Constants.FS_READY;
 var FS_PENDING = Constants.FS_PENDING;
 var FS_ERROR = Constants.FS_ERROR;
+var FS_NODUPEIDCHECK = Constants.FS_NODUPEIDCHECK;
 
 var providers = require('../providers/index.js');
 
@@ -16,6 +17,7 @@ var Shell = require('../shell/shell.js');
 var Intercom = require('../../lib/intercom.js');
 var FSWatcher = require('../fs-watcher.js');
 var Errors = require('../errors.js');
+var defaultGuidFn = require('../shared.js').guid;
 
 var STDIN = Constants.STDIN;
 var STDOUT = Constants.STDOUT;
@@ -55,6 +57,9 @@ function maybeCallback(callback) {
  *           can write one of their own and pass it in to be used.
  *           By default an IndexedDB provider is used.
  *
+ * guid: a function for generating unique IDs for nodes in the filesystem.
+ *       Use this to override the built-in UUID generation. (Used mainly for tests).
+ *
  * callback: a callback function to be executed when the file system becomes
  *           ready for use. Depending on the context provider used, this might
  *           be right away, or could take some time. The callback should expect
@@ -67,6 +72,7 @@ function FileSystem(options, callback) {
   callback = callback || nop;
 
   var flags = options.flags;
+  var guid = options.guid ? options.guid : defaultGuidFn;
   var provider = options.provider || new providers.Default(options.name || FILE_SYSTEM_NAME);
   // If we're given a provider, match its name unless we get an explicit name
   var name = options.name || provider.name;
@@ -138,6 +144,36 @@ function FileSystem(options, callback) {
     return watcher;
   };
 
+  // Deal with various approaches to node ID creation
+  function wrappedGuidFn(context) {
+    return function(callback) {
+      // Skip the duplicate ID check if asked to
+      if(_(flags).contains(FS_NODUPEIDCHECK)) {
+        callback(null, guid());
+        return;
+      }
+
+      // Otherwise (default) make sure this id is unused first
+      function guidWithCheck(callback) {
+        var id = guid();
+        context.get(id, function(err, value) {
+          if(err) {
+            callback(err);
+            return;
+          }
+
+          // If this id is unused, use it, otherwise find another
+          if(!value) {
+            callback(null, id);
+          } else {
+            guidWithCheck(callback);
+          }
+        });
+      }
+      guidWithCheck(callback);
+    };
+  }
+
   // Let other instances (in this or other windows) know about
   // any changes to this fs instance.
   function broadcastChanges(changes) {
@@ -158,6 +194,7 @@ function FileSystem(options, callback) {
         var context = provider[methodName]();
         context.flags = flags;
         context.changes = [];
+        context.guid = wrappedGuidFn(context);
 
         // When the context is finished, let the fs deal with any change events
         context.close = function() {
@@ -201,6 +238,7 @@ function FileSystem(options, callback) {
     }
     // otherwise format the fs first
     var context = provider.getReadWriteContext();
+    context.guid = wrappedGuidFn(context);
     context.clear(function(err) {
       if(err) {
         complete(err);

src/node.js

@@ -1,20 +1,53 @@
 var MODE_FILE = require('./constants.js').MODE_FILE;
-var guid = require('./shared.js').guid;
 
-module.exports = function Node(id, mode, size, atime, ctime, mtime, flags, xattrs, nlinks, version) {
+function Node(options) {
   var now = Date.now();
 
-  this.id = id || guid();
+  this.id = options.id;
-  this.mode = mode || MODE_FILE;  // node type (file, directory, etc)
+  this.mode = options.mode || MODE_FILE;  // node type (file, directory, etc)
-  this.size = size || 0; // size (bytes for files, entries for directories)
+  this.size = options.size || 0; // size (bytes for files, entries for directories)
-  this.atime = atime || now; // access time (will mirror ctime after creation)
+  this.atime = options.atime || now; // access time (will mirror ctime after creation)
-  this.ctime = ctime || now; // creation/change time
+  this.ctime = options.ctime || now; // creation/change time
-  this.mtime = mtime || now; // modified time
+  this.mtime = options.mtime || now; // modified time
-  this.flags = flags || []; // file flags
+  this.flags = options.flags || []; // file flags
-  this.xattrs = xattrs || {}; // extended attributes
+  this.xattrs = options.xattrs || {}; // extended attributes
-  this.nlinks = nlinks || 0; // links count
+  this.nlinks = options.nlinks || 0; // links count
-  this.version = version || 0; // node version
+  this.version = options.version || 0; // node version
   this.blksize = undefined; // block size
   this.nblocks = 1; // blocks count
-  this.data = guid(); // id for data object
+  this.data = options.data; // id for data object
+}
+
+// Make sure the options object has an id on property,
+// either from caller or one we generate using supplied guid fn.
+function ensureID(options, prop, callback) {
+  if(options[prop]) {
+    callback(null);
+  } else {
+    options.guid(function(err, id) {
+      options[prop] = id;
+      callback(err);
+    });
+  }
+}
+
+Node.create = function(options, callback) {
+  // We expect both options.id and options.data to be provided/generated.
+  ensureID(options, 'id', function(err) {
+    if(err) {
+      callback(err);
+      return;
+    }
+
+    ensureID(options, 'data', function(err) {
+      if(err) {
+        callback(err);
+        return;
+      }
+
+      callback(null, new Node(options));
+    });
+  });
 };
+
+module.exports = Node;

src/super-node.js

@@ -1,13 +1,26 @@
 var Constants = require('./constants.js');
-var guid = require('./shared.js').guid;
 
-module.exports = function SuperNode(atime, ctime, mtime) {
+function SuperNode(options) {
   var now = Date.now();
 
   this.id = Constants.SUPER_NODE_ID;
   this.mode = Constants.MODE_META;
-  this.atime = atime || now;
+  this.atime = options.atime || now;
-  this.ctime = ctime || now;
+  this.ctime = options.ctime || now;
-  this.mtime = mtime || now;
+  this.mtime = options.mtime || now;
-  this.rnode = guid(); // root node id (randomly generated)
+  // root node id (randomly generated)
+  this.rnode = options.rnode;
+}
+
+SuperNode.create = function(options, callback) {
+  options.guid(function(err, rnode) {
+    if(err) {
+      callback(err);
+      return;
+    }
+    options.rnode = options.rnode || rnode;
+    callback(null, new SuperNode(options));
+  });
 };
+
+module.exports = SuperNode;