feat: adding withFileTypes option to fs.readdir native api

Author: abose

dist/virtualfs.js

@@ -27,11 +27,15 @@ const {Constants} = require('./constants');
 const {Utils} =require('./utils');
 
 
-async function _listDir(handle, callback) {
+async function _listDir(path, handle, options, callback) {
     let dirEntryNames = [];
     try {
-        for await (const [key] of handle.entries()) {
-            dirEntryNames.push(key);
+        for await (const [key, value] of handle.entries()) {
+            let entry = key;
+            if(options['withFileTypes']){
+                entry = await Utils.createStatObject(globalObject.path.join(path, key), value);
+            }
+            dirEntryNames.push(entry);
         }
         if(callback){
             callback(null, dirEntryNames);
@@ -85,10 +89,10 @@ function mkdir(path, mode, callback) {
 
 function readdir(path, options, callback) {
     path = globalObject.path.normalize(path);
-    if (typeof options !== 'function') {
-        throw new Errors.ENOSYS('Filer readdir options are not yet supported');
+    if (typeof options === 'function') {
+        callback = options;
+        options = {};
     }
-    callback = options;
 
     if(path === Constants.MOUNT_POINT_ROOT ) {
         let mountedFolders = Object.keys(Mounts.getMountPoints());
@@ -100,7 +104,7 @@ function readdir(path, options, callback) {
             } else if (handle.kind === Constants.KIND_FILE) {
                 callback(new Errors.ENOTDIR('Path is not a directory.'));
             }else {
-                _listDir(handle, callback);
+                _listDir(path, handle, options, callback);
             }
         });
     }

dist/virtualfs.js.map

@@ -54,6 +54,32 @@ describe('Browser main tests', function () {
         expect(readSuccess).to.be.true;
     });
 
+    it('Should phoenix native read dir', async function () {
+        let readSuccess = false, contentsRead;
+        fs.readdir(`${window.mountTestPath}`, (err, contents)=>{
+            if(!err){
+                readSuccess = true;
+            }
+            contentsRead = contents;
+        });
+        await waitForTrue(()=>{return readSuccess;},1000);
+        expect(readSuccess).to.be.true;
+        expect(contentsRead.length).to.be.above(1);
+    });
+
+    it('Should phoenix native read dir with withFileTypes', async function () {
+        let readSuccess = false, contentsRead;
+        fs.readdir(`${window.mountTestPath}`, {withFileTypes: true} , (err, contents)=>{
+            if(!err){
+                readSuccess = true;
+            }
+            contentsRead = contents;
+        });
+        await waitForTrue(()=>{return readSuccess;},1000);
+        expect(readSuccess).to.be.true;
+        expect(contentsRead[0].type).to.exist;
+    });
+
     it('Should phoenix native delete in browser', async function () {
         let delSuccess = false;
         fs.unlink(`${window.mountTestPath}/browserWrite.txt`, (err)=>{

src/fslib_native.js

@@ -72,6 +72,13 @@ describe('web worker tests', function () {
         expect(status).to.be.true;
     });
 
+    it('Should phoenix native read dir withFileTypes in worker', async function () {
+        messageFromWorker = null;
+        worker.postMessage('readDirMountCheck');
+        let status = await waitForWorkerMessage('readDirMountCheck.ok', 1000);
+        expect(status).to.be.true;
+    });
+
     it('Should phoenix native delete in worker', async function () {
         messageFromWorker = null;
         worker.postMessage('deleteMountCheck');

test/test.browser.js

@@ -38,6 +38,17 @@ function checkReadInMountPath() {
     });
 }
 
+function checkReadDirInMountPath() {
+    console.log('worker: checkReadDirInMountPath');
+    fs.readdir(`${mountTestPath}`, {withFileTypes: true} , (err, contents)=>{
+        if(!err && contents[0].type){
+            postMessage('readDirMountCheck.ok');
+            return;
+        }
+        console.log('file read:', err, contents);
+    });
+}
+
 function checkDeleteInMountPath() {
     console.log('worker: checkDeleteInMountPath');
     fs.unlink(`${mountTestPath}/workerWrite.txt`,  (err)=>{
@@ -58,6 +69,7 @@ self.addEventListener('message', (event) => {
     case 'writeMountCheck': checkWriteInMountPath(); break;
     case 'readMountCheck': checkReadInMountPath(); break;
     case 'deleteMountCheck': checkDeleteInMountPath(); break;
+    case 'readDirMountCheck': checkReadDirInMountPath(); break;
     default: console.error('unknown worker command: ', command);
     }
 }, false);