@signalk/streams 2.0.0 → 2.0.1

package/canboatjs.js

@@ -16,7 +16,6 @@
 
 const Transform = require('stream').Transform
 const FromPgn = require('@canboat/canboatjs').FromPgn
-const debug = require('debug')('signalk:streams:canboatjs')
 const _ = require('lodash')
 
 function CanboatJs (options) {
@@ -25,6 +24,9 @@ function CanboatJs (options) {
   })
 
   this.fromPgn = new FromPgn(options)
+  const createDebug = options.createDebug || require('debug')
+  const debug = createDebug('signalk:streams:nmea0183-signalk')
+
 
   this.fromPgn.on('warning', (pgn, warning) => {
     debug(`[warning] ${pgn.pgn} ${warning}`)

package/execute.js

@@ -42,7 +42,8 @@ const { pgnToActisenseSerialFormat } = require('@canboat/canboatjs')
 function Execute (options) {
   Transform.call(this, {})
   this.options = options
-  this.debug = options.debug || require('debug')('signalk:streams:execute')
+  const createDebug = options.createDebug || require('debug')
+  this.debug = options.debug || createDebug('signalk:streams:execute')
 }
 
 require('util').inherits(Execute, Transform)

package/gpsd.js

@@ -32,7 +32,6 @@
 
 const Transform = require('stream').Transform
 const gpsd = require('node-gpsd')
-const debug = require('debug')('signalk:streams:gpsd')
 
 function Gpsd (options) {
   Transform.call(this, {
@@ -45,12 +44,14 @@ function Gpsd (options) {
   function setProviderStatus(msg) {
     options.app.setProviderStatus(options.providerId, msg)
   }
-  
+
+  const createDebug = options.createDebug || require('debug')
+
   this.listener = new gpsd.Listener({
     port,
     hostname,
     logger: {
-      info: debug,
+      info: createDebug('signalk:streams:gpsd'),
       warn: console.warn,
       error: (msg) => {
         options.app.setProviderError(options.providerId, `${hostname}:${port}: ` + msg)

package/keys-filter.js

@@ -1,13 +1,14 @@
 'use strict'
 
 const Transform = require('stream').Transform
-const debug = require('debug')('signalk:streams:keys-filter')
 
 function ToSignalK (options) {
   Transform.call(this, {
     objectMode: true
   })
 
+  const createDebug = options.createDebug || require('debug')
+  this.debug = createDebug('signalk:streams:keys-filter')
   this.exclude = options.excludeMatchingPaths
 }
 
@@ -25,7 +26,7 @@ ToSignalK.prototype._transform = function (chunk, encoding, done) {
       delta = JSON.parse(chunk)
       string = true
     } catch (e) {
-      debug(`Error parsing chunk: ${e.message}`)
+      this.debug(`Error parsing chunk: ${e.message}`)
     }
   }
 

package/logging.js

@@ -16,7 +16,7 @@
 
 const { FileTimestampStream } = require('file-timestamp-stream')
 const path = require('path')
-const debug = require('debug')('signalk:streams:logging')
+let debug = require('debug')('signalk:streams:logging')
 const fs = require('fs')
 
 const filenamePattern = /skserver\-raw\_\d\d\d\d\-\d\d\-\d\dT\d\d\.log/
@@ -35,6 +35,7 @@ class FileTimestampStreamWithDelete extends FileTimestampStream {
     this.filesToKeep = filesToKeep
     this.fullLogDir = fullLogDir
     this.prevFilename = undefined
+    debug = (options.createDebug || require('debug'))('signalk:streams:logging')
   }
 
   // This method of base class is called when new file name is contemplated

package/mdns-ws.js

@@ -18,8 +18,6 @@ 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')
 
@@ -33,6 +31,10 @@ 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 = () => { }
@@ -92,7 +94,7 @@ MdnsWs.prototype.connect = function (client) {
       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)`)
+          that.debug(`Mapping context ${selfFromServer} to self (empty context)`)
           this.handleContext = (delta) => {
             if (delta.context === selfFromServer) {
               delete delta.context
@@ -115,7 +117,7 @@ MdnsWs.prototype.connect = function (client) {
           parsed = [ parsed ]
         }
         parsed.forEach((sub, idx) => {
-          debug('sending subscription %j', sub)
+          that.debug('sending subscription %j', sub)
           client.subscribe(sub, String(idx))
         })
       }
@@ -127,7 +129,7 @@ MdnsWs.prototype.connect = function (client) {
   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}`
       })

package/n2kAnalyzer.js

@@ -15,7 +15,6 @@
  */
 
 const Transform = require('stream').Transform
-const debug = require('debug')('signalk:streams:n2k-analyzer')
 
 function N2KAnalyzer (options) {
   Transform.call(this, {
@@ -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,7 +32,6 @@
 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
 
@@ -108,7 +107,7 @@ Nmea0183ToSignalK.prototype._transform = function (chunk, encoding, done) {
       }
     }
   } catch (e) {
-    debug(`[error] ${e.message}`)
+    console.error(e)
   }
 
   done()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/streams",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Utilities for handling streams of Signal K data",
   "main": "index.js",
   "scripts": {

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/s3.js

@@ -23,8 +23,7 @@ var Transform = require('stream').Transform
   deprecation warnings.
   Known to work with ^2.413.0
 */
-const AWS = require('aws-sdk') 
-const debug = require('debug')('signalk:streams:s3-provider')
+const AWS = require('aws-sdk')
 
 function S3Provider ({ bucket, prefix }) {
   Transform.call(this, {

package/serialport.js

@@ -62,7 +62,6 @@ const child_process = require('child_process')
 const shellescape = require('any-shell-escape')
 const SerialPort = require('serialport')
 const isArray = require('lodash').isArray
-const debug = require('debug')('signalk:streams:serialport')
 const isBuffer = require('lodash').isBuffer
 
 function SerialStream (options) {
@@ -79,11 +78,16 @@ function SerialStream (options) {
   this.maxPendingWrites = options.maxPendingWrites || 5
   this.start()
   this.isFirstError = true
+
+  const createDebug = options.createDebug || require('debug')
+  this.debug = createDebug('signalk:streams:serialport')
 }
 
 require('util').inherits(SerialStream, Transform)
 
 SerialStream.prototype.start = function () {
+  const that = this
+
   if (this.serial !== null) {
     this.serial.unpipe(this)
     this.serial.removeAllListeners()
@@ -125,7 +129,7 @@ SerialStream.prototype.start = function () {
       if (this.isFirstError) {
         console.log(x.message)
       }
-      debug(x.message)
+      this.debug(x.message)
       this.isFirstError = false
       this.scheduleReconnect()
     }.bind(this)
@@ -141,7 +145,6 @@ SerialStream.prototype.start = function () {
     }.bind(this)
   )
 
-  const that = this
   let pendingWrites = 0
   const stdOutEvent = this.options.toStdout
   if (stdOutEvent) {
@@ -152,10 +155,10 @@ SerialStream.prototype.start = function () {
 
       that.options.app.on(event, d => {
         if (pendingWrites > that.maxPendingWrites) {
-          debug('Buffer overflow, not writing:' + d)
+          that.debug('Buffer overflow, not writing:' + d)
           return
         }
-        debug('Writing:' + d)
+        that.debug('Writing:' + d)
         if ( isBuffer(d) ) {
           that.serial.write(d)
         } else {
@@ -182,7 +185,7 @@ SerialStream.prototype.scheduleReconnect = function () {
   const msg = `Not connected (retry delay ${(
     this.reconnectDelay / 1000
   ).toFixed(0)} s)`
-  debug(msg)
+  this.debug(msg)
   this.options.app.setProviderStatus(this.options.providerId, msg)
   setTimeout(this.start.bind(this), this.reconnectDelay)
 }

package/simple.js

@@ -1,7 +1,6 @@
 const Transform = require('stream').Transform
 const Writable = require('stream').Writable
 const _ = require('lodash')
-const debug = require('debug')('signalk:simple')
 const N2kAnalyzer = require('./n2kAnalyzer')
 const FromJson = require('./from_json')
 const MultiplexedLog = require('./multiplexedlog')
@@ -27,9 +26,14 @@ const pigpioSeatalk = require('./pigpio-seatalk')
 function Simple (options) {
   Transform.call(this, { objectMode: true })
 
-  const { emitPropertyValue, onPropertyValues } = options
+  const { emitPropertyValue, onPropertyValues, createDebug } = options
   options = { ...options }
-  options.subOptions = { ...options.subOptions, emitPropertyValue, onPropertyValues }
+  options.subOptions = {
+    ...options.subOptions,
+    emitPropertyValue,
+    onPropertyValues,
+    createDebug
+  }
 
   options.subOptions.providerId = options.providerId
   const dataType = options.subOptions.dataType || options.type

package/tcp.js

@@ -32,23 +32,22 @@ const net = require('net')
 const Transform = require('stream').Transform
 const isArray = require('lodash').isArray
 
-const debug = require('debug')('signalk-server:streams:tcp')
-const debugData = require('debug')('signalk-server:streams:tcp-data')
-
 function TcpStream (options) {
   Transform.call(this, options)
   this.options = options
   this.noDataReceivedTimeout = Number.parseInt((this.options.noDataReceivedTimeout + '').trim()) * 1000
+  this.debug = (options.createDebug || require('debug'))('signalk:streams:tcp')
+  this.debugData = (options.createDebug || require('debug'))('signalk:streams:tcp-data')
 }
 
 require('util').inherits(TcpStream, Transform)
 
 TcpStream.prototype.pipe = function (pipeTo) {
+  const that = this
   if ( this.options.outEvent ) {
-    const that = this
     that.options.app.on(that.options.outEvent, function (d) {
       if ( that.tcpStream ) {
-        debug('sending %s', d)
+        that.debug('sending %s', d)
         that.tcpStream.write(d)
       }
     })
@@ -61,7 +60,7 @@ TcpStream.prototype.pipe = function (pipeTo) {
       that.options.app.on(stdEvent, function (d) {
         if (that.tcpStream) {
           that.tcpStream.write(d + '\r\n')
-          debug('event %s sending %s', stdEvent, d)
+         that. debug('event %s sending %s', stdEvent, d)
         }
       })
     })
@@ -72,19 +71,19 @@ TcpStream.prototype.pipe = function (pipeTo) {
   })({ maxDelay: 5 * 1000 }, tcpStream => {
     if (!isNaN(this.noDataReceivedTimeout)) {
       tcpStream.setTimeout(this.noDataReceivedTimeout)
-      debug(
+      that.debug(
         `Setting socket idle timeout ${this.options.host}:${this.options.port} ${this.noDataReceivedTimeout}`
       )
       tcpStream.on('timeout', () => {
-        debug(
+        that.debug(
           `Idle timeout, closing socket ${this.options.host}:${this.options.port}`
         )
         tcpStream.end()
       })
     }
     tcpStream.on('data', data => {
-      if (debugData.enabled) {
-        debugData(data.toString())
+      if (that.debugData.enabled) {
+        that.debugData(data.toString())
       }
       this.write(data)
     })
@@ -93,18 +92,18 @@ TcpStream.prototype.pipe = function (pipeTo) {
       this.tcpStream = con
       const msg = `Connected to ${this.options.host} ${this.options.port}`
       this.options.app.setProviderStatus(this.options.providerId, msg)
-      debug(msg)
+      that.debug(msg)
     })
     .on('reconnect', (n, delay) => {
       const msg = `Reconnect ${this.options.host} ${
         this.options.port
       } retry ${n} delay ${delay}`
       this.options.app.setProviderError(this.options.providerId, msg)
-      debug(msg)
+      that.debug(msg)
     })
     .on('disconnect', err => {
       delete this.tcpStream
-      debug(`Disconnected ${this.options.host} ${this.options.port}`)
+      that.debug(`Disconnected ${this.options.host} ${this.options.port}`)
     })
     .on('error', err => {
       this.options.app.setProviderError(this.options.providerId, err.message)

package/udp.js

@@ -34,13 +34,13 @@
  */
 
 const Transform = require('stream').Transform
-const debug = require('debug')('signalk:streams:udp')
 
 function Udp (options) {
   Transform.call(this, {
     objectMode: false
   })
   this.options = options
+  this.debug = (options.createDebug || require('debug'))('signalk:streams:udp')
 }
 
 require('util').inherits(Udp, Transform)
@@ -52,7 +52,7 @@ Udp.prototype.pipe = function (pipeTo) {
   const socket = require('dgram').createSocket('udp4')
   const self = this
   socket.on('message', function (message, remote) {
-    debug(message.toString())
+    self.debug(message.toString())
     self.push(message)
   })
   socket.bind(this.options.port)