@signalk/streams 1.19.0 → 2.0.3

package/mdns-ws.js

@@ -18,14 +18,11 @@ const Transform = require('stream').Transform
 
 const SignalK = require('@signalk/client')
 
-const debug = require('debug')('signalk:streams:mdns-ws')
-const dataDebug = require('debug')('signalk:streams:mdns-ws-data')
-
 const WebSocket = require('ws')
 
-function MdnsWs (options) {
+function MdnsWs(options) {
   Transform.call(this, {
-    objectMode: true
+    objectMode: true,
   })
   this.options = options
   this.selfHost = options.app.config.getExternalHostname() + '.'
@@ -33,9 +30,13 @@ function MdnsWs (options) {
   this.remoteServers = {}
   this.remoteServers[this.selfHost + ':' + this.selfPort] = {}
   const deltaStreamBehaviour = options.subscription ? 'none' : 'all'
+
+  const createDebug = options.createDebug || require('debug')
+  this.debug = createDebug('signalk:streams:mdns-ws')
+  this.dataDebug = createDebug('signalk:streams:mdns-ws-data')
   debug(`deltaStreamBehaviour:${deltaStreamBehaviour}`)
 
-  this.handleContext = () => { }
+  this.handleContext = () => {}
   if (options.selfHandling === 'manualSelf') {
     if (options.remoteSelf) {
       debug(`Using manual remote self ${options.remoteSelf}`)
@@ -45,12 +46,14 @@ function MdnsWs (options) {
         }
       }
     } else {
-      console.error('Manual self handling speficied but no remoteSelf configured')
+      console.error(
+        'Manual self handling speficied but no remoteSelf configured'
+      )
     }
   }
 
   if (options.ignoreServers) {
-    options.ignoreServers.forEach(s => {
+    options.ignoreServers.forEach((s) => {
       this.remoteServers[s] = {}
     })
   }
@@ -62,18 +65,21 @@ function MdnsWs (options) {
       reconnect: true,
       autoConnect: false,
       deltaStreamBehaviour,
-      rejectUnauthorized: !(options.selfsignedcert === true)
+      rejectUnauthorized: !(options.selfsignedcert === true),
     })
     this.connect(this.signalkClient)
   } else {
-    this.options.app.setProviderError(this.options.providerId, 'This connection is deprecated and must be deleted')
+    this.options.app.setProviderError(
+      this.options.providerId,
+      'This connection is deprecated and must be deleted'
+    )
     return
   }
 }
 
 require('util').inherits(MdnsWs, Transform)
 
-function setProviderStatus (that, providerId, message, isError) {
+function setProviderStatus(that, providerId, message, isError) {
   if (!isError) {
     that.options.app.setProviderStatus(providerId, message)
     console.log(message)
@@ -89,50 +95,70 @@ MdnsWs.prototype.connect = function (client) {
   client
     .connect()
     .then(() => {
-      setProviderStatus(that, that.options.providerId, `ws connection connected to ${client.options.hostname}:${client.options.port}`)
+      setProviderStatus(
+        that,
+        that.options.providerId,
+        `ws connection connected to ${client.options.hostname}:${client.options.port}`
+      )
       if (this.options.selfHandling === 'useRemoteSelf') {
-        client.API().then(api => api.get('/self')).then(selfFromServer => {
-          debug(`Mapping context ${selfFromServer} to self (empty context)`)
-          this.handleContext = (delta) => {
-            if (delta.context === selfFromServer) {
-              delete delta.context
+        client
+          .API()
+          .then((api) => api.get('/self'))
+          .then((selfFromServer) => {
+            that.debug(
+              `Mapping context ${selfFromServer} to self (empty context)`
+            )
+            this.handleContext = (delta) => {
+              if (delta.context === selfFromServer) {
+                delete delta.context
+              }
             }
-          }
-        }).catch(err => {
-          console.error('Error retrieving self from remote server')
-          console.error(err)
-        })
+          })
+          .catch((err) => {
+            console.error('Error retrieving self from remote server')
+            console.error(err)
+          })
       }
-      that.remoteServers[client.options.hostname + ':' + client.options.port] = client
-      if ( that.options.subscription ) {
-        let parsed 
+      that.remoteServers[client.options.hostname + ':' + client.options.port] =
+        client
+      if (that.options.subscription) {
+        let parsed
         try {
           parsed = JSON.parse(that.options.subscription)
-        } catch ( ex ) {
-          setProviderStatus(that, that.options.providerId, `unable to parse subscription json: ${that.options.subscription}: ${ex.message}`, true)
+        } catch (ex) {
+          setProviderStatus(
+            that,
+            that.options.providerId,
+            `unable to parse subscription json: ${that.options.subscription}: ${ex.message}`,
+            true
+          )
         }
-        if ( !Array.isArray(parsed) ) {
-          parsed = [ parsed ]
+        if (!Array.isArray(parsed)) {
+          parsed = [parsed]
         }
         parsed.forEach((sub, idx) => {
-          debug('sending subscription %j', sub)
+          that.debug('sending subscription %j', sub)
           client.subscribe(sub, String(idx))
         })
       }
     })
-    .catch(err => {
+    .catch((err) => {
       setProviderStatus(that, that.options.providerId, err.message, true)
     })
-  
+
   client.on('delta', (data) => {
     if (data && data.updates) {
       that.handleContext(data)
-      if (dataDebug.enabled) { dataDebug(JSON.stringify(data)) }
+      if (that.dataDebug.enabled) {
+        that.dataDebug(JSON.stringify(data))
+      }
       data.updates.forEach(function (update) {
-        update['$source'] = `${that.options.providerId}.${client.options.hostname}:${client.options.port}`
+        update[
+          '$source'
+        ] = `${that.options.providerId}.${client.options.hostname}:${client.options.port}`
       })
     }
-    
+
     that.push(data)
   })
 }

package/n2k-signalk.js

@@ -20,22 +20,22 @@ const N2kMapper = require('@signalk/n2k-signalk').N2kMapper
 
 require('util').inherits(ToSignalK, Transform)
 
-function ToSignalK (options) {
+function ToSignalK(options) {
   Transform.call(this, {
-    objectMode: true
+    objectMode: true,
   })
   const n2kOutEvent = 'nmea2000JsonOut'
   this.sourceMeta = {}
   this.notifications = {}
   this.options = options
   this.app = options.app
-  if ( options.filters && options.filtersEnabled ) {
-    this.filters = options.filters.filter(f => {
+  if (options.filters && options.filtersEnabled) {
+    this.filters = options.filters.filter((f) => {
       return (f.source && f.source.length) || (f.pgn && f.pgn.length)
     })
   }
 
-  this.n2kMapper = new N2kMapper({...options, sendMetaData: true})
+  this.n2kMapper = new N2kMapper({ ...options, sendMetaData: true })
 
   this.n2kMapper.on('n2kOut', (pgn) => this.app.emit('nmea2000JsonOut', pgn))
 
@@ -43,7 +43,7 @@ function ToSignalK (options) {
     const existing = this.sourceMeta[n2k.src] || {}
     this.sourceMeta[n2k.src] = {
       ...existing,
-      ...meta
+      ...meta,
     }
     const delta = {
       context: this.app.selfContext,
@@ -54,21 +54,24 @@ function ToSignalK (options) {
             label: this.options.providerId,
             type: 'NMEA2000',
             pgn: Number(n2k.pgn),
-            src: n2k.src.toString()
+            src: n2k.src.toString(),
           },
           timestamp:
             n2k.timestamp.substring(0, 10) +
             'T' +
             n2k.timestamp.substring(11, n2k.timestamp.length),
-          values: []
-        }
-      ]
+          values: [],
+        },
+      ],
     }
-    this.app.deltaCache.setSourceDelta(`${this.options.providerId}.${n2k.src}`, delta)
+    this.app.deltaCache.setSourceDelta(
+      `${this.options.providerId}.${n2k.src}`,
+      delta
+    )
   })
 
   this.n2kMapper.on('n2kSourceMetadataTimeout', (pgn, src) => {
-    if ( pgn == 60928 ) {
+    if (pgn == 60928) {
       console.warn(`n2k-signalk: unable to detect can name for src ${src}`)
       this.sourceMeta[src].unknowCanName = true
     }
@@ -76,86 +79,110 @@ function ToSignalK (options) {
 
   this.n2kMapper.on('n2kSourceChanged', (src, from, to) => {
     console.warn(`n2k-signalk: address ${src} changed from ${from} ${to}`)
-    if ( this.sourceMeta[src] ) {
+    if (this.sourceMeta[src]) {
       delete this.sourceMeta[src]
     }
   })
 
-  if ( this.app.isNmea2000OutAvailable ) {
+  if (this.app.isNmea2000OutAvailable) {
     this.n2kMapper.n2kOutIsAvailable(this.app, n2kOutEvent)
   } else {
     this.app.on('nmea2000OutAvailable', () =>
-                this.n2kMapper.n2kOutIsAvailable(this.app, n2kOutEvent))
+      this.n2kMapper.n2kOutIsAvailable(this.app, n2kOutEvent)
+    )
   }
 }
 
-ToSignalK.prototype.isFiltered = function(source) {
-  return this.filters && this.filters.find(filter => {
-    const sFilter = this.options.useCanName ? source.canName : source.src
-    return (!filter.source || filter.source.length === 0 || filter.source == sFilter) && (!filter.pgn || filter.pgn.length === 0 || filter.pgn == source.pgn)
-  })
+ToSignalK.prototype.isFiltered = function (source) {
+  return (
+    this.filters &&
+    this.filters.find((filter) => {
+      const sFilter = this.options.useCanName ? source.canName : source.src
+      return (
+        (!filter.source ||
+          filter.source.length === 0 ||
+          filter.source == sFilter) &&
+        (!filter.pgn || filter.pgn.length === 0 || filter.pgn == source.pgn)
+      )
+    })
+  )
 }
 
 ToSignalK.prototype._transform = function (chunk, encoding, done) {
   try {
     const delta = this.n2kMapper.toDelta(chunk)
-    
+
     const src = Number(chunk.src)
-    if ( !this.sourceMeta[src] ) {
+    if (!this.sourceMeta[src]) {
       this.sourceMeta[src] = {}
-    } 
+    }
 
-    if (delta && delta.updates[0].values.length > 0 && !this.isFiltered(delta.updates[0].source) ) {
-      if ( !this.options.useCanName ) {
+    if (
+      delta &&
+      delta.updates[0].values.length > 0 &&
+      !this.isFiltered(delta.updates[0].source)
+    ) {
+      if (!this.options.useCanName) {
         delete delta.updates[0].source.canName
       }
 
       const canName = delta.updates[0].source.canName
-      
-      if ( this.options.useCanName && !canName && !this.sourceMeta[src].unknowCanName ) {
+
+      if (
+        this.options.useCanName &&
+        !canName &&
+        !this.sourceMeta[src].unknowCanName
+      ) {
         done()
         return
       }
 
-      delta.updates.forEach(update => {
-          update.values.forEach(kv => {
-            if ( kv.path && kv.path.startsWith('notifications.') ) {
-              if ( kv.value.state === 'normal' && this.notifications[kv.path] && this.notifications[kv.path][src]) {
-                clearInterval(this.notifications[kv.path][src].interval)
-                delete this.notifications[kv.path][src]
-              } else if ( kv.value.state !== 'normal' ) {
-                if ( !this.notifications[kv.path] ) {
-                  this.notifications[kv.path] = {}
-                }
-                if ( !this.notifications[kv.path][src] ) {
-                  const interval = setInterval(() => {
-                    if (Date.now() - this.notifications[kv.path][src].lastTime > 10000) {
-                      const copy = JSON.parse(JSON.stringify(kv))
-                      copy.value.state = 'normal'
-                      const normalDelta = {
-                        context: delta.context,
-                        updates: [
-                          {
-                            source: update.source,
-                            values: [ copy ]
-                          }
-                        ]
-                      }
-                      delete this.notifications[kv.path][src]
-                      clearInterval(interval)
-                      this.app.handleMessage(this.options.providerId, normalDelta)
+      delta.updates.forEach((update) => {
+        update.values.forEach((kv) => {
+          if (kv.path && kv.path.startsWith('notifications.')) {
+            if (
+              kv.value.state === 'normal' &&
+              this.notifications[kv.path] &&
+              this.notifications[kv.path][src]
+            ) {
+              clearInterval(this.notifications[kv.path][src].interval)
+              delete this.notifications[kv.path][src]
+            } else if (kv.value.state !== 'normal') {
+              if (!this.notifications[kv.path]) {
+                this.notifications[kv.path] = {}
+              }
+              if (!this.notifications[kv.path][src]) {
+                const interval = setInterval(() => {
+                  if (
+                    Date.now() - this.notifications[kv.path][src].lastTime >
+                    10000
+                  ) {
+                    const copy = JSON.parse(JSON.stringify(kv))
+                    copy.value.state = 'normal'
+                    const normalDelta = {
+                      context: delta.context,
+                      updates: [
+                        {
+                          source: update.source,
+                          values: [copy],
+                        },
+                      ],
                     }
-                  }, 5000)
-                  this.notifications[kv.path][src] = {
-                    lastTime: Date.now(),
-                    interval: interval
+                    delete this.notifications[kv.path][src]
+                    clearInterval(interval)
+                    this.app.handleMessage(this.options.providerId, normalDelta)
                   }
-                } else {
-                  this.notifications[kv.path][src].lastTime = Date.now()
+                }, 5000)
+                this.notifications[kv.path][src] = {
+                  lastTime: Date.now(),
+                  interval: interval,
                 }
+              } else {
+                this.notifications[kv.path][src].lastTime = Date.now()
               }
             }
-          })
+          }
+        })
       })
       this.push(delta)
     }

package/n2kAnalyzer.js

@@ -15,21 +15,20 @@
  */
 
 const Transform = require('stream').Transform
-const debug = require('debug')('signalk:streams:n2k-analyzer')
 
-function N2KAnalyzer (options) {
+function N2KAnalyzer(options) {
   Transform.call(this, {
-    objectMode: true
+    objectMode: true,
   })
   if (process.platform === 'win32') {
     this.analyzerProcess = require('child_process').spawn('cmd', [
       '/c',
-      'analyzer -json -si'
+      'analyzer -json -si',
     ])
   } else {
     this.analyzerProcess = require('child_process').spawn('sh', [
       '-c',
-      'analyzer -json -si'
+      'analyzer -json -si',
     ])
   }
   this.analyzerProcess.stderr.on('data', function (data) {
@@ -68,7 +67,7 @@ N2KAnalyzer.prototype.pipe = function (pipeTo) {
 }
 
 N2KAnalyzer.prototype.end = function () {
-  debug('end, killing child analyzer process')
+  console.log('end, killing child analyzer process')
   this.analyzerProcess.kill()
   this.pipeTo.end()
 }

package/nmea0183-signalk.js

@@ -32,14 +32,15 @@
 const Transform = require('stream').Transform
 const Parser = require('@signalk/nmea0183-signalk')
 const utils = require('@signalk/nmea0183-utilities')
-const debug = require('debug')('signalk:streams:nmea0183-signalk')
 const n2kToDelta = require('@signalk/n2k-signalk').toDelta
 const FromPgn = require('@canboat/canboatjs').FromPgn
 
-function Nmea0183ToSignalK (options) {
+function Nmea0183ToSignalK(options) {
   Transform.call(this, {
-    objectMode: true
+    objectMode: true,
   })
+  this.debug = (options.createDebug || require('debug'))('signalk:streams:nmea0183-signalk')
+  
 
   this.parser = new Parser(options)
   this.n2kParser = new FromPgn(options)
@@ -50,7 +51,7 @@ function Nmea0183ToSignalK (options) {
 
   // Prepare a list of events to send for each sentence received
   this.sentenceEvents = options.suppress0183event ? [] : ['nmea0183']
-  this.appendChecksum = options.appendChecksum;
+  this.appendChecksum = options.appendChecksum
 
   if (options.sentenceEvent) {
     if (Array.isArray(options.sentenceEvent)) {
@@ -79,19 +80,19 @@ Nmea0183ToSignalK.prototype._transform = function (chunk, encoding, done) {
   try {
     if (sentence !== undefined) {
       if (this.appendChecksum) {
-        sentence = utils.appendChecksum(sentence);
+        sentence = utils.appendChecksum(sentence)
       }
       // Send 'sentences' event to the app for each sentence
-      this.sentenceEvents.forEach(eventName => {
+      this.sentenceEvents.forEach((eventName) => {
         this.app.emit(eventName, sentence)
         this.app.signalk.emit(eventName, sentence)
       })
 
       let delta = null
-      if ( this.n2kParser.isN2KOver0183(sentence) ) {
+      if (this.n2kParser.isN2KOver0183(sentence)) {
         const pgn = this.n2kParser.parseN2KOver0183(sentence)
-        if ( pgn ) {
-          delta = n2kToDelta(pgn, this.state, {sendMetaData: true})
+        if (pgn) {
+          delta = n2kToDelta(pgn, this.state, { sendMetaData: true })
         }
       } else {
         delta = this.parser.parse(sentence)
@@ -99,7 +100,7 @@ Nmea0183ToSignalK.prototype._transform = function (chunk, encoding, done) {
 
       if (delta !== null) {
         if (timestamp !== null) {
-          delta.updates.forEach(update => {
+          delta.updates.forEach((update) => {
             update.timestamp = timestamp
           })
         }
@@ -108,7 +109,7 @@ Nmea0183ToSignalK.prototype._transform = function (chunk, encoding, done) {
       }
     }
   } catch (e) {
-    debug(`[error] ${e.message}`)
+    this.debug(e)
   }
 
   done()

package/nullprovider.js

@@ -20,9 +20,9 @@
 
 const Transform = require('stream').Transform
 
-function NullProvider (options) {
+function NullProvider(options) {
   Transform.call(this, {
-    objectMode: true
+    objectMode: true,
   })
 }
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@signalk/streams",
-  "version": "1.19.0",
+  "version": "2.0.3",
   "description": "Utilities for handling streams of Signal K data",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "ci": "prettier --check .",
+    "format": "prettier --write ."
   },
   "repository": {
     "type": "git",
@@ -28,7 +29,6 @@
     "@signalk/nmea0183-utilities": "^0.8.0",
     "@signalk/signalk-schema": "^1.5.0",
     "any-shell-escape": "^0.1.1",
-    "aws-sdk": "^2.413.0",
     "file-timestamp-stream": "^2.1.2",
     "lodash": "^4.17.4",
     "moment": "^2.24.0",
@@ -38,5 +38,8 @@
   },
   "optionalDependencies": {
     "serialport": "^9.0.1"
+  },
+  "devDependencies": {
+    "prettier": "2.5.1"
   }
 }

package/pigpio-seatalk.js

@@ -15,14 +15,13 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- * 
+ *
  * 2020-06-24 Original Python code from @Thomas-GeDaD https://github.com/Thomas-GeDaD/Seatalk1-Raspi-reader
  * and finetuned by @MatsA
  *
  */
 
 const Execute = require('./execute')
-const debug = require('debug')('signalk:streams:pigpio-seatalk')
 
 const cmd = `
 import pigpio, time, signal, sys
@@ -79,13 +78,13 @@ if __name__ == "__main__":
                 print ("exit")
 `
 
-function PigpioSeatalk (options) {
-  Execute.call(this, {debug})
+function PigpioSeatalk(options) {
+  const createDebug = options.createDebug || require('debug')
+  Execute.call(this, { debug: createDebug('signalk:streams:pigpio-seatalk') })
   this.options = options
   this.options.command = `python -u -c '${cmd}' ${options.gpio} ${options.gpioInvert} `
 }
 
 require('util').inherits(PigpioSeatalk, Execute)
 
-
 module.exports = PigpioSeatalk

package/replacer.js

@@ -14,21 +14,19 @@
  * limitations under the License.
  */
 
-
 const Transform = require('stream').Transform
 
 require('util').inherits(Replacer, Transform)
 
-function Replacer (options) {
+function Replacer(options) {
   Transform.call(this, {
-    objectMode: true
+    objectMode: true,
   })
   this.doPush = this.push.bind(this)
   this.regexp = new RegExp(options.regexp, 'gu')
   this.template = options.template
 }
 
-
 Replacer.prototype._transform = function (chunk, encoding, done) {
   this.doPush(chunk.toString().replace(this.regexp, this.template))
   done()

package/s3.js

@@ -15,12 +15,19 @@
  */
 
 var Transform = require('stream').Transform
+/*
+  aws-sdk is not included in dependencies because of the
+  persistent deprecation warnings caused by its transitive
+  dependencies. This feature is not in wide use, especially
+  not in signalk-server where people encounter the scary looking
+  deprecation warnings.
+  Known to work with ^2.413.0
+*/
 const AWS = require('aws-sdk')
-const debug = require('debug')('signalk:streams:s3-provider')
 
-function S3Provider ({ bucket, prefix }) {
+function S3Provider({ bucket, prefix }) {
   Transform.call(this, {
-    objectMode: false
+    objectMode: false,
   })
   this.Bucket = bucket
   this.Prefix = prefix
@@ -34,12 +41,12 @@ S3Provider.prototype.pipe = function (pipeTo) {
   const s3 = new AWS.S3()
   const params = {
     Bucket: this.Bucket,
-    Prefix: this.Prefix
+    Prefix: this.Prefix,
   }
   console.log('listobjects')
   s3.listObjects(params)
     .promise()
-    .then(data => {
+    .then((data) => {
       // console.log(data)
       const jobs = data.Contents.map(
         (item, i) =>
@@ -48,18 +55,15 @@ S3Provider.prototype.pipe = function (pipeTo) {
               console.log('Starting key ' + item.Key)
               const objectParams = {
                 Bucket: params.Bucket,
-                Key: item.Key
+                Key: item.Key,
               }
               const request = s3.getObject(objectParams)
-              request.on('error', err => {
+              request.on('error', (err) => {
                 console.log(err)
               })
               const stream = request.createReadStream()
               stream.on('end', resolve)
-              stream.pipe(
-                pipeTo,
-                { end: i === data.Contents.length-1 }
-              )
+              stream.pipe(pipeTo, { end: i === data.Contents.length - 1 })
             })
           }
       )
@@ -67,14 +71,14 @@ S3Provider.prototype.pipe = function (pipeTo) {
       let i = 0
       function startNext() {
         if (i < jobs.length) {
-          jobs[i++]().then(startNext);
+          jobs[i++]().then(startNext)
         } else {
           doEnd()
         }
       }
-      startNext();
+      startNext()
     })
-    .catch(error => {
+    .catch((error) => {
       console.error(error)
     })
   return pipeTo