react 0.2.2 → 0.2.3

package/README.md

@@ -242,7 +242,7 @@ fn(2, 3, function (err, m, s) {
 
 ## Status
 
- - 2012-01-10 - Create default DSL for react()
+ - 2012-01-10 - Create default DSL for react(), create error for missing variables, list remaining tasks when flow won't complete
  - 2011-12-21 - Refactor from ground up with tests, changes to the interfaces
  - 2011-10-26 - React is in active development and interface may change frequently in these early stages. Current code is functional but does not perform validation yet.  Additional interfaces are planned to make it easy to define flows in a variety of ways. Documentation and examples forthcoming.
 

package/lib/task.js

@@ -25,7 +25,7 @@ function outTaskTypeKeys() { return Object.keys(OUT_TASK_TYPES); }
 
 var LOCAL_FN_MISSING = 'function: %s not found in locals or input params - task[%s]';
 var TASKDEF_IS_OBJECT = 'task must be an object';
-var NO_TASKS_RUNNING_WONT_COMPLETE = 'no tasks running, flow will not complete';
+var NO_TASKS_RUNNING_WONT_COMPLETE = 'no tasks running, flow will not complete, remaining tasks: %s';
 var TASK_TYPE_SHOULD_MATCH = 'task.type should match one of ' +
   Object.keys(TASK_TYPES).join(', ');
 
@@ -201,7 +201,12 @@ function checkIfTasksRunning(vCon, tasks, handleError) {
   var tasksRunning = tasks.filter(function (t) {
     return (t.status === STATUS.RUNNING || t.status === STATUS.READY);
   });
-  if (!tasksRunning.length) handleError({}, new Error(NO_TASKS_RUNNING_WONT_COMPLETE));
+  if (!tasksRunning.length) {
+    var remainingTasks = tasks.filter(function (t) { return (!t.status); });
+    var remainingTNames = remainingTasks.map(function (t) { return t.name; });
+    var errMsg = sprintf(NO_TASKS_RUNNING_WONT_COMPLETE, remainingTNames.join(', '));
+    handleError({}, new Error(errMsg));
+  }
 }
 
 function findReadyAndExec(vCon, tasks, tasksByName, handleError, contExec) {

package/lib/validate.js

@@ -11,14 +11,19 @@ var TASKS_ARR = 'ast.tasks must be an array of tasks';
 var NAMES_UNIQUE = 'ast.tasks that specify name need to be unique, duplicate:';
 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';
 
 var validateInParams, validateTasks, validateOutTask, validateTaskNamesUnique;
-var validateLocals, validateOuputsUnique;
+var validateLocals, validateOuputsUnique, validateNoMissingNames;
 
 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);
+}
+
 /**
    validate the AST return Errors
    @example
@@ -37,6 +42,7 @@ function validate(ast) {
   if (errors.length === 0) { // if no errors do additional validation
     if (ast.outTask.type !== 'finalcbFirst') errors = errors.concat(validateOuputsUnique(ast.tasks));
     errors = errors.concat(tutil.validateLocalFunctions(ast.inParams, ast.tasks, ast.locals));
+    errors = errors.concat(validateNoMissingNames(ast));
   }
   return errors;
 }
@@ -99,4 +105,46 @@ function validateOuputsUnique(taskDefs) {
   return errors;
 }
 
+/**
+   validate there are no missing or mispelled param names in any task inputs
+   or the final task output
+
+   @return array of errors, or empty array if none
+  */
+function validateNoMissingNames(ast) {
+  var errors = [];
+  var names = {};
+  if (ast.locals) {
+    names = Object.keys(ast.locals).reduce(function (accum, k) { // start with locals
+      accum[k] = true;
+      return accum;
+    }, names);
+  }
+  ast.inParams.reduce(function (accum, p) {  // add input params
+    accum[p] = true;
+    return accum;
+  }, names);
+  ast.tasks.reduce(function (accum, t) { // add task outputs
+    return t.out.reduce(function (innerAccum, p) {
+      innerAccum[p] = true;
+      return innerAccum;
+    }, accum);
+  }, names);
+
+  // 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
+      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
+    return accum;
+  }, errors);
+  return errors;
+}
+
 module.exports = validate;

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.2.2",
+  "version": "0.2.3",
   "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/test/chain.test.js

