signalk-automation-plugin 0.0.5 → 0.0.7

package/lib/engine.js

@@ -37,6 +37,12 @@ function addPathsFromAction (paths, action) {
   if (!action || typeof action !== 'object') return
   if (action.put) paths.add(action.put)
   if (action.valueFrom) paths.add(action.valueFrom)
+  const gate = action.if
+  if (Array.isArray(gate)) {
+    for (const c of gate) addPathsFromClause(paths, c)
+  } else if (gate) {
+    addPathsFromClause(paths, gate)
+  }
 }
 
 function getByPath (values, p) {
@@ -306,6 +312,31 @@ function resultLabel (result) {
   return result === 'failure' ? 'Failed' : 'OK'
 }
 
+function formatStream (text) {
+  const t = String(text == null ? '' : text).replace(/\s+$/, '')
+  if (!t) return '(empty)'
+  if (!t.includes('\n')) return t
+  return '\n' + t.split('\n').map((line) => '      ' + line).join('\n')
+}
+
+function actionStderr (action) {
+  if (action && action.stderr) return String(action.stderr)
+  const err = action && action.error ? String(action.error) : ''
+  if (err.startsWith('stderr: ')) return err.slice(8)
+  return ''
+}
+
+function appendRunActionLines (lines, action) {
+  const extra = (action.args && action.args.length) ? ' ' + action.args.join(' ') : ''
+  lines.push('  run ' + (action.file || '') + extra)
+  lines.push('    stdout: ' + formatStream(action.stdout))
+  lines.push('    stderr: ' + formatStream(actionStderr(action)))
+  const err = action.error ? String(action.error) : ''
+  if (err && !err.startsWith('stderr: ')) {
+    lines.push('    error: ' + err)
+  }
+}
+
 function formatVerboseLog (auto, record) {
   const name = (auto && (auto.alias || auto.id)) || (record && record.id) || 'automation'
   const result = resultLabel(record.result)
@@ -327,6 +358,9 @@ function formatVerboseLog (auto, record) {
       appendClauseLines(lines, c, '    ')
     }
   }
+  for (const a of record.actions || []) {
+    if (a && a.type === 'run') appendRunActionLines(lines, a)
+  }
   return lines.join('\n')
 }
 
