feat: automatically switch to node endpoint when it becomes available with fs.preferNodeWSEndpoint

Author: abose

README.md

@@ -868,3 +868,34 @@ open across failures and automatically reconnects as necessary.
 - **Returns:**
   - Promise<void>
 
+
+### `fs.forceUseNodeWSEndpoint(use)`
+
+Forces the usage of the Node WebSocket endpoint.
+Throws an error if the Node WebSocket endpoint is not set.
+
+- **Parameters**
+  - `use`: Boolean
+    - If `true`, forces the use of the Node WebSocket endpoint.
+
+- **Throws**
+  - Throws an error if the Node WebSocket endpoint has not been set.
+  - Call `fs.setNodeWSEndpoint(websocketEndpoint)` before calling this API.
+
+---
+
+### `fs.preferNodeWSEndpoint(use)`
+
+Sets the preference to use the Node WebSocket endpoint if available.
+Throws an error if the Node WebSocket endpoint is not set.
+If a Node connection is not available, it falls back to Tauri.
+To always force the library to use the Node WebSocket endpoint for all FS APIs, use `fs.forceUseNodeWSEndpoint`.
+
+- **Parameters**
+  - `use`: Boolean
+    - If `true`, prefers the use of the Node WebSocket endpoint when available.
+
+- **Throws**
+  - Throws an error if the Node WebSocket endpoint has not been set.
+  - Call `fs.setNodeWSEndpoint(websocketEndpoint)` before calling this this API.
+

dist/virtualfs.js

@@ -333,6 +333,9 @@ const fileSystemLib = {
     forceUseNodeWSEndpoint: function (use) {
         return TauriFS.forceUseNodeWSEndpoint(use);
     },
+    preferNodeWSEndpoint: function (use) {
+        return TauriFS.preferNodeWSEndpoint(use);
+    },
     BYTE_ARRAY_ENCODING: Constants.BYTE_ARRAY_ENCODING,
     MOUNT_POINT_ROOT: Constants.MOUNT_POINT_ROOT,
     TAURI_ROOT: Constants.TAURI_ROOT,

dist/virtualfs.js.map

@@ -100,6 +100,20 @@ function _isSocketOpen(socket) {
     return socket && socket.readyState === WebSocket.OPEN;
 }
 
+let isNodeWsConnected = false;
+
+/**
+ * Returns true if the node websocket connection is established and ready to take requests.
+ * @returns {boolean}
+ */
+function isNodeWSReady() {
+    return isNodeWsConnected;
+}
+
+function updateConnectionState() {
+    isNodeWsConnected = _isSocketOpen(controlSocket) || _isSocketOpen(dataSocket);
+}
+
 const _pendingCommandQueue = [],
     commandIdMap = {};
 
@@ -188,6 +202,7 @@ async function _establishAndMaintainConnection(socketType, firstConnectCB) {
                     .catch(console.error);
             }
             _execPendingCommands();
+            updateConnectionState();
         });
 
         ws.addEventListener('message', function (event) {
@@ -200,6 +215,7 @@ async function _establishAndMaintainConnection(socketType, firstConnectCB) {
 
         ws.addEventListener('close', function () {
             wsClosePromiseResolve();
+            updateConnectionState();
         });
         await wsClosePromise;
         const backoffTime = Math.min(ws.backoffTime * 2, MAX_RECONNECT_BACKOFF_TIME_MS) || 1;
@@ -383,6 +399,7 @@ const NodeTauriFS = {
     setNodeWSEndpoint,
     stopNodeWSEndpoint,
     getNodeWSEndpoint,
+    isNodeWSReady,
     readdir,
     stat,
     readBinaryFile,

src/fslib.js

@@ -28,7 +28,8 @@ const {NodeTauriFS} = require("./fslib_node_ws");
 
 const TAURI_PATH_PREFIX = Constants.TAURI_ROOT+ '/';
 const IS_WINDOWS = navigator.userAgent.includes('Windows');
-let preferNodeWs = false;
+let preferNodeWs = false,
+    forceNodeWs = false;
 
 /**
  * Check if the given path is a subpath of the '/tauri' folder.
@@ -251,7 +252,7 @@ function readdir(path, options, callback) {
         options = {};
     }
 
-    if(!window.__TAURI__ || preferNodeWs) {
+    if(!window.__TAURI__ || forceNodeWs || (preferNodeWs && NodeTauriFS.isNodeWSReady())) {
         return NodeTauriFS.readdir(path, options, callback);
     }
 
@@ -367,7 +368,7 @@ function mkdirs(path, mode, recursive, callback) {
  */
 function stat(path, callback, options= {}) {
     path = globalObject.path.normalize(path);
-    if(!window.__TAURI__ || preferNodeWs) {
+    if(!window.__TAURI__ || forceNodeWs || (preferNodeWs && NodeTauriFS.isNodeWSReady())) {
         return NodeTauriFS.stat(path, callback, options);
     }
     _getTauriStat(path)
@@ -485,7 +486,7 @@ function readFile(path, options, callback) {
         callback = arguments[arguments.length - 1];
         options = Utils.validateFileOptions(options, Constants.BINARY_ENCODING, 'r');
 
-        if(!window.__TAURI__ || preferNodeWs) {
+        if(!window.__TAURI__ || forceNodeWs || (preferNodeWs && NodeTauriFS.isNodeWSReady())) {
             NodeTauriFS.readBinaryFile(path)
                 .then(contents => {
                     // contents is Array buffer
@@ -562,7 +563,7 @@ function writeFile (path, data, options, callback) {
             }
             arrayBuffer = Utils.getEncodedArrayBuffer(data, options.encoding);
         }
-        if(!window.__TAURI__ || preferNodeWs) {
+        if(!window.__TAURI__ || forceNodeWs || (preferNodeWs && NodeTauriFS.isNodeWSReady())) {
             NodeTauriFS.writeBinaryFile(path, arrayBuffer)
                 .then(() => {
                     callback(null);
@@ -588,7 +589,30 @@ function writeFile (path, data, options, callback) {
     }
 }
 
+/**
+ * Forces the usage of the Node WebSocket endpoint.
+ * Throws an error if the Node WebSocket endpoint is not set.
+ *
+ * @param {boolean} use - If `true`, forces the use of the Node WebSocket endpoint.
+ * @throws {Error} Throws an error if the Node WebSocket endpoint has not been set.
+ */
 function forceUseNodeWSEndpoint(use) {
+    if(!NodeTauriFS.getNodeWSEndpoint()) {
+        throw new Error("Please call fs.setNodeWSEndpoint('ws://your server') before calling this function.");
+    }
+    forceNodeWs = use;
+}
+
+/**
+ * Sets the preference to use the Node WebSocket endpoint if available.
+ * Throws an error if the Node WebSocket endpoint is not set.
+ * If a Node connection is not available, it falls back to Tauri.
+ * To always force the library to use the Node WebSocket endpoint for all FS APIs, use `forceUseNodeWSEndpoint`.
+ *
+ * @param {boolean} use - If `true`, prefers the use of the Node WebSocket endpoint.
+ * @throws {Error} Throws an error if the Node WebSocket endpoint has not been set.
+ */
+function preferNodeWSEndpoint(use) {
     if(!NodeTauriFS.getNodeWSEndpoint()) {
         throw new Error("Please call fs.setNodeWSEndpoint('ws://your server') before calling this function.");
     }
@@ -609,7 +633,8 @@ const TauriFS = {
     unlink,
     readFile,
     writeFile,
-    forceUseNodeWSEndpoint
+    forceUseNodeWSEndpoint,
+    preferNodeWSEndpoint
 };
 
 module.exports ={