react 0.2.3 → 0.3.0

package/lib/dsl.js

@@ -6,9 +6,13 @@ var core = require('./core.js');
 var parse = require('./parse.js');
 var tutil = require('./task.js');
 
-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
 var CB_NAMES_RE = /^cb|callback$/i;  //cb, Cb, CB, callback, Callback
 var ERR_NAMES_RE = /^err$/i; // err, ERR, Err, ...
 
@@ -23,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),
@@ -81,6 +91,7 @@ function parseVargs(vargs) {
 
 function dslDefine(name, arg1, arg2, argN) {
   var reactFn = core();
+  if (name && INOUT_RE.test(name)) throw new Error(sprintf(MISSING_NAME, name));
   var defObj = parseVargs(Array.prototype.slice.call(arguments, 1)); // name, already used 
   var inOutDef = parseInOutParams(defObj.inOutParamStr);
   var ast = {

package/lib/event-manager.js

@@ -3,12 +3,20 @@
 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
+  TASK_BEGIN: 'task.begin',                        // task
+  TASK_COMPLETE: 'task.complete',                  // task
+
+  // Internal Hooks
+  EXEC_INPUT_PREPROCESS: 'exec.input.preprocess',  // parsedInput
+  EXEC_TASKS_PRECREATE: 'exec.tasks.precreate',     // taskEnv
+  EXEC_OUTTASK_CREATE: 'exec.outTask.create'      // outTaskOptions
 };
 
 /**
@@ -21,6 +29,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,6 +47,7 @@ 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);
 };
@@ -54,4 +66,4 @@ EventManager.prototype.emitObject = function (event, object) {
 };
 
 module.exports = EventManager;
-module.exports.TYPES = TYPES;
+module.exports.global = EventManager.create(); // create one top level emitter

package/lib/finalcb-first-task.js

@@ -8,12 +8,20 @@ var VContext = require('./vcon.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;
+  var cbFunc = outTaskOptions.cbFunc;
+  var tasks = outTaskOptions.tasks;
+  var vCon = outTaskOptions.vCon;
+  var execOptions = outTaskOptions.execOptions;
+  var retValue = outTaskOptions.retValue;
+  if (typeof(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;
+  this.retValue = retValue;
 }
 
 function format_error(errmsg, obj) {
@@ -27,11 +35,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);
 };
 
 /**

package/lib/finalcb-task.js

@@ -7,12 +7,20 @@ var STATUS = require('./status.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;
+  var cbFunc = outTaskOptions.cbFunc;
+  var tasks = outTaskOptions.tasks;
+  var vCon = outTaskOptions.vCon;
+  var execOptions = outTaskOptions.execOptions;
+  var retValue = outTaskOptions.retValue;
+  if (typeof(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;
+  this.retValue = retValue;
 }
 
 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); }));
 };

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/parse.js

@@ -9,10 +9,13 @@ function splitTrimFilterArgs(commaSepArgs) { //parse 'one, two' into ['one', 'tw
     .filter(function (s) { return (s); });  //filter out empty strings
 }
 
-function parseReduce(accum, regexFn) {
+/**
+   @param patternFn regex + fn or splitStr + fn
+  */
+function parseReduce(accum, patternFn) {
   if (typeof(accum) !== 'string') return accum; // already matched
-  var m = regexFn.regex.exec(accum);
-  if (m) return regexFn.fn(m); // return result obj
+  var m = (patternFn.regex) ? patternFn.regex.exec(accum) : accum.split(patternFn.splitStr);
+  if (m) return patternFn.fn(m, accum); // pass in matches and origStr, return result obj
   return accum; // no match, return str, will try next matcher
 }
 

package/lib/promise-task.js

@@ -0,0 +1,89 @@
+'use strict';
+
+/**
+   PromiseTask is a task which executes a fn that returns a promise
+   and when it completes it sets the values in vCon
+  */
+
+var util = require('util');
+var sprintf = require('sprintf').sprintf;
+
+var BaseTask = require('./base-task.js');
+
+function format_error(errmsg, obj) {
+  return sprintf('%s - %s', errmsg, util.inspect(obj));
+}
+
+var REQ = 'promiseTask requires f, a, out';
+var FN_REQ = 'promiseTask requires f to be a function or string';
+var A_REQ = 'promiseTask requires a to be an array of string param names';
+var OUT_REQ = 'promiseTask requires out to be an array[1] of string param names';
+
+function PromiseTask(taskDef) {
+  var self = this;
+  Object.keys(taskDef).forEach(function (k) { self[k] = taskDef[k]; });
+}
+
+PromiseTask.prototype = new BaseTask();
+PromiseTask.prototype.constructor = PromiseTask;
+
+PromiseTask.validate = function (taskDef) {
+  var errors = [];
+  if (!taskDef.f || !taskDef.a || !taskDef.out) {
+    errors.push(format_error(REQ, taskDef));
+  } else {
+    var ftype = typeof(taskDef.f);
+    if (! ((taskDef.f instanceof Function) || (ftype === 'string'))) {
+      errors.push(format_error(FN_REQ, taskDef));
+    }
+    if (! (Array.isArray(taskDef.a) &&
+           taskDef.a.every(function (x) { return (typeof(x) === 'string'); }))) {
+      errors.push(format_error(A_REQ, taskDef));
+    }
+    if (! (Array.isArray(taskDef.out) && taskDef.out.length <= 1 && 
+           taskDef.out.every(function (x) { return (typeof(x) === 'string'); }))) {
+      errors.push(format_error(OUT_REQ, taskDef));
+    }
+  }
+  return errors;
+};
+
+PromiseTask.prototype.prepare = function prepare(handleTaskError, vCon, contExec) {
+  var self = this;
+  this.nextFn = function (arg) {
+    var args = Array.prototype.slice.call(arguments);
+    vCon.saveResults(self.out, args);
+    self.complete(args);
+    contExec();
+  };
+  this.failFn = function (err) {
+    handleTaskError(self, err);
+  };
+};
+
+PromiseTask.prototype.exec = function exec(vCon, handleError, contExec) {
+  try {
+    var args = this.a.map(function (k) { return vCon.getVar(k); }); //get args from vCon
+    //console.error('PromiseTask.exec.args=', args);
+    //console.error('PromiseTask.exec.vCon=', vCon);
+    this.start(args); //note the start time, args
+    var func = this.f;
+    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);
+    } else if (typeof(func) === 'string') {
+      func = vCon.getVar(func); // we want the actual fn from this string
+    }
+    var retValue = func.apply(bindObj, args);
+    if (retValue && typeof(retValue.then) === 'function') { // is a promise
+      retValue.then(this.nextFn, this.failFn);
+    } else { // just a value, proceed now
+      this.nextFn(retValue);
+    }
+  } catch (err) { //catch and handle the task error, calling final cb
+    handleError(this, err);
+  }    
+};
+
+module.exports = PromiseTask;