@@ -63,10 +63,11 @@ test('in triple first param -> inParams["foo", "bar", "baz"]', function (t) {
 
 test('single task, single out params', function (t) {
   var fn = chainDefine()
+    .in('a', 'b')
     .out('c')
     .async(falpha).in('a', 'b').out('c')
     .end();
-  t.deepEqual(fn.ast.inParams, []);
+  t.deepEqual(fn.ast.inParams, ['a', 'b']);
   t.deepEqual(fn.ast.tasks, [
     { f: falpha, type: 'cb', a: ['a', 'b'], out: ['c'], name: 'falpha' }
   ]);
@@ -77,11 +78,11 @@ test('single task, single out params', function (t) {
 test('single task, err and out params', function (t) {
   var fn = chainDefine()
     .out('err', 'c')
-    .async(falpha).in('a', 'b').out('err', 'c')
+    .async(falpha).in().out('err', 'c')
     .end();
   t.deepEqual(fn.ast.inParams, []);
   t.deepEqual(fn.ast.tasks, [
-    { f: falpha, type: 'cb', a: ['a', 'b'], out: ['c'], name: 'falpha' }
+    { f: falpha, type: 'cb', a: [], out: ['c'], name: 'falpha' }
   ]);
   t.deepEqual(fn.ast.outTask, { a: ['c'], type: 'finalcb' });
   t.end();  
@@ -90,11 +91,11 @@ test('single task, err and out params', function (t) {
 test('single task, ERR and out params', function (t) {
   var fn = chainDefine()
     .out('ERR', 'c')
-    .async(falpha).in('a', 'b').out('ERR', 'c')
+    .async(falpha).in().out('ERR', 'c')
     .end();
   t.deepEqual(fn.ast.inParams, []);
   t.deepEqual(fn.ast.tasks, [
-    { f: falpha, type: 'cb', a: ['a', 'b'], out: ['c'], name: 'falpha' }
+    { f: falpha, type: 'cb', a: [], out: ['c'], name: 'falpha' }
   ]);
   t.deepEqual(fn.ast.outTask, { a: ['c'], type: 'finalcb' });
   t.end();  

package/test/core.test.js

@@ -198,14 +198,15 @@ test('error when cant complete', function (t) {
     inParams: ['a', 'b', 'c'],
     tasks: [    
       { f: multiply, a: ['a', 'b'], out: ['c.mult'] },
-      { f: fnRetsSum, a: ['c.bad', 'b'], out: ['c.sum'], type: 'ret' }
+      { f: fnRetsSum, a: ['c.bad', 'b'], out: ['c.sum'], type: 'ret' },
+      { f: add, a: ['c.sum', 'a'], out: ['d']}
     ],
-    outTask: { a: ['c.mult', 'c.sum', 'c'] }
+    outTask: { a: ['c.mult', 'c.sum', 'd'] }
   });
   t.deepEqual(errors, [], 'no validation errors');
 
-  fn(2, 3, { foo: 1 }, function (err, cmult, csum, c) {
-    t.equal(err.message, 'no tasks running, flow will not complete');
+  fn(2, 3, { foo: 1 }, function (err, cmult, csum, d) {
+    t.equal(err.message, 'no tasks running, flow will not complete, remaining tasks: fnRetsSum, add');
     t.end();
   });
 });

package/test/dsl.test.js

@@ -55,11 +55,11 @@ test('triple first string -> inParams["foo", "bar", "baz"], empty tasks, outTask
 
 test('single task, single out params', function (t) {
   var r = react('myName', 'cb -> err, c',
-    falpha, 'a, b, cb -> err, c'
+    falpha, 'cb -> err, c'
   );
   t.deepEqual(r.ast.inParams, []);
   t.deepEqual(r.ast.tasks, [
-    { f: falpha, a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
+    { f: falpha, a: [], out: ['c'], type: 'cb', name: 'falpha'}
   ]);
   t.deepEqual(r.ast.outTask, { a: ['c'], type: 'finalcb' });
   t.end();  
@@ -67,11 +67,11 @@ test('single task, single out params', function (t) {
 
 test('single task, err and out params', function (t) {
   var r = react('myName', 'cb -> err, c',
-    falpha, 'a, b, cb -> err, c'
+    falpha, 'cb -> err, c'
   );
   t.deepEqual(r.ast.inParams, []);
   t.deepEqual(r.ast.tasks, [
-    { f: falpha, a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
+    { f: falpha, a: [], out: ['c'], type: 'cb', name: 'falpha'}
   ]);
   t.deepEqual(r.ast.outTask, { a: ['c'], type: 'finalcb' });
   t.end();  
@@ -79,11 +79,11 @@ test('single task, err and out params', function (t) {
 
 test('single task, ERR and out params', function (t) {
   var r = react('myName', 'cb -> ERR, c', 
-    falpha, 'a, b, cb -> ERR, c'
+    falpha, 'cb -> ERR, c'
   );
   t.deepEqual(r.ast.inParams, []);
   t.deepEqual(r.ast.tasks, [
-    { f: falpha, a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
+    { f: falpha, a: [], out: ['c'], type: 'cb', name: 'falpha'}
   ]);
   t.deepEqual(r.ast.outTask, { a: ['c'], type: 'finalcb' });
   t.end();  

package/test/fstr.test.js

@@ -48,10 +48,10 @@ test('triple first string -> inParams["foo", "bar", "baz"], empty tasks, outTask
 });
 
 test('single task, single out params', function (t) {
-  var r = fstrDefine('', [
+  var r = fstrDefine('a, b', [
     falpha, 'a, b -> err, c'
   ], 'c');
-  t.deepEqual(r.ast.inParams, []);
+  t.deepEqual(r.ast.inParams, ['a', 'b']);
   t.deepEqual(r.ast.tasks, [
     { f: falpha, a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
   ]);
@@ -60,10 +60,10 @@ test('single task, single out params', function (t) {
 });
 
 test('single task, err and out params', function (t) {
-  var r = fstrDefine('', [
+  var r = fstrDefine('a, b', [
     falpha, 'a, b -> err, c'
   ], 'err, c');
-  t.deepEqual(r.ast.inParams, []);
+  t.deepEqual(r.ast.inParams, ['a', 'b']);
   t.deepEqual(r.ast.tasks, [
     { f: falpha, a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
   ]);
@@ -72,10 +72,10 @@ test('single task, err and out params', function (t) {
 });
 
 test('single task, ERR and out params', function (t) {
-  var r = fstrDefine('', [
+  var r = fstrDefine('a, b', [
     falpha, 'a, b -> ERR, c'
   ], 'ERR, c');
-  t.deepEqual(r.ast.inParams, []);
+  t.deepEqual(r.ast.inParams, ['a', 'b']);
   t.deepEqual(r.ast.tasks, [
     { f: falpha, a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
   ]);

package/test/pcode.test.js

@@ -50,11 +50,11 @@ test('triple first string -> inParams["foo", "bar", "baz"], empty tasks, outTask
 
 test('single task, single out params', function (t) {
   var locals = { falpha: falpha };
-  var r = pcode('', [
+  var r = pcode('a, b', [
     'c := falpha(a, b)',
     'cb(err, c)'
   ], locals);
-  t.deepEqual(r.ast.inParams, []);
+  t.deepEqual(r.ast.inParams, ['a', 'b']);
   t.deepEqual(r.ast.tasks, [
     { f: 'falpha', a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
   ]);
@@ -64,11 +64,11 @@ test('single task, single out params', function (t) {
 
 test('single task, err and out params', function (t) {
   var locals = { falpha: falpha };
-  var r = pcode('', [
+  var r = pcode('a, b', [
     'c := falpha(a, b)',
     'cb(err, c)'
   ], locals);
-  t.deepEqual(r.ast.inParams, []);
+  t.deepEqual(r.ast.inParams, ['a', 'b']);
   t.deepEqual(r.ast.tasks, [
     { f: 'falpha', a: ['a', 'b'], out: ['c'], type: 'cb', name: 'falpha'}
   ]);

package/test/validate.test.js

@@ -210,9 +210,57 @@ test('multiple tasks output the same param, must be unique', function (t) {
       { f: foo, a: [], out: ['baz', 'c'] },
       { f: bar, a: [], out: ['c'] }
     ], 
-    outTask: { a: ['bar'] }
+    outTask: { a: ['baz'] }
   };
   var msg = 'multiple tasks output the same param, must be unique. param: c';
   t.deepEqual(validate(ast), [msg]);  
   t.end();
+});
+
+test('missing or mispelled input variable', function (t) {
+  var ast = {
+    inParams: [], 
+    tasks: [
+      { f: foo, a: [], out: [] },
+      { f: bar, a: ['abc'], out: [] }
+    ], 
+    outTask: { a: [] }
+  };
+  var msg = 'missing or mispelled variable referenced in flow definition: abc';
+  t.deepEqual(validate(ast), [msg]);  
+  t.end();  
+});
+
+test('missing or mispelled input variables', function (t) {
+  var ast = {
+    inParams: ['aaa', 'bbb'], 
+    tasks: [
+      { f: foo, a: ['aaa', 'cat'], out: ['ccc'] },
+      { f: bar, a: ['abc', 'bbb', 'ccc'], out: [] }
+    ], 
+    outTask: { a: [] }
+  };
+  var messages = [
+    'missing or mispelled variable referenced in flow definition: cat',
+    'missing or mispelled variable referenced in flow definition: abc'
+  ];
+  t.deepEqual(validate(ast), messages);  
+  t.end();  
+});
+
+test('missing or mispelled final output variables', function (t) {
+  var ast = {
+    inParams: ['aaa'], 
+    tasks: [
+      { f: foo, a: ['aaa'], out: ['bbb'] },
+      { f: bar, a: ['bbb'], out: ['ccc'] }
+    ], 
+    outTask: { a: ['ccc', 'ddd', 'eee'] }
+  };
+  var messages = [
+    'missing or mispelled variable referenced in flow definition: ddd',
+    'missing or mispelled variable referenced in flow definition: eee'
+  ];
+  t.deepEqual(validate(ast), messages);  
+  t.end();  
 });