Version 0.4.0

lib/modules/citizen/mail/detect-mail.js

@@ -0,0 +1,30 @@
+module.exports = function( citizen, config ){
+
+  citizen.hook.add( 'supervisor-ipc', 'detect-mail', function( details ){
+    if( ! details || ! details.hasOwnProperty( 'data' ) ) return;
+
+    var envelope = details.data;
+
+    if( Object.prototype.toString.call( envelope ) !== '[object Object]' ) return;
+    if( ! envelope.hasOwnProperty( 'type' ) ) return;
+    if( envelope.type !== 'mail' ) return;
+
+    var mail_handled = false;
+
+    citizen.hook.run( 'citizen-mail', envelope, ack_current_mail );
+
+    if( ! mail_handled ){
+      citizen.hook.run( 'unhandled-citizen-mail', envelope );
+      ack_current_mail();
+    }
+
+    citizen.hook.end();
+
+    function ack_current_mail(){
+      mail_handled = true;
+
+      citizen.signal.send( 'ACK-CURRENT-MAIL' );
+      citizen.hook.end();
+    }
+  });
+}

lib/modules/citizen/mail/log-unhandled-mail.js

@@ -0,0 +1,6 @@
+module.exports = function( citizen ){
+
+  citizen.hook.add( 'unhandled-citizen-mail', 'log-unhandled-mail', function( envelope ){
+    console.log({ action: 'log-unhandled-mail', envelope: envelope });
+  });
+}

lib/modules/citizen/mail/receive-mail.js