@@ -475,6 +509,11 @@ async function evaluateAutomation (auto, ctx) {
   }
 
   for (const action of actions) {
+    if (ctx.abort && ctx.abort.aborted) {
+      record.result = 'ok'
+      record.reason = 'superseded'
+      return finishRecord(auto, record)
+    }
     const ran = await runAction(action, ctx)
     record.actions.push(ran)
     if (!ran.ok) {
@@ -482,6 +521,7 @@ async function evaluateAutomation (auto, ctx) {
       record.reason = ran.error
       return finishRecord(auto, record)
     }
+    if (ran.stop) break
   }
   record.result = 'ok'
   return finishRecord(auto, record)
@@ -491,6 +531,12 @@ async function runAction (action, ctx) {
   if (!action || typeof action !== 'object') {
     return { ok: false, error: 'empty action' }
   }
+  if (action.if) {
+    const gate = await evalListAll(Array.isArray(action.if) ? action.if : [action.if], ctx)
+    if (!gate.pass) {
+      return { ok: true, skipped: true, reason: 'if not met', if: gate.results }
+    }
+  }
   if (action.put) {
     try {
       const value = Object.prototype.hasOwnProperty.call(action, 'valueFrom')
@@ -533,20 +579,46 @@ async function runAction (action, ctx) {
   }
   if (action.delay != null) {
     const ms = parseDuration(action.delay)
-    if (ctx.skipDelay) return { ok: true, type: 'delay', ms, skipped: true }
-    await ctx.sleep(ms)
+    if (ctx.skipDelay) return { ok: true, type: 'delay', ms, skipped: true, stop: true }
+    try {
+      await ctx.sleep(ms)
+    } catch (err) {
+      if (err && err.cancelled) {
+        return { ok: true, type: 'delay', ms, cancelled: true, stop: true }
+      }
+      throw err
+    }
+    if (ctx.abort && ctx.abort.aborted) {
+      return { ok: true, type: 'delay', ms, cancelled: true, stop: true }
+    }
     return { ok: true, type: 'delay', ms }
   }
   if (action.run) {
     const spec = typeof action.run === 'string' ? { file: action.run } : action.run
     const ran = await ctx.runScript(spec)
     if (!ran.ok) {
-      return { ok: false, type: 'run', file: spec.file, error: ran.error, stdout: ran.stdout }
+      return {
+        ok: false,
+        type: 'run',
+        file: spec.file,
+        args: spec.args || [],
+        error: ran.error,
+        stdout: ran.stdout,
+        stderr: ran.stderr || ''
+      }
     }
     if (action.as) {
       ctx.setHelper(action.as, ran.value)
     }
-    return { ok: true, type: 'run', file: spec.file, value: ran.value, stdout: ran.stdout }
+    return {
+      ok: true,
+      type: 'run',
+      file: spec.file,
+      args: spec.args || [],
+      value: ran.value,
+      stdout: ran.stdout,
+      stderr: ran.stderr || ''
+    }
   }
   return { ok: false, error: 'unknown action' }
 }

package/lib/runtime.js

@@ -21,6 +21,7 @@ class Runtime {
     this.sleep = opts.sleep || ((ms) => new Promise((r) => setTimeout(r, ms)))
     this.putFn = opts.put
     this.notifyFn = opts.notify
+    this.onHelper = opts.onHelper || null
     this.log = opts.log || { debug () {}, error () {} }
 
     this.doc = yaml.emptyDoc()
@@ -33,6 +34,7 @@ class Runtime {
     this.lastCronMinute = ''
     this.lastQuantized = {}
     this.unsubscribes = []
+    this.inFlight = {}
   }
 
   load () {
@@ -89,11 +91,20 @@ class Runtime {
         to: coerced,
         changed: true
       })
+      this.emitHelperValue(id, coerced)
       if (!opts || opts.kick !== false) {
         await this.kickPath(helpers.helperPath(id), coerced)
       }
     }
-    return coerced
+    const current = Object.prototype.hasOwnProperty.call(this.helperValues, id)
+      ? this.helperValues[id]
+      : coerced
+    if (!engine.sameValue(current, coerced)) this.emitHelperValue(id, current)
+    return current
+  }
+
+  emitHelperValue (id, value) {
+    if (typeof this.onHelper === 'function') this.onHelper(id, value)
   }
 
   async resetHelper (id) {
@@ -162,16 +173,21 @@ class Runtime {
     const key = d.getFullYear() + '-' + d.getMonth() + '-' + d.getDate() + '-' + d.getHours() + '-' + d.getMinutes()
     if (key === this.lastCronMinute) return
     this.lastCronMinute = key
+    const runs = []
     for (const auto of this.doc.automations) {
       const schedules = (auto.trigger || []).filter((t) => t.schedule)
       if (!schedules.length) continue
       const hit = schedules.some((t) => engine.cronMatch(t.schedule, d))
-      if (hit) await this.maybeRun(auto, { schedule: schedules[0].schedule })
+      if (hit) runs.push(this.maybeRun(auto, { schedule: schedules[0].schedule }))
     }
+    await Promise.all(runs)
   }
 
   async maybeRun (auto, trigger) {
     if (!this.isEnabled(auto)) return
+    const mode = auto.mode || 'parallel'
+    if (mode === 'single' && this.inFlight[auto.id]) return
+    if (mode === 'restart' && this.inFlight[auto.id]) this.inFlight[auto.id].abort()
     const ctx = this.makeCtx(trigger)
     const trig = await engine.evalListAll(auto.trigger || [], ctx)
     const matched = engine.triggerListMatched(auto.trigger, trig.results)
@@ -199,9 +215,15 @@ class Runtime {
     }
 
     this.lastDebounce[auto.id] = this.now()
-    const record = await engine.evaluateAutomation(auto, this.makeCtx(trigger))
-    this.finishRun(auto, record, { forceTrace: false })
-    return record
+    const abort = newAbort()
+    if (mode === 'single' || mode === 'restart') this.inFlight[auto.id] = abort
+    try {
+      const record = await engine.evaluateAutomation(auto, this.makeCtx(trigger, { abort }))
+      this.finishRun(auto, record, { forceTrace: false })
+      return record
+    } finally {
+      if (this.inFlight[auto.id] === abort) delete this.inFlight[auto.id]
+    }
   }
 
   keepTrace (auto, record, extra) {
@@ -237,11 +259,13 @@ class Runtime {
 
   async evaluateOnStart () {
     this.seedFromSelf()
+    const runs = []
     for (const auto of this.doc.automations) {
       if (!this.isEnabled(auto)) continue
       if (this.scheduleOnly(auto)) continue
-      await this.maybeRun(auto, { start: true })
+      runs.push(this.maybeRun(auto, { start: true }))
     }
+    await Promise.all(runs)
   }
 
   seedFromSelf () {
@@ -318,6 +342,24 @@ class Runtime {
 
   makeCtx (trigger, extra) {
     extra = extra || {}
+    const abort = extra.abort
+    const sleep = async (ms) => {
+      if (!abort) return this.sleep(ms)
+      try {
+        await Promise.race([
+          this.sleep(ms),
+          abort.promise
+        ])
+      } catch (err) {
+        if (err && err.cancelled) throw err
+        throw err
+      }
+      if (abort.aborted) {
+        const err = new Error('superseded')
+        err.cancelled = true
+        throw err
+      }
+    }
     return {
       values: this.values,
       zones: this.doc.zones,
@@ -326,10 +368,11 @@ class Runtime {
       now: this.now(),
       skipDelay: !!extra.skipDelay,
       skipUnchanged: extra.skipUnchanged !== false,
+      abort: abort || null,
       put: (p, value) => this.put(p, value),
       notify: (p, state, message) => this.notify(p, state, message),
       setHelper: (id, value) => this.setHelper(id, value, { kick: false }),
-      sleep: this.sleep,
+      sleep,
       runScript: engine.makeRunScript({
         scriptsDir: this.scriptsDir,
         timeoutMs: this.scriptTimeoutMs
@@ -446,6 +489,24 @@ class Runtime {
   }
 }
 
+function newAbort () {
+  const abort = {
+    aborted: false,
+    abort () {
+      if (this.aborted) return
+      this.aborted = true
+      const err = new Error('superseded')
+      err.cancelled = true
+      this._reject(err)
+    }
+  }
+  abort.promise = new Promise((_, reject) => {
+    abort._reject = reject
+  })
+  abort.promise.catch(() => {})
+  return abort
+}
+
 function asSwitch (v) {
   if (v === true || v === 1 || v === '1' || v === 'on' || v === 'ON') return 1
   if (v === false || v === 0 || v === '0' || v === 'off' || v === 'OFF') return 0

package/lib/yaml.js

@@ -172,8 +172,15 @@ function mergeAutomations (result, list, file) {
       action: asArray(raw.action),
       choose: Array.isArray(raw.choose) ? raw.choose : [],
       debounceMs: raw.debounceMs || 0,
-      edge: raw.edge || 'every'
+      edge: raw.edge || 'every',
+      mode: raw.mode || 'parallel'
     })
+    if (raw.mode && ['parallel', 'restart', 'single'].indexOf(raw.mode) === -1) {
+      result.errors.push({
+        file,
+        message: 'Automation ' + raw.id + ': mode must be parallel, restart, or single'
+      })
+    }
     for (const t of asArray(raw.trigger)) {
       if (!t || t.round == null) continue
       const n = Number(t.round)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-automation-plugin",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Home Assistant-like YAML automations for Signal K",
   "main": "plugin/index.js",
   "keywords": [

package/plugin/index.js

@@ -426,6 +426,7 @@ module.exports = function (app) {
       scriptTimeoutSeconds: options.scriptTimeoutSeconds,
       put: putPath,
       notify,
+      onHelper: (id, value) => emitHelper(id, value),
       log: {
         debug: app.debug ? app.debug.bind(app) : () => {},
         error: app.error ? app.error.bind(app) : console.error,
@@ -461,7 +462,10 @@ module.exports = function (app) {
         app.registerPutHandler('vessels.self', helpers.helperPath(id), (context, p, v, cb) => {
           Promise.resolve(runtime.setHelper(id, v))
             .then((next) => {
-              emitHelper(id, next)
+              const live = Object.prototype.hasOwnProperty.call(runtime.helperValues, id)
+                ? runtime.helperValues[id]
+                : next
+              emitHelper(id, live)
               if (cb) cb({ state: 'COMPLETED' })
             })
             .catch((err) => {

package/public/app.js

@@ -98,7 +98,10 @@ function fmtActions (t) {
     if (a.type === 'helper') return 'helper ' + a.helper + ' = ' + fmtVal(a.value)
     if (a.type === 'notify') return 'notify ' + (a.path || '') + ' ' + (a.state || '')
     if (a.type === 'delay') return a.skipped ? 'delay skipped (' + a.ms + ' ms)' : 'delay ' + a.ms + ' ms'
-    if (a.type === 'run') return 'run ' + (a.file || '')
+    if (a.type === 'run') {
+      const extra = (a.args && a.args.length) ? ' ' + a.args.join(' ') : ''
+      return 'run ' + (a.file || '') + extra
+    }
     return a.type || 'action'
   }).join('\n')
 }

package/public/index.html

@@ -5,7 +5,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Signal K Automations</title>
     <link rel="icon" href="icon.png" />
-    <link rel="stylesheet" href="style.css?v=20260918ok" />
+    <link rel="stylesheet" href="style.css?v=20260918args" />
   </head>
   <body>
     <header>
@@ -61,6 +61,6 @@
         </div>
       </section>
     </main>
-    <script src="app.js?v=20260918ok"></script>
+    <script src="app.js?v=20260918args"></script>
   </body>
 </html>