react 0.3.0 → 0.3.4

package/lib/track-tasks.js

@@ -0,0 +1,117 @@
+'use strict';
+
+/**
+   Track the tasks, start, complete, args, results, elapsed time
+   Emits events that can be monitored
+
+    - track start and complete
+    - record args each task was called with
+    - record results at completion
+    - record start, end, and calc elapsed time
+    - emits flow.begin with flowEnv
+    - emits task.begin with task
+    - emits task.complete with task
+    - emits flow complete with flowEnv
+    - emits flow errored with flowEnv
+  */
+
+
+var react = require('../');  // require('react');
+
+var TASK_EVENTS_RE = /^task\./;
+var FLOW_EVENTS_RE = /^flow\./;
+
+/**
+   Accumulator to make it easy to capture events
+
+   @example
+   var EventCollector = require('react/lib/track-tasks').EventCollector;
+   var collector = new EventCollector();
+   
+   collector.captureGlobal('*'); // capture all react events for all flows
+
+   // OR
+   
+   collector.capture(flowFn, 'task.'); // capture task events on a flow
+   collector.capture(flowFn, 'flow.'); // add capture flow events on a flow
+
+   var events = collector.list();  // retrieve the list of events
+  */
+function EventCollector() {
+  this.events = [];
+}
+
+/**
+   register listener to capture all events
+   @param eventId event id or wildcarded id
+  */
+EventCollector.prototype.captureGlobal = function (eventId) {
+  this.capture(react, eventId);
+};
+
+/**
+   register listener to capture events for a specific flow
+   @param flowFn the react flow function or can pass global react
+   @param eventId event id or wildcarded id
+  */
+EventCollector.prototype.capture = function (flowFn, eventId) {
+  var emitter = flowFn.events;
+  var self = this;
+  function accumEvents(obj) {
+    var eventObject = {
+      event: this.event,
+      time: Date.now()
+    };
+    if (FLOW_EVENTS_RE.test(this.event)) {
+      eventObject.env = obj;
+    } else if (TASK_EVENTS_RE.test(this.event)) {
+      eventObject.task = obj;
+    }
+    self.events.push(eventObject);      
+  }
+  emitter.on(eventId, accumEvents);
+};
+
+EventCollector.prototype.list = function () {
+  return this.events;
+};
+
+react.events.on(react.events.TYPES.EXEC_FLOW_START, function (env){
+  env.startTime = Date.now();
+  env.flowEmitter.emit(react.events.TYPES.FLOW_BEGIN, env); //fire public ev
+});
+
+react.events.on(react.events.TYPES.EXEC_TASK_START, function (task) {
+  task.startTime = Date.now();
+  task.env.flowEmitter.emit(react.events.TYPES.TASK_BEGIN, task); //fire public ev
+});
+
+react.events.on(react.events.TYPES.EXEC_TASK_COMPLETE, function (task) {
+  task.endTime = Date.now();
+  task.elapsedTime = task.endTime - task.startTime;
+  task.env.flowEmitter.emit(react.events.TYPES.TASK_COMPLETE, task); // fire public ev
+});
+
+react.events.on(react.events.TYPES.EXEC_TASK_ERRORED, function (task) {
+  task.endTime = Date.now();
+  task.elapsedTime = task.endTime - task.startTime;
+  task.env.flowEmitter.emit(react.events.TYPES.TASK_ERRORED, task); // fire public ev
+});
+
+react.events.on(react.events.TYPES.EXEC_FLOW_COMPLETE, function (env) {
+  env.endTime = Date.now();
+  env.elapsedTime = env.endTime - env.startTime;
+  env.flowEmitter.emit(react.events.TYPES.FLOW_COMPLETE, env); //fire public ev
+});
+
+react.events.on(react.events.TYPES.EXEC_FLOW_ERRORED, function (env) {
+  env.endTime = Date.now();
+  env.elapsedTime = env.endTime - env.startTime;
+  env.flowEmitter.emit(react.events.TYPES.FLOW_ERRORED, env); //fire public ev
+});
+
+
+
+
+module.exports = react;  // return react
+module.exports.EventCollector = EventCollector;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react",
   "description": "React is a javascript module to make it easier to work with asynchronous code, by reducing boilerplate code and improving error and exception handling while allowing variable and task dependencies when defining flow.",
