0.3.4

Adds `server` options `connectRedux` and `getStatistics`

Author: grrowl

.travis.yml

@@ -3,8 +3,3 @@ language: node_js
 node_js:
   - 6.0
   - 7.0
-
-# configure notifications (email, IRC, campfire etc)
-# please update this section to your needs!
-notifications:
-  irc: "irc.freenode.org#travis"

CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.3.4
+
+* Adds `server` options `connectRedux` and `getStatistics`
+
+# 0.3.3
+
+* Fixes initialState always being undefined, now uses
+  `orderedHistory.getInitialState`
+* Default `getDelayedDispatch` moved to its own file.
+* Now depends on [`scuttlebutt-vector`](https://github.com/grrowl/scuttlebutt),
+  instead pointing to a github branch.
+
 # 0.3.2
 
 * Exports `devToolsStateSanitizer`to better display state in redux dev-tools.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-scuttlebutt",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Redux distributed dispatcher",
   "main": "lib/index.js",
   "engines": {

src/server.js

@@ -4,57 +4,18 @@ const INFILE = process.env['INFILE'],
   OUTFILE = process.env['OUTFILE'],
   REMOTE_SB = process.env['REMOTE_SB']
 
-export default function scuttlebuttServer(server) {
-  const primusServer = new (require('primus'))(server, {}),
-      Dispatcher = require('./dispatcher').default,
-      gossip = new Dispatcher()
-
-  const statistics = {}
-
-  var statisticsDirty = true
-
-  // prime statistics for when spark.id is undefined, presumably server messages
-  statistics[undefined] = {
-    recv: 0, sent: 0, s: 'other'
-  }
-
-  setInterval(() => {
-    if (!statisticsDirty)
-      return
-
-    statisticsDirty = false
-
-    /*
-    // full client statistics
-    console.log('# ' + (new Date()) + '')
-    for (let spark in statistics) {
-      console.log(`${spark}: ${statistics[spark].recv} recv ${statistics[spark].sent} sent (${statistics[spark].s})`)
-    }
-    */
-
-    // basic statistics
-    console.log([
-      (new Date()).toLocaleString('en-AU'),
-      ': ',
-      (() => {
-        let recv = 0, sent = 0, connected = 0, disconnected = 0, other = 0
-        for (let spark in statistics) {
-          recv += statistics[spark].recv
-          sent += statistics[spark].sent
-
-          if (statistics[spark].s === 'connected')
-            connected++
-          else if (statistics[spark].s === 'disconnected')
-            disconnected++
-          else
-            other++
-        }
+const defaultOptions = {
+  connectRedux,
+  getStatistics,
+}
 
-        return `recv ${recv}, sent ${sent}, (${connected} 🌏, ${disconnected} 🔕, ${other} 👥)`
-      })()
-    ].join(''))
+export default function scuttlebuttServer(server, options) {
+  options = { ...defaultOptions, ...options }
 
-  }, 10000) // max 6/minute
+  const primusServer = new (require('primus'))(server, {}),
+      Dispatcher = require('./dispatcher').default,
+      gossip = new Dispatcher(),
+      onStatistic = getStatistics()
 
   // connect dispatcher to redux
   connectRedux(gossip)
@@ -100,23 +61,20 @@ export default function scuttlebuttServer(server) {
 
     remoteClient.pipe(remoteStream).pipe(remoteClient)
 
-    statistics['REMOTE_SB'] = {
-      recv: 0, sent: 0, s: 'remote'
-    }
+    onStatistic('REMOTE_SB', 'connect')
 
     remoteClient.on('data', function recv(data) {
       // console.log('[io]', 'REMOTE_SB', '<-', data);
-      statistics['REMOTE_SB'].recv++
-      statisticsDirty = true
+      onStatistic('REMOTE_SB', 'recv')
     });
 
     remoteStream.on('data', (data) => {
       // console.log('[io]', 'REMOTE_SB' || 'origin', '->', data);
-      statistics['REMOTE_SB'].sent++
-      statisticsDirty = true
+      onStatistic('REMOTE_SB', 'sent')
     })
 
     remoteStream.on('error', (error) => {
+      onStatistic('REMOTE_SB', 'error', error)
       console.log('[io]', 'REMOTE_SB', 'ERROR:', error);
       remoteClient.end('Disconnecting due to error', { reconnect: true })
     })
@@ -127,33 +85,29 @@ export default function scuttlebuttServer(server) {
 
     // console.log('[io] connection', spark.address, spark.id)
 
-    statistics[spark.id] = {
-      recv: 0, sent: 0, s: 'connected'
-    }
+    onStatistic(spark.id, 'connect')
 
     spark.on('data', function recv(data) {
       // console.log('[io]', spark.id, '<-', data);
-      statistics[spark.id].recv++
-      statisticsDirty = true
+      onStatistic(spark.id, 'recv')
       stream.write(data)
     });
 
     stream.on('data', (data) => {
       // console.log('[io]', spark.id || 'origin', '->', data);
-      statistics[spark.id].sent++
-      statisticsDirty = true
+      onStatistic(spark.id, 'sent')
       spark.write(data)
     })
 
     stream.on('error', (error) => {
+      onStatistic(spark.id, 'error', error)
       console.log('[io]', spark.id, 'ERROR:', error);
       spark.end('Disconnecting due to error', { reconnect: true })
     })
   })
 
   primusServer.on('disconnection', (spark) => {
-    statistics[spark.id].s = 'disconnected'
-    statisticsDirty = true
+    onStatistic(spark.id, 'disconnect')
     // in case you don't want to track zombie connections
     // delete statistics[spark.id]
   })
@@ -171,3 +125,71 @@ function connectRedux(gossip) {
   // store.subscribe(render)
   // setInterval(function () { dispatch({ type: 'TICK' }) }, 1000)
 }
+
+function getStatistics() {
+  const statistics = {}
+
+  var statisticsDirty = true
+
+  // prime statistics for when spark.id is undefined, presumably server messages
+  statistics[undefined] = {
+    recv: 0, sent: 0, s: 'other'
+  }
+
+  setInterval(() => {
+    if (!statisticsDirty)
+      return
+
+    statisticsDirty = false
+
+    /*
+    // full client statistics
+    console.log('# ' + (new Date()) + '')
+    for (let spark in statistics) {
+      console.log(`${spark}: ${statistics[spark].recv} recv ${statistics[spark].sent} sent (${statistics[spark].s})`)
+    }
+    */
+
+    // basic statistics
+    console.log([
+      (new Date()).toLocaleString('en-AU'),
+      ': ',
+      (() => {
+        let recv = 0, sent = 0, connected = 0, disconnected = 0, other = 0
+        for (let spark in statistics) {
+          recv += statistics[spark].recv
+          sent += statistics[spark].sent
+
+          if (statistics[spark].s === 'connected')
+            connected++
+          else if (statistics[spark].s === 'disconnected')
+            disconnected++
+          else
+            other++
+        }
+
+        return `recv ${recv}, sent ${sent}, (${connected} 🌏, ${disconnected} 🔕, ${other} 👥)`
+      })()
+    ].join(''))
+
+  }, 10000) // max 6/minute
+
+  return (source, event, extra) => {
+    statisticsDirty = true
+    if (event === 'connect') {
+      statistics[source] = {
+        recv: 0, sent: 0, s: 'connected'
+      }
+    } else if (event === 'disconnect') {
+      statistics[source] = {
+        recv: 0, sent: 0, s: 'disconnected'
+      }
+    } else if (event === 'error') {
+      statistics[source] = {
+        recv: 0, sent: 0, s: 'error', err: extra,
+      }
+    } else if (event === 'recv' || event === 'sent') {
+      statistics[source][event]++
+    }
+  }
+}