Implement FS Driver, to better handle PKG paths

Author: marcus-j-davies

PSI/PKGFSDriver.js

@@ -0,0 +1,89 @@
+const { fs: nodeFs } = require('@zwave-js/core/bindings/fs/node');
+const path = require('path');
+
+const CONFIG_PATH = path.resolve(__filename, '/config');
+const CONFIG_PATH_IN_PKG = path.join(__dirname, `node_modules/@zwave-js/config/config`);
+
+class PKGFSDriver {
+	readFile(filePath) {
+		filePath = path.normalize(filePath);
+		if (filePath.startsWith(CONFIG_PATH)) {
+			filePath = filePath.replace(CONFIG_PATH, CONFIG_PATH_IN_PKG);
+		}
+		return nodeFs.readFile(filePath);
+	}
+
+	writeFile(filePath, data) {
+		filePath = path.normalize(filePath);
+		if (filePath.startsWith(CONFIG_PATH)) {
+			// The pkg assets are readonly
+			return;
+		}
+		return nodeFs.writeFile(filePath, data);
+	}
+
+	copyFile(source, dest) {
+		source = path.normalize(source);
+		dest = path.normalize(dest);
+		if (dest.startsWith(CONFIG_PATH)) {
+			// The pkg assets are readonly
+			return;
+		}
+		if (source.startsWith(CONFIG_PATH)) {
+			source = source.replace(CONFIG_PATH, CONFIG_PATH_IN_PKG);
+		}
+		return nodeFs.copyFile(source, dest);
+	}
+
+	open(filePath, flags) {
+		filePath = path.normalize(filePath);
+		if (filePath.startsWith(CONFIG_PATH) && flags.write) {
+			// The pkg assets are readonly
+			throw new Error(`${filePath} is not writable`);
+		}
+		if (filePath.startsWith(CONFIG_PATH)) {
+			filePath = filePath.replace(CONFIG_PATH, CONFIG_PATH_IN_PKG);
+		}
+		return nodeFs.open(filePath, flags);
+	}
+
+	readDir(dirPath) {
+		dirPath = path.normalize(dirPath);
+		if (dirPath.startsWith(CONFIG_PATH)) {
+			dirPath = dirPath.replace(CONFIG_PATH, CONFIG_PATH_IN_PKG);
+		}
+		return nodeFs.readDir(dirPath);
+	}
+
+	stat(filePath) {
+		filePath = path.normalize(filePath);
+		if (filePath.startsWith(CONFIG_PATH)) {
+			filePath = filePath.replace(CONFIG_PATH, CONFIG_PATH_IN_PKG);
+		}
+		return nodeFs.stat(filePath);
+	}
+
+	ensureDir(dirPath) {
+		dirPath = path.normalize(dirPath);
+		if (dirPath.startsWith(CONFIG_PATH)) {
+			// The pkg assets are readonly
+			return;
+		}
+		return nodeFs.ensureDir(dirPath);
+	}
+
+	deleteDir(dirPath) {
+		dirPath = path.normalize(dirPath);
+		if (dirPath.startsWith(CONFIG_PATH)) {
+			// The pkg assets are readonly
+			return;
+		}
+		return nodeFs.deleteDir(dirPath);
+	}
+
+	makeTempDir(prefix) {
+		return nodeFs.makeTempDir(prefix);
+	}
+}
+
+module.exports = { PKGFSDriver };

PSI/esb.js

@@ -56,7 +56,6 @@ const run = async () => {
 
 	const patchedServer = (await readFile(outfile, 'utf-8'))
 		.replace(/__dirname, "\.\.\/"/g, '__dirname, "./node_modules/@serialport/bindings-cpp"')
-		.replace('"../.."', '"./node_modules/@zwave-js/config"')
 		.replace('../../package.json', './node_modules/@zwave-js/server/package.json');
 
 	await writeFile(outfile, patchedServer);

PSI/server_source.js

@@ -1,9 +1,13 @@
 const { Driver } = require('zwave-js');
 const { ZwavejsServer } = require('@zwave-js/server');
+const { PKGFSDriver } = require('./PKGFSDriver');
 
 const serialPort = process.env.SERIAL_PORT;
 const wsPort = parseInt(process.env.WS_PORT);
 const driverOptions = JSON.parse(process.env.CONFIG);
+driverOptions.host = {
+	fs: new PKGFSDriver()
+};
 let ServerStarted = false;
 let DriverStarted = false;