-  "version": "0.3.0",
+  "version": "0.3.4",
   "author": "Jeff Barczewski <jeff.barczewski@gmail.com>",
   "repository": { "type": "git", "url": "http://github.com/jeffbski/react.git" },
   "bugs" : { "url": "http://github.com/jeffbski/react/issues" },

package/promise-resolve.js

@@ -14,9 +14,9 @@ var react = require('./');  // require('react');
 
 var PROMISE_SUFFIX = '__promise';  // added to param names that are promises
 
-react.events.on(react.events.TYPES.EXEC_TASKS_PRECREATE, function (taskEnv) {
-  var vConValues = taskEnv.vCon.values;
-  var promiseParams = taskEnv.ast.inParams.filter(function (p) {
+react.events.on(react.events.TYPES.EXEC_TASKS_PRECREATE, function (env) {
+  var vConValues = env.vCon.values;
+  var promiseParams = env.ast.inParams.filter(function (p) {
     var value = vConValues[p];
     return (value && typeof(value.then) === 'function');
   });
@@ -24,7 +24,7 @@ react.events.on(react.events.TYPES.EXEC_TASKS_PRECREATE, function (taskEnv) {
     var promiseName = p + PROMISE_SUFFIX;
     vConValues[promiseName] = vConValues[p];
     vConValues[p] = undefined;
-    taskEnv.taskDefs.push({
+    env.taskDefs.push({
       type: 'when',
       a: [promiseName],
       out: [p]

package/test/core.test.js

@@ -3,6 +3,7 @@
 var test = require('tap').test;
 
 var react = require('../react');
+var EventCollector = require('../lib/track-tasks').EventCollector;  // require('react/lib/track-tasks'); // turn on tracking
 
 function multiply(x, y, cb) { cb(null, x * y); }
 function add(x, y, cb) { cb(null, x + y); }
@@ -107,19 +108,17 @@ test('multi-step with after as nonarr fn', function (t) {
   });
   t.deepEqual(errors, [], 'no validation errors');
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
   
   fn(2, 3, function (err, c, d) {
     t.equal(err, null);
     t.equal(c, 6);
     t.equal(d, 5);
+    var events = collector.list();
     t.equal(events.length, 2, 'should have seen one task compl events');
-    t.equal(events[0].name, 'add', 'name matches');
-    t.equal(events[1].name, 'multiply', 'name matches');
+    t.equal(events[0].task.name, 'add', 'name matches');
+    t.equal(events[1].task.name, 'multiply', 'name matches');
     t.end();
   });
 });  
@@ -137,31 +136,29 @@ test('mixed multi-step with after as nonarr fn w/events', function (t) {
   });
   t.deepEqual(errors, [], 'no validation errors');
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
   
   fn(2, 3, function (err, c, d) {
     t.equal(err, null);
     t.equal(c, 6);
     t.equal(d, 5);
+    var events = collector.list();
     t.equal(events.length, 2, 'should have seen one task compl events');
-    t.equal(events[0].name, 'fnRetsSum', 'name matches');
-    t.ok(events[0].id, 'has unique id');
-    t.ok(events[0].startTime, 'has startTime');
-    t.ok(events[0].endTime, 'has endTime');
-    t.ok(events[0].elapsedTime !== undefined, 'has elapsedTime');    
-    t.ok(events[0].args, 'has args');
-    t.ok(events[0].results, 'has results');
-    t.equal(events[1].name, 'multiply', 'name matches');
-    t.ok(events[1].id, 'has unique id');
-    t.ok(events[1].startTime, 'has startTime');
-    t.ok(events[1].endTime, 'has endTime');
-    t.ok(events[1].elapsedTime !== undefined, 'has elapsedTime');    
-    t.ok(events[1].args, 'has args');
-    t.ok(events[1].results, 'has results');
+    t.equal(events[0].task.name, 'fnRetsSum', 'name matches');
+    t.ok(events[0].task.id, 'has unique id');
+    t.ok(events[0].task.startTime, 'has startTime');
+    t.ok(events[0].task.endTime, 'has endTime');
+    t.ok(events[0].task.elapsedTime !== undefined, 'has elapsedTime');    
+    t.ok(events[0].task.args, 'has args');
+    t.ok(events[0].task.results, 'has results');
+    t.equal(events[1].task.name, 'multiply', 'name matches');
+    t.ok(events[1].task.id, 'has unique id');
+    t.ok(events[1].task.startTime, 'has startTime');
+    t.ok(events[1].task.endTime, 'has endTime');
+    t.ok(events[1].task.elapsedTime !== undefined, 'has elapsedTime');    
+    t.ok(events[1].task.args, 'has args');
+    t.ok(events[1].task.results, 'has results');
     t.end();
   });
 });  
@@ -451,18 +448,16 @@ test('selectFirst with first succeeding', function (t) {
   });
   t.deepEqual(errors, [], 'no validation errors');
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
 
   fn(2, 3, function (err, c) {
     t.equal(err, null);
     t.equal(c, 6);
+    var events = collector.list();
     t.equal(events.length, 1, 'should have seen one task compl events');
-    t.equal(events[0].name, 'multiply', 'name matches');
-    t.deepEqual(events[0].results, [6], 'results match');
+    t.equal(events[0].task.name, 'multiply', 'name matches');
+    t.deepEqual(events[0].task.results, [6], 'results match');
     t.end();
   });
 });  
@@ -484,18 +479,16 @@ test('selectFirst with third succeeding', function (t) {
   });
   t.deepEqual(errors, [], 'no validation errors');
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
 
   fn(2, 3, function (err, c) {
     t.equal(err, null);
     t.equal(c, 5);
+    var events = collector.list();
     t.equal(events.length, 3, 'should have seen three task compl events');
-    t.equal(events[2].name, 'add', 'name matches');
-    t.deepEqual(events[2].results, [5], 'results match');
+    t.equal(events[2].task.name, 'add', 'name matches');
+    t.deepEqual(events[2].task.results, [5], 'results match');
     t.end();
   });
 });  
@@ -521,20 +514,18 @@ test('selectFirst forces order with third succeeding', function (t) {
   });
   t.deepEqual(errors, [], 'no validation errors');
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
 
   fn(2, 3, function (err, c) {
     t.equal(err, null);
     t.equal(c, 5);
+    var events = collector.list();
     t.equal(events.length, 3, 'should have seen three task compl events');
-    t.equal(events[0].name, 'noSuccess', 'name matches');
-    t.equal(events[1].name, 'noSuccessNull', 'name matches');
-    t.equal(events[2].name, 'add', 'name matches');
-    t.deepEqual(events[2].results, [5], 'results match');
+    t.equal(events[0].task.name, 'noSuccess', 'name matches');
+    t.equal(events[1].task.name, 'noSuccessNull', 'name matches');
+    t.equal(events[2].task.name, 'add', 'name matches');
+    t.deepEqual(events[2].task.results, [5], 'results match');
     t.end();
   });
 });  
@@ -560,18 +551,16 @@ test('selectFirst using direct returns', function (t) {
   });
   t.deepEqual(errors, [], 'no validation errors');
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
 
   fn(2, 3, function (err, c) {
     t.equal(err, null);
     t.equal(c, 5);
+    var events = collector.list();
     t.equal(events.length, 3, 'should have seen three task compl events');
-    t.equal(events[2].name, 'addRet', 'name matches');
-    t.deepEqual(events[2].results, [5], 'results match');
+    t.equal(events[2].task.name, 'addRet', 'name matches');
+    t.deepEqual(events[2].task.results, [5], 'results match');
     t.end();
   });
 });  

