@signalk/streams 1.16.2 → 2.0.0

package/README.md

@@ -0,0 +1,14 @@
+# @signalk/streams
+
+Used within the [Signal K](http://signalk.org) [Node Server](https://github.com/SignalK/signalk-server-node) for streaming and converting input data in different formats.
+
+The code is not compiled and is not more effective, but allows using the streams and their conversions independently outside the server.
+
+## Development
+
+* Install dev packages with `npm i`.
+* Edit files with `/src`.
+* `npm link`
+* `cd ../../`
+* `npm link @signalk/streams`
+* Restart signalk `npm start`

package/canboatjs.js

@@ -30,7 +30,7 @@ function CanboatJs (options) {
     debug(`[warning] ${pgn.pgn} ${warning}`)
   })
 
-  this.fromPgn.on('error', (err) => {console.log(err)} )
+  this.fromPgn.on('error', (pgn, err) => {console.log(err)} )
 
   this.app = options.app
 }

package/logging.js

@@ -28,6 +28,53 @@ module.exports = {
   listLogFiles
 }
 
+class FileTimestampStreamWithDelete extends FileTimestampStream {
+  constructor(app, fullLogDir, filesToKeep, options){
+    super(options)
+    this.app = app
+    this.filesToKeep = filesToKeep
+    this.fullLogDir = fullLogDir
+    this.prevFilename = undefined
+  }
+
+  // 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)
 
@@ -36,10 +83,21 @@ function getLogger (app, discriminator = '', logdir) {
 
     debug(`logging to ${fileName}`)
 
-    loggers[fullLogdir] = new FileTimestampStream({
-      path: fileName
-    })
+    let fileTimestampStream
+    if (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}`)

package/package.json

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

package/s3.js

@@ -15,7 +15,15 @@
  */
 
 var Transform = require('stream').Transform
-const AWS = require('aws-sdk')
+/*
+  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 }) {

package/simple.js

@@ -27,6 +27,10 @@ const pigpioSeatalk = require('./pigpio-seatalk')
 function Simple (options) {
   Transform.call(this, { objectMode: true })
 
+  const { emitPropertyValue, onPropertyValues } = options
+  options = { ...options }
+  options.subOptions = { ...options.subOptions, emitPropertyValue, onPropertyValues }
+
   options.subOptions.providerId = options.providerId
   const dataType = options.subOptions.dataType || options.type
   if (!dataType) {
@@ -167,7 +171,7 @@ const dataTypeMapping = {
     return result.concat([new N2kToSignalK(options.subOptions)])
   },
   NMEA2000YD: options => {
-    const result = [new Ydwg02(options, options.subOptions.type === 'ydwg02-usb-canboatjs' ? 'usb' : 'network')]
+    const result = [new Ydwg02(options.subOptions, options.subOptions.type === 'ydwg02-usb-canboatjs' ? 'usb' : 'network')]
     if (options.type === 'FileStream') {
       result.push(new TimestampThrottle())
     }