Move broadcaster into library, use in all exercises, refactor notifier slightly

Alan Shaw · Alan Shaw · commit 08a457000eef · 2014-07-03T22:52:20.000-07:00
diff --git a/exercises/blink_blink/exercise.js b/exercises/blink_blink/exercise.js
@@ -7,7 +7,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Blink blink')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 
 // checks that the submission file actually exists
@@ -57,9 +58,9 @@ exercise.addVerifyProcessor(function (callback) {
     expect(io.digitalWrite.calledWith(13, io.HIGH)).to.be.true
     expect(io.digitalWrite.calledWith(13, io.LOW)).to.be.true
 
-    notifier(callback)
+    broadcaster(exercise)(function (er) { notifier(exercise)(er, callback) })
   } catch(error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/fire_alarm/exercise.js b/exercises/fire_alarm/exercise.js
@@ -7,7 +7,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Fire alarm')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -63,14 +64,14 @@ exercise.addVerifyProcessor(function (callback) {
     expect(io.digitalWrite.called, 'Fire alarm went off before a temperature was received!').to.be.false
 
     testAlarmTurnsOff(analogReadListener, io, function (error) {
-      if (error) return notifier(error, callback)
+      if (error) return broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
 
       testAlarmResets(analogReadListener, io, function (error) {
-        notifier(error, callback)
+        broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
       })
     })
   } catch (error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/light_switch/exercise.js b/exercises/light_switch/exercise.js
@@ -7,7 +7,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Light switch')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -108,9 +109,9 @@ exercise.addVerifyProcessor(function (callback) {
       expect(led.off.callCount, 'LED did not turn off after fourth button press').to.be.equal(initial.off.callCount + 2)
     }
 
-    notifier(callback)
+    broadcaster(exercise)(function (er) { notifier(exercise)(er, callback) })
   } catch(error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/ping_bell/exercise.js b/exercises/ping_bell/exercise.js
@@ -8,7 +8,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Ping bell')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -63,14 +64,14 @@ exercise.addVerifyProcessor(function (callback) {
           'Piezo didn\'t play a tone when sent a UDP message')
             .to.be.gt(initial.tone.callCount)
 
-        notifier(callback)
+        broadcaster(exercise)(function (er) { notifier(exercise)(er, callback) })
       } catch (error) {
-        notifier(error, callback)
+        broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
       }
     }, 500)
 
   } catch (error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/remote_temperature/exercise.js b/exercises/remote_temperature/exercise.js
@@ -9,7 +9,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Remote temperature')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -64,7 +65,10 @@ exercise.addVerifyProcessor(function (callback) {
 
     d.on('remote', function (remote) {
       if (!remote.getTemperature) {
-        return callback(new Error('Remote has no method \'getTemperature\''), false)
+        return broadcaster(exercise)(
+          new Error('Remote has no method \'getTemperature\''),
+          function (er) { notifier(exercise)(er, callback) }
+        )
       }
 
       async.eachSeries(
@@ -90,16 +94,16 @@ exercise.addVerifyProcessor(function (callback) {
           }, 1000)
         },
         function (error) {
-          notifier(error, callback)
+          broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
         })
     })
 
     d.on('error', function (error) {
-      notifier(error, callback)
+      broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
     })
 
   } catch (error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/robot_arm/exercise.js b/exercises/robot_arm/exercise.js
@@ -8,7 +8,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Robot arm')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -100,11 +101,11 @@ exercise.addVerifyProcessor(function (callback) {
         }, sensor.freq + 0)
       },
       function (error) {
-        notifier(error, callback)
+        broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
       })
 
   } catch(error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/servo_wave/exercise.js b/exercises/servo_wave/exercise.js
@@ -7,7 +7,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Servo wave')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -60,9 +61,9 @@ exercise.addVerifyProcessor(function (callback) {
     expect(stop0.calledBefore(toLast), 'servo did not stop before returning to center').to.be.true
     expect(toLast.args[0], 'servo did not return to center').to.equal(90)
 
-    notifier(callback)
+    broadcaster(exercise)(function (er) { notifier(exercise)(er, callback) })
   } catch(error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/spin_motor_spin/exercise.js b/exercises/spin_motor_spin/exercise.js
@@ -7,7 +7,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Spin motor spin')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -73,9 +74,9 @@ exercise.addVerifyProcessor(function (callback) {
     expect(start1.calledAfter(wait1), 'motor didn\'t start again after 1 second')
     expect(start1.args[0], 'motor not started again at 200').to.equal(200)
 
-    notifier(callback)
+    broadcaster(exercise)(function (er) { notifier(exercise)(er, callback) })
   } catch(error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/exercises/street_lamp/exercise.js b/exercises/street_lamp/exercise.js
@@ -7,7 +7,8 @@ var filecheck = require('workshopper-exercise/filecheck')
 var execute = require('workshopper-exercise/execute')
 var wrappedexec = require('workshopper-wrappedexec')
 var path = require('path')
-var notifier = require('../../lib/notifier')('Street lamp')
+var notifier = require('../../lib/notifier')
+var broadcaster = require('../../lib/broadcaster')
 
 // checks that the submission file actually exists
 exercise = filecheck(exercise)
@@ -69,7 +70,7 @@ exercise.addVerifyProcessor(function (callback) {
       try {
         expect(led.on.called, 'led was not turned on when resistor value high').to.be.true
       } catch (er) {
-        callback(er, false)
+        return broadcaster(exercise)(er, function (er) { notifier(exercise)(er, callback) })
       }
 
       analogReadListener(random(0, 600))
@@ -82,7 +83,7 @@ exercise.addVerifyProcessor(function (callback) {
             'led was not turned off after it was turned on'
           ).to.be.true
         } catch (er) {
-          callback(er, false)
+          return broadcaster(exercise)(er, function (er) { notifier(exercise)(er, callback) })
         }
 
         analogReadListener(random(600, 900))
@@ -93,16 +94,16 @@ exercise.addVerifyProcessor(function (callback) {
               led.on.lastCall.calledAfter(led.off.lastCall),
               'led was not turned on after it was turned off'
             ).to.be.true
-            notifier(callback)
+            broadcaster(exercise)(function (er) { notifier(exercise)(er, callback) })
           } catch (error) {
-            notifier(error, callback)
+            broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
           }
         }, freq)
       }, freq)
     }, freq)
 
   } catch (error) {
-    notifier(error, callback)
+    broadcaster(exercise)(error, function (er) { notifier(exercise)(er, callback) })
   }
 })
 