package/test/dsl/chain.test.js

@@ -4,6 +4,7 @@ var test = require('tap').test;
 var sprintf = require('sprintf').sprintf;
 
 var chainDefine = require('../../dsl/chain'); // require('react/dsl/chain');
+require('../../lib/track-tasks');  // require('react/lib/track-tasks'); // turn on tracking
 
 function falpha() { }
 function fbeta() { }

package/test/dsl/pcode.test.js

@@ -4,6 +4,7 @@ var test = require('tap').test;
 var sprintf = require('sprintf').sprintf;
 
 var pcode = require('../../dsl/pcode'); // require('react/dsl/pcode');
+var EventCollector = require('../../lib/track-tasks').EventCollector;  // require('react/lib/track-tasks'); // turn on tracking
 
 function falpha() { }
 function fbeta() { }
@@ -359,11 +360,6 @@ test('use pcodeDefine with events', function (t) {
   function multiply(a, b, cb) { cb(null, a * b); }
   function add(a, b, cb) { cb(null, a + b); }
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  
   var locals = { multiply: multiply, add: add };
   var fn = pcode('a, b, cb', [
     'm := multiply(a, b)',
@@ -371,17 +367,19 @@ test('use pcodeDefine with events', function (t) {
     'cb(err, m, s)'
   ], locals);
 
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
   
   fn(2, 3, function (err, m, s) {
     t.deepEqual(err, null, 'should not be any error');
     t.equal(m, 6);
     t.equal(s, 8);
+    var events = collector.list();
     t.equal(events.length, 2, 'should have seen two task compl events');
-    t.equal(events[0].name, 'multiply', 'name matches');
-    t.deepEqual(events[0].results, [6], 'results match');
-    t.equal(events[1].name, 'add', 'name matches');
-    t.deepEqual(events[1].results, [8], 'results match');
+    t.equal(events[0].task.name, 'multiply', 'name matches');
+    t.deepEqual(events[0].task.results, [6], 'results match');
+    t.equal(events[1].task.name, 'add', 'name matches');
+    t.deepEqual(events[1].task.results, [8], 'results match');
     t.end();
   });
 });
@@ -394,11 +392,6 @@ test('use pcodeDefine.selectFirst with events', function (t) {
   function noSuccessNull(a, b, cb) { cb(null, null); } // returns null result
   function add(a, b, cb) { cb(null, a + b); }
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  
   var locals = { noSuccess: noSuccess, noSuccessNull: noSuccessNull, add: add };
   var fn = pcode.selectFirst('a, b, cb', [
     'c := noSuccess(a, b)',
@@ -408,16 +401,18 @@ test('use pcodeDefine.selectFirst with events', function (t) {
     'cb(err, c)'
   ], locals);
 
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
   
   fn(2, 3, function (err, c) {
     t.deepEqual(err, null, 'should not be any error');
     t.equal(c, 5);
+    var events = collector.list();
     t.equal(events.length, 3, 'should have seen two task compl events');
-    t.equal(events[0].name, 'noSuccess', 'name matches');
-    t.equal(events[1].name, 'noSuccessNull', 'name matches');
-    t.equal(events[2].name, 'add', 'name matches');
-    t.deepEqual(events[2].results, [5], 'results match');
+    t.equal(events[0].task.name, 'noSuccess', 'name matches');
+    t.equal(events[1].task.name, 'noSuccessNull', 'name matches');
+    t.equal(events[2].task.name, 'add', 'name matches');
+    t.deepEqual(events[2].task.results, [5], 'results match');
     t.end();
   });
 });
@@ -427,11 +422,6 @@ test('use pcodeDefine events emit to global emitter', function (t) {
   function multiply(a, b, cb) { cb(null, a * b); }
   function add(a, b, cb) { cb(null, a + b); }
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
-  
   var locals = { multiply: multiply, add: add };
   var fn = pcode('a, b, cb', [
     'm := multiply(a, b)',
@@ -439,17 +429,19 @@ test('use pcodeDefine events emit to global emitter', function (t) {
     'cb(err, m, s)'
   ], locals);
 
-  pcode.events.on('task.complete', accumEvents);  // the global react emitter
+  var collector = new EventCollector();
+  collector.capture(pcode, 'task.complete'); // the global react emitter
   
   fn(2, 3, function (err, m, s) {
     t.deepEqual(err, null, 'should not be any error');
     t.equal(m, 6);
     t.equal(s, 8);
+    var events = collector.list();
     t.equal(events.length, 2, 'should have seen two task compl events');
-    t.equal(events[0].name, 'multiply', 'name matches');
-    t.deepEqual(events[0].results, [6], 'results match');
-    t.equal(events[1].name, 'add', 'name matches');
-    t.deepEqual(events[1].results, [8], 'results match');
+    t.equal(events[0].task.name, 'multiply', 'name matches');
+    t.deepEqual(events[0].task.results, [6], 'results match');
+    t.equal(events[1].task.name, 'add', 'name matches');
+    t.deepEqual(events[1].task.results, [8], 'results match');
     t.end();
   });
 });