feat: fs.mkdir, fs.mkdirs api and tests for node ws apis working

Author: abose

README.md

@@ -566,7 +566,7 @@ Creates a directory at given path. Not that the parent dir should exist for this
 
 - **Parameters:**
   - `path` _(string)_ - The path where the directory should be created.
-  - `mode` _(number|function)_ (Optional, default: `0o777`) - The directory permissions.
+  - `mode` _(number|function)_ (Optional, default: `0o666`) - The directory permissions.
   - `callback` _(function)_ (Optional) - Callback to execute once directory creation is done. Called with an error as the first argument on failure, and null on success.
 
 - **Examples:**
@@ -591,7 +591,7 @@ Creates a directory with optional mode and recursion (create all intermediate di
 
 - **Parameters:**
   - `path` _(string)_ - The path where the directory should be created.
-  - `mode` _(number|function)_ (Optional, default: `0o777`) - The directory permissions.
+  - `mode` _(number|function)_ (Optional, default: `0o666`) - The directory permissions.
   - `recursive` _(boolean|function)_ (Optional, default: `false`) - Whether to create directories recursively.
   - `callback` _(function)_ (Optional) - Callback to execute once directory creation is done. Called with an error as the first argument on failure, and null on success.
 
@@ -836,6 +836,7 @@ Writes data to a file, replacing the file if it already exists.
   - If provided as an `object`, it can have the following properties:
     - `encoding` (`string`): The type of encoding. Default is `'binary'`.
     - `flag` (`string`): The file system flag. Default is `'w'`.
+    - `mode` (`number`): (Optional, default: `0o666`) - The permissions.
 
 - **callback**: (`function`)
   - The callback function executed once the file write operation concludes.

dist/phoenix-fs.js

@@ -106,7 +106,8 @@ const WS_COMMAND = {
     READ_DIR: "readDir",
     STAT: "stat",
     READ_BIN_FILE: "readBinFile",
-    WRITE_BIN_FILE: "writeBinFile"
+    WRITE_BIN_FILE: "writeBinFile",
+    MKDIR: "mkdir"
 };
 
 const LARGE_DATA_THRESHOLD = 2*1024*1024; // 2MB
@@ -229,8 +230,20 @@ function _readBinaryFile(ws, metadata) {
  * @private
  */
 function _writeBinaryFile(ws, metadata, dataBuffer) {
-    const fullPath = metadata.data.path;
-    fs.writeFile(fullPath, Buffer.from(dataBuffer))
+    const fullPath = metadata.data.path,
+        mode = metadata.data.mode,
+        flag = metadata.data.flag;
+    fs.writeFile(fullPath, Buffer.from(dataBuffer), {mode, flag})
+        .then( ()=> {
+            _sendResponse(ws, metadata);
+        }).catch((err)=>_reportError(ws, metadata, err, `Failed to write file at path ${fullPath}`));
+}
+
+function _mkdir(ws, metadata, dataBuffer) {
+    const fullPath = metadata.data.path,
+        recursive = metadata.data.recursive,
+        mode = metadata.data.mode;
+    fs.mkdir(fullPath, {recursive, mode})
         .then( ()=> {
             _sendResponse(ws, metadata);
         }).catch((err)=>_reportError(ws, metadata, err, `Failed to write file at path ${fullPath}`));
@@ -260,6 +273,9 @@ function processWSCommand(ws, metadata, dataBuffer) {
         case WS_COMMAND.WRITE_BIN_FILE:
             _writeBinaryFile(ws, metadata, dataBuffer);
             return;
+        case WS_COMMAND.MKDIR:
+            _mkdir(ws, metadata, dataBuffer);
+            return;
         case WS_COMMAND.LARGE_DATA_SOCKET_ANNOUNCE:
             console.log("Large Data Transfer Socket established, socket Group: ", metadata.socketGroupID);
             ws.isLargeData = true;

dist/virtualfs.js

@@ -106,7 +106,8 @@ const WS_COMMAND = {
     READ_DIR: "readDir",
     STAT: "stat",
     READ_BIN_FILE: "readBinFile",
-    WRITE_BIN_FILE: "writeBinFile"
+    WRITE_BIN_FILE: "writeBinFile",
+    MKDIR: "mkdir"
 };
 
 const LARGE_DATA_THRESHOLD = 2*1024*1024; // 2MB
@@ -229,8 +230,20 @@ function _readBinaryFile(ws, metadata) {
  * @private
  */
 function _writeBinaryFile(ws, metadata, dataBuffer) {
-    const fullPath = metadata.data.path;
-    fs.writeFile(fullPath, Buffer.from(dataBuffer))
+    const fullPath = metadata.data.path,
+        mode = metadata.data.mode,
+        flag = metadata.data.flag;
+    fs.writeFile(fullPath, Buffer.from(dataBuffer), {mode, flag})
+        .then( ()=> {
+            _sendResponse(ws, metadata);
+        }).catch((err)=>_reportError(ws, metadata, err, `Failed to write file at path ${fullPath}`));
+}
+
+function _mkdir(ws, metadata, dataBuffer) {
+    const fullPath = metadata.data.path,
+        recursive = metadata.data.recursive,
+        mode = metadata.data.mode;
+    fs.mkdir(fullPath, {recursive, mode})
         .then( ()=> {
             _sendResponse(ws, metadata);
         }).catch((err)=>_reportError(ws, metadata, err, `Failed to write file at path ${fullPath}`));
@@ -260,6 +273,9 @@ function processWSCommand(ws, metadata, dataBuffer) {
         case WS_COMMAND.WRITE_BIN_FILE:
             _writeBinaryFile(ws, metadata, dataBuffer);
             return;
+        case WS_COMMAND.MKDIR:
+            _mkdir(ws, metadata, dataBuffer);
+            return;
         case WS_COMMAND.LARGE_DATA_SOCKET_ANNOUNCE:
             console.log("Large Data Transfer Socket established, socket Group: ", metadata.socketGroupID);
             ws.isLargeData = true;

dist/virtualfs.js.map

@@ -36,7 +36,8 @@ const WS_COMMAND = {
     READ_DIR: "readDir",
     STAT: "stat",
     READ_BIN_FILE: "readBinFile",
-    WRITE_BIN_FILE: "writeBinFile"
+    WRITE_BIN_FILE: "writeBinFile",
+    MKDIR: "mkdir"
 };
 
 // each browser context belongs to a single socket group. So multiple websocket connections can be pooled
@@ -383,24 +384,37 @@ function readBinaryFile(path) {
     });
 }
 
-function writeBinaryFile(path, dataArrayBuffer) {
+function writeBinaryFile(path, mode, flag, dataArrayBuffer) {
     return new Promise((resolve, reject)=>{
         const platformPath = Utils.getTauriPlatformPath(path);
-        _execCommand(WS_COMMAND.WRITE_BIN_FILE, {path: platformPath}, dataArrayBuffer)
+        _execCommand(WS_COMMAND.WRITE_BIN_FILE, {path: platformPath, mode, flag}, dataArrayBuffer)
             .then(resolve)
             .catch((err)=>{
                 reject(mapNodeTauriErrorMessage(err, path, 'Failed to write file: '));
             });
     });
 }
 
+function mkdirs(path, mode, recursive, callback) {
+    const platformPath = Utils.getTauriPlatformPath(path);
+    _execCommand(WS_COMMAND.MKDIR, {path: platformPath, mode, recursive})
+        .then(()=>{
+            console.log("dir created: ", platformPath);
+            callback(null);
+        })
+        .catch((err)=>{
+            callback(mapNodeTauriErrorMessage(err, path, 'Failed to mkdir: '));
+        });
+}
+
 const NodeTauriFS = {
     testNodeWsEndpoint,
     setNodeWSEndpoint,
     stopNodeWSEndpoint,
     getNodeWSEndpoint,
     isNodeWSReady,
     readdir,
+    mkdirs,
     stat,
     readBinaryFile,
     writeBinaryFile

src-tauri/node-src/phoenix-fs.js

@@ -285,8 +285,8 @@ function readdir(path, options, callback) {
  * Creates a directory with optional mode and recursion(create all intermediate directories if those don't exist).
  *
  * @param {string} path - The path where the directory should be created.
- * @param {(number|function)} [mode=0o777] - The directory permissions. Defaults to `0o777` if not provided.
- * @param {(boolean|function)} [recursive=false] - Whether to create directories recursively. Defaults to `false` if not provided.
+ * @param {(number)} [mode=0o666] - The directory permissions. Defaults to `0o666` if not provided.
+ * @param {(boolean)} [recursive=false] - Whether to create directories recursively. Defaults to `false` if not provided.
  * @param {function} [callback] - Callback to execute once directory creation is done. Called with an error as the first argument on failure, and null on success.
  *
  * @example
@@ -309,7 +309,7 @@ function mkdirs(path, mode, recursive, callback) {
     if (typeof mode !== 'number') {
         callback = recursive;
         recursive = mode;
-        mode = 0o777; // Default mode (or any other default you'd like to set)
+        mode = 0o666; // Default mode (or any other default you'd like to set)
     }
 
     // Determine if 'recursive' is provided
@@ -325,6 +325,11 @@ function mkdirs(path, mode, recursive, callback) {
         };
     }
 
+    if(!window.__TAURI__ || forceNodeWs || (preferNodeWs && NodeTauriFS.isNodeWSReady())) {
+        NodeTauriFS.mkdirs(path, mode, recursive, callback);
+        return;
+    }
+
     let platformPath = Utils.getTauriPlatformPath(path);
     __TAURI__.fs.createDir(platformPath,  {recursive})
         .then(()=>{
@@ -527,6 +532,7 @@ function readFile(path, options, callback) {
  *   - If provided as an `object`, it can have the following keys:
  *     - `encoding` (string): The type of encoding. Default is `'binary'`.
  *     - `flag` (string): The file system flag. Default is `'w'`.
+ *     - `mode`- The permissions. Defaults to `0o666` if not provided.
  * @param {function} callback - The callback function to execute once the file write operation concludes.
  *   - The callback receives one argument:
  *     1. An error object (or null if there were no errors).
@@ -564,7 +570,7 @@ function writeFile (path, data, options, callback) {
             arrayBuffer = Utils.getEncodedArrayBuffer(data, options.encoding);
         }
         if(!window.__TAURI__ || forceNodeWs || (preferNodeWs && NodeTauriFS.isNodeWSReady())) {
-            NodeTauriFS.writeBinaryFile(path, arrayBuffer)
+            NodeTauriFS.writeBinaryFile(path, options.mode || 0o666, options.flag, arrayBuffer)
                 .then(() => {
                     callback(null);
                 })
@@ -626,15 +632,15 @@ const TauriFS = {
     getTauriVirtualPath: Utils.getTauriVirtualPath,
     openTauriFilePickerAsync,
     openTauriFileSaveDialogueAsync,
+    forceUseNodeWSEndpoint,
+    preferNodeWSEndpoint,
     stat,
     readdir,
     mkdirs,
     rename,
     unlink,
     readFile,
-    writeFile,
-    forceUseNodeWSEndpoint,
-    preferNodeWSEndpoint
+    writeFile
 };
 
 module.exports ={

src/fslib_node_ws.js

@@ -65,7 +65,7 @@ function _setupTests(testType) {
         console.log(`mkdirs: `, testPath);
         let mkdirResolve;
         const mkdirPromise = new Promise((resolve) => {mkdirResolve = resolve;});
-        fs.mkdirs(testPath, 777 ,true, ()=>{
+        fs.mkdirs(testPath, 0o777 ,true, ()=>{
             mkdirResolve();
         });
         await mkdirPromise;
@@ -172,7 +172,7 @@ function _setupTests(testType) {
     it(`Should phoenix ${testType} mkdir(path,mode, cb) in browser if it doesnt exist`, async function () {
         let createSuccess = false;
         const dirPathToCreate = `${testPath}/testDir1`;
-        fs.mkdir(dirPathToCreate, 777, (err)=>{
+        fs.mkdir(dirPathToCreate, 0o777, (err)=>{
             if(!err){
                 createSuccess = true;
             }
@@ -198,7 +198,7 @@ function _setupTests(testType) {
     it(`Should phoenix fail ${testType} mkdir(path,mode, cb) if already exists`, async function () {
         let dirPathCreated = await _writeTestDir();
         let error;
-        fs.mkdir(dirPathCreated, 777, (err)=>{
+        fs.mkdir(dirPathCreated, 0o777, (err)=>{
             error = err;
         });
         await waitForTrue(()=>{return !!error;},1000);
@@ -208,7 +208,7 @@ function _setupTests(testType) {
     it(`Should phoenix ${testType} mkdirs(path,mode, recursive, cb) even if exists`, async function () {
         let dirPathCreated = await _writeTestDir();
         let success, error;
-        fs.mkdirs(dirPathCreated, 777, true, (err)=>{
+        fs.mkdirs(dirPathCreated, 0o777, true, (err)=>{
             error = err;
             success = true;
         });
@@ -221,7 +221,7 @@ function _setupTests(testType) {
         let dirPathCreated = await _writeTestDir();
         let pathToCreate = `${dirPathCreated}/path/that/doesnt/exist`;
         let success, error;
-        fs.mkdirs(pathToCreate, 777, true, (err)=>{
+        fs.mkdirs(pathToCreate, 0o777, true, (err)=>{
             error = err;
             success = true;
         });
@@ -247,7 +247,7 @@ function _setupTests(testType) {
         let dirPathCreated = await _writeTestDir();
         let pathToCreate = `${dirPathCreated}/path/that/doesnt/exist`;
         let error;
-        fs.mkdirs(pathToCreate, 777, (err)=>{
+        fs.mkdirs(pathToCreate, 0o777, (err)=>{
             error = err;
         });
         await waitForTrue(()=>{return !!error;},1000);

src/fslib_tauri.js

@@ -73,7 +73,7 @@ function _setupTests(testType) {
         await _clean();
         console.log(`mkdir: `, testPath);
         let cleanSuccess = false;
-        fs.mkdirs(testPath, 777 ,true, ()=>{
+        fs.mkdirs(testPath, 0o777 ,true, ()=>{
             cleanSuccess = true;
         });
         await waitForTrue(()=>{return cleanSuccess;},10000);