package/lib/ret-task.js

@@ -50,7 +50,7 @@ RetTask.prototype.exec = function exec(vCon, handleError, contExec) {
     var args = this.a.map(function (k) { return vCon.getVar(k); }); //get args from vCon
     this.start(args); //note the start time, args    
     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/task.js

@@ -4,16 +4,21 @@ var util = require('util');
 var sprintf = require('sprintf').sprintf;
 var array = require('ensure-array');
 var CbTask = require('./cb-task.js');
+var PromiseTask = require('./promise-task.js');
 var RetTask = require('./ret-task.js');
+var WhenTask = require('./when-task.js');
 var FinalCbTask = require('./finalcb-task.js');
 var FinalCbFirstSuccTask = require('./finalcb-first-task.js');
 var STATUS = require('./status.js');
 var error = require('./error.js');
 var VContext = require('./vcon.js');
+var EventManager = require('./event-manager.js');
 
 var TASK_TYPES = {
   cb: CbTask,
-  ret: RetTask
+  ret: RetTask,
+  promise: PromiseTask,
+  when: WhenTask
 };
 function taskTypeKeys() { return Object.keys(TASK_TYPES); }
 
@@ -106,7 +111,8 @@ function validateLocalFunctions(inParams, taskDefs, locals) {
   var mock_args = inParams.map(function (p) { return foo; }); //mock args with fns
   var vCon = VContext.create(mock_args, inParams, locals);
   var tasks = taskDefs.map(create);
-  tasks.forEach(function (t, idx) {
+  var tasksWFunctions = tasks.filter(function (t) { return (t.type !== 'when'); }); // non-when tasks need f
+  tasksWFunctions.forEach(function (t, idx) {
     if (!t.functionExists(vCon)) {   // error if function doesnt exist AND
       if (!t.isMethodCall()) errors.push(sprintf(LOCAL_FN_MISSING, t.f, idx)); // not method OR
       else {
@@ -121,7 +127,9 @@ function validateLocalFunctions(inParams, taskDefs, locals) {
 }
 
 function fName(fn) {
-  return (typeof(fn) === 'string') ? fn : fn.name;
+  return (fn) ?
+    ((fn.name) ? fn.name : fn) :  // if defined, try name, otherwise toString()
+    'undefined';  // not defined, use undefined
 }
 
 /**
@@ -155,24 +163,21 @@ function create(taskDef) {
   return new TaskConstructor(taskDef);
 }
 
-function createOutTask(taskDef, cbFinal, tasks, vCon) {
+function createOutTask(taskDef, cbFunc, tasks, vCon, execOptions) {
   setMissingOutTaskType(taskDef);
-  var TaskConstructor = OUT_TASK_TYPES[taskDef.type];
-  return new TaskConstructor(taskDef, cbFinal, tasks, vCon);
-}
-  
-function createCallback(task, handleTaskError, vCon, contExec) {
-  return function (err, arg0, arg1, argn) {
-    var args = Array.prototype.slice.call(arguments, 1);
-    if (err) { handleTaskError(task, err); return; } //handle error and return, we are done
-
-    //no error, save callback args to vCon context, then continue execution
-    vCon.saveResults(task.out, args);
-    task.complete(args);
-    contExec();
+  var outTaskOptions = {
+    taskDef: taskDef,
+    cbFunc: cbFunc,
+    tasks: tasks,
+    vCon: vCon,
+    execOptions: execOptions,
+    TaskConstructor: OUT_TASK_TYPES[taskDef.type]
   };
+  EventManager.global.emit(EventManager.TYPES.EXEC_OUTTASK_CREATE, outTaskOptions); // hook
+  var TaskConstructor = outTaskOptions.TaskConstructor;  // hook could have changed
+  return new TaskConstructor(outTaskOptions);
 }
-
+  
 function createErrorHandler(vCon, outTask) {
   return function handleError(task, err) {
     task.status = STATUS.ERRORED;
@@ -234,6 +239,5 @@ exports.validateLocalFunctions = validateLocalFunctions;
 exports.nameTasks = nameTasks;
 exports.create = create;
 exports.createOutTask = createOutTask;
-exports.createCallback = createCallback;
 exports.createErrorHandler = createErrorHandler;
 exports.findReadyAndExec = findReadyAndExec;

package/lib/validate.js

@@ -13,6 +13,9 @@ var LOCALS_NOTNULL = 'ast.locals should not be null';
 var DUP_OUTPUTS = 'multiple tasks output the same param, must be unique. param';
 var MISSING_INPUTS = 'missing or mispelled variable referenced in flow definition: %s';
 
+// match any of our literals true, false, int, float, quoted strings, or is property (has dot), match vcon.js
+var LITERAL_OR_PROP_RE = /^(true|false|this|null|\-?[0-9\.]+)$|'|"|\./i;  
+
 var validateInParams, validateTasks, validateOutTask, validateTaskNamesUnique;
 var validateLocals, validateOuputsUnique, validateNoMissingNames;
 
@@ -20,10 +23,15 @@ function format_error(errmsg, obj) {
   return sprintf('%s - %s', errmsg, util.inspect(obj));
 }
 
-function isProp(str) { // true if is a property name (contains a dot)
-  return (str.indexOf('.') !== -1);
+/**
+   true if is a literal name
+  */
+function isLiteralOrProp(name) {  // need to match what is in vcon.js, TODO consolidate?
+  return LITERAL_OR_PROP_RE.test(name);
 }
 
+
+
 /**
    validate the AST return Errors
    @example
@@ -105,6 +113,7 @@ function validateOuputsUnique(taskDefs) {
   return errors;
 }
 
+
 /**
    validate there are no missing or mispelled param names in any task inputs
    or the final task output
@@ -134,17 +143,17 @@ function validateNoMissingNames(ast) {
   // now we have all possible provided vars, check task inputs are accounted for
   ast.tasks.reduce(function (accum, t) {  // for all tasks
     return t.a.reduce(function (innerAccum, p) { // for all in params, except property
-      if (!isProp(p) && !names[p]) innerAccum.push(sprintf(MISSING_INPUTS, p)); // add error if missing
+      if (!isLiteralOrProp(p) && !names[p]) innerAccum.push(sprintf(MISSING_INPUTS, p)); // add error if missing
       return innerAccum;
     }, accum);
   }, errors);
 
   // now check the final task outputs
   ast.outTask.a.reduce(function (accum, p) { // for final task out params
-    if (!isProp(p) && !names[p]) accum.push(sprintf(MISSING_INPUTS, p)); // add error if missing
+    if (!isLiteralOrProp(p) && !names[p]) accum.push(sprintf(MISSING_INPUTS, p)); // add error if missing
     return accum;
   }, errors);
-  return errors;
+  return errors;  
 }
 
 module.exports = validate;