react 0.2.5 → 0.3.5

package/lib/base-task.js

@@ -19,17 +19,18 @@ BaseTask.prototype.isComplete = function () {
 };
 
 BaseTask.prototype.start = function (args) { // mark task as started with args and note time
+  /*jshint validthis: true */
   this.args = args;
-  this.startTime = Date.now();
-  if (this.flowEmitter) this.flowEmitter.emitObject(EventManager.TYPES.TASK_BEGIN, this);
+  this.env.currentTask = this;
+  this.env.flowEmitter.emit(EventManager.TYPES.EXEC_TASK_START, this);
 };
 
 BaseTask.prototype.complete = function (args) { //args that were used are available
-  this.results = args;  // save the results
-  this.endTime = Date.now();
-  this.elapsedTime = this.endTime - this.startTime;
-  if (this.flowEmitter) this.flowEmitter.emitObject(EventManager.TYPES.TASK_COMPLETE, this);
+/*jshint validthis: true */
   this.status = STATUS.COMPLETE;
+  this.results = args;
+  this.env.currentTask = this;
+  this.env.flowEmitter.emit(EventManager.TYPES.EXEC_TASK_COMPLETE, this);
 };
 
 BaseTask.prototype.functionExists = function (vCon) {
@@ -96,6 +97,7 @@ BaseTask.prototype.isReady = function (vCon, tasksByName) {
 };
 
 BaseTask.prototype.isMethodCall = function () {
+  /*jshint regexp: false */
   return (typeof(this.f) === 'string' && /^.*\..*$/.test(this.f));  //str contains .
 };
 

package/lib/cb-task.js

@@ -43,6 +43,19 @@ CbTask.validate = function (taskDef) {
   return errors;
 };
 
+CbTask.prototype.prepare = function prepare(handleTaskError, vCon, contExec) {
+  var self = this;
+  this.cbFun = function (err, arg0, arg1, argn) {
+    var args = Array.prototype.slice.call(arguments, 1);
+    if (err) { handleTaskError(self, err); return; } //handle error and return, we are done
+
+    //no error, save callback args to vCon context, then continue execution
+    vCon.saveResults(self.out, args);
+    self.complete(args);
+    contExec();
+  };    
+};
+
 CbTask.prototype.exec = function exec(vCon, handleError, contExec) {
   try {
     var args = this.a.map(function (k) { return vCon.getVar(k); }); //get args from vCon
@@ -51,7 +64,7 @@ CbTask.prototype.exec = function exec(vCon, handleError, contExec) {
     this.start(args); //note the start time, args
     args.push(this.cbFun);   // push callback fn on end
     var func = this.f;
-    var bindObj = null; //global space
+    var bindObj = vCon.getVar('this'); //global space or the original this
     if (this.isMethodCall()) { //if method call then reset func and bindObj
       func = vCon.getVar(this.f);
       bindObj = this.getMethodObj(vCon);

package/lib/core.js

@@ -7,7 +7,6 @@ var validate = require('./validate.js');
 var tskutil = require('./task.js');
 var STATUS = require('./status.js');
 var VContext = require('./vcon.js');
-var FinalCbTask = require('./finalcb-task.js');
 var EventManager = require('./event-manager.js');
 var inputParser = require('./input-parser.js');
 var idGenerator = require('./id.js');
@@ -16,7 +15,17 @@ var reactOptions = {
   stackTraceLimitMin: 30
 };
 
-var reactEmitter = EventManager.globalEventManager; // the top emitter
+var reactEmitter = EventManager.global; // the top emitter
+
+/**
+   merge global react options with parsed options
+  */
+function mergeOptions(parsedOptions) {
+  return Object.keys(reactOptions).reduce(function (accum, k) {
+    if (!accum[k]) accum[k] = reactOptions[k];
+    return accum;
+  }, parsedOptions);    
+}
 
 /**
    Creates react function which the AST can be manipulated and then
@@ -56,32 +65,54 @@ function reactFactory() {
     Object.keys(newAST).forEach(function (k) { ast[k] = newAST[k]; }); // copy all properties
     var errors = validate(ast);
     if (!errors.length) tskutil.nameTasks(ast.tasks); //run this so names can be checked in ast
+    if (Object.freeze) { //lets freeze the AST so plugin writers don't accidentally manip the ast
+      Object.keys(newAST).forEach(function (k) {
+        if (typeof(newAST[k]) === 'object') Object.freeze(newAST[k]);
+      });
+      Object.freeze(newAST);
+    }
     return errors;
   }
 
   function exec(arg1, arg2, argN, cb) { // called to execute the flow
-    var parsedInput = inputParser(Array.prototype.slice.call(arguments), ast);
-    var args = parsedInput.args;
-    var cbFinal = parsedInput.cb;
-    var extraArgs = parsedInput.extraArgs; // we'll have these if we need them
-    var vCon = VContext.create(args, ast.inParams, ast.locals); // create var ctx with in args & locals
-    var tasks = ast.tasks.map(tskutil.create);
+    /*jshint validthis: true */
+    var args = Array.prototype.slice.call(arguments);
+    var env = {
+      execId: idGenerator.createUniqueId(),
+      args: args,
+      ast: ast,
+      flowEmitter: flowEmitter
+    };
+    env.name = ast.name || env.execId;
+    flowEmitter.emit(EventManager.TYPES.EXEC_FLOW_START, env);  // hook
+    var parsedInput = inputParser(args, ast);
+    var vCon = VContext.create(parsedInput.args, ast.inParams, ast.locals, this); // create var ctx with in args & locals
+
+    env.parsedInput = parsedInput;
+    env.options = mergeOptions(parsedInput.options);
+    env.vCon = vCon;
+    env.taskDefs = ast.tasks.slice(); // create copy
+    env.outTaskDef = Object.create(ast.outTask); // create copy
+    reactEmitter.emit(EventManager.TYPES.EXEC_TASKS_PRECREATE, env);  // hook
+    
+    var tasks = env.taskDefs.map(tskutil.create);
     var tasksByName = tskutil.nameTasks(tasks); // map names to working tasks
-    var outTask = tskutil.createOutTask(ast.outTask, cbFinal, tasks, vCon);
+    var outTask = tskutil.createOutTask(env.outTaskDef, parsedInput.cb, tasks, vCon, env.options, env);
     var handleError = tskutil.createErrorHandler(vCon, outTask);
 
     function contExec() {
       if (!outTask.f) { return; } //stop execution, we already hit an error, f was cleared
       if (outTask.isReady()) return outTask.exec(); // all tasks done, exec cb, return
-      tskutil.findReadyAndExec(vCon, tasks, tasksByName, handleError, contExec);  //exec tasks that ready to run
+      tskutil.findReadyAndExec(vCon, tasks, tasksByName, handleError, contExec, env);  //exec tasks that ready to run
     }
 
     tasks.forEach(function (t) {
       t.id = idGenerator.createUniqueId();
-      t.flowEmitter = flowEmitter;
-      if (t.type === 'cb') t.cbFun = tskutil.createCallback(t, handleError, vCon, contExec, flowEmitter);
+      t.env = env;
+      if (t.prepare) t.prepare(handleError, vCon, contExec, flowEmitter);
     }); // create callbacks
     contExec();   // start things off
+    return outTask.retValue; // could return promise
   }
 
   var reactFn = exec;        // make the exec() the function returned

package/lib/dsl.js

@@ -6,8 +6,10 @@ var core = require('./core.js');
 var parse = require('./parse.js');
 var tutil = require('./task.js');
 
-var MISSING_NAME = 'param[0] should be the flow name, instead found in/out def: %s';
-var INOUT_PARAMS_NO_MATCH = 'params in wrong format, wanted "foo, bar cb -> err, baz" - found: %s';
+var MISSING_NAME = 'first flow parameter should be the flow name, but found in/out def: %s';
+var INOUT_PARAMS_NO_MATCH = 'params in wrong format, wanted "foo, bar, cb -> err, baz" - found: %s';
+var MISSING_ERR = 'callback specified, but first out param was not "err", use for clarity. Found in/out def: %s';
+var MISSING_CB = 'found err param, but cb/callback is not specified, is this cb-style async or sync function? Found in/out def: %s';
 var EXTRA_TASKARG = 'extra unmatched task arg: %s';
 
 var INOUT_RE = /\->/;  // used to detect missing name, in/out as first arg
@@ -25,12 +27,18 @@ function filterOutLeadingErrParam(args) { // if leading err param, filter it out
 }
 
 var inOutDefParse = {
-  regex: /^([^\-]*)(->\s*(.*))?$/i,
-  fn: function (m) {
-    var inParams = parse.splitTrimFilterArgs(m[1]);
+  splitStr: '->',
+  fn: function (m, origStr) {
+    var inParams = parse.splitTrimFilterArgs(m[0]);
     var lastParam = inParams[inParams.length - 1];
     var type = (lastParam && CB_NAMES_RE.test(lastParam)) ? 'cb' : 'ret';
-    var outParams = parse.splitTrimFilterArgs(m[3]);
+    var outParams = parse.splitTrimFilterArgs(m[1]);
+    var firstOutParam = outParams[0];
+    if (type === 'cb' && (!firstOutParam || !ERR_NAMES_RE.test(firstOutParam))) {
+      throw new Error(sprintf(MISSING_ERR, origStr));  // found cb, but no err param
+    } else if (type === 'ret' && firstOutParam && ERR_NAMES_RE.test(firstOutParam)) {
+      throw new Error(sprintf(MISSING_CB, origStr));  // found err but not cb param
+    }
     return {
       type: type,
       inDef: filterOutTrailingCbParam(inParams),

package/lib/event-manager.js

@@ -3,12 +3,30 @@
 var EventEmitter2 = require('eventemitter2').EventEmitter2;
 
 var EVENT_EMITTER2_CONFIG = {
-  wildcard: true
+  wildcard: true, // should the event emitter use wildcards.
+  delimiter: '.', // the delimiter used to segment namespaces, defaults to `.`.
+  maxListeners: 30 // the max number of listeners that can be assigned to an event, defaults to 10.
 };
 
 var TYPES = {
-  TASK_BEGIN: 'task.begin',
-  TASK_COMPLETE: 'task.complete'
+  // Flow monitoring events and their params
+  FLOW_BEGIN: 'flow.begin',                        // env
+  TASK_BEGIN: 'task.begin',                        // task
+  TASK_COMPLETE: 'task.complete',                  // task
+  TASK_ERRORED: 'task.errored',                    // task
+  FLOW_COMPLETE: 'flow.complete',                  // env
+  FLOW_ERRORED: 'flow.errored',                    // env
+
+  // Internal Hooks
+  EXEC_FLOW_START: 'exec.flow.start',              // env
+  EXEC_INPUT_PREPROCESS: 'exec.input.preprocess',  // parsedInput
+  EXEC_TASKS_PRECREATE: 'exec.tasks.precreate',    // env
+  EXEC_OUTTASK_CREATE: 'exec.outTask.create',      // outTaskOptions
+  EXEC_TASK_START: 'exec.task.start',              // task
+  EXEC_TASK_COMPLETE: 'exec.task.complete',        // task
+  EXEC_TASK_ERRORED: 'exec.task.errored',          // task
+  EXEC_FLOW_COMPLETE: 'exec.flow.complete',        // env
+  EXEC_FLOW_ERRORED: 'exec.flow.errored'           // env
 };
 
 /**
@@ -21,6 +39,9 @@ function EventManager() {
 
 EventManager.create = function () { return new EventManager(); };
 
+EventManager.TYPES = TYPES;
+EventManager.prototype.TYPES = TYPES;
+
 EventManager.prototype.isEnabled = function () { // if has listener or an ancestor has listener
   return (this.emitter || (this.parent && this.parent.isEnabled()));
 };
@@ -36,23 +57,15 @@ EventManager.prototype.on = function (event, listener) {
 };
 
 EventManager.prototype.emit = function (event, arg1, arg2, argN) {
+  if (event === undefined) throw new Error('event is undefined');
   if (this.emitter) this.emitter.emit.apply(this.emitter, arguments);
   if (this.parent && this.parent.isEnabled()) this.parent.emit.apply(this.parent, arguments);
 };
 
-/**
-   Emit an object augmented with standard fields.
-   Copies object and adds standard fields:
-    event: event type
-    time: current time
-  */
-EventManager.prototype.emitObject = function (event, object) {
-  var evObj = Object.create(object); // create inherited copy version so origin is untouched
-  evObj.event = event;     // augment with the event type
-  evObj.time = Date.now(); // augument with the time of the event
-  this.emit(event, evObj);
+EventManager.prototype.removeListener = function (event, listener) {
+  if (this.emitter) this.emitter.removeListener.apply(this.emitter, arguments);
 };
 
+
 module.exports = EventManager;
-module.exports.TYPES = TYPES;
-module.exports.globalEventManager = EventManager.create(); // create one top level emitter
+module.exports.global = EventManager.create(); // create one top level emitter

package/lib/finalcb-first-task.js

@@ -5,15 +5,22 @@ var util = require('util');
 
 var STATUS = require('./status.js');
 var VContext = require('./vcon.js');
+var EventManager = require('./event-manager.js');
 
 var OUTTASK_A_REQ = 'ast.outTask.a should be an array of string param names';
 
-function FinalCbFirstSuccTask(taskDef, cbFunc, tasks, vCon) {
+function FinalCbFirstSuccTask(outTaskOptions) {
+  var taskDef = outTaskOptions.taskDef;
+  if (typeof(outTaskOptions.cbFunc) !== 'function') throw new Error('callback is not a function'); 
   var self = this;
-  Object.keys(taskDef).forEach(function (k) { self[k] = taskDef[k]; });
-  this.f = cbFunc;
-  this.tasks = tasks;
-  this.vCon = vCon;
+  for (var k in taskDef) {
+    if (true) self[k] = taskDef[k];  // if to make jshint happy
+  }
+  this.f = outTaskOptions.cbFunc;
+  this.tasks = outTaskOptions.tasks;
+  this.vCon = outTaskOptions.vCon;
+  this.retValue = outTaskOptions.retValue;
+  this.env = outTaskOptions.env;
 }
 
 function format_error(errmsg, obj) {
@@ -27,11 +34,6 @@ FinalCbFirstSuccTask.validate = function (taskDef) {
     errors.push(format_error(OUTTASK_A_REQ, taskDef));
   }
   return errors;
-}
-
-FinalCbFirstSuccTask.create = function (taskDef, cbFunc, tasks, vCon) {
-  if (!(cbFunc && cbFunc instanceof Function)) throw new Error('callback is not a function'); 
-  return new FinalCbFirstSuccTask(taskDef, cbFunc, tasks, vCon);
 };
 
 /**
@@ -46,11 +48,15 @@ FinalCbFirstSuccTask.prototype.isReady = function () {
 FinalCbFirstSuccTask.prototype.exec = function (err) {
   if (!this.f) return;   //must have already been called
   if (err) {
+    this.env.error = err;
+    this.env.flowEmitter.emit(EventManager.TYPES.EXEC_FLOW_ERRORED, this.env);
     this.f.call(null, err); //call the final callback with the first error hit
   } else { // no error, call with args
     var vCon = this.vCon;
     var finalArgs = this.a.map(function (k) { return vCon.getVar(k); });
     finalArgs.unshift(null);   //unshift err=null to front
+    this.env.results = finalArgs;
+    this.env.flowEmitter.emit(EventManager.TYPES.EXEC_FLOW_COMPLETE, this.env);
     this.f.apply(null, finalArgs);
   }
   this.f = null;   // prevent multiple calls

package/lib/finalcb-task.js

@@ -4,15 +4,23 @@ var sprintf = require('sprintf').sprintf;
 var util = require('util');
 
 var STATUS = require('./status.js');
+var EventManager = require('./event-manager.js');
 
 var OUTTASK_A_REQ = 'ast.outTask.a should be an array of string param names';
 
-function FinalCbTask(taskDef, cbFunc, tasks, vCon) {
+function FinalCbTask(outTaskOptions) {
+  var taskDef = outTaskOptions.taskDef;
+  if (typeof(outTaskOptions.cbFunc) !== 'function') throw new Error('callback is not a function'); 
   var self = this;
-  Object.keys(taskDef).forEach(function (k) { self[k] = taskDef[k]; });
-  this.f = cbFunc;
-  this.tasks = tasks;
-  this.vCon = vCon;
+  for (var k in taskDef) {
+    if (true) self[k] = taskDef[k];  // if to make jshint happy
+  }
+  this.f = outTaskOptions.cbFunc;
+  this.tasks = outTaskOptions.tasks;
+  this.vCon = outTaskOptions.vCon;
+  this.retValue = outTaskOptions.retValue;
+  this.execOptions = outTaskOptions.execOptions;
+  this.env = outTaskOptions.env;
 }
 
 function format_error(errmsg, obj) {
@@ -29,11 +37,6 @@ FinalCbTask.validate = function (taskDef) {
   return errors;
 };
 
-FinalCbTask.create = function (taskDef, cbFunc, tasks, vCon) {
-  if (!(cbFunc && cbFunc instanceof Function)) throw new Error('callback is not a function'); 
-  return new FinalCbTask(taskDef, cbFunc, tasks, vCon);
-};
-
 FinalCbTask.prototype.isReady = function () {
   return (this.tasks.every(function (t) { return (t.status === STATUS.COMPLETE); }));
 };
@@ -41,11 +44,15 @@ FinalCbTask.prototype.isReady = function () {
 FinalCbTask.prototype.exec = function (err) {
   if (!this.f) return;   //must have already been called
   if (err) {
+    this.env.error = err;
+    this.env.flowEmitter.emit(EventManager.TYPES.EXEC_FLOW_ERRORED, this.env);
     this.f.call(null, err); //call the final callback with the first error hit
   } else { // no error, call with args
     var vCon = this.vCon;
     var finalArgs = this.a.map(function (k) { return vCon.getVar(k); });
     finalArgs.unshift(null);   //unshift err=null to front
+    this.env.results = finalArgs;
+    this.env.flowEmitter.emit(EventManager.TYPES.EXEC_FLOW_COMPLETE, this.env);
     this.f.apply(null, finalArgs);
   }
   this.f = null;   // prevent multiple calls

package/lib/input-parser.js

@@ -1,12 +1,14 @@
 'use strict';
 
+var EventManager = require('./event-manager.js');
+
 var defaultExecOptions = {
   reactExecOptions: true,
-  outputStyle: 'callback',
+  outputStyle: 'cb',
 };
 
 var OUTPUT_STYLES = {
-  CALLBACK: 'callback',
+  CALLBACK: 'cb',
   NONE: 'none'
 };
 
@@ -36,7 +38,9 @@ function inputParser(inputArgs, ast) {
   var splitResult = splitArgs(args, ast.inParams, parsedInput.options.outputStyle); 
   parsedInput.args = splitResult.args;
   parsedInput.cb = splitResult.cb;
-  if (splitResult.extra) parsedInput.extraArgs = splitResult.extra;  
+  if (splitResult.outputStyle) parsedInput.options.outputStyle = splitResult.outputStyle;
+  if (splitResult.extra) parsedInput.extraArgs = splitResult.extra;
+  EventManager.global.emit(EventManager.TYPES.EXEC_INPUT_PREPROCESS, parsedInput);  // hook
   return parsedInput;
 }
 

package/lib/log-events.js

@@ -0,0 +1,71 @@
+'use strict';
+
+/**
+   Log events to console.error
+
+   @example
+   var react = require('react');
+   require('react/lib/log-events').logEvent(react);
+  */
+
+var react = require('../lib/track-tasks');  // require('react/lib/track-tasks'); // turn on tracking
+
+var ALL_FLOW_EVENTS = 'flow.*';
+var ALL_TASK_EVENTS = 'task.*';
+
+function flowLog(obj) {
+  /*jshint validthis: true */
+  var time = new Date();
+  time.setTime(obj.time);
+  var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
+  var eventTimeStr = time.toISOString();
+  if (this.event === 'flow.complete') {
+    var env = obj; 
+    console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
+                  this.event, env.name, env.elapsedTime, argsNoCb, env.results);   
+  } else {
+    var name = obj.name;
+    var args = obj.args;
+    console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
+  }    
+}
+
+function taskLog(obj) {
+  /*jshint validthis: true */
+  var time = new Date();
+  time.setTime(obj.time);
+  var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
+  var eventTimeStr = time.toISOString();
+  if (this.event === 'task.complete') {
+    var task = obj;
+    console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
+                  this.event, task.name, task.elapsedTime, argsNoCb, task.results);
+  } else {
+    var name = obj.name;
+    var args = obj.args;
+    console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
+  }
+  
+}
+
+/**
+   Log flow and task events for a flowFn or all of react.
+   If called multiple times, remove previous listener (if any) before
+   adding.
+   
+   @example
+   var react = require('react');
+   require('react/lib/log-events').logEvents(flowFn); // pass flowFn or react
+   
+   @param flowFn Flow function or global react object
+  */
+function logEvents(flowFn) {
+  //output events as tasks start and complete
+  flowFn.events.removeListener(ALL_FLOW_EVENTS, flowLog);
+  flowFn.events.on(ALL_FLOW_EVENTS, flowLog);
+  flowFn.events.removeListener(ALL_TASK_EVENTS, taskLog);
+  flowFn.events.on(ALL_TASK_EVENTS, taskLog);
+}
+
+module.exports = react;
+module.exports.logEvents = logEvents;