@signalk/streams 5.1.3 → 6.0.0

package/logging.js

@@ -1,149 +0,0 @@
-/*
- * Copyright 2017 Scott Bender (scott@scottbender.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
-
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const { FileTimestampStream } = require('file-timestamp-stream')
-const path = require('path')
-let debug = require('debug')('signalk:streams:logging')
-const fs = require('fs')
-const { isUndefined } = require('lodash')
-
-const filenamePattern = /skserver-raw_\d\d\d\d-\d\d-\d\dT\d\d\.log/
-const loggers = {}
-
-module.exports = {
-  getLogger,
-  getFullLogDir,
-  listLogFiles
-}
-
-class FileTimestampStreamWithDelete extends FileTimestampStream {
-  constructor(app, fullLogDir, filesToKeep, options) {
-    super(options)
-    this.app = app
-    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
-  // So let's override it to check how many files are there and delete the oldest ones
-  newFilename() {
-    if (this.prevFilename !== this.currentFilename) {
-      // Only do that after new file created
-      this.prevFilename = this.currentFilename
-      this.deleteOldFiles()
-    }
-    return super.newFilename()
-  }
-
-  deleteOldFiles() {
-    debug(`Checking for old log files`)
-    listLogFiles(this.app, (err, files) => {
-      if (err) {
-        console.error(err)
-      } else {
-        if (files.length > this.filesToKeep) {
-          const sortedFiles = files.sort()
-          const numToDelete = files.length - this.filesToKeep
-          debug(`Will delete ${numToDelete} files`)
-          for (let i = 0; i < numToDelete; i++) {
-            const fileName = path.join(this.fullLogDir, sortedFiles[i])
-            debug(`Deleting ${fileName}`)
-            fs.unlink(fileName, (err) => {
-              if (err) {
-                console.error(err)
-              } else {
-                debug(`${fileName} was deleted`)
-              }
-            })
-          }
-        }
-      }
-    })
-  }
-}
-
-function getLogger(app, discriminator = '', logdir) {
-  const fullLogdir = getFullLogDir(app, logdir)
-
-  if (!loggers[fullLogdir]) {
-    const fileName = path.join(fullLogdir, 'skserver-raw_%Y-%m-%dT%H.log')
-
-    debug(`logging to ${fileName}`)
-
-    let fileTimestampStream
-    if (
-      isUndefined(app.config.settings.keepMostRecentLogsOnly) ||
-      app.config.settings.keepMostRecentLogsOnly
-    ) {
-      // Delete old logs
-      fileTimestampStream = new FileTimestampStreamWithDelete(
-        app,
-        fullLogdir,
-        app.config.settings.logCountToKeep,
-        { path: fileName }
-      )
-    } else {
-      // Don't delete any logs
-      fileTimestampStream = new FileTimestampStream({ path: fileName })
-    }
-
-    loggers[fullLogdir] = fileTimestampStream
-  }
-
-  const logger = loggers[fullLogdir]
-  logger.on('error', (err) => {
-    console.error(`Error opening data logging file: ${err.message}`)
-  })
-
-  return (msg) => {
-    try {
-      logger.write(
-        Date.now() +
-          ';' +
-          discriminator +
-          ';' +
-          (msg.updates ? JSON.stringify(msg) : msg.toString()) +
-          '\n'
-      )
-    } catch (e) {
-      console.error(e)
-    }
-  }
-}
-
-function getFullLogDir(app, logdir) {
-  if (!logdir) {
-    logdir = app.config.settings.loggingDirectory || app.config.configPath
-  }
-  return path.isAbsolute(logdir)
-    ? logdir
-    : path.join(app.config.configPath, logdir)
-}
-
-function listLogFiles(app, cb) {
-  fs.readdir(getFullLogDir(app), (err, files) => {
-    if (!err) {
-      cb(
-        undefined,
-        files.filter((filename) => filename.match(filenamePattern))
-      )
-    } else {
-      cb(err)
-    }
-  })
-}

package/mdns-ws.js

@@ -1,167 +0,0 @@
-/*
- * Copyright 2016 Teppo Kurki <teppo.kurki@iki.fi>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
-
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const Transform = require('stream').Transform
-
-const SignalK = require('@signalk/client')
-
-function MdnsWs(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-  this.options = options
-  this.selfHost = options.app.config.getExternalHostname() + '.'
-  this.selfPort = options.app.config.getExternalPort()
-  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')
-  this.debug(`deltaStreamBehaviour:${deltaStreamBehaviour}`)
-
-  this.handleContext = () => {}
-  if (options.selfHandling === 'manualSelf') {
-    if (options.remoteSelf) {
-      this.debug(`Using manual remote self ${options.remoteSelf}`)
-      this.handleContext = (delta) => {
-        if (delta.context === options.remoteSelf) {
-          delete delta.context
-        }
-      }
-    } else {
-      console.error(
-        'Manual self handling speficied but no remoteSelf configured'
-      )
-    }
-  }
-
-  if (options.ignoreServers) {
-    options.ignoreServers.forEach((s) => {
-      this.remoteServers[s] = {}
-    })
-  }
-  if (options.host && options.port) {
-    this.signalkClient = new SignalK.Client({
-      hostname: options.host,
-      port: options.port,
-      useTLS: options.type === 'wss',
-      reconnect: true,
-      notifications: false,
-      autoConnect: false,
-      deltaStreamBehaviour,
-      rejectUnauthorized: !(options.selfsignedcert === true),
-      wsKeepaliveInterval: 10
-    })
-    this.connect(this.signalkClient)
-  } else {
-    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) {
-  if (!isError) {
-    that.options.app.setProviderStatus(providerId, message)
-    console.log(message)
-  } else {
-    that.options.app.setProviderError(providerId, message)
-    console.error(message)
-  }
-}
-
-MdnsWs.prototype.connect = function (client) {
-  const that = this
-
-  client
-    .connect()
-    .then(() => {
-      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) => {
-            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)
-          })
-      }
-      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
-          )
-        }
-        if (!Array.isArray(parsed)) {
-          parsed = [parsed]
-        }
-        parsed.forEach((sub, idx) => {
-          that.debug('sending subscription %j', sub)
-          client.subscribe(sub, String(idx))
-        })
-      }
-    })
-    .catch((err) => {
-      setProviderStatus(that, that.options.providerId, err.message, true)
-    })
-
-  client.on('delta', (data) => {
-    if (data && data.updates) {
-      that.handleContext(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}`
-      })
-    }
-
-    that.push(data)
-  })
-}
-
-MdnsWs.prototype._transform = function () {}
-
-module.exports = MdnsWs

package/multiplexedlog.js

@@ -1,3 +0,0 @@
-const autodetect = require('./autodetect')
-
-module.exports = autodetect

package/n2k-signalk.js

@@ -1,195 +0,0 @@
-/*
- * Copyright 2014-2015 Fabian Tollenaar <fabian@starting-point.nl>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const Transform = require('stream').Transform
-
-const N2kMapper = require('@signalk/n2k-signalk').N2kMapper
-
-require('util').inherits(ToSignalK, Transform)
-
-function ToSignalK(options) {
-  Transform.call(this, {
-    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) => {
-      return (f.source && f.source.length) || (f.pgn && f.pgn.length)
-    })
-  }
-
-  this.n2kMapper = new N2kMapper({ ...options, sendMetaData: true })
-
-  this.n2kMapper.on('n2kOut', (pgn) => this.app.emit('nmea2000JsonOut', pgn))
-
-  this.n2kMapper.on('n2kSourceMetadata', (n2k, meta) => {
-    const existing = this.sourceMeta[n2k.src] || {}
-    this.sourceMeta[n2k.src] = {
-      ...existing,
-      ...meta
-    }
-    const delta = {
-      context: this.app.selfContext,
-      updates: [
-        {
-          source: {
-            ...this.sourceMeta[n2k.src],
-            label: this.options.providerId,
-            type: 'NMEA2000',
-            pgn: Number(n2k.pgn),
-            src: n2k.src.toString()
-          },
-          timestamp:
-            n2k.timestamp.substring(0, 10) +
-            'T' +
-            n2k.timestamp.substring(11, n2k.timestamp.length),
-          values: []
-        }
-      ]
-    }
-    this.app.deltaCache.setSourceDelta(
-      `${this.options.providerId}.${n2k.src}`,
-      delta
-    )
-  })
-
-  this.n2kMapper.on('n2kSourceMetadataTimeout', (pgn, src) => {
-    if (pgn == 60928) {
-      console.warn(`n2k-signalk: unable to detect can name for src ${src}`)
-      this.sourceMeta[src].unknowCanName = true
-    }
-  })
-
-  this.n2kMapper.on('n2kSourceChanged', (src, from, to) => {
-    console.warn(`n2k-signalk: address ${src} changed from ${from} ${to}`)
-    if (this.sourceMeta[src]) {
-      delete this.sourceMeta[src]
-    }
-  })
-
-  if (this.app.isNmea2000OutAvailable) {
-    this.n2kMapper.n2kOutIsAvailable(this.app, n2kOutEvent)
-  } else {
-    this.app.on('nmea2000OutAvailable', () =>
-      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._transform = function (chunk, encoding, done) {
-  try {
-    const delta = this.n2kMapper.toDelta(chunk)
-
-    const src = Number(chunk.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) {
-        delete delta.updates[0].source.canName
-      }
-
-      const canName = delta.updates[0].source.canName
-
-      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)
-                  }
-                }, 5000)
-                this.notifications[kv.path][src] = {
-                  lastTime: Date.now(),
-                  interval: interval
-                }
-              } else {
-                this.notifications[kv.path][src].lastTime = Date.now()
-              }
-            }
-          }
-        })
-      })
-      this.push(delta)
-    }
-  } catch (ex) {
-    console.error(ex)
-  }
-  done()
-}
-
-module.exports = ToSignalK

package/n2kAnalyzer.js

@@ -1,82 +0,0 @@
-/*
- * Copyright 2014-2015 Fabian Tollenaar <fabian@starting-point.nl>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
-
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const Transform = require('stream').Transform
-
-function N2KAnalyzer(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-
-  this.analyzerOutEvent = options.analyzerOutEvent || 'N2KAnalyzerOut'
-
-  if (process.platform === 'win32') {
-    this.analyzerProcess = require('child_process').spawn('cmd', [
-      '/c',
-      'analyzer -json -si -camel'
-    ])
-  } else {
-    this.analyzerProcess = require('child_process').spawn('sh', [
-      '-c',
-      'analyzer -json -si -camel'
-    ])
-  }
-  this.analyzerProcess.stderr.on('data', function (data) {
-    console.error(data.toString())
-  })
-  this.analyzerProcess.on('close', function (code) {
-    console.error('Analyzer process exited with code ' + code)
-  })
-
-  this.linereader = require('readline').createInterface(
-    this.analyzerProcess.stdout,
-    this.analyzerProcess.stdin
-  )
-  const that = this
-  this.linereader.on('line', function (data) {
-    try {
-      let parsed = JSON.parse(data)
-      if (parsed.version) {
-        console.log('Connected to analyzer v' + parsed.version)
-        return
-      }
-      that.push(parsed)
-      options.app.emit(that.analyzerOutEvent, parsed)
-    } catch (ex) {
-      console.error(data)
-      console.error(ex.stack)
-    }
-  })
-}
-
-require('util').inherits(N2KAnalyzer, Transform)
-
-N2KAnalyzer.prototype._transform = function (chunk, encoding, done) {
-  this.analyzerProcess.stdin.write(chunk.toString() + '\n')
-  done()
-}
-N2KAnalyzer.prototype.pipe = function (pipeTo) {
-  this.pipeTo = pipeTo
-  N2KAnalyzer.super_.prototype.pipe.call(this, pipeTo)
-}
-
-N2KAnalyzer.prototype.end = function () {
-  console.log('end, killing child analyzer process')
-  this.analyzerProcess.kill()
-  this.pipeTo.end()
-}
-
-module.exports = N2KAnalyzer