var hooks = require('./hooks') , should = require('should') , assert = require('assert') , _ = require('underscore'); // TODO Add in test for making sure all pres get called if pre is defined directly on an instance. // TODO Test for calling `done` twice or `next` twice in the same function counts only once module.exports = { 'should be able to assign multiple hooks at once': function () { var A = function () {}; _.extend(A, hooks); A.hook({ hook1: function (a) {}, hook2: function (b) {} }); var a = new A(); assert.equal(typeof a.hook1, 'function'); assert.equal(typeof a.hook2, 'function'); }, 'should run without pres and posts when not present': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); var a = new A(); a.save(); a.value.should.equal(1); }, 'should run with pres when present': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.pre('save', function (next) { this.preValue = 2; next(); }); var a = new A(); a.save(); a.value.should.equal(1); a.preValue.should.equal(2); }, 'should run with posts when present': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.post('save', function (next) { this.value = 2; next(); }); var a = new A(); a.save(); a.value.should.equal(2); }, 'should run pres and posts when present': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.pre('save', function (next) { this.preValue = 2; next(); }); A.post('save', function (next) { this.value = 3; next(); }); var a = new A(); a.save(); a.value.should.equal(3); a.preValue.should.equal(2); }, 'should run posts after pres': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.pre('save', function (next) { this.override = 100; next(); }); A.post('save', function (next) { this.override = 200; next(); }); var a = new A(); a.save(); a.value.should.equal(1); a.override.should.equal(200); }, 'should not run a hook if a pre fails': function () { var A = function () {}; _.extend(A, hooks); var counter = 0; A.hook('save', function () { this.value = 1; }, function (err) { counter++; }); A.pre('save', true, function (next, done) { next(new Error()); }); var a = new A(); a.save(); counter.should.equal(1); assert.equal(typeof a.value, 'undefined'); }, 'should be able to run multiple pres': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.pre('save', function (next) { this.v1 = 1; next(); }).pre('save', function (next) { this.v2 = 2; next(); }); var a = new A(); a.save(); a.v1.should.equal(1); a.v2.should.equal(2); }, 'should run multiple pres until a pre fails and not call the hook': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }, function (err) {}); A.pre('save', function (next) { this.v1 = 1; next(); }).pre('save', function (next) { next(new Error()); }).pre('save', function (next) { this.v3 = 3; next(); }); var a = new A(); a.save(); a.v1.should.equal(1); assert.equal(typeof a.v3, 'undefined'); assert.equal(typeof a.value, 'undefined'); }, 'should be able to run multiple posts': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.post('save', function (next) { this.value = 2; next(); }).post('save', function (next) { this.value = 3.14; next(); }).post('save', function (next) { this.v3 = 3; next(); }); var a = new A(); a.save(); assert.equal(a.value, 3.14); assert.equal(a.v3, 3); }, 'should run only posts up until an error': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }, function (err) {}); A.post('save', function (next) { this.value = 2; next(); }).post('save', function (next) { this.value = 3; next(new Error()); }).post('save', function (next) { this.value = 4; next(); }); var a = new A(); a.save(); a.value.should.equal(3); }, "should fall back first to the hook method's last argument as the error handler if it is a function of arity 1 or 2": function () { var A = function () {}; _.extend(A, hooks); var counter = 0; A.hook('save', function (callback) { this.value = 1; }); A.pre('save', true, function (next, done) { next(new Error()); }); var a = new A(); a.save( function (err) { if (err instanceof Error) counter++; }); counter.should.equal(1); should.deepEqual(undefined, a.value); }, 'should fall back second to the default error handler if specified': function () { var A = function () {}; _.extend(A, hooks); var counter = 0; A.hook('save', function (callback) { this.value = 1; }, function (err) { if (err instanceof Error) counter++; }); A.pre('save', true, function (next, done) { next(new Error()); }); var a = new A(); a.save(); counter.should.equal(1); should.deepEqual(undefined, a.value); }, 'fallback default error handler should scope to the object': function () { var A = function () { this.counter = 0; }; _.extend(A, hooks); var counter = 0; A.hook('save', function (callback) { this.value = 1; }, function (err) { if (err instanceof Error) this.counter++; }); A.pre('save', true, function (next, done) { next(new Error()); }); var a = new A(); a.save(); a.counter.should.equal(1); should.deepEqual(undefined, a.value); }, 'should fall back last to throwing the error': function () { var A = function () {}; _.extend(A, hooks); var counter = 0; A.hook('save', function (err) { if (err instanceof Error) return counter++; this.value = 1; }); A.pre('save', true, function (next, done) { next(new Error()); }); var a = new A(); var didCatch = false; try { a.save(); } catch (e) { didCatch = true; e.should.be.an.instanceof(Error); counter.should.equal(0); assert.equal(typeof a.value, 'undefined'); } didCatch.should.be.true; }, "should proceed without mutating arguments if `next(null|undefined)` is called in a serial pre, and the last argument of the target method is a callback with node-like signature function (err, obj) {...} or function (err) {...}": function () { var A = function () {}; _.extend(A, hooks); var counter = 0; A.prototype.save = function (callback) { this.value = 1; callback(); }; A.pre('save', function (next) { next(null); }); A.pre('save', function (next) { next(undefined); }); var a = new A(); a.save( function (err) { if (err instanceof Error) counter++; else counter--; }); counter.should.equal(-1); a.value.should.eql(1); }, "should proceed with mutating arguments if `next(null|undefined)` is callback in a serial pre, and the last argument of the target method is not a function": function () { var A = function () {}; _.extend(A, hooks); A.prototype.set = function (v) { this.value = v; }; A.pre('set', function (next) { next(undefined); }); A.pre('set', function (next) { next(null); }); var a = new A(); a.set(1); should.strictEqual(null, a.value); }, 'should not run any posts if a pre fails': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 2; }, function (err) {}); A.pre('save', function (next) { this.value = 1; next(new Error()); }).post('save', function (next) { this.value = 3; next(); }); var a = new A(); a.save(); a.value.should.equal(1); }, "can pass the hook's arguments verbatim to pres": function () { var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val) { this[path] = val; }); A.pre('set', function (next, path, val) { path.should.equal('hello'); val.should.equal('world'); next(); }); var a = new A(); a.set('hello', 'world'); a.hello.should.equal('world'); }, // "can pass the hook's arguments as an array to pres": function () { // // Great for dynamic arity - e.g., slice(...) // var A = function () {}; // _.extend(A, hooks); // A.hook('set', function (path, val) { // this[path] = val; // }); // A.pre('set', function (next, hello, world) { // hello.should.equal('hello'); // world.should.equal('world'); // next(); // }); // var a = new A(); // a.set('hello', 'world'); // assert.equal(a.hello, 'world'); // }, "can pass the hook's arguments verbatim to posts": function () { var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val) { this[path] = val; }); A.post('set', function (next, path, val) { path.should.equal('hello'); val.should.equal('world'); next(); }); var a = new A(); a.set('hello', 'world'); assert.equal(a.hello, 'world'); }, // "can pass the hook's arguments as an array to posts": function () { // var A = function () {}; // _.extend(A, hooks); // A.hook('set', function (path, val) { // this[path] = val; // }); // A.post('set', function (next, halt, args) { // assert.equal(args[0], 'hello'); // assert.equal(args[1], 'world'); // next(); // }); // var a = new A(); // a.set('hello', 'world'); // assert.equal(a.hello, 'world'); // }, "pres should be able to modify and pass on a modified version of the hook's arguments": function () { var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val) { this[path] = val; assert.equal(arguments[2], 'optional'); }); A.pre('set', function (next, path, val) { next('foo', 'bar'); }); A.pre('set', function (next, path, val) { assert.equal(path, 'foo'); assert.equal(val, 'bar'); next('rock', 'says', 'optional'); }); A.pre('set', function (next, path, val, opt) { assert.equal(path, 'rock'); assert.equal(val, 'says'); assert.equal(opt, 'optional'); next(); }); var a = new A(); a.set('hello', 'world'); assert.equal(typeof a.hello, 'undefined'); a.rock.should.equal('says'); }, 'posts should see the modified version of arguments if the pres modified them': function () { var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val) { this[path] = val; }); A.pre('set', function (next, path, val) { next('foo', 'bar'); }); A.post('set', function (next, path, val) { path.should.equal('foo'); val.should.equal('bar'); }); var a = new A(); a.set('hello', 'world'); assert.equal(typeof a.hello, 'undefined'); a.foo.should.equal('bar'); }, 'should pad missing arguments (relative to expected arguments of the hook) with null': function () { // Otherwise, with hookFn = function (a, b, next, ), // if we use hookFn(a), then because the pre functions are of the form // preFn = function (a, b, next, ), then it actually gets executed with // preFn(a, next, ), so when we call next() from within preFn, we are actually // calling () var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val, opts) { this[path] = val; }); A.pre('set', function (next, path, val, opts) { next('foo', 'bar'); assert.equal(typeof opts, 'undefined'); }); var a = new A(); a.set('hello', 'world'); }, 'should not invoke the target method until all asynchronous middleware have invoked dones': function () { var counter = 0; var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val) { counter++; this[path] = val; counter.should.equal(7); }); A.pre('set', function (next, path, val) { counter++; next(); }); A.pre('set', true, function (next, done, path, val) { counter++; setTimeout(function () { counter++; done(); }, 1000); next(); }); A.pre('set', function (next, path, val) { counter++; next(); }); A.pre('set', true, function (next, done, path, val) { counter++; setTimeout(function () { counter++; done(); }, 500); next(); }); var a = new A(); a.set('hello', 'world'); }, 'invoking a method twice should run its async middleware twice': function () { var counter = 0; var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val) { this[path] = val; if (path === 'hello') counter.should.equal(1); if (path === 'foo') counter.should.equal(2); }); A.pre('set', true, function (next, done, path, val) { setTimeout(function () { counter++; done(); }, 1000); next(); }); var a = new A(); a.set('hello', 'world'); a.set('foo', 'bar'); }, 'calling the same done multiple times should have the effect of only calling it once': function () { var A = function () { this.acked = false; }; _.extend(A, hooks); A.hook('ack', function () { console.log("UH OH, YOU SHOULD NOT BE SEEING THIS"); this.acked = true; }); A.pre('ack', true, function (next, done) { next(); done(); done(); }); A.pre('ack', true, function (next, done) { next(); // Notice that done() is not invoked here }); var a = new A(); a.ack(); setTimeout( function () { a.acked.should.be.false; }, 1000); }, 'calling the same next multiple times should have the effect of only calling it once': function (beforeExit) { var A = function () { this.acked = false; }; _.extend(A, hooks); A.hook('ack', function () { console.log("UH OH, YOU SHOULD NOT BE SEEING THIS"); this.acked = true; }); A.pre('ack', function (next) { // force a throw to re-exec next() try { next(new Error('bam')); } catch (err) { next(); } }); A.pre('ack', function (next) { next(); }); var a = new A(); a.ack(); beforeExit( function () { a.acked.should.be.false; }); }, 'asynchronous middleware should be able to pass an error via `done`, stopping the middleware chain': function () { var counter = 0; var A = function () {}; _.extend(A, hooks); A.hook('set', function (path, val, fn) { counter++; this[path] = val; fn(null); }); A.pre('set', true, function (next, done, path, val, fn) { setTimeout(function () { counter++; done(new Error); }, 1000); next(); }); var a = new A(); a.set('hello', 'world', function (err) { err.should.be.an.instanceof(Error); should.strictEqual(undefined, a['hello']); counter.should.eql(1); }); }, 'should be able to remove a particular pre': function () { var A = function () {} , preTwo; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.pre('save', function (next) { this.preValueOne = 2; next(); }); A.pre('save', preTwo = function (next) { this.preValueTwo = 4; next(); }); A.removePre('save', preTwo); var a = new A(); a.save(); a.value.should.equal(1); a.preValueOne.should.equal(2); should.strictEqual(undefined, a.preValueTwo); }, 'should be able to remove all pres associated with a hook': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.pre('save', function (next) { this.preValueOne = 2; next(); }); A.pre('save', function (next) { this.preValueTwo = 4; next(); }); A.removePre('save'); var a = new A(); a.save(); a.value.should.equal(1); should.strictEqual(undefined, a.preValueOne); should.strictEqual(undefined, a.preValueTwo); }, 'should be able to remove a particular post': function () { var A = function () {} , postTwo; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.post('save', function (next) { this.postValueOne = 2; next(); }); A.post('save', postTwo = function (next) { this.postValueTwo = 4; next(); }); A.removePost('save', postTwo); var a = new A(); a.save(); a.value.should.equal(1); a.postValueOne.should.equal(2); should.strictEqual(undefined, a.postValueTwo); }, 'should be able to remove all posts associated with a hook': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function () { this.value = 1; }); A.post('save', function (next) { this.postValueOne = 2; next(); }); A.post('save', function (next) { this.postValueTwo = 4; next(); }); A.removePost('save'); var a = new A(); a.save(); a.value.should.equal(1); should.strictEqual(undefined, a.postValueOne); should.strictEqual(undefined, a.postValueTwo); }, '#pre should lazily make a method hookable': function () { var A = function () {}; _.extend(A, hooks); A.prototype.save = function () { this.value = 1; }; A.pre('save', function (next) { this.preValue = 2; next(); }); var a = new A(); a.save(); a.value.should.equal(1); a.preValue.should.equal(2); }, '#pre lazily making a method hookable should be able to provide a default errorHandler as the last argument': function () { var A = function () {}; var preValue = ""; _.extend(A, hooks); A.prototype.save = function () { this.value = 1; }; A.pre('save', function (next) { next(new Error); }, function (err) { preValue = 'ERROR'; }); var a = new A(); a.save(); should.strictEqual(undefined, a.value); preValue.should.equal('ERROR'); }, '#post should lazily make a method hookable': function () { var A = function () {}; _.extend(A, hooks); A.prototype.save = function () { this.value = 1; }; A.post('save', function (next) { this.value = 2; next(); }); var a = new A(); a.save(); a.value.should.equal(2); }, "a lazy hooks setup should handle errors via a method's last argument, if it's a callback": function () { var A = function () {}; _.extend(A, hooks); A.prototype.save = function (fn) {}; A.pre('save', function (next) { next(new Error("hi there")); }); var a = new A(); a.save( function (err) { err.should.be.an.instanceof(Error); }); }, 'should intercept method callbacks for post handlers': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function (val, callback) { this.value = val; callback(); }); A.post('save', function (next) { assert.equal(a.value, 2); this.value += 2; setTimeout(next, 10); }).post('save', function (next) { assert.equal(a.value, 4); this.value += 3; setTimeout(next, 10); }).post('save', function (next) { assert.equal(a.value, 7); this.value2 = 3; setTimeout(next, 10); }); var a = new A(); a.save(2, function(){ assert.equal(a.value, 7); assert.equal(a.value2, 3); }); }, 'should handle parallel followed by serial': function () { var A = function () {}; _.extend(A, hooks); A.hook('save', function (val, callback) { this.value = val; callback(); }); A.pre('save', true, function(next, done) { process.nextTick(function() { done(); }); next(); }).pre('save', function(done) { process.nextTick(function() { done(); }); }); var a = new A(); a.save(2, function(){ assert.ok(true); }); } };