smart-home-engine 0.23.3 → 0.24.0

package/src/index.js

@@ -27,12 +27,12 @@ if (process.argv.includes('--install')) {
 
 // Resolve --data-dir early so that storage.js and config.js both see the correct
 // data root when they are first require()'d below.
-;(function () {
+(function () {
     const idx = process.argv.indexOf('--data-dir');
     if (idx !== -1 && process.argv[idx + 1] && !process.argv[idx + 1].startsWith('-')) {
         process.env.SHE_DATA_DIR = process.argv[idx + 1];
     }
-}());
+})();
 
 // Ensure the data directory exists before anything else runs
 require('./lib/storage').ensureRoot();
@@ -73,6 +73,21 @@ const log = {
 const config = require('./config.js');
 const pkg = require('../package.json');
 
+/**
+ * Build a short log label for a script file.
+ * Uses the path relative to the configured script dir(s) when possible,
+ * falling back to the bare filename for files outside the script dir.
+ */
+function makeLabel(filePath) {
+    const normalized = filePath.replace(/\\/g, '/');
+    const dirs = config.dir ? (Array.isArray(config.dir) ? config.dir : [config.dir]) : [];
+    for (const d of dirs) {
+        const rel = path.relative(d, normalized).replace(/\\/g, '/');
+        if (!rel.startsWith('..')) return rel + ':';
+    }
+    return path.basename(normalized) + ':';
+}
+
 log.setLevel(['debug', 'info', 'warn', 'error'].indexOf(config.verbosity) === -1 ? 'info' : config.verbosity);
 log.info('she ' + pkg.version + ' starting');
 log.debug('loaded config: ', config);
@@ -296,9 +311,9 @@ if (config.url) {
     const _mqttOpts = { will: { topic: config.name + '/connected', payload: '0', retain: true } };
     if (config.mqttUsername) _mqttOpts.username = config.mqttUsername;
     if (config.mqttPassword) _mqttOpts.password = config.mqttPassword;
-    if (config.mqttCa)   _mqttOpts.ca   = config.mqttCa;
+    if (config.mqttCa) _mqttOpts.ca = config.mqttCa;
     if (config.mqttCert) _mqttOpts.cert = config.mqttCert;
-    if (config.mqttKey)  _mqttOpts.key  = config.mqttKey;
+    if (config.mqttKey) _mqttOpts.key = config.mqttKey;
     mqtt = modules.mqtt.connect(config.url, _mqttOpts);
     mqtt.publish(config.name + '/connected', '2', { retain: true });
 
@@ -497,18 +512,19 @@ function setVariable(name, val) {
 }
 
 function createScript(source, name) {
-    log.debug(name, 'compiling');
+    const compileLabel = makeLabel(name);
+    log.debug(compileLabel, 'compiling');
     try {
         return new vm.Script(source, { filename: name });
     } catch (err) {
-        log.error(name, err.name + ':', err.message);
+        log.error(compileLabel, err.name + ':', err.message);
         return false;
     }
 }
 
 function runScript(script, name, origin) {
     const scriptDir = path.dirname(path.resolve(name));
-    const logLabel = (origin || 'user') + '::' + path.basename(name) + ':';
+    const logLabel = makeLabel(name);
 
     // Initialise per-script resource tracking
     if (!scriptJobs.has(name)) scriptJobs.set(name, []);
@@ -521,6 +537,10 @@ function runScript(script, name, origin) {
 
     log.debug(logLabel, 'creating sandbox');
 
+    function serializeArg(a) {
+        return a !== null && typeof a === 'object' ? JSON.stringify(a) : a;
+    }
+
     const she = {
         global: _global,
 
@@ -530,7 +550,7 @@ function runScript(script, name, origin) {
          * @param {...*}
          */
         debug(...args) {
-            log.debug(logLabel, ...args);
+            log.debug(logLabel, ...args.map(serializeArg));
         },
         /**
          * Log an info message
@@ -538,7 +558,7 @@ function runScript(script, name, origin) {
          * @param {...*}
          */
         info(...args) {
-            log.info(logLabel, ...args);
+            log.info(logLabel, ...args.map(serializeArg));
         },
         /**
          * Log a warning message
@@ -546,7 +566,7 @@ function runScript(script, name, origin) {
          * @param {...*}
          */
         warn(...args) {
-            log.warn(logLabel, ...args);
+            log.warn(logLabel, ...args.map(serializeArg));
         },
         /**
          * Log an error message
@@ -554,7 +574,7 @@ function runScript(script, name, origin) {
          * @param {...*}
          */
         error(...args) {
-            log.error(logLabel, ...args);
+            log.error(logLabel, ...args.map(serializeArg));
         },
 
         /**
@@ -980,7 +1000,7 @@ function runScript(script, name, origin) {
         md(she, { scriptDomain, scriptName, scriptFile: name });
     });
 
-    log.debug(name, 'contextifying sandbox');
+    log.debug(logLabel, 'contextifying sandbox');
     const context = vm.createContext(Sandbox);
 
     scriptDomain.on('error', (e) => {
@@ -1004,12 +1024,28 @@ function runScript(script, name, origin) {
         log.debug(logLabel, 'running');
         script.runInContext(context);
     });
+
+    // Log a summary of what was registered — symmetric with the unload summary
+    const registeredCallbacks =
+        subscriptions.filter((s) => s._script === name).length +
+        varSubscriptions.filter((s) => s._script === name).length +
+        mqttEventCallbacks.filter((c) => c._script === name).length;
+    const registeredTimers =
+        _myJobs.length +
+        sunEvents.filter((e) => e._script === name).length +
+        _myTimers.size;
+    if (registeredCallbacks > 0 || registeredTimers > 0) {
+        const parts = [];
+        if (registeredCallbacks > 0) parts.push(`${registeredCallbacks} callback${registeredCallbacks !== 1 ? 's' : ''}`);
+        if (registeredTimers > 0) parts.push(`${registeredTimers} timer${registeredTimers !== 1 ? 's' : ''}`);
+        log.debug(logLabel, `registered ${parts.join(' and ')}`);
+    }
 }
 
 function loadScript(file, origin) {
     origin = origin || 'user';
     file = file.replace(/\\/g, '/');
-    const loadLabel = (origin || 'user') + '::' + path.basename(file) + ':';
+    const loadLabel = makeLabel(file);
     if (scripts[file]) {
         log.error(loadLabel, 'already loaded?!');
         return;
@@ -1037,7 +1073,7 @@ function loadScript(file, origin) {
 function unloadScript(file) {
     file = file.replace(/\\/g, '/');
     const origin = scriptOrigins.get(file) || 'user';
-    const unloadLabel = (origin || 'user') + '::' + path.basename(file) + ':';
+    const unloadLabel = makeLabel(file);
     log.info(unloadLabel, 'unloading');
     scriptOrigins.delete(file);
 
@@ -1046,12 +1082,18 @@ function unloadScript(file) {
 
     // Remove MQTT subscriptions belonging to this script
     for (let i = subscriptions.length - 1; i >= 0; i--) {
-        if (subscriptions[i]._script === file) { subscriptions.splice(i, 1); removedCallbacks++; }
+        if (subscriptions[i]._script === file) {
+            subscriptions.splice(i, 1);
+            removedCallbacks++;
+        }
     }
 
     // Remove MQTT event callbacks (connect/disconnect) belonging to this script
     for (let i = mqttEventCallbacks.length - 1; i >= 0; i--) {
-        if (mqttEventCallbacks[i]._script === file) { mqttEventCallbacks.splice(i, 1); removedCallbacks++; }
+        if (mqttEventCallbacks[i]._script === file) {
+            mqttEventCallbacks.splice(i, 1);
+            removedCallbacks++;
+        }
     }
 
     // Remove HTTP routes registered by this script via she.api
@@ -1158,7 +1200,7 @@ function loadSandbox(callback) {
                 sandboxWatcher.on('ready', () => log.debug('watch', dir, 'initialized'));
                 sandboxWatcher.on('all', (event, filePath) => {
                     sandboxWatcher.close();
-                    log.info(filePath, 'sandbox change detected. exiting.');
+                    log.info(makeLabel(filePath), 'sandbox change detected. exiting.');
                     process.exit(0);
                 });
             }
@@ -1290,9 +1332,9 @@ function loadDir(dir) {
             // .shelib marker changes - warn only, manual restart required
             if (basename === '.shelib') {
                 if (event === 'add') {
-                    log.warn(filePath, 'library marker added - .js files in this directory will no longer load as scripts after daemon restart');
+                    log.warn(makeLabel(filePath), 'library marker added - .js files in this directory will no longer load as scripts after daemon restart');
                 } else if (event === 'unlink') {
-                    log.warn(filePath, 'library marker removed - .js files in this directory will load as scripts after daemon restart');
+                    log.warn(makeLabel(filePath), 'library marker removed - .js files in this directory will load as scripts after daemon restart');
                 }
                 return;
             }
@@ -1312,32 +1354,33 @@ function loadDir(dir) {
                 return;
             }
 
+            const fileLabel = makeLabel(filePath);
             if (event === 'change' && filePath.endsWith('.js')) {
                 if (isLibFile(filePath, dir)) {
-                    log.warn(filePath, 'is a library file - scripts that require() it will see the old version until they or the daemon are restarted');
+                    log.warn(fileLabel, 'is a library file - scripts that require() it will see the old version until they or the daemon are restarted');
                     return;
                 }
                 if (isDisabledPath(filePath) || isInDisabledDir(filePath, dir)) {
-                    log.debug(filePath, 'is disabled - ignoring change');
+                    log.debug(fileLabel, 'is disabled - ignoring change');
                     return;
                 }
-                log.info(filePath, 'change detected. hot-reloading.');
+                log.info(fileLabel, 'change detected. hot-reloading.');
                 unloadScript(filePath);
                 loadScript(filePath);
             } else if (event === 'add' && filePath.endsWith('.js')) {
                 if (isLibFile(filePath, dir)) {
-                    log.debug(filePath, 'is a library file - not loading as script');
+                    log.debug(fileLabel, 'is a library file - not loading as script');
                     return;
                 }
                 if (isDisabledPath(filePath) || isInDisabledDir(filePath, dir)) {
-                    log.debug(filePath, 'is disabled - not loading as script');
+                    log.debug(fileLabel, 'is disabled - not loading as script');
                     return;
                 }
-                log.info(filePath, 'added. loading.');
+                log.info(fileLabel, 'added. loading.');
                 loadScript(filePath);
             } else if (event === 'unlink' && filePath.endsWith('.js')) {
                 if (scripts[filePath]) {
-                    log.info(filePath, 'removed. unloading.');
+                    log.info(fileLabel, 'removed. unloading.');
                     unloadScript(filePath);
                 }
             }

package/src/web/deps-api.js

@@ -164,6 +164,11 @@ router.get('/search', (req, res) => {
                         obj.package.links?.homepage ||
                         obj.package.links?.npm ||
                         `https://www.npmjs.com/package/${encodeURIComponent(obj.package.name)}`,
+                    author:
+                        obj.package.publisher?.username ||
+                        obj.package.author?.name ||
+                        (obj.package.maintainers?.[0]?.username ?? null),
+                    date: obj.package.date ?? null,
                 }));
                 res.json(results);
             } catch {

package/src/web/git-api.js

@@ -70,13 +70,26 @@ router.get('/status', async (req, res) => {
         const [statusOut, branchOut] = await Promise.all([git(['status', '--porcelain', '-u'], gitRoot), git(['rev-parse', '--abbrev-ref', 'HEAD'], gitRoot)]);
 
         const branch = branchOut.stdout.trim();
+
+        // Compute the path of scriptDir relative to gitRoot (forward slashes)
+        // so returned file paths are relative to scriptDir, matching the frontend tree.
+        const scriptRelToRoot = path.relative(gitRoot, scriptDir).replace(/\\/g, '/');
+
         const changes = statusOut.stdout
             .split('\n')
             .filter(Boolean)
-            .map((line) => ({
-                status: line.slice(0, 2).trim(),
-                file: line.slice(3),
-            }));
+            .map((line) => {
+                let file = line.slice(3);
+                if (scriptRelToRoot) {
+                    if (file.startsWith(scriptRelToRoot + '/')) {
+                        file = file.slice(scriptRelToRoot.length + 1);
+                    } else {
+                        return null; // outside scriptDir
+                    }
+                }
+                return { status: line.slice(0, 2).trim(), file };
+            })
+            .filter(Boolean);
 
         let ahead = 0;
         let behind = 0;

package/src/web/scripts-api.js

@@ -46,6 +46,7 @@ function walk(dir, base, parentIsLib) {
     for (const entry of entries) {
         if (entry.name === '.shelib') continue;
         if (entry.name.startsWith('.shedisable-')) continue;
+        if (entry.isDirectory() && entry.name.startsWith('.')) continue;
         const rel = base ? `${base}/${entry.name}` : entry.name;
         if (entry.isDirectory()) {
             results.push(...walk(path.join(dir, entry.name), rel, lib));
@@ -75,6 +76,7 @@ function buildTree(dir, base, parentIsLib) {
     for (const entry of entries) {
         if (entry.name === '.shelib') continue;
         if (entry.name.startsWith('.shedisable-')) continue;
+        if (entry.isDirectory() && entry.name.startsWith('.')) continue;
         const rel = base ? `${base}/${entry.name}` : entry.name;
         const abs = path.join(dir, entry.name);
         if (entry.isDirectory()) {