readdir-options (vercel#854)

* fix isRootPath, add options_

* readdirOptions

* separate entries

* modify entries

* mock dirent, getFileTypes

* fix test-fs-layer-2 temporarily

Author: igorklopov

prelude/bootstrap.js

@@ -164,6 +164,7 @@ console.log(translateNth(["", "a+"], 0, "d:\\snapshot\\countly\\plugins-ext\\123
 // /////////////////////////////////////////////////////////////////
 
 function isRootPath (p) {
+  if (p === '.') p = require('path').resolve(p);
   return require('path').dirname(p) === p;
 }
 
@@ -697,6 +698,7 @@ function payloadFileSync (pointer) {
 
     var encoding = options.encoding;
     assertEncoding(encoding);
+
     var buffer = readFileFromSnapshot(path);
     if (encoding) buffer = buffer.toString(encoding);
     return buffer;
@@ -738,6 +740,49 @@ function payloadFileSync (pointer) {
   // readdir ///////////////////////////////////////////////////////
   // ///////////////////////////////////////////////////////////////
 
+  function readdirOptions (options, hasCallback) {
+    if (!options || (hasCallback && typeof options === 'function')) {
+      return { encoding: null };
+    } else if (typeof options === 'string') {
+      return { encoding: options };
+    } else if (typeof options === 'object') {
+      return options;
+    } else {
+      return null;
+    }
+  }
+
+  function Dirent (name, type) {
+    this.name = name;
+    this.type = type;
+  }
+
+  Dirent.prototype.isDirectory = function () {
+    return this.type === 2;
+  };
+
+  Dirent.prototype.isFile = function () {
+    return this.type === 1;
+  };
+
+  Dirent.prototype.isBlockDevice =
+  Dirent.prototype.isCharacterDevice =
+  Dirent.prototype.isSymbolicLink =
+  Dirent.prototype.isFIFO =
+  Dirent.prototype.isSocket = function () {
+    return false;
+  };
+
+  function getFileTypes (path_, entries) {
+    return entries.map(function (entry) {
+      var path = require('path').join(path_, entry);
+      var entity = VIRTUAL_FILESYSTEM[path];
+      if (entity[STORE_BLOB] || entity[STORE_CONTENT]) return new Dirent(entry, 1);
+      if (entity[STORE_LINKS]) return new Dirent(entry, 2);
+      throw new Error('UNEXPECTED-24');
+    });
+  }
+
   function readdirRoot (path, cb) {
     if (cb) {
       ancestor.readdir(path, function (error, entries) {
@@ -780,7 +825,7 @@ function payloadFileSync (pointer) {
     return cb2(new Error('UNEXPECTED-25'));
   }
 
-  fs.readdirSync = function (path) {
+  fs.readdirSync = function (path, options_) {
     var isRoot = isRootPath(path);
 
     if (!insideSnapshot(path) && !isRoot) {
@@ -790,10 +835,18 @@ function payloadFileSync (pointer) {
       return ancestor.readdirSync.apply(fs, translateNth(arguments, 0, path));
     }
 
-    return readdirFromSnapshot(path, isRoot);
+    var options = readdirOptions(options_, false);
+
+    if (!options) {
+      return ancestor.readdirSync.apply(fs, arguments);
+    }
+
+    var entries = readdirFromSnapshot(path, isRoot);
+    if (options.withFileTypes) entries = getFileTypes(path, entries);
+    return entries;
   };
 
-  fs.readdir = function (path) {
+  fs.readdir = function (path, options_) {
     var isRoot = isRootPath(path);
 
     if (!insideSnapshot(path) && !isRoot) {
@@ -803,8 +856,18 @@ function payloadFileSync (pointer) {
       return ancestor.readdir.apply(fs, translateNth(arguments, 0, path));
     }
 
+    var options = readdirOptions(options_, true);
+
+    if (!options) {
+      return ancestor.readdir.apply(fs, arguments);
+    }
+
     var callback = dezalgo(maybeCallback(arguments));
-    readdirFromSnapshot(path, isRoot, callback);
+    readdirFromSnapshot(path, isRoot, function (error, entries) {
+      if (error) return callback(error);
+      if (options.withFileTypes) entries = getFileTypes(path, entries);
+      callback(null, entries);
+    });
   };
 
   // ///////////////////////////////////////////////////////////////

test/test-50-fs-runtime-layer-2/main.js

@@ -57,6 +57,9 @@ right = right.split('\n');
 // right may have less lines, premature exit,
 // less trusted, so using left.length here
 for (let i = 0; i < left.length; i += 1) {
+  // TODO remove when latest node12 lands pkg-fetch
+  if (left[i] === 'The "fd" argument must be of type number. Received type string (\'incorrect fd as string\')' &&
+      right[i] === 'The "fd" argument must be of type number. Received type string') continue;
   assert.equal(left[i], right[i]);
 }