@@ -1,27 +1,6 @@
-var current_receive_callback,
-    setup_listener = false;
-
 module.exports = function( citizen, config ){
 
-  if( !setup_listener ){
-
-    process.on( 'message', function( envelope ){
-
-      if( !envelope.type || envelope.type !== 'mail' ) return;
-      if( typeof current_receive_callback !== 'function' ) return;
-
-      current_receive_callback( envelope, function(){ citizen.signal.send( 'ACK-CURRENT-MAIL' ); } );
-    });
-
-    setup_listener = true;
-  }
-
-  citizen.mail.receive = function receive_mail( receive_callback ){
-
-    if( !current_receive_callback && ( !receive_callback || typeof receive_callback !== 'function' ) ) throw new Error( 'mail.receive requires a function to pass received messages to' );
-
-    if( receive_callback && typeof receive_callback === 'function' ) current_receive_callback = receive_callback;
-
+  citizen.mail.receive = function receive_mail(){
     citizen.signal.send( 'READY-TO-RECEIVE-MAIL' );
   }
 }

lib/modules/citizen/mail/send-mail.js

@@ -3,8 +3,7 @@ var merge = require('merge-objects');
 module.exports = function( citizen, config ){
 
   citizen.mail.send = function send_mail( settings, msg ){
-
-    if( !msg ){
+    if( ! msg ){
       msg = settings;
       settings = {};
     }

lib/modules/citizen/signal/detect-signal.js

@@ -0,0 +1,15 @@
+module.exports = function( citizen, config ){
+
+  citizen.hook.add( 'supervisor-ipc', 'detect-signal', function( details ){
+    if( ! details || ! details.hasOwnProperty( 'data' ) ) return;
+
+    var envelope = details.data;
+
+    if( Object.prototype.toString.call( envelope ) !== '[object Object]' ) return;
+    if( ! envelope.hasOwnProperty( 'type' ) ) return;
+    if( envelope.type !== 'signal' ) return;
+
+    citizen.hook.run( 'supervisor-signal', envelope );
+    citizen.hook.end();
+  });
+}

lib/modules/citizen/signal/send-signal.js

@@ -1,12 +1,10 @@
 module.exports = function( citizen, config ){
 
   citizen.signal.send = function send_signal( signal, data ){
-
-    if( !signal ) return;
+    if( ! signal ) return;
     if( typeof signal !== 'string' ) throw new Error( 'signal must be a string' );
 
     var envelope = { type: 'signal', signal: signal };
-
     if( data ) envelope.data = data;
 
     process.send( envelope );

lib/modules/citizen/supervision/create-supervisor-output-hooks.js

@@ -0,0 +1,6 @@
+module.exports = function( citizen ){
+
+  process.on( 'message', function( msg ){
+    citizen.hook.run( 'supervisor-ipc', { data: msg });
+  });
+}

lib/modules/citizen/supervision/get-citizen-name.js

@@ -1,5 +1,5 @@
-module.exports = function( supe ){
-  supe.get_name = get_name;
+module.exports = function( citizen ){
+  citizen.get_name = get_name;
 
   function get_name(){
     return process.env.SUPE_CITIZEN_NAME;

lib/modules/citizen/supervision/handle-shutdown-signal.js

@@ -1,13 +1,19 @@
 var shutdown_initiated = false,
+    shutdown_hook_running = false,
     delays = 0;
 
 module.exports = function( citizen, config ){
 
-  citizen.signal.watch( 'SUPE-SHUTDOWN', 'supe-initiate-shutdown', function(){
+  citizen.hook.add( 'supervisor-signal', 'handle-shutdown-request', function( envelope ){
+    if( ! envelope || ! envelope.signal || envelope.signal !== 'SUPE-SHUTDOWN' ) return;
     if( shutdown_initiated ) return;
-    else shutdown_initiated = true;
+
+    shutdown_initiated = true;
+    shutdown_hook_running = true;
 
     citizen.hook.run( 'shutdown', delay_shutdown );
+
+    shutdown_hook_running = false;
     if( ! delays ) return process.exit();
   });
 
@@ -18,6 +24,6 @@ module.exports = function( citizen, config ){
 
   function clear_delay(){
     delays -= 1;
-    if( ! delays ) process.exit();
+    if( ! shutdown_hook_running && ! delays ) process.exit();
   }
 }

lib/modules/citizen/supervisor-noticeboard-bindings/ignore-notice.js

@@ -3,11 +3,9 @@ module.exports = function( citizen, noticeboard, config ){
   citizen.noticeboard.ignore = ignore_wrapper;
 
   function ignore_wrapper( notice, watcher ){
-
     noticeboard.ignore( notice, watcher );
 
     if( noticeboard.watchers[ notice ] && noticeboard.watchers[ notice ].length > 0 ) return;
-
-    citizen.signal.send( 'NOTICEBOARD-REQUEST', { type: 'ignore', notice: notice });
+    else citizen.signal.send( 'NOTICEBOARD-REQUEST', { type: 'ignore', notice: notice });
   }  
 }

lib/modules/citizen/supervisor-noticeboard-bindings/process-supervisor-noticeboard-signals.js

@@ -1,64 +1,43 @@
 module.exports = function( citizen, noticeboard, config ){
 
-  process.on( 'message', function( envelope ){
+  citizen.hook.add( 'supervisor-signal', 'handle-noticeboard-responses', function( envelope ){
+    if( ! envelope || ! envelope.signal || envelope.signal !== 'NOTICEBOARD-RESPONSE' ) return;
 
-    if( !envelope || !envelope.type || envelope.type !== 'signal' ) return;
-    if( envelope.signal.indexOf( 'NOTICEBOARD' ) !== 0 ) return;
+    var data = envelope.data;
+    if( ! data.type ) return console.log({ action: 'handle-noticeboard-responses', success: false, error: 'no noticeboard action type found' });
 
-    switch( envelope.signal ){
+    switch( data.type ){
 
-      case 'NOTICEBOARD-RESPONSE':
+      case 'watch':
+        if( ! data.success ) citizen.noticeboard.pending[ data.notice ].callback( new Error( data.error || 'unidentified error' ) );
+        else citizen.noticeboard.pending[ data.notice ].callback();
 
-        var data = envelope.data;
-
-        if( !data.type ) return;
-
-        switch( data.type ){
-
-          case 'watch':
-
-            if( !data.success ) citizen.noticeboard.pending[ data.notice ].callback( new Error( data.error || 'unidentified error' ) );
-
-            else citizen.noticeboard.pending[ data.notice ].callback();
-
-            delete citizen.noticeboard.pending[ data.notice ];
-
-            noticeboard.notify( data.notice + '-pipe-installed' );
-
-          break;
-
-          case 'ignore': 
-
-            if( !data.success ) throw new Error( data.error || 'attempt to ignore supervisor notice "' + data.notice + '" failed' );
-
-          break;
-
-          case 'notify': 
-
-            if( !data.success ) throw new Error( data.error || 'attempt to send notice "' + data.notice + '" to supervisor failed' );
-
-          break;
-        }
+        delete citizen.noticeboard.pending[ data.notice ];
 
+        noticeboard.notify( data.notice + '-pipe-installed' );
       break;
 
-      case 'NOTICEBOARD-EVENT':
-
-        var data = envelope.data;
-
-        if( !data.type ) return;
-
-        switch( data.type ){
+      case 'ignore':
+        if( ! data.success ) throw new Error( data.error || 'attempt to ignore supervisor notice "' + data.notice + '" failed' );
+      break;
 
-          case 'notice':
+      case 'notify':
+        if( ! data.success ) throw new Error( data.error || 'attempt to send notice "' + data.notice + '" to supervisor failed' );
+      break;
+    }
+  });
 
-            if( !data.notice ) return;
+  citizen.hook.add( 'supervisor-signal', 'handle-noticeboard-events', function( envelope ){
+    if( ! envelope || ! envelope.signal || envelope.signal !== 'NOTICEBOARD-EVENT' ) return;
 
-            noticeboard.notify( data.notice, data.msg.notice, 'supe' );
+    var data = envelope.data;
+    if( ! data.type ) return console.log({ action: 'handle-noticeboard-events', success: false, error: 'no noticeboard event type found' });
 
-          break;
-        }
+    switch( data.type ){
 
+      case 'notice':
+        if( ! data.notice ) return console.log({ action: 'handle-noticeboard-events', success: false, error: 'event notice name not found' });
+        else noticeboard.notify( data.notice, data.msg.notice, 'supe' );
       break;
     }
   });

lib/modules/citizen/supervisor-noticeboard-bindings/send-notice.js

@@ -3,7 +3,6 @@ module.exports = function( citizen, noticeboard, config ){
   citizen.noticeboard.notify = notify_wrapper;
 
   function notify_wrapper( notice, message, source ){
-
     citizen.signal.send( 'NOTICEBOARD-REQUEST', { type: 'notify', notice: notice, message: message, source: source });
   }
 }

lib/modules/citizen/supervisor-noticeboard-bindings/watch-notice-once.js

@@ -3,11 +3,9 @@ module.exports = function( citizen, noticeboard, config ){
   citizen.noticeboard.once = once_wrapper;
 
   function once_wrapper( notice, watcher, callback, opts ){
-
-    if( !opts ) opts = {};
+    if( ! opts ) opts = {};
 
     opts.once = true; 
-
     return citizen.noticeboard.watch( notice, watcher, callback, opts );
   }
 }

lib/modules/citizen/supervisor-noticeboard-bindings/watch-notice.js

@@ -7,11 +7,9 @@ module.exports = function( citizen, noticeboard, config ){
     var method = opts && opts.once ? 'once' : 'watch';
 
     if( method === 'once' ){
-
       callback = function( real_callback ){
 
         return function( msg ){
-
           real_callback( msg );
           citizen.noticeboard.ignore( notice, watcher );
         }
@@ -21,7 +19,6 @@ module.exports = function( citizen, noticeboard, config ){
     // if there is an active watcher, pipe is still installed
     // -- do a normal watch
       if( noticeboard.watchers[ notice ] && noticeboard.watchers[ notice ].length > 0 ){
-
         noticeboard[ method ]( notice, watcher, callback, opts );
       }
 
@@ -30,7 +27,6 @@ module.exports = function( citizen, noticeboard, config ){
       else if( citizen.noticeboard.pending[ notice ] ){
 
         noticeboard.once( notice + '-pipe-installed', 'pipe-to-' + watcher, function(){
-
           noticeboard[ method ]( notice, watcher, callback, opts );
         });
       }
@@ -40,16 +36,13 @@ module.exports = function( citizen, noticeboard, config ){
       else {
 
         citizen.noticeboard.pending[ notice ] = {
-
           type: 'watch',
           notice: notice,
           opts: opts,
 
           callback: function( error ){
-
             if( error ) throw error;
-
-            noticeboard[ method ]( notice, watcher, callback, opts );
+            else noticeboard[ method ]( notice, watcher, callback, opts );
           }
         };
 

lib/modules/supervisor/mail/actions/add-mail-to-citizen-inbox.js

@@ -0,0 +1,4 @@
+module.exports = function( supervisor, citizen, envelope ){
+  citizen.mail.inbox.push( envelope );
+  supervisor.hook.run( 'mail-added-to-inbox', { citizen: citizen.name });
+}

lib/modules/supervisor/mail/actions/requeue-current-mail.js

@@ -0,0 +1,6 @@
+module.exports = function( supervisor, citizen ){
+  if( ! citizen.state.current_mail ) return;
+
+  citizen.mail.inbox.splice( 0, 0, citizen.state.current_mail );
+  citizen.state.current_mail = null;
+}