signalk-automation-plugin 0.0.1 → 0.0.2

package/plugin/index.js

@@ -14,8 +14,14 @@ function sendJson (res, body, status) {
 
 function readJson (req) {
   return new Promise((resolve, reject) => {
-    if (req.body && typeof req.body === 'object' && !Buffer.isBuffer(req.body)) {
-      resolve(req.body)
+    const parsed = req.body
+    const hasParsed =
+      parsed &&
+      typeof parsed === 'object' &&
+      !Buffer.isBuffer(parsed) &&
+      Object.keys(parsed).length > 0
+    if (hasParsed || req.readableEnded) {
+      resolve(hasParsed ? parsed : (parsed && typeof parsed === 'object' && !Buffer.isBuffer(parsed) ? parsed : {}))
       return
     }
     let raw = ''
@@ -27,7 +33,7 @@ function readJson (req) {
     })
     req.on('end', () => {
       if (!raw) {
-        resolve({})
+        resolve(parsed && typeof parsed === 'object' && !Buffer.isBuffer(parsed) ? parsed : {})
         return
       }
       try {
@@ -88,6 +94,8 @@ module.exports = function (app) {
         started: false,
         automations: [],
         helpers: [],
+        zones: [],
+        switches: [],
         errors: [],
         yaml: '',
         commits: []
@@ -110,6 +118,19 @@ module.exports = function (app) {
     try {
       const body = await readJson(req)
       const snap = rt.activateCommit(body.sha)
+      rewireAfterYamlChange()
+      sendJson(res, snap)
+    } catch (err) {
+      sendJson(res, { error: err.message }, 400)
+    }
+  }
+
+  function handleReload (req, res) {
+    const rt = requireRuntime(res)
+    if (!rt) return
+    try {
+      const snap = rt.reloadWorkingTree()
+      rewireAfterYamlChange()
       sendJson(res, snap)
     } catch (err) {
       sendJson(res, { error: err.message }, 400)
@@ -120,9 +141,37 @@ module.exports = function (app) {
     const rt = requireRuntime(res)
     if (!rt) return
     try {
+      const auto = rt.doc.automations.find((a) => a.id === id)
+      if (!auto) {
+        sendJson(res, { error: 'Unknown automation: ' + id }, 404)
+        return
+      }
       const body = await readJson(req)
+      if (!Object.prototype.hasOwnProperty.call(body, 'enabled')) {
+        throw new Error('enabled is required')
+      }
       rt.setEnabled(id, body.enabled)
-      sendJson(res, { id, enabled: rt.isEnabled({ id, enabled: true }) && body.enabled })
+      sendJson(res, { id, enabled: rt.isEnabled(auto) })
+    } catch (err) {
+      sendJson(res, { error: err.message }, 400)
+    }
+  }
+
+  async function handleVerbose (req, res, id) {
+    const rt = requireRuntime(res)
+    if (!rt) return
+    try {
+      const auto = rt.doc.automations.find((a) => a.id === id)
+      if (!auto) {
+        sendJson(res, { error: 'Unknown automation: ' + id }, 404)
+        return
+      }
+      const body = await readJson(req)
+      if (!Object.prototype.hasOwnProperty.call(body, 'verbose')) {
+        throw new Error('verbose is required')
+      }
+      rt.setVerbose(id, body.verbose)
+      sendJson(res, { id, verbose: rt.isVerbose(auto) })
     } catch (err) {
       sendJson(res, { error: err.message }, 400)
     }
@@ -133,7 +182,7 @@ module.exports = function (app) {
     if (!rt) return
     try {
       const body = await readJson(req)
-      const value = rt.setHelper(id, body.value)
+      const value = await rt.setHelper(id, body.value)
       emitHelper(id, value)
       sendJson(res, { id, value })
     } catch (err) {
@@ -141,11 +190,11 @@ module.exports = function (app) {
     }
   }
 
-  function handleHelperReset (req, res, id) {
+  async function handleHelperReset (req, res, id) {
     const rt = requireRuntime(res)
     if (!rt) return
     try {
-      const value = rt.resetHelper(id)
+      const value = await rt.resetHelper(id)
       emitHelper(id, value)
       sendJson(res, { id, value: value == null ? null : value })
     } catch (err) {
@@ -153,25 +202,55 @@ module.exports = function (app) {
     }
   }
 
+  async function handleRun (req, res, id) {
+    const rt = requireRuntime(res)
+    if (!rt) return
+    try {
+      const record = await rt.runNow(id)
+      sendJson(res, record)
+    } catch (err) {
+      sendJson(res, { error: err.message }, 404)
+    }
+  }
+
   plugin.registerWithRouter = function (router) {
+    const write = typeof router.access === 'function' ? router.access('readwrite') : router
     router.get('/status', (req, res) => sendJson(res, snapshot()))
     router.get('/yaml', (req, res) => sendJson(res, { yaml: snapshot().yaml, sha: snapshot().activeSha }))
     router.get('/commits', (req, res) => sendJson(res, { commits: snapshot().commits, activeSha: snapshot().activeSha }))
+    router.get('/diff', (req, res) => {
+      const rt = requireRuntime(res)
+      if (!rt) return
+      try {
+        sendJson(res, rt.diffCommit(queryParam(req, 'sha')))
+      } catch (err) {
+        sendJson(res, { error: err.message }, 400)
+      }
+    })
     router.get('/automations/:id/traces', (req, res) => {
       const rt = requireRuntime(res)
       if (!rt) return
       sendJson(res, { id: req.params.id, traces: rt.traces(req.params.id) })
     })
-    router.post('/live', (req, res) => {
+    write.post('/live', (req, res) => {
       handleLive(req, res)
     })
-    router.post('/automations/:id/enabled', (req, res) => {
+    write.post('/reload', (req, res) => {
+      handleReload(req, res)
+    })
+    write.post('/automations/:id/enabled', (req, res) => {
       handleEnabled(req, res, req.params.id)
     })
-    router.put('/helpers/:id', (req, res) => {
+    write.post('/automations/:id/verbose', (req, res) => {
+      handleVerbose(req, res, req.params.id)
+    })
+    write.post('/automations/:id/run', (req, res) => {
+      handleRun(req, res, req.params.id)
+    })
+    write.put('/helpers/:id', (req, res) => {
       handleHelperPut(req, res, req.params.id)
     })
-    router.post('/helpers/:id/reset', (req, res) => {
+    write.post('/helpers/:id/reset', (req, res) => {
       handleHelperReset(req, res, req.params.id)
     })
   }
@@ -185,6 +264,17 @@ module.exports = function (app) {
     router.get(prefix + '/commits', (req, res) =>
       sendJson(res, { commits: snapshot().commits, activeSha: snapshot().activeSha })
     )
+    router.get(prefix + '/diff', (req, res) => {
+      if (!runtime) {
+        sendJson(res, { error: 'plugin not started' }, 409)
+        return
+      }
+      try {
+        sendJson(res, runtime.diffCommit(queryParam(req, 'sha')))
+      } catch (err) {
+        sendJson(res, { error: err.message }, 400)
+      }
+    })
     router.get(prefix + '/automations/:id/traces', (req, res) => {
       if (!runtime) {
         sendJson(res, { error: 'plugin not started' }, 409)
@@ -217,14 +307,38 @@ module.exports = function (app) {
 
   function putPath (p, value) {
     return new Promise((resolve, reject) => {
-      if (typeof app.putSelfPath === 'function') {
-        app.putSelfPath(p, value, (err) => (err ? reject(err) : resolve()))
+      if (typeof app.putSelfPath !== 'function') {
+        app.handleMessage(PLUGIN_ID, {
+          updates: [{ values: [{ path: p, value }] }]
+        })
+        resolve()
         return
       }
-      app.handleMessage(PLUGIN_ID, {
-        updates: [{ values: [{ path: p, value }] }]
-      })
-      resolve()
+      let settled = false
+      const finish = (err) => {
+        if (settled) return
+        settled = true
+        if (err) reject(err)
+        else resolve()
+      }
+      const fromReply = (reply) => {
+        if (reply == null) return finish(null)
+        if (reply instanceof Error) return finish(reply)
+        const code = reply.statusCode
+        if (typeof code === 'number' && code >= 400) {
+          finish(new Error(reply.message || ('PUT failed (' + code + ') for ' + p)))
+          return
+        }
+        finish(null)
+      }
+      try {
+        const ret = app.putSelfPath(p, value, fromReply)
+        if (ret && typeof ret.then === 'function') {
+          ret.then(fromReply, finish)
+        }
+      } catch (err) {
+        finish(err)
+      }
     })
   }
 
@@ -265,57 +379,90 @@ module.exports = function (app) {
       scriptTimeoutSeconds: options.scriptTimeoutSeconds,
       put: putPath,
       notify,
-      log: { debug: app.debug ? app.debug.bind(app) : () => {}, error: app.error ? app.error.bind(app) : console.error }
+      log: {
+        debug: app.debug ? app.debug.bind(app) : () => {},
+        error: app.error ? app.error.bind(app) : console.error,
+        info: (msg) => {
+          if (app.debug) app.debug(msg)
+          console.log('[signalk-automation-plugin] ' + msg)
+        }
+      }
     })
     runtime.load()
+    runtime.seedFromSelf()
+    rewireAfterYamlChange()
+    runtime.evaluateOnStart().catch((err) => app.error && app.error(err))
+
+    timers.push(setInterval(() => {
+      runtime.tickSchedule().catch((err) => app.error && app.error(err))
+    }, 15000))
+  }
+
+  function clearSubscriptions () {
+    unsubscribes.splice(0).forEach((f) => {
+      try {
+        f()
+      } catch (_) {}
+    })
+  }
 
+  function emitAllHelpers () {
+    if (!runtime) return
     for (const [id, value] of Object.entries(runtime.helperValues)) {
       emitHelper(id, value)
       if (typeof app.registerPutHandler === 'function') {
         app.registerPutHandler('vessels.self', helpers.helperPath(id), (context, p, v, cb) => {
-          try {
-            const next = runtime.setHelper(id, v)
-            emitHelper(id, next)
-            if (cb) cb({ state: 'COMPLETED' })
-          } catch (err) {
-            if (cb) cb({ state: 'COMPLETED', statusCode: 400, message: err.message })
-          }
+          Promise.resolve(runtime.setHelper(id, v))
+            .then((next) => {
+              emitHelper(id, next)
+              if (cb) cb({ state: 'COMPLETED' })
+            })
+            .catch((err) => {
+              if (cb) cb({ state: 'COMPLETED', statusCode: 400, message: err.message })
+            })
+          return { state: 'PENDING' }
         })
       }
     }
+  }
 
+  function subscribePaths () {
+    if (!runtime || !app.subscriptionmanager) return
     const paths = require('../lib/engine').collectPaths(runtime.doc)
-    if (paths.length && app.subscriptionmanager) {
-      app.subscriptionmanager.subscribe(
-        {
-          context: 'vessels.self',
-          subscribe: paths.map((p) => ({ path: p }))
-        },
-        unsubscribes,
-        (err) => app.error && app.error(err),
-        (delta) => {
-          const src = delta && delta.updates && delta.updates[0] && delta.updates[0].$source
-          ;(delta.updates || []).forEach((u) => {
-            const source = u.$source || src
-            ;(u.values || []).forEach((v) => {
-              runtime.handlePathChange(v.path, v.value, source).catch((err) => {
-                if (app.error) app.error(err)
-              })
+    if (!paths.length) return
+    app.subscriptionmanager.subscribe(
+      {
+        context: 'vessels.self',
+        subscribe: paths.map((p) => ({ path: p }))
+      },
+      unsubscribes,
+      (err) => app.error && app.error(err),
+      (delta) => {
+        const src = delta && delta.updates && delta.updates[0] && delta.updates[0].$source
+        ;(delta.updates || []).forEach((u) => {
+          const source = u.$source || src
+          ;(u.values || []).forEach((v) => {
+            runtime.handlePathChange(v.path, v.value, source).catch((err) => {
+              if (app.error) app.error(err)
             })
           })
-        }
-      )
-    }
+        })
+      }
+    )
+  }
 
-    timers.push(setInterval(() => {
-      runtime.tickSchedule().catch((err) => app.error && app.error(err))
-    }, 15000))
+  function setStatusFromRuntime () {
+    if (!app.setPluginStatus || !runtime) return
+    const n = runtime.doc.automations.length
+    const err = runtime.doc.errors.length
+    app.setPluginStatus(n + ' automations' + (err ? ', ' + err + ' YAML error(s)' : ''))
+  }
 
-    if (app.setPluginStatus) {
-      const n = runtime.doc.automations.length
-      const err = runtime.doc.errors.length
-      app.setPluginStatus(n + ' automations' + (err ? ', ' + err + ' YAML error(s)' : ''))
-    }
+  function rewireAfterYamlChange () {
+    clearSubscriptions()
+    emitAllHelpers()
+    subscribePaths()
+    setStatusFromRuntime()
   }
 
   plugin.stop = function () {
@@ -336,5 +483,11 @@ function fsMkdir (dir) {
   fs.mkdirSync(dir, { recursive: true })
 }
 
+function queryParam (req, name) {
+  if (req.query && req.query[name] != null) return String(req.query[name])
+  const raw = String(req.url || '').split('?')[1] || ''
+  return new URLSearchParams(raw).get(name) || ''
+}
+
 module.exports.app = 'app'
 module.exports.options = 'options'