From 7dfa2b5a19079e561a543c10fc289b9e2c22e0bc Mon Sep 17 00:00:00 2001
From: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Date: Tue, 27 Aug 2019 17:14:27 -0700
Subject: [PATCH] fs: introduce `opendir()` and `fs.Dir`

This adds long-requested methods for asynchronously interacting and
iterating through directory entries by using `uv_fs_opendir`,
`uv_fs_readdir`, and `uv_fs_closedir`.

`fs.opendir()` and friends return an `fs.Dir`, which contains methods
for doing reads and cleanup. `fs.Dir` also has the async iterator
symbol exposed.

The `read()` method and friends only return `fs.Dirent`s for this API.
Having a entry type or doing a `stat` call is deemed to be necessary in
the majority of cases, so just returning dirents seems like the logical
choice for a new api.

Reading when there are no more entries returns `null` instead of a
dirent. However the async iterator hides that (and does automatic
cleanup).

The code lives in separate files from the rest of fs, this is done
partially to prevent over-pollution of those (already very large)
files, but also in the case of js allows loading into `fsPromises`.

Due to async_hooks, this introduces a new handle type of `DIRHANDLE`.

This PR does not attempt to make complete optimization of
this feature. Notable future improvements include:
- Moving promise work into C++ land like FileHandle.
- Possibly adding `readv()` to do multi-entry directory reads.
- Aliasing `fs.readdir` to `fs.scandir` and doing a deprecation.

Refs: https://github.com/nodejs/node-v0.x-archive/issues/388
Refs: https://github.com/nodejs/node/issues/583
Refs: https://github.com/libuv/libuv/pull/2057

PR-URL: https://github.com/nodejs/node/pull/29349
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: David Carlier <devnexen@gmail.com>
---
 lib/internal/fs/promises.js | 54 +++++++++++++++++--------------------
 1 file changed, 25 insertions(+), 29 deletions(-)

diff --git a/lib/internal/fs/promises.js b/lib/internal/fs/promises.js
index cc3f98268c..e0f522bdc1 100644
--- a/lib/internal/fs/promises.js
+++ b/lib/internal/fs/promises.js
@@ -512,33 +512,29 @@ async function readFile(path, options) {
 }
 
 module.exports = {
-  exports: {
-    access,
-    copyFile,
-    open,
-    opendir: promisify(opendir),
-    rename,
-    truncate,
-    rmdir,
-    mkdir,
-    readdir,
-    readlink,
-    symlink,
-    lstat,
-    stat,
-    link,
-    unlink,
-    chmod,
-    lchmod,
-    lchown,
-    chown,
-    utimes,
-    realpath,
-    mkdtemp,
-    writeFile,
-    appendFile,
-    readFile,
-  },
-
-  FileHandle
+  access,
+  copyFile,
+  open,
+  opendir: promisify(opendir),
+  rename,
+  truncate,
+  rmdir,
+  mkdir,
+  readdir,
+  readlink,
+  symlink,
+  lstat,
+  stat,
+  link,
+  unlink,
+  chmod,
+  lchmod,
+  lchown,
+  chown,
+  utimes,
+  realpath,
+  mkdtemp,
+  writeFile,
+  appendFile,
+  readFile
 };