diff --git a/lib/broadcaster.js b/lib/broadcaster.js
@@ -0,0 +1,32 @@
+var dgram = require('dgram')
+
+module.exports = function (exercise) {
+  return function (er, cb) {
+    if (!cb) {
+      cb = er
+      er = null
+    }
+
+    var sock = dgram.createSocket('udp4')
+      , packet = new Buffer(JSON.stringify({
+        workshop: exercise.workshopper.title,
+        exercise: exercise.name,
+        event: er ? 'fail' : 'pass',
+        timestamp: Date.now()
+      }))
+      , port = process.env.PROGRESS_BROADCAST_PORT || 1138
+
+    try {
+      sock.bind(port, '0.0.0.0', function (er) {
+        if (er) return;
+        sock.setBroadcast(true)
+
+        sock.send(packet, 0, packet.length, port, '255.255.255.255', function () {
+          sock.close()
+        })
+      })
+    } catch (er) {}
+
+    cb(er)
+  }
+}
diff --git a/lib/notifier.js b/lib/notifier.js
@@ -7,7 +7,7 @@ try {
   notifier = new Notification();
 } catch(e) {}
 
-module.exports = function(excercise) {
+module.exports = function (excercise) {
   return function(error, callback) {
     if(!callback) {
       callback = error
@@ -17,7 +17,7 @@ module.exports = function(excercise) {
     try {
       notifier.notify({
           title: 'nodebot-workshop',
-          message: excercise + (error ? ' failed :(' : ' passed :)'),
+          message: excercise.name + (error ? ' failed :(' : ' passed :)'),
           appIcon: __dirname + '/../assets/nodebots.png',
           contentImage: __dirname + '/../assets/' + (error ? 'sad' : 'happy') + '_robot' + ~~(Math.random() * 5) + '.jpg'
       })
diff --git a/nodebot-workshop.js b/nodebot-workshop.js
@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 
-const dgram       = require('dgram')
-    , workshopper = require('workshopper')
+const workshopper = require('workshopper')
     , path        = require('path')
     , name        = 'nodebot-workshop'
     , title       = 'Nodebot Workshop'
@@ -11,7 +10,7 @@ function fpath (f) {
   return path.join(__dirname, f)
 }
 
-var nodebot = workshopper({
+workshopper({
     name        : name
   , title       : title
   , subtitle    : subtitle
@@ -20,33 +19,4 @@ var nodebot = workshopper({
   , helpFile    : fpath('help.txt')
   , menuItems   : []
   , menu        : {fg: 'black', bg: /^win/.test(process.platform) ? 'yellow' : 220}
-})
-
-function broadcastProgress (event, exercise, mode, msg) {
-  var sock = dgram.createSocket('udp4')
-    , packet = new Buffer(JSON.stringify({
-        workshop: title,
-        exercise: exercise.title,
-        mode: mode,
-        msg: msg,
-        event: event
-      }))
-    , port = process.env.PROGRESS_BROADCAST_PORT || 1337
-
-  sock.bind(port, '0.0.0.0', function (er) {
-    if (er) return;
-    sock.setBroadcast(true)
-
-    sock.send(packet, 0, packet.length, port, '255.255.255.255', function () {
-      sock.close()
-    })
-  })
-}
-
-nodebot.on('pass', function (exercise, mode) {
-  broadcastProgress('pass', exercise, mode)
-})
-
-nodebot.on('fail', function (exercise, mode) {
-  broadcastProgress('fail', exercise, mode)